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

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

Resource Profile: Profile_R2_ImmunizationRecommendation_R4 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-ImmunizationRecommendation resource profile.

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

0. ImmunizationRecommendation
Definition

A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.

ShortGuidance or advice relating to an immunization
Control0..*
Is Modifierfalse
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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. ImmunizationRecommendation.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

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

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

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

ShortExtensions that cannot be ignored
Comments

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

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

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

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

The patient the recommendation(s) are for.

ShortWho this profile is for
Control1..1
TypeReference(Patient)
Is Modifierfalse
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. ImmunizationRecommendation.patient.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 ImmunizationRecommendation.patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 10. ImmunizationRecommendation.patient.extension:patient
    Slice Namepatient
    Definition

    DSTU2: ImmunizationRecommendation.patient additional types from child elements (display, reference)

    ShortDSTU2: patient additional types
    Comments

    Element ImmunizationRecommendation.patient is mapped to FHIR R4 element ImmunizationRecommendation.patient as SourceIsBroaderThanTarget. The mappings for ImmunizationRecommendation.patient do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element ImmunizationRecommendation.patient with unmapped reference targets: Patient.

    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())
    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. ImmunizationRecommendation.date
    Definition

    The date the immunization recommendation(s) were created.

    ShortDate recommendation(s) created
    Control1..1
    TypedateTime
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. ImmunizationRecommendation.recommendation
    Definition

    Vaccine administration recommendations.

    ShortVaccine administration recommendations
    Control1..*
    TypeBackboneElement
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    imr-1: One of vaccineCode or targetDisease SHALL be present (vaccineCode.exists() or targetDisease.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    imr-1: One of vaccineCode or targetDisease SHALL be present (vaccineCode.exists() or targetDisease.exists())
    16. ImmunizationRecommendation.recommendation.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 ImmunizationRecommendation.recommendation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 18. ImmunizationRecommendation.recommendation.extension:doseSequence
      Slice NamedoseSequence
      Definition

      DSTU2: ImmunizationRecommendation.recommendation.protocol.doseSequence (new:integer)

      ShortDSTU2: Dose number within sequence (new)
      Comments

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

      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(DSTU2: Dose number within sequence (new)) (Extension Type: integer)
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      20. ImmunizationRecommendation.recommendation.extension:authority
      Slice Nameauthority
      Definition

      DSTU2: ImmunizationRecommendation.recommendation.protocol.authority (new:Reference(Organization))

      ShortDSTU2: Who is responsible for protocol (new)
      Comments

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

      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(DSTU2: Who is responsible for protocol (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Organization for use in FHIR R4, Organization))
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      22. ImmunizationRecommendation.recommendation.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())
      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())
      24. ImmunizationRecommendation.recommendation.forecastStatus
      Definition

      Indicates the patient status with respect to the path to immunity for the target disease.

      ShortVaccine recommendation status
      Control1..1
      BindingFor example codes, see ImmunizationRecommendationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-status|4.0.1
      (example to http://hl7.org/fhir/ValueSet/immunization-recommendation-status|4.0.1)

      The patient's status with respect to a vaccination protocol.

      TypeCodeableConcept
      Is Modifiertrue because This element is labeled as a modifier because the forecastStatus indicates whether a patient needs additional doses (due, overdue, etc) or not (contraindicated, complete, etc).
      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. ImmunizationRecommendation
      2. ImmunizationRecommendation.meta
      4. ImmunizationRecommendation.meta.extension
      Control0..*
      SlicingThis element introduces a set of slices on ImmunizationRecommendation.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 6. ImmunizationRecommendation.meta.extension:meta
        Slice Namemeta
        Definition

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

        ShortDSTU2: meta additional types
        Comments

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

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

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

          ShortDSTU2: text additional types
          Comments

          Element ImmunizationRecommendation.text is mapped to FHIR R4 element ImmunizationRecommendation.text as SourceIsBroaderThanTarget. The mappings for ImmunizationRecommendation.text do not cover the following types: Narrative. The mappings for ImmunizationRecommendation.text do not cover the following types based on type expansion: div, status. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

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

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

            ShortDSTU2: identifier additional types
            Comments

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

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

              DSTU2: ImmunizationRecommendation.patient additional types from child elements (display, reference)

              ShortDSTU2: patient additional types
              Comments

              Element ImmunizationRecommendation.patient is mapped to FHIR R4 element ImmunizationRecommendation.patient as SourceIsBroaderThanTarget. The mappings for ImmunizationRecommendation.patient do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element ImmunizationRecommendation.patient with unmapped reference targets: Patient.

              Control0..1
              TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
              26. ImmunizationRecommendation.recommendation
              28. ImmunizationRecommendation.recommendation.extension
              Control0..*
              SlicingThis element introduces a set of slices on ImmunizationRecommendation.recommendation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 30. ImmunizationRecommendation.recommendation.extension:doseSequence
                Slice NamedoseSequence
                Definition

                DSTU2: ImmunizationRecommendation.recommendation.protocol.doseSequence (new:integer)

                ShortDSTU2: Dose number within sequence (new)
                Comments

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

                Control0..1
                TypeExtension(DSTU2: Dose number within sequence (new)) (Extension Type: integer)
                32. ImmunizationRecommendation.recommendation.extension:authority
                Slice Nameauthority
                Definition

                DSTU2: ImmunizationRecommendation.recommendation.protocol.authority (new:Reference(Organization))

                ShortDSTU2: Who is responsible for protocol (new)
                Comments

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

                Control0..1
                TypeExtension(DSTU2: Who is responsible for protocol (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Organization for use in FHIR R4, Organization))
                34. ImmunizationRecommendation.recommendation.supportingImmunization
                36. ImmunizationRecommendation.recommendation.supportingImmunization.extension
                Control0..*
                SlicingThis element introduces a set of slices on ImmunizationRecommendation.recommendation.supportingImmunization.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 38. ImmunizationRecommendation.recommendation.supportingImmunization.extension:supportingImmunization
                  Slice NamesupportingImmunization
                  Definition

                  DSTU2: ImmunizationRecommendation.recommendation.supportingImmunization additional types from child elements (display, reference)

                  ShortDSTU2: supportingImmunization additional types
                  Comments

                  Element ImmunizationRecommendation.recommendation.supportingImmunization is mapped to FHIR R4 element ImmunizationRecommendation.recommendation.supportingImmunization as SourceIsBroaderThanTarget. The mappings for ImmunizationRecommendation.recommendation.supportingImmunization do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element ImmunizationRecommendation.recommendation.supportingImmunization with unmapped reference targets: Immunization.

                  Control0..*
                  TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                  40. ImmunizationRecommendation.recommendation.supportingPatientInformation
                  42. ImmunizationRecommendation.recommendation.supportingPatientInformation.extension
                  Control0..*
                  SlicingThis element introduces a set of slices on ImmunizationRecommendation.recommendation.supportingPatientInformation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 44. ImmunizationRecommendation.recommendation.supportingPatientInformation.extension:supportingPatientInformation
                    Slice NamesupportingPatientInformation
                    Definition

                    DSTU2: ImmunizationRecommendation.recommendation.supportingPatientInformation additional types from child elements (display, reference)

                    ShortDSTU2: supportingPatientInformation additional types
                    Comments

                    Element ImmunizationRecommendation.recommendation.supportingPatientInformation is mapped to FHIR R4 element ImmunizationRecommendation.recommendation.supportingPatientInformation as SourceIsBroaderThanTarget. The mappings for ImmunizationRecommendation.recommendation.supportingPatientInformation do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element ImmunizationRecommendation.recommendation.supportingPatientInformation with unmapped reference targets: AllergyIntolerance, Observation.

                    Control0..*
                    TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))

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

                    0. ImmunizationRecommendation
                    Definition

                    A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.

                    ShortGuidance or advice relating to an immunization
                    Control0..*
                    Is Modifierfalse
                    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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
                    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
                    dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                    dom-6: A resource should have narrative for robust management (text.`div`.exists())
                    2. ImmunizationRecommendation.id
                    Definition

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

                    ShortLogical id of this artifact
                    Comments

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

                    Control0..1
                    Typeid
                    Is Modifierfalse
                    Summarytrue
                    4. ImmunizationRecommendation.meta
                    Definition

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

                    ShortMetadata about the resource
                    Control0..1
                    TypeMeta
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    6. ImmunizationRecommendation.meta.id
                    Definition

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

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    8. ImmunizationRecommendation.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 ImmunizationRecommendation.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 10. ImmunizationRecommendation.meta.extension:meta
                      Slice Namemeta
                      Definition

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

                      ShortDSTU2: meta additional types
                      Comments

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

                      Control0..1
                      TypeExtension(DSTU2: meta additional types) (Extension Type: Meta)
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      12. ImmunizationRecommendation.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. ImmunizationRecommendation.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. ImmunizationRecommendation.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. ImmunizationRecommendation.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. ImmunizationRecommendation.meta.security
                      Definition

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

                      ShortSecurity Labels applied to this resource
                      Comments

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

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

                      Security Labels from the Healthcare Privacy and Security Classification System.

                      TypeCoding
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      22. ImmunizationRecommendation.meta.tag
                      Definition

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

                      ShortTags applied to this resource
                      Comments

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

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

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

                      TypeCoding
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      24. ImmunizationRecommendation.implicitRules
                      Definition

                      A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                      ShortA set of rules under which this content was created
                      Comments

                      Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

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

                      The base language in which the resource is written.

                      ShortLanguage of the resource content
                      Comments

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

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

                      A human language.

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

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

                      ShortText summary of the resource, for human interpretation
                      Comments

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

                      Control0..1
                      TypeNarrative
                      Is Modifierfalse
                      Summaryfalse
                      Alternate Namesnarrative, html, xhtml, display
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      30. ImmunizationRecommendation.text.id
                      Definition

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

                      ShortUnique id for inter-element referencing
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      32. ImmunizationRecommendation.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 ImmunizationRecommendation.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 34. ImmunizationRecommendation.text.extension:text
                        Slice Nametext
                        Definition

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

                        ShortDSTU2: text additional types
                        Comments

                        Element ImmunizationRecommendation.text is mapped to FHIR R4 element ImmunizationRecommendation.text as SourceIsBroaderThanTarget. The mappings for ImmunizationRecommendation.text do not cover the following types: Narrative. The mappings for ImmunizationRecommendation.text do not cover the following types based on type expansion: div, status. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

                        Control0..1
                        TypeExtension(DSTU2: text 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. ImmunizationRecommendation.text.status
                        Definition

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

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

                        The status of a resource narrative.

                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        38. ImmunizationRecommendation.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. ImmunizationRecommendation.contained
                        Definition

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

                        ShortContained, inline Resources
                        Comments

                        This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

                        Control0..*
                        TypeResource
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesinline resources, anonymous resources, contained resources
                        42. ImmunizationRecommendation.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
                        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. ImmunizationRecommendation.modifierExtension
                        Definition

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

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

                        ShortExtensions that cannot be ignored
                        Comments

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

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                        Summaryfalse
                        Requirements

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

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

                        A unique identifier assigned to this particular recommendation record.

                        ShortBusiness identifier
                        NoteThis is a business identifier, not a resource identifier (see discussion)
                        Control0..*
                        TypeIdentifier
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        48. ImmunizationRecommendation.identifier.id
                        Definition

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

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        50. ImmunizationRecommendation.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 ImmunizationRecommendation.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 52. ImmunizationRecommendation.identifier.extension:identifier
                          Slice Nameidentifier
                          Definition

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

                          ShortDSTU2: identifier additional types
                          Comments

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

                          Control0..*
                          TypeExtension(DSTU2: 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. ImmunizationRecommendation.identifier.use
                          Definition

                          The purpose of this identifier.

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

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

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

                          Identifies the purpose for this identifier, if known .

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

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

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

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

                          ShortDescription of identifier
                          Comments

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

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

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

                          TypeCodeableConcept
                          Is Modifierfalse
                          Summarytrue
                          Requirements

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

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          58. ImmunizationRecommendation.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. ImmunizationRecommendation.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. ImmunizationRecommendation.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. ImmunizationRecommendation.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. ImmunizationRecommendation.patient
                          Definition

                          The patient the recommendation(s) are for.

                          ShortWho this profile is for
                          Control1..1
                          TypeReference(Patient)
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          68. ImmunizationRecommendation.patient.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
                          70. ImmunizationRecommendation.patient.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 ImmunizationRecommendation.patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 72. ImmunizationRecommendation.patient.extension:patient
                            Slice Namepatient
                            Definition

                            DSTU2: ImmunizationRecommendation.patient additional types from child elements (display, reference)

                            ShortDSTU2: patient additional types
                            Comments

                            Element ImmunizationRecommendation.patient is mapped to FHIR R4 element ImmunizationRecommendation.patient as SourceIsBroaderThanTarget. The mappings for ImmunizationRecommendation.patient do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element ImmunizationRecommendation.patient with unmapped reference targets: Patient.

                            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())
                            74. ImmunizationRecommendation.patient.reference
                            Definition

                            A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                            ShortLiteral reference, Relative, internal or absolute URL
                            Comments

                            Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                            Control0..1
                            This element is affected by the following invariants: ref-1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            76. ImmunizationRecommendation.patient.type
                            Definition

                            The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                            The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                            ShortType the reference refers to (e.g. "Patient")
                            Comments

                            This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

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

                            Aa resource (or, for logical models, the URI of the logical model).

                            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()))
                            78. ImmunizationRecommendation.patient.identifier
                            Definition

                            An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                            ShortLogical reference, when literal reference is not known
                            Comments

                            When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                            When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                            Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                            Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                            NoteThis is a business identifier, not a resource identifier (see discussion)
                            Control0..1
                            TypeIdentifier
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            80. ImmunizationRecommendation.patient.display
                            Definition

                            Plain text narrative that identifies the resource in addition to the resource reference.

                            ShortText alternative for the resource
                            Comments

                            This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

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

                            The date the immunization recommendation(s) were created.

                            ShortDate recommendation(s) created
                            Control1..1
                            TypedateTime
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            84. ImmunizationRecommendation.authority
                            Definition

                            Indicates the authority who published the protocol (e.g. ACIP).

                            ShortWho is responsible for protocol
                            Control0..1
                            TypeReference(Organization)
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            86. ImmunizationRecommendation.recommendation
                            Definition

                            Vaccine administration recommendations.

                            ShortVaccine administration recommendations
                            Control1..*
                            TypeBackboneElement
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            imr-1: One of vaccineCode or targetDisease SHALL be present (vaccineCode.exists() or targetDisease.exists())
                            88. ImmunizationRecommendation.recommendation.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
                            90. ImmunizationRecommendation.recommendation.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 ImmunizationRecommendation.recommendation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 92. ImmunizationRecommendation.recommendation.extension:doseSequence
                              Slice NamedoseSequence
                              Definition

                              DSTU2: ImmunizationRecommendation.recommendation.protocol.doseSequence (new:integer)

                              ShortDSTU2: Dose number within sequence (new)
                              Comments

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

                              Control0..1
                              This element is affected by the following invariants: ele-1
                              TypeExtension(DSTU2: Dose number within sequence (new)) (Extension Type: integer)
                              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())
                              94. ImmunizationRecommendation.recommendation.extension:authority
                              Slice Nameauthority
                              Definition

                              DSTU2: ImmunizationRecommendation.recommendation.protocol.authority (new:Reference(Organization))

                              ShortDSTU2: Who is responsible for protocol (new)
                              Comments

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

                              Control0..1
                              This element is affected by the following invariants: ele-1
                              TypeExtension(DSTU2: Who is responsible for protocol (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Organization for use in FHIR R4, Organization))
                              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())
                              96. ImmunizationRecommendation.recommendation.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())
                              98. ImmunizationRecommendation.recommendation.vaccineCode
                              Definition

                              Vaccine(s) or vaccine group that pertain to the recommendation.

                              ShortVaccine or vaccine group recommendation applies to
                              Control0..*
                              BindingFor example codes, see VaccineAdministeredValueSet
                              (example to http://hl7.org/fhir/ValueSet/vaccine-code|4.0.1)

                              The type of vaccine administered.

                              TypeCodeableConcept
                              Is Modifierfalse
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              100. ImmunizationRecommendation.recommendation.targetDisease
                              Definition

                              The targeted disease for the recommendation.

                              ShortDisease to be immunized against
                              Control0..1
                              BindingFor example codes, see ImmunizationRecommendationTargetDiseaseCodes
                              (example to http://hl7.org/fhir/ValueSet/immunization-recommendation-target-disease|4.0.1)

                              The disease that the recommended vaccination targets.

                              TypeCodeableConcept
                              Is Modifierfalse
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              102. ImmunizationRecommendation.recommendation.contraindicatedVaccineCode
                              Definition

                              Vaccine(s) which should not be used to fulfill the recommendation.

                              ShortVaccine which is contraindicated to fulfill the recommendation
                              Control0..*
                              BindingFor example codes, see VaccineAdministeredValueSet
                              (example to http://hl7.org/fhir/ValueSet/vaccine-code|4.0.1)

                              The type of vaccine administered.

                              TypeCodeableConcept
                              Is Modifierfalse
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              104. ImmunizationRecommendation.recommendation.forecastStatus
                              Definition

                              Indicates the patient status with respect to the path to immunity for the target disease.

                              ShortVaccine recommendation status
                              Control1..1
                              BindingFor example codes, see ImmunizationRecommendationStatusCodes
                              (example to http://hl7.org/fhir/ValueSet/immunization-recommendation-status|4.0.1)

                              The patient's status with respect to a vaccination protocol.

                              TypeCodeableConcept
                              Is Modifiertrue because This element is labeled as a modifier because the forecastStatus indicates whether a patient needs additional doses (due, overdue, etc) or not (contraindicated, complete, etc).
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              106. ImmunizationRecommendation.recommendation.forecastReason
                              Definition

                              The reason for the assigned forecast status.

                              ShortVaccine administration status reason
                              Control0..*
                              BindingFor example codes, see ImmunizationRecommendationReasonCodes
                              (example to http://hl7.org/fhir/ValueSet/immunization-recommendation-reason|4.0.1)

                              The reason for the patient's status with respect to a vaccination protocol.

                              TypeCodeableConcept
                              Is Modifierfalse
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              108. ImmunizationRecommendation.recommendation.dateCriterion
                              Definition

                              Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.

                              ShortDates governing proposed immunization
                              Control0..*
                              TypeBackboneElement
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              110. ImmunizationRecommendation.recommendation.dateCriterion.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
                              112. ImmunizationRecommendation.recommendation.dateCriterion.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())
                              114. ImmunizationRecommendation.recommendation.dateCriterion.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())
                              116. ImmunizationRecommendation.recommendation.dateCriterion.code
                              Definition

                              Date classification of recommendation. For example, earliest date to give, latest date to give, etc.

                              ShortType of date
                              Control1..1
                              BindingFor example codes, see ImmunizationRecommendationDateCriterionCodes
                              (example to http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion|4.0.1)

                              Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).

                              TypeCodeableConcept
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              118. ImmunizationRecommendation.recommendation.dateCriterion.value
                              Definition

                              The date whose meaning is specified by dateCriterion.code.

                              ShortRecommended date
                              Control1..1
                              TypedateTime
                              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()))
                              120. ImmunizationRecommendation.recommendation.description
                              Definition

                              Contains the description about the protocol under which the vaccine was administered.

                              ShortProtocol details
                              Control0..1
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              122. ImmunizationRecommendation.recommendation.series
                              Definition

                              One possible path to achieve presumed immunity against a disease - within the context of an authority.

                              ShortName of vaccination series
                              Control0..1
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              124. ImmunizationRecommendation.recommendation.doseNumber[x]
                              Definition

                              Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose).

                              ShortRecommended dose number within series
                              Comments

                              The use of an integer is prefered if known. A string should only be used in cases where an interger is not available (such as when documenting a recurring booster dose).

                              Control0..1
                              TypeChoice of: positiveInt, string
                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              126. ImmunizationRecommendation.recommendation.seriesDoses[x]
                              Definition

                              The recommended number of doses to achieve immunity.

                              ShortRecommended number of doses for immunity
                              Comments

                              The use of an integer is prefered if known. A string should only be used in cases where an interger is not available (such as when documenting a recurring booster dose).

                              Control0..1
                              TypeChoice of: positiveInt, string
                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              128. ImmunizationRecommendation.recommendation.supportingImmunization
                              Definition

                              Immunization event history and/or evaluation that supports the status and recommendation.

                              ShortPast immunizations supporting recommendation
                              Control0..*
                              TypeReference(Immunization, ImmunizationEvaluation)
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              130. ImmunizationRecommendation.recommendation.supportingImmunization.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
                              132. ImmunizationRecommendation.recommendation.supportingImmunization.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 ImmunizationRecommendation.recommendation.supportingImmunization.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 134. ImmunizationRecommendation.recommendation.supportingImmunization.extension:supportingImmunization
                                Slice NamesupportingImmunization
                                Definition

                                DSTU2: ImmunizationRecommendation.recommendation.supportingImmunization additional types from child elements (display, reference)

                                ShortDSTU2: supportingImmunization additional types
                                Comments

                                Element ImmunizationRecommendation.recommendation.supportingImmunization is mapped to FHIR R4 element ImmunizationRecommendation.recommendation.supportingImmunization as SourceIsBroaderThanTarget. The mappings for ImmunizationRecommendation.recommendation.supportingImmunization do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element ImmunizationRecommendation.recommendation.supportingImmunization with unmapped reference targets: Immunization.

                                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())
                                136. ImmunizationRecommendation.recommendation.supportingImmunization.reference
                                Definition

                                A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                ShortLiteral reference, Relative, internal or absolute URL
                                Comments

                                Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                Control0..1
                                This element is affected by the following invariants: ref-1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                138. ImmunizationRecommendation.recommendation.supportingImmunization.type
                                Definition

                                The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                ShortType the reference refers to (e.g. "Patient")
                                Comments

                                This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

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

                                Aa resource (or, for logical models, the URI of the logical model).

                                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()))
                                140. ImmunizationRecommendation.recommendation.supportingImmunization.identifier
                                Definition

                                An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                ShortLogical reference, when literal reference is not known
                                Comments

                                When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                Control0..1
                                TypeIdentifier
                                Is Modifierfalse
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                142. ImmunizationRecommendation.recommendation.supportingImmunization.display
                                Definition

                                Plain text narrative that identifies the resource in addition to the resource reference.

                                ShortText alternative for the resource
                                Comments

                                This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

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

                                Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.

                                ShortPatient observations supporting recommendation
                                Control0..*
                                TypeReference(Resource)
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                146. ImmunizationRecommendation.recommendation.supportingPatientInformation.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
                                148. ImmunizationRecommendation.recommendation.supportingPatientInformation.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 ImmunizationRecommendation.recommendation.supportingPatientInformation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 150. ImmunizationRecommendation.recommendation.supportingPatientInformation.extension:supportingPatientInformation
                                  Slice NamesupportingPatientInformation
                                  Definition

                                  DSTU2: ImmunizationRecommendation.recommendation.supportingPatientInformation additional types from child elements (display, reference)

                                  ShortDSTU2: supportingPatientInformation additional types
                                  Comments

                                  Element ImmunizationRecommendation.recommendation.supportingPatientInformation is mapped to FHIR R4 element ImmunizationRecommendation.recommendation.supportingPatientInformation as SourceIsBroaderThanTarget. The mappings for ImmunizationRecommendation.recommendation.supportingPatientInformation do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element ImmunizationRecommendation.recommendation.supportingPatientInformation with unmapped reference targets: AllergyIntolerance, Observation.

                                  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())
                                  152. ImmunizationRecommendation.recommendation.supportingPatientInformation.reference
                                  Definition

                                  A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                  ShortLiteral reference, Relative, internal or absolute URL
                                  Comments

                                  Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                  Control0..1
                                  This element is affected by the following invariants: ref-1
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  154. ImmunizationRecommendation.recommendation.supportingPatientInformation.type
                                  Definition

                                  The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                  The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                  ShortType the reference refers to (e.g. "Patient")
                                  Comments

                                  This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

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

                                  Aa resource (or, for logical models, the URI of the logical model).

                                  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()))
                                  156. ImmunizationRecommendation.recommendation.supportingPatientInformation.identifier
                                  Definition

                                  An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                  ShortLogical reference, when literal reference is not known
                                  Comments

                                  When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                  When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                  Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                  Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                  Control0..1
                                  TypeIdentifier
                                  Is Modifierfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  158. ImmunizationRecommendation.recommendation.supportingPatientInformation.display
                                  Definition

                                  Plain text narrative that identifies the resource in addition to the resource reference.

                                  ShortText alternative for the resource
                                  Comments

                                  This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

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