Generated Narrative: StructureDefinition profile-NamingSystem Name Flags Card. Type Description & Constraints NamingSystem 0..* NamingSystem(4.3.0) System of unique identification #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:url 0..1 uri R5: Canonical identifier for this naming system, represented as a URI (globally unique) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-url #xD; extension:identifier 0..* Identifier R5: Additional identifier for the naming system (business identifier) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier #xD; extension:version 0..1 string R5: Business version of the naming system (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-version #xD; extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) #xD; extension:title 0..1 string R5: Title for this naming system (human friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-title #xD; extension:experimental 0..1 boolean R5: For testing purposes, not real usage (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental #xD; extension:purpose 0..1 markdown R5: Why this naming system is defined (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose #xD; extension:copyright 0..1 markdown R5: Use and/or publishing restrictions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright #xD; extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel #xD; extension:approvalDate 0..1 date R5: When the NamingSystem was approved by publisher (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate #xD; extension:lastReviewDate 0..1 date R5: When the NamingSystem was last reviewed by the publisher (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate #xD; extension:effectivePeriod 0..1 Period R5: When the NamingSystem is expected to be used (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod #xD; extension:topic 0..* CodeableConcept R5: E.g. Education, Treatment, Assessment, etc (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact #xD; extension:author 0..* ContactDetail R5: Who authored the CodeSystem (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-author #xD; extension:editor 0..* ContactDetail R5: Who edited the NamingSystem (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-editor #xD; extension:reviewer 0..* ContactDetail R5: Who reviewed the NamingSystem (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer #xD; extension:endorser 0..* ContactDetail R5: Who endorsed the NamingSystem (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser #xD; extension:relatedArtifact 0..* RelatedArtifact R5: Additional documentation, citations, etc (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact #xD; uniqueId #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:authoritative 0..1 boolean R5: Whether the identifier is authoritative (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-NamingSystem.uniqueId.authoritative #xD; type #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:type 0..1 code R5: oid | uuid | uri | iri-stem | v2csmnemonic | other additional codes URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-NamingSystem.uniqueId.type Binding: R5NamingsystemIdentifierTypeForR4B (0.1.0) (required): Identifies the style of unique identifier used to identify a namespace. #xD; Documentation for this format
Cross-version Profile for R5.NamingSystem for use in FHIR R4B
This cross-version profile allows R5 NamingSystem content to be represented via FHIR R4B NamingSystem resources.
A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
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
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
not(exists(for $contained in f:contained return $contained[not(exists(parent::*/descendant::f:reference/@value=concat('#', $contained/*/f:id/@value)) or exists(descendant::f:reference[@value='#']))]))
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If a resource is contained in another resource, it SHALL NOT have a security label
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.
A resource should have narrative for robust management
Name should be usable as an identifier for the module by machine processing applications such as code generation
name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')
Root systems cannot have uuid identifiers
kind != 'root' or uniqueId.all(type != 'uuid')
not(f:kind/@value='root' and f:uniqueId/f:type/@value='uuid')
Can't have more than one preferred identifier for a type
uniqueId.where(preferred = true).select(type).isDistinct()
not(exists(for $type in distinct-values(f:uniqueId/f:type/@value) return if (count(f:uniqueId[f:type/@value=$type and f:preferred/@value=true()])>1) then $type else ()))
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
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.
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 it's narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
The base language in which the resource is written.
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).
Text summary of the resource, for human interpretation
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.
Contained resources do not have 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.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
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.
Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
not(f:Citation|f:Evidence|f:EvidenceReport|f:EvidenceVariable|f:MedicinalProductDefinition|f:PackagedProductDefinition|f:AdministrableProductDefinition|f:Ingredient|f:ClinicalUseDefinition|f:RegulatedAuthorization|f:SubstanceDefinition|f:SubscriptionStatus|f:SubscriptionTopic) or not(parent::f:Citation|parent::f:Evidence|parent::f:EvidenceReport|parent::f:EvidenceVariable|parent::f:MedicinalProductDefinition|parent::f:PackagedProductDefinition|parent::f:AdministrableProductDefinition|parent::f:Ingredient|parent::f:ClinicalUseDefinition|parent::f:RegulatedAuthorization|parent::f:SubstanceDefinition|f:SubscriptionStatus|f:SubscriptionTopic)
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
R5: Canonical identifier for this naming system, represented as a URI (globally unique) (new)
Element `NamingSystem.url` has a context of NamingSystem based on following the parent source element upwards and mapping to `NamingSystem`. Element `NamingSystem.url` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `NamingSystem.url`: `http://hl7.org/fhir/StructureDefinition/artifact-url`. 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. The 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](https://hl7.org/fhir/resource..html#versions). In 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](https://hl7.org/fhir/resou.html#meta) element to indicate where the current master source of the resource can be found.
R5: Additional identifier for the naming system (business identifier) (new)
R5: `NamingSystem.identifier` (new:Identifier)
Element `NamingSystem.identifier` has a context of NamingSystem based on following the parent source element upwards and mapping to `NamingSystem`. Element `NamingSystem.identifier` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `NamingSystem.identifier`: `http://hl7.org/fhir/StructureDefinition/artifact-identifier`. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this naming system outside of FHIR, where it is not possible to use the logical URI.
R5: Business version of the naming system (new)
Element `NamingSystem.version` has a context of NamingSystem based on following the parent source element upwards and mapping to `NamingSystem`. Element `NamingSystem.version` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `NamingSystem.version`: `http://hl7.org/fhir/StructureDefinition/artifact-version`. There may be different naming system instances that have the same identifier 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 naming system with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](https://hl7.org/fhir/resource.h.html#bv-format).
R5: `NamingSystem.versionAlgorithm[x]` (new:Coding, string)
Element `NamingSystem.versionAlgorithm[x]` has a context of NamingSystem based on following the parent source element upwards and mapping to `NamingSystem`. Element `NamingSystem.versionAlgorithm[x]` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `NamingSystem.versionAlgorithm[x]`: `http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm`. 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.
R5: Title for this naming system (human friendly) (new)
Element `NamingSystem.title` has a context of NamingSystem based on following the parent source element upwards and mapping to `NamingSystem`. Element `NamingSystem.title` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `NamingSystem.title`: `http://hl7.org/fhir/StructureDefinition/artifact-title`. This title does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
R5: For testing purposes, not real usage (new)
R5: `NamingSystem.experimental` (new:boolean)
Element `NamingSystem.experimental` has a context of NamingSystem based on following the parent source element upwards and mapping to `NamingSystem`. Element `NamingSystem.experimental` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `NamingSystem.experimental`: `http://hl7.org/fhir/StructureDefinition/artifact-experimental`. Allows filtering of naming systems that are appropriate for use versus not.
R5: Why this naming system is defined (new)
R5: `NamingSystem.purpose` (new:markdown)
Element `NamingSystem.purpose` has a context of NamingSystem based on following the parent source element upwards and mapping to `NamingSystem`. Element `NamingSystem.purpose` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `NamingSystem.purpose`: `http://hl7.org/fhir/StructureDefinition/artifact-purpose`. This element does not describe the usage of the code system. 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 code system.
R5: Use and/or publishing restrictions (new)
R5: `NamingSystem.copyright` (new:markdown)
Element `NamingSystem.copyright` has a context of NamingSystem based on following the parent source element upwards and mapping to `NamingSystem`. Element `NamingSystem.copyright` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `NamingSystem.copyright`: `http://hl7.org/fhir/StructureDefinition/artifact-copyright`.
R5: `NamingSystem.copyrightLabel` (new:string)
Element `NamingSystem.copyrightLabel` has a context of NamingSystem based on following the parent source element upwards and mapping to `NamingSystem`. Element `NamingSystem.copyrightLabel` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `NamingSystem.copyrightLabel`: `http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel`. 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.
R5: When the NamingSystem was approved by publisher (new)
R5: `NamingSystem.approvalDate` (new:date)
Element `NamingSystem.approvalDate` has a context of NamingSystem based on following the parent source element upwards and mapping to `NamingSystem`. Element `NamingSystem.approvalDate` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `NamingSystem.approvalDate`: `http://hl7.org/fhir/StructureDefinition/artifact-approvalDate`. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. See guidance around (not) making local changes to elements [here](https://hl7.org/fhir/canonicalreso.html#localization).
R5: When the NamingSystem was last reviewed by the publisher (new)
R5: `NamingSystem.lastReviewDate` (new:date)
Element `NamingSystem.lastReviewDate` has a context of NamingSystem based on following the parent source element upwards and mapping to `NamingSystem`. Element `NamingSystem.lastReviewDate` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `NamingSystem.lastReviewDate`: `http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate`. If specified, this date follows the original approval date. See guidance around (not) making local changes to elements [here](https://hl7.org/fhir/canonicalreso.html#localization).
R5: When the NamingSystem is expected to be used (new)
R5: `NamingSystem.effectivePeriod` (new:Period)
Element `NamingSystem.effectivePeriod` has a context of NamingSystem based on following the parent source element upwards and mapping to `NamingSystem`. Element `NamingSystem.effectivePeriod` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `NamingSystem.effectivePeriod`: `http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod`. The effective period for a NamingSystem determines when the content is applicable for usage and is independent of publication and review dates. For example, a NamingSystem intended to be used for the year 2016 might be published in 2015. See guidance around (not) making local changes to elements [here](https://hl7.org/fhir/canonicalreso.html#localization).
R5: E.g. Education, Treatment, Assessment, etc (new)
R5: `NamingSystem.topic` (new:CodeableConcept)
Element `NamingSystem.topic` has a context of NamingSystem based on following the parent source element upwards and mapping to `NamingSystem`. Element `NamingSystem.topic` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `NamingSystem.topic`: `http://hl7.org/fhir/StructureDefinition/artifact-topic`. Element `NamingSystem.topic` has been flagged as deprecated. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)
R5: `NamingSystem.author` (new:ContactDetail)
Element `NamingSystem.author` has a context of NamingSystem based on following the parent source element upwards and mapping to `NamingSystem`. Element `NamingSystem.author` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `NamingSystem.author`: `http://hl7.org/fhir/StructureDefinition/artifact-author`.
R5: `NamingSystem.editor` (new:ContactDetail)
Element `NamingSystem.editor` has a context of NamingSystem based on following the parent source element upwards and mapping to `NamingSystem`. Element `NamingSystem.editor` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `NamingSystem.editor`: `http://hl7.org/fhir/StructureDefinition/artifact-editor`.
R5: `NamingSystem.reviewer` (new:ContactDetail)
Element `NamingSystem.reviewer` has a context of NamingSystem based on following the parent source element upwards and mapping to `NamingSystem`. Element `NamingSystem.reviewer` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `NamingSystem.reviewer`: `http://hl7.org/fhir/StructureDefinition/artifact-reviewer`. See guidance around (not) making local changes to elements [here](https://hl7.org/fhir/canonicalreso.html#localization).
R5: `NamingSystem.endorser` (new:ContactDetail)
Element `NamingSystem.endorser` has a context of NamingSystem based on following the parent source element upwards and mapping to `NamingSystem`. Element `NamingSystem.endorser` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `NamingSystem.endorser`: `http://hl7.org/fhir/StructureDefinition/artifact-endorser`. See guidance around (not) making local changes to elements [here](https://hl7.org/fhir/canonicalreso.html#localization).
R5: Additional documentation, citations, etc (new)
R5: `NamingSystem.relatedArtifact` (new:RelatedArtifact)
Element `NamingSystem.relatedArtifact` has a context of NamingSystem based on following the parent source element upwards and mapping to `NamingSystem`. Element `NamingSystem.relatedArtifact` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `NamingSystem.relatedArtifact`: `http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact`. Each related artifact is either an attachment, or a reference to another resource, but not both.
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 manageable, 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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.
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](http://hl7.org/fhir/R4B/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Name for this naming system (computer friendly)
A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation.
The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.The"symbolic name" for an OID would be captured as an extension.
Support human navigation and code generation.
The status of this naming system. Enables tracking the life-cycle of the content.
Allows filtering of naming systems that are appropriate for use versus not.
This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
Indicates the purpose for the naming system - what kinds of things does it make unique?
Identifies the purpose of the naming system.
The date (and optionally time) when the naming system was published. 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 naming system changes.
Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the naming system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
Name of the publisher (organization or individual)
The name of the organization or individual that published the naming system.
Usually an organization but may be an individual. The publisher (or steward) of the naming system is the organization or individual primarily responsible for the maintenance and upkeep of the naming system. 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 naming system. This item SHOULD be populated unless the information is available from context.
Helps establish the "authority/credibility" of the naming system. May also allow for contact.
Contact details to assist a user in finding and communicating with the publisher.
May be a web site, an email address, a telephone number, etc.
The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
This is the primary organization. Responsibility for some aspects of a namespace may be delegated.
e.g. driver, provider, patient, bank etc.
Categorizes a naming system for easier search by grouping related naming systems.
This will most commonly be used for identifier namespaces, but categories could potentially be useful for code systems and authorities as well.
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Natural language description of the naming system
A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc.
This description can be used to capture details such as why the naming system was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the naming system as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the naming system is presumed to be the predominant language in the place the naming system was created).
The context that the content is intended to support
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 naming system instances.
When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Assist in searching for appropriate content.
Intended jurisdiction for naming system (if applicable)
A legal or geographic region in which the naming system is intended to be used.
It may be possible for the naming system to be used in jurisdictions other than those for which it was originally designed or intended.
Countries and regions within which this artifact is targeted for use.
Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.
Indicates how the system may be identified when referenced in electronic exchange.
Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.
All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
R5: Whether the identifier is authoritative (new)
R5: `NamingSystem.uniqueId.authoritative` (new:boolean)
Element `NamingSystem.uniqueId.authoritative` has a context of NamingSystem.uniqueId based on following the parent source element upwards and mapping to `NamingSystem`. Element `NamingSystem.uniqueId.authoritative` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
Extensions that cannot be ignored even if unrecognized
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 manageable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Identifies the unique identifier scheme used for this particular identifier.
Different identifier types may be used in different types of communications (OIDs for v3, URIs for FHIR, etc.). Other includes RUIDs from v3, standard v2 code name strings, etc.
Identifies the style of unique identifier used to identify a namespace.
unique id for the element within a resource (for internal references)
R5: oid | uuid | uri | iri-stem | v2csmnemonic | other additional codes
R5: `NamingSystem.uniqueId.type` additional codes
Element `NamingSystem.uniqueId.type` is mapped to FHIR R4B element `NamingSystem.uniqueId.type` as `RelatedTo`. The mappings for `NamingSystem.uniqueId.type` do not allow expression of the necessary codes, per the bindings on the source and target. Different identifier types may be used in different types of communications (OIDs for v3, URIs for FHIR, etc.). Other includes RUIDs from v3, standard v2 code name strings, etc. Preferred identifiers for the same identifier type SHOULD NOT overlap by period.
The string that should be sent over the wire to identify the code system or identifier system.
If the value is a URI intended for use as FHIR system identifier, the URI should not contain "\" or "?" or "," since this makes escaping very difficult.
Is this the id that should be used for this type
Indicates whether this identifier is the "preferred" identifier of this type.
If there are multiple ids, and one is labeled "preferred", then the assumption is that the others are not preferred. In the absence of any id marked as preferred, no inference can be drawn
Notes about the past or intended usage of this identifier.
e.g. "must be used in Germany" or "was initially published in error with this value".
Identifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic.
Within a registry, a given identifier should only be "active" for a single namespace at a time. (Ideally, an identifier should only ever be associated with a single namespace across all time).