HL7 Terminology (THO)
6.1.0 - Continuous Process Integration (ci build)
HL7 Terminology (THO)
6.1.0 - Continuous Process Integration (ci build)
HL7 Terminology (THO) - Local Development build (v6.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://terminology.hl7.org/StructureDefinition/shareablenamingsystem | Version: 1.0.0 | |||
| Standards status: Trial-use | Maturity Level: 1 | Responsible: HL7 International / Terminology Infrastructure | Computable Name: ShareableNamingSystem | |
Enforces the minimum information set for the naming system metadata required by HL7 and other organizations that share and publish naming systems
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  NamingSystem |
C | 1..1 | NamingSystem | 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 |
| 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 |
Σ | 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 |
| description |
S | 1..1 | markdown | Natural language description of the naming system 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| NamingSystem.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithmfrom the FHIR Standard | |
| NamingSystem.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0from the FHIR Standard | |
| NamingSystem.kind | required | NamingSystemTypehttp://hl7.org/fhir/ValueSet/namingsystem-type|5.0.0from the FHIR Standard | |
| NamingSystem.uniqueId.type | required | NamingSystemIdentifierTypehttp://hl7.org/fhir/ValueSet/namingsystem-identifier-type|5.0.0from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | NamingSystem | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
| cnl-1 | warning | NamingSystem.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
| 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-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() | |
| nsd-3 | error | NamingSystem | Can'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 NamingSystem
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| NamingSystem |
1..1 | NamingSystem | System of unique identification | |
| 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) |
 url |
S | 1..1 | uri | Canonical identifier for this naming system, represented as a URI (globally unique) |
| version |
S | 1..1 | string | Business version of the naming system |
| versionAlgorithm[x] |
S | 0..1 | string, Coding | How to compare versions |
| name |
S | 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 |
| experimental |
S | 0..1 | boolean | For testing purposes, not real usage |
| publisher |
S | 0..1 | string | Name of the publisher/steward (organization or individual) |
| description |
S | 1..1 | markdown | Natural language description of the naming system |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| NamingSystem |
C | 1..1 | NamingSystem | 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
| |||||
| 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 |
Σ | 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 |
Σ | 1..1 | dateTime | Date last changed | ||||
| publisher |
SΣ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
| contact |
Σ | 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 |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for naming system (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this naming system is defined | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| copyrightLabel |
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 |
Σ | 0..1 | Period | When the NamingSystem is expected to be used | ||||
| topic |
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 | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| NamingSystem.language | required | AllLanguages (a valid code from Tags for the Identification of Languages)http://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| NamingSystem.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithmfrom the FHIR Standard | |
| NamingSystem.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0from the FHIR Standard | |
| NamingSystem.kind | required | NamingSystemTypehttp://hl7.org/fhir/ValueSet/namingsystem-type|5.0.0from the FHIR Standard | |
| NamingSystem.type | preferred | NamingSystemIdentifierSystemType (a valid code from identifierType)http://hl7.org/fhir/ValueSet/namingsystem-identifier-system-typefrom the FHIR Standard | |
| NamingSystem.jurisdiction | extensible | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | |
| NamingSystem.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topicfrom the FHIR Standard | |
| NamingSystem.uniqueId.type | required | NamingSystemIdentifierTypehttp://hl7.org/fhir/ValueSet/namingsystem-identifier-type|5.0.0from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | NamingSystem | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
| cnl-1 | warning | NamingSystem.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
| 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-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() | |
| nsd-3 | error | NamingSystem | Can'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 NamingSystem
Summary
Mandatory: 4 elements
Must-Support: 10 elements
Extensions
This structure refers to these extensions:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| NamingSystem |
C | 1..1 | NamingSystem | 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 |
| 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 |
Σ | 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 |
| description |
S | 1..1 | markdown | Natural language description of the naming system 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| NamingSystem.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithmfrom the FHIR Standard | |
| NamingSystem.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0from the FHIR Standard | |
| NamingSystem.kind | required | NamingSystemTypehttp://hl7.org/fhir/ValueSet/namingsystem-type|5.0.0from the FHIR Standard | |
| NamingSystem.uniqueId.type | required | NamingSystemIdentifierTypehttp://hl7.org/fhir/ValueSet/namingsystem-identifier-type|5.0.0from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | NamingSystem | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
| cnl-1 | warning | NamingSystem.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
| 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-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() | |
| nsd-3 | error | NamingSystem | Can'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 NamingSystem
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| NamingSystem |
1..1 | NamingSystem | System of unique identification | |
| 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) |
| url |
S | 1..1 | uri | Canonical identifier for this naming system, represented as a URI (globally unique) |
| version |
S | 1..1 | string | Business version of the naming system |
| versionAlgorithm[x] |
S | 0..1 | string, Coding | How to compare versions |
| name |
S | 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 |
| experimental |
S | 0..1 | boolean | For testing purposes, not real usage |
| publisher |
S | 0..1 | string | Name of the publisher/steward (organization or individual) |
| description |
S | 1..1 | markdown | Natural language description of the naming system |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| NamingSystem |
C | 1..1 | NamingSystem | 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
| |||||
| 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 |
Σ | 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 |
Σ | 1..1 | dateTime | Date last changed | ||||
| publisher |
SΣ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
| contact |
Σ | 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 |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for naming system (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this naming system is defined | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| copyrightLabel |
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 |
Σ | 0..1 | Period | When the NamingSystem is expected to be used | ||||
| topic |
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 | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| NamingSystem.language | required | AllLanguages (a valid code from Tags for the Identification of Languages)http://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| NamingSystem.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithmfrom the FHIR Standard | |
| NamingSystem.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0from the FHIR Standard | |
| NamingSystem.kind | required | NamingSystemTypehttp://hl7.org/fhir/ValueSet/namingsystem-type|5.0.0from the FHIR Standard | |
| NamingSystem.type | preferred | NamingSystemIdentifierSystemType (a valid code from identifierType)http://hl7.org/fhir/ValueSet/namingsystem-identifier-system-typefrom the FHIR Standard | |
| NamingSystem.jurisdiction | extensible | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | |
| NamingSystem.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topicfrom the FHIR Standard | |
| NamingSystem.uniqueId.type | required | NamingSystemIdentifierTypehttp://hl7.org/fhir/ValueSet/namingsystem-identifier-type|5.0.0from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | NamingSystem | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
| cnl-1 | warning | NamingSystem.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
| 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-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() | |
| nsd-3 | error | NamingSystem | Can'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 NamingSystem
Summary
Mandatory: 4 elements
Must-Support: 10 elements
Extensions
This structure refers to these extensions:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International - Vocabulary Work Group. Package hl7.terminology#6.1.0 based on FHIR 5.0.0. Generated 2025-01-17
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change