Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4B
0.1.0 - STU International flag

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

Resource Profile: Profile_R2_NamingSystem_R4B

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

This cross-version profile allows DSTU2 NamingSystem content to be represented via FHIR R4B 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(4.3.0) System of unique identification
Constraints: nsd-0, nsd-1, nsd-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:replacedBy 0..1 Reference(Cross-version Profile for DSTU2.NamingSystem for use in FHIR R4B(0.1.0) | NamingSystem) DSTU2: Use this instead (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-NamingSystem.replacedBy
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... kind Σ 1..1 code codesystem | identifier | root
Binding: NamingSystemType (required): Identifies the purpose of the naming system.
... date Σ 1..1 dateTime Date last changed
... uniqueId Σ 1..* BackboneElement Unique identifiers used for system
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type Σ 1..1 code oid | uuid | uri | other
Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.
.... 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 📍4.3.0 FHIR Std.
NamingSystem.kind Base required NamingSystemType 📍4.3.0 FHIR Std.
NamingSystem.uniqueId.​type Base required NamingSystemIdentifierType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error NamingSystem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error NamingSystem If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error NamingSystem If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error NamingSystem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice NamingSystem A resource should have narrative for robust management text.`div`.exists()
ele-1 error 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.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 Must have either extensions or value[x], not both extension.exists() != value.exists()
nsd-0 warning NamingSystem Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
nsd-1 error NamingSystem Root systems cannot have uuid identifiers kind != 'root' or uniqueId.all(type != 'uuid')
nsd-2 error NamingSystem Can't have more than one preferred identifier for a type uniqueId.where(preferred = true).select(type).isDistinct()

This structure is derived from NamingSystem

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NamingSystem 0..* NamingSystem(4.3.0) System of unique identification
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-NamingSystem.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.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 DSTU2.NamingSystem for use in FHIR R4B(0.1.0) | NamingSystem) DSTU2: Use this instead (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-NamingSystem.replacedBy
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:name 0..1 string DSTU2: Name of a individual to contact (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-NamingSystem.contact.name
..... extension:telecom 0..* ContactPoint DSTU2: Contact details for individual or publisher (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-NamingSystem.contact.telecom
... uniqueId
.... period
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-NamingSystem.uniqueId.period

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NamingSystem C 0..* NamingSystem(4.3.0) System of unique identification
Constraints: nsd-0, nsd-1, nsd-2
... 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 (Complex) DSTU2: meta additional types
URL: http://hl7.org/fhir/1.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: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-NamingSystem.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:replacedBy 0..1 Reference(Cross-version Profile for DSTU2.NamingSystem for use in FHIR R4B(0.1.0) | NamingSystem) DSTU2: Use this instead (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-NamingSystem.replacedBy
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... name Σ 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 Σ 1..1 code codesystem | identifier | root
Binding: NamingSystemType (required): Identifies the purpose of the naming system.
... date Σ 1..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (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:name 0..1 string DSTU2: Name of a individual to contact (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-NamingSystem.contact.name
Constraints: ext-1
..... extension:telecom 0..* ContactPoint DSTU2: Contact details for individual or publisher (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-NamingSystem.contact.telecom
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: Identifier Type Codes (extensible): 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
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for naming system (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... usage 0..1 string How/where is it used
... uniqueId Σ 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 Σ 1..1 code oid | uuid | uri | other
Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.
.... value Σ 1..1 string The unique identifier
.... preferred 0..1 boolean Is this the id that should be used for this type
.... comment 0..1 string Notes about identifier usage
.... period 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 DSTU2: period additional types
URL: http://hl7.org/fhir/1.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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
NamingSystem.meta.security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
NamingSystem.meta.tag Base example Common Tags 📍4.3.0 FHIR Std.
NamingSystem.language Base preferred Common Languages 📍4.3.0 FHIR Std.
NamingSystem.text.status Base required NarrativeStatus 📍4.3.0 FHIR Std.
NamingSystem.status Base required PublicationStatus 📍4.3.0 FHIR Std.
NamingSystem.kind Base required NamingSystemType 📍4.3.0 FHIR Std.
NamingSystem.type Base extensible IdentifierType 📍4.3.0 FHIR Std.
NamingSystem.jurisdiction Base extensible Jurisdiction 📍4.3.0 FHIR Std.
NamingSystem.uniqueId.​type Base required NamingSystemIdentifierType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error NamingSystem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error NamingSystem If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error NamingSystem If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error NamingSystem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice NamingSystem A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning NamingSystem.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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.name, NamingSystem.status, NamingSystem.kind, NamingSystem.date, NamingSystem.publisher, NamingSystem.contact, NamingSystem.contact.extension, NamingSystem.contact.extension:name, NamingSystem.contact.extension:telecom, NamingSystem.contact.name, NamingSystem.contact.telecom, NamingSystem.responsible, NamingSystem.type, NamingSystem.description, NamingSystem.useContext, NamingSystem.jurisdiction, NamingSystem.usage, NamingSystem.uniqueId, NamingSystem.uniqueId.extension, NamingSystem.uniqueId.modifierExtension, NamingSystem.uniqueId.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 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:name, NamingSystem.contact.extension:telecom, NamingSystem.uniqueId.extension, NamingSystem.uniqueId.modifierExtension, NamingSystem.uniqueId.period.extension, NamingSystem.uniqueId.period.extension:period Must have either extensions or value[x], not both extension.exists() != value.exists()
nsd-0 warning NamingSystem Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
nsd-1 error NamingSystem Root systems cannot have uuid identifiers kind != 'root' or uniqueId.all(type != 'uuid')
nsd-2 error NamingSystem Can't have more than one preferred identifier for a type uniqueId.where(preferred = true).select(type).isDistinct()
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(4.3.0) System of unique identification
Constraints: nsd-0, nsd-1, nsd-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:replacedBy 0..1 Reference(Cross-version Profile for DSTU2.NamingSystem for use in FHIR R4B(0.1.0) | NamingSystem) DSTU2: Use this instead (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-NamingSystem.replacedBy
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... kind Σ 1..1 code codesystem | identifier | root
Binding: NamingSystemType (required): Identifies the purpose of the naming system.
... date Σ 1..1 dateTime Date last changed
... uniqueId Σ 1..* BackboneElement Unique identifiers used for system
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type Σ 1..1 code oid | uuid | uri | other
Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.
.... 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 📍4.3.0 FHIR Std.
NamingSystem.kind Base required NamingSystemType 📍4.3.0 FHIR Std.
NamingSystem.uniqueId.​type Base required NamingSystemIdentifierType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error NamingSystem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error NamingSystem If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error NamingSystem If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error NamingSystem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice NamingSystem A resource should have narrative for robust management text.`div`.exists()
ele-1 error 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.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 Must have either extensions or value[x], not both extension.exists() != value.exists()
nsd-0 warning NamingSystem Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
nsd-1 error NamingSystem Root systems cannot have uuid identifiers kind != 'root' or uniqueId.all(type != 'uuid')
nsd-2 error NamingSystem Can't have more than one preferred identifier for a type uniqueId.where(preferred = true).select(type).isDistinct()

Differential View

This structure is derived from NamingSystem

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NamingSystem 0..* NamingSystem(4.3.0) System of unique identification
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-NamingSystem.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.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 DSTU2.NamingSystem for use in FHIR R4B(0.1.0) | NamingSystem) DSTU2: Use this instead (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-NamingSystem.replacedBy
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:name 0..1 string DSTU2: Name of a individual to contact (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-NamingSystem.contact.name
..... extension:telecom 0..* ContactPoint DSTU2: Contact details for individual or publisher (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-NamingSystem.contact.telecom
... uniqueId
.... period
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-NamingSystem.uniqueId.period

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NamingSystem C 0..* NamingSystem(4.3.0) System of unique identification
Constraints: nsd-0, nsd-1, nsd-2
... 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 (Complex) DSTU2: meta additional types
URL: http://hl7.org/fhir/1.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: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-NamingSystem.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:replacedBy 0..1 Reference(Cross-version Profile for DSTU2.NamingSystem for use in FHIR R4B(0.1.0) | NamingSystem) DSTU2: Use this instead (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-NamingSystem.replacedBy
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... name Σ 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 Σ 1..1 code codesystem | identifier | root
Binding: NamingSystemType (required): Identifies the purpose of the naming system.
... date Σ 1..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (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:name 0..1 string DSTU2: Name of a individual to contact (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-NamingSystem.contact.name
Constraints: ext-1
..... extension:telecom 0..* ContactPoint DSTU2: Contact details for individual or publisher (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-NamingSystem.contact.telecom
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: Identifier Type Codes (extensible): 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
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for naming system (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... usage 0..1 string How/where is it used
... uniqueId Σ 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 Σ 1..1 code oid | uuid | uri | other
Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.
.... value Σ 1..1 string The unique identifier
.... preferred 0..1 boolean Is this the id that should be used for this type
.... comment 0..1 string Notes about identifier usage
.... period 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 DSTU2: period additional types
URL: http://hl7.org/fhir/1.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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
NamingSystem.meta.security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
NamingSystem.meta.tag Base example Common Tags 📍4.3.0 FHIR Std.
NamingSystem.language Base preferred Common Languages 📍4.3.0 FHIR Std.
NamingSystem.text.status Base required NarrativeStatus 📍4.3.0 FHIR Std.
NamingSystem.status Base required PublicationStatus 📍4.3.0 FHIR Std.
NamingSystem.kind Base required NamingSystemType 📍4.3.0 FHIR Std.
NamingSystem.type Base extensible IdentifierType 📍4.3.0 FHIR Std.
NamingSystem.jurisdiction Base extensible Jurisdiction 📍4.3.0 FHIR Std.
NamingSystem.uniqueId.​type Base required NamingSystemIdentifierType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error NamingSystem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error NamingSystem If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error NamingSystem If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error NamingSystem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice NamingSystem A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning NamingSystem.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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.name, NamingSystem.status, NamingSystem.kind, NamingSystem.date, NamingSystem.publisher, NamingSystem.contact, NamingSystem.contact.extension, NamingSystem.contact.extension:name, NamingSystem.contact.extension:telecom, NamingSystem.contact.name, NamingSystem.contact.telecom, NamingSystem.responsible, NamingSystem.type, NamingSystem.description, NamingSystem.useContext, NamingSystem.jurisdiction, NamingSystem.usage, NamingSystem.uniqueId, NamingSystem.uniqueId.extension, NamingSystem.uniqueId.modifierExtension, NamingSystem.uniqueId.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 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:name, NamingSystem.contact.extension:telecom, NamingSystem.uniqueId.extension, NamingSystem.uniqueId.modifierExtension, NamingSystem.uniqueId.period.extension, NamingSystem.uniqueId.period.extension:period Must have either extensions or value[x], not both extension.exists() != value.exists()
nsd-0 warning NamingSystem Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
nsd-1 error NamingSystem Root systems cannot have uuid identifiers kind != 'root' or uniqueId.all(type != 'uuid')
nsd-2 error NamingSystem Can't have more than one preferred identifier for a type uniqueId.where(preferred = true).select(type).isDistinct()
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