Extensions for Using Data Elements from FHIR STU3 in FHIR R5
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR STU3 in FHIR R5 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R3_NamingSystem_R5

Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-NamingSystem Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R3_NamingSystem_R5

This cross-version profile allows STU3 NamingSystem content to be represented via FHIR R5 NamingSystem resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NamingSystem C 0..* NamingSystem(5.0.0) System of unique identification
Constraints: cnl-0, nsd-1, nsd-2, nsd-3
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:replacedBy 0..1 Reference(Cross-version Profile for STU3.NamingSystem for use in FHIR R5(0.1.0) | NamingSystem) STU3: Use this instead (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.replacedBy
Constraints: ext-1
... name ΣC 1..1 string Name for this naming system (computer friendly)
... status ?!Σ 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.
... date Σ 1..1 dateTime Date last changed
... uniqueId ΣC 1..* BackboneElement Unique identifiers used for system
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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.
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:type 0..1 code STU3: oid | uuid | uri | other additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.uniqueId.type
Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.
Constraints: ext-1
.... value Σ 1..1 string The unique identifier

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
NamingSystem.status Base required PublicationStatus 📍5.0.0 FHIR Std.
NamingSystem.kind Base required Naming System Type 📍5.0.0 FHIR Std.
NamingSystem.uniqueId.​type Base required Naming System Identifier Type 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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}$')
ele-1 error NamingSystem.implicitRules, NamingSystem.extension, NamingSystem.extension:replacedBy, NamingSystem.modifierExtension, NamingSystem.name, NamingSystem.status, NamingSystem.kind, NamingSystem.date, NamingSystem.uniqueId, NamingSystem.uniqueId.modifierExtension, NamingSystem.uniqueId.type, NamingSystem.uniqueId.type.extension, NamingSystem.uniqueId.type.extension:type, NamingSystem.uniqueId.value All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error NamingSystem.extension, NamingSystem.extension:replacedBy, NamingSystem.modifierExtension, NamingSystem.uniqueId.modifierExtension, NamingSystem.uniqueId.type.extension, NamingSystem.uniqueId.type.extension:type 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NamingSystem 0..* NamingSystem(5.0.0) System of unique identification
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.text
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:replacedBy 0..1 Reference(Cross-version Profile for STU3.NamingSystem for use in FHIR R5(0.1.0) | NamingSystem) STU3: Use this instead (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.replacedBy
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* ContactDetail STU3: contact additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.contact
... useContext
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:useContext 0..* UsageContext STU3: Context the content is intended to support additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.useContext
... uniqueId
.... type
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:type 0..1 code STU3: oid | uuid | uri | other additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.uniqueId.type
Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.
.... period
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:period 0..1 Period STU3: period additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.uniqueId.period

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NamingSystem C 0..* NamingSystem(5.0.0) System of unique identification
Constraints: cnl-0, nsd-1, nsd-2, nsd-3
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 Meta STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:replacedBy 0..1 Reference(Cross-version Profile for STU3.NamingSystem for use in FHIR R5(0.1.0) | NamingSystem) STU3: Use this instead (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.replacedBy
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url ΣC 0..1 uri Canonical identifier for this naming system, represented as a URI (globally unique)
Constraints: cnl-1
... identifier Σ 0..* Identifier Additional identifier for the naming system (business identifier)
... version Σ 0..1 string Business version of the naming system
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 1..1 string Name for this naming system (computer friendly)
... title Σ 0..1 string Title for this naming system (human friendly)
... status ?!Σ 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 Σ 0..1 boolean For testing purposes, not real usage
... date Σ 1..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:contact 0..* ContactDetail STU3: contact additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.contact
Constraints: ext-1
.... name Σ 0..1 string Name of an individual to contact
.... telecom Σ 0..* ContactPoint Contact details for individual or organization
... 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 0..1 markdown Natural language description of the naming system
... useContext Σ 0..* UsageContext The context that the content is intended to support
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:useContext 0..* UsageContext STU3: Context the content is intended to support additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.useContext
Constraints: ext-1
.... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context.
.... value[x] Σ 1..1 Value that defines the context
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization)
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:type 0..1 code STU3: oid | uuid | uri | other additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.uniqueId.type
Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.
Constraints: ext-1
..... value 0..1 code Primitive value for code
.... 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?
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:period 0..1 Period STU3: period additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.uniqueId.period
Constraints: ext-1
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... authoritative C 0..1 boolean Whether the identifier is authoritative

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
NamingSystem.meta.security Base extensible All Security Labels . 📍5.0.0 tx.fhir.org
NamingSystem.meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
NamingSystem.language Base required All Languages 📍5.0.0 FHIR Std.
NamingSystem.text.status Base required NarrativeStatus 📍5.0.0 FHIR Std.
NamingSystem.versionAlgorithm[x] Base extensible Version Algorithm 📍5.0.0 FHIR Std.
NamingSystem.status Base required PublicationStatus 📍5.0.0 FHIR Std.
NamingSystem.kind Base required Naming System Type 📍5.0.0 FHIR Std.
NamingSystem.type Base preferred Naming System Identifier System Type 📍5.0.0 FHIR Std.
NamingSystem.useContext.​code Base extensible UsageContextType 📍1.0.1 THO v7.1
NamingSystem.useContext.​value[x] Base example Context of Use ValueSet 📍5.0.0 FHIR Std.
NamingSystem.jurisdiction Base extensible Jurisdiction ValueSet 📍5.0.0 FHIR Std.
NamingSystem.topic Base example Definition Topic 📍5.0.0 FHIR Std.
NamingSystem.uniqueId.​type Base required Naming System Identifier Type 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 NamingSystem.meta, NamingSystem.meta.extension, NamingSystem.meta.extension:meta, NamingSystem.meta.versionId, NamingSystem.meta.lastUpdated, NamingSystem.meta.source, NamingSystem.meta.profile, NamingSystem.meta.security, NamingSystem.meta.tag, NamingSystem.implicitRules, NamingSystem.language, NamingSystem.text, NamingSystem.text.extension, NamingSystem.text.extension:text, NamingSystem.text.status, NamingSystem.text.div, NamingSystem.extension, NamingSystem.extension:replacedBy, NamingSystem.modifierExtension, NamingSystem.url, NamingSystem.identifier, NamingSystem.version, NamingSystem.versionAlgorithm[x], NamingSystem.name, NamingSystem.title, NamingSystem.status, NamingSystem.kind, NamingSystem.experimental, NamingSystem.date, NamingSystem.publisher, NamingSystem.contact, NamingSystem.contact.extension, NamingSystem.contact.extension:contact, NamingSystem.contact.name, NamingSystem.contact.telecom, NamingSystem.responsible, NamingSystem.type, NamingSystem.description, NamingSystem.useContext, NamingSystem.useContext.extension, NamingSystem.useContext.extension:useContext, NamingSystem.useContext.code, NamingSystem.useContext.value[x], NamingSystem.jurisdiction, NamingSystem.purpose, NamingSystem.copyright, NamingSystem.copyrightLabel, NamingSystem.approvalDate, NamingSystem.lastReviewDate, NamingSystem.effectivePeriod, NamingSystem.topic, NamingSystem.author, NamingSystem.editor, NamingSystem.reviewer, NamingSystem.endorser, NamingSystem.relatedArtifact, NamingSystem.usage, NamingSystem.uniqueId, NamingSystem.uniqueId.extension, NamingSystem.uniqueId.modifierExtension, NamingSystem.uniqueId.type, NamingSystem.uniqueId.type.extension, NamingSystem.uniqueId.type.extension:type, NamingSystem.uniqueId.value, NamingSystem.uniqueId.preferred, NamingSystem.uniqueId.comment, NamingSystem.uniqueId.period, NamingSystem.uniqueId.period.extension, NamingSystem.uniqueId.period.extension:period, NamingSystem.uniqueId.period.start, NamingSystem.uniqueId.period.end, NamingSystem.uniqueId.authoritative All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error NamingSystem.meta.extension, NamingSystem.meta.extension:meta, NamingSystem.text.extension, NamingSystem.text.extension:text, NamingSystem.extension, NamingSystem.extension:replacedBy, NamingSystem.modifierExtension, NamingSystem.contact.extension, NamingSystem.contact.extension:contact, NamingSystem.useContext.extension, NamingSystem.useContext.extension:useContext, NamingSystem.uniqueId.extension, NamingSystem.uniqueId.modifierExtension, NamingSystem.uniqueId.type.extension, NamingSystem.uniqueId.type.extension:type, NamingSystem.uniqueId.period.extension, NamingSystem.uniqueId.period.extension:period 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()
txt-1 error NamingSystem.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error NamingSystem.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NamingSystem C 0..* NamingSystem(5.0.0) System of unique identification
Constraints: cnl-0, nsd-1, nsd-2, nsd-3
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:replacedBy 0..1 Reference(Cross-version Profile for STU3.NamingSystem for use in FHIR R5(0.1.0) | NamingSystem) STU3: Use this instead (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.replacedBy
Constraints: ext-1
... name ΣC 1..1 string Name for this naming system (computer friendly)
... status ?!Σ 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.
... date Σ 1..1 dateTime Date last changed
... uniqueId ΣC 1..* BackboneElement Unique identifiers used for system
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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.
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:type 0..1 code STU3: oid | uuid | uri | other additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.uniqueId.type
Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.
Constraints: ext-1
.... value Σ 1..1 string The unique identifier

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
NamingSystem.status Base required PublicationStatus 📍5.0.0 FHIR Std.
NamingSystem.kind Base required Naming System Type 📍5.0.0 FHIR Std.
NamingSystem.uniqueId.​type Base required Naming System Identifier Type 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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}$')
ele-1 error NamingSystem.implicitRules, NamingSystem.extension, NamingSystem.extension:replacedBy, NamingSystem.modifierExtension, NamingSystem.name, NamingSystem.status, NamingSystem.kind, NamingSystem.date, NamingSystem.uniqueId, NamingSystem.uniqueId.modifierExtension, NamingSystem.uniqueId.type, NamingSystem.uniqueId.type.extension, NamingSystem.uniqueId.type.extension:type, NamingSystem.uniqueId.value All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error NamingSystem.extension, NamingSystem.extension:replacedBy, NamingSystem.modifierExtension, NamingSystem.uniqueId.modifierExtension, NamingSystem.uniqueId.type.extension, NamingSystem.uniqueId.type.extension:type 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NamingSystem 0..* NamingSystem(5.0.0) System of unique identification
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.text
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:replacedBy 0..1 Reference(Cross-version Profile for STU3.NamingSystem for use in FHIR R5(0.1.0) | NamingSystem) STU3: Use this instead (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.replacedBy
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* ContactDetail STU3: contact additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.contact
... useContext
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:useContext 0..* UsageContext STU3: Context the content is intended to support additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.useContext
... uniqueId
.... type
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:type 0..1 code STU3: oid | uuid | uri | other additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.uniqueId.type
Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.
.... period
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:period 0..1 Period STU3: period additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.uniqueId.period

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NamingSystem C 0..* NamingSystem(5.0.0) System of unique identification
Constraints: cnl-0, nsd-1, nsd-2, nsd-3
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 Meta STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:replacedBy 0..1 Reference(Cross-version Profile for STU3.NamingSystem for use in FHIR R5(0.1.0) | NamingSystem) STU3: Use this instead (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.replacedBy
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url ΣC 0..1 uri Canonical identifier for this naming system, represented as a URI (globally unique)
Constraints: cnl-1
... identifier Σ 0..* Identifier Additional identifier for the naming system (business identifier)
... version Σ 0..1 string Business version of the naming system
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 1..1 string Name for this naming system (computer friendly)
... title Σ 0..1 string Title for this naming system (human friendly)
... status ?!Σ 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 Σ 0..1 boolean For testing purposes, not real usage
... date Σ 1..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:contact 0..* ContactDetail STU3: contact additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.contact
Constraints: ext-1
.... name Σ 0..1 string Name of an individual to contact
.... telecom Σ 0..* ContactPoint Contact details for individual or organization
... 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 0..1 markdown Natural language description of the naming system
... useContext Σ 0..* UsageContext The context that the content is intended to support
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:useContext 0..* UsageContext STU3: Context the content is intended to support additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.useContext
Constraints: ext-1
.... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context.
.... value[x] Σ 1..1 Value that defines the context
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization)
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:type 0..1 code STU3: oid | uuid | uri | other additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.uniqueId.type
Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.
Constraints: ext-1
..... value 0..1 code Primitive value for code
.... 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?
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:period 0..1 Period STU3: period additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-NamingSystem.uniqueId.period
Constraints: ext-1
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... authoritative C 0..1 boolean Whether the identifier is authoritative

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
NamingSystem.meta.security Base extensible All Security Labels . 📍5.0.0 tx.fhir.org
NamingSystem.meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
NamingSystem.language Base required All Languages 📍5.0.0 FHIR Std.
NamingSystem.text.status Base required NarrativeStatus 📍5.0.0 FHIR Std.
NamingSystem.versionAlgorithm[x] Base extensible Version Algorithm 📍5.0.0 FHIR Std.
NamingSystem.status Base required PublicationStatus 📍5.0.0 FHIR Std.
NamingSystem.kind Base required Naming System Type 📍5.0.0 FHIR Std.
NamingSystem.type Base preferred Naming System Identifier System Type 📍5.0.0 FHIR Std.
NamingSystem.useContext.​code Base extensible UsageContextType 📍1.0.1 THO v7.1
NamingSystem.useContext.​value[x] Base example Context of Use ValueSet 📍5.0.0 FHIR Std.
NamingSystem.jurisdiction Base extensible Jurisdiction ValueSet 📍5.0.0 FHIR Std.
NamingSystem.topic Base example Definition Topic 📍5.0.0 FHIR Std.
NamingSystem.uniqueId.​type Base required Naming System Identifier Type 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 NamingSystem.meta, NamingSystem.meta.extension, NamingSystem.meta.extension:meta, NamingSystem.meta.versionId, NamingSystem.meta.lastUpdated, NamingSystem.meta.source, NamingSystem.meta.profile, NamingSystem.meta.security, NamingSystem.meta.tag, NamingSystem.implicitRules, NamingSystem.language, NamingSystem.text, NamingSystem.text.extension, NamingSystem.text.extension:text, NamingSystem.text.status, NamingSystem.text.div, NamingSystem.extension, NamingSystem.extension:replacedBy, NamingSystem.modifierExtension, NamingSystem.url, NamingSystem.identifier, NamingSystem.version, NamingSystem.versionAlgorithm[x], NamingSystem.name, NamingSystem.title, NamingSystem.status, NamingSystem.kind, NamingSystem.experimental, NamingSystem.date, NamingSystem.publisher, NamingSystem.contact, NamingSystem.contact.extension, NamingSystem.contact.extension:contact, NamingSystem.contact.name, NamingSystem.contact.telecom, NamingSystem.responsible, NamingSystem.type, NamingSystem.description, NamingSystem.useContext, NamingSystem.useContext.extension, NamingSystem.useContext.extension:useContext, NamingSystem.useContext.code, NamingSystem.useContext.value[x], NamingSystem.jurisdiction, NamingSystem.purpose, NamingSystem.copyright, NamingSystem.copyrightLabel, NamingSystem.approvalDate, NamingSystem.lastReviewDate, NamingSystem.effectivePeriod, NamingSystem.topic, NamingSystem.author, NamingSystem.editor, NamingSystem.reviewer, NamingSystem.endorser, NamingSystem.relatedArtifact, NamingSystem.usage, NamingSystem.uniqueId, NamingSystem.uniqueId.extension, NamingSystem.uniqueId.modifierExtension, NamingSystem.uniqueId.type, NamingSystem.uniqueId.type.extension, NamingSystem.uniqueId.type.extension:type, NamingSystem.uniqueId.value, NamingSystem.uniqueId.preferred, NamingSystem.uniqueId.comment, NamingSystem.uniqueId.period, NamingSystem.uniqueId.period.extension, NamingSystem.uniqueId.period.extension:period, NamingSystem.uniqueId.period.start, NamingSystem.uniqueId.period.end, NamingSystem.uniqueId.authoritative All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error NamingSystem.meta.extension, NamingSystem.meta.extension:meta, NamingSystem.text.extension, NamingSystem.text.extension:text, NamingSystem.extension, NamingSystem.extension:replacedBy, NamingSystem.modifierExtension, NamingSystem.contact.extension, NamingSystem.contact.extension:contact, NamingSystem.useContext.extension, NamingSystem.useContext.extension:useContext, NamingSystem.uniqueId.extension, NamingSystem.uniqueId.modifierExtension, NamingSystem.uniqueId.type.extension, NamingSystem.uniqueId.type.extension:type, NamingSystem.uniqueId.period.extension, NamingSystem.uniqueId.period.extension:period 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()
txt-1 error NamingSystem.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error NamingSystem.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron