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

This page is part of the CCDA: Consolidated CDA Release (v3.0.0: CCDA 3.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Logical Model: PlannedInterventionAct - Detailed Descriptions

Draft as of 2024-05-18

Definitions for the PlannedInterventionAct logical model.

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

0. Act
Logical ContainerClinicalDocument (CDA Class)
ValidationInstance 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())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
should-author: SHOULD contain author (author.exists())
2. Act.templateId
Control1..?
SlicingThis element introduces a set of slices on Act.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
  • 4. Act.templateId:planned-intervention-act
    Slice Nameplanned-intervention-act
    Control1..1
    6. Act.templateId:planned-intervention-act.root
    Control1..?
    Pattern Value2.16.840.1.113883.10.20.22.4.146
    8. Act.templateId:planned-intervention-act.extension
    Control1..?
    Pattern Value2015-08-01
    10. Act.classCode
    Comments

    SHALL contain exactly one [1..1] @classCode="ACT" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1198-32678).

    Fixed ValueACT
    12. Act.moodCode
    Comments

    SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned Intervention moodCode urn:oid:2.16.840.1.113883.11.20.9.54 DYNAMIC (CONF:1198-32679).

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

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

    Control1..?
    16. Act.code
    Comments

    SHALL contain exactly one [1..1] code (CONF:1198-32654).

    18. Act.code.code
    Comments

    This code SHALL contain exactly one [1..1] @code="362956003" procedure / intervention (navigational concept) (CONF:1198-32682).

    Control1..?
    Pattern Value362956003
    20. Act.code.codeSystem
    Comments

    This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.96" (CodeSystem: SNOMED CT urn:oid:2.16.840.1.113883.6.96) (CONF:1198-32683).

    Control1..?
    Pattern Value2.16.840.1.113883.6.96
    22. Act.text
    ShortSHOULD reference the portion of section narrative text corresponding to this entry
    24. Act.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('#'))
    26. Act.statusCode
    Comments

    SHALL contain exactly one [1..1] statusCode (CONF:1198-32655).

    Control1..?
    28. Act.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 STATIC) (CONF:1198-32684).

    Control1..?
    Fixed Valueactive
    30. Act.effectiveTime
    Comments

    SHOULD contain zero or one [0..1] effectiveTime (CONF:1198-32723).

    32. Act.author
    Comments

    SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1198-32719).

    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
    34. Act.entryRelationship
    Control1..?
    SlicingThis element introduces a set of slices on Act.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • profile @ observation
    • profile @ substanceAdministration
    • profile @ act
    • profile @ procedure
    • profile @ encounter
    • profile @ supply
    • value @ typeCode
    • 36. Act.entryRelationship:reason
      Slice Namereason
      ShortAn Intervention Act SHALL reference a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. The following entryRelationship represents an Entry Reference to Goal Observation.
      Comments

      SHALL contain at least one [1..*] entryRelationship (CONF:1198-32673) such that it

      Control1..*
      Invariantsentry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template. (%resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension)))
      38. Act.entryRelationship:reason.typeCode
      Comments

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

      Fixed ValueRSON
      40. Act.entryRelationship:reason.act
      Comments

      SHALL contain exactly one [1..1] Entry Reference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.122) (CONF:1198-32721).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Entry Reference)
      42. Act.entryRelationship:immunizationActivity
      Slice NameimmunizationActivity
      Comments

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

      Control0..*
      44. Act.entryRelationship:immunizationActivity.typeCode
      Comments

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

      Fixed ValueREFR
      46. Act.entryRelationship:immunizationActivity.substanceAdministration
      Comments

      SHALL contain exactly one [1..1] Immunization Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.52:2015-08-01) (CONF:1198-32687).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(Immunization Activity)
      48. Act.entryRelationship:medicationActivity
      Slice NamemedicationActivity
      Comments

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

      Control0..*
      50. Act.entryRelationship:medicationActivity.typeCode
      Comments

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

      Fixed ValueREFR
      52. Act.entryRelationship:medicationActivity.substanceAdministration
      Comments

      SHALL contain exactly one [1..1] Medication Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.16:2014-06-09) (CONF:1198-32689).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(Medication Activity)
      54. Act.entryRelationship:instruction
      Slice Nameinstruction
      Comments

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

      Control0..*
      56. Act.entryRelationship:instruction.typeCode
      Comments

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

      Fixed ValueREFR
      58. Act.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:1198-32701).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Instruction)
      60. Act.entryRelationship:nonMedSupply
      Slice NamenonMedSupply
      Comments

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

      Control0..*
      62. Act.entryRelationship:nonMedSupply.typeCode
      Comments

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

      Fixed ValueREFR
      64. Act.entryRelationship:nonMedSupply.supply
      Comments

      SHALL contain exactly one [1..1] Non-Medicinal Supply Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.50:2014-06-09) (CONF:1198-32703).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply(Non-Medicinal Supply Activity)
      66. Act.entryRelationship:plannedEncounter
      Slice NameplannedEncounter
      Comments

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

      Control0..*
      68. Act.entryRelationship:plannedEncounter.typeCode
      Comments

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

      Fixed ValueREFR
      70. Act.entryRelationship:plannedEncounter.encounter
      Comments

      SHALL contain exactly one [1..1] Planned Encounter (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.40:2014-06-09) (CONF:1198-32707).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter(Planned Encounter)
      72. Act.entryRelationship:plannedProcedure
      Slice NameplannedProcedure
      Comments

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

      Control0..*
      74. Act.entryRelationship:plannedProcedure.typeCode
      Comments

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

      Fixed ValueREFR
      76. Act.entryRelationship:plannedProcedure.procedure
      Comments

      SHALL contain exactly one [1..1] Planned Procedure (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.41:2014-06-09) (CONF:1198-32711).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure(Planned Procedure)
      78. Act.entryRelationship:plannedMedicationActivity
      Slice NameplannedMedicationActivity
      Comments

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

      Control0..*
      80. Act.entryRelationship:plannedMedicationActivity.typeCode
      Comments

      SHALL contain exactly one [1..1] @typeCode="REFR" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-32712).

      Fixed ValueREFR
      82. Act.entryRelationship:plannedMedicationActivity.substanceAdministration
      Comments

      SHALL contain exactly one [1..1] Planned Medication Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.42:2014-06-09) (CONF:1198-32713).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(Planned Medication Activity)
      84. Act.entryRelationship:plannedSupply
      Slice NameplannedSupply
      Comments

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

      Control0..*
      86. Act.entryRelationship:plannedSupply.typeCode
      Comments

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

      Fixed ValueREFR
      88. Act.entryRelationship:plannedSupply.supply
      Comments

      SHALL contain exactly one [1..1] Planned Supply (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.43:2014-06-09) (CONF:1198-32715).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply(Planned Supply)
      90. Act.entryRelationship:nutritionRecommendation
      Slice NamenutritionRecommendation
      Comments

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

      Control0..*
      92. Act.entryRelationship:nutritionRecommendation.typeCode
      Fixed ValueREFR
      94. Act.entryRelationship:nutritionRecommendation.act
      Comments

      SHALL contain exactly one [1..1] Nutrition Recommendation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.130) (CONF:1198-32716).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Nutrition Recommendation)
      96. Act.entryRelationship:entryReference
      Slice NameentryReference
      ShortWhere an Intervention needs to reference another entry already described in the CDA document instance, rather than repeating the full content of the entry, the Entry Reference template may be used to reference this entry.
      Comments

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

      Control0..*
      98. Act.entryRelationship:entryReference.typeCode
      Comments

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

      Fixed ValueREFR
      100. Act.entryRelationship:entryReference.act
      Comments

      SHALL contain exactly one [1..1] Entry Reference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.122) (CONF:1198-32718).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Entry Reference)
      102. Act.entryRelationship:plannedImmunizationActivity
      Slice NameplannedImmunizationActivity
      Comments

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

      Control0..*
      104. Act.entryRelationship:plannedImmunizationActivity.typeCode
      Comments

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

      Fixed ValueREFR
      106. Act.entryRelationship:plannedImmunizationActivity.substanceAdministration
      Comments

      SHALL contain exactly one [1..1] Planned Immunization Activity (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.120) (CONF:1198-32729).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(Planned Immunization Activity)
      108. Act.reference
      Comments

      MAY contain zero or more [0..*] reference (CONF:1198-32766).

      110. Act.reference.typeCode
      Comments

      The reference, if present, SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-32767).

      Fixed ValueREFR
      112. Act.reference.externalDocument
      Comments

      The reference, if present, SHALL contain exactly one [1..1] External Document Reference (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.115:2014-06-09) (CONF:1198-32768).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/ExternalDocument(External Document Reference)

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

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


      Base definition for all types defined in FHIR type system.

      ShortBase for all types and resources
      Control10..1*
      Is Modifierfalse
      Logical ContainerClinicalDocument (CDA Class)
      ValidationInstance 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())
      should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
      should-author: SHOULD contain author (author.exists())
      2. Act.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 Act.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ root
      • value @ extension
      • 4. Act.templateId:planned-intervention-act
        Slice Nameplanned-intervention-act
        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. Act.templateId:planned-intervention-act.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.146
        8. Act.templateId:planned-intervention-act.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
        Pattern Value2015-08-01
        10. Act.classCode
        Comments

        SHALL contain exactly one [1..1] @classCode="ACT" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1198-32678).

        Control1..1
        BindingThe codes SHALL be taken from XActClassDocumentEntryAct (2.0.0)
        (required to http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|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.
        Fixed ValueACT
        12. Act.moodCode
        Comments

        SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned Intervention moodCode urn:oid:2.16.840.1.113883.11.20.9.54 DYNAMIC (CONF:1198-32679).

        Control1..1
        BindingThe codes SHALL be taken from Planned Intervention moodCode .
        (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.54)
        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. Act.id
        Comments

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

        Control1..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        16. Act.code
        Comments

        SHALL contain exactly one [1..1] code (CONF:1198-32654).

        Control1..1
        BindingFor example codes, see v3 Code System ActCode
        (example to http://terminology.hl7.org/ValueSet/v3-ActCode)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
        18. Act.code.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 code SHALL contain exactly one [1..1] @code="362956003" procedure / intervention (navigational concept) (CONF:1198-32682).

        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
        Pattern Value362956003
        20. Act.code.codeSystem
        Definition

        Specifies the code system that defines the code.

        Comments

        This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.96" (CodeSystem: SNOMED CT urn:oid:2.16.840.1.113883.6.96) (CONF:1198-32683).

        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.
        LabelCode System
        Pattern Value2.16.840.1.113883.6.96
        22. Act.text
        ShortSHOULD reference the portion of section narrative text corresponding to this entry
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        24. Act.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('#'))
        26. Act.statusCode
        Comments

        SHALL contain exactly one [1..1] statusCode (CONF:1198-32655).

        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
        28. Act.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 STATIC) (CONF:1198-32684).

        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
        30. Act.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
        32. Act.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
        34. Act.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
        36. Act.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
        38. Act.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
        40. Act.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
        42. Act.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
        44. Act.effectiveTime
        Comments

        SHOULD contain zero or one [0..1] effectiveTime (CONF:1198-32723).

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
        46. Act.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.

        ShortBase for all types and resources
        Comments

        SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1198-32719).

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
        Is Modifierfalse
        48. Act.entryRelationship
        Control1..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
        SlicingThis element introduces a set of slices on Act.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • profile @ observation
        • profile @ substanceAdministration
        • profile @ act
        • profile @ procedure
        • profile @ encounter
        • profile @ supply
        • value @ typeCode
        • 50. Act.entryRelationship:reason
          Slice Namereason
          ShortAn Intervention Act SHALL reference a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. The following entryRelationship represents an Entry Reference to Goal Observation.
          Comments

          SHALL contain at least one [1..*] entryRelationship (CONF:1198-32673) such that it

          Control1..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
          Invariantsentry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template. (%resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension)))
          52. Act.entryRelationship:reason.typeCode
          Comments

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

          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
          54. Act.entryRelationship:reason.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] Entry Reference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.122) (CONF:1198-32721).

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Entry Reference)
          Is Modifierfalse
          Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
          56. Act.entryRelationship:immunizationActivity
          Slice NameimmunizationActivity
          Comments

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

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
          58. Act.entryRelationship:immunizationActivity.typeCode
          Comments

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

          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
          60. Act.entryRelationship:immunizationActivity.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
          Comments

          SHALL contain exactly one [1..1] Immunization Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.52:2015-08-01) (CONF:1198-32687).

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(Immunization Activity)
          Is Modifierfalse
          Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
          should-doseQuantity: SHOULD contain doseQuantity (doseQuantity.exists())
          dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. (doseQuantity.unit.exists() implies administrationUnitCode.empty())
          should-performer: SHOULD contain performer (performer.exists())
          should-author: SHOULD contain author (author.exists())
          62. Act.entryRelationship:medicationActivity
          Slice NamemedicationActivity
          Comments

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

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
          64. Act.entryRelationship:medicationActivity.typeCode
          Comments

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

          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
          66. Act.entryRelationship:medicationActivity.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
          Comments

          SHALL contain exactly one [1..1] Medication Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.16:2014-06-09) (CONF:1198-32689).

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(Medication Activity)
          Is Modifierfalse
          Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
          1098-7513: SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499). (effectiveTime.ofType(CDA.PIVL_TS).exists() or effectiveTime.ofType(CDA.EIVL_TS).exists())
          should-routeCode: SHOULD contain routeCode (routeCode.exists())
          dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. (doseQuantity.unit.exists() implies administrationUnitCode.empty())
          should-author: SHOULD contain author (author.exists())
          68. Act.entryRelationship:instruction
          Slice Nameinstruction
          Comments

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

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

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

          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
          72. Act.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:1198-32701).

          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())
          74. Act.entryRelationship:nonMedSupply
          Slice NamenonMedSupply
          Comments

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

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
          76. Act.entryRelationship:nonMedSupply.typeCode
          Comments

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

          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
          78. Act.entryRelationship:nonMedSupply.supply
          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] Non-Medicinal Supply Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.50:2014-06-09) (CONF:1198-32703).

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply(Non-Medicinal Supply Activity)
          Is Modifierfalse
          Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
          should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
          should-quantity: SHOULD contain quantity (quantity.exists())
          80. Act.entryRelationship:plannedEncounter
          Slice NameplannedEncounter
          Comments

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

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
          82. Act.entryRelationship:plannedEncounter.typeCode
          Comments

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

          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
          84. Act.entryRelationship:plannedEncounter.encounter
          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] Planned Encounter (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.40:2014-06-09) (CONF:1198-32707).

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter(Planned Encounter)
          Is Modifierfalse
          Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
          should-code: SHOULD contain code (code.exists())
          should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
          should-author: SHOULD contain author (author.exists())
          86. Act.entryRelationship:plannedProcedure
          Slice NameplannedProcedure
          Comments

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

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
          88. Act.entryRelationship:plannedProcedure.typeCode
          Comments

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

          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
          90. Act.entryRelationship:plannedProcedure.procedure
          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] Planned Procedure (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.41:2014-06-09) (CONF:1198-32711).

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure(Planned Procedure)
          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())
          92. Act.entryRelationship:plannedMedicationActivity
          Slice NameplannedMedicationActivity
          Comments

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

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
          94. Act.entryRelationship:plannedMedicationActivity.typeCode
          Comments

          SHALL contain exactly one [1..1] @typeCode="REFR" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-32712).

          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
          96. Act.entryRelationship:plannedMedicationActivity.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
          Comments

          SHALL contain exactly one [1..1] Planned Medication Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.42:2014-06-09) (CONF:1198-32713).

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(Planned Medication Activity)
          Is Modifierfalse
          Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
          dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. (doseQuantity.unit.exists() implies administrationUnitCode.empty())
          should-author: SHOULD contain author (author.exists())
          98. Act.entryRelationship:plannedSupply
          Slice NameplannedSupply
          Comments

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

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
          100. Act.entryRelationship:plannedSupply.typeCode
          Comments

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

          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
          102. Act.entryRelationship:plannedSupply.supply
          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] Planned Supply (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.43:2014-06-09) (CONF:1198-32715).

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply(Planned Supply)
          Is Modifierfalse
          Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
          should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
          shall-product-or-device: The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV') ((product | participant.where(typeCode='DEV')).count() = 1)
          should-author: SHOULD contain author (author.exists())
          104. Act.entryRelationship:nutritionRecommendation
          Slice NamenutritionRecommendation
          Comments

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

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
          106. Act.entryRelationship:nutritionRecommendation.typeCode
          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
          108. Act.entryRelationship:nutritionRecommendation.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] Nutrition Recommendation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.130) (CONF:1198-32716).

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Nutrition Recommendation)
          Is Modifierfalse
          Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
          should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
          110. Act.entryRelationship:entryReference
          Slice NameentryReference
          ShortWhere an Intervention needs to reference another entry already described in the CDA document instance, rather than repeating the full content of the entry, the Entry Reference template may be used to reference this entry.
          Comments

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

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
          112. Act.entryRelationship:entryReference.typeCode
          Comments

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

          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
          114. Act.entryRelationship:entryReference.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] Entry Reference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.122) (CONF:1198-32718).

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Entry Reference)
          Is Modifierfalse
          Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
          116. Act.entryRelationship:plannedImmunizationActivity
          Slice NameplannedImmunizationActivity
          Comments

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

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
          118. Act.entryRelationship:plannedImmunizationActivity.typeCode
          Comments

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

          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
          120. Act.entryRelationship:plannedImmunizationActivity.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
          Comments

          SHALL contain exactly one [1..1] Planned Immunization Activity (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.120) (CONF:1198-32729).

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(Planned Immunization Activity)
          Is Modifierfalse
          Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
          122. Act.reference
          Comments

          MAY contain zero or more [0..*] reference (CONF:1198-32766).

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
          124. Act.reference.typeCode
          Comments

          The reference, if present, SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-32767).

          Control1..1
          BindingThe codes SHALL be taken from x_ActRelationshipExternalReference
          (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference)
          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
          126. Act.reference.externalDocument
          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

          The reference, if present, SHALL contain exactly one [1..1] External Document Reference (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.115:2014-06-09) (CONF:1198-32768).

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ExternalDocument(External Document Reference)
          Is Modifierfalse
          Invariantsshould-setId: SHOULD contain setId (setId.exists())
          should-versionNumber: SHOULD contain versionNumber (versionNumber.exists())

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

          0. 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
          Control1..1
          Is Modifierfalse
          Logical ContainerClinicalDocument (CDA Class)
          ValidationInstance 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())
          should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
          should-author: SHOULD contain author (author.exists())
          2. Act.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. Act.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. Act.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. Act.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. Act.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. Act.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. Act.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. Act.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. Act.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 Act.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ root
          • value @ extension
          • 20. Act.templateId:planned-intervention-act
            Slice Nameplanned-intervention-act
            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. Act.templateId:planned-intervention-act.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. Act.templateId:planned-intervention-act.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. Act.templateId:planned-intervention-act.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. Act.templateId:planned-intervention-act.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.146
            30. Act.templateId:planned-intervention-act.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
            Pattern Value2015-08-01
            32. Act.classCode
            Comments

            SHALL contain exactly one [1..1] @classCode="ACT" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1198-32678).

            Control1..1
            BindingThe codes SHALL be taken from XActClassDocumentEntryAct (2.0.0)
            (required to http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|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.
            Fixed ValueACT
            34. Act.moodCode
            Comments

            SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned Intervention moodCode urn:oid:2.16.840.1.113883.11.20.9.54 DYNAMIC (CONF:1198-32679).

            Control1..1
            BindingThe codes SHALL be taken from Planned Intervention moodCode .
            (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.54)
            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. Act.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.
            38. Act.id
            Comments

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

            Control1..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
            40. Act.code
            Comments

            SHALL contain exactly one [1..1] code (CONF:1198-32654).

            Control1..1
            BindingFor example codes, see v3 Code System ActCode
            (example to http://terminology.hl7.org/ValueSet/v3-ActCode)
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
            42. Act.code.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
            44. Act.code.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 code SHALL contain exactly one [1..1] @code="362956003" procedure / intervention (navigational concept) (CONF:1198-32682).

            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
            Pattern Value362956003
            46. Act.code.codeSystem
            Definition

            Specifies the code system that defines the code.

            Comments

            This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.96" (CodeSystem: SNOMED CT urn:oid:2.16.840.1.113883.6.96) (CONF:1198-32683).

            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.
            LabelCode System
            Pattern Value2.16.840.1.113883.6.96
            48. Act.code.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
            50. Act.code.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
            52. Act.code.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
            54. Act.code.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.
            56. Act.code.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.
            58. Act.code.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
            60. Act.code.qualifier
            Definition

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

            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
            LabelQualifier
            62. Act.code.translation
            Definition

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

            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
            XML FormatThe type of this property is determined using the " xsi:typeattribute.
            LabelTranslation
            64. Act.text
            ShortSHOULD reference the portion of section narrative text corresponding to this entry
            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
            66. Act.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
            68. Act.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
            70. Act.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
            72. Act.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
            74. Act.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
            76. Act.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
            78. Act.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.
            80. Act.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.
            82. Act.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('#'))
            84. Act.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
            86. Act.statusCode
            Comments

            SHALL contain exactly one [1..1] statusCode (CONF:1198-32655).

            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
            88. Act.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
            90. Act.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 STATIC) (CONF:1198-32684).

            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
            92. Act.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
            94. Act.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
            96. Act.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
            98. Act.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
            100. Act.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.
            102. Act.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.
            104. Act.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
            106. Act.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
            108. Act.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
            110. Act.effectiveTime
            Comments

            SHOULD contain zero or one [0..1] effectiveTime (CONF:1198-32723).

            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
            112. Act.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
            114. Act.languageCode
            Control0..1
            BindingThe codes SHALL be taken from AllLanguages
            (required to http://hl7.org/fhir/ValueSet/all-languages)
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
            116. Act.subject
            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
            118. Act.specimen
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
            120. Act.performer
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
            122. Act.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.

            ShortBase for all types and resources
            Comments

            SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1198-32719).

            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
            Is Modifierfalse
            124. Act.informant
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
            126. Act.participant
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
            128. Act.entryRelationship
            Control1..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
            SlicingThis element introduces a set of slices on Act.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • profile @ observation
            • profile @ substanceAdministration
            • profile @ act
            • profile @ procedure
            • profile @ encounter
            • profile @ supply
            • value @ typeCode
            • 130. Act.entryRelationship:reason
              Slice Namereason
              ShortAn Intervention Act SHALL reference a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry. The following entryRelationship represents an Entry Reference to Goal Observation.
              Comments

              SHALL contain at least one [1..*] entryRelationship (CONF:1198-32673) such that it

              Control1..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
              Invariantsentry-ref-goal: This entryReference template **SHALL** reference an instance of a Goal Observation template. (%resource.descendants().ofType(CDA.Observation).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.4.121' and $this.extension = '2022-06-01') and id.exists($this.root = %context.act.id.first().root and $this.extension ~ %context.act.id.first().extension)))
              132. Act.entryRelationship:reason.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
              134. Act.entryRelationship:reason.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
              136. Act.entryRelationship:reason.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
              138. Act.entryRelationship:reason.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
              140. Act.entryRelationship:reason.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
              142. Act.entryRelationship:reason.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
              144. Act.entryRelationship:reason.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
              146. Act.entryRelationship:reason.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
              148. Act.entryRelationship:reason.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
              150. Act.entryRelationship:reason.typeCode
              Comments

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

              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
              152. Act.entryRelationship:reason.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.
              154. Act.entryRelationship:reason.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
              156. Act.entryRelationship:reason.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.
              158. Act.entryRelationship:reason.sequenceNumber
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
              160. Act.entryRelationship:reason.seperatableInd
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
              162. Act.entryRelationship:reason.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] Entry Reference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.122) (CONF:1198-32721).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Entry Reference)
              Is Modifierfalse
              Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
              164. Act.entryRelationship:reason.encounter
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
              166. Act.entryRelationship:reason.observation
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
              168. Act.entryRelationship:reason.observationMedia
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
              170. Act.entryRelationship:reason.organizer
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
              172. Act.entryRelationship:reason.procedure
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
              174. Act.entryRelationship:reason.regionOfInterest
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
              176. Act.entryRelationship:reason.substanceAdministration
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
              178. Act.entryRelationship:reason.supply
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
              180. Act.entryRelationship:immunizationActivity
              Slice NameimmunizationActivity
              Comments

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
              182. Act.entryRelationship:immunizationActivity.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
              184. Act.entryRelationship:immunizationActivity.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
              186. Act.entryRelationship:immunizationActivity.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
              188. Act.entryRelationship:immunizationActivity.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
              190. Act.entryRelationship:immunizationActivity.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
              192. Act.entryRelationship:immunizationActivity.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
              194. Act.entryRelationship:immunizationActivity.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
              196. Act.entryRelationship:immunizationActivity.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
              198. Act.entryRelationship:immunizationActivity.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
              200. Act.entryRelationship:immunizationActivity.typeCode
              Comments

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

              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
              202. Act.entryRelationship:immunizationActivity.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.
              204. Act.entryRelationship:immunizationActivity.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
              206. Act.entryRelationship:immunizationActivity.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.
              208. Act.entryRelationship:immunizationActivity.sequenceNumber
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
              210. Act.entryRelationship:immunizationActivity.seperatableInd
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
              212. Act.entryRelationship:immunizationActivity.act
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
              214. Act.entryRelationship:immunizationActivity.encounter
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
              216. Act.entryRelationship:immunizationActivity.observation
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
              218. Act.entryRelationship:immunizationActivity.observationMedia
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
              220. Act.entryRelationship:immunizationActivity.organizer
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
              222. Act.entryRelationship:immunizationActivity.procedure
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
              224. Act.entryRelationship:immunizationActivity.regionOfInterest
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
              226. Act.entryRelationship:immunizationActivity.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
              Comments

              SHALL contain exactly one [1..1] Immunization Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.52:2015-08-01) (CONF:1198-32687).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(Immunization Activity)
              Is Modifierfalse
              Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
              should-doseQuantity: SHOULD contain doseQuantity (doseQuantity.exists())
              dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. (doseQuantity.unit.exists() implies administrationUnitCode.empty())
              should-performer: SHOULD contain performer (performer.exists())
              should-author: SHOULD contain author (author.exists())
              228. Act.entryRelationship:immunizationActivity.supply
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
              230. Act.entryRelationship:medicationActivity
              Slice NamemedicationActivity
              Comments

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
              232. Act.entryRelationship:medicationActivity.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
              234. Act.entryRelationship:medicationActivity.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
              236. Act.entryRelationship:medicationActivity.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
              238. Act.entryRelationship:medicationActivity.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
              240. Act.entryRelationship:medicationActivity.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
              242. Act.entryRelationship:medicationActivity.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
              244. Act.entryRelationship:medicationActivity.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
              246. Act.entryRelationship:medicationActivity.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
              248. Act.entryRelationship:medicationActivity.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
              250. Act.entryRelationship:medicationActivity.typeCode
              Comments

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

              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
              252. Act.entryRelationship:medicationActivity.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.
              254. Act.entryRelationship:medicationActivity.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
              256. Act.entryRelationship:medicationActivity.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.
              258. Act.entryRelationship:medicationActivity.sequenceNumber
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
              260. Act.entryRelationship:medicationActivity.seperatableInd
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
              262. Act.entryRelationship:medicationActivity.act
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
              264. Act.entryRelationship:medicationActivity.encounter
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
              266. Act.entryRelationship:medicationActivity.observation
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
              268. Act.entryRelationship:medicationActivity.observationMedia
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
              270. Act.entryRelationship:medicationActivity.organizer
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
              272. Act.entryRelationship:medicationActivity.procedure
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
              274. Act.entryRelationship:medicationActivity.regionOfInterest
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
              276. Act.entryRelationship:medicationActivity.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
              Comments

              SHALL contain exactly one [1..1] Medication Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.16:2014-06-09) (CONF:1198-32689).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(Medication Activity)
              Is Modifierfalse
              Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
              1098-7513: SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-7513) such that it **SHALL** contain exactly one [1..1] @xsi:type="PIVL_TS" or "EIVL_TS" (CONF:1098-28499). (effectiveTime.ofType(CDA.PIVL_TS).exists() or effectiveTime.ofType(CDA.EIVL_TS).exists())
              should-routeCode: SHOULD contain routeCode (routeCode.exists())
              dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. (doseQuantity.unit.exists() implies administrationUnitCode.empty())
              should-author: SHOULD contain author (author.exists())
              278. Act.entryRelationship:medicationActivity.supply
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
              280. Act.entryRelationship:instruction
              Slice Nameinstruction
              Comments

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
              282. Act.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
              284. Act.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
              286. Act.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
              288. Act.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
              290. Act.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
              292. Act.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
              294. Act.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
              296. Act.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
              298. Act.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
              300. Act.entryRelationship:instruction.typeCode
              Comments

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

              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
              302. Act.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.
              304. Act.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
              306. Act.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.
              308. Act.entryRelationship:instruction.sequenceNumber
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
              310. Act.entryRelationship:instruction.seperatableInd
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
              312. Act.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:1198-32701).

              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())
              314. Act.entryRelationship:instruction.encounter
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
              316. Act.entryRelationship:instruction.observation
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
              318. Act.entryRelationship:instruction.observationMedia
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
              320. Act.entryRelationship:instruction.organizer
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
              322. Act.entryRelationship:instruction.procedure
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
              324. Act.entryRelationship:instruction.regionOfInterest
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
              326. Act.entryRelationship:instruction.substanceAdministration
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
              328. Act.entryRelationship:instruction.supply
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
              330. Act.entryRelationship:nonMedSupply
              Slice NamenonMedSupply
              Comments

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
              332. Act.entryRelationship:nonMedSupply.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
              334. Act.entryRelationship:nonMedSupply.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
              336. Act.entryRelationship:nonMedSupply.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
              338. Act.entryRelationship:nonMedSupply.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
              340. Act.entryRelationship:nonMedSupply.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
              342. Act.entryRelationship:nonMedSupply.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
              344. Act.entryRelationship:nonMedSupply.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
              346. Act.entryRelationship:nonMedSupply.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
              348. Act.entryRelationship:nonMedSupply.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
              350. Act.entryRelationship:nonMedSupply.typeCode
              Comments

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

              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
              352. Act.entryRelationship:nonMedSupply.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.
              354. Act.entryRelationship:nonMedSupply.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
              356. Act.entryRelationship:nonMedSupply.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.
              358. Act.entryRelationship:nonMedSupply.sequenceNumber
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
              360. Act.entryRelationship:nonMedSupply.seperatableInd
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
              362. Act.entryRelationship:nonMedSupply.act
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
              364. Act.entryRelationship:nonMedSupply.encounter
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
              366. Act.entryRelationship:nonMedSupply.observation
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
              368. Act.entryRelationship:nonMedSupply.observationMedia
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
              370. Act.entryRelationship:nonMedSupply.organizer
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
              372. Act.entryRelationship:nonMedSupply.procedure
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
              374. Act.entryRelationship:nonMedSupply.regionOfInterest
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
              376. Act.entryRelationship:nonMedSupply.substanceAdministration
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
              378. Act.entryRelationship:nonMedSupply.supply
              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] Non-Medicinal Supply Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.50:2014-06-09) (CONF:1198-32703).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply(Non-Medicinal Supply Activity)
              Is Modifierfalse
              Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
              should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
              should-quantity: SHOULD contain quantity (quantity.exists())
              380. Act.entryRelationship:plannedEncounter
              Slice NameplannedEncounter
              Comments

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
              382. Act.entryRelationship:plannedEncounter.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
              384. Act.entryRelationship:plannedEncounter.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
              386. Act.entryRelationship:plannedEncounter.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
              388. Act.entryRelationship:plannedEncounter.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
              390. Act.entryRelationship:plannedEncounter.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
              392. Act.entryRelationship:plannedEncounter.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
              394. Act.entryRelationship:plannedEncounter.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
              396. Act.entryRelationship:plannedEncounter.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
              398. Act.entryRelationship:plannedEncounter.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
              400. Act.entryRelationship:plannedEncounter.typeCode
              Comments

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

              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
              402. Act.entryRelationship:plannedEncounter.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.
              404. Act.entryRelationship:plannedEncounter.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
              406. Act.entryRelationship:plannedEncounter.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.
              408. Act.entryRelationship:plannedEncounter.sequenceNumber
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
              410. Act.entryRelationship:plannedEncounter.seperatableInd
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
              412. Act.entryRelationship:plannedEncounter.act
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
              414. Act.entryRelationship:plannedEncounter.encounter
              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] Planned Encounter (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.40:2014-06-09) (CONF:1198-32707).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter(Planned Encounter)
              Is Modifierfalse
              Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
              should-code: SHOULD contain code (code.exists())
              should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
              should-author: SHOULD contain author (author.exists())
              416. Act.entryRelationship:plannedEncounter.observation
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
              418. Act.entryRelationship:plannedEncounter.observationMedia
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
              420. Act.entryRelationship:plannedEncounter.organizer
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
              422. Act.entryRelationship:plannedEncounter.procedure
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
              424. Act.entryRelationship:plannedEncounter.regionOfInterest
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
              426. Act.entryRelationship:plannedEncounter.substanceAdministration
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
              428. Act.entryRelationship:plannedEncounter.supply
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
              430. Act.entryRelationship:plannedProcedure
              Slice NameplannedProcedure
              Comments

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
              432. Act.entryRelationship:plannedProcedure.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
              434. Act.entryRelationship:plannedProcedure.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
              436. Act.entryRelationship:plannedProcedure.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
              438. Act.entryRelationship:plannedProcedure.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
              440. Act.entryRelationship:plannedProcedure.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
              442. Act.entryRelationship:plannedProcedure.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
              444. Act.entryRelationship:plannedProcedure.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
              446. Act.entryRelationship:plannedProcedure.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
              448. Act.entryRelationship:plannedProcedure.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
              450. Act.entryRelationship:plannedProcedure.typeCode
              Comments

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

              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
              452. Act.entryRelationship:plannedProcedure.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.
              454. Act.entryRelationship:plannedProcedure.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
              456. Act.entryRelationship:plannedProcedure.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.
              458. Act.entryRelationship:plannedProcedure.sequenceNumber
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
              460. Act.entryRelationship:plannedProcedure.seperatableInd
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
              462. Act.entryRelationship:plannedProcedure.act
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
              464. Act.entryRelationship:plannedProcedure.encounter
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
              466. Act.entryRelationship:plannedProcedure.observation
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
              468. Act.entryRelationship:plannedProcedure.observationMedia
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
              470. Act.entryRelationship:plannedProcedure.organizer
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
              472. Act.entryRelationship:plannedProcedure.procedure
              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] Planned Procedure (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.41:2014-06-09) (CONF:1198-32711).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure(Planned Procedure)
              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())
              474. Act.entryRelationship:plannedProcedure.regionOfInterest
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
              476. Act.entryRelationship:plannedProcedure.substanceAdministration
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
              478. Act.entryRelationship:plannedProcedure.supply
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
              480. Act.entryRelationship:plannedMedicationActivity
              Slice NameplannedMedicationActivity
              Comments

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
              482. Act.entryRelationship:plannedMedicationActivity.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
              484. Act.entryRelationship:plannedMedicationActivity.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
              486. Act.entryRelationship:plannedMedicationActivity.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
              488. Act.entryRelationship:plannedMedicationActivity.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
              490. Act.entryRelationship:plannedMedicationActivity.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
              492. Act.entryRelationship:plannedMedicationActivity.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
              494. Act.entryRelationship:plannedMedicationActivity.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
              496. Act.entryRelationship:plannedMedicationActivity.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
              498. Act.entryRelationship:plannedMedicationActivity.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
              500. Act.entryRelationship:plannedMedicationActivity.typeCode
              Comments

              SHALL contain exactly one [1..1] @typeCode="REFR" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-32712).

              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
              502. Act.entryRelationship:plannedMedicationActivity.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.
              504. Act.entryRelationship:plannedMedicationActivity.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
              506. Act.entryRelationship:plannedMedicationActivity.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.
              508. Act.entryRelationship:plannedMedicationActivity.sequenceNumber
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
              510. Act.entryRelationship:plannedMedicationActivity.seperatableInd
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
              512. Act.entryRelationship:plannedMedicationActivity.act
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
              514. Act.entryRelationship:plannedMedicationActivity.encounter
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
              516. Act.entryRelationship:plannedMedicationActivity.observation
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
              518. Act.entryRelationship:plannedMedicationActivity.observationMedia
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
              520. Act.entryRelationship:plannedMedicationActivity.organizer
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
              522. Act.entryRelationship:plannedMedicationActivity.procedure
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
              524. Act.entryRelationship:plannedMedicationActivity.regionOfInterest
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
              526. Act.entryRelationship:plannedMedicationActivity.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
              Comments

              SHALL contain exactly one [1..1] Planned Medication Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.42:2014-06-09) (CONF:1198-32713).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(Planned Medication Activity)
              Is Modifierfalse
              Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
              dose-unit-or-admin-unit: If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present. (doseQuantity.unit.exists() implies administrationUnitCode.empty())
              should-author: SHOULD contain author (author.exists())
              528. Act.entryRelationship:plannedMedicationActivity.supply
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
              530. Act.entryRelationship:plannedSupply
              Slice NameplannedSupply
              Comments

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
              532. Act.entryRelationship:plannedSupply.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
              534. Act.entryRelationship:plannedSupply.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
              536. Act.entryRelationship:plannedSupply.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
              538. Act.entryRelationship:plannedSupply.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
              540. Act.entryRelationship:plannedSupply.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
              542. Act.entryRelationship:plannedSupply.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
              544. Act.entryRelationship:plannedSupply.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
              546. Act.entryRelationship:plannedSupply.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
              548. Act.entryRelationship:plannedSupply.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
              550. Act.entryRelationship:plannedSupply.typeCode
              Comments

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

              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
              552. Act.entryRelationship:plannedSupply.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.
              554. Act.entryRelationship:plannedSupply.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
              556. Act.entryRelationship:plannedSupply.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.
              558. Act.entryRelationship:plannedSupply.sequenceNumber
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
              560. Act.entryRelationship:plannedSupply.seperatableInd
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
              562. Act.entryRelationship:plannedSupply.act
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
              564. Act.entryRelationship:plannedSupply.encounter
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
              566. Act.entryRelationship:plannedSupply.observation
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
              568. Act.entryRelationship:plannedSupply.observationMedia
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
              570. Act.entryRelationship:plannedSupply.organizer
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
              572. Act.entryRelationship:plannedSupply.procedure
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
              574. Act.entryRelationship:plannedSupply.regionOfInterest
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
              576. Act.entryRelationship:plannedSupply.substanceAdministration
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
              578. Act.entryRelationship:plannedSupply.supply
              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] Planned Supply (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.43:2014-06-09) (CONF:1198-32715).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply(Planned Supply)
              Is Modifierfalse
              Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
              should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
              shall-product-or-device: The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV') ((product | participant.where(typeCode='DEV')).count() = 1)
              should-author: SHOULD contain author (author.exists())
              580. Act.entryRelationship:nutritionRecommendation
              Slice NamenutritionRecommendation
              Comments

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
              582. Act.entryRelationship:nutritionRecommendation.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
              584. Act.entryRelationship:nutritionRecommendation.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
              586. Act.entryRelationship:nutritionRecommendation.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
              588. Act.entryRelationship:nutritionRecommendation.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
              590. Act.entryRelationship:nutritionRecommendation.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
              592. Act.entryRelationship:nutritionRecommendation.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
              594. Act.entryRelationship:nutritionRecommendation.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
              596. Act.entryRelationship:nutritionRecommendation.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
              598. Act.entryRelationship:nutritionRecommendation.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
              600. Act.entryRelationship:nutritionRecommendation.typeCode
              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
              602. Act.entryRelationship:nutritionRecommendation.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.
              604. Act.entryRelationship:nutritionRecommendation.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
              606. Act.entryRelationship:nutritionRecommendation.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.
              608. Act.entryRelationship:nutritionRecommendation.sequenceNumber
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
              610. Act.entryRelationship:nutritionRecommendation.seperatableInd
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
              612. Act.entryRelationship:nutritionRecommendation.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] Nutrition Recommendation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.130) (CONF:1198-32716).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Nutrition Recommendation)
              Is Modifierfalse
              Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
              should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
              614. Act.entryRelationship:nutritionRecommendation.encounter
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
              616. Act.entryRelationship:nutritionRecommendation.observation
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
              618. Act.entryRelationship:nutritionRecommendation.observationMedia
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
              620. Act.entryRelationship:nutritionRecommendation.organizer
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
              622. Act.entryRelationship:nutritionRecommendation.procedure
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
              624. Act.entryRelationship:nutritionRecommendation.regionOfInterest
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
              626. Act.entryRelationship:nutritionRecommendation.substanceAdministration
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
              628. Act.entryRelationship:nutritionRecommendation.supply
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
              630. Act.entryRelationship:entryReference
              Slice NameentryReference
              ShortWhere an Intervention needs to reference another entry already described in the CDA document instance, rather than repeating the full content of the entry, the Entry Reference template may be used to reference this entry.
              Comments

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
              632. Act.entryRelationship:entryReference.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
              634. Act.entryRelationship:entryReference.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
              636. Act.entryRelationship:entryReference.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
              638. Act.entryRelationship:entryReference.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
              640. Act.entryRelationship:entryReference.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
              642. Act.entryRelationship:entryReference.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
              644. Act.entryRelationship:entryReference.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
              646. Act.entryRelationship:entryReference.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
              648. Act.entryRelationship:entryReference.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
              650. Act.entryRelationship:entryReference.typeCode
              Comments

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

              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
              652. Act.entryRelationship:entryReference.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.
              654. Act.entryRelationship:entryReference.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
              656. Act.entryRelationship:entryReference.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.
              658. Act.entryRelationship:entryReference.sequenceNumber
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
              660. Act.entryRelationship:entryReference.seperatableInd
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
              662. Act.entryRelationship:entryReference.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] Entry Reference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.122) (CONF:1198-32718).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Entry Reference)
              Is Modifierfalse
              Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
              664. Act.entryRelationship:entryReference.encounter
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
              666. Act.entryRelationship:entryReference.observation
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
              668. Act.entryRelationship:entryReference.observationMedia
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
              670. Act.entryRelationship:entryReference.organizer
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
              672. Act.entryRelationship:entryReference.procedure
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
              674. Act.entryRelationship:entryReference.regionOfInterest
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
              676. Act.entryRelationship:entryReference.substanceAdministration
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
              678. Act.entryRelationship:entryReference.supply
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
              680. Act.entryRelationship:plannedImmunizationActivity
              Slice NameplannedImmunizationActivity
              Comments

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
              682. Act.entryRelationship:plannedImmunizationActivity.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
              684. Act.entryRelationship:plannedImmunizationActivity.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
              686. Act.entryRelationship:plannedImmunizationActivity.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
              688. Act.entryRelationship:plannedImmunizationActivity.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
              690. Act.entryRelationship:plannedImmunizationActivity.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
              692. Act.entryRelationship:plannedImmunizationActivity.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
              694. Act.entryRelationship:plannedImmunizationActivity.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
              696. Act.entryRelationship:plannedImmunizationActivity.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
              698. Act.entryRelationship:plannedImmunizationActivity.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
              700. Act.entryRelationship:plannedImmunizationActivity.typeCode
              Comments

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

              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
              702. Act.entryRelationship:plannedImmunizationActivity.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.
              704. Act.entryRelationship:plannedImmunizationActivity.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
              706. Act.entryRelationship:plannedImmunizationActivity.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.
              708. Act.entryRelationship:plannedImmunizationActivity.sequenceNumber
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
              710. Act.entryRelationship:plannedImmunizationActivity.seperatableInd
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
              712. Act.entryRelationship:plannedImmunizationActivity.act
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
              714. Act.entryRelationship:plannedImmunizationActivity.encounter
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
              716. Act.entryRelationship:plannedImmunizationActivity.observation
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
              718. Act.entryRelationship:plannedImmunizationActivity.observationMedia
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
              720. Act.entryRelationship:plannedImmunizationActivity.organizer
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
              722. Act.entryRelationship:plannedImmunizationActivity.procedure
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
              724. Act.entryRelationship:plannedImmunizationActivity.regionOfInterest
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
              726. Act.entryRelationship:plannedImmunizationActivity.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
              Comments

              SHALL contain exactly one [1..1] Planned Immunization Activity (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.120) (CONF:1198-32729).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(Planned Immunization Activity)
              Is Modifierfalse
              Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
              728. Act.entryRelationship:plannedImmunizationActivity.supply
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
              730. Act.reference
              Comments

              MAY contain zero or more [0..*] reference (CONF:1198-32766).

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
              732. Act.reference.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
              734. Act.reference.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
              736. Act.reference.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
              738. Act.reference.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
              740. Act.reference.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
              742. Act.reference.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
              744. Act.reference.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
              746. Act.reference.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
              748. Act.reference.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
              750. Act.reference.typeCode
              Comments

              The reference, if present, SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1198-32767).

              Control1..1
              BindingThe codes SHALL be taken from x_ActRelationshipExternalReference
              (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference)
              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
              752. Act.reference.seperatableInd
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
              754. Act.reference.externalAct
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ExternalAct
              756. Act.reference.externalObservation
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ExternalObservation
              758. Act.reference.externalProcedure
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ExternalProcedure
              760. Act.reference.externalDocument
              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

              The reference, if present, SHALL contain exactly one [1..1] External Document Reference (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.115:2014-06-09) (CONF:1198-32768).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ExternalDocument(External Document Reference)
              Is Modifierfalse
              Invariantsshould-setId: SHOULD contain setId (setId.exists())
              should-versionNumber: SHOULD contain versionNumber (versionNumber.exists())
              762. Act.precondition
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
              764. Act.sdtcPrecondition2
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition2
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameprecondition2.
              766. Act.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.