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

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

Resource Profile: Profile_R4B_NamingSystem_R3 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-NamingSystem resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. NamingSystem
Definition

A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.

ShortSystem of unique identification
Control0..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
nsd-1: Root systems cannot have uuid identifiers (kind != 'root' or uniqueId.type = 'uuid')
nsd-3: Can only have replacedBy if naming system is retired (replacedBy.empty() or status = 'retired')
nsd-2: Can't have more than one preferred identifier for a type (uniqueId.where(preferred = true).select(type).isDistinct())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
nsd-1: Root systems cannot have uuid identifiers (kind != 'root' or uniqueId.type = 'uuid')
nsd-3: Can only have replacedBy if naming system is retired (replacedBy.empty() or status = 'retired')
nsd-2: Can't have more than one preferred identifier for a type (uniqueId.where(preferred = true).select(type).isDistinct())
2. NamingSystem.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. NamingSystem.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Alternate Namesextensions, user content
6. NamingSystem.name
Definition

A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation.

ShortName for this naming system (computer friendly)
Comments

The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly. The"symbolic name" for an OID would be captured as an extension.

Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Support human navigation and code generation.

8. NamingSystem.status
Definition

The status of this naming system. Enables tracking the life-cycle of the content.

Shortdraft | active | retired | unknown
Comments

Allows filtering of naming systems that are appropriate for use vs. not.
This is labeled as "Is Modifier" because applications should not use a retired naming system without due consideration.

Control1..1
BindingThe codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|3.0.2
(required to http://hl7.org/fhir/ValueSet/publication-status|3.0.2)

The lifecycle status of a Value Set or Concept Map.

Typecode
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
10. NamingSystem.kind
Definition

Indicates the purpose for the naming system - what kinds of things does it make unique?

Shortcodesystem | identifier | root
Control1..1
BindingThe codes SHALL be taken from NamingSystemTypehttp://hl7.org/fhir/ValueSet/namingsystem-type|3.0.2
(required to http://hl7.org/fhir/ValueSet/namingsystem-type|3.0.2)

Identifies the purpose of the naming system.

Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. NamingSystem.date
Definition

The date (and optionally time) when the naming system was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes.

ShortDate this was last changed
Comments

Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the naming system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesRevision Date
14. NamingSystem.uniqueId
Definition

Indicates how the system may be identified when referenced in electronic exchange.

ShortUnique identifiers used for system
Comments

Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.

Control1..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
16. NamingSystem.uniqueId.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Summarytrue
Alternate Namesextensions, user content, modifiers
18. NamingSystem.uniqueId.type
Definition

Identifies the unique identifier scheme used for this particular identifier.

Shortoid | uuid | uri | other
Comments

Different identifier types may be used in different types of communications (OIDs for v3, URIs for FHIR, etc.). Other includes RUIDs from v3, standard v2 code name strings, etc.

Control1..1
BindingThe codes SHALL be taken from NamingSystemIdentifierTypehttp://hl7.org/fhir/ValueSet/namingsystem-identifier-type|3.0.2
(required to http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|3.0.2)

Identifies the style of unique identifier used to identify a namespace.

Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. NamingSystem.uniqueId.value
Definition

The string that should be sent over the wire to identify the code system or identifier system.

ShortThe unique identifier
Comments

If the value is a URI intended for use as FHIR system identifier, the URI should not contain "" or "?" or "," since this makes escaping very difficult.

Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be foundhere

0. NamingSystem
2. NamingSystem.meta
4. NamingSystem.meta.extension
Control0..*
SlicingThis element introduces a set of slices on NamingSystem.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. NamingSystem.meta.extension:meta
    Slice Namemeta
    Definition

    R4B: NamingSystem.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)

    ShortR4B: meta additional types
    Comments

    Element NamingSystem.meta is mapped to FHIR STU3 element NamingSystem.meta as SourceIsBroaderThanTarget. The mappings for NamingSystem.meta do not cover the following types: Meta. The mappings for NamingSystem.meta do not cover the following types based on type expansion: lastUpdated, profile, security, source, tag, versionId.

    Control0..1
    TypeExtension(R4B: meta additional types) (Extension Type: Meta)
    8. NamingSystem.text
    10. NamingSystem.text.extension
    Control0..*
    SlicingThis element introduces a set of slices on NamingSystem.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 12. NamingSystem.text.extension:text
      Slice Nametext
      Definition

      R4B: NamingSystem.text additional types (Narrative) additional types from child elements (div, status)

      ShortR4B: text additional types
      Comments

      Element NamingSystem.text is mapped to FHIR STU3 element NamingSystem.text as SourceIsBroaderThanTarget. The mappings for NamingSystem.text do not cover the following types: Narrative. The mappings for NamingSystem.text do not cover the following types based on type expansion: div, status. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

      Control0..1
      TypeExtension(R4B: text additional types) (Complex Extension)
      14. NamingSystem.contact
      16. NamingSystem.contact.extension
      Control0..*
      SlicingThis element introduces a set of slices on NamingSystem.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 18. NamingSystem.contact.extension:contact
        Slice Namecontact
        Definition

        R4B: NamingSystem.contact additional types (ContactDetail) additional types from child elements (name, telecom)

        ShortR4B: contact additional types
        Comments

        Element NamingSystem.contact is mapped to FHIR STU3 element NamingSystem.contact as SourceIsBroaderThanTarget. The mappings for NamingSystem.contact do not cover the following types: ContactDetail. The mappings for NamingSystem.contact do not cover the following types based on type expansion: name, telecom. May be a web site, an email address, a telephone number, etc.

        Control0..*
        TypeExtension(R4B: contact additional types) (Complex Extension)
        20. NamingSystem.useContext
        22. NamingSystem.useContext.extension
        Control0..*
        SlicingThis element introduces a set of slices on NamingSystem.useContext.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 24. NamingSystem.useContext.extension:useContext
          Slice NameuseContext
          Definition

          R4B: NamingSystem.useContext additional types (UsageContext) additional types from child elements (code, value[x])

          ShortR4B: The context that the content is intended to support additional types
          Comments

          Element NamingSystem.useContext is mapped to FHIR STU3 element NamingSystem.useContext as SourceIsBroaderThanTarget. The mappings for NamingSystem.useContext do not cover the following types: UsageContext. The mappings for NamingSystem.useContext do not cover the following types based on type expansion: code, value[x]. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

          Control0..*
          TypeExtension(R4B: The context that the content is intended to support additional types) (Complex Extension)
          26. NamingSystem.uniqueId
          28. NamingSystem.uniqueId.period
          30. NamingSystem.uniqueId.period.extension
          Control0..*
          SlicingThis element introduces a set of slices on NamingSystem.uniqueId.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 32. NamingSystem.uniqueId.period.extension:period
            Slice Nameperiod
            Definition

            R4B: NamingSystem.uniqueId.period additional types (Period) additional types from child elements (end, start)

            ShortR4B: period additional types
            Comments

            Element NamingSystem.uniqueId.period is mapped to FHIR STU3 element NamingSystem.uniqueId.period as SourceIsBroaderThanTarget. The mappings for NamingSystem.uniqueId.period do not cover the following types: Period. The mappings for NamingSystem.uniqueId.period do not cover the following types based on type expansion: end, start. Within a registry, a given identifier should only be "active" for a single namespace at a time. (Ideally, an identifier should only ever be associated with a single namespace across all time).

            Control0..1
            TypeExtension(R4B: period additional types) (Extension Type: Period)

            Guidance on how to interpret the contents of this table can be foundhere

            0. NamingSystem
            Definition

            A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.

            ShortSystem of unique identification
            Control0..*
            Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
            dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
            dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
            nsd-1: Root systems cannot have uuid identifiers (kind != 'root' or uniqueId.type = 'uuid')
            nsd-3: Can only have replacedBy if naming system is retired (replacedBy.empty() or status = 'retired')
            nsd-2: Can't have more than one preferred identifier for a type (uniqueId.where(preferred = true).select(type).isDistinct())
            2. NamingSystem.id
            Definition

            The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

            ShortLogical id of this artifact
            Comments

            The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

            Control0..1
            Typeid
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            4. NamingSystem.meta
            Definition

            The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

            ShortMetadata about the resource
            Control0..1
            TypeMeta
            Summarytrue
            6. NamingSystem.meta.id
            Definition

            unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            Shortxml:id (or equivalent in JSON)
            Control0..1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            8. NamingSystem.meta.extension
            Definition

            An Extension

            ShortExtension
            Control0..*
            TypeExtension
            SlicingThis element introduces a set of slices on NamingSystem.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 10. NamingSystem.meta.extension:meta
              Slice Namemeta
              Definition

              R4B: NamingSystem.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)

              ShortR4B: meta additional types
              Comments

              Element NamingSystem.meta is mapped to FHIR STU3 element NamingSystem.meta as SourceIsBroaderThanTarget. The mappings for NamingSystem.meta do not cover the following types: Meta. The mappings for NamingSystem.meta do not cover the following types based on type expansion: lastUpdated, profile, security, source, tag, versionId.

              Control0..1
              TypeExtension(R4B: meta additional types) (Extension Type: Meta)
              12. NamingSystem.meta.versionId
              Definition

              The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.

              ShortVersion specific identifier
              Comments

              The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

              Control0..1
              Typeid
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              14. NamingSystem.meta.lastUpdated
              Definition

              When the resource last changed - e.g. when the version changed.

              ShortWhen the resource version last changed
              Comments

              This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.

              Control0..1
              Typeinstant
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              16. NamingSystem.meta.profile
              Definition

              A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

              ShortProfiles this resource claims to conform to
              Comments

              It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

              Control0..*
              Typeuri
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              18. NamingSystem.meta.security
              Definition

              Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

              ShortSecurity Labels applied to this resource
              Comments

              The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

              Control0..*
              BindingUnless not suitable, these codes SHALL be taken from All Security Labels
              (extensible to http://hl7.org/fhir/ValueSet/security-labels|3.0.2)

              Security Labels from the Healthcare Privacy and Security Classification System.

              TypeCoding
              Summarytrue
              20. NamingSystem.meta.tag
              Definition

              Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

              ShortTags applied to this resource
              Comments

              The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

              Control0..*
              BindingFor example codes, see Common Tags
              (example to http://hl7.org/fhir/ValueSet/common-tags|3.0.2)

              Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"

              TypeCoding
              Summarytrue
              22. NamingSystem.implicitRules
              Definition

              A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

              ShortA set of rules under which this content was created
              Comments

              Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

              This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

              Control0..1
              Typeuri
              Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              24. NamingSystem.language
              Definition

              The base language in which the resource is written.

              ShortLanguage of the resource content
              Comments

              Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

              Control0..1
              BindingUnless not suitable, these codes SHALL be taken from Common Languages
              (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)

              A human language.

              Additional BindingsPurpose
              All LanguagesMax Binding
              Typecode
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              26. NamingSystem.text
              Definition

              A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

              ShortText summary of the resource, for human interpretation
              Comments

              Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

              Control0..1
              This element is affected by the following invariants: dom-1
              TypeNarrative
              Alternate Namesnarrative, html, xhtml, display
              28. NamingSystem.text.id
              Definition

              unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              Shortxml:id (or equivalent in JSON)
              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              30. NamingSystem.text.extension
              Definition

              An Extension

              ShortExtension
              Control0..*
              TypeExtension
              SlicingThis element introduces a set of slices on NamingSystem.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 32. NamingSystem.text.extension:text
                Slice Nametext
                Definition

                R4B: NamingSystem.text additional types (Narrative) additional types from child elements (div, status)

                ShortR4B: text additional types
                Comments

                Element NamingSystem.text is mapped to FHIR STU3 element NamingSystem.text as SourceIsBroaderThanTarget. The mappings for NamingSystem.text do not cover the following types: Narrative. The mappings for NamingSystem.text do not cover the following types based on type expansion: div, status. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

                Control0..1
                TypeExtension(R4B: text additional types) (Complex Extension)
                34. NamingSystem.text.status
                Definition

                The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

                Shortgenerated | extensions | additional | empty
                Control1..1
                BindingThe codes SHALL be taken from NarrativeStatus
                (required to http://hl7.org/fhir/ValueSet/narrative-status|3.0.2)

                The status of a resource narrative

                Typecode
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                36. NamingSystem.text.div
                Definition

                The actual narrative content, a stripped down version of XHTML.

                ShortLimited xhtml content
                Comments

                The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content may not contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.

                Control1..1
                Typexhtml
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Invariantstxt-1: 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: The narrative SHALL have some non-whitespace content (htmlchecks())
                38. NamingSystem.contained
                Definition

                These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

                ShortContained, inline Resources
                Comments

                This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

                Control0..*
                TypeResource
                Alternate Namesinline resources, anonymous resources, contained resources
                40. NamingSystem.extension
                Definition

                May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                ShortAdditional Content defined by implementations
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Alternate Namesextensions, user content
                42. NamingSystem.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                ShortExtensions that cannot be ignored
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                Alternate Namesextensions, user content
                44. NamingSystem.name
                Definition

                A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation.

                ShortName for this naming system (computer friendly)
                Comments

                The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly. The"symbolic name" for an OID would be captured as an extension.

                Control1..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

                Support human navigation and code generation.

                46. NamingSystem.status
                Definition

                The status of this naming system. Enables tracking the life-cycle of the content.

                Shortdraft | active | retired | unknown
                Comments

                Allows filtering of naming systems that are appropriate for use vs. not.
                This is labeled as "Is Modifier" because applications should not use a retired naming system without due consideration.

                Control1..1
                BindingThe codes SHALL be taken from PublicationStatus
                (required to http://hl7.org/fhir/ValueSet/publication-status|3.0.2)

                The lifecycle status of a Value Set or Concept Map.

                Typecode
                Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                48. NamingSystem.kind
                Definition

                Indicates the purpose for the naming system - what kinds of things does it make unique?

                Shortcodesystem | identifier | root
                Control1..1
                BindingThe codes SHALL be taken from NamingSystemType
                (required to http://hl7.org/fhir/ValueSet/namingsystem-type|3.0.2)

                Identifies the purpose of the naming system.

                Typecode
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                50. NamingSystem.date
                Definition

                The date (and optionally time) when the naming system was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes.

                ShortDate this was last changed
                Comments

                Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the naming system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

                Control1..1
                TypedateTime
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Alternate NamesRevision Date
                52. NamingSystem.publisher
                Definition

                The name of the individual or organization that published the naming system.

                ShortName of the publisher (organization or individual)
                Comments

                Usually an organization, but may be an individual. The publisher (or steward) of the naming system is the organization or individual primarily responsible for the maintenance and upkeep of the naming system. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the naming system. This item SHOULD be populated unless the information is available from context.

                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

                Helps establish the "authority/credibility" of the naming system. May also allow for contact.

                54. NamingSystem.contact
                Definition

                Contact details to assist a user in finding and communicating with the publisher.

                ShortContact details for the publisher
                Comments

                May be a web site, an email address, a telephone number, etc.

                Control0..*
                TypeContactDetail
                Summarytrue
                56. NamingSystem.contact.id
                Definition

                unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                Shortxml:id (or equivalent in JSON)
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                58. NamingSystem.contact.extension
                Definition

                An Extension

                ShortExtension
                Control0..*
                TypeExtension
                SlicingThis element introduces a set of slices on NamingSystem.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 60. NamingSystem.contact.extension:contact
                  Slice Namecontact
                  Definition

                  R4B: NamingSystem.contact additional types (ContactDetail) additional types from child elements (name, telecom)

                  ShortR4B: contact additional types
                  Comments

                  Element NamingSystem.contact is mapped to FHIR STU3 element NamingSystem.contact as SourceIsBroaderThanTarget. The mappings for NamingSystem.contact do not cover the following types: ContactDetail. The mappings for NamingSystem.contact do not cover the following types based on type expansion: name, telecom. May be a web site, an email address, a telephone number, etc.

                  Control0..*
                  TypeExtension(R4B: contact additional types) (Complex Extension)
                  62. NamingSystem.contact.name
                  Definition

                  The name of an individual to contact.

                  ShortName of an individual to contact
                  Comments

                  If there is no named individual, the telecom information is for the organization as a whole.

                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  64. NamingSystem.contact.telecom
                  Definition

                  The contact details for the individual (if a name was provided) or the organization.

                  ShortContact details for individual or organization
                  Control0..*
                  TypeContactPoint
                  Summarytrue
                  66. NamingSystem.responsible
                  Definition

                  The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.

                  ShortWho maintains system namespace?
                  Comments

                  This is the primary organization. Responsibility for some aspects of a namespace may be delegated.

                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  68. NamingSystem.type
                  Definition

                  Categorizes a naming system for easier search by grouping related naming systems.

                  Shorte.g. driver, provider, patient, bank etc.
                  Comments

                  This will most commonly be used for identifier namespaces, but categories could potentially be useful for code systems and authorities as well.

                  Control0..1
                  BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                  (extensible to http://hl7.org/fhir/ValueSet/identifier-type|3.0.2)

                  A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                  TypeCodeableConcept
                  70. NamingSystem.description
                  Definition

                  A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc.

                  ShortNatural language description of the naming system
                  Comments

                  This description can be used to capture details such as why the naming system was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the naming system as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created).

                  Control0..1
                  Typemarkdown
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  72. NamingSystem.useContext
                  Definition

                  The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate naming system instances.

                  ShortContext the content is intended to support
                  Comments

                  When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.

                  Control0..*
                  TypeUsageContext
                  Summarytrue
                  Requirements

                  Assist in searching for appropriate content.

                  74. NamingSystem.useContext.id
                  Definition

                  unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  Shortxml:id (or equivalent in JSON)
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  76. NamingSystem.useContext.extension
                  Definition

                  An Extension

                  ShortExtension
                  Control0..*
                  TypeExtension
                  SlicingThis element introduces a set of slices on NamingSystem.useContext.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 78. NamingSystem.useContext.extension:useContext
                    Slice NameuseContext
                    Definition

                    R4B: NamingSystem.useContext additional types (UsageContext) additional types from child elements (code, value[x])

                    ShortR4B: The context that the content is intended to support additional types
                    Comments

                    Element NamingSystem.useContext is mapped to FHIR STU3 element NamingSystem.useContext as SourceIsBroaderThanTarget. The mappings for NamingSystem.useContext do not cover the following types: UsageContext. The mappings for NamingSystem.useContext do not cover the following types based on type expansion: code, value[x]. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

                    Control0..*
                    TypeExtension(R4B: The context that the content is intended to support additional types) (Complex Extension)
                    80. NamingSystem.useContext.code
                    Definition

                    A code that identifies the type of context being specified by this usage context.

                    ShortType of context being specified
                    Control1..1
                    BindingUnless not suitable, these codes SHALL be taken from UsageContextType
                    (extensible to http://hl7.org/fhir/ValueSet/usage-context-type|3.0.2)

                    A code that specifies a type of context being specified by a usage context

                    TypeCoding
                    Summarytrue
                    82. NamingSystem.useContext.value[x]
                    Definition

                    A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

                    ShortValue that defines the context
                    Control1..1
                    BindingFor example codes, see Context of Use ValueSet
                    (example to http://hl7.org/fhir/ValueSet/use-context|3.0.2)

                    A code that defines the specific value for the context being specified

                    TypeChoice of: CodeableConcept, Quantity, Range
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    Summarytrue
                    84. NamingSystem.jurisdiction
                    Definition

                    A legal or geographic region in which the naming system is intended to be used.

                    ShortIntended jurisdiction for naming system (if applicable)
                    Comments

                    It may be possible for the naming system to be used in jurisdictions other than those for which it was originally designed or intended.

                    Control0..*
                    BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSet
                    (extensible to http://hl7.org/fhir/ValueSet/jurisdiction|3.0.2)

                    Countries and regions within which this artifact is targeted for use

                    TypeCodeableConcept
                    Summarytrue
                    86. NamingSystem.usage
                    Definition

                    Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.

                    ShortHow/where is it used
                    Control0..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    88. NamingSystem.uniqueId
                    Definition

                    Indicates how the system may be identified when referenced in electronic exchange.

                    ShortUnique identifiers used for system
                    Comments

                    Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.

                    Control1..*
                    TypeBackboneElement
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                    90. NamingSystem.uniqueId.id
                    Definition

                    unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    Shortxml:id (or equivalent in JSON)
                    Control0..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    92. NamingSystem.uniqueId.extension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional Content defined by implementations
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Alternate Namesextensions, user content
                    94. NamingSystem.uniqueId.modifierExtension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                    ShortExtensions that cannot be ignored
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                    Summarytrue
                    Alternate Namesextensions, user content, modifiers
                    96. NamingSystem.uniqueId.type
                    Definition

                    Identifies the unique identifier scheme used for this particular identifier.

                    Shortoid | uuid | uri | other
                    Comments

                    Different identifier types may be used in different types of communications (OIDs for v3, URIs for FHIR, etc.). Other includes RUIDs from v3, standard v2 code name strings, etc.

                    Control1..1
                    BindingThe codes SHALL be taken from NamingSystemIdentifierType
                    (required to http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|3.0.2)

                    Identifies the style of unique identifier used to identify a namespace.

                    Typecode
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    98. NamingSystem.uniqueId.value
                    Definition

                    The string that should be sent over the wire to identify the code system or identifier system.

                    ShortThe unique identifier
                    Comments

                    If the value is a URI intended for use as FHIR system identifier, the URI should not contain "" or "?" or "," since this makes escaping very difficult.

                    Control1..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    100. NamingSystem.uniqueId.preferred
                    Definition

                    Indicates whether this identifier is the "preferred" identifier of this type.

                    ShortIs this the id that should be used for this type
                    Control0..1
                    Typeboolean
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Meaning if MissingIf there are multiple ids, and one is labeled "preferred", then the assumption is that the others are not preferred. In the absence of any id marked as preferred, no inference can be drawn
                    102. NamingSystem.uniqueId.comment
                    Definition

                    Notes about the past or intended usage of this identifier.

                    ShortNotes about identifier usage
                    Comments

                    e.g. "must be used in Germany" or "was initially published in error with this value".

                    Control0..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    104. NamingSystem.uniqueId.period
                    Definition

                    Identifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic.

                    ShortWhen is identifier valid?
                    Comments

                    Within a registry, a given identifier should only be "active" for a single namespace at a time. (Ideally, an identifier should only ever be associated with a single namespace across all time).

                    Control0..1
                    TypePeriod
                    106. NamingSystem.uniqueId.period.id
                    Definition

                    unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    Shortxml:id (or equivalent in JSON)
                    Control0..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    108. NamingSystem.uniqueId.period.extension
                    Definition

                    An Extension

                    ShortExtension
                    Control0..*
                    TypeExtension
                    SlicingThis element introduces a set of slices on NamingSystem.uniqueId.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 110. NamingSystem.uniqueId.period.extension:period
                      Slice Nameperiod
                      Definition

                      R4B: NamingSystem.uniqueId.period additional types (Period) additional types from child elements (end, start)

                      ShortR4B: period additional types
                      Comments

                      Element NamingSystem.uniqueId.period is mapped to FHIR STU3 element NamingSystem.uniqueId.period as SourceIsBroaderThanTarget. The mappings for NamingSystem.uniqueId.period do not cover the following types: Period. The mappings for NamingSystem.uniqueId.period do not cover the following types based on type expansion: end, start. Within a registry, a given identifier should only be "active" for a single namespace at a time. (Ideally, an identifier should only ever be associated with a single namespace across all time).

                      Control0..1
                      TypeExtension(R4B: period additional types) (Extension Type: Period)
                      112. NamingSystem.uniqueId.period.start
                      Definition

                      The start of the period. The boundary is inclusive.

                      ShortStarting time with inclusive boundary
                      Comments

                      If the low element is missing, the meaning is that the low boundary is not known.

                      Control0..1
                      This element is affected by the following invariants: per-1
                      TypedateTime
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      114. NamingSystem.uniqueId.period.end
                      Definition

                      The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

                      ShortEnd time with inclusive boundary, if not ongoing
                      Comments

                      The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.

                      Control0..1
                      This element is affected by the following invariants: per-1
                      TypedateTime
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
                      116. NamingSystem.replacedBy
                      Definition

                      For naming systems that are retired, indicates the naming system that should be used in their place (if any).

                      ShortUse this instead
                      Control0..1
                      This element is affected by the following invariants: nsd-3
                      TypeReference(NamingSystem)