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: SubstanceAdministeredAct - Detailed Descriptions

Draft as of 2024-05-18

Definitions for the SubstanceAdministeredAct 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())
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
  • 4. Act.templateId:substance-administered-act
    Slice Namesubstance-administered-act
    Control1..1
    6. Act.templateId:substance-administered-act.root
    Control1..?
    Pattern Value2.16.840.1.113883.10.20.22.4.118
    8. Act.templateId:substance-administered-act.extension
    Control0..0
    10. Act.classCode
    Comments

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

    Fixed ValueACT
    12. Act.moodCode
    Comments

    SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31501).

    Fixed ValueEVN
    14. Act.id
    Comments

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

    Control1..?
    16. Act.code
    Comments

    SHALL contain exactly one [1..1] code (CONF:1098-31506).

    18. Act.code.code
    Comments

    This code SHALL contain exactly one [1..1] @code="416118004" Administration (CONF:1098-31507).

    Control1..?
    Pattern Value416118004
    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:1098-31508).

    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="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-31505).

    Control1..?
    28. Act.statusCode.code
    Comments

    SHALL contain exactly one [1..1] statusCode="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-31505).

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

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

    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())
    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
    • 4. Act.templateId:substance-administered-act
      Slice Namesubstance-administered-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:substance-administered-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.118
      8. Act.templateId:substance-administered-act.extension
      Definition

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

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

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

      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="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31501).

      Control1..1
      BindingThe codes SHALL be taken from XDocumentActMood (2.0.0)
      (required to http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|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 ValueEVN
      14. Act.id
      Comments

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

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

      SHALL contain exactly one [1..1] code (CONF:1098-31506).

      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="416118004" Administration (CONF:1098-31507).

      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 Value416118004
      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:1098-31508).

      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="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-31505).

      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

      SHALL contain exactly one [1..1] statusCode="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-31505).

      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 Valuecompleted
      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

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

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS

      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())
      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
      • 20. Act.templateId:substance-administered-act
        Slice Namesubstance-administered-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:substance-administered-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:substance-administered-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:substance-administered-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:substance-administered-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.118
        30. Act.templateId:substance-administered-act.extension
        Definition

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

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

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

        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="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31501).

        Control1..1
        BindingThe codes SHALL be taken from XDocumentActMood (2.0.0)
        (required to http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|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 ValueEVN
        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:1098-31504).

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

        SHALL contain exactly one [1..1] code (CONF:1098-31506).

        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="416118004" Administration (CONF:1098-31507).

        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 Value416118004
        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:1098-31508).

        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="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-31505).

        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

        SHALL contain exactly one [1..1] statusCode="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-31505).

        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 Valuecompleted
        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

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

        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
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
        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
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
        130. Act.reference
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
        132. Act.precondition
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
        134. 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.
        136. 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.