{
"description": "Logical Model: A pattern to be followed by resources that represent a specific proposal, plan and/or order for some sort of action or service.",
"_filename": "StructureDefinition-Definition.json",
"package_name": "hl7.fhir.r6.core",
"date": "2025-04-01T12:16:37+11:00",
"publisher": "HL7 International / FHIR Infrastructure",
"fhirVersion": "6.0.0-ballot3",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"name": "Definition",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 V2 Mapping",
"identity": "v2"
} ],
"abstract": false,
"type": "Definition",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": "definition",
"package_version": "6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition",
"min": 0,
"definition": "A pattern to be followed by resources that represent a specific proposal, plan and/or order for some sort of action or service.",
"isModifier": false,
"short": "Definition Pattern",
"mapping": [ {
"map": "Act[moodCode<=DEFN]",
"identity": "rim"
} ],
"max": "*",
"id": "Definition",
"base": {
"max": "*",
"min": 0,
"path": "Definition"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.url",
"requirements": "Allows the {{title}} to be referenced by a single globally unique identifier.",
"min": 0,
"definition": "An absolute URI that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this {{title}} is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the {{title}} is stored on different servers.",
"isModifier": false,
"short": "Canonical identifier for this {{title}}, represented as an absolute URI (globally unique)",
"mapping": [ {
"map": ".identifier",
"identity": "rim"
}, {
"map": "FiveWs.identifier",
"identity": "w5"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Definition.url",
"comment": "Can be a `urn:uuid:` or a `urn:oid:` but real `http/s:` addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).\n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"base": {
"max": "1",
"min": 0,
"path": "Definition.url"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.identifier",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the {{title}}.",
"min": 0,
"definition": "A formal identifier that is used to identify this {{title}} when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"isModifier": false,
"short": "Business identifier for {{title}}",
"mapping": [ {
"map": ".identifier",
"identity": "rim"
}, {
"map": "FiveWs.identifier",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "Definition.identifier",
"comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this {{title}} outside of FHIR, where it is not possible to use the logical URI.",
"base": {
"max": "*",
"min": 0,
"path": "Definition.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.version",
"min": 0,
"definition": "The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"isModifier": false,
"short": "Business version of the {{title}}",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
}, {
"map": "FiveWs.version",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Definition.version",
"comment": "There may be different {{title}}s that have the same url but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the {{title}} with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).",
"base": {
"max": "1",
"min": 0,
"path": "Definition.version"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.versionAlgorithm[x]",
"min": 0,
"definition": "Indicates the mechanism used to compare versions to determine which is more current.",
"isModifier": false,
"short": "How to compare versions",
"type": [ {
"code": "string"
}, {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/version-algorithm",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VersionAlgorithm"
} ]
},
"max": "1",
"id": "Definition.versionAlgorithm[x]",
"comment": "If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.",
"base": {
"max": "1",
"min": 0,
"path": "Definition.versionAlgorithm[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.name",
"requirements": "Supports code generation.",
"min": 0,
"definition": "A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"isModifier": false,
"short": "Name for this {{title}} (computer friendly)",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Definition.name",
"comment": "The name is not expected to be globally unique. The name should be a simple alphanumeric type no-whitespace name to ensure that it is machine-processing friendly.",
"base": {
"max": "1",
"min": 0,
"path": "Definition.name"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.title",
"min": 0,
"definition": "A short, descriptive, user-friendly title for the {{title}}.",
"isModifier": false,
"short": "Name for this {{title}} (human friendly)",
"mapping": [ {
"map": ".title",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Definition.title",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Definition.title"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.derivedFromCanonical",
"requirements": "Protocols and order sets may be refinements of more generic protocols and order sets.",
"min": 0,
"definition": "The canonical URL pointing to another FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition.",
"isModifier": false,
"short": "Based on FHIR protocol or definition",
"mapping": [ {
"map": "Varies by domain",
"identity": "v2"
}, {
"map": ".outboundRelationship[typeCode=DEFN].target",
"identity": "rim"
} ],
"type": [ {
"code": "canonical"
} ],
"max": "*",
"id": "Definition.derivedFromCanonical",
"base": {
"max": "*",
"min": 0,
"path": "Definition.derivedFromCanonical"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.derivedFromUri",
"requirements": "Protocols and order sets may be refinements of more generic protocols and order sets.",
"min": 0,
"definition": "The URL pointing to an externally-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition.",
"isModifier": false,
"short": "Based on external protocol or definition",
"mapping": [ {
"map": "Varies by domain",
"identity": "v2"
}, {
"map": ".outboundRelationship[typeCode=DEFN].target",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "*",
"id": "Definition.derivedFromUri",
"comment": "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
"base": {
"max": "*",
"min": 0,
"path": "Definition.derivedFromUri"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.partOf",
"requirements": "E.g. Drug administration as part of a procedure, procedure as part of observation, etc.",
"min": 0,
"definition": "A larger definition of which this particular definition is a component or step.",
"isModifier": false,
"short": "Part of referenced definition",
"mapping": [ {
"map": ".inboundRelationship[typeCode=COMP].source[moodCode=DEFN]",
"identity": "rim"
} ],
"type": [ {
"code": "canonical"
} ],
"alias": [ "container" ],
"max": "*",
"id": "Definition.partOf",
"comment": "[The allowed reference resources may be adjusted as appropriate for the event resource].",
"base": {
"max": "*",
"min": 0,
"path": "Definition.partOf"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.status",
"requirements": "Enables tracking the lifecycle of the content and filtering of {{title}}s that are appropriate for use versus not.",
"min": 1,
"definition": "The current state of this {{title}}.",
"isModifier": true,
"short": "draft | active | retired | unknown",
"mapping": [ {
"map": ".status",
"identity": "rim"
}, {
"map": "FiveWs.status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "The lifecycle status of an artifact."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The lifecycle status of an artifact."
},
"max": "1",
"id": "Definition.status",
"comment": "A nominal state-transition diagram can be found in the [[definition.html#statemachine | Definition pattern]] documentation\n\nUnknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.",
"base": {
"max": "1",
"min": 1,
"path": "Definition.status"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.experimental",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level {{title}}.",
"min": 0,
"definition": "A Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.",
"isModifier": false,
"short": "For testing only - never for real usage",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
}, {
"map": "FiveWs.class",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Definition.experimental",
"comment": "Allows filtering of {{title}}s that are appropriate for use versus not.",
"base": {
"max": "1",
"min": 0,
"path": "Definition.experimental"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.subject",
"requirements": "Many protocols, order sets and guidelines are intended for use only with specific types of patients or subjects.",
"min": 0,
"definition": "A code or group definition that describes the intended subject of instantiations of this definition.",
"isModifier": false,
"short": "Type of individual the defined service is for",
"mapping": [ {
"map": ".participation[typeCode=SBJ].role",
"identity": "rim"
}, {
"map": "FiveWs.subject[x]",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableReference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Group" ]
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "Codes identifying the type of subject intended to be the recpient or focus of the defined action. These should ideally be consistent across definition resources."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DefinitionSubject"
} ],
"description": "Codes identifying the type of subject intended to be the recpient or focus of the defined action. These should ideally be consistent across definition resources."
},
"alias": [ "Subject type" ],
"max": "*",
"id": "Definition.subject",
"base": {
"max": "*",
"min": 0,
"path": "Definition.subject"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.date",
"min": 0,
"definition": "The date (and optionally time) when the {{title}} was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the {{title}} changes.",
"isModifier": false,
"short": "Date last changed",
"mapping": [ {
"map": ".participation[typeCode=AUT].time",
"identity": "rim"
}, {
"map": "FiveWs.recorded",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"alias": [ "created" ],
"max": "1",
"id": "Definition.date",
"comment": "The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the {{title}}. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"base": {
"max": "1",
"min": 0,
"path": "Definition.date"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.publisher",
"requirements": "Helps establish the \"authority/credibility\" of the {{title}}. May also allow for contact.",
"min": 0,
"definition": "The name of the organization or individual responsible for the release and ongoing maintenance of the {{title}}.",
"isModifier": false,
"short": "Name of the publisher/steward (organization or individual)",
"mapping": [ {
"map": ".participation[typeCode=AUT].role",
"identity": "rim"
}, {
"map": "FiveWs.author",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "author" ],
"max": "1",
"id": "Definition.publisher",
"comment": "Usually an organization but may be an individual. The publisher (or steward) of the {{title}} is the organization or individual primarily responsible for the maintenance and upkeep of the {{title}}. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the {{title}}. This item SHOULD be populated unless the information is available from context.",
"base": {
"max": "1",
"min": 0,
"path": "Definition.publisher"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.contact",
"min": 0,
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"isModifier": false,
"short": "Contact details for the publisher",
"mapping": [ {
"map": ".participation[typeCode=CALLBCK].role",
"identity": "rim"
} ],
"type": [ {
"code": "ContactDetail"
} ],
"max": "*",
"id": "Definition.contact",
"comment": "May be a web site, an email address, a telephone number, etc.",
"base": {
"max": "*",
"min": 0,
"path": "Definition.contact"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.description",
"min": 0,
"definition": "A free text natural language description of the {{title}} from a consumer's perspective.",
"isModifier": false,
"short": "Natural language description of the {{title}}",
"mapping": [ {
"map": ".text",
"identity": "rim"
} ],
"type": [ {
"code": "markdown"
} ],
"max": "1",
"id": "Definition.description",
"comment": "This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the {{title}} as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context.",
"base": {
"max": "1",
"min": 0,
"path": "Definition.description"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.useContext",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate {{title}}s.",
"isModifier": false,
"short": "The context that the content is intended to support",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "UsageContext"
} ],
"max": "*",
"id": "Definition.useContext",
"comment": "When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply.",
"base": {
"max": "*",
"min": 0,
"path": "Definition.useContext"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.jurisdiction",
"min": 0,
"definition": "A legal or geographic region in which the {{title}} is intended to be used.",
"isModifier": false,
"short": "Intended jurisdiction for {{title}} (if applicable)",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/jurisdiction",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "Countries and regions within which this artifact is targeted for use."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Countries and regions within which this artifact is targeted for use."
},
"max": "*",
"id": "Definition.jurisdiction",
"comment": "It may be possible for the {{title}} to be used in jurisdictions other than those for which it was originally designed or intended\n\nDEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.).",
"base": {
"max": "*",
"min": 0,
"path": "Definition.jurisdiction"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.purpose",
"min": 0,
"definition": "Explanation of why this {{title}} is needed and why it has been designed as it has.",
"isModifier": false,
"short": "Why this {{title}} is defined",
"mapping": [ {
"map": ".reasonCode.text",
"identity": "rim"
}, {
"map": "FiveWs.why[x]",
"identity": "w5"
} ],
"type": [ {
"code": "markdown"
} ],
"max": "1",
"id": "Definition.purpose",
"comment": "This element does not describe the usage of the {{title}}. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this {{title}}.",
"base": {
"max": "1",
"min": 0,
"path": "Definition.purpose"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.copyright",
"requirements": "Consumers of the {{title}} must be able to determine any legal restrictions on the use of the artifact and/or its content.",
"min": 0,
"definition": "A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.",
"isModifier": false,
"short": "Use and/or publishing restrictions",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "markdown"
} ],
"alias": [ "License", "Restrictions" ],
"max": "1",
"id": "Definition.copyright",
"base": {
"max": "1",
"min": 0,
"path": "Definition.copyright"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.copyrightLabel",
"requirements": "Defines the content expected to be rendered in all representations of the artifact.",
"min": 0,
"definition": "A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').",
"isModifier": false,
"short": "Copyright holder and year(s)",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Definition.copyrightLabel",
"comment": "The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.",
"base": {
"max": "1",
"min": 0,
"path": "Definition.copyrightLabel"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.approvalDate",
"min": 0,
"definition": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"isModifier": false,
"short": "When the {{title}} was approved by publisher",
"mapping": [ {
"map": ".outboundRelationship[typeCode=\"SUBJ\"].act[classCode=CACT;moodCode=EVN;code=\"approval\"].effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "date"
} ],
"max": "1",
"id": "Definition.approvalDate",
"comment": "The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.",
"base": {
"max": "1",
"min": 0,
"path": "Definition.approvalDate"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.lastReviewDate",
"requirements": "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.",
"min": 0,
"definition": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"isModifier": false,
"short": "When the {{title}} was last reviewed",
"mapping": [ {
"map": ".outboundRelationship[typeCode=\"SUBJ\"; subsetCode=\"RECENT\"].act[classCode=CACT;moodCode=EVN;code=\"review\"].effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "date"
} ],
"max": "1",
"id": "Definition.lastReviewDate",
"comment": "If specified, this date follows the original approval date.",
"base": {
"max": "1",
"min": 0,
"path": "Definition.lastReviewDate"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.effectivePeriod",
"requirements": "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the {{title}} are or are expected to be used instead.",
"min": 0,
"definition": "The period during which the {{title}} content was or is planned to be in active use.",
"isModifier": false,
"short": "When the {{title}} is expected to be used",
"mapping": [ {
"map": "N/A (to add?)",
"identity": "rim"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Definition.effectivePeriod",
"comment": "The effective period for a {{title}} determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.",
"base": {
"max": "1",
"min": 0,
"path": "Definition.effectivePeriod"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.topic",
"requirements": "This element provides topical categorization and keywords for the {{title}}, as opposed to the more structured context-of-use information provided in the useContext element.",
"min": 0,
"definition": "Repositories must be able to determine how to categorize the {{title}} so that it can be found by topical and keyword searches.",
"isModifier": false,
"short": "Descriptive topics related to the content of the {{title}}. Topics provide a high-level categorization as well as keywords for the {{title}} that can be useful for filtering and searching",
"type": [ {
"code": "CodeableConcept"
} ],
"max": "*",
"id": "Definition.topic",
"base": {
"max": "*",
"min": 0,
"path": "Definition.topic"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.performerType",
"min": 0,
"definition": "The type of individual that is expected to act upon instances of this definition.",
"isModifier": false,
"short": "Desired kind of service performer",
"mapping": [ {
"map": ".participation[typeCode=PRF].role[scoper.determinerCode=KIND].code",
"identity": "rim"
}, {
"map": "FiveWs.actor",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "Identifies types of practitioners, devices or other agents that are intended to perform a defined action. While the detailed constraints of relevant agents will vary by resource, some degree of consistency around recommended codes across request and definition resources would be desirable."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PerformerType"
} ],
"description": "Identifies types of practitioners, devices or other agents that are intended to perform a defined action. While the detailed constraints of relevant agents will vary by resource, some degree of consistency around recommended codes across request and definition resources would be desirable."
},
"max": "1",
"id": "Definition.performerType",
"base": {
"max": "1",
"min": 0,
"path": "Definition.performerType"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.code",
"min": 0,
"definition": "A code that identifies the specific service or action that was or is being performed.",
"isModifier": false,
"short": "Service to be done",
"mapping": [ {
"map": "Varies by domain",
"identity": "v2"
}, {
"map": ".code",
"identity": "rim"
}, {
"map": "FiveWs.what[x]",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"alias": [ "type" ],
"max": "1",
"id": "Definition.code",
"base": {
"max": "1",
"min": 0,
"path": "Definition.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Definition.product",
"min": 0,
"definition": "Indicates the product supplied or manipulated by this {{title}}.",
"isModifier": false,
"short": "Product to use/manipulate",
"mapping": [ {
"map": "Varies by domain",
"identity": "v2"
}, {
"map": ".participation[typeCode=PRD].role",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableReference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct", "http://hl7.org/fhir/StructureDefinition/DeviceDefinition", "http://hl7.org/fhir/StructureDefinition/Medication", "http://hl7.org/fhir/StructureDefinition/NutritionProduct", "http://hl7.org/fhir/StructureDefinition/Substance" ]
} ],
"max": "1",
"id": "Definition.product",
"base": {
"max": "1",
"min": 0,
"path": "Definition.product"
},
"isSummary": true
} ]
},
"status": "draft",
"id": "e9e23eae-cc03-48bf-88f1-3d83977954aa",
"kind": "logical",
"url": "http://hl7.org/fhir/StructureDefinition/Definition",
"version": "6.0.0-ballot3",
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/fhir",
"system": "url"
} ]
}, {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base"
}