Canonical Resource Management Infrastructure Implementation Guide
1.1.0-cibuild - cibuild International flag

Canonical Resource Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 1.1.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions

Resource Profile: CRMIPublishableNamingSystem - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 1

Definitions for the crmi-publishablenamingsystem resource profile.

Guidance on how to interpret the contents of this table can be found here

0. NamingSystem
Control1..1
2. NamingSystem.extension:identifier
Slice Nameidentifier
Control0..*
TypeExtension(Artifact Identifier) (Extension Type: Identifier)
Must Supporttrue
4. NamingSystem.extension:purpose
Slice Namepurpose
Control0..1
TypeExtension(Artifact Purpose) (Extension Type: markdown)
Must Supporttrue
6. NamingSystem.extension:copyright
Slice Namecopyright
Control0..1
TypeExtension(Artifact Copyright) (Extension Type: markdown)
Must Supporttrue
8. NamingSystem.extension:copyrightLabel
Slice NamecopyrightLabel
Control0..1
TypeExtension(Artifact Copyright Label) (Extension Type: string)
Must Supporttrue
10. NamingSystem.extension:approvalDate
Slice NameapprovalDate
Control0..1
TypeExtension(Artifact Approval Date) (Extension Type: date)
Must Supporttrue
12. NamingSystem.extension:lastReviewDate
Slice NamelastReviewDate
Control0..1
TypeExtension(Artifact Last Review Date) (Extension Type: date)
Must Supporttrue
14. NamingSystem.extension:effectivePeriod
Slice NameeffectivePeriod
Control0..1
TypeExtension(Artifact Effective Period) (Extension Type: Period)
Must Supporttrue
16. NamingSystem.extension:topic
Slice Nametopic
Control0..*
TypeExtension(Artifact Topic) (Extension Type: CodeableConcept)
Must Supporttrue
18. NamingSystem.extension:author
Slice Nameauthor
Control0..*
TypeExtension(Artifact Author) (Extension Type: ContactDetail)
Must Supporttrue
20. NamingSystem.extension:editor
Slice Nameeditor
Control0..*
TypeExtension(Artifact Editor) (Extension Type: ContactDetail)
Must Supporttrue
22. NamingSystem.extension:reviewer
Slice Namereviewer
Control0..*
TypeExtension(Artifact Reviewer) (Extension Type: ContactDetail)
Must Supporttrue
24. NamingSystem.extension:endorser
Slice Nameendorser
Control0..*
TypeExtension(Artifact Endorser) (Extension Type: ContactDetail)
Must Supporttrue
26. NamingSystem.extension:relatedArtifact
Slice NamerelatedArtifact
Control0..*
TypeExtension(Artifact related artifact) (Extension Type: RelatedArtifact)
Must Supporttrue
28. NamingSystem.date
Control1..1
Must Supporttrue
30. NamingSystem.contact
Must Supporttrue
32. NamingSystem.useContext
Must Supporttrue
34. NamingSystem.jurisdiction
Must Supporttrue

Guidance on how to interpret the contents of this table can be found here

0. NamingSystem
Definition

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.

ShortSystem of unique identification
Control10..1*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: 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())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
nsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
nsd-1: Root systems cannot have uuid identifiers (kind != 'root' or uniqueId.all(type != 'uuid'))
nsd-2: Can't have more than one preferred identifier for a type (uniqueId.where(preferred = true).select(type).isDistinct())
nsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
nsd-1: Root systems cannot have uuid identifiers (kind != 'root' or uniqueId.all(type != 'uuid'))
nsd-2: Can't have more than one preferred identifier for a type (uniqueId.where(preferred = true).select(type).isDistinct())
2. NamingSystem.implicitRules
Definition

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.

ShortA set of rules under which this content was created
Comments

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.

Control0..1
Typeuri
Is Modifiertrue because 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
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. NamingSystem.extension:identifier
Slice Nameidentifier
Definition

A formal identifier that is used to identify this artifact when it is represented in other formats, or referenced in a specification, model, design or an instance.

ShortAdditional identifier for the artifact
Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this artifact outside of FHIR, where it is not possible to use the logical URI.

Control0..*
TypeExtension(Artifact Identifier) (Extension Type: Identifier)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. NamingSystem.extension:purpose
Slice Namepurpose
Definition

Explanation of why this artifact is needed and why it has been designed as it has.

ShortWhy this artifact is defined
Comments

This element does not describe the usage of the artifact. 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 artifact.

Control0..1
TypeExtension(Artifact Purpose) (Extension Type: markdown)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. NamingSystem.extension:copyright
Slice Namecopyright
Definition

A copyright statement relating to the artifact and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the artifact.

ShortUse and/or publishing restrictions
Comments

The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.

Control0..1
TypeExtension(Artifact Copyright) (Extension Type: markdown)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. NamingSystem.extension:copyrightLabel
Slice NamecopyrightLabel
Definition

A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

ShortCopyright holder and year(s)
Comments

Defines the content expected to be rendered in all representations of the artifact. The (c) symbol should NOT be included in this string. It is expected to be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

Control0..1
TypeExtension(Artifact Copyright Label) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. NamingSystem.extension:approvalDate
Slice NameapprovalDate
Definition

The date on which the artifact content was approved by the publisher. Approval happens once when the content is officially approved for usage.

ShortWhen the artifact was approved by publisher
Comments

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

Control0..1
TypeExtension(Artifact Approval Date) (Extension Type: date)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. NamingSystem.extension:lastReviewDate
Slice NamelastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

ShortWhen the artifact was approved by publisher
Comments

If specified, this date follows the original approval date.

Control0..1
TypeExtension(Artifact Last Review Date) (Extension Type: date)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. NamingSystem.extension:effectivePeriod
Slice NameeffectivePeriod
Definition

The period during which the artifact content was or is planned to be in active use.

ShortWhen the artifact is expected to be used
Comments

The effective period for an artifact determines when the content is applicable for usage and is independent of publication and review dates. For example, an artifact intended to be used for the year 2016 might be published in 2015.

Control0..1
TypeExtension(Artifact Effective Period) (Extension Type: Period)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. NamingSystem.extension:topic
Slice Nametopic
Definition

Descriptive topics related to the content of the artifact. Topics provide a high-level categorization of the artifact that can be useful for filtering and searching.

ShortE.g. Education, Treatment, Assessment, etc.
Comments

This element provides a topical categorization of the artifact, as opposed to the more structured context-of-use information provided in the useContext element.

Control0..*
TypeExtension(Artifact Topic) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. NamingSystem.extension:author
Slice Nameauthor
Definition

An individual or organization primarily involved in the creation and maintenance of the artifact.

ShortWho authored the artifact
Control0..*
TypeExtension(Artifact Author) (Extension Type: ContactDetail)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
22. NamingSystem.extension:editor
Slice Nameeditor
Definition

An individual or organization primarily responsible for internal coherence of the artifact.

ShortWho edited the artifact
Control0..*
TypeExtension(Artifact Editor) (Extension Type: ContactDetail)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
24. NamingSystem.extension:reviewer
Slice Namereviewer
Definition

An individual or organization primarily responsible for review of some aspect of the artifact.

ShortWho reviewed the artifact
Control0..*
TypeExtension(Artifact Reviewer) (Extension Type: ContactDetail)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
26. NamingSystem.extension:endorser
Slice Nameendorser
Definition

An individual or organization responsible for officially endorsing the artifact for use in some setting.

ShortWho endorsed the artifact
Control0..*
TypeExtension(Artifact Endorser) (Extension Type: ContactDetail)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
28. NamingSystem.extension:relatedArtifact
Slice NamerelatedArtifact
Definition

Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.

ShortAdditional documentation, citations, etc.
Comments

Each related artifact is either an attachment, or a reference to another resource, but not both.

Control0..*
TypeExtension(Artifact related artifact) (Extension Type: RelatedArtifact)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
30. NamingSystem.modifierExtension
Definition

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).

ShortExtensions that cannot be ignored
Comments

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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

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.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
32. NamingSystem.name
Definition

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.

ShortName for this naming system (computer friendly)
Comments

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.

Control1..1
This element is affected by the following invariants: inv-0
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Support human navigation and code generation.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. NamingSystem.status
Definition

The status of this naming system. Enables tracking the life-cycle of the content.

Shortdraft | active | retired | unknown
Comments

Allows filtering of naming systems that are appropriate for use versus not.

Control1..1
BindingThe codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1
(required to http://hl7.org/fhir/ValueSet/publication-status|4.0.1)

The lifecycle status of an artifact.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. NamingSystem.kind
Definition

Indicates the purpose for the naming system - what kinds of things does it make unique?

Shortcodesystem | identifier | root
Control1..1
BindingThe codes SHALL be taken from NamingSystemTypehttp://hl7.org/fhir/ValueSet/namingsystem-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/namingsystem-type|4.0.1)

Identifies the purpose of the naming system.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. NamingSystem.date
Definition

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.

ShortDate last changed
Comments

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.

Control1..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesRevision Date
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. NamingSystem.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

ShortContact details for the publisher
Comments

May be a web site, an email address, a telephone number, etc.

Control0..*
TypeContactDetail
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. NamingSystem.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate naming system instances.

ShortThe context that the content is intended to support
Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

Control0..*
TypeUsageContext
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Assist in searching for appropriate content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. NamingSystem.jurisdiction
Definition

A legal or geographic region in which the naming system is intended to be used.

ShortIntended jurisdiction for naming system (if applicable)
Comments

It may be possible for the naming system to be used in jurisdictions other than those for which it was originally designed or intended.

Control0..*
BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction
(extensible to http://hl7.org/fhir/ValueSet/jurisdiction)

Countries and regions within which this artifact is targeted for use.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. NamingSystem.uniqueId
Definition

Indicates how the system may be identified when referenced in electronic exchange.

ShortUnique identifiers used for system
Comments

Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.

Control1..*
TypeBackboneElement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. NamingSystem.uniqueId.modifierExtension
Definition

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).

ShortExtensions that cannot be ignored even if unrecognized
Comments

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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
50. NamingSystem.uniqueId.type
Definition

Identifies the unique identifier scheme used for this particular identifier.

Shortoid | uuid | uri | other
Comments

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.

Control1..1
BindingThe codes SHALL be taken from NamingSystemIdentifierTypehttp://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.0.1)

Identifies the style of unique identifier used to identify a namespace.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. NamingSystem.uniqueId.value
Definition

The string that should be sent over the wire to identify the code system or identifier system.

ShortThe unique identifier
Comments

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.

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. NamingSystem
Definition

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.

ShortSystem of unique identification
Control1..1
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: 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())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
nsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
nsd-1: Root systems cannot have uuid identifiers (kind != 'root' or uniqueId.all(type != 'uuid'))
nsd-2: Can't have more than one preferred identifier for a type (uniqueId.where(preferred = true).select(type).isDistinct())
2. NamingSystem.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control0..1
Typeid
Is Modifierfalse
Summarytrue
4. NamingSystem.meta
Definition

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.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. NamingSystem.implicitRules
Definition

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.

ShortA set of rules under which this content was created
Comments

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.

Control0..1
Typeuri
Is Modifiertrue because 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
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. NamingSystem.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

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).

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages)

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. NamingSystem.text
Definition

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.

ShortText summary of the resource, for human interpretation
Comments

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.

Control0..1
TypeNarrative
Is Modifierfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. NamingSystem.contained
Definition

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.

ShortContained, inline Resources
Comments

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.

Control0..*
TypeResource
Is Modifierfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. NamingSystem.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on NamingSystem.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 16. NamingSystem.extension:identifier
    Slice Nameidentifier
    Definition

    A formal identifier that is used to identify this artifact when it is represented in other formats, or referenced in a specification, model, design or an instance.

    ShortAdditional identifier for the artifact
    Comments

    Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this artifact outside of FHIR, where it is not possible to use the logical URI.

    Control0..*
    TypeExtension(Artifact Identifier) (Extension Type: Identifier)
    Is Modifierfalse
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    18. NamingSystem.extension:purpose
    Slice Namepurpose
    Definition

    Explanation of why this artifact is needed and why it has been designed as it has.

    ShortWhy this artifact is defined
    Comments

    This element does not describe the usage of the artifact. 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 artifact.

    Control0..1
    TypeExtension(Artifact Purpose) (Extension Type: markdown)
    Is Modifierfalse
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    20. NamingSystem.extension:copyright
    Slice Namecopyright
    Definition

    A copyright statement relating to the artifact and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the artifact.

    ShortUse and/or publishing restrictions
    Comments

    The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.

    Control0..1
    TypeExtension(Artifact Copyright) (Extension Type: markdown)
    Is Modifierfalse
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    22. NamingSystem.extension:copyrightLabel
    Slice NamecopyrightLabel
    Definition

    A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

    ShortCopyright holder and year(s)
    Comments

    Defines the content expected to be rendered in all representations of the artifact. The (c) symbol should NOT be included in this string. It is expected to be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

    Control0..1
    TypeExtension(Artifact Copyright Label) (Extension Type: string)
    Is Modifierfalse
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    24. NamingSystem.extension:approvalDate
    Slice NameapprovalDate
    Definition

    The date on which the artifact content was approved by the publisher. Approval happens once when the content is officially approved for usage.

    ShortWhen the artifact was approved by publisher
    Comments

    The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

    Control0..1
    TypeExtension(Artifact Approval Date) (Extension Type: date)
    Is Modifierfalse
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    26. NamingSystem.extension:lastReviewDate
    Slice NamelastReviewDate
    Definition

    The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

    ShortWhen the artifact was approved by publisher
    Comments

    If specified, this date follows the original approval date.

    Control0..1
    TypeExtension(Artifact Last Review Date) (Extension Type: date)
    Is Modifierfalse
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    28. NamingSystem.extension:effectivePeriod
    Slice NameeffectivePeriod
    Definition

    The period during which the artifact content was or is planned to be in active use.

    ShortWhen the artifact is expected to be used
    Comments

    The effective period for an artifact determines when the content is applicable for usage and is independent of publication and review dates. For example, an artifact intended to be used for the year 2016 might be published in 2015.

    Control0..1
    TypeExtension(Artifact Effective Period) (Extension Type: Period)
    Is Modifierfalse
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    30. NamingSystem.extension:topic
    Slice Nametopic
    Definition

    Descriptive topics related to the content of the artifact. Topics provide a high-level categorization of the artifact that can be useful for filtering and searching.

    ShortE.g. Education, Treatment, Assessment, etc.
    Comments

    This element provides a topical categorization of the artifact, as opposed to the more structured context-of-use information provided in the useContext element.

    Control0..*
    TypeExtension(Artifact Topic) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    32. NamingSystem.extension:author
    Slice Nameauthor
    Definition

    An individual or organization primarily involved in the creation and maintenance of the artifact.

    ShortWho authored the artifact
    Control0..*
    TypeExtension(Artifact Author) (Extension Type: ContactDetail)
    Is Modifierfalse
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    34. NamingSystem.extension:editor
    Slice Nameeditor
    Definition

    An individual or organization primarily responsible for internal coherence of the artifact.

    ShortWho edited the artifact
    Control0..*
    TypeExtension(Artifact Editor) (Extension Type: ContactDetail)
    Is Modifierfalse
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    36. NamingSystem.extension:reviewer
    Slice Namereviewer
    Definition

    An individual or organization primarily responsible for review of some aspect of the artifact.

    ShortWho reviewed the artifact
    Control0..*
    TypeExtension(Artifact Reviewer) (Extension Type: ContactDetail)
    Is Modifierfalse
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    38. NamingSystem.extension:endorser
    Slice Nameendorser
    Definition

    An individual or organization responsible for officially endorsing the artifact for use in some setting.

    ShortWho endorsed the artifact
    Control0..*
    TypeExtension(Artifact Endorser) (Extension Type: ContactDetail)
    Is Modifierfalse
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    40. NamingSystem.extension:relatedArtifact
    Slice NamerelatedArtifact
    Definition

    Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.

    ShortAdditional documentation, citations, etc.
    Comments

    Each related artifact is either an attachment, or a reference to another resource, but not both.

    Control0..*
    TypeExtension(Artifact related artifact) (Extension Type: RelatedArtifact)
    Is Modifierfalse
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    42. NamingSystem.modifierExtension
    Definition

    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).

    ShortExtensions that cannot be ignored
    Comments

    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.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    Requirements

    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.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    44. NamingSystem.name
    Definition

    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.

    ShortName for this naming system (computer friendly)
    Comments

    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.

    Control1..1
    This element is affected by the following invariants: inv-0
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Support human navigation and code generation.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    46. NamingSystem.status
    Definition

    The status of this naming system. Enables tracking the life-cycle of the content.

    Shortdraft | active | retired | unknown
    Comments

    Allows filtering of naming systems that are appropriate for use versus not.

    Control1..1
    BindingThe codes SHALL be taken from PublicationStatus
    (required to http://hl7.org/fhir/ValueSet/publication-status|4.0.1)

    The lifecycle status of an artifact.

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    48. NamingSystem.kind
    Definition

    Indicates the purpose for the naming system - what kinds of things does it make unique?

    Shortcodesystem | identifier | root
    Control1..1
    BindingThe codes SHALL be taken from NamingSystemType
    (required to http://hl7.org/fhir/ValueSet/namingsystem-type|4.0.1)

    Identifies the purpose of the naming system.

    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    50. NamingSystem.date
    Definition

    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.

    ShortDate last changed
    Comments

    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.

    Control1..1
    TypedateTime
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Alternate NamesRevision Date
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    52. NamingSystem.publisher
    Definition

    The name of the organization or individual that published the naming system.

    ShortName of the publisher (organization or individual)
    Comments

    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.

    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Helps establish the "authority/credibility" of the naming system. May also allow for contact.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    54. NamingSystem.contact
    Definition

    Contact details to assist a user in finding and communicating with the publisher.

    ShortContact details for the publisher
    Comments

    May be a web site, an email address, a telephone number, etc.

    Control0..*
    TypeContactDetail
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    56. NamingSystem.responsible
    Definition

    The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.

    ShortWho maintains system namespace?
    Comments

    This is the primary organization. Responsibility for some aspects of a namespace may be delegated.

    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    58. NamingSystem.type
    Definition

    Categorizes a naming system for easier search by grouping related naming systems.

    Shorte.g. driver, provider, patient, bank etc.
    Comments

    This will most commonly be used for identifier namespaces, but categories could potentially be useful for code systems and authorities as well.

    Control0..1
    BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
    (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

    A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

    TypeCodeableConcept
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    60. NamingSystem.description
    Definition

    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.

    ShortNatural language description of the naming system
    Comments

    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).

    Control0..1
    Typemarkdown
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    62. NamingSystem.useContext
    Definition

    The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate naming system instances.

    ShortThe context that the content is intended to support
    Comments

    When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

    Control0..*
    TypeUsageContext
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Requirements

    Assist in searching for appropriate content.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    64. NamingSystem.jurisdiction
    Definition

    A legal or geographic region in which the naming system is intended to be used.

    ShortIntended jurisdiction for naming system (if applicable)
    Comments

    It may be possible for the naming system to be used in jurisdictions other than those for which it was originally designed or intended.

    Control0..*
    BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSet
    (extensible to http://hl7.org/fhir/ValueSet/jurisdiction)

    Countries and regions within which this artifact is targeted for use.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    66. NamingSystem.usage
    Definition

    Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.

    ShortHow/where is it used
    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    68. NamingSystem.uniqueId
    Definition

    Indicates how the system may be identified when referenced in electronic exchange.

    ShortUnique identifiers used for system
    Comments

    Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.

    Control1..*
    TypeBackboneElement
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    70. NamingSystem.uniqueId.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    72. NamingSystem.uniqueId.extension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element. 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.

    ShortAdditional content defined by implementations
    Comments

    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.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    74. NamingSystem.uniqueId.modifierExtension
    Definition

    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).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    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.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    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.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    76. NamingSystem.uniqueId.type
    Definition

    Identifies the unique identifier scheme used for this particular identifier.

    Shortoid | uuid | uri | other
    Comments

    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.

    Control1..1
    BindingThe codes SHALL be taken from NamingSystemIdentifierType
    (required to http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.0.1)

    Identifies the style of unique identifier used to identify a namespace.

    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    78. NamingSystem.uniqueId.value
    Definition

    The string that should be sent over the wire to identify the code system or identifier system.

    ShortThe unique identifier
    Comments

    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.

    Control1..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    80. NamingSystem.uniqueId.preferred
    Definition

    Indicates whether this identifier is the "preferred" identifier of this type.

    ShortIs this the id that should be used for this type
    Control0..1
    Typeboolean
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Meaning if MissingIf 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
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    82. NamingSystem.uniqueId.comment
    Definition

    Notes about the past or intended usage of this identifier.

    ShortNotes about identifier usage
    Comments

    e.g. "must be used in Germany" or "was initially published in error with this value".

    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    84. NamingSystem.uniqueId.period
    Definition

    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.

    ShortWhen is identifier valid?
    Comments

    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).

    Control0..1
    TypePeriod
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))