Content Repository Management Infrastructure Implementation Guide
3.0.0-ballot - STU 3 Ballot International flag

Content Repository 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 3.0.0-ballot 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: CRMI Shareable NamingSystem

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablenamingsystem Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 1 Responsible: HL7 International / Terminology Infrastructure Computable Name: CRMIShareableNamingSystem
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.53

Enforces the minimum information set for the naming system metadata required by HL7 and other organizations that share and publish naming systems

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
NamingSystem C 1..1 NamingSystem System of unique identification
Constraints: nsd-0, nsd-1, nsd-2, shr-1
NamingSystem.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
NamingSystem.Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
NamingSystem.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
NamingSystem.Slices for extension.extension:url This element must be supported. 1..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
NamingSystem.Slices for extension.extension:version This element must be supported. 1..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
NamingSystem.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
NamingSystem.Slices for extension.extension:versionPolicy 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
NamingSystem.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
NamingSystem.Slices for extension.extension:title This element must be supported. 1..1 string Name for this artifact (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
NamingSystem.Slices for extension.extension:experimental This element must be supported. 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
NamingSystem.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
NamingSystem.name This element must be supported. This element is included in summaries. C 1..1 string Name for this naming system (computer friendly)
NamingSystem.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
NamingSystem.kind This element is included in summaries. 1..1 code codesystem | identifier | root
Binding: NamingSystemType (required): Identifies the purpose of the naming system.
NamingSystem.date This element is included in summaries. 1..1 dateTime Date last changed
NamingSystem.publisher This element must be supported. This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
NamingSystem.description This element must be supported. 1..1 markdown Natural language description of the naming system
NamingSystem.uniqueId This element is included in summaries. 1..* BackboneElement Unique identifiers used for system
NamingSystem.uniqueId.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
NamingSystem.uniqueId.type This element is included in summaries. 1..1 code oid | uuid | uri | other
Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.
NamingSystem.uniqueId.value This element is included in summaries. 1..1 string The unique identifier

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
NamingSystem.status Base required PublicationStatus 📍4.0.1 FHIR Std.
NamingSystem.kind Base required NamingSystemType 📍4.0.1 FHIR Std.
NamingSystem.uniqueId.​type Base required NamingSystemIdentifierType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error NamingSystem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error NamingSystem 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 error NamingSystem 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 error NamingSystem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice NamingSystem A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
nsd-0 warning NamingSystem 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 error NamingSystem Root systems cannot have uuid identifiers kind != 'root' or uniqueId.all(type != 'uuid')
nsd-2 error NamingSystem Can't have more than one preferred identifier for a type uniqueId.where(preferred = true).select(type).isDistinct()
shr-1 error NamingSystem If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()

This structure is derived from NamingSystem

NameFlagsCard.TypeDescription & Constraints    Filter: doco
NamingSystem C 1..1 NamingSystem System of unique identification
Constraints: shr-1
NamingSystem.Slices for extension Content/Rules for all slices
NamingSystem.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
NamingSystem.Slices for extension.extension:url This element must be supported. 1..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
NamingSystem.Slices for extension.extension:version This element must be supported. 1..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
NamingSystem.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
NamingSystem.Slices for extension.extension:versionPolicy 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
NamingSystem.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
NamingSystem.Slices for extension.extension:title This element must be supported. 1..1 string Name for this artifact (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
NamingSystem.Slices for extension.extension:experimental This element must be supported. 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
NamingSystem.name This element must be supported. 1..1 string Name for this naming system (computer friendly)
NamingSystem.status This element must be supported. 1..1 code draft | active | retired | unknown
NamingSystem.description This element must be supported. 1..1 markdown Natural language description of the naming system

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
shr-1 error NamingSystem If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
NamingSystem C 1..1 NamingSystem System of unique identification
Constraints: nsd-0, nsd-1, nsd-2, shr-1
NamingSystem.id This element is included in summaries. 0..1 id Logical id of this artifact
NamingSystem.meta This element is included in summaries. 0..1 Meta Metadata about the resource
NamingSystem.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
NamingSystem.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
NamingSystem.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
NamingSystem.contained 0..* Resource Contained, inline Resources
NamingSystem.Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
NamingSystem.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
NamingSystem.Slices for extension.extension:url This element must be supported. 1..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
NamingSystem.Slices for extension.extension:version This element must be supported. 1..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
NamingSystem.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
NamingSystem.Slices for extension.extension:versionPolicy 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
NamingSystem.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
NamingSystem.Slices for extension.extension:title This element must be supported. 1..1 string Name for this artifact (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
NamingSystem.Slices for extension.extension:experimental This element must be supported. 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
NamingSystem.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
NamingSystem.name This element must be supported. This element is included in summaries. C 1..1 string Name for this naming system (computer friendly)
NamingSystem.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
NamingSystem.kind This element is included in summaries. 1..1 code codesystem | identifier | root
Binding: NamingSystemType (required): Identifies the purpose of the naming system.
NamingSystem.date This element is included in summaries. 1..1 dateTime Date last changed
NamingSystem.publisher This element must be supported. This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
NamingSystem.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
NamingSystem.responsible 0..1 string Who maintains system namespace?
NamingSystem.type 0..1 CodeableConcept e.g. driver, provider, patient, bank etc.
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
NamingSystem.description This element must be supported. 1..1 markdown Natural language description of the naming system
NamingSystem.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
NamingSystem.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for naming system (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
NamingSystem.usage 0..1 string How/where is it used
NamingSystem.uniqueId This element is included in summaries. 1..* BackboneElement Unique identifiers used for system
NamingSystem.uniqueId.id 0..1 string Unique id for inter-element referencing
NamingSystem.uniqueId.extension 0..* Extension Additional content defined by implementations
NamingSystem.uniqueId.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
NamingSystem.uniqueId.type This element is included in summaries. 1..1 code oid | uuid | uri | other
Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.
NamingSystem.uniqueId.value This element is included in summaries. 1..1 string The unique identifier
NamingSystem.uniqueId.preferred 0..1 boolean Is this the id that should be used for this type
NamingSystem.uniqueId.comment 0..1 string Notes about identifier usage
NamingSystem.uniqueId.period 0..1 Period When is identifier valid?

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
NamingSystem.language Base preferred Common Languages 📍4.0.1 FHIR Std.
NamingSystem.status Base required PublicationStatus 📍4.0.1 FHIR Std.
NamingSystem.kind Base required NamingSystemType 📍4.0.1 FHIR Std.
NamingSystem.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
NamingSystem.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
NamingSystem.uniqueId.​type Base required NamingSystemIdentifierType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error NamingSystem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error NamingSystem 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 error NamingSystem 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 error NamingSystem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice NamingSystem A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
nsd-0 warning NamingSystem 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 error NamingSystem Root systems cannot have uuid identifiers kind != 'root' or uniqueId.all(type != 'uuid')
nsd-2 error NamingSystem Can't have more than one preferred identifier for a type uniqueId.where(preferred = true).select(type).isDistinct()
shr-1 error NamingSystem If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
NamingSystem C 1..1 NamingSystem System of unique identification
Constraints: nsd-0, nsd-1, nsd-2, shr-1
NamingSystem.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
NamingSystem.Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
NamingSystem.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
NamingSystem.Slices for extension.extension:url This element must be supported. 1..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
NamingSystem.Slices for extension.extension:version This element must be supported. 1..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
NamingSystem.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
NamingSystem.Slices for extension.extension:versionPolicy 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
NamingSystem.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
NamingSystem.Slices for extension.extension:title This element must be supported. 1..1 string Name for this artifact (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
NamingSystem.Slices for extension.extension:experimental This element must be supported. 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
NamingSystem.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
NamingSystem.name This element must be supported. This element is included in summaries. C 1..1 string Name for this naming system (computer friendly)
NamingSystem.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
NamingSystem.kind This element is included in summaries. 1..1 code codesystem | identifier | root
Binding: NamingSystemType (required): Identifies the purpose of the naming system.
NamingSystem.date This element is included in summaries. 1..1 dateTime Date last changed
NamingSystem.publisher This element must be supported. This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
NamingSystem.description This element must be supported. 1..1 markdown Natural language description of the naming system
NamingSystem.uniqueId This element is included in summaries. 1..* BackboneElement Unique identifiers used for system
NamingSystem.uniqueId.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
NamingSystem.uniqueId.type This element is included in summaries. 1..1 code oid | uuid | uri | other
Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.
NamingSystem.uniqueId.value This element is included in summaries. 1..1 string The unique identifier

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
NamingSystem.status Base required PublicationStatus 📍4.0.1 FHIR Std.
NamingSystem.kind Base required NamingSystemType 📍4.0.1 FHIR Std.
NamingSystem.uniqueId.​type Base required NamingSystemIdentifierType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error NamingSystem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error NamingSystem 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 error NamingSystem 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 error NamingSystem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice NamingSystem A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
nsd-0 warning NamingSystem 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 error NamingSystem Root systems cannot have uuid identifiers kind != 'root' or uniqueId.all(type != 'uuid')
nsd-2 error NamingSystem Can't have more than one preferred identifier for a type uniqueId.where(preferred = true).select(type).isDistinct()
shr-1 error NamingSystem If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()

Differential View

This structure is derived from NamingSystem

NameFlagsCard.TypeDescription & Constraints    Filter: doco
NamingSystem C 1..1 NamingSystem System of unique identification
Constraints: shr-1
NamingSystem.Slices for extension Content/Rules for all slices
NamingSystem.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
NamingSystem.Slices for extension.extension:url This element must be supported. 1..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
NamingSystem.Slices for extension.extension:version This element must be supported. 1..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
NamingSystem.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
NamingSystem.Slices for extension.extension:versionPolicy 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
NamingSystem.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
NamingSystem.Slices for extension.extension:title This element must be supported. 1..1 string Name for this artifact (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
NamingSystem.Slices for extension.extension:experimental This element must be supported. 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
NamingSystem.name This element must be supported. 1..1 string Name for this naming system (computer friendly)
NamingSystem.status This element must be supported. 1..1 code draft | active | retired | unknown
NamingSystem.publisher This element must be supported. 0..1 string Name of the publisher (organization or individual)
NamingSystem.description This element must be supported. 1..1 markdown Natural language description of the naming system

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
shr-1 error NamingSystem If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
NamingSystem C 1..1 NamingSystem System of unique identification
Constraints: nsd-0, nsd-1, nsd-2, shr-1
NamingSystem.id This element is included in summaries. 0..1 id Logical id of this artifact
NamingSystem.meta This element is included in summaries. 0..1 Meta Metadata about the resource
NamingSystem.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
NamingSystem.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
NamingSystem.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
NamingSystem.contained 0..* Resource Contained, inline Resources
NamingSystem.Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
NamingSystem.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
NamingSystem.Slices for extension.extension:url This element must be supported. 1..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
NamingSystem.Slices for extension.extension:version This element must be supported. 1..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
NamingSystem.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
NamingSystem.Slices for extension.extension:versionPolicy 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
NamingSystem.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
NamingSystem.Slices for extension.extension:title This element must be supported. 1..1 string Name for this artifact (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
NamingSystem.Slices for extension.extension:experimental This element must be supported. 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
NamingSystem.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
NamingSystem.name This element must be supported. This element is included in summaries. C 1..1 string Name for this naming system (computer friendly)
NamingSystem.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
NamingSystem.kind This element is included in summaries. 1..1 code codesystem | identifier | root
Binding: NamingSystemType (required): Identifies the purpose of the naming system.
NamingSystem.date This element is included in summaries. 1..1 dateTime Date last changed
NamingSystem.publisher This element must be supported. This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
NamingSystem.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
NamingSystem.responsible 0..1 string Who maintains system namespace?
NamingSystem.type 0..1 CodeableConcept e.g. driver, provider, patient, bank etc.
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
NamingSystem.description This element must be supported. 1..1 markdown Natural language description of the naming system
NamingSystem.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
NamingSystem.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for naming system (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
NamingSystem.usage 0..1 string How/where is it used
NamingSystem.uniqueId This element is included in summaries. 1..* BackboneElement Unique identifiers used for system
NamingSystem.uniqueId.id 0..1 string Unique id for inter-element referencing
NamingSystem.uniqueId.extension 0..* Extension Additional content defined by implementations
NamingSystem.uniqueId.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
NamingSystem.uniqueId.type This element is included in summaries. 1..1 code oid | uuid | uri | other
Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.
NamingSystem.uniqueId.value This element is included in summaries. 1..1 string The unique identifier
NamingSystem.uniqueId.preferred 0..1 boolean Is this the id that should be used for this type
NamingSystem.uniqueId.comment 0..1 string Notes about identifier usage
NamingSystem.uniqueId.period 0..1 Period When is identifier valid?

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
NamingSystem.language Base preferred Common Languages 📍4.0.1 FHIR Std.
NamingSystem.status Base required PublicationStatus 📍4.0.1 FHIR Std.
NamingSystem.kind Base required NamingSystemType 📍4.0.1 FHIR Std.
NamingSystem.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
NamingSystem.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
NamingSystem.uniqueId.​type Base required NamingSystemIdentifierType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error NamingSystem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error NamingSystem 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 error NamingSystem 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 error NamingSystem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice NamingSystem A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
nsd-0 warning NamingSystem 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 error NamingSystem Root systems cannot have uuid identifiers kind != 'root' or uniqueId.all(type != 'uuid')
nsd-2 error NamingSystem Can't have more than one preferred identifier for a type uniqueId.where(preferred = true).select(type).isDistinct()
shr-1 error NamingSystem If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()

 

Other representations of profile: CSV, Excel, Schematron