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

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

Resource Profile: Profile_R2_ValueSet_R4_CodeSystem - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-ValueSet-for-CodeSystem resource profile.

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

0. CodeSystem
Definition

The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.

ShortDeclares the existence of and describes a code system or code system supplement
Control0..*
Is Modifierfalse
Summaryfalse
Invariantscsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
csd-1: Within a code system definition, all the codes SHALL be unique (concept.code.combine($this.descendants().concept.code).isDistinct())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
csd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
csd-1: Within a code system definition, all the codes SHALL be unique (concept.code.combine($this.descendants().concept.code).isDistinct())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. CodeSystem.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. CodeSystem.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional 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.

Control10..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on CodeSystem.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. CodeSystem.extension:extensible
    Slice Nameextensible
    Definition

    DSTU2: ValueSet.extensible (new:boolean)

    ShortDSTU2: Whether this is intended to be used with an extensible binding (new)
    Comments

    Element ValueSet.extensible has a context of CodeSystem based on following the parent source element upwards and mapping to CodeSystem. Element ValueSet.extensible has a context of ValueSet based on following the parent source element upwards and mapping to ValueSet. Element ValueSet.extensible has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(DSTU2: Whether this is intended to be used with an extensible binding (new)) (Extension Type: boolean)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. CodeSystem.extension:codeSystem
    Slice NamecodeSystem
    Definition

    DSTU2: ValueSet.codeSystem (new:BackboneElement)

    ShortDSTU2: An inline code system, which is part of this value set (new)
    Comments

    Element ValueSet.codeSystem has a context of CodeSystem based on following the parent source element upwards and mapping to CodeSystem. Element ValueSet.codeSystem has a context of ValueSet based on following the parent source element upwards and mapping to ValueSet. Element ValueSet.codeSystem has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). All code systems defined as part of a FHIR value set have an implicit valueset that includes all of the codes in the code system - the value set in which they are defined.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(DSTU2: An inline code system, which is part of this value set (new)) (Complex Extension)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. CodeSystem.extension:concept
    Slice Nameconcept
    Definition

    DSTU2: ValueSet.codeSystem.concept (new:BackboneElement)

    ShortDSTU2: Concepts in the code system (new)
    Comments

    Element ValueSet.codeSystem.concept is part of an existing definition because parent element ValueSet.codeSystem requires a cross-version extension. Element ValueSet.codeSystem.concept has a context of CodeSystem based on following the parent source element upwards and mapping to CodeSystem. Element ValueSet.codeSystem.concept has a context of ValueSet based on following the parent source element upwards and mapping to ValueSet. Element ValueSet.codeSystem.concept has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Control1..*
    This element is affected by the following invariants: ele-1
    TypeExtension(DSTU2: Concepts in the code system (new)) (Complex Extension)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. CodeSystem.extension:concept
    Slice Nameconcept
    Definition

    DSTU2: ValueSet.codeSystem.concept.concept (new:ValueSet.codeSystem.concept)

    ShortDSTU2: Child Concepts (is-a/contains/categorizes) (new)
    Comments

    Element ValueSet.codeSystem.concept.concept is part of an existing definition because parent element ValueSet.codeSystem.concept requires a cross-version extension. Element ValueSet.codeSystem.concept.concept has a context of CodeSystem based on following the parent source element upwards and mapping to CodeSystem. Element ValueSet.codeSystem.concept.concept has a context of ValueSet based on following the parent source element upwards and mapping to ValueSet. Element ValueSet.codeSystem.concept.concept has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(DSTU2: Concepts in the code system (new)) (Complex Extension)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    14. CodeSystem.extension:import
    Slice Nameimport
    Definition

    DSTU2: ValueSet.compose.import (new:uri)

    ShortDSTU2: Import the contents of another value set (new)
    Comments

    Element ValueSet.compose.import has a context of CodeSystem based on following the parent source element upwards and mapping to CodeSystem. Element ValueSet.compose.import has a context of ValueSet.compose based on following the parent source element upwards and mapping to ValueSet. Element ValueSet.compose.import has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). The value set URI is either a logical reference to a defined value set such as a [SNOMED CT reference set]{snomedct.html#implicit}, or a direct reference to a value set definition using ValueSet.url. The reference may also not reference an actual FHIR ValueSet resource; in this case, whatever is referenced is an implicit definition of a value set that needs to be clear about how versions are resolved.

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(DSTU2: Import the contents of another value set (new)) (Extension Type: uri)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    16. CodeSystem.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    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 Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    18. CodeSystem.status
    Definition

    The date (and optionally time) when the code system resource was created or revised.

    Shortdraft | active | retired | unknown
    Comments

    Allows filtering of code systems that are appropriate for use versus not.

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

    The lifecycle status of an artifact.

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. CodeSystem.content
    Definition

    The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.

    Shortnot-present | example | fragment | complete | supplement
    Control1..1
    BindingThe codes SHALL be taken from CodeSystemContentModehttp://hl7.org/fhir/ValueSet/codesystem-content-mode|4.0.1
    (required to http://hl7.org/fhir/ValueSet/codesystem-content-mode|4.0.1)

    The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.

    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

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

      DSTU2: ValueSet.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, tag, versionId)

      ShortDSTU2: Metadata about the resource additional types
      Comments

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

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

        DSTU2: ValueSet.text additional types (Narrative) additional types from child elements (div, status)

        ShortDSTU2: Text summary of the resource, for human interpretation additional types
        Comments

        Element ValueSet.text is mapped to FHIR R4 element CodeSystem.text as SourceIsBroaderThanTarget. Element ValueSet.text is mapped to FHIR R4 element ValueSet.text as SourceIsBroaderThanTarget. The mappings for ValueSet.text do not cover the following types: Narrative. The mappings for ValueSet.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.

        Control0..1
        TypeExtension(DSTU2: Text summary of the resource, for human interpretation additional types) (Complex Extension)
        14. CodeSystem.extension
        Control1..*
        SlicingThis element introduces a set of slices on CodeSystem.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 16. CodeSystem.extension:extensible
          Slice Nameextensible
          Definition

          DSTU2: ValueSet.extensible (new:boolean)

          ShortDSTU2: Whether this is intended to be used with an extensible binding (new)
          Comments

          Element ValueSet.extensible has a context of CodeSystem based on following the parent source element upwards and mapping to CodeSystem. Element ValueSet.extensible has a context of ValueSet based on following the parent source element upwards and mapping to ValueSet. Element ValueSet.extensible has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

          Control0..1
          TypeExtension(DSTU2: Whether this is intended to be used with an extensible binding (new)) (Extension Type: boolean)
          18. CodeSystem.extension:codeSystem
          Slice NamecodeSystem
          Definition

          DSTU2: ValueSet.codeSystem (new:BackboneElement)

          ShortDSTU2: An inline code system, which is part of this value set (new)
          Comments

          Element ValueSet.codeSystem has a context of CodeSystem based on following the parent source element upwards and mapping to CodeSystem. Element ValueSet.codeSystem has a context of ValueSet based on following the parent source element upwards and mapping to ValueSet. Element ValueSet.codeSystem has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). All code systems defined as part of a FHIR value set have an implicit valueset that includes all of the codes in the code system - the value set in which they are defined.

          Control0..1
          TypeExtension(DSTU2: An inline code system, which is part of this value set (new)) (Complex Extension)
          20. CodeSystem.extension:concept
          Slice Nameconcept
          Definition

          DSTU2: ValueSet.codeSystem.concept (new:BackboneElement)

          ShortDSTU2: Concepts in the code system (new)
          Comments

          Element ValueSet.codeSystem.concept is part of an existing definition because parent element ValueSet.codeSystem requires a cross-version extension. Element ValueSet.codeSystem.concept has a context of CodeSystem based on following the parent source element upwards and mapping to CodeSystem. Element ValueSet.codeSystem.concept has a context of ValueSet based on following the parent source element upwards and mapping to ValueSet. Element ValueSet.codeSystem.concept has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

          Control1..*
          TypeExtension(DSTU2: Concepts in the code system (new)) (Complex Extension)
          22. CodeSystem.extension:concept
          Slice Nameconcept
          Definition

          DSTU2: ValueSet.codeSystem.concept.concept (new:ValueSet.codeSystem.concept)

          ShortDSTU2: Child Concepts (is-a/contains/categorizes) (new)
          Comments

          Element ValueSet.codeSystem.concept.concept is part of an existing definition because parent element ValueSet.codeSystem.concept requires a cross-version extension. Element ValueSet.codeSystem.concept.concept has a context of CodeSystem based on following the parent source element upwards and mapping to CodeSystem. Element ValueSet.codeSystem.concept.concept has a context of ValueSet based on following the parent source element upwards and mapping to ValueSet. Element ValueSet.codeSystem.concept.concept has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

          Control0..*
          TypeExtension(DSTU2: Concepts in the code system (new)) (Complex Extension)
          24. CodeSystem.extension:import
          Slice Nameimport
          Definition

          DSTU2: ValueSet.compose.import (new:uri)

          ShortDSTU2: Import the contents of another value set (new)
          Comments

          Element ValueSet.compose.import has a context of CodeSystem based on following the parent source element upwards and mapping to CodeSystem. Element ValueSet.compose.import has a context of ValueSet.compose based on following the parent source element upwards and mapping to ValueSet. Element ValueSet.compose.import has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). The value set URI is either a logical reference to a defined value set such as a [SNOMED CT reference set]{snomedct.html#implicit}, or a direct reference to a value set definition using ValueSet.url. The reference may also not reference an actual FHIR ValueSet resource; in this case, whatever is referenced is an implicit definition of a value set that needs to be clear about how versions are resolved.

          Control0..*
          TypeExtension(DSTU2: Import the contents of another value set (new)) (Extension Type: uri)
          26. CodeSystem.identifier
          NoteThis is a business identifier, not a resource identifier (see discussion)
          28. CodeSystem.identifier.extension
          Control0..*
          SlicingThis element introduces a set of slices on CodeSystem.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 30. CodeSystem.identifier.extension:identifier
            Slice Nameidentifier
            Definition

            DSTU2: ValueSet.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

            ShortDSTU2: Additional identifier for the value set (e.g. HL7 v2 / CDA) additional types
            Comments

            Element ValueSet.identifier is mapped to FHIR R4 element CodeSystem.identifier as RelatedTo. Element ValueSet.identifier is mapped to FHIR R4 element ValueSet.identifier as RelatedTo. The mappings for ValueSet.identifier do not cover the following types: Identifier. The mappings for ValueSet.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value. Typically, this is used for values that can go in an HL7 v3 II data type.

            Control0..1
            TypeExtension(DSTU2: Additional identifier for the value set (e.g. HL7 v2 / CDA) additional types) (Extension Type: Identifier)
            32. CodeSystem.contact
            34. CodeSystem.contact.extension
            Control0..*
            SlicingThis element introduces a set of slices on CodeSystem.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 36. CodeSystem.contact.extension:name
              Slice Namename
              Definition

              DSTU2: ValueSet.contact.name (new:string)

              ShortDSTU2: Name of an individual to contact (new)
              Comments

              Element ValueSet.contact.name has a context of CodeSystem.contact based on following the parent source element upwards and mapping to CodeSystem. Element ValueSet.contact.name has a context of ValueSet.contact based on following the parent source element upwards and mapping to ValueSet. Element ValueSet.contact.name has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). If there is no named individual, the telecom is for the organization as a whole.

              Control0..1
              TypeExtension(DSTU2: Name of an individual to contact (new)) (Extension Type: string)
              38. CodeSystem.contact.extension:telecom
              Slice Nametelecom
              Definition

              DSTU2: ValueSet.contact.telecom (new:ContactPoint)

              ShortDSTU2: Contact details for individual or publisher (new)
              Comments

              Element ValueSet.contact.telecom has a context of CodeSystem.contact based on following the parent source element upwards and mapping to CodeSystem. Element ValueSet.contact.telecom has a context of ValueSet.contact based on following the parent source element upwards and mapping to ValueSet. Element ValueSet.contact.telecom has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

              Control0..*
              TypeExtension(DSTU2: Contact details for individual or publisher (new)) (Extension Type: ContactPoint)

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

              0. CodeSystem
              Definition

              The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.

              ShortDeclares the existence of and describes a code system or code system supplement
              Control0..*
              Is Modifierfalse
              Summaryfalse
              Invariantscsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
              csd-1: Within a code system definition, all the codes SHALL be unique (concept.code.combine($this.descendants().concept.code).isDistinct())
              dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
              dom-3: 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
              dom-6: A resource should have narrative for robust management (text.`div`.exists())
              2. CodeSystem.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
              Is Modifierfalse
              Summarytrue
              4. CodeSystem.meta
              Definition

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

              ShortMetadata about the resource
              Control0..1
              TypeMeta
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              6. CodeSystem.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.

              ShortUnique id for inter-element referencing
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              8. CodeSystem.meta.extension
              Definition

              An Extension

              ShortExtension
              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on CodeSystem.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 10. CodeSystem.meta.extension:meta
                Slice Namemeta
                Definition

                DSTU2: ValueSet.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, tag, versionId)

                ShortDSTU2: Metadata about the resource additional types
                Comments

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

                Control0..1
                TypeExtension(DSTU2: Metadata about the resource additional types) (Extension Type: Meta)
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                12. CodeSystem.meta.versionId
                Definition

                The version specific identifier, as it appears in the version portion of the URL. This value 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
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                14. CodeSystem.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. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

                Control0..1
                Typeinstant
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                16. CodeSystem.meta.source
                Definition

                A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

                ShortIdentifies where the resource comes from
                Comments

                In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

                This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

                Control0..1
                Typeuri
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                18. CodeSystem.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..*
                Typecanonical(StructureDefinition)
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                20. CodeSystem.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|4.0.1)

                Security Labels from the Healthcare Privacy and Security Classification System.

                TypeCoding
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                22. CodeSystem.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 CommonTags
                (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

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

                TypeCoding
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                24. CodeSystem.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

                Control0..1
                Typeuri
                Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                26. CodeSystem.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
                BindingThe codes SHOULD be taken from CommonLanguages
                (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

                A human language.

                Additional BindingsPurpose
                AllLanguagesMax Binding
                Typecode
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                28. CodeSystem.text
                Definition

                A human-readable narrative that contains a summary of the resource and can 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 information is added later.

                Control0..1
                TypeNarrative
                Is Modifierfalse
                Summaryfalse
                Alternate Namesnarrative, html, xhtml, display
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                30. CodeSystem.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.

                ShortUnique id for inter-element referencing
                Control0..1
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                32. CodeSystem.text.extension
                Definition

                An Extension

                ShortExtension
                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                SlicingThis element introduces a set of slices on CodeSystem.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 34. CodeSystem.text.extension:text
                  Slice Nametext
                  Definition

                  DSTU2: ValueSet.text additional types (Narrative) additional types from child elements (div, status)

                  ShortDSTU2: Text summary of the resource, for human interpretation additional types
                  Comments

                  Element ValueSet.text is mapped to FHIR R4 element CodeSystem.text as SourceIsBroaderThanTarget. Element ValueSet.text is mapped to FHIR R4 element ValueSet.text as SourceIsBroaderThanTarget. The mappings for ValueSet.text do not cover the following types: Narrative. The mappings for ValueSet.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.

                  Control0..1
                  TypeExtension(DSTU2: Text summary of the resource, for human interpretation additional types) (Complex Extension)
                  Is Modifierfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  36. CodeSystem.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|4.0.1)

                  The status of a resource narrative.

                  Typecode
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  38. CodeSystem.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 SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.

                  Control1..1
                  Typexhtml
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  txt-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())
                  40. CodeSystem.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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

                  Control0..*
                  TypeResource
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesinline resources, anonymous resources, contained resources
                  42. CodeSystem.extension
                  Definition

                  An Extension

                  ShortExtension
                  Control1..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  SlicingThis element introduces a set of slices on CodeSystem.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 44. CodeSystem.extension:extensible
                    Slice Nameextensible
                    Definition

                    DSTU2: ValueSet.extensible (new:boolean)

                    ShortDSTU2: Whether this is intended to be used with an extensible binding (new)
                    Comments

                    Element ValueSet.extensible has a context of CodeSystem based on following the parent source element upwards and mapping to CodeSystem. Element ValueSet.extensible has a context of ValueSet based on following the parent source element upwards and mapping to ValueSet. Element ValueSet.extensible has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                    Control0..1
                    This element is affected by the following invariants: ele-1
                    TypeExtension(DSTU2: Whether this is intended to be used with an extensible binding (new)) (Extension Type: boolean)
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    46. CodeSystem.extension:codeSystem
                    Slice NamecodeSystem
                    Definition

                    DSTU2: ValueSet.codeSystem (new:BackboneElement)

                    ShortDSTU2: An inline code system, which is part of this value set (new)
                    Comments

                    Element ValueSet.codeSystem has a context of CodeSystem based on following the parent source element upwards and mapping to CodeSystem. Element ValueSet.codeSystem has a context of ValueSet based on following the parent source element upwards and mapping to ValueSet. Element ValueSet.codeSystem has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). All code systems defined as part of a FHIR value set have an implicit valueset that includes all of the codes in the code system - the value set in which they are defined.

                    Control0..1
                    This element is affected by the following invariants: ele-1
                    TypeExtension(DSTU2: An inline code system, which is part of this value set (new)) (Complex Extension)
                    Is Modifierfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    48. CodeSystem.extension:concept
                    Slice Nameconcept
                    Definition

                    DSTU2: ValueSet.codeSystem.concept (new:BackboneElement)

                    ShortDSTU2: Concepts in the code system (new)
                    Comments

                    Element ValueSet.codeSystem.concept is part of an existing definition because parent element ValueSet.codeSystem requires a cross-version extension. Element ValueSet.codeSystem.concept has a context of CodeSystem based on following the parent source element upwards and mapping to CodeSystem. Element ValueSet.codeSystem.concept has a context of ValueSet based on following the parent source element upwards and mapping to ValueSet. Element ValueSet.codeSystem.concept has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                    Control1..*
                    This element is affected by the following invariants: ele-1
                    TypeExtension(DSTU2: Concepts in the code system (new)) (Complex Extension)
                    Is Modifierfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    50. CodeSystem.extension:concept
                    Slice Nameconcept
                    Definition

                    DSTU2: ValueSet.codeSystem.concept.concept (new:ValueSet.codeSystem.concept)

                    ShortDSTU2: Child Concepts (is-a/contains/categorizes) (new)
                    Comments

                    Element ValueSet.codeSystem.concept.concept is part of an existing definition because parent element ValueSet.codeSystem.concept requires a cross-version extension. Element ValueSet.codeSystem.concept.concept has a context of CodeSystem based on following the parent source element upwards and mapping to CodeSystem. Element ValueSet.codeSystem.concept.concept has a context of ValueSet based on following the parent source element upwards and mapping to ValueSet. Element ValueSet.codeSystem.concept.concept has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                    Control0..*
                    This element is affected by the following invariants: ele-1
                    TypeExtension(DSTU2: Concepts in the code system (new)) (Complex Extension)
                    Is Modifierfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    52. CodeSystem.extension:import
                    Slice Nameimport
                    Definition

                    DSTU2: ValueSet.compose.import (new:uri)

                    ShortDSTU2: Import the contents of another value set (new)
                    Comments

                    Element ValueSet.compose.import has a context of CodeSystem based on following the parent source element upwards and mapping to CodeSystem. Element ValueSet.compose.import has a context of ValueSet.compose based on following the parent source element upwards and mapping to ValueSet. Element ValueSet.compose.import has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). The value set URI is either a logical reference to a defined value set such as a [SNOMED CT reference set]{snomedct.html#implicit}, or a direct reference to a value set definition using ValueSet.url. The reference may also not reference an actual FHIR ValueSet resource; in this case, whatever is referenced is an implicit definition of a value set that needs to be clear about how versions are resolved.

                    Control0..*
                    This element is affected by the following invariants: ele-1
                    TypeExtension(DSTU2: Import the contents of another value set (new)) (Extension Type: uri)
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    54. CodeSystem.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.

                    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                    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 Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                    Summaryfalse
                    Requirements

                    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                    Alternate Namesextensions, user content
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    56. CodeSystem.url
                    Definition

                    An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in Coding.system.

                    ShortCanonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
                    Comments

                    Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

                    The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

                    In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

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

                    Allows the code system to be referenced by a single globally unique identifier.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    58. CodeSystem.identifier
                    Definition

                    A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.

                    ShortAdditional identifier for the code system (business identifier)
                    Comments

                    Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this code system outside of FHIR, where it is not possible to use the logical URI. Note that HL7 defines at least three identifiers for many of its code systems - the FHIR canonical URL, the OID and the V2 Table 0396 mnemonic code.

                    NoteThis is a business identifier, not a resource identifier (see discussion)
                    Control0..*
                    TypeIdentifier
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    Allows externally provided and/or usable business identifiers to be easily associated with the module.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    60. CodeSystem.identifier.id
                    Definition

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

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    62. CodeSystem.identifier.extension
                    Definition

                    An Extension

                    ShortExtension
                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    SlicingThis element introduces a set of slices on CodeSystem.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 64. CodeSystem.identifier.extension:identifier
                      Slice Nameidentifier
                      Definition

                      DSTU2: ValueSet.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

                      ShortDSTU2: Additional identifier for the value set (e.g. HL7 v2 / CDA) additional types
                      Comments

                      Element ValueSet.identifier is mapped to FHIR R4 element CodeSystem.identifier as RelatedTo. Element ValueSet.identifier is mapped to FHIR R4 element ValueSet.identifier as RelatedTo. The mappings for ValueSet.identifier do not cover the following types: Identifier. The mappings for ValueSet.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value. Typically, this is used for values that can go in an HL7 v3 II data type.

                      Control0..1
                      TypeExtension(DSTU2: Additional identifier for the value set (e.g. HL7 v2 / CDA) additional types) (Extension Type: Identifier)
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      66. CodeSystem.identifier.use
                      Definition

                      The purpose of this identifier.

                      Shortusual | official | temp | secondary | old (If known)
                      Comments

                      Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                      Control0..1
                      BindingThe codes SHALL be taken from IdentifierUse
                      (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                      Identifies the purpose for this identifier, if known .

                      Typecode
                      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      68. CodeSystem.identifier.type
                      Definition

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

                      ShortDescription of identifier
                      Comments

                      This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

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

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

                      TypeCodeableConcept
                      Is Modifierfalse
                      Summarytrue
                      Requirements

                      Allows users to make use of identifiers when the identifier system is not known.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      70. CodeSystem.identifier.system
                      Definition

                      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                      ShortThe namespace for the identifier value
                      Comments

                      Identifier.system is always case sensitive.

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

                      There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                      ExampleGeneral: http://www.acme.com/identifiers/patient
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      72. CodeSystem.identifier.value
                      Definition

                      The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                      ShortThe value that is unique
                      Comments

                      If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      ExampleGeneral: 123456
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      74. CodeSystem.identifier.period
                      Definition

                      Time period during which identifier is/was valid for use.

                      ShortTime period when id is/was valid for use
                      Control0..1
                      TypePeriod
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      76. CodeSystem.identifier.assigner
                      Definition

                      Organization that issued/manages the identifier.

                      ShortOrganization that issued id (may be just text)
                      Comments

                      The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                      Control0..1
                      TypeReference(Organization)
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      78. CodeSystem.version
                      Definition

                      The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in Coding.version.

                      ShortBusiness version of the code system (Coding.version)
                      Comments

                      There may be different code system instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the code system with the format [url]|[version].

                      NoteThis is a business version Id, not a resource version Id (see discussion)
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      80. CodeSystem.name
                      Definition

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

                      ShortName for this code system (computer friendly)
                      Comments

                      The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

                      Control0..1
                      This element is affected by the following invariants: inv-0
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Support human navigation and code generation.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      82. CodeSystem.title
                      Definition

                      A short, descriptive, user-friendly title for the code system.

                      ShortName for this code system (human friendly)
                      Comments

                      This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      84. CodeSystem.status
                      Definition

                      The date (and optionally time) when the code system resource was created or revised.

                      Shortdraft | active | retired | unknown
                      Comments

                      Allows filtering of code systems that are appropriate for use versus not.

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

                      The lifecycle status of an artifact.

                      Typecode
                      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      86. CodeSystem.experimental
                      Definition

                      A Boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

                      ShortFor testing purposes, not real usage
                      Comments

                      Allows filtering of code systems that are appropriate for use versus not.

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

                      Enables experimental content to be developed following the same lifecycle that would be used for a production-level code system.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      88. CodeSystem.date
                      Definition

                      The date (and optionally time) when the code system was published. The date must change 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 code system changes.

                      ShortDate 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 code system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

                      Control0..1
                      TypedateTime
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Alternate NamesRevision Date
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      90. CodeSystem.publisher
                      Definition

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

                      ShortName of the publisher (organization or individual)
                      Comments

                      Usually an organization but may be an individual. The publisher (or steward) of the code system is the organization or individual primarily responsible for the maintenance and upkeep of the code 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 code system. This item SHOULD be populated unless the information is available from context.

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

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

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      92. CodeSystem.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
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      94. CodeSystem.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.

                      ShortUnique id for inter-element referencing
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      96. CodeSystem.contact.extension
                      Definition

                      An Extension

                      ShortExtension
                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      SlicingThis element introduces a set of slices on CodeSystem.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 98. CodeSystem.contact.extension:name
                        Slice Namename
                        Definition

                        DSTU2: ValueSet.contact.name (new:string)

                        ShortDSTU2: Name of an individual to contact (new)
                        Comments

                        Element ValueSet.contact.name has a context of CodeSystem.contact based on following the parent source element upwards and mapping to CodeSystem. Element ValueSet.contact.name has a context of ValueSet.contact based on following the parent source element upwards and mapping to ValueSet. Element ValueSet.contact.name has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). If there is no named individual, the telecom is for the organization as a whole.

                        Control0..1
                        TypeExtension(DSTU2: Name of an individual to contact (new)) (Extension Type: string)
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        100. CodeSystem.contact.extension:telecom
                        Slice Nametelecom
                        Definition

                        DSTU2: ValueSet.contact.telecom (new:ContactPoint)

                        ShortDSTU2: Contact details for individual or publisher (new)
                        Comments

                        Element ValueSet.contact.telecom has a context of CodeSystem.contact based on following the parent source element upwards and mapping to CodeSystem. Element ValueSet.contact.telecom has a context of ValueSet.contact based on following the parent source element upwards and mapping to ValueSet. Element ValueSet.contact.telecom has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                        Control0..*
                        TypeExtension(DSTU2: Contact details for individual or publisher (new)) (Extension Type: ContactPoint)
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        102. CodeSystem.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
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        104. CodeSystem.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
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        106. CodeSystem.description
                        Definition

                        A free text natural language description of the code system from a consumer's perspective.

                        ShortNatural language description of the code system
                        Comments

                        This description can be used to capture details such as why the code 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 code 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 code system is presumed to be the predominant language in the place the code system was created).

                        Control0..1
                        Typemarkdown
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Alternate NamesScope, Purpose
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        108. CodeSystem.useContext
                        Definition

                        The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate code system instances.

                        ShortThe context that the content is intended to support
                        Comments

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

                        Control0..*
                        TypeUsageContext
                        Is Modifierfalse
                        Summarytrue
                        Requirements

                        Assist in searching for appropriate content.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        110. CodeSystem.jurisdiction
                        Definition

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

                        ShortIntended jurisdiction for code system (if applicable)
                        Comments

                        It may be possible for the code 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|4.0.1)

                        Countries and regions within which this artifact is targeted for use.

                        TypeCodeableConcept
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        112. CodeSystem.purpose
                        Definition

                        Explanation of why this code system is needed and why it has been designed as it has.

                        ShortWhy this code system is defined
                        Comments

                        This element does not describe the usage of the code system. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this code system.

                        Control0..1
                        Typemarkdown
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        114. CodeSystem.copyright
                        Definition

                        A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.

                        ShortUse and/or publishing restrictions
                        Comments

                        ... Sometimes, the copyright differs between the code system and the codes that are included. The copyright statement should clearly differentiate between these when required.

                        Control0..1
                        Typemarkdown
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Requirements

                        Consumers must be able to determine any legal restrictions on the use of the code system and/or its content.

                        Alternate NamesLicense, Restrictions
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        116. CodeSystem.caseSensitive
                        Definition

                        If code comparison is case sensitive when codes within this system are compared to each other.

                        ShortIf code comparison is case sensitive
                        Comments

                        If this value is missing, then it is not specified whether a code system is case sensitive or not. When the rule is not known, Postel's law should be followed: produce codes with the correct case, and accept codes in any case. This element is primarily provided to support validation software.

                        Control0..1
                        Typeboolean
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        118. CodeSystem.valueSet
                        Definition

                        Canonical reference to the value set that contains the entire code system.

                        ShortCanonical reference to the value set with entire code system
                        Comments

                        The definition of the value set SHALL include all codes from this code system and only codes from this code system, and it SHALL be immutable.

                        Control0..1
                        Typecanonical(ValueSet)
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        120. CodeSystem.hierarchyMeaning
                        Definition

                        The meaning of the hierarchy of concepts as represented in this resource.

                        Shortgrouped-by | is-a | part-of | classified-with
                        Comments

                        Note that other representations might have a different hierarchy or none at all, and represent the information using properties.

                        Control0..1
                        BindingThe codes SHALL be taken from CodeSystemHierarchyMeaning
                        (required to http://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning|4.0.1)

                        The meaning of the hierarchy of concepts in a code system.

                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        122. CodeSystem.compositional
                        Definition

                        The code system defines a compositional (post-coordination) grammar.

                        ShortIf code system defines a compositional grammar
                        Comments

                        Note that the code system resource does not define what the compositional grammar is, only whether or not there is one.

                        Control0..1
                        Typeboolean
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Alternate Namesgrammar
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        124. CodeSystem.versionNeeded
                        Definition

                        This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system.

                        ShortIf definitions are not stable
                        Comments

                        Best practice is that code systems do not redefine concepts, or that if concepts are redefined, a new code system definition is created. But this is not always possible, so some code systems may be defined as 'versionNeeded'.

                        Most code systems occasionally refine the displays defined for concepts between versions. Contexts in which the concept display values are validated may require that the version be specified for some code systems irrespective of the value of this property.

                        Control0..1
                        Typeboolean
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        126. CodeSystem.content
                        Definition

                        The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.

                        Shortnot-present | example | fragment | complete | supplement
                        Control1..1
                        BindingThe codes SHALL be taken from CodeSystemContentMode
                        (required to http://hl7.org/fhir/ValueSet/codesystem-content-mode|4.0.1)

                        The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.

                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        128. CodeSystem.supplements
                        Definition

                        The canonical URL of the code system that this code system supplement is adding designations and properties to.

                        ShortCanonical URL of Code System this adds designations and properties to
                        Comments

                        The most common use of a code system supplement is to add additional language support.

                        Control0..1
                        Typecanonical(CodeSystem)
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        130. CodeSystem.count
                        Definition

                        The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward.

                        ShortTotal concepts in the code system
                        Comments

                        The count of concepts defined in this resource cannot be more than this value but may be less for several reasons - see the content element.

                        Control0..1
                        TypeunsignedInt
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        132. CodeSystem.filter
                        Definition

                        A filter that can be used in a value set compose statement when selecting concepts using a filter.

                        ShortFilter that can be used in a value set
                        Comments

                        Note that filters defined in code systems usually require custom code on the part of any terminology engine that will make them available for use in value set filters. For this reason, they are generally only seen in high value published terminologies.

                        Control0..*
                        TypeBackboneElement
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        134. CodeSystem.filter.id
                        Definition

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

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        136. CodeSystem.filter.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. 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 can 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
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        138. CodeSystem.filter.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        140. CodeSystem.filter.code
                        Definition

                        The code that identifies this filter when it is used as a filter in ValueSet.compose.include.filter.

                        ShortCode that identifies the filter
                        Control1..1
                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        142. CodeSystem.filter.description
                        Definition

                        A description of how or why the filter is used.

                        ShortHow or why the filter is used
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        144. CodeSystem.filter.operator
                        Definition

                        A list of operators that can be used with the filter.

                        Short= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
                        Control1..*
                        BindingThe codes SHALL be taken from FilterOperator
                        (required to http://hl7.org/fhir/ValueSet/filter-operator|4.0.1)

                        The kind of operation to perform as a part of a property based filter.

                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        146. CodeSystem.filter.value
                        Definition

                        A description of what the value for the filter should be.

                        ShortWhat to use for the value
                        Control1..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        148. CodeSystem.property
                        Definition

                        A property defines an additional slot through which additional information can be provided about a concept.

                        ShortAdditional information supplied about each concept
                        Control0..*
                        TypeBackboneElement
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        150. CodeSystem.property.id
                        Definition

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

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        152. CodeSystem.property.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. 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 can 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
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        154. CodeSystem.property.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        156. CodeSystem.property.code
                        Definition

                        A code that is used to identify the property. The code is used internally (in CodeSystem.concept.property.code) and also externally, such as in property filters.

                        ShortIdentifies the property on the concepts, and when referred to in operations
                        Control1..1
                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        158. CodeSystem.property.uri
                        Definition

                        Reference to the formal meaning of the property. One possible source of meaning is the Concept Properties code system.

                        ShortFormal identifier for the property
                        Control0..1
                        Typeuri
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        160. CodeSystem.property.description
                        Definition

                        A description of the property- why it is defined, and how its value might be used.

                        ShortWhy the property is defined, and/or what it conveys
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        162. CodeSystem.property.type
                        Definition

                        The type of the property value. Properties of type "code" contain a code defined by the code system (e.g. a reference to another defined concept).

                        Shortcode | Coding | string | integer | boolean | dateTime | decimal
                        Control1..1
                        BindingThe codes SHALL be taken from PropertyType
                        (required to http://hl7.org/fhir/ValueSet/concept-property-type|4.0.1)

                        The type of a property value.

                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        164. CodeSystem.concept
                        Definition

                        Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are.

                        ShortConcepts in the code system
                        Comments

                        If this is empty, it means that the code system resource does not represent the content of the code system.

                        Control0..*
                        TypeBackboneElement
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        166. CodeSystem.concept.id
                        Definition

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

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        168. CodeSystem.concept.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. 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 can 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
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        170. CodeSystem.concept.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        172. CodeSystem.concept.code
                        Definition

                        A code - a text symbol - that uniquely identifies the concept within the code system.

                        ShortCode that identifies concept
                        Control1..1
                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        174. CodeSystem.concept.display
                        Definition

                        A human readable string that is the recommended default way to present this concept to a user.

                        ShortText to display to the user
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        176. CodeSystem.concept.definition
                        Definition

                        The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.

                        ShortFormal definition
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        178. CodeSystem.concept.designation
                        Definition

                        Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.

                        ShortAdditional representations for the concept
                        Comments

                        Concepts have both a display and an array of designation. The display is equivalent to a special designation with an implied designation.use of "primary code" and a language equal to the Resource Language.

                        Control0..*
                        TypeBackboneElement
                        Is Modifierfalse
                        Summaryfalse
                        Requirements

                        Many concept definition systems support multiple representations, in multiple languages, and for multiple purposes.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        180. CodeSystem.concept.designation.id
                        Definition

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

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        182. CodeSystem.concept.designation.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. 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 can 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
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        184. CodeSystem.concept.designation.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        186. CodeSystem.concept.designation.language
                        Definition

                        The language this designation is defined for.

                        ShortHuman language of the designation
                        Comments

                        In the absence of a language, the resource language applies.

                        Control0..1
                        BindingThe codes SHOULD be taken from CommonLanguages
                        (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

                        A human language.

                        Additional BindingsPurpose
                        AllLanguagesMax Binding
                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        188. CodeSystem.concept.designation.use
                        Definition

                        A code that details how this designation would be used.

                        ShortDetails how this designation would be used
                        Comments

                        If no use is provided, the designation can be assumed to be suitable for general display to a human user.

                        Control0..1
                        BindingUnless not suitable, these codes SHALL be taken from DesignationUse
                        (extensible to http://hl7.org/fhir/ValueSet/designation-use|4.0.1)

                        Details of how a designation would be used.

                        TypeCoding
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        190. CodeSystem.concept.designation.value
                        Definition

                        The text value for this designation.

                        ShortThe text value for this designation
                        Control1..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        192. CodeSystem.concept.property
                        Definition

                        A property value for this concept.

                        ShortProperty value for the concept
                        Control0..*
                        TypeBackboneElement
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        194. CodeSystem.concept.property.id
                        Definition

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

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        196. CodeSystem.concept.property.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. 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 can 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
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        198. CodeSystem.concept.property.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        200. CodeSystem.concept.property.code
                        Definition

                        A code that is a reference to CodeSystem.property.code.

                        ShortReference to CodeSystem.property.code
                        Control1..1
                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        202. CodeSystem.concept.property.value[x]
                        Definition

                        The value of this property.

                        ShortValue of the property for this concept
                        Control1..1
                        TypeChoice of: code, Coding, string, integer, boolean, dateTime, decimal
                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        204. CodeSystem.concept.concept
                        Definition

                        Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) - see hierarchyMeaning.

                        ShortChild Concepts (is-a/contains/categorizes)
                        Control0..*
                        TypeSeettp://hl7.org/fhir/StructureDefinition/CodeSystem#CodeSystem.concept
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))