This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions
Terminology Infrastructure Work Group | Maturity Level: 0 | Trial Use | Use Context: Any |
The canonical URL for this profile is:
http://hl7.org/fhir/StructureDefinition/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
Note to Implementers: All of the shareable, publishable, computable, and executable profiles will be migrating to the new Canonical Resource Management implementation guide as part of the next FHIR release. Implementers are encouraged to look there for updates, corrections and clarifications.
This profile was published on Thu, Jan 1, 1970 00:00+1000 as a draft by HL7.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from ShareableNamingSystem.
Summary
Mandatory: 1 element
Must-Support: 10 elements
This indicates the differences between this profile and the base ShareableNamingSystem structure.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
useContext | S | 0..* | UsageContext | The context that the content is intended to support |
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 | |
Documentation for this format |
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ShareableNamingSystem structure.
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
NamingSystem | C | 1..1 | ShareableNamingSystem | System of unique identification | ||||
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: All Languages (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: Knowledge Representation Level (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) | ||||
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: Version Algorithm (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: Naming System Type (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: Naming System Identifier System Type (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: Jurisdiction ValueSet (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: Definition Topic (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: Naming System Identifier Type (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 |
<!-- PublishableNamingSystem --> <NamingSystem xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- I 1..1 Canonical identifier for this naming system, represented as a URI (globally unique) --> <identifier><!-- I 0..* Identifier Additional identifier for the naming system (business identifier) --></identifier> <version value="[string]"/><!-- I 1..1 Business version of the naming system --> <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 1..1 Name for this naming system (computer friendly) --> <title value="[string]"/><!-- I 1..1 Title for this naming system (human friendly) --> <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown --> <kind value="[code]"/><!-- I 1..1 codesystem | identifier | root --> <experimental value="[boolean]"/><!-- I 0..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- I 1..1 Date last changed --> <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact> <responsible value="[string]"/><!-- I 0..1 Who maintains system namespace? --> <type><!-- I 0..1 CodeableConcept e.g. driver, provider, patient, bank etc --></type> <description value="[markdown]"/><!-- I 1..1 Natural language description of the naming system --> <useContext><!-- I 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for naming system (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- I 0..1 Why this naming system is defined --> <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- I 0..1 When the NamingSystem was approved by publisher --> <lastReviewDate value="[date]"/><!-- I 0..1 When the NamingSystem was last reviewed by the publisher --> <effectivePeriod><!-- I 0..1 Period When the NamingSystem is expected to be used --></effectivePeriod> <topic><!-- I 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic> <author><!-- I 0..* ContactDetail Who authored the CodeSystem --></author> <editor><!-- I 0..* ContactDetail Who edited the NamingSystem --></editor> <reviewer><!-- I 0..* ContactDetail Who reviewed the NamingSystem --></reviewer> <endorser><!-- I 0..* ContactDetail Who endorsed the NamingSystem --></endorser> <relatedArtifact><!-- I 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact> <usage value="[string]"/><!-- I 0..1 How/where is it used --> <uniqueId> I 1..* BackboneElement <!-- I 1..* Unique identifiers used for system --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <type value="[code]"/><!-- I 1..1 oid | uuid | uri | iri-stem | v2csmnemonic | other --> <value value="[string]"/><!-- I 1..1 The unique identifier --> <preferred value="[boolean]"/><!-- I 0..1 Is this the id that should be used for this type --> <comment value="[string]"/><!-- I 0..1 Notes about identifier usage --> <period><!-- I 0..1 Period When is identifier valid? --></period> <authoritative value="[boolean]"/><!-- I 0..1 Whether the identifier is authoritative --> </uniqueId> </NamingSystem>
{ // PublishableNamingSystem // from Element: extension "meta" : { Meta }, // IMetadata about the resource "implicitRules" : "<uri>", // IA set of rules under which this content was created "language" : "<code>", // ILanguage of the resource content "text" : { Narrative }, // IText summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "extension" : [ // sliced by value:url in the specified order, Open { // narrative | semi-structured | structured | executable // I // from Element: extension } ], "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored "url" : "<uri>", // I R! Canonical identifier for this naming system, represented as a URI (globally unique) "identifier" : [{ Identifier }], // IAdditional identifier for the naming system (business identifier) "version" : "<string>", // I R! Business version of the naming system // value[x]: How to compare versions. One of these 2: "versionAlgorithmString" : "<string>", // IHow to compare versions "versionAlgorithmCoding" : { Coding }, // IHow to compare versions "name" : "<string>", // I R! Name for this naming system (computer friendly) "title" : "<string>", // I R! Title for this naming system (human friendly) "status" : "<code>", // I R! draft | active | retired | unknown "kind" : "<code>", // I R! codesystem | identifier | root "experimental" : <boolean>, // IFor testing purposes, not real usage "date" : "<dateTime>", // I R! Date last changed "publisher" : "<string>", // IName of the publisher/steward (organization or individual) "contact" : [{ ContactDetail }], // IContact details for the publisher "responsible" : "<string>", // IWho maintains system namespace? "type" : { CodeableConcept }, // Ie.g. driver, provider, patient, bank etc "description" : "<markdown>", // I R! Natural language description of the naming system "useContext" : [{ UsageContext }], // IThe context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for naming system (if applicable) "purpose" : "<markdown>", // IWhy this naming system is defined "copyright" : "<markdown>", // IUse and/or publishing restrictions "copyrightLabel" : "<string>", // ICopyright holder and year(s) "approvalDate" : "<date>", // IWhen the NamingSystem was approved by publisher "lastReviewDate" : "<date>", // IWhen the NamingSystem was last reviewed by the publisher "effectivePeriod" : { Period }, // IWhen the NamingSystem is expected to be used "topic" : [{ CodeableConcept }], // IE.g. Education, Treatment, Assessment, etc "author" : [{ ContactDetail }], // IWho authored the CodeSystem "editor" : [{ ContactDetail }], // IWho edited the NamingSystem "reviewer" : [{ ContactDetail }], // IWho reviewed the NamingSystem "endorser" : [{ ContactDetail }], // IWho endorsed the NamingSystem "relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc "usage" : "<string>", // IHow/where is it used "uniqueId" : [{ BackboneElement }], // I R! Unique identifiers used for system }
This structure is derived from ShareableNamingSystem.
Differential View
This indicates the differences between this profile and the base ShareableNamingSystem structure.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
useContext | S | 0..* | UsageContext | The context that the content is intended to support |
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 | |
Documentation for this format |
Snapshot View
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ShareableNamingSystem structure.
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
NamingSystem | C | 1..1 | ShareableNamingSystem | System of unique identification | ||||
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: All Languages (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: Knowledge Representation Level (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) | ||||
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: Version Algorithm (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: Naming System Type (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: Naming System Identifier System Type (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: Jurisdiction ValueSet (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: Definition Topic (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: Naming System Identifier Type (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 |
XML Template
<!-- PublishableNamingSystem --> <NamingSystem xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- I 1..1 Canonical identifier for this naming system, represented as a URI (globally unique) --> <identifier><!-- I 0..* Identifier Additional identifier for the naming system (business identifier) --></identifier> <version value="[string]"/><!-- I 1..1 Business version of the naming system --> <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 1..1 Name for this naming system (computer friendly) --> <title value="[string]"/><!-- I 1..1 Title for this naming system (human friendly) --> <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown --> <kind value="[code]"/><!-- I 1..1 codesystem | identifier | root --> <experimental value="[boolean]"/><!-- I 0..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- I 1..1 Date last changed --> <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact> <responsible value="[string]"/><!-- I 0..1 Who maintains system namespace? --> <type><!-- I 0..1 CodeableConcept e.g. driver, provider, patient, bank etc --></type> <description value="[markdown]"/><!-- I 1..1 Natural language description of the naming system --> <useContext><!-- I 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for naming system (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- I 0..1 Why this naming system is defined --> <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- I 0..1 When the NamingSystem was approved by publisher --> <lastReviewDate value="[date]"/><!-- I 0..1 When the NamingSystem was last reviewed by the publisher --> <effectivePeriod><!-- I 0..1 Period When the NamingSystem is expected to be used --></effectivePeriod> <topic><!-- I 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic> <author><!-- I 0..* ContactDetail Who authored the CodeSystem --></author> <editor><!-- I 0..* ContactDetail Who edited the NamingSystem --></editor> <reviewer><!-- I 0..* ContactDetail Who reviewed the NamingSystem --></reviewer> <endorser><!-- I 0..* ContactDetail Who endorsed the NamingSystem --></endorser> <relatedArtifact><!-- I 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact> <usage value="[string]"/><!-- I 0..1 How/where is it used --> <uniqueId> I 1..* BackboneElement <!-- I 1..* Unique identifiers used for system --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <type value="[code]"/><!-- I 1..1 oid | uuid | uri | iri-stem | v2csmnemonic | other --> <value value="[string]"/><!-- I 1..1 The unique identifier --> <preferred value="[boolean]"/><!-- I 0..1 Is this the id that should be used for this type --> <comment value="[string]"/><!-- I 0..1 Notes about identifier usage --> <period><!-- I 0..1 Period When is identifier valid? --></period> <authoritative value="[boolean]"/><!-- I 0..1 Whether the identifier is authoritative --> </uniqueId> </NamingSystem>
JSON Template
{ // PublishableNamingSystem // from Element: extension "meta" : { Meta }, // IMetadata about the resource "implicitRules" : "<uri>", // IA set of rules under which this content was created "language" : "<code>", // ILanguage of the resource content "text" : { Narrative }, // IText summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "extension" : [ // sliced by value:url in the specified order, Open { // narrative | semi-structured | structured | executable // I // from Element: extension } ], "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored "url" : "<uri>", // I R! Canonical identifier for this naming system, represented as a URI (globally unique) "identifier" : [{ Identifier }], // IAdditional identifier for the naming system (business identifier) "version" : "<string>", // I R! Business version of the naming system // value[x]: How to compare versions. One of these 2: "versionAlgorithmString" : "<string>", // IHow to compare versions "versionAlgorithmCoding" : { Coding }, // IHow to compare versions "name" : "<string>", // I R! Name for this naming system (computer friendly) "title" : "<string>", // I R! Title for this naming system (human friendly) "status" : "<code>", // I R! draft | active | retired | unknown "kind" : "<code>", // I R! codesystem | identifier | root "experimental" : <boolean>, // IFor testing purposes, not real usage "date" : "<dateTime>", // I R! Date last changed "publisher" : "<string>", // IName of the publisher/steward (organization or individual) "contact" : [{ ContactDetail }], // IContact details for the publisher "responsible" : "<string>", // IWho maintains system namespace? "type" : { CodeableConcept }, // Ie.g. driver, provider, patient, bank etc "description" : "<markdown>", // I R! Natural language description of the naming system "useContext" : [{ UsageContext }], // IThe context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for naming system (if applicable) "purpose" : "<markdown>", // IWhy this naming system is defined "copyright" : "<markdown>", // IUse and/or publishing restrictions "copyrightLabel" : "<string>", // ICopyright holder and year(s) "approvalDate" : "<date>", // IWhen the NamingSystem was approved by publisher "lastReviewDate" : "<date>", // IWhen the NamingSystem was last reviewed by the publisher "effectivePeriod" : { Period }, // IWhen the NamingSystem is expected to be used "topic" : [{ CodeableConcept }], // IE.g. Education, Treatment, Assessment, etc "author" : [{ ContactDetail }], // IWho authored the CodeSystem "editor" : [{ ContactDetail }], // IWho edited the NamingSystem "reviewer" : [{ ContactDetail }], // IWho reviewed the NamingSystem "endorser" : [{ ContactDetail }], // IWho endorsed the NamingSystem "relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc "usage" : "<string>", // IHow/where is it used "uniqueId" : [{ BackboneElement }], // I R! Unique identifiers used for system }
Alternate definitions: Master Definition (XML, JSON), Schematron
Path | Name | Conformance | ValueSet |
NamingSystem.language | All Languages | required | All Languages |
NamingSystem.versionAlgorithm[x] | Version Algorithm | extensible | Version Algorithm |
NamingSystem.status | PublicationStatus | required | PublicationStatus |
NamingSystem.kind | Naming System Type | required | Naming System Type |
NamingSystem.type | Naming System Identifier System Type | preferred | Naming System Identifier System Type |
NamingSystem.jurisdiction | Jurisdiction ValueSet | extensible | Jurisdiction ValueSet |
NamingSystem.topic | Definition Topic | example | Definition Topic |
NamingSystem.uniqueId.type | Naming System Identifier Type | required | Naming System Identifier Type |