Release 5
FoundationThis page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
| FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: No defined compartments |
Raw Turtle (+ also see Turtle/RDF Format Specification)
StructureDefinition for canonicalresource
@prefix fhir: <http://hl7.org/fhir/> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
# - resource -------------------------------------------------------------------
[] a fhir:StructureDefinition ;
fhir:id [ fhir:v "CanonicalResource"] ;
fhir:meta [
fhir:lastUpdated [ fhir:v "2023-03-26T15:21:02.749+11:00" ]
] ;
fhir:text [
fhir:status [ fhir:v "generated" ]
] ;
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-interface" ] ;
fhir:value [ fhir:v "true" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ] ;
fhir:value [ fhir:v "normative" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version" ] ;
fhir:value [ fhir:v "4.2.0" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm" ] ;
fhir:value [ fhir:v "5" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg" ] ;
fhir:value [ fhir:v "fhir" ]
] ) ;
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/CanonicalResource"], [ fhir:v "http://hl7.org/fhir/StructureDefinition/CanonicalResource"] ;
fhir:version [ fhir:v "5.0.0"], [ fhir:v "5.0.0"] ;
fhir:name [ fhir:v "CanonicalResource"], [ fhir:v "CanonicalResource"] ;
fhir:status [ fhir:v "active"], [ fhir:v "active"] ;
fhir:experimental [ fhir:v "false"], [ fhir:v "false"] ;
fhir:date [ fhir:v "2023-03-26T15:21:02+11:00"], [ fhir:v "2023-03-26T15:21:02+11:00"] ;
fhir:publisher [ fhir:v "Health Level Seven International (FHIR Infrastructure)"], [ fhir:v "Health Level Seven International (FHIR Infrastructure)"] ;
fhir:contact ( [
fhir:telecom ( [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://hl7.org/fhir" ]
] )
] [
fhir:telecom ( [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://www.hl7.org/Special/committees/fiwg/index.cfm" ]
] )
] [
fhir:telecom ( [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://hl7.org/fhir" ]
] )
] [
fhir:telecom ( [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://www.hl7.org/Special/committees/fiwg/index.cfm" ]
] )
] ) ;
fhir:description [ fhir:v "Common Interface declaration for conformance and knowledge artifact resources."], [ fhir:v "Common Interface declaration for conformance and knowledge artifact resources."] ;
fhir:jurisdiction ( [
fhir:coding ( [
fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm" ] ;
fhir:code [ fhir:v "001" ] ;
fhir:display [ fhir:v "World" ]
] )
] [
fhir:coding ( [
fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm" ] ;
fhir:code [ fhir:v "001" ] ;
fhir:display [ fhir:v "World" ]
] )
] ) ;
fhir:fhirVersion [ fhir:v "5.0.0"] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:uri [ fhir:v "http://hl7.org/fhir/fivews" ] ;
fhir:name [ fhir:v "FiveWs Pattern Mapping" ]
] [
fhir:identity [ fhir:v "objimpl" ] ;
fhir:uri [ fhir:v "http://hl7.org/fhir/object-implementation" ] ;
fhir:name [ fhir:v "Object Implementation Information" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:uri [ fhir:v "http://hl7.org/v3" ] ;
fhir:name [ fhir:v "RIM Mapping" ]
] ) ;
fhir:kind [ fhir:v "resource"] ;
fhir:abstract [ fhir:v "true"] ;
fhir:type [ fhir:v "CanonicalResource"] ;
fhir:baseDefinition [ fhir:v "http://hl7.org/fhir/StructureDefinition/DomainResource"] ;
fhir:derivation [ fhir:v "specialization"] ;
fhir:snapshot [
fhir:element ( [
fhir:id [ fhir:v "CanonicalResource" ] ;
fhir:path [ fhir:v "CanonicalResource" ] ;
fhir:short [ fhir:v "Common Interface declaration for definitional resources" ] ;
fhir:definition [ fhir:v "Common Interface declaration for conformance and knowledge artifact resources." ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "CanonicalResource" ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:constraint ( [
fhir:key [ fhir:v "cnl-0" ] ;
fhir:severity [ fhir:v "warning" ] ;
fhir:human [ fhir:v "Name should be usable as an identifier for the module by machine processing applications such as code generation" ] ;
fhir:expression [ fhir:v "name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/CanonicalResource" ]
] [
fhir:key [ fhir:v "dom-2" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "If the resource is contained in another resource, it SHALL NOT contain nested Resources" ] ;
fhir:expression [ fhir:v "contained.contained.empty()" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/DomainResource" ]
] [
fhir:key [ fhir:v "dom-3" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource" ] ;
fhir:expression [ fhir:v "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/DomainResource" ]
] [
fhir:key [ fhir:v "dom-4" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated" ] ;
fhir:expression [ fhir:v "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/DomainResource" ]
] [
fhir:key [ fhir:v "dom-5" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "If a resource is contained in another resource, it SHALL NOT have a security label" ] ;
fhir:expression [ fhir:v "contained.meta.security.empty()" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/DomainResource" ]
] [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice" ] ;
fhir:value [ fhir:v "true" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation" ] ;
fhir:value [ fhir:v "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." ]
] ) ;
fhir:key [ fhir:v "dom-6" ] ;
fhir:severity [ fhir:v "warning" ] ;
fhir:human [ fhir:v "A resource should have narrative for robust management" ] ;
fhir:expression [ fhir:v "text.`div`.exists()" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/DomainResource" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "Entity, Role, or Act" ]
] [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "conformance.behavior" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.id" ] ;
fhir:path [ fhir:v "CanonicalResource.id" ] ;
fhir:short [ fhir:v "Logical id of this artifact" ] ;
fhir:definition [ fhir:v "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." ] ;
fhir:comment [ fhir:v "Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "Resource.id" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type" ] ;
fhir:value [ fhir:v "id" ]
] ) ;
fhir:code [ fhir:v "http://hl7.org/fhirpath/System.String" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ]
] [
fhir:id [ fhir:v "CanonicalResource.meta" ] ;
fhir:path [ fhir:v "CanonicalResource.meta" ] ;
fhir:short [ fhir:v "Metadata about the resource" ] ;
fhir:definition [ fhir:v "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "Resource.meta" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Meta" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ]
] [
fhir:id [ fhir:v "CanonicalResource.implicitRules" ] ;
fhir:path [ fhir:v "CanonicalResource.implicitRules" ] ;
fhir:short [ fhir:v "A set of rules under which this content was created" ] ;
fhir:definition [ fhir:v "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc." ] ;
fhir:comment [ fhir:v "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "Resource.implicitRules" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "uri" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "true" ] ;
fhir:isModifierReason [ fhir:v "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation" ] ;
fhir:isSummary [ fhir:v "true" ]
] [
fhir:id [ fhir:v "CanonicalResource.language" ] ;
fhir:path [ fhir:v "CanonicalResource.language" ] ;
fhir:short [ fhir:v "Language of the resource content" ] ;
fhir:definition [ fhir:v "The base language in which the resource is written." ] ;
fhir:comment [ fhir:v "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "Resource.language" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "code" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "Language" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding" ] ;
fhir:value [ fhir:v "true" ]
] ) ;
fhir:strength [ fhir:v "required" ] ;
fhir:description [ fhir:v "IETF language tag for a human language" ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/all-languages|5.0.0" ] ;
fhir:additional ( [
fhir:purpose [ fhir:v "starter" ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/languages" ]
] )
]
] [
fhir:id [ fhir:v "CanonicalResource.text" ] ;
fhir:path [ fhir:v "CanonicalResource.text" ] ;
fhir:short [ fhir:v "Text summary of the resource, for human interpretation" ] ;
fhir:definition [ fhir:v "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety." ] ;
fhir:comment [ fhir:v "Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later." ] ;
fhir:alias ( [ fhir:v "narrative" ] [ fhir:v "html" ] [ fhir:v "xhtml" ] [ fhir:v "display" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "DomainResource.text" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Narrative" ]
] ) ;
fhir:condition ( [ fhir:v "dom-6" ] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "Act.text?" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.contained" ] ;
fhir:path [ fhir:v "CanonicalResource.contained" ] ;
fhir:short [ fhir:v "Contained, inline Resources" ] ;
fhir:definition [ fhir:v "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning." ] ;
fhir:comment [ fhir:v "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels." ] ;
fhir:alias ( [ fhir:v "inline resources" ] [ fhir:v "anonymous resources" ] [ fhir:v "contained resources" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "DomainResource.contained" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Resource" ]
] ) ;
fhir:condition ( [ fhir:v "dom-2" ] [ fhir:v "dom-4" ] [ fhir:v "dom-3" ] [ fhir:v "dom-5" ] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "N/A" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.extension" ] ;
fhir:path [ fhir:v "CanonicalResource.extension" ] ;
fhir:short [ fhir:v "Additional content defined by implementations" ] ;
fhir:definition [ fhir:v "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." ] ;
fhir:comment [ fhir:v "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." ] ;
fhir:alias ( [ fhir:v "extensions" ] [ fhir:v "user content" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "DomainResource.extension" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Extension" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] [
fhir:key [ fhir:v "ext-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "Must have either extensions or value[x], not both" ] ;
fhir:expression [ fhir:v "extension.exists() != value.exists()" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Extension" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "N/A" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.modifierExtension" ] ;
fhir:path [ fhir:v "CanonicalResource.modifierExtension" ] ;
fhir:short [ fhir:v "Extensions that cannot be ignored" ] ;
fhir:definition [ fhir:v "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." ] ;
fhir:comment [ fhir:v "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." ] ;
fhir:requirements [ fhir:v "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)." ] ;
fhir:alias ( [ fhir:v "extensions" ] [ fhir:v "user content" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "DomainResource.modifierExtension" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Extension" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] [
fhir:key [ fhir:v "ext-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "Must have either extensions or value[x], not both" ] ;
fhir:expression [ fhir:v "extension.exists() != value.exists()" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Extension" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "true" ] ;
fhir:isModifierReason [ fhir:v "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "N/A" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.url" ] ;
fhir:path [ fhir:v "CanonicalResource.url" ] ;
fhir:short [ fhir:v "Canonical identifier for this {{title}}, represented as an absolute URI (globally unique)" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:comment [ fhir:v "Can be a urn:uuid: or a urn:oid: but real http: 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." ] ;
fhir:requirements [ fhir:v "Allows the {{title}} to be referenced by a single globally unique identifier." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "CanonicalResource.url" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "uri" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "cnl-1" ] ;
fhir:severity [ fhir:v "warning" ] ;
fhir:human [ fhir:v "URL should not contain | or # - these characters make processing canonical references problematic" ] ;
fhir:expression [ fhir:v "exists() implies matches('^[^|# ]+$')" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/CanonicalResource" ]
] [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.identifier" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.identifier" ] ;
fhir:path [ fhir:v "CanonicalResource.identifier" ] ;
fhir:short [ fhir:v "Additional identifier for the {{title}}" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:requirements [ fhir:v "Allows externally provided and/or usable business identifiers to be easily associated with the {{title}}." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "CanonicalResource.identifier" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Identifier" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.identifier" ]
] [
fhir:identity [ fhir:v "objimpl" ] ;
fhir:map [ fhir:v "no-gen-base" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.version" ] ;
fhir:path [ fhir:v "CanonicalResource.version" ] ;
fhir:short [ fhir:v "Business version of the {{title}}" ] ;
fhir:definition [ fhir:v "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 without additional knowledge. (See the versionAlgorithm element.)" ] ;
fhir:comment [ fhir:v "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)." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "CanonicalResource.version" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.version" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.versionAlgorithm[x]" ] ;
fhir:path [ fhir:v "CanonicalResource.versionAlgorithm[x]" ] ;
fhir:short [ fhir:v "How to compare versions" ] ;
fhir:definition [ fhir:v "Indicates the mechanism used to compare versions to determine which is more current." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "CanonicalResource.versionAlgorithm[x]" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] [
fhir:code [ fhir:v "Coding" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:strength [ fhir:v "extensible" ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/version-algorithm" ]
]
] [
fhir:id [ fhir:v "CanonicalResource.name" ] ;
fhir:path [ fhir:v "CanonicalResource.name" ] ;
fhir:short [ fhir:v "Name for this {{title}} (computer friendly)" ] ;
fhir:definition [ fhir:v "A natural language name identifying the {{title}}. This name should be usable as an identifier for the resource by machine processing applications such as code generation." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:requirements [ fhir:v "Supports code generation." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "CanonicalResource.name" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:condition ( [ fhir:v "cnl-0" ] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ]
] [
fhir:id [ fhir:v "CanonicalResource.title" ] ;
fhir:path [ fhir:v "CanonicalResource.title" ] ;
fhir:short [ fhir:v "Name for this {{title}} (human friendly)" ] ;
fhir:definition [ fhir:v "A short, descriptive, user-friendly title for the {{title}}." ] ;
fhir:comment [ fhir:v "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "CanonicalResource.title" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ]
] [
fhir:id [ fhir:v "CanonicalResource.status" ] ;
fhir:path [ fhir:v "CanonicalResource.status" ] ;
fhir:short [ fhir:v "draft | active | retired | unknown" ] ;
fhir:definition [ fhir:v "The current state of this {{title}}. " ] ;
fhir:comment [ fhir:v "A nominal state-transition diagram can be found in the [Definition pattern](definition.html#statemachine) 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.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization)." ] ;
fhir:requirements [ fhir:v "Enables tracking the life-cycle of the content and filtering of {{title}}s that are appropriate for use versus not." ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "CanonicalResource.status" ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "code" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "true" ] ;
fhir:isModifierReason [ fhir:v "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "PublicationStatus" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding" ] ;
fhir:value [ fhir:v "true" ]
] ) ;
fhir:strength [ fhir:v "required" ] ;
fhir:description [ fhir:v "The lifecycle status of an artifact." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/publication-status|5.0.0" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.status" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.experimental" ] ;
fhir:path [ fhir:v "CanonicalResource.experimental" ] ;
fhir:short [ fhir:v "For testing purposes, not real usage" ] ;
fhir:definition [ fhir:v "A Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage." ] ;
fhir:comment [ fhir:v "Allows filtering of {{title}}s that are appropriate for use versus not." ] ;
fhir:requirements [ fhir:v "Enables experimental content to be developed following the same lifecycle that would be used for a production-level {{title}}." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "CanonicalResource.experimental" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "boolean" ]
] ) ;
fhir:meaningWhenMissing [ fhir:v "If absent, this resource is treated as though it is not experimental." ] ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.class" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.date" ] ;
fhir:path [ fhir:v "CanonicalResource.date" ] ;
fhir:short [ fhir:v "Date last changed" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:comment [ fhir:v "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.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization)." ] ;
fhir:alias ( [ fhir:v "Revision Date" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "CanonicalResource.date" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "dateTime" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.recorded" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.publisher" ] ;
fhir:path [ fhir:v "CanonicalResource.publisher" ] ;
fhir:short [ fhir:v "Name of the publisher/steward (organization or individual)" ] ;
fhir:definition [ fhir:v "The name of the organization or individual responsible for the release and ongoing maintenance of the {{title}}." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:requirements [ fhir:v "Helps establish the \"authority/credibility\" of the {{title}}. May also allow for contact." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "CanonicalResource.publisher" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.witness" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.contact" ] ;
fhir:path [ fhir:v "CanonicalResource.contact" ] ;
fhir:short [ fhir:v "Contact details for the publisher" ] ;
fhir:definition [ fhir:v "Contact details to assist a user in finding and communicating with the publisher." ] ;
fhir:comment [ fhir:v "May be a web site, an email address, a telephone number, etc.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization)." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "CanonicalResource.contact" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "ContactDetail" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ]
] [
fhir:id [ fhir:v "CanonicalResource.description" ] ;
fhir:path [ fhir:v "CanonicalResource.description" ] ;
fhir:short [ fhir:v "Natural language description of the {{title}}" ] ;
fhir:definition [ fhir:v "A free text natural language description of the {{title}} from a consumer's perspective." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "CanonicalResource.description" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "markdown" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ]
] [
fhir:id [ fhir:v "CanonicalResource.useContext" ] ;
fhir:path [ fhir:v "CanonicalResource.useContext" ] ;
fhir:short [ fhir:v "The context that the content is intended to support" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:comment [ fhir:v "When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply." ] ;
fhir:requirements [ fhir:v "Assist in searching for appropriate content." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "CanonicalResource.useContext" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "UsageContext" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ]
] [
fhir:id [ fhir:v "CanonicalResource.jurisdiction" ] ;
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ] ;
fhir:value [ fhir:v "deprecated" ]
] ) ;
fhir:path [ fhir:v "CanonicalResource.jurisdiction" ] ;
fhir:short [ fhir:v "Intended jurisdiction for {{title}} (if applicable)" ] ;
fhir:definition [ fhir:v "A legal or geographic region in which the {{title}} is intended to be used." ] ;
fhir:comment [ fhir:v "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.)" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "CanonicalResource.jurisdiction" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "CodeableConcept" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "Jurisdiction" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding" ] ;
fhir:value [ fhir:v "true" ]
] ) ;
fhir:strength [ fhir:v "extensible" ] ;
fhir:description [ fhir:v "Countries and regions within which this artifact is targeted for use." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/jurisdiction" ]
]
] [
fhir:id [ fhir:v "CanonicalResource.purpose" ] ;
fhir:path [ fhir:v "CanonicalResource.purpose" ] ;
fhir:short [ fhir:v "Why this {{title}} is defined" ] ;
fhir:definition [ fhir:v "Explanation of why this {{title}} is needed and why it has been designed as it has." ] ;
fhir:comment [ fhir:v "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}}." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "CanonicalResource.purpose" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "markdown" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.why[x]" ]
] [
fhir:identity [ fhir:v "objimpl" ] ;
fhir:map [ fhir:v "no-gen-base" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.copyright" ] ;
fhir:path [ fhir:v "CanonicalResource.copyright" ] ;
fhir:short [ fhir:v "Use and/or publishing restrictions" ] ;
fhir:definition [ fhir:v "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}}." ] ;
fhir:comment [ fhir:v "The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element." ] ;
fhir:requirements [ fhir:v "Consumers must be able to determine any legal restrictions on the use of the {{title}} and/or its content." ] ;
fhir:alias ( [ fhir:v "License" ] [ fhir:v "Restrictions" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "CanonicalResource.copyright" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "markdown" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "objimpl" ] ;
fhir:map [ fhir:v "no-gen-base" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.copyrightLabel" ] ;
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable" ] ;
fhir:value [ fhir:v "true" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable" ] ;
fhir:value [ fhir:v "true" ]
] ) ;
fhir:path [ fhir:v "CanonicalResource.copyrightLabel" ] ;
fhir:short [ fhir:v "Copyright holder and year(s)" ] ;
fhir:definition [ fhir:v "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')." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:requirements [ fhir:v "Defines the content expected to be rendered in all representations of the artifact." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "CanonicalResource.copyrightLabel" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ]
] )
] ;
fhir:differential [
fhir:element ( [
fhir:id [ fhir:v "CanonicalResource" ] ;
fhir:path [ fhir:v "CanonicalResource" ] ;
fhir:short [ fhir:v "Common Interface declaration for definitional resources" ] ;
fhir:definition [ fhir:v "Common Interface declaration for conformance and knowledge artifact resources." ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:constraint ( [
fhir:key [ fhir:v "cnl-0" ] ;
fhir:severity [ fhir:v "warning" ] ;
fhir:human [ fhir:v "Name should be usable as an identifier for the module by machine processing applications such as code generation" ] ;
fhir:expression [ fhir:v "name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/CanonicalResource" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "conformance.behavior" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.url" ] ;
fhir:path [ fhir:v "CanonicalResource.url" ] ;
fhir:short [ fhir:v "Canonical identifier for this {{title}}, represented as an absolute URI (globally unique)" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:comment [ fhir:v "Can be a urn:uuid: or a urn:oid: but real http: 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." ] ;
fhir:requirements [ fhir:v "Allows the {{title}} to be referenced by a single globally unique identifier." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "uri" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "cnl-1" ] ;
fhir:severity [ fhir:v "warning" ] ;
fhir:human [ fhir:v "URL should not contain | or # - these characters make processing canonical references problematic" ] ;
fhir:expression [ fhir:v "exists() implies matches('^[^|# ]+$')" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/CanonicalResource" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.identifier" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.identifier" ] ;
fhir:path [ fhir:v "CanonicalResource.identifier" ] ;
fhir:short [ fhir:v "Additional identifier for the {{title}}" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:requirements [ fhir:v "Allows externally provided and/or usable business identifiers to be easily associated with the {{title}}." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:type ( [
fhir:code [ fhir:v "Identifier" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.identifier" ]
] [
fhir:identity [ fhir:v "objimpl" ] ;
fhir:map [ fhir:v "no-gen-base" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.version" ] ;
fhir:path [ fhir:v "CanonicalResource.version" ] ;
fhir:short [ fhir:v "Business version of the {{title}}" ] ;
fhir:definition [ fhir:v "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 without additional knowledge. (See the versionAlgorithm element.)" ] ;
fhir:comment [ fhir:v "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)." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.version" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.versionAlgorithm[x]" ] ;
fhir:path [ fhir:v "CanonicalResource.versionAlgorithm[x]" ] ;
fhir:short [ fhir:v "How to compare versions" ] ;
fhir:definition [ fhir:v "Indicates the mechanism used to compare versions to determine which is more current." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] [
fhir:code [ fhir:v "Coding" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:strength [ fhir:v "extensible" ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/version-algorithm" ]
]
] [
fhir:id [ fhir:v "CanonicalResource.name" ] ;
fhir:path [ fhir:v "CanonicalResource.name" ] ;
fhir:short [ fhir:v "Name for this {{title}} (computer friendly)" ] ;
fhir:definition [ fhir:v "A natural language name identifying the {{title}}. This name should be usable as an identifier for the resource by machine processing applications such as code generation." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:requirements [ fhir:v "Supports code generation." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:condition ( [ fhir:v "cnl-0" ] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ]
] [
fhir:id [ fhir:v "CanonicalResource.title" ] ;
fhir:path [ fhir:v "CanonicalResource.title" ] ;
fhir:short [ fhir:v "Name for this {{title}} (human friendly)" ] ;
fhir:definition [ fhir:v "A short, descriptive, user-friendly title for the {{title}}." ] ;
fhir:comment [ fhir:v "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ]
] [
fhir:id [ fhir:v "CanonicalResource.status" ] ;
fhir:path [ fhir:v "CanonicalResource.status" ] ;
fhir:short [ fhir:v "draft | active | retired | unknown" ] ;
fhir:definition [ fhir:v "The current state of this {{title}}. " ] ;
fhir:comment [ fhir:v "A nominal state-transition diagram can be found in the [Definition pattern](definition.html#statemachine) 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.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization)." ] ;
fhir:requirements [ fhir:v "Enables tracking the life-cycle of the content and filtering of {{title}}s that are appropriate for use versus not." ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "code" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "true" ] ;
fhir:isModifierReason [ fhir:v "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "PublicationStatus" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding" ] ;
fhir:value [ fhir:v "true" ]
] ) ;
fhir:strength [ fhir:v "required" ] ;
fhir:description [ fhir:v "The lifecycle status of an artifact." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/publication-status|5.0.0" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.status" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.experimental" ] ;
fhir:path [ fhir:v "CanonicalResource.experimental" ] ;
fhir:short [ fhir:v "For testing purposes, not real usage" ] ;
fhir:definition [ fhir:v "A Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage." ] ;
fhir:comment [ fhir:v "Allows filtering of {{title}}s that are appropriate for use versus not." ] ;
fhir:requirements [ fhir:v "Enables experimental content to be developed following the same lifecycle that would be used for a production-level {{title}}." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "boolean" ]
] ) ;
fhir:meaningWhenMissing [ fhir:v "If absent, this resource is treated as though it is not experimental." ] ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.class" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.date" ] ;
fhir:path [ fhir:v "CanonicalResource.date" ] ;
fhir:short [ fhir:v "Date last changed" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:comment [ fhir:v "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.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization)." ] ;
fhir:alias ( [ fhir:v "Revision Date" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "dateTime" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.recorded" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.publisher" ] ;
fhir:path [ fhir:v "CanonicalResource.publisher" ] ;
fhir:short [ fhir:v "Name of the publisher/steward (organization or individual)" ] ;
fhir:definition [ fhir:v "The name of the organization or individual responsible for the release and ongoing maintenance of the {{title}}." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:requirements [ fhir:v "Helps establish the \"authority/credibility\" of the {{title}}. May also allow for contact." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.witness" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.contact" ] ;
fhir:path [ fhir:v "CanonicalResource.contact" ] ;
fhir:short [ fhir:v "Contact details for the publisher" ] ;
fhir:definition [ fhir:v "Contact details to assist a user in finding and communicating with the publisher." ] ;
fhir:comment [ fhir:v "May be a web site, an email address, a telephone number, etc.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization)." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:type ( [
fhir:code [ fhir:v "ContactDetail" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ]
] [
fhir:id [ fhir:v "CanonicalResource.description" ] ;
fhir:path [ fhir:v "CanonicalResource.description" ] ;
fhir:short [ fhir:v "Natural language description of the {{title}}" ] ;
fhir:definition [ fhir:v "A free text natural language description of the {{title}} from a consumer's perspective." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "markdown" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ]
] [
fhir:id [ fhir:v "CanonicalResource.useContext" ] ;
fhir:path [ fhir:v "CanonicalResource.useContext" ] ;
fhir:short [ fhir:v "The context that the content is intended to support" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:comment [ fhir:v "When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply." ] ;
fhir:requirements [ fhir:v "Assist in searching for appropriate content." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:type ( [
fhir:code [ fhir:v "UsageContext" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ]
] [
fhir:id [ fhir:v "CanonicalResource.jurisdiction" ] ;
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ] ;
fhir:value [ fhir:v "deprecated" ]
] ) ;
fhir:path [ fhir:v "CanonicalResource.jurisdiction" ] ;
fhir:short [ fhir:v "Intended jurisdiction for {{title}} (if applicable)" ] ;
fhir:definition [ fhir:v "A legal or geographic region in which the {{title}} is intended to be used." ] ;
fhir:comment [ fhir:v "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.)" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:type ( [
fhir:code [ fhir:v "CodeableConcept" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "Jurisdiction" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding" ] ;
fhir:value [ fhir:v "true" ]
] ) ;
fhir:strength [ fhir:v "extensible" ] ;
fhir:description [ fhir:v "Countries and regions within which this artifact is targeted for use." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/jurisdiction" ]
]
] [
fhir:id [ fhir:v "CanonicalResource.purpose" ] ;
fhir:path [ fhir:v "CanonicalResource.purpose" ] ;
fhir:short [ fhir:v "Why this {{title}} is defined" ] ;
fhir:definition [ fhir:v "Explanation of why this {{title}} is needed and why it has been designed as it has." ] ;
fhir:comment [ fhir:v "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}}." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "markdown" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "w5" ] ;
fhir:map [ fhir:v "FiveWs.why[x]" ]
] [
fhir:identity [ fhir:v "objimpl" ] ;
fhir:map [ fhir:v "no-gen-base" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.copyright" ] ;
fhir:path [ fhir:v "CanonicalResource.copyright" ] ;
fhir:short [ fhir:v "Use and/or publishing restrictions" ] ;
fhir:definition [ fhir:v "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}}." ] ;
fhir:comment [ fhir:v "The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element." ] ;
fhir:requirements [ fhir:v "Consumers must be able to determine any legal restrictions on the use of the {{title}} and/or its content." ] ;
fhir:alias ( [ fhir:v "License" ] [ fhir:v "Restrictions" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "markdown" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "objimpl" ] ;
fhir:map [ fhir:v "no-gen-base" ]
] )
] [
fhir:id [ fhir:v "CanonicalResource.copyrightLabel" ] ;
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable" ] ;
fhir:value [ fhir:v "true" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable" ] ;
fhir:value [ fhir:v "true" ]
] ) ;
fhir:path [ fhir:v "CanonicalResource.copyrightLabel" ] ;
fhir:short [ fhir:v "Copyright holder and year(s)" ] ;
fhir:definition [ fhir:v "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')." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:requirements [ fhir:v "Defines the content expected to be rendered in all representations of the artifact." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:mustSupport [ fhir:v "false" ] ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ]
] )
] .
# -------------------------------------------------------------------------------------
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR ®© HL7.org 2011+. FHIR R5 hl7.fhir.core#5.0.0 generated on Sun, Mar 26, 2023 15:24+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R4B |
|
Propose a change