HL7 Terminology (THO)
6.1.0 - Continuous Process Integration (ci build) International flag

HL7 Terminology (THO) - Local Development build (v6.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Publishable NamingSystem

Official URL: http://terminology.hl7.org/StructureDefinition/publishablenamingsystem Version: 1.0.0
Standards status: Trial-use Maturity Level: 1 Responsible: HL7 International / Terminology Infrastructure Computable Name: PublishableNamingSystem

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

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. NamingSystem C 1..1 ShareableNamingSystem System of unique identification
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
nsd-1: Root systems cannot have uuid identifiers
nsd-2: Can't have more than one preferred identifier for a type
nsd-3: Can't have more than one authoritative identifier for a type/period combination (only one authoritative identifier allowed at any given point of time)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... Slices for extension Content/Rules for all slices
.... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevel (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... url SΣC 1..1 uri Canonical identifier for this naming system, represented as a URI (globally unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
ele-1: All FHIR elements must have a @value or children
... identifier SΣ 0..* Identifier Additional identifier for the naming system (business identifier)
ele-1: All FHIR elements must have a @value or children
... version SΣ 1..1 string Business version of the naming system
ele-1: All FHIR elements must have a @value or children
... versionAlgorithm[x] SΣ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
ele-1: All FHIR elements must have a @value or children
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 1..1 string Name for this naming system (computer friendly)
ele-1: All FHIR elements must have a @value or children
... title SΣ 1..1 string Title for this naming system (human friendly)
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
... kind ΣC 1..1 code codesystem | identifier | root
Binding: NamingSystemType (required): Identifies the purpose of the naming system.


ele-1: All FHIR elements must have a @value or children
... experimental SΣ 0..1 boolean For testing purposes, not real usage
ele-1: All FHIR elements must have a @value or children
... date SΣ 1..1 dateTime Date last changed
ele-1: All FHIR elements must have a @value or children
... publisher SΣ 0..1 string Name of the publisher/steward (organization or individual)
ele-1: All FHIR elements must have a @value or children
... contact SΣ 0..* ContactDetail Contact details for the publisher
ele-1: All FHIR elements must have a @value or children
... description S 1..1 markdown Natural language description of the naming system
ele-1: All FHIR elements must have a @value or children
... useContext SΣ 0..* UsageContext The context that the content is intended to support
ele-1: All FHIR elements must have a @value or children
... jurisdiction SΣ 0..* CodeableConcept Intended jurisdiction for naming system (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


ele-1: All FHIR elements must have a @value or children
... purpose S 0..1 markdown Why this naming system is defined
ele-1: All FHIR elements must have a @value or children
... copyright S 0..1 markdown Use and/or publishing restrictions
ele-1: All FHIR elements must have a @value or children
... copyrightLabel S 0..1 string Copyright holder and year(s)
ele-1: All FHIR elements must have a @value or children
... approvalDate 0..1 date When the NamingSystem was approved by publisher
ele-1: All FHIR elements must have a @value or children
... lastReviewDate 0..1 date When the NamingSystem was last reviewed by the publisher
ele-1: All FHIR elements must have a @value or children
... effectivePeriod SΣ 0..1 Period When the NamingSystem is expected to be used
ele-1: All FHIR elements must have a @value or children
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
ele-1: All FHIR elements must have a @value or children
... author 0..* ContactDetail Who authored the CodeSystem
ele-1: All FHIR elements must have a @value or children
... editor 0..* ContactDetail Who edited the NamingSystem
ele-1: All FHIR elements must have a @value or children
... reviewer 0..* ContactDetail Who reviewed the NamingSystem
ele-1: All FHIR elements must have a @value or children
... endorser 0..* ContactDetail Who endorsed the NamingSystem
ele-1: All FHIR elements must have a @value or children
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
ele-1: All FHIR elements must have a @value or children
... uniqueId ΣC 1..* BackboneElement Unique identifiers used for system
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... type ΣC 1..1 code oid | uuid | uri | iri-stem | v2csmnemonic | other
Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.


ele-1: All FHIR elements must have a @value or children
.... value Σ 1..1 string The unique identifier
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
NamingSystem.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
NamingSystem.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
NamingSystem.kindrequiredNamingSystemType
http://hl7.org/fhir/ValueSet/namingsystem-type|5.0.0
from the FHIR Standard
NamingSystem.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
NamingSystem.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
NamingSystem.uniqueId.typerequiredNamingSystemIdentifierType
http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningNamingSystemName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1warningNamingSystem.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nsd-1errorNamingSystemRoot systems cannot have uuid identifiers
: kind != 'root' or uniqueId.all(type != 'uuid')
nsd-2errorNamingSystemCan't have more than one preferred identifier for a type
: uniqueId.where(preferred = true).select(type).isDistinct()
nsd-3errorNamingSystemCan't have more than one authoritative identifier for a type/period combination (only one authoritative identifier allowed at any given point of time)
: uniqueId.where(authoritative = 'true').select(type.toString() & period.start.toString() & period.end.toString()).isDistinct()

This structure is derived from ShareableNamingSystem

NameFlagsCard.TypeDescription & Constraintsdoco
.. NamingSystem 1..1 ShareableNamingSystem System of unique identification
... identifier S 0..* Identifier Additional identifier for the naming system (business identifier)
... date S 1..1 dateTime Date last changed
... contact S 0..* ContactDetail Contact details for the publisher
... jurisdiction S 0..* CodeableConcept Intended jurisdiction for naming system (if applicable)
... purpose S 0..1 markdown Why this naming system is defined
... copyright S 0..1 markdown Use and/or publishing restrictions
... copyrightLabel S 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the NamingSystem was approved by publisher
... lastReviewDate 0..1 date When the NamingSystem was last reviewed by the publisher
... effectivePeriod S 0..1 Period When the NamingSystem is expected to be used
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
... author 0..* ContactDetail Who authored the CodeSystem
... editor 0..* ContactDetail Who edited the NamingSystem
... reviewer 0..* ContactDetail Who reviewed the NamingSystem
... endorser 0..* ContactDetail Who endorsed the NamingSystem
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. NamingSystem C 1..1 ShareableNamingSystem System of unique identification
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
nsd-1: Root systems cannot have uuid identifiers
nsd-2: Can't have more than one preferred identifier for a type
nsd-3: Can't have more than one authoritative identifier for a type/period combination (only one authoritative identifier allowed at any given point of time)
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevel (required)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url SΣC 1..1 uri Canonical identifier for this naming system, represented as a URI (globally unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
... identifier SΣ 0..* Identifier Additional identifier for the naming system (business identifier)
... version SΣ 1..1 string Business version of the naming system
... versionAlgorithm[x] SΣ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 1..1 string Name for this naming system (computer friendly)
... title SΣ 1..1 string Title for this naming system (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... kind ΣC 1..1 code codesystem | identifier | root
Binding: NamingSystemType (required): Identifies the purpose of the naming system.

... experimental SΣ 0..1 boolean For testing purposes, not real usage
... date SΣ 1..1 dateTime Date last changed
... publisher SΣ 0..1 string Name of the publisher/steward (organization or individual)
... contact SΣ 0..* ContactDetail Contact details for the publisher
... responsible 0..1 string Who maintains system namespace?
... type 0..1 CodeableConcept e.g. driver, provider, patient, bank etc
Binding: NamingSystemIdentifierSystemType (preferred): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

... description S 1..1 markdown Natural language description of the naming system
... useContext SΣ 0..* UsageContext The context that the content is intended to support
... jurisdiction SΣ 0..* CodeableConcept Intended jurisdiction for naming system (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S 0..1 markdown Why this naming system is defined
... copyright S 0..1 markdown Use and/or publishing restrictions
... copyrightLabel S 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the NamingSystem was approved by publisher
... lastReviewDate 0..1 date When the NamingSystem was last reviewed by the publisher
... effectivePeriod SΣ 0..1 Period When the NamingSystem is expected to be used
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
... author 0..* ContactDetail Who authored the CodeSystem
... editor 0..* ContactDetail Who edited the NamingSystem
... reviewer 0..* ContactDetail Who reviewed the NamingSystem
... endorser 0..* ContactDetail Who endorsed the NamingSystem
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
... usage 0..1 string How/where is it used
... uniqueId ΣC 1..* BackboneElement Unique identifiers used for system
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type ΣC 1..1 code oid | uuid | uri | iri-stem | v2csmnemonic | other
Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.

.... value Σ 1..1 string The unique identifier
.... preferred C 0..1 boolean Is this the id that should be used for this type
.... comment 0..1 string Notes about identifier usage
.... period C 0..1 Period When is identifier valid?
.... authoritative C 0..1 boolean Whether the identifier is authoritative

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
NamingSystem.languagerequiredAllLanguages (a valid code from Tags for the Identification of Languages)
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
NamingSystem.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
NamingSystem.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
NamingSystem.kindrequiredNamingSystemType
http://hl7.org/fhir/ValueSet/namingsystem-type|5.0.0
from the FHIR Standard
NamingSystem.typepreferredNamingSystemIdentifierSystemType (a valid code from identifierType)
http://hl7.org/fhir/ValueSet/namingsystem-identifier-system-type
from the FHIR Standard
NamingSystem.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
NamingSystem.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
NamingSystem.uniqueId.typerequiredNamingSystemIdentifierType
http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningNamingSystemName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1warningNamingSystem.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nsd-1errorNamingSystemRoot systems cannot have uuid identifiers
: kind != 'root' or uniqueId.all(type != 'uuid')
nsd-2errorNamingSystemCan't have more than one preferred identifier for a type
: uniqueId.where(preferred = true).select(type).isDistinct()
nsd-3errorNamingSystemCan't have more than one authoritative identifier for a type/period combination (only one authoritative identifier allowed at any given point of time)
: uniqueId.where(authoritative = 'true').select(type.toString() & period.start.toString() & period.end.toString()).isDistinct()

This structure is derived from ShareableNamingSystem

Summary

Mandatory: 1 element
Must-Support: 10 elements

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. NamingSystem C 1..1 ShareableNamingSystem System of unique identification
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
nsd-1: Root systems cannot have uuid identifiers
nsd-2: Can't have more than one preferred identifier for a type
nsd-3: Can't have more than one authoritative identifier for a type/period combination (only one authoritative identifier allowed at any given point of time)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... Slices for extension Content/Rules for all slices
.... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevel (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... url SΣC 1..1 uri Canonical identifier for this naming system, represented as a URI (globally unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
ele-1: All FHIR elements must have a @value or children
... identifier SΣ 0..* Identifier Additional identifier for the naming system (business identifier)
ele-1: All FHIR elements must have a @value or children
... version SΣ 1..1 string Business version of the naming system
ele-1: All FHIR elements must have a @value or children
... versionAlgorithm[x] SΣ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
ele-1: All FHIR elements must have a @value or children
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 1..1 string Name for this naming system (computer friendly)
ele-1: All FHIR elements must have a @value or children
... title SΣ 1..1 string Title for this naming system (human friendly)
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
... kind ΣC 1..1 code codesystem | identifier | root
Binding: NamingSystemType (required): Identifies the purpose of the naming system.


ele-1: All FHIR elements must have a @value or children
... experimental SΣ 0..1 boolean For testing purposes, not real usage
ele-1: All FHIR elements must have a @value or children
... date SΣ 1..1 dateTime Date last changed
ele-1: All FHIR elements must have a @value or children
... publisher SΣ 0..1 string Name of the publisher/steward (organization or individual)
ele-1: All FHIR elements must have a @value or children
... contact SΣ 0..* ContactDetail Contact details for the publisher
ele-1: All FHIR elements must have a @value or children
... description S 1..1 markdown Natural language description of the naming system
ele-1: All FHIR elements must have a @value or children
... useContext SΣ 0..* UsageContext The context that the content is intended to support
ele-1: All FHIR elements must have a @value or children
... jurisdiction SΣ 0..* CodeableConcept Intended jurisdiction for naming system (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


ele-1: All FHIR elements must have a @value or children
... purpose S 0..1 markdown Why this naming system is defined
ele-1: All FHIR elements must have a @value or children
... copyright S 0..1 markdown Use and/or publishing restrictions
ele-1: All FHIR elements must have a @value or children
... copyrightLabel S 0..1 string Copyright holder and year(s)
ele-1: All FHIR elements must have a @value or children
... approvalDate 0..1 date When the NamingSystem was approved by publisher
ele-1: All FHIR elements must have a @value or children
... lastReviewDate 0..1 date When the NamingSystem was last reviewed by the publisher
ele-1: All FHIR elements must have a @value or children
... effectivePeriod SΣ 0..1 Period When the NamingSystem is expected to be used
ele-1: All FHIR elements must have a @value or children
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
ele-1: All FHIR elements must have a @value or children
... author 0..* ContactDetail Who authored the CodeSystem
ele-1: All FHIR elements must have a @value or children
... editor 0..* ContactDetail Who edited the NamingSystem
ele-1: All FHIR elements must have a @value or children
... reviewer 0..* ContactDetail Who reviewed the NamingSystem
ele-1: All FHIR elements must have a @value or children
... endorser 0..* ContactDetail Who endorsed the NamingSystem
ele-1: All FHIR elements must have a @value or children
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
ele-1: All FHIR elements must have a @value or children
... uniqueId ΣC 1..* BackboneElement Unique identifiers used for system
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... type ΣC 1..1 code oid | uuid | uri | iri-stem | v2csmnemonic | other
Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.


ele-1: All FHIR elements must have a @value or children
.... value Σ 1..1 string The unique identifier
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
NamingSystem.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
NamingSystem.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
NamingSystem.kindrequiredNamingSystemType
http://hl7.org/fhir/ValueSet/namingsystem-type|5.0.0
from the FHIR Standard
NamingSystem.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
NamingSystem.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
NamingSystem.uniqueId.typerequiredNamingSystemIdentifierType
http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningNamingSystemName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1warningNamingSystem.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nsd-1errorNamingSystemRoot systems cannot have uuid identifiers
: kind != 'root' or uniqueId.all(type != 'uuid')
nsd-2errorNamingSystemCan't have more than one preferred identifier for a type
: uniqueId.where(preferred = true).select(type).isDistinct()
nsd-3errorNamingSystemCan't have more than one authoritative identifier for a type/period combination (only one authoritative identifier allowed at any given point of time)
: uniqueId.where(authoritative = 'true').select(type.toString() & period.start.toString() & period.end.toString()).isDistinct()

Differential View

This structure is derived from ShareableNamingSystem

NameFlagsCard.TypeDescription & Constraintsdoco
.. NamingSystem 1..1 ShareableNamingSystem System of unique identification
... identifier S 0..* Identifier Additional identifier for the naming system (business identifier)
... date S 1..1 dateTime Date last changed
... contact S 0..* ContactDetail Contact details for the publisher
... jurisdiction S 0..* CodeableConcept Intended jurisdiction for naming system (if applicable)
... purpose S 0..1 markdown Why this naming system is defined
... copyright S 0..1 markdown Use and/or publishing restrictions
... copyrightLabel S 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the NamingSystem was approved by publisher
... lastReviewDate 0..1 date When the NamingSystem was last reviewed by the publisher
... effectivePeriod S 0..1 Period When the NamingSystem is expected to be used
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
... author 0..* ContactDetail Who authored the CodeSystem
... editor 0..* ContactDetail Who edited the NamingSystem
... reviewer 0..* ContactDetail Who reviewed the NamingSystem
... endorser 0..* ContactDetail Who endorsed the NamingSystem
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. NamingSystem C 1..1 ShareableNamingSystem System of unique identification
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
nsd-1: Root systems cannot have uuid identifiers
nsd-2: Can't have more than one preferred identifier for a type
nsd-3: Can't have more than one authoritative identifier for a type/period combination (only one authoritative identifier allowed at any given point of time)
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevel (required)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url SΣC 1..1 uri Canonical identifier for this naming system, represented as a URI (globally unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
... identifier SΣ 0..* Identifier Additional identifier for the naming system (business identifier)
... version SΣ 1..1 string Business version of the naming system
... versionAlgorithm[x] SΣ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 1..1 string Name for this naming system (computer friendly)
... title SΣ 1..1 string Title for this naming system (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... kind ΣC 1..1 code codesystem | identifier | root
Binding: NamingSystemType (required): Identifies the purpose of the naming system.

... experimental SΣ 0..1 boolean For testing purposes, not real usage
... date SΣ 1..1 dateTime Date last changed
... publisher SΣ 0..1 string Name of the publisher/steward (organization or individual)
... contact SΣ 0..* ContactDetail Contact details for the publisher
... responsible 0..1 string Who maintains system namespace?
... type 0..1 CodeableConcept e.g. driver, provider, patient, bank etc
Binding: NamingSystemIdentifierSystemType (preferred): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

... description S 1..1 markdown Natural language description of the naming system
... useContext SΣ 0..* UsageContext The context that the content is intended to support
... jurisdiction SΣ 0..* CodeableConcept Intended jurisdiction for naming system (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S 0..1 markdown Why this naming system is defined
... copyright S 0..1 markdown Use and/or publishing restrictions
... copyrightLabel S 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the NamingSystem was approved by publisher
... lastReviewDate 0..1 date When the NamingSystem was last reviewed by the publisher
... effectivePeriod SΣ 0..1 Period When the NamingSystem is expected to be used
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
... author 0..* ContactDetail Who authored the CodeSystem
... editor 0..* ContactDetail Who edited the NamingSystem
... reviewer 0..* ContactDetail Who reviewed the NamingSystem
... endorser 0..* ContactDetail Who endorsed the NamingSystem
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
... usage 0..1 string How/where is it used
... uniqueId ΣC 1..* BackboneElement Unique identifiers used for system
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type ΣC 1..1 code oid | uuid | uri | iri-stem | v2csmnemonic | other
Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.

.... value Σ 1..1 string The unique identifier
.... preferred C 0..1 boolean Is this the id that should be used for this type
.... comment 0..1 string Notes about identifier usage
.... period C 0..1 Period When is identifier valid?
.... authoritative C 0..1 boolean Whether the identifier is authoritative

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
NamingSystem.languagerequiredAllLanguages (a valid code from Tags for the Identification of Languages)
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
NamingSystem.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
NamingSystem.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
NamingSystem.kindrequiredNamingSystemType
http://hl7.org/fhir/ValueSet/namingsystem-type|5.0.0
from the FHIR Standard
NamingSystem.typepreferredNamingSystemIdentifierSystemType (a valid code from identifierType)
http://hl7.org/fhir/ValueSet/namingsystem-identifier-system-type
from the FHIR Standard
NamingSystem.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
NamingSystem.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
NamingSystem.uniqueId.typerequiredNamingSystemIdentifierType
http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningNamingSystemName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1warningNamingSystem.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nsd-1errorNamingSystemRoot systems cannot have uuid identifiers
: kind != 'root' or uniqueId.all(type != 'uuid')
nsd-2errorNamingSystemCan't have more than one preferred identifier for a type
: uniqueId.where(preferred = true).select(type).isDistinct()
nsd-3errorNamingSystemCan't have more than one authoritative identifier for a type/period combination (only one authoritative identifier allowed at any given point of time)
: uniqueId.where(authoritative = 'true').select(type.toString() & period.start.toString() & period.end.toString()).isDistinct()

This structure is derived from ShareableNamingSystem

Summary

Mandatory: 1 element
Must-Support: 10 elements

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron