Consolidated CDA (C-CDA)
3.0.0 - STU United States of America flag

Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 3.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions

Logical Model: PlannedImmunizationActivity - Detailed Descriptions

Draft as of 2024-05-07

Definitions for the PlannedImmunizationActivity logical model.

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

0. SubstanceAdministration
Logical ContainerClinicalDocument (CDA Class)
ValidationInstances of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
2. SubstanceAdministration.templateId
Control1..?
SlicingThis element introduces a set of slices on SubstanceAdministration.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • 4. SubstanceAdministration.templateId:planned-immunization-activity
    Slice Nameplanned-immunization-activity
    Control1..1
    6. SubstanceAdministration.templateId:planned-immunization-activity.root
    Control1..?
    Pattern Value2.16.840.1.113883.10.20.22.4.120
    8. SubstanceAdministration.templateId:planned-immunization-activity.extension
    Control0..0
    10. SubstanceAdministration.classCode
    Comments

    SHALL contain exactly one [1..1] @classCode="SBADM" (CONF:1098-32091).

    12. SubstanceAdministration.moodCode
    Comments

    SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (SubstanceAdministration/Supply) urn:oid:2.16.840.1.113883.11.20.9.24 STATIC 2014-09-01 (CONF:1098-32097).

    BindingThe codes SHALL be taken from Planned moodCode (SubstanceAdministration/Supply) .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24)
    14. SubstanceAdministration.id
    Comments

    SHALL contain at least one [1..*] id (CONF:1098-32100).

    Control1..?
    16. SubstanceAdministration.text
    ShortSHOULD reference the portion of section narrative text corresponding to this entry
    18. SubstanceAdministration.text.reference
    Invariantsvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (value.exists() implies value.startsWith('#'))
    20. SubstanceAdministration.statusCode
    Comments

    SHALL contain exactly one [1..1] statusCode (CONF:1098-32101).

    Control1..?
    22. SubstanceAdministration.statusCode.code
    Comments

    This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-32102).

    Control1..?
    Fixed Valueactive
    24. SubstanceAdministration.effectiveTime
    ShortThe effectiveTime in a planned immunization activity represents the time that the immunization activity should occur.
    Comments

    SHALL contain exactly one [1..1] effectiveTime (CONF:1098-32103).

    Control1..1
    26. SubstanceAdministration.repeatNumber
    ShortIn a Planned Immunization Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.
    Comments

    MAY contain zero or one [0..1] repeatNumber (CONF:1098-32126).

    28. SubstanceAdministration.routeCode
    Comments

    MAY contain zero or one [0..1] routeCode, which SHALL be selected from ValueSet SPL Drug Route of Administration Terminology urn:oid:2.16.840.1.113883.3.88.12.3221.8.7 DYNAMIC (CONF:1098-32127).

    BindingThe codes SHALL be taken from SPL Drug Route of Administration Terminology .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.7)
    Invariantsshould-translation: SHOULD contain translation (translation.exists())
    30. SubstanceAdministration.routeCode.translation
    Comments

    The routeCode, if present, SHOULD contain zero or more [0..*] translation, which SHOULD be selected from ValueSet Medication Route urn:oid:2.16.840.1.113762.1.4.1099.12 DYNAMIC (CONF:1098-32951).

    BindingThe codes SHOULD be taken from Medication Route .
    (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.12)
    32. SubstanceAdministration.approachSiteCode
    Comments

    MAY contain zero or more [0..*] approachSiteCode, which SHALL be selected from ValueSet Body Site Value Set urn:oid:2.16.840.1.113883.3.88.12.3221.8.9 DYNAMIC (CONF:1098-32128).

    BindingThe codes SHALL be taken from Body Site Value Set .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.9)
    34. SubstanceAdministration.doseQuantity
    Comments

    MAY contain zero or one [0..1] doseQuantity (CONF:1098-32129).

    Invariantsshould-unit: SHOULD contain @unit (nullFlavor.exists() or unit.exists())
    36. SubstanceAdministration.doseQuantity.unit
    ShortNOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
    Comments

    The doseQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHOULD be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32130).

    BindingThe codes SHOULD be taken from UnitsOfMeasureCaseSensitive .
    (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12839)
    38. SubstanceAdministration.consumable
    Comments

    SHALL contain exactly one [1..1] consumable (CONF:1098-32131).

    40. SubstanceAdministration.consumable.manufacturedProduct
    Comments

    This consumable SHALL contain exactly one [1..1] Immunization Medication Information (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.54:2014-06-09) (CONF:1098-32132).

    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Immunization Medication Information)
    42. SubstanceAdministration.performer
    ShortThe clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer.
    Comments

    MAY contain zero or more [0..*] performer (CONF:1098-32104).

    44. SubstanceAdministration.author
    ShortThe author in a planned immunization activity represents the clinician who is requesting or planning the immunization activity.
    Comments

    MAY contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32105).

    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
    46. SubstanceAdministration.entryRelationship
    ShortThe following entryRelationship captures any instructions associated with the planned immunization activity.
    SlicingThis element introduces a set of slices on SubstanceAdministration.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
    • profile @ observation
    • profile @ act
    • 48. SubstanceAdministration.entryRelationship:priorityPreference
      Slice NamepriorityPreference
      ShortThe following entryRelationship represents the priority that a patient or a provider places on the immunization activity.
      Comments

      MAY contain zero or more [0..*] entryRelationship (CONF:1098-32108) such that it

      Control0..*
      50. SubstanceAdministration.entryRelationship:priorityPreference.typeCode
      Comments

      SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32109).

      Fixed ValueREFR
      52. SubstanceAdministration.entryRelationship:priorityPreference.observation
      Comments

      SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-32110).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference)
      54. SubstanceAdministration.entryRelationship:indication
      Slice Nameindication
      ShortThe following entryRelationship represents the indication for the immunization activity.
      Comments

      MAY contain zero or more [0..*] entryRelationship (CONF:1098-32114) such that it

      Control0..*
      56. SubstanceAdministration.entryRelationship:indication.typeCode
      Comments

      SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32115).

      Fixed ValueRSON
      58. SubstanceAdministration.entryRelationship:indication.observation
      Comments

      SHALL contain exactly one [1..1] Indication (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1098-32116).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication)
      60. SubstanceAdministration.entryRelationship:instruction
      Slice Nameinstruction
      Comments

      MAY contain zero or more [0..*] entryRelationship (CONF:1098-32117) such that it

      Control0..*
      62. SubstanceAdministration.entryRelationship:instruction.typeCode
      Comments

      SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32118).

      Fixed ValueSUBJ
      64. SubstanceAdministration.entryRelationship:instruction.act
      Comments

      SHALL contain exactly one [1..1] Instruction (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-32119).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Instruction)
      66. SubstanceAdministration.precondition
      SlicingThis element introduces a set of slices on SubstanceAdministration.precondition. The slices are unordered and Open, and can be differentiated using the following discriminators:
      • profile @ criterion
      • 68. SubstanceAdministration.precondition:pronditionForSubstanceAdmin
        Slice NamepronditionForSubstanceAdmin
        Comments

        MAY contain zero or more [0..*] precondition (CONF:1098-32123) such that it

        Control0..*
        70. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeCode
        Comments

        SHALL contain exactly one [1..1] @typeCode="PRCN" Precondition (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32124).

        Control1..?
        72. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.criterion
        Comments

        SHALL contain exactly one [1..1] Precondition for Substance Administration (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.25:2014-06-09) (CONF:1098-32125).

        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Criterion(Precondition for Substance Administration)

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

        0. SubstanceAdministration
        Definition

        Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.


        Base definition for all types defined in FHIR type system.

        ShortBase for all types and resources
        Control10..1*
        Is Modifierfalse
        Logical ContainerClinicalDocument (CDA Class)
        ValidationInstances of this type are validated by templateId
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
        Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
        2. SubstanceAdministration.templateId
        Definition

        When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

        Control1..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        SlicingThis element introduces a set of slices on SubstanceAdministration.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
        • value @ root
        • 4. SubstanceAdministration.templateId:planned-immunization-activity
          Slice Nameplanned-immunization-activity
          Definition

          When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
          6. SubstanceAdministration.templateId:planned-immunization-activity.root
          Definition

          A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

          Control1..1
          Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelRoot
          Pattern Value2.16.840.1.113883.10.20.22.4.120
          8. SubstanceAdministration.templateId:planned-immunization-activity.extension
          Definition

          A character string as a unique identifier within the scope of the identifier root.

          Control0..0
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExtension
          10. SubstanceAdministration.classCode
          Comments

          SHALL contain exactly one [1..1] @classCode="SBADM" (CONF:1098-32091).

          Control1..1
          BindingThe codes SHALL be taken from CDAActClass
          (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueSBADM
          12. SubstanceAdministration.moodCode
          Comments

          SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (SubstanceAdministration/Supply) urn:oid:2.16.840.1.113883.11.20.9.24 STATIC 2014-09-01 (CONF:1098-32097).

          Control1..1
          BindingThe codes SHALL be taken from Planned moodCode (SubstanceAdministration/Supply) .
          (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          14. SubstanceAdministration.id
          Comments

          SHALL contain at least one [1..*] id (CONF:1098-32100).

          Control1..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
          16. SubstanceAdministration.text
          ShortSHOULD reference the portion of section narrative text corresponding to this entry
          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
          18. SubstanceAdministration.text.reference
          Definition

          A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
          LabelReference
          Invariantsvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (value.exists() implies value.startsWith('#'))
          20. SubstanceAdministration.statusCode
          Comments

          SHALL contain exactly one [1..1] statusCode (CONF:1098-32101).

          Control1..1
          BindingThe codes SHALL be taken from ActStatus
          (required to http://terminology.hl7.org/ValueSet/v3-ActStatus)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
          22. SubstanceAdministration.statusCode.code
          Definition

          The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

          Comments

          This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-32102).

          Control1..1
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelCode
          Fixed Valueactive
          24. SubstanceAdministration.statusCode.codeSystem
          Definition

          Specifies the code system that defines the code.

          Control0..0
          Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelCode System
          26. SubstanceAdministration.statusCode.codeSystemName
          Definition

          The common name of the coding system.

          Control0..0
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelCode System Name
          28. SubstanceAdministration.statusCode.codeSystemVersion
          Definition

          If applicable, a version descriptor defined specifically for the given code system.

          Control0..0
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelCode System Version
          30. SubstanceAdministration.statusCode.displayName
          Definition

          A name or title for the code, under which the sending system shows the code value to its users.

          Control0..0
          Typestring(st: Character String)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelDisplay Name
          32. SubstanceAdministration.statusCode.originalText
          Definition

          The text or phrase used as the basis for the coding.

          Control0..0
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
          LabelOriginal Text
          34. SubstanceAdministration.statusCode.qualifier
          Definition

          Specifies additional codes that increase the specificity of the the primary code.

          Control0..0
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
          LabelQualifier
          36. SubstanceAdministration.statusCode.translation
          Definition

          A set of other concept descriptors that translate this concept descriptor into other code systems.

          Control0..0
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
          XML FormatThe type of this property is determined using the xsi:typeattribute.
          LabelTranslation
          38. SubstanceAdministration.effectiveTime
          ShortThe effectiveTime in a planned immunization activity represents the time that the immunization activity should occur.
          Comments

          SHALL contain exactly one [1..1] effectiveTime (CONF:1098-32103).

          Control1..1
          TypeChoice of: http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
          Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
          XML FormatThe type of this property is determined using the xsi:typeattribute.
          40. SubstanceAdministration.repeatNumber
          ShortIn a Planned Immunization Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.
          Comments

          MAY contain zero or one [0..1] repeatNumber (CONF:1098-32126).

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
          42. SubstanceAdministration.routeCode
          Comments

          MAY contain zero or one [0..1] routeCode, which SHALL be selected from ValueSet SPL Drug Route of Administration Terminology urn:oid:2.16.840.1.113883.3.88.12.3221.8.7 DYNAMIC (CONF:1098-32127).

          Control0..1
          BindingThe codes SHALL be taken from SPL Drug Route of Administration Terminology .
          (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.7)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
          Invariantsshould-translation: SHOULD contain translation (translation.exists())
          44. SubstanceAdministration.routeCode.qualifier
          Definition

          Specifies additional codes that increase the specificity of the the primary code.

          Control0..0
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
          LabelQualifier
          46. SubstanceAdministration.routeCode.translation
          Definition

          A set of other concept descriptors that translate this concept descriptor into other code systems.

          Comments

          The routeCode, if present, SHOULD contain zero or more [0..*] translation, which SHOULD be selected from ValueSet Medication Route urn:oid:2.16.840.1.113762.1.4.1099.12 DYNAMIC (CONF:1098-32951).

          Control0..*
          BindingThe codes SHOULD be taken from Medication Route .
          (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.12)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
          XML FormatThe type of this property is determined using the xsi:typeattribute.
          LabelTranslation
          48. SubstanceAdministration.approachSiteCode
          Comments

          MAY contain zero or more [0..*] approachSiteCode, which SHALL be selected from ValueSet Body Site Value Set urn:oid:2.16.840.1.113883.3.88.12.3221.8.9 DYNAMIC (CONF:1098-32128).

          Control0..*
          BindingThe codes SHALL be taken from Body Site Value Set .
          (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.9)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
          50. SubstanceAdministration.doseQuantity
          Comments

          MAY contain zero or one [0..1] doseQuantity (CONF:1098-32129).

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
          Invariantsshould-unit: SHOULD contain @unit (nullFlavor.exists() or unit.exists())
          52. SubstanceAdministration.doseQuantity.unit
          Definition

          The unit of measure specified in the Unified Code for Units of Measure (UCUM) [].

          ShortNOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
          Comments

          The doseQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHOULD be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32130).

          Control0..1
          BindingThe codes SHOULD be taken from UnitsOfMeasureCaseSensitive .
          (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12839)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelUnit of Measure
          Default Value1
          54. SubstanceAdministration.consumable
          Definition

          The consumable participation is used to bring in the LabeledDrug or Material entity that describes the administered substance. The LabeledDrug class, which is an Entity class playing the Role of Manufactured Product, identifies the drug that is consumed in the substance administration. The medication is identified by means of the LabeledDrug.code or the LabeledDrug.name. The Material entity is used to identify non-drug administered substances such as vaccines and blood products.

          Comments

          SHALL contain exactly one [1..1] consumable (CONF:1098-32131).

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
          56. SubstanceAdministration.consumable.manufacturedProduct
          Definition

          Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

          ShortBase for all types and resources
          Comments

          This consumable SHALL contain exactly one [1..1] Immunization Medication Information (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.54:2014-06-09) (CONF:1098-32132).

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Immunization Medication Information)
          Is Modifierfalse
          Invariantsproduct-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) ((manufacturedLabeledDrug | manufacturedMaterial).count() = 1)
          should-manufacturerOrganization: SHOULD contain manufacturerOrganization (manufacturerOrganization.exists())
          58. SubstanceAdministration.performer
          ShortThe clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer.
          Comments

          MAY contain zero or more [0..*] performer (CONF:1098-32104).

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
          60. SubstanceAdministration.author
          Definition

          Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

          ShortThe author in a planned immunization activity represents the clinician who is requesting or planning the immunization activity.
          Comments

          MAY contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32105).

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
          Is Modifierfalse
          62. SubstanceAdministration.entryRelationship
          ShortThe following entryRelationship captures any instructions associated with the planned immunization activity.
          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
          SlicingThis element introduces a set of slices on SubstanceAdministration.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
          • profile @ observation
          • profile @ act
          • 64. SubstanceAdministration.entryRelationship:priorityPreference
            Slice NamepriorityPreference
            ShortThe following entryRelationship represents the priority that a patient or a provider places on the immunization activity.
            Comments

            MAY contain zero or more [0..*] entryRelationship (CONF:1098-32108) such that it

            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
            66. SubstanceAdministration.entryRelationship:priorityPreference.typeCode
            Comments

            SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32109).

            Control1..1
            BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
            (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed ValueREFR
            68. SubstanceAdministration.entryRelationship:priorityPreference.observation
            Definition

            Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

            ShortBase for all types and resources
            Comments

            SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-32110).

            Control1..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference)
            Is Modifierfalse
            Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
            should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
            should-author: SHOULD contain author (author.exists())
            70. SubstanceAdministration.entryRelationship:indication
            Slice Nameindication
            ShortThe following entryRelationship represents the indication for the immunization activity.
            Comments

            MAY contain zero or more [0..*] entryRelationship (CONF:1098-32114) such that it

            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
            72. SubstanceAdministration.entryRelationship:indication.typeCode
            Comments

            SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32115).

            Control1..1
            BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
            (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed ValueRSON
            74. SubstanceAdministration.entryRelationship:indication.observation
            Definition

            Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

            ShortBase for all types and resources
            Comments

            SHALL contain exactly one [1..1] Indication (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1098-32116).

            Control1..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication)
            Is Modifierfalse
            Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
            should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
            indication-value: If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. (value.exists() or (%resource.descendants().ofType(CDA.Observation).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and value.exists())))
            76. SubstanceAdministration.entryRelationship:instruction
            Slice Nameinstruction
            Comments

            MAY contain zero or more [0..*] entryRelationship (CONF:1098-32117) such that it

            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
            78. SubstanceAdministration.entryRelationship:instruction.typeCode
            Comments

            SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32118).

            Control1..1
            BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
            (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed ValueSUBJ
            80. SubstanceAdministration.entryRelationship:instruction.act
            Definition

            Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

            ShortBase for all types and resources
            Comments

            SHALL contain exactly one [1..1] Instruction (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-32119).

            Control1..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Instruction)
            Is Modifierfalse
            Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
            82. SubstanceAdministration.precondition
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
            SlicingThis element introduces a set of slices on SubstanceAdministration.precondition. The slices are unordered and Open, and can be differentiated using the following discriminators:
            • profile @ criterion
            • 84. SubstanceAdministration.precondition:pronditionForSubstanceAdmin
              Slice NamepronditionForSubstanceAdmin
              Comments

              MAY contain zero or more [0..*] precondition (CONF:1098-32123) such that it

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
              86. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeCode
              Comments

              SHALL contain exactly one [1..1] @typeCode="PRCN" Precondition (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32124).

              Control1..1
              BindingThe codes SHALL be taken from CDAActRelationshipType
              (required to http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValuePRCN
              88. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.criterion
              Definition

              Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

              ShortBase for all types and resources
              Comments

              SHALL contain exactly one [1..1] Precondition for Substance Administration (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.25:2014-06-09) (CONF:1098-32125).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Criterion(Precondition for Substance Administration)
              Is Modifierfalse

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

              0. SubstanceAdministration
              Definition

              Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

              ShortBase for all types and resources
              Control1..1
              Is Modifierfalse
              Logical ContainerClinicalDocument (CDA Class)
              ValidationInstances of this type are validated by templateId
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
              Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
              2. SubstanceAdministration.nullFlavor
              Definition

              If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              4. SubstanceAdministration.realmCode
              Definition

              When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
              6. SubstanceAdministration.typeId
              Definition

              When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              8. SubstanceAdministration.typeId.nullFlavor
              Definition

              If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              10. SubstanceAdministration.typeId.assigningAuthorityName
              Definition

              A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

              Control0..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelAssigning Authority Name
              12. SubstanceAdministration.typeId.displayable
              Definition

              Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

              Control0..1
              Typeboolean(bl: Boolean)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelDisplayable
              14. SubstanceAdministration.typeId.root
              Definition

              Identifies the type as an HL7 Registered model

              Control1..1
              Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelRoot
              Fixed Value2.16.840.1.113883.1.3
              16. SubstanceAdministration.typeId.extension
              Definition

              A character string as a unique identifier within the scope of the identifier root.

              Control1..1
              Typestring(st: Character String)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExtension
              18. SubstanceAdministration.templateId
              Definition

              When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

              Control1..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
              SlicingThis element introduces a set of slices on SubstanceAdministration.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
              • value @ root
              • 20. SubstanceAdministration.templateId:planned-immunization-activity
                Slice Nameplanned-immunization-activity
                Definition

                When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

                Control1..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
                22. SubstanceAdministration.templateId:planned-immunization-activity.nullFlavor
                Definition

                If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

                Control0..1
                BindingThe codes SHALL be taken from CDANullFlavor
                (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
                Typecode(cs: Coded Simple Value)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelExceptional Value Detail
                24. SubstanceAdministration.templateId:planned-immunization-activity.assigningAuthorityName
                Definition

                A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

                Control0..1
                Typestring(st: Character String)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelAssigning Authority Name
                26. SubstanceAdministration.templateId:planned-immunization-activity.displayable
                Definition

                Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

                Control0..1
                Typeboolean(bl: Boolean)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelDisplayable
                28. SubstanceAdministration.templateId:planned-immunization-activity.root
                Definition

                A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

                Control1..1
                Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelRoot
                Pattern Value2.16.840.1.113883.10.20.22.4.120
                30. SubstanceAdministration.templateId:planned-immunization-activity.extension
                Definition

                A character string as a unique identifier within the scope of the identifier root.

                Control0..0
                Typestring(st: Character String)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelExtension
                32. SubstanceAdministration.classCode
                Comments

                SHALL contain exactly one [1..1] @classCode="SBADM" (CONF:1098-32091).

                Control1..1
                BindingThe codes SHALL be taken from CDAActClass
                (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass)
                Typecode(cs: Coded Simple Value)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                Fixed ValueSBADM
                34. SubstanceAdministration.moodCode
                Comments

                SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (SubstanceAdministration/Supply) urn:oid:2.16.840.1.113883.11.20.9.24 STATIC 2014-09-01 (CONF:1098-32097).

                Control1..1
                BindingThe codes SHALL be taken from Planned moodCode (SubstanceAdministration/Supply) .
                (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24)
                Typecode(cs: Coded Simple Value)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                36. SubstanceAdministration.id
                Comments

                SHALL contain at least one [1..*] id (CONF:1098-32100).

                Control1..*
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
                38. SubstanceAdministration.code
                Control0..1
                BindingFor example codes, see CDAActSubstanceAdministrationCode
                (example to http://hl7.org/cda/stds/core/ValueSet/CDAActSubstanceAdministrationCode)
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
                40. SubstanceAdministration.negationInd
                Control0..1
                Typeboolean(bl: Boolean)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                42. SubstanceAdministration.text
                ShortSHOULD reference the portion of section narrative text corresponding to this entry
                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
                44. SubstanceAdministration.text.nullFlavor
                Definition

                If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

                Control0..1
                BindingThe codes SHALL be taken from CDANullFlavor
                (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
                Typecode(cs: Coded Simple Value)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelExceptional Value Detail
                46. SubstanceAdministration.text.compression
                Definition

                Indicates whether the raw byte data is compressed, and what compression algorithm was used.

                Control0..1
                BindingThe codes SHALL be taken from CDACompressionAlgorithm
                (required to http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm)
                Typecode(cs: Coded Simple Value)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelCompression
                48. SubstanceAdministration.text.integrityCheck
                Definition

                The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

                Control0..1
                Typebase64Binary(bin: Binary Data)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelIntegrity Check
                50. SubstanceAdministration.text.integrityCheckAlgorithm
                Definition

                Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

                Control0..1
                BindingThe codes SHALL be taken from IntegrityCheckAlgorithm (2.0.0)
                (required to http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0)
                Typecode(cs: Coded Simple Value)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelIntegrity Check Algorithm
                52. SubstanceAdministration.text.language
                Definition

                For character based information the language property specifies the human language of the text.

                Control0..1
                Typecode(cs: Coded Simple Value)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelLanguage
                54. SubstanceAdministration.text.mediaType
                Definition

                Identifies the type of the encapsulated data and identifies a method to interpret or render the data.

                Control0..1
                BindingFor example codes, see MediaType
                (example to http://terminology.hl7.org/ValueSet/v3-MediaType)
                Typecode(cs: Coded Simple Value)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelMedia Type
                56. SubstanceAdministration.text.representation
                Control0..1
                BindingThe codes SHALL be taken from CDABinaryDataEncoding
                (required to http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding)
                Typecode(cs: Coded Simple Value)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                58. SubstanceAdministration.text.xmlText
                Definition

                Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)

                ShortAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
                Comments

                This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

                Control0..1
                Typestring(st: Character String)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as unadorned text.
                60. SubstanceAdministration.text.reference
                Definition

                A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
                LabelReference
                Invariantsvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (value.exists() implies value.startsWith('#'))
                62. SubstanceAdministration.text.thumbnail
                Definition

                An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
                LabelThumbnail
                64. SubstanceAdministration.statusCode
                Comments

                SHALL contain exactly one [1..1] statusCode (CONF:1098-32101).

                Control1..1
                BindingThe codes SHALL be taken from ActStatus
                (required to http://terminology.hl7.org/ValueSet/v3-ActStatus)
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
                66. SubstanceAdministration.statusCode.nullFlavor
                Definition

                If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

                Control0..1
                BindingThe codes SHALL be taken from CDANullFlavor
                (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
                Typecode(cs: Coded Simple Value)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelExceptional Value Detail
                68. SubstanceAdministration.statusCode.code
                Definition

                The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

                Comments

                This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-32102).

                Control1..1
                Typecode(cs: Coded Simple Value)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelCode
                Fixed Valueactive
                70. SubstanceAdministration.statusCode.codeSystem
                Definition

                Specifies the code system that defines the code.

                Control0..0
                Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelCode System
                72. SubstanceAdministration.statusCode.codeSystemName
                Definition

                The common name of the coding system.

                Control0..0
                Typestring(st: Character String)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelCode System Name
                74. SubstanceAdministration.statusCode.codeSystemVersion
                Definition

                If applicable, a version descriptor defined specifically for the given code system.

                Control0..0
                Typestring(st: Character String)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelCode System Version
                76. SubstanceAdministration.statusCode.displayName
                Definition

                A name or title for the code, under which the sending system shows the code value to its users.

                Control0..0
                Typestring(st: Character String)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelDisplay Name
                78. SubstanceAdministration.statusCode.sdtcValueSet
                Definition

                The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

                Control0..1
                Typestring(oid: ISO Object Identifier)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet.
                80. SubstanceAdministration.statusCode.sdtcValueSetVersion
                Definition

                The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

                Control0..1
                Typestring(st: Character String)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSetVersion.
                82. SubstanceAdministration.statusCode.originalText
                Definition

                The text or phrase used as the basis for the coding.

                Control0..0
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
                LabelOriginal Text
                84. SubstanceAdministration.statusCode.qualifier
                Definition

                Specifies additional codes that increase the specificity of the the primary code.

                Control0..0
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
                LabelQualifier
                86. SubstanceAdministration.statusCode.translation
                Definition

                A set of other concept descriptors that translate this concept descriptor into other code systems.

                Control0..0
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
                XML FormatThe type of this property is determined using the xsi:typeattribute.
                LabelTranslation
                88. SubstanceAdministration.effectiveTime
                ShortThe effectiveTime in a planned immunization activity represents the time that the immunization activity should occur.
                Comments

                SHALL contain exactly one [1..1] effectiveTime (CONF:1098-32103).

                Control1..1
                TypeChoice of: http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
                Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
                XML FormatThe type of this property is determined using the xsi:typeattribute.
                90. SubstanceAdministration.priorityCode
                Control0..1
                BindingFor example codes, see ActPriority
                (example to http://terminology.hl7.org/ValueSet/v3-ActPriority)
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
                92. SubstanceAdministration.repeatNumber
                ShortIn a Planned Immunization Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.
                Comments

                MAY contain zero or one [0..1] repeatNumber (CONF:1098-32126).

                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
                94. SubstanceAdministration.routeCode
                Comments

                MAY contain zero or one [0..1] routeCode, which SHALL be selected from ValueSet SPL Drug Route of Administration Terminology urn:oid:2.16.840.1.113883.3.88.12.3221.8.7 DYNAMIC (CONF:1098-32127).

                Control0..1
                BindingThe codes SHALL be taken from SPL Drug Route of Administration Terminology .
                (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.7)
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
                Invariantsshould-translation: SHOULD contain translation (translation.exists())
                96. SubstanceAdministration.routeCode.nullFlavor
                Definition

                If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

                Control0..1
                BindingThe codes SHALL be taken from CDANullFlavor
                (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
                Typecode(cs: Coded Simple Value)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelExceptional Value Detail
                98. SubstanceAdministration.routeCode.code
                Definition

                The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

                Control0..1
                Typecode(cs: Coded Simple Value)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelCode
                100. SubstanceAdministration.routeCode.codeSystem
                Definition

                Specifies the code system that defines the code.

                Control0..1
                Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelCode System
                102. SubstanceAdministration.routeCode.codeSystemName
                Definition

                The common name of the coding system.

                Control0..1
                Typestring(st: Character String)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelCode System Name
                104. SubstanceAdministration.routeCode.codeSystemVersion
                Definition

                If applicable, a version descriptor defined specifically for the given code system.

                Control0..1
                Typestring(st: Character String)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelCode System Version
                106. SubstanceAdministration.routeCode.displayName
                Definition

                A name or title for the code, under which the sending system shows the code value to its users.

                Control0..1
                Typestring(st: Character String)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelDisplay Name
                108. SubstanceAdministration.routeCode.sdtcValueSet
                Definition

                The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

                Control0..1
                Typestring(oid: ISO Object Identifier)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet.
                110. SubstanceAdministration.routeCode.sdtcValueSetVersion
                Definition

                The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

                Control0..1
                Typestring(st: Character String)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSetVersion.
                112. SubstanceAdministration.routeCode.originalText
                Definition

                The text or phrase used as the basis for the coding.

                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
                LabelOriginal Text
                114. SubstanceAdministration.routeCode.qualifier
                Definition

                Specifies additional codes that increase the specificity of the the primary code.

                Control0..0
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
                LabelQualifier
                116. SubstanceAdministration.routeCode.translation
                Definition

                A set of other concept descriptors that translate this concept descriptor into other code systems.

                Comments

                The routeCode, if present, SHOULD contain zero or more [0..*] translation, which SHOULD be selected from ValueSet Medication Route urn:oid:2.16.840.1.113762.1.4.1099.12 DYNAMIC (CONF:1098-32951).

                Control0..*
                BindingThe codes SHOULD be taken from Medication Route .
                (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.12)
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
                XML FormatThe type of this property is determined using the xsi:typeattribute.
                LabelTranslation
                118. SubstanceAdministration.approachSiteCode
                Comments

                MAY contain zero or more [0..*] approachSiteCode, which SHALL be selected from ValueSet Body Site Value Set urn:oid:2.16.840.1.113883.3.88.12.3221.8.9 DYNAMIC (CONF:1098-32128).

                Control0..*
                BindingThe codes SHALL be taken from Body Site Value Set .
                (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.8.9)
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
                120. SubstanceAdministration.doseQuantity
                Comments

                MAY contain zero or one [0..1] doseQuantity (CONF:1098-32129).

                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
                Invariantsshould-unit: SHOULD contain @unit (nullFlavor.exists() or unit.exists())
                122. SubstanceAdministration.doseQuantity.nullFlavor
                Definition

                If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

                Control0..1
                BindingThe codes SHALL be taken from CDANullFlavor
                (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
                Typecode(cs: Coded Simple Value)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelExceptional Value Detail
                124. SubstanceAdministration.doseQuantity.unit
                Definition

                The unit of measure specified in the Unified Code for Units of Measure (UCUM) [].

                ShortNOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
                Comments

                The doseQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHOULD be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32130).

                Control0..1
                BindingThe codes SHOULD be taken from UnitsOfMeasureCaseSensitive .
                (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12839)
                Typecode(cs: Coded Simple Value)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelUnit of Measure
                Default Value1
                126. SubstanceAdministration.doseQuantity.value
                Definition

                The magnitude of the quantity measured in terms of the unit.

                Control0..1
                Typedecimal(real: Real Number)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelMaginitude Value
                128. SubstanceAdministration.doseQuantity.translation
                Definition

                An alternative representation of the same physical quantity expressed in a different unit, of a different unit code system and possibly with a different value.

                Control0..*
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQR
                LabelTranslation
                130. SubstanceAdministration.doseQuantity.operator
                Definition

                A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.

                Control0..1
                BindingThe codes SHALL be taken from CDASetOperator
                (required to http://hl7.org/cda/stds/core/ValueSet/CDASetOperator)
                Typecode(cs: Coded Simple Value)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                Default ValueI
                132. SubstanceAdministration.doseQuantity.low
                Definition

                This is the low limit of the interval.

                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-PQ
                LabelLow Boundary
                134. SubstanceAdministration.doseQuantity.center
                Definition

                The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.

                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
                LabelCentral Value
                136. SubstanceAdministration.doseQuantity.width
                Definition

                The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.

                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
                LabelWidth
                138. SubstanceAdministration.doseQuantity.high
                Definition

                This is the high limit of the interval.

                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-PQ
                LabelHigh Boundary
                140. SubstanceAdministration.rateQuantity
                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ
                142. SubstanceAdministration.maxDoseQuantity
                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ
                144. SubstanceAdministration.administrationUnitCode
                Control0..1
                BindingFor example codes, see AdministrableDrugForm
                (example to http://terminology.hl7.org/ValueSet/v3-AdministrableDrugForm)
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
                146. SubstanceAdministration.consumable
                Definition

                The consumable participation is used to bring in the LabeledDrug or Material entity that describes the administered substance. The LabeledDrug class, which is an Entity class playing the Role of Manufactured Product, identifies the drug that is consumed in the substance administration. The medication is identified by means of the LabeledDrug.code or the LabeledDrug.name. The Material entity is used to identify non-drug administered substances such as vaccines and blood products.

                Comments

                SHALL contain exactly one [1..1] consumable (CONF:1098-32131).

                Control1..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
                148. SubstanceAdministration.consumable.nullFlavor
                Definition

                If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

                Control0..1
                BindingThe codes SHALL be taken from CDANullFlavor
                (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
                Typecode(cs: Coded Simple Value)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelExceptional Value Detail
                150. SubstanceAdministration.consumable.realmCode
                Definition

                When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

                Control0..*
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
                152. SubstanceAdministration.consumable.typeId
                Definition

                When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
                154. SubstanceAdministration.consumable.typeId.nullFlavor
                Definition

                If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

                Control0..1
                BindingThe codes SHALL be taken from CDANullFlavor
                (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
                Typecode(cs: Coded Simple Value)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelExceptional Value Detail
                156. SubstanceAdministration.consumable.typeId.assigningAuthorityName
                Definition

                A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

                Control0..1
                Typestring(st: Character String)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelAssigning Authority Name
                158. SubstanceAdministration.consumable.typeId.displayable
                Definition

                Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

                Control0..1
                Typeboolean(bl: Boolean)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelDisplayable
                160. SubstanceAdministration.consumable.typeId.root
                Definition

                Identifies the type as an HL7 Registered model

                Control1..1
                Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelRoot
                Fixed Value2.16.840.1.113883.1.3
                162. SubstanceAdministration.consumable.typeId.extension
                Definition

                A character string as a unique identifier within the scope of the identifier root.

                Control1..1
                Typestring(st: Character String)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                LabelExtension
                164. SubstanceAdministration.consumable.templateId
                Definition

                When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

                Control0..*
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
                166. SubstanceAdministration.consumable.typeCode
                Control0..1
                BindingThe codes SHALL be taken from CDAParticipationType
                (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
                Typecode(cs: Coded Simple Value)
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                Fixed ValueCSM
                168. SubstanceAdministration.consumable.manufacturedProduct
                Definition

                Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

                ShortBase for all types and resources
                Comments

                This consumable SHALL contain exactly one [1..1] Immunization Medication Information (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.54:2014-06-09) (CONF:1098-32132).

                Control1..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct(Immunization Medication Information)
                Is Modifierfalse
                Invariantsproduct-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) ((manufacturedLabeledDrug | manufacturedMaterial).count() = 1)
                should-manufacturerOrganization: SHOULD contain manufacturerOrganization (manufacturerOrganization.exists())
                170. SubstanceAdministration.subject
                Control0..1
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
                172. SubstanceAdministration.specimen
                Control0..*
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
                174. SubstanceAdministration.performer
                ShortThe clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer.
                Comments

                MAY contain zero or more [0..*] performer (CONF:1098-32104).

                Control0..*
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
                176. SubstanceAdministration.author
                Definition

                Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

                ShortThe author in a planned immunization activity represents the clinician who is requesting or planning the immunization activity.
                Comments

                MAY contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32105).

                Control0..*
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
                Is Modifierfalse
                178. SubstanceAdministration.informant
                Control0..*
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
                180. SubstanceAdministration.participant
                Control0..*
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
                182. SubstanceAdministration.entryRelationship
                ShortThe following entryRelationship captures any instructions associated with the planned immunization activity.
                Control0..*
                Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
                SlicingThis element introduces a set of slices on SubstanceAdministration.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
                • profile @ observation
                • profile @ act
                • 184. SubstanceAdministration.entryRelationship:priorityPreference
                  Slice NamepriorityPreference
                  ShortThe following entryRelationship represents the priority that a patient or a provider places on the immunization activity.
                  Comments

                  MAY contain zero or more [0..*] entryRelationship (CONF:1098-32108) such that it

                  Control0..*
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
                  186. SubstanceAdministration.entryRelationship:priorityPreference.nullFlavor
                  Definition

                  If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

                  Control0..1
                  BindingThe codes SHALL be taken from CDANullFlavor
                  (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
                  Typecode(cs: Coded Simple Value)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  LabelExceptional Value Detail
                  188. SubstanceAdministration.entryRelationship:priorityPreference.realmCode
                  Definition

                  When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

                  Control0..*
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
                  190. SubstanceAdministration.entryRelationship:priorityPreference.typeId
                  Definition

                  When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
                  192. SubstanceAdministration.entryRelationship:priorityPreference.typeId.nullFlavor
                  Definition

                  If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

                  Control0..1
                  BindingThe codes SHALL be taken from CDANullFlavor
                  (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
                  Typecode(cs: Coded Simple Value)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  LabelExceptional Value Detail
                  194. SubstanceAdministration.entryRelationship:priorityPreference.typeId.assigningAuthorityName
                  Definition

                  A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

                  Control0..1
                  Typestring(st: Character String)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  LabelAssigning Authority Name
                  196. SubstanceAdministration.entryRelationship:priorityPreference.typeId.displayable
                  Definition

                  Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

                  Control0..1
                  Typeboolean(bl: Boolean)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  LabelDisplayable
                  198. SubstanceAdministration.entryRelationship:priorityPreference.typeId.root
                  Definition

                  Identifies the type as an HL7 Registered model

                  Control1..1
                  Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  LabelRoot
                  Fixed Value2.16.840.1.113883.1.3
                  200. SubstanceAdministration.entryRelationship:priorityPreference.typeId.extension
                  Definition

                  A character string as a unique identifier within the scope of the identifier root.

                  Control1..1
                  Typestring(st: Character String)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  LabelExtension
                  202. SubstanceAdministration.entryRelationship:priorityPreference.templateId
                  Definition

                  When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

                  Control0..*
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
                  204. SubstanceAdministration.entryRelationship:priorityPreference.typeCode
                  Comments

                  SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32109).

                  Control1..1
                  BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
                  (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship)
                  Typecode(cs: Coded Simple Value)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Fixed ValueREFR
                  206. SubstanceAdministration.entryRelationship:priorityPreference.inversionInd
                  Definition

                  The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.

                  Control0..1
                  Typeboolean(bl: Boolean)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  208. SubstanceAdministration.entryRelationship:priorityPreference.contextConductionInd
                  Definition

                  The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.

                  Control0..1
                  Typeboolean(bl: Boolean)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Default Valuetrue
                  210. SubstanceAdministration.entryRelationship:priorityPreference.negationInd
                  Control0..1
                  Typeboolean(bl: Boolean)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  212. SubstanceAdministration.entryRelationship:priorityPreference.sequenceNumber
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
                  214. SubstanceAdministration.entryRelationship:priorityPreference.seperatableInd
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
                  216. SubstanceAdministration.entryRelationship:priorityPreference.act
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
                  218. SubstanceAdministration.entryRelationship:priorityPreference.encounter
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
                  220. SubstanceAdministration.entryRelationship:priorityPreference.observation
                  Definition

                  Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

                  ShortBase for all types and resources
                  Comments

                  SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-32110).

                  Control1..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Priority Preference)
                  Is Modifierfalse
                  Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
                  should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
                  should-author: SHOULD contain author (author.exists())
                  222. SubstanceAdministration.entryRelationship:priorityPreference.observationMedia
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
                  224. SubstanceAdministration.entryRelationship:priorityPreference.organizer
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
                  226. SubstanceAdministration.entryRelationship:priorityPreference.procedure
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
                  228. SubstanceAdministration.entryRelationship:priorityPreference.regionOfInterest
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
                  230. SubstanceAdministration.entryRelationship:priorityPreference.substanceAdministration
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
                  232. SubstanceAdministration.entryRelationship:priorityPreference.supply
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
                  234. SubstanceAdministration.entryRelationship:indication
                  Slice Nameindication
                  ShortThe following entryRelationship represents the indication for the immunization activity.
                  Comments

                  MAY contain zero or more [0..*] entryRelationship (CONF:1098-32114) such that it

                  Control0..*
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
                  236. SubstanceAdministration.entryRelationship:indication.nullFlavor
                  Definition

                  If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

                  Control0..1
                  BindingThe codes SHALL be taken from CDANullFlavor
                  (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
                  Typecode(cs: Coded Simple Value)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  LabelExceptional Value Detail
                  238. SubstanceAdministration.entryRelationship:indication.realmCode
                  Definition

                  When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

                  Control0..*
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
                  240. SubstanceAdministration.entryRelationship:indication.typeId
                  Definition

                  When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
                  242. SubstanceAdministration.entryRelationship:indication.typeId.nullFlavor
                  Definition

                  If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

                  Control0..1
                  BindingThe codes SHALL be taken from CDANullFlavor
                  (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
                  Typecode(cs: Coded Simple Value)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  LabelExceptional Value Detail
                  244. SubstanceAdministration.entryRelationship:indication.typeId.assigningAuthorityName
                  Definition

                  A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

                  Control0..1
                  Typestring(st: Character String)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  LabelAssigning Authority Name
                  246. SubstanceAdministration.entryRelationship:indication.typeId.displayable
                  Definition

                  Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

                  Control0..1
                  Typeboolean(bl: Boolean)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  LabelDisplayable
                  248. SubstanceAdministration.entryRelationship:indication.typeId.root
                  Definition

                  Identifies the type as an HL7 Registered model

                  Control1..1
                  Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  LabelRoot
                  Fixed Value2.16.840.1.113883.1.3
                  250. SubstanceAdministration.entryRelationship:indication.typeId.extension
                  Definition

                  A character string as a unique identifier within the scope of the identifier root.

                  Control1..1
                  Typestring(st: Character String)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  LabelExtension
                  252. SubstanceAdministration.entryRelationship:indication.templateId
                  Definition

                  When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

                  Control0..*
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
                  254. SubstanceAdministration.entryRelationship:indication.typeCode
                  Comments

                  SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32115).

                  Control1..1
                  BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
                  (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship)
                  Typecode(cs: Coded Simple Value)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Fixed ValueRSON
                  256. SubstanceAdministration.entryRelationship:indication.inversionInd
                  Definition

                  The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.

                  Control0..1
                  Typeboolean(bl: Boolean)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  258. SubstanceAdministration.entryRelationship:indication.contextConductionInd
                  Definition

                  The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.

                  Control0..1
                  Typeboolean(bl: Boolean)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Default Valuetrue
                  260. SubstanceAdministration.entryRelationship:indication.negationInd
                  Control0..1
                  Typeboolean(bl: Boolean)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  262. SubstanceAdministration.entryRelationship:indication.sequenceNumber
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
                  264. SubstanceAdministration.entryRelationship:indication.seperatableInd
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
                  266. SubstanceAdministration.entryRelationship:indication.act
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
                  268. SubstanceAdministration.entryRelationship:indication.encounter
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
                  270. SubstanceAdministration.entryRelationship:indication.observation
                  Definition

                  Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

                  ShortBase for all types and resources
                  Comments

                  SHALL contain exactly one [1..1] Indication (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1098-32116).

                  Control1..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Indication)
                  Is Modifierfalse
                  Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
                  should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
                  indication-value: If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. (value.exists() or (%resource.descendants().ofType(CDA.Observation).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and value.exists())))
                  272. SubstanceAdministration.entryRelationship:indication.observationMedia
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
                  274. SubstanceAdministration.entryRelationship:indication.organizer
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
                  276. SubstanceAdministration.entryRelationship:indication.procedure
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
                  278. SubstanceAdministration.entryRelationship:indication.regionOfInterest
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
                  280. SubstanceAdministration.entryRelationship:indication.substanceAdministration
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
                  282. SubstanceAdministration.entryRelationship:indication.supply
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
                  284. SubstanceAdministration.entryRelationship:instruction
                  Slice Nameinstruction
                  Comments

                  MAY contain zero or more [0..*] entryRelationship (CONF:1098-32117) such that it

                  Control0..*
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
                  286. SubstanceAdministration.entryRelationship:instruction.nullFlavor
                  Definition

                  If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

                  Control0..1
                  BindingThe codes SHALL be taken from CDANullFlavor
                  (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
                  Typecode(cs: Coded Simple Value)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  LabelExceptional Value Detail
                  288. SubstanceAdministration.entryRelationship:instruction.realmCode
                  Definition

                  When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

                  Control0..*
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
                  290. SubstanceAdministration.entryRelationship:instruction.typeId
                  Definition

                  When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
                  292. SubstanceAdministration.entryRelationship:instruction.typeId.nullFlavor
                  Definition

                  If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

                  Control0..1
                  BindingThe codes SHALL be taken from CDANullFlavor
                  (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
                  Typecode(cs: Coded Simple Value)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  LabelExceptional Value Detail
                  294. SubstanceAdministration.entryRelationship:instruction.typeId.assigningAuthorityName
                  Definition

                  A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

                  Control0..1
                  Typestring(st: Character String)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  LabelAssigning Authority Name
                  296. SubstanceAdministration.entryRelationship:instruction.typeId.displayable
                  Definition

                  Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

                  Control0..1
                  Typeboolean(bl: Boolean)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  LabelDisplayable
                  298. SubstanceAdministration.entryRelationship:instruction.typeId.root
                  Definition

                  Identifies the type as an HL7 Registered model

                  Control1..1
                  Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  LabelRoot
                  Fixed Value2.16.840.1.113883.1.3
                  300. SubstanceAdministration.entryRelationship:instruction.typeId.extension
                  Definition

                  A character string as a unique identifier within the scope of the identifier root.

                  Control1..1
                  Typestring(st: Character String)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  LabelExtension
                  302. SubstanceAdministration.entryRelationship:instruction.templateId
                  Definition

                  When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

                  Control0..*
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
                  304. SubstanceAdministration.entryRelationship:instruction.typeCode
                  Comments

                  SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32118).

                  Control1..1
                  BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
                  (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship)
                  Typecode(cs: Coded Simple Value)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Fixed ValueSUBJ
                  306. SubstanceAdministration.entryRelationship:instruction.inversionInd
                  Definition

                  The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.

                  Control0..1
                  Typeboolean(bl: Boolean)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  308. SubstanceAdministration.entryRelationship:instruction.contextConductionInd
                  Definition

                  The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.

                  Control0..1
                  Typeboolean(bl: Boolean)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Default Valuetrue
                  310. SubstanceAdministration.entryRelationship:instruction.negationInd
                  Control0..1
                  Typeboolean(bl: Boolean)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  312. SubstanceAdministration.entryRelationship:instruction.sequenceNumber
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
                  314. SubstanceAdministration.entryRelationship:instruction.seperatableInd
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
                  316. SubstanceAdministration.entryRelationship:instruction.act
                  Definition

                  Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

                  ShortBase for all types and resources
                  Comments

                  SHALL contain exactly one [1..1] Instruction (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-32119).

                  Control1..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Instruction)
                  Is Modifierfalse
                  Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
                  318. SubstanceAdministration.entryRelationship:instruction.encounter
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
                  320. SubstanceAdministration.entryRelationship:instruction.observation
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
                  322. SubstanceAdministration.entryRelationship:instruction.observationMedia
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
                  324. SubstanceAdministration.entryRelationship:instruction.organizer
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
                  326. SubstanceAdministration.entryRelationship:instruction.procedure
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
                  328. SubstanceAdministration.entryRelationship:instruction.regionOfInterest
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
                  330. SubstanceAdministration.entryRelationship:instruction.substanceAdministration
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
                  332. SubstanceAdministration.entryRelationship:instruction.supply
                  Control0..1
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
                  334. SubstanceAdministration.reference
                  Control0..*
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
                  336. SubstanceAdministration.precondition
                  Control0..*
                  Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
                  SlicingThis element introduces a set of slices on SubstanceAdministration.precondition. The slices are unordered and Open, and can be differentiated using the following discriminators:
                  • profile @ criterion
                  • 338. SubstanceAdministration.precondition:pronditionForSubstanceAdmin
                    Slice NamepronditionForSubstanceAdmin
                    Comments

                    MAY contain zero or more [0..*] precondition (CONF:1098-32123) such that it

                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
                    340. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.nullFlavor
                    Definition

                    If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

                    Control0..1
                    BindingThe codes SHALL be taken from CDANullFlavor
                    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
                    Typecode(cs: Coded Simple Value)
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    LabelExceptional Value Detail
                    342. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.realmCode
                    Definition

                    When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
                    344. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeId
                    Definition

                    When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

                    Control0..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
                    346. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeId.nullFlavor
                    Definition

                    If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

                    Control0..1
                    BindingThe codes SHALL be taken from CDANullFlavor
                    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
                    Typecode(cs: Coded Simple Value)
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    LabelExceptional Value Detail
                    348. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeId.assigningAuthorityName
                    Definition

                    A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

                    Control0..1
                    Typestring(st: Character String)
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    LabelAssigning Authority Name
                    350. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeId.displayable
                    Definition

                    Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

                    Control0..1
                    Typeboolean(bl: Boolean)
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    LabelDisplayable
                    352. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeId.root
                    Definition

                    Identifies the type as an HL7 Registered model

                    Control1..1
                    Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    LabelRoot
                    Fixed Value2.16.840.1.113883.1.3
                    354. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeId.extension
                    Definition

                    A character string as a unique identifier within the scope of the identifier root.

                    Control1..1
                    Typestring(st: Character String)
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    LabelExtension
                    356. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.templateId
                    Definition

                    When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
                    358. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.typeCode
                    Comments

                    SHALL contain exactly one [1..1] @typeCode="PRCN" Precondition (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32124).

                    Control1..1
                    BindingThe codes SHALL be taken from CDAActRelationshipType
                    (required to http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType)
                    Typecode(cs: Coded Simple Value)
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Fixed ValuePRCN
                    360. SubstanceAdministration.precondition:pronditionForSubstanceAdmin.criterion
                    Definition

                    Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

                    ShortBase for all types and resources
                    Comments

                    SHALL contain exactly one [1..1] Precondition for Substance Administration (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.25:2014-06-09) (CONF:1098-32125).

                    Control1..1
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Criterion(Precondition for Substance Administration)
                    Is Modifierfalse
                    362. SubstanceAdministration.sdtcInFulfillmentOf1
                    Control0..*
                    Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
                    XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameinFulfillmentOf1.