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: Publishable NamingSystem

Official URL: http://hl7.org/fhir/StructureDefinition/publishablenamingsystem Version: 4.0.2
Standards status: Trial-use Maturity Level: 1 Responsible: HL7 International / Terminology Infrastructure Computable Name: PublishableNamingSystem
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1261

Defines and enforces the minimum expectations for publication and distribution of a naming system, typically as part of an artifact repository or implementation guide publication

​Original Source: hl7.org

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, pub-1
NamingSystem.meta This element is included in summaries. 0..1 Meta Metadata about the resource
NamingSystem.meta.Slices for extension Content/Rules for all slices
NamingSystem.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
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 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:identifier This element must be supported. 0..* Identifier Additional identifier for the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
NamingSystem.Slices for extension.extension:purpose This element must be supported. 0..1 markdown Why this artifact is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
NamingSystem.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
NamingSystem.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
NamingSystem.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
NamingSystem.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
NamingSystem.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
NamingSystem.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
NamingSystem.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
NamingSystem.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
NamingSystem.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
NamingSystem.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
NamingSystem.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
NamingSystem.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
NamingSystem.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
NamingSystem.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
NamingSystem.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
NamingSystem.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
NamingSystem.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
NamingSystem.name 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 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 must be supported. This element is included in summaries. 1..1 dateTime Date last changed
NamingSystem.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
NamingSystem.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
NamingSystem.jurisdiction This element must be supported. 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.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.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍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.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()
pub-1 error NamingSystem If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

This structure is derived from NamingSystem

NameFlagsCard.TypeDescription & Constraints    Filter: doco
NamingSystem C 1..1 NamingSystem System of unique identification
Constraints: pub-1
NamingSystem.meta
NamingSystem.meta.Slices for extension Content/Rules for all slices
NamingSystem.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
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:identifier This element must be supported. 0..* Identifier Additional identifier for the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
NamingSystem.Slices for extension.extension:purpose This element must be supported. 0..1 markdown Why this artifact is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
NamingSystem.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
NamingSystem.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
NamingSystem.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
NamingSystem.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
NamingSystem.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
NamingSystem.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
NamingSystem.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
NamingSystem.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
NamingSystem.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
NamingSystem.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
NamingSystem.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
NamingSystem.Slices for extension.extension:relatedArtifact.value[x]
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
NamingSystem.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
NamingSystem.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
NamingSystem.date This element must be supported. 1..1 dateTime Date last changed
NamingSystem.useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
NamingSystem.jurisdiction This element must be supported. 0..* CodeableConcept Intended jurisdiction for naming system (if applicable)

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
pub-1 error NamingSystem If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
NamingSystem C 1..1 NamingSystem System of unique identification
Constraints: nsd-0, nsd-1, nsd-2, pub-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.meta.id 0..1 string Unique id for inter-element referencing
NamingSystem.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
NamingSystem.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
NamingSystem.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
NamingSystem.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
NamingSystem.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
NamingSystem.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
NamingSystem.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
NamingSystem.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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 0..* 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:identifier This element must be supported. 0..* Identifier Additional identifier for the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
NamingSystem.Slices for extension.extension:purpose This element must be supported. 0..1 markdown Why this artifact is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
NamingSystem.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
NamingSystem.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
NamingSystem.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
NamingSystem.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
NamingSystem.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
NamingSystem.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
NamingSystem.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
NamingSystem.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
NamingSystem.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
NamingSystem.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
NamingSystem.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
NamingSystem.Slices for extension.extension:relatedArtifact.id 0..1 string Unique id for inter-element referencing
NamingSystem.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
NamingSystem.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
NamingSystem.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].id 0..1 string Unique id for inter-element referencing
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].label This element is included in summaries. 0..1 string Short label
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].display This element is included in summaries. 0..1 string Brief description of the related artifact
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].url This element is included in summaries. 0..1 url Where the artifact can be accessed
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].document This element is included in summaries. 0..1 Attachment What document is being referenced
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].resource This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
NamingSystem.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
NamingSystem.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
NamingSystem.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
NamingSystem.name 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 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 must be supported. This element is included in summaries. 1..1 dateTime Date last changed
NamingSystem.publisher This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
NamingSystem.contact This element must be supported. 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 0..1 markdown Natural language description of the naming system
NamingSystem.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
NamingSystem.jurisdiction This element must be supported. 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.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
NamingSystem.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
NamingSystem.language Base preferred Common Languages 📍4.0.1 FHIR Std.
NamingSystem.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍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()
pub-1 error NamingSystem If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').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, pub-1
NamingSystem.meta This element is included in summaries. 0..1 Meta Metadata about the resource
NamingSystem.meta.Slices for extension Content/Rules for all slices
NamingSystem.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
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 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:identifier This element must be supported. 0..* Identifier Additional identifier for the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
NamingSystem.Slices for extension.extension:purpose This element must be supported. 0..1 markdown Why this artifact is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
NamingSystem.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
NamingSystem.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
NamingSystem.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
NamingSystem.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
NamingSystem.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
NamingSystem.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
NamingSystem.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
NamingSystem.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
NamingSystem.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
NamingSystem.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
NamingSystem.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
NamingSystem.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
NamingSystem.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
NamingSystem.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
NamingSystem.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
NamingSystem.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
NamingSystem.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
NamingSystem.name 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 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 must be supported. This element is included in summaries. 1..1 dateTime Date last changed
NamingSystem.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
NamingSystem.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
NamingSystem.jurisdiction This element must be supported. 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.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.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍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.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()
pub-1 error NamingSystem If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

Differential View

This structure is derived from NamingSystem

NameFlagsCard.TypeDescription & Constraints    Filter: doco
NamingSystem C 1..1 NamingSystem System of unique identification
Constraints: pub-1
NamingSystem.meta
NamingSystem.meta.Slices for extension Content/Rules for all slices
NamingSystem.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
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:identifier This element must be supported. 0..* Identifier Additional identifier for the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
NamingSystem.Slices for extension.extension:purpose This element must be supported. 0..1 markdown Why this artifact is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
NamingSystem.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
NamingSystem.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
NamingSystem.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
NamingSystem.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
NamingSystem.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
NamingSystem.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
NamingSystem.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
NamingSystem.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
NamingSystem.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
NamingSystem.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
NamingSystem.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
NamingSystem.Slices for extension.extension:relatedArtifact.value[x]
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
NamingSystem.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
NamingSystem.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
NamingSystem.date This element must be supported. 1..1 dateTime Date last changed
NamingSystem.contact This element must be supported. 0..* ContactDetail Contact details for the publisher
NamingSystem.useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
NamingSystem.jurisdiction This element must be supported. 0..* CodeableConcept Intended jurisdiction for naming system (if applicable)

doco Documentation for this format

Constraints

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

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
NamingSystem C 1..1 NamingSystem System of unique identification
Constraints: nsd-0, nsd-1, nsd-2, pub-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.meta.id 0..1 string Unique id for inter-element referencing
NamingSystem.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
NamingSystem.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
NamingSystem.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
NamingSystem.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
NamingSystem.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
NamingSystem.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
NamingSystem.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
NamingSystem.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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 0..* 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:identifier This element must be supported. 0..* Identifier Additional identifier for the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
NamingSystem.Slices for extension.extension:purpose This element must be supported. 0..1 markdown Why this artifact is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
NamingSystem.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
NamingSystem.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
NamingSystem.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
NamingSystem.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
NamingSystem.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
NamingSystem.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
NamingSystem.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
NamingSystem.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
NamingSystem.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
NamingSystem.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
NamingSystem.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
NamingSystem.Slices for extension.extension:relatedArtifact.id 0..1 string Unique id for inter-element referencing
NamingSystem.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
NamingSystem.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
NamingSystem.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].id 0..1 string Unique id for inter-element referencing
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].label This element is included in summaries. 0..1 string Short label
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].display This element is included in summaries. 0..1 string Brief description of the related artifact
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].url This element is included in summaries. 0..1 url Where the artifact can be accessed
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].document This element is included in summaries. 0..1 Attachment What document is being referenced
NamingSystem.Slices for extension.extension:relatedArtifact.value[x].resource This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
NamingSystem.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
NamingSystem.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
NamingSystem.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
NamingSystem.name 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 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 must be supported. This element is included in summaries. 1..1 dateTime Date last changed
NamingSystem.publisher This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
NamingSystem.contact This element must be supported. 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 0..1 markdown Natural language description of the naming system
NamingSystem.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
NamingSystem.jurisdiction This element must be supported. 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.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
NamingSystem.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
NamingSystem.language Base preferred Common Languages 📍4.0.1 FHIR Std.
NamingSystem.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍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()
pub-1 error NamingSystem If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

 

Other representations of profile: CSV, Excel, Schematron