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

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

Resource Profile: Profile_R3_Substance_R4B - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-Substance resource profile.

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

0. Substance
Definition

A homogeneous material with a definite composition.

ShortA homogeneous material with a definite composition
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-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.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: 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())
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.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: 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. Substance.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
Must Supportfalse
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. Substance.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
Must Supportfalse
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())
6. Substance.status
Definition

A code to indicate if the substance is actively used.

Shortactive | inactive | entered-in-error
Control0..1
BindingThe codes SHALL be taken from FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|4.3.0
(required to http://hl7.org/fhir/ValueSet/substance-status|4.3.0)

A code to indicate if the substance is actively used.

Typecode
Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
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()))
8. Substance.status.extension
Definition

An Extension


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.

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.

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())
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 Substance.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 10. Substance.status.extension:status
    Slice Namestatus
    Definition

    STU3: Substance.status

    ShortSTU3: status
    Comments

    Element Substance.status is mapped to FHIR R4B element Substance.status as Equivalent. An externally-defined extension that has been mapped as the representation of FHIR STU3 element Substance.status: http://hl7.org/fhir/StructureDefinition/artifact-status.

    Control0..1
    TypeExtension(Artifact Status) (Extension Type: code)
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired CodeSystem without due consideration
    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())
    12. Substance.code
    Definition

    A code (or set of codes) that identify this substance.

    ShortWhat substance this is
    Comments

    This could be a reference to an externally defined code. It could also be a locally assigned code (e.g. a formulary), optionally with translations to the standard drug codes.

    Control1..1
    BindingFor example codes, see SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code|4.3.0
    (example to http://hl7.org/fhir/ValueSet/substance-code|4.3.0)

    Substance codes.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supportfalse
    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. Substance
    2. Substance.meta
    4. Substance.meta.extension
    Control0..*
    SlicingThis element introduces a set of slices on Substance.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 6. Substance.meta.extension:meta
      Slice Namemeta
      Definition

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

      ShortSTU3: meta additional types
      Comments

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

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

        STU3: Substance.text additional types (Narrative) additional types from child elements (div, status)

        ShortSTU3: text additional types
        Comments

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

        Control0..1
        TypeExtension(STU3: text additional types) (Complex Extension)
        14. Substance.identifier
        NoteThis is a business identifier, not a resource identifier (see discussion)
        16. Substance.identifier.extension
        Control0..*
        SlicingThis element introduces a set of slices on Substance.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 18. Substance.identifier.extension:identifier
          Slice Nameidentifier
          Definition

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

          ShortSTU3: identifier additional types
          Comments

          Element Substance.identifier is mapped to FHIR R4B element Substance.identifier as SourceIsBroaderThanTarget. The mappings for Substance.identifier do not cover the following types: Identifier. The mappings for Substance.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value. This identifier is associated with the kind of substance in contrast to the Substance.instance.identifier which is associated with the package/container.

          Control0..*
          TypeExtension(STU3: identifier additional types) (Extension Type: Identifier)
          20. Substance.status
          22. Substance.status.extension
          Control0..*
          SlicingThis element introduces a set of slices on Substance.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 24. Substance.status.extension:status
            Slice Namestatus
            Definition

            STU3: Substance.status

            ShortSTU3: status
            Comments

            Element Substance.status is mapped to FHIR R4B element Substance.status as Equivalent. An externally-defined extension that has been mapped as the representation of FHIR STU3 element Substance.status: http://hl7.org/fhir/StructureDefinition/artifact-status.

            Control0..1
            TypeExtension(Artifact Status) (Extension Type: code)
            26. Substance.instance
            28. Substance.instance.identifier
            NoteThis is a business identifier, not a resource identifier (see discussion)
            30. Substance.instance.identifier.extension
            Control0..*
            SlicingThis element introduces a set of slices on Substance.instance.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 32. Substance.instance.identifier.extension:identifier
              Slice Nameidentifier
              Definition

              STU3: Substance.instance.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

              ShortSTU3: identifier additional types
              Comments

              Element Substance.instance.identifier is mapped to FHIR R4B element Substance.instance.identifier as SourceIsBroaderThanTarget. The mappings for Substance.instance.identifier do not cover the following types: Identifier. The mappings for Substance.instance.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

              Control0..1
              TypeExtension(STU3: identifier additional types) (Extension Type: Identifier)
              34. Substance.ingredient
              36. Substance.ingredient.quantity
              38. Substance.ingredient.quantity.extension
              Control0..*
              SlicingThis element introduces a set of slices on Substance.ingredient.quantity.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 40. Substance.ingredient.quantity.extension:quantity
                Slice Namequantity
                Definition

                STU3: Substance.ingredient.quantity additional types (Ratio) additional types from child elements (denominator, numerator)

                ShortSTU3: quantity additional types
                Comments

                Element Substance.ingredient.quantity is mapped to FHIR R4B element Substance.ingredient.quantity as SourceIsBroaderThanTarget. The mappings for Substance.ingredient.quantity do not cover the following types: Ratio. The mappings for Substance.ingredient.quantity do not cover the following types based on type expansion: denominator, numerator.

                Control0..1
                TypeExtension(STU3: quantity additional types) (Extension Type: Ratio)
                42. Substance.ingredient.substanceReference
                44. Substance.ingredient.substanceReference.extension
                Control0..*
                SlicingThis element introduces a set of slices on Substance.ingredient.substanceReference.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 46. Substance.ingredient.substanceReference.extension:alternateReference
                  Slice NamealternateReference
                  Definition

                  STU3: Substance.ingredient.substance[x] additional types from child elements (display, identifier, reference)

                  ShortSTU3: substance additional types
                  Comments

                  Element Substance.ingredient.substance[x] is mapped to FHIR R4B element Substance.ingredient.substance[x] as SourceIsBroaderThanTarget. The mappings for Substance.ingredient.substance[x] do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element Substance.ingredient.substance[x] with unmapped reference targets: Substance. Source element Substance.ingredient.substance[x] has unmapped reference types. While the target element Substance.ingredient.substance[x] is a choice type and does not allow extensions, the alternate-reference extension can be applied to Reference values within it.

                  TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))

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

                  0. Substance
                  Definition

                  A homogeneous material with a definite composition.

                  ShortA homogeneous material with a definite composition
                  Control0..*
                  Is Modifierfalse
                  Must Supportfalse
                  Summaryfalse
                  Invariantsdom-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.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty())
                  dom-4: 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. Substance.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
                  Must Supportfalse
                  Summarytrue
                  4. Substance.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
                  Must Supportfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  6. Substance.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
                  Typeid
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  8. Substance.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 Substance.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 10. Substance.meta.extension:meta
                    Slice Namemeta
                    Definition

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

                    ShortSTU3: meta additional types
                    Comments

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

                    Control0..1
                    TypeExtension(STU3: meta 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())
                    12. Substance.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. Substance.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. Substance.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. Substance.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. Substance.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.3.0)
                    TypeCoding
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    22. Substance.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.3.0)
                    TypeCoding
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    24. Substance.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
                    Must Supportfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    26. Substance.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.3.0)

                    IETF language tag

                    Additional BindingsPurpose
                    AllLanguagesMax Binding
                    Typecode
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supportfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    28. Substance.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
                    Must Supportfalse
                    Summaryfalse
                    Alternate Namesnarrative, html, xhtml, display
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    30. Substance.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
                    Typeid
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    32. Substance.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 Substance.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 34. Substance.text.extension:text
                      Slice Nametext
                      Definition

                      STU3: Substance.text additional types (Narrative) additional types from child elements (div, status)

                      ShortSTU3: text additional types
                      Comments

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

                      Control0..1
                      TypeExtension(STU3: text 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. Substance.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.3.0)
                      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. Substance.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. Substance.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
                      Must Supportfalse
                      Summaryfalse
                      Alternate Namesinline resources, anonymous resources, contained resources
                      Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
                      42. Substance.extension
                      Definition

                      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.

                      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
                      Must Supportfalse
                      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())
                      44. Substance.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
                      Must Supportfalse
                      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())
                      46. Substance.identifier
                      Definition

                      Unique identifier for the substance.

                      ShortUnique identifier
                      Comments

                      This identifier is associated with the kind of substance in contrast to the Substance.instance.identifier which is associated with the package/container.

                      NoteThis is a business identifier, not a resource identifier (see discussion)
                      Control0..*
                      TypeIdentifier
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      48. Substance.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
                      Typeid
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      50. Substance.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 Substance.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 52. Substance.identifier.extension:identifier
                        Slice Nameidentifier
                        Definition

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

                        ShortSTU3: identifier additional types
                        Comments

                        Element Substance.identifier is mapped to FHIR R4B element Substance.identifier as SourceIsBroaderThanTarget. The mappings for Substance.identifier do not cover the following types: Identifier. The mappings for Substance.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value. This identifier is associated with the kind of substance in contrast to the Substance.instance.identifier which is associated with the package/container.

                        Control0..*
                        TypeExtension(STU3: identifier 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())
                        54. Substance.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.3.0)
                        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()))
                        56. Substance.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.3.0)
                        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()))
                        58. Substance.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()))
                        60. Substance.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()))
                        62. Substance.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()))
                        64. Substance.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()))
                        66. Substance.status
                        Definition

                        A code to indicate if the substance is actively used.

                        Shortactive | inactive | entered-in-error
                        Control0..1
                        BindingThe codes SHALL be taken from FHIRSubstanceStatus
                        (required to http://hl7.org/fhir/ValueSet/substance-status|4.3.0)

                        A code to indicate if the substance is actively used.

                        Typecode
                        Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        68. Substance.status.id
                        Definition

                        unique id for the element within a resource (for internal references)

                        Shortxml:id (or equivalent in JSON)
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        70. Substance.status.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 Substance.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 72. Substance.status.extension:status
                          Slice Namestatus
                          Definition

                          STU3: Substance.status

                          ShortSTU3: status
                          Comments

                          Element Substance.status is mapped to FHIR R4B element Substance.status as Equivalent. An externally-defined extension that has been mapped as the representation of FHIR STU3 element Substance.status: http://hl7.org/fhir/StructureDefinition/artifact-status.

                          Control0..1
                          TypeExtension(Artifact Status) (Extension Type: code)
                          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired CodeSystem without due consideration
                          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())
                          74. Substance.status.value
                          Definition

                          Primitive value for code

                          ShortPrimitive value for code
                          Control0..1
                          Typecode
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          76. Substance.category
                          Definition

                          A code that classifies the general type of substance. This is used for searching, sorting and display purposes.

                          ShortWhat class/type of substance this is
                          Comments

                          The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in Substance.code.

                          Control0..*
                          BindingUnless not suitable, these codes SHALL be taken from SubstanceCategoryCodes
                          (extensible to http://hl7.org/fhir/ValueSet/substance-category|4.3.0)

                          Category or classification of substance.

                          TypeCodeableConcept
                          Is Modifierfalse
                          Must Supportfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          78. Substance.code
                          Definition

                          A code (or set of codes) that identify this substance.

                          ShortWhat substance this is
                          Comments

                          This could be a reference to an externally defined code. It could also be a locally assigned code (e.g. a formulary), optionally with translations to the standard drug codes.

                          Control1..1
                          BindingFor example codes, see SubstanceCode
                          (example to http://hl7.org/fhir/ValueSet/substance-code|4.3.0)

                          Substance codes.

                          TypeCodeableConcept
                          Is Modifierfalse
                          Must Supportfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          80. Substance.description
                          Definition

                          A description of the substance - its appearance, handling requirements, and other usage notes.

                          ShortTextual description of the substance, comments
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supportfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          82. Substance.instance
                          Definition

                          Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.

                          ShortIf this describes a specific package/container of the substance
                          Control0..*
                          TypeBackboneElement
                          Is Modifierfalse
                          Must Supportfalse
                          Summarytrue
                          Meaning if MissingIf this element is not present, then the substance resource describes a kind of substance
                          Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                          84. Substance.instance.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
                          86. Substance.instance.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())
                          88. Substance.instance.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())
                          90. Substance.instance.identifier
                          Definition

                          Identifier associated with the package/container (usually a label affixed directly).

                          ShortIdentifier of the package/container
                          NoteThis is a business identifier, not a resource identifier (see discussion)
                          Control0..1
                          TypeIdentifier
                          Is Modifierfalse
                          Must Supportfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          92. Substance.instance.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
                          Typeid
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          94. Substance.instance.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 Substance.instance.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 96. Substance.instance.identifier.extension:identifier
                            Slice Nameidentifier
                            Definition

                            STU3: Substance.instance.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

                            ShortSTU3: identifier additional types
                            Comments

                            Element Substance.instance.identifier is mapped to FHIR R4B element Substance.instance.identifier as SourceIsBroaderThanTarget. The mappings for Substance.instance.identifier do not cover the following types: Identifier. The mappings for Substance.instance.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

                            Control0..1
                            TypeExtension(STU3: identifier 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())
                            98. Substance.instance.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.3.0)
                            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()))
                            100. Substance.instance.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.3.0)
                            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()))
                            102. Substance.instance.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()))
                            104. Substance.instance.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()))
                            106. Substance.instance.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()))
                            108. Substance.instance.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()))
                            110. Substance.instance.expiry
                            Definition

                            When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.

                            ShortWhen no longer valid to use
                            Control0..1
                            TypedateTime
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            112. Substance.instance.quantity
                            Definition

                            The amount of the substance.

                            ShortAmount of substance in the package
                            Control0..1
                            TypeQuantity(SimpleQuantity)
                            Is Modifierfalse
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            114. Substance.ingredient
                            Definition

                            A substance can be composed of other substances.

                            ShortComposition information about the substance
                            Control0..*
                            TypeBackboneElement
                            Is Modifierfalse
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                            116. Substance.ingredient.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
                            118. Substance.ingredient.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())
                            120. Substance.ingredient.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())
                            122. Substance.ingredient.quantity
                            Definition

                            The amount of the ingredient in the substance - a concentration ratio.

                            ShortOptional amount (concentration)
                            Control0..1
                            TypeRatio
                            Is Modifierfalse
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            124. Substance.ingredient.quantity.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
                            Typeid
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            126. Substance.ingredient.quantity.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 Substance.ingredient.quantity.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 128. Substance.ingredient.quantity.extension:quantity
                              Slice Namequantity
                              Definition

                              STU3: Substance.ingredient.quantity additional types (Ratio) additional types from child elements (denominator, numerator)

                              ShortSTU3: quantity additional types
                              Comments

                              Element Substance.ingredient.quantity is mapped to FHIR R4B element Substance.ingredient.quantity as SourceIsBroaderThanTarget. The mappings for Substance.ingredient.quantity do not cover the following types: Ratio. The mappings for Substance.ingredient.quantity do not cover the following types based on type expansion: denominator, numerator.

                              Control0..1
                              TypeExtension(STU3: quantity additional types) (Extension Type: Ratio)
                              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())
                              130. Substance.ingredient.quantity.numerator
                              Definition

                              The value of the numerator.

                              ShortNumerator value
                              Control0..1
                              TypeQuantity
                              Is Modifierfalse
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              132. Substance.ingredient.quantity.denominator
                              Definition

                              The value of the denominator.

                              ShortDenominator value
                              Control0..1
                              TypeQuantity
                              Is Modifierfalse
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              134. Substance.ingredient.substance[x]
                              Definition

                              Another substance that is a component of this substance.

                              ShortA component of the substance
                              Control1..1
                              BindingFor example codes, see SubstanceCode
                              (example to http://hl7.org/fhir/ValueSet/substance-code|4.3.0)

                              Substance Ingredient codes.

                              TypeChoice of: CodeableConcept, Reference(Substance)
                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                              Is Modifierfalse
                              Must Supportfalse
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              136. Substance.ingredient.substance[x].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
                              Typeid
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              138. Substance.ingredient.substance[x].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 Substance.ingredient.substance[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 140. Substance.ingredient.substance[x].extension:alternateReference
                                Slice NamealternateReference
                                Definition

                                STU3: Substance.ingredient.substance[x] additional types from child elements (display, identifier, reference)

                                ShortSTU3: substance additional types
                                Comments

                                Element Substance.ingredient.substance[x] is mapped to FHIR R4B element Substance.ingredient.substance[x] as SourceIsBroaderThanTarget. The mappings for Substance.ingredient.substance[x] do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element Substance.ingredient.substance[x] with unmapped reference targets: Substance. Source element Substance.ingredient.substance[x] has unmapped reference types. While the target element Substance.ingredient.substance[x] is a choice type and does not allow extensions, the alternate-reference extension can be applied to Reference values within it.

                                Control0..1
                                TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                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())