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

Draft as of 2024-05-18

Definitions for the AllergyIntoleranceObservation logical model.

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

0. Observation
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.
2. Observation.templateId
Control2..?
4. Observation.templateId:allergy
Slice Nameallergy
Control1..1
6. Observation.templateId:allergy.root
Control1..?
Pattern Value2.16.840.1.113883.10.20.22.4.7
8. Observation.templateId:allergy.extension
Control1..?
Pattern Value2014-06-09
10. Observation.negationInd
ShortUse negationInd="true" to indicate that the allergy was not observed.
Comments

MAY contain zero or one [0..1] @negationInd (CONF:1098-31526).

12. Observation.effectiveTime
ShortIf the allergy/intolerance is known to be resolved, but the date of resolution is not known, then the high element SHALL be present, and the nullFlavor attribute SHALL be set to 'UNK'.
14. Observation.participant:consumable
Slice Nameconsumable
16. Observation.participant:consumable.participantRole
18. Observation.participant:consumable.participantRole.playingEntity
20. Observation.participant:consumable.participantRole.playingEntity.code
Short(USCDI) Substance
BindingThe codes SHOULD be taken from Common substances for allergy and intolerance documentation including refutations .
(preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1186.8)

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

0. Observation
Definition

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


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-author: SHOULD contain author (author.exists())
should-not-severity: Allergy SHOULD NOT include severity. Severity belongs at reaction level, while Criticality is used at the allergy level. (entryRelationship.observation.where(code.code = 'SEV' and code.codeSystem = '2.16.840.1.113883.5.4').empty())
2. Observation.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

Control2..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
SlicingThis element introduces a set of slices on Observation.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
  • 4. Observation.templateId:substance-device-allergy-intolerance-obs
    Slice Namesubstance-device-allergy-intolerance-obs
    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. Observation.templateId:substance-device-allergy-intolerance-obs.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.24.3.90
    8. Observation.templateId:substance-device-allergy-intolerance-obs.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 Value2014-06-09
    10. Observation.templateId:allergy
    Slice Nameallergy
    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
    12. Observation.templateId:allergy.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.7
    14. Observation.templateId:allergy.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 Value2014-06-09
    16. Observation.classCode
    Comments

    SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-16303).

    Control1..1
    BindingThe codes SHALL be taken from CDAActClassObservation
    (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation)
    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 ValueOBS
    18. Observation.moodCode
    Comments

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

    Control1..1
    BindingThe codes SHALL be taken from XActMoodDocumentObservation (2.0.0)
    (required to http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|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
    20. Observation.negationInd
    ShortUse negationInd="true" to indicate that the allergy was not observed.
    Comments

    MAY contain zero or one [0..1] @negationInd (CONF:1098-31526).

    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.
    22. Observation.id
    Definition

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

    ShortLogical id of this artifact
    Comments

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


    Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

    Control10..*1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/IIid
    Is Modifierfalse
    24. Observation.code
    Definition

    Describes what was observed. Sometimes this is called the observation "name".

    ShortType of observation (code / type)
    Comments

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


    All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

    Control1..1
    This element is affected by the following invariants: obs-7
    BindingFor example codes, see ObservationTypehttp://hl7.org/fhir/ValueSet/observation-codes
    (example to http://terminology.hl7.org/ValueSet/v3-ObservationType)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CDCodeableConcept
    Is Modifierfalse
    XML FormatThe type of this property is determined using the " xsi:typeattribute.
    Requirements

    Knowing what kind of observation is being made is essential to understanding the observation.

    Alternate NamesName
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. Observation.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="ASSERTION" Assertion (CONF:1098-16346).

    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 ValueASSERTION
    28. Observation.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.5.4" (CodeSystem: HL7ActCode urn:oid:2.16.840.1.113883.5.4) (CONF:1098-32171).

    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.5.4
    30. Observation.statusCode
    Comments

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

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

    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
    34. Observation.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
    36. Observation.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
    38. Observation.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
    40. Observation.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
    42. Observation.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
    44. Observation.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
    46. Observation.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
    48. Observation.effectiveTime
    ShortIf the allergy/intolerance is known to be resolved, but the date of resolution is not known, then the high element SHALL be present, and the nullFlavor attribute SHALL be set to 'UNK'.
    Comments

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

    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
    50. Observation.effectiveTime.low
    Definition

    This is the low limit of the interval.

    Comments

    This effectiveTime SHALL contain exactly one [1..1] low (CONF:1098-31536).

    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
    LabelLow Boundary
    52. Observation.value
    Comments

    SHALL contain exactly one [1..1] value with @xsi:type="CD" (CONF:1098-16312).

    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
    XML FormatThe type of this property is determined using the " xsi:typeattribute.
    54. Observation.value.nullFlavor
    Definition

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

    Control0..0
    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
    56. Observation.value.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.

    Control1..1
    BindingThe codes SHALL be taken from Allergy and Intolerance Type .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.6.2)
    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
    58. Observation.participant
    Comments

    SHOULD contain zero or more [0..*] participant (CONF:1098-16318) such that it

    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
    SlicingThis element introduces a set of slices on Observation.participant. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ typeCode
    • 60. Observation.participant:consumable
      Slice Nameconsumable
      Shortparticipant
      Control0..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
      62. Observation.participant:consumable.typeCode
      Comments

      SHALL contain exactly one [1..1] @typeCode="CSM" Consumable (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1098-16319).

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

      SHALL contain exactly one [1..1] participantRole (CONF:1098-16320).

      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole
      66. Observation.participant:consumable.participantRole.classCode
      Comments

      This participantRole SHALL contain exactly one [1..1] @classCode="MANU" Manufactured Product (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:1098-16321).

      Control1..1
      BindingThe codes SHALL be taken from CDARoleClassRoot
      (required to http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      Default ValueROL
      Fixed ValueMANU
      68. Observation.participant:consumable.participantRole.playingEntity
      Comments

      This participantRole SHALL contain exactly one [1..1] playingEntity (CONF:1098-16322).

      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity
      70. Observation.participant:consumable.participantRole.playingEntity.classCode
      Comments

      This playingEntity SHALL contain exactly one [1..1] @classCode="MMAT" Manufactured Material (CodeSystem: HL7EntityClass urn:oid:2.16.840.1.113883.5.41 STATIC) (CONF:1098-16323).

      Control1..1
      BindingThe codes SHALL be taken from EntityClassRoot
      (required to http://terminology.hl7.org/ValueSet/v3-EntityClassRoot)
      Typecode(cs: Coded Simple Value)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      Default ValueENT
      Fixed ValueMMAT
      72. Observation.participant:consumable.participantRole.playingEntity.code
      Short(USCDI) Substance
      Comments

      This playingEntity SHALL contain exactly one [1..1] code, which MAY be selected from ValueSet Substance Reactant for Intolerance urn:oid:2.16.840.1.113762.1.4.1010.1 DYNAMIC (CONF:1098-16324).

      Control1..1
      BindingThe codes SHOULD be taken from Common substances for allergy and intolerance documentation including refutations .
      (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1186.8)
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
      74. Observation.entryRelationship
      Comments

      SHOULD contain zero or one [0..1] entryRelationship (CONF:1098-32935) such that it

      Control0..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
      SlicingThis element introduces a set of slices on Observation.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • profile @ observation
      • 76. Observation.entryRelationship:status
        Slice Namestatus
        ShortentryRelationship
        Comments

        MAY contain zero or one [0..1] entryRelationship (CONF:1098-16333) such that it

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
        78. Observation.entryRelationship:status.typeCode
        Comments

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

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

        Comments

        SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-16334).

        Control1..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.
        Fixed Valuetrue
        82. Observation.entryRelationship:status.observation
        Definition

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

        ShortBase for all types and resources
        Comments

        SHALL contain exactly one [1..1] Allergy Status Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.28:2019-06-20) (CONF:1098-16336).

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Allergy Status Observation)
        Is Modifierfalse
        Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
        84. Observation.entryRelationship:reaction
        Slice Namereaction
        ShortentryRelationship
        Comments

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
        86. Observation.entryRelationship:reaction.typeCode
        Comments

        SHALL contain exactly one [1..1] @typeCode="MFST" Is Manifestation of (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-16339).

        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 ValueMFST
        88. Observation.entryRelationship:reaction.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.

        Comments

        SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-16338).

        Control1..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.
        Fixed Valuetrue
        90. Observation.entryRelationship:reaction.observation
        Definition

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

        ShortBase for all types and resources
        Comments

        SHALL contain exactly one [1..1] Reaction Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.9:2014-06-09) (CONF:1098-16340).

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Reaction Observation)
        Is Modifierfalse
        Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
        should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
        92. Observation.entryRelationship:severity
        Slice Nameseverity
        ShortentryRelationship
        Comments

        SHOULD NOT contain zero or one [0..1] entryRelationship (CONF:1098-16341) such that it

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
        94. Observation.entryRelationship:severity.typeCode
        Comments

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

        Control1..1
        BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
        (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueSUBJ
        96. Observation.entryRelationship:severity.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.

        Comments

        SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-16343).

        Control1..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.
        Fixed Valuetrue
        98. Observation.entryRelationship:severity.observation
        Definition

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

        ShortBase for all types and resources
        Comments

        SHALL contain exactly one [1..1] Severity Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.8:2014-06-09) (CONF:1098-16344).

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Severity Observation)
        Is Modifierfalse
        Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
        100. Observation.entryRelationship:criticality
        Slice Namecriticality
        ShortentryRelationship
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
        102. Observation.entryRelationship:criticality.typeCode
        Comments

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

        Control1..1
        BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
        (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueSUBJ
        104. Observation.entryRelationship:criticality.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.

        Comments

        SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-32937).

        Control1..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.
        Fixed Valuetrue
        106. Observation.entryRelationship:criticality.observation
        Definition

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

        ShortBase for all types and resources
        Comments

        SHALL contain exactly one [1..1] Criticality Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.145) (CONF:1098-32938).

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Criticality Observation)
        Is Modifierfalse
        Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())

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

        0. Observation
        Definition

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

        ShortBase for all types and resources
        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-author: SHOULD contain author (author.exists())
        should-not-severity: Allergy SHOULD NOT include severity. Severity belongs at reaction level, while Criticality is used at the allergy level. (entryRelationship.observation.where(code.code = 'SEV' and code.codeSystem = '2.16.840.1.113883.5.4').empty())
        2. Observation.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. Observation.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. Observation.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. Observation.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. Observation.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. Observation.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. Observation.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. Observation.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. Observation.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

        Control2..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        SlicingThis element introduces a set of slices on Observation.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ root
        • value @ extension
        • 20. Observation.templateId:substance-device-allergy-intolerance-obs
          Slice Namesubstance-device-allergy-intolerance-obs
          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. Observation.templateId:substance-device-allergy-intolerance-obs.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. Observation.templateId:substance-device-allergy-intolerance-obs.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. Observation.templateId:substance-device-allergy-intolerance-obs.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. Observation.templateId:substance-device-allergy-intolerance-obs.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.24.3.90
          30. Observation.templateId:substance-device-allergy-intolerance-obs.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 Value2014-06-09
          32. Observation.templateId:allergy
          Slice Nameallergy
          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
          34. Observation.templateId:allergy.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
          36. Observation.templateId:allergy.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
          38. Observation.templateId:allergy.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
          40. Observation.templateId:allergy.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.7
          42. Observation.templateId:allergy.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 Value2014-06-09
          44. Observation.classCode
          Comments

          SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-16303).

          Control1..1
          BindingThe codes SHALL be taken from CDAActClassObservation
          (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation)
          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 ValueOBS
          46. Observation.moodCode
          Comments

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

          Control1..1
          BindingThe codes SHALL be taken from XActMoodDocumentObservation (2.0.0)
          (required to http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|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
          48. Observation.negationInd
          ShortUse negationInd="true" to indicate that the allergy was not observed.
          Comments

          MAY contain zero or one [0..1] @negationInd (CONF:1098-31526).

          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.
          50. Observation.id
          Comments

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

          Control1..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
          52. Observation.code
          Comments

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

          Control1..1
          BindingFor example codes, see ObservationType
          (example to http://terminology.hl7.org/ValueSet/v3-ObservationType)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
          XML FormatThe type of this property is determined using the " xsi:typeattribute.
          54. Observation.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
          56. Observation.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="ASSERTION" Assertion (CONF:1098-16346).

          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 ValueASSERTION
          58. Observation.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.5.4" (CodeSystem: HL7ActCode urn:oid:2.16.840.1.113883.5.4) (CONF:1098-32171).

          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.5.4
          60. Observation.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
          62. Observation.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
          64. Observation.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
          66. Observation.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.
          68. Observation.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.
          70. Observation.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
          72. Observation.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
          74. Observation.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
          76. Observation.derivationExpr
          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ST
          78. Observation.text
          ShortSHOULD reference the portion of section narrative text corresponding to this entry
          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
          XML FormatThe type of this property is determined using the " xsi:typeattribute.
          80. Observation.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
          82. Observation.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
          84. Observation.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
          86. Observation.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
          88. Observation.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
          90. Observation.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
          92. Observation.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.
          94. Observation.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.
          96. Observation.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('#'))
          98. Observation.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
          100. Observation.statusCode
          Comments

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

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

          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
          106. Observation.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
          108. Observation.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
          110. Observation.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
          112. Observation.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
          114. Observation.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.
          116. Observation.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.
          118. Observation.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
          120. Observation.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
          122. Observation.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
          124. Observation.effectiveTime
          ShortIf the allergy/intolerance is known to be resolved, but the date of resolution is not known, then the high element SHALL be present, and the nullFlavor attribute SHALL be set to 'UNK'.
          Comments

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

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
          126. Observation.effectiveTime.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
          128. Observation.effectiveTime.value
          Definition

          A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

          Control0..1
          TypedateTime(ts: Point in Time)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Date FormatYYYYMMDDHHMMSS.UUUU[+|-ZZzz]
          XML FormatIn the XML format, this property is represented as an attribute.
          130. Observation.effectiveTime.operator
          Definition

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

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

          This is the low limit of the interval.

          Comments

          This effectiveTime SHALL contain exactly one [1..1] low (CONF:1098-31536).

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
          LabelLow Boundary
          134. Observation.effectiveTime.center
          Definition

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

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
          LabelCentral Value
          136. Observation.effectiveTime.width
          Definition

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

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

          This is the high limit of the interval.

          Comments

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

          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
          LabelHigh Boundary
          140. Observation.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
          142. Observation.repeatNumber
          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
          144. Observation.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
          146. Observation.value
          Comments

          SHALL contain exactly one [1..1] value with @xsi:type="CD" (CONF:1098-16312).

          Control1..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
          XML FormatThe type of this property is determined using the " xsi:typeattribute.
          148. Observation.value.nullFlavor
          Definition

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

          Control0..0
          BindingThe codes SHALL be taken from CDANullFlavor
          (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
          Typecode(cs: Coded Simple Value)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelExceptional Value Detail
          150. Observation.value.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.

          Control1..1
          BindingThe codes SHALL be taken from Allergy and Intolerance Type .
          (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.6.2)
          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
          152. Observation.value.codeSystem
          Definition

          Specifies the code system that defines the code.

          Control0..1
          Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          LabelCode System
          154. Observation.value.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
          156. Observation.value.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
          158. Observation.value.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
          160. Observation.value.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.
          162. Observation.value.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.
          164. Observation.value.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
          166. Observation.value.qualifier
          Definition

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

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
          LabelQualifier
          168. Observation.value.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
          170. Observation.interpretationCode
          Control0..*
          BindingThe codes SHALL be taken from CDAObservationInterpretation
          (required to http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
          172. Observation.methodCode
          Control0..*
          BindingFor example codes, see ObservationMethod
          (example to http://terminology.hl7.org/ValueSet/v3-ObservationMethod)
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
          174. Observation.targetSiteCode
          Definition

          Drawn from concept domain ActSite

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
          176. Observation.subject
          Control0..1
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
          178. Observation.specimen
          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
          180. Observation.performer
          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
          182. Observation.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:1098-31144).

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
          Is Modifierfalse
          184. Observation.informant
          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
          186. Observation.participant
          Comments

          SHOULD contain zero or more [0..*] participant (CONF:1098-16318) such that it

          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
          SlicingThis element introduces a set of slices on Observation.participant. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ typeCode
          • 188. Observation.participant:consumable
            Slice Nameconsumable
            Shortparticipant
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
            190. Observation.participant:consumable.nullFlavor
            Definition

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

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

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

            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
            194. Observation.participant:consumable.typeId
            Definition

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

            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
            196. Observation.participant:consumable.typeId.nullFlavor
            Definition

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

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

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

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

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

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

            Identifies the type as an HL7 Registered model

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

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

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

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

            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
            208. Observation.participant:consumable.typeCode
            Comments

            SHALL contain exactly one [1..1] @typeCode="CSM" Consumable (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1098-16319).

            Control1..1
            BindingThe codes SHALL be taken from CDAParticipationType
            (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed ValueCSM
            210. Observation.participant:consumable.contextControlCode
            Control0..1
            BindingThe codes SHALL be taken from CDAContextControl
            (required to http://hl7.org/cda/stds/core/ValueSet/CDAContextControl)
            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 ValueOP
            212. Observation.participant:consumable.sdtcFunctionCode
            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
            XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namefunctionCode.
            214. Observation.participant:consumable.time
            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
            216. Observation.participant:consumable.awarenessCode
            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
            218. Observation.participant:consumable.participantRole
            Comments

            SHALL contain exactly one [1..1] participantRole (CONF:1098-16320).

            Control1..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole
            220. Observation.participant:consumable.participantRole.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
            222. Observation.participant:consumable.participantRole.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
            224. Observation.participant:consumable.participantRole.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
            226. Observation.participant:consumable.participantRole.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
            228. Observation.participant:consumable.participantRole.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
            230. Observation.participant:consumable.participantRole.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
            232. Observation.participant:consumable.participantRole.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
            234. Observation.participant:consumable.participantRole.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
            236. Observation.participant:consumable.participantRole.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
            238. Observation.participant:consumable.participantRole.classCode
            Comments

            This participantRole SHALL contain exactly one [1..1] @classCode="MANU" Manufactured Product (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:1098-16321).

            Control1..1
            BindingThe codes SHALL be taken from CDARoleClassRoot
            (required to http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Default ValueROL
            Fixed ValueMANU
            240. Observation.participant:consumable.participantRole.id
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
            242. Observation.participant:consumable.participantRole.sdtcIdentifiedBy
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
            XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
            244. Observation.participant:consumable.participantRole.code
            Control0..1
            BindingFor example codes, see CDARoleCode
            (example to http://hl7.org/cda/stds/core/ValueSet/CDARoleCode)
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
            246. Observation.participant:consumable.participantRole.addr
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
            248. Observation.participant:consumable.participantRole.telecom
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
            250. Observation.participant:consumable.participantRole.playingDevice
            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Device
            252. Observation.participant:consumable.participantRole.playingEntity
            Comments

            This participantRole SHALL contain exactly one [1..1] playingEntity (CONF:1098-16322).

            Control1..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity
            254. Observation.participant:consumable.participantRole.playingEntity.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
            256. Observation.participant:consumable.participantRole.playingEntity.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
            258. Observation.participant:consumable.participantRole.playingEntity.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
            260. Observation.participant:consumable.participantRole.playingEntity.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
            262. Observation.participant:consumable.participantRole.playingEntity.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
            264. Observation.participant:consumable.participantRole.playingEntity.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
            266. Observation.participant:consumable.participantRole.playingEntity.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
            268. Observation.participant:consumable.participantRole.playingEntity.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
            270. Observation.participant:consumable.participantRole.playingEntity.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
            272. Observation.participant:consumable.participantRole.playingEntity.classCode
            Comments

            This playingEntity SHALL contain exactly one [1..1] @classCode="MMAT" Manufactured Material (CodeSystem: HL7EntityClass urn:oid:2.16.840.1.113883.5.41 STATIC) (CONF:1098-16323).

            Control1..1
            BindingThe codes SHALL be taken from EntityClassRoot
            (required to http://terminology.hl7.org/ValueSet/v3-EntityClassRoot)
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Default ValueENT
            Fixed ValueMMAT
            274. Observation.participant:consumable.participantRole.playingEntity.determinerCode
            Control0..1
            BindingThe codes SHALL be taken from EntityDeterminer
            (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
            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 ValueINSTANCE
            276. Observation.participant:consumable.participantRole.playingEntity.code
            Short(USCDI) Substance
            Comments

            This playingEntity SHALL contain exactly one [1..1] code, which MAY be selected from ValueSet Substance Reactant for Intolerance urn:oid:2.16.840.1.113762.1.4.1010.1 DYNAMIC (CONF:1098-16324).

            Control1..1
            BindingThe codes SHOULD be taken from Common substances for allergy and intolerance documentation including refutations .
            (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1186.8)
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
            278. Observation.participant:consumable.participantRole.playingEntity.quantity
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
            280. Observation.participant:consumable.participantRole.playingEntity.name
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN
            282. Observation.participant:consumable.participantRole.playingEntity.sdtcBirthTime
            Definition

            The purpose of this extension is to allow the recording of the subscriber or member of a health plan in cases where the health plan eligibility system has different information on file than the provider does for the patient.

            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
            XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namebirthTime.
            284. Observation.participant:consumable.participantRole.playingEntity.desc
            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
            286. Observation.participant:consumable.participantRole.scopingEntity
            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Entity
            288. Observation.entryRelationship
            Comments

            SHOULD contain zero or one [0..1] entryRelationship (CONF:1098-32935) such that it

            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
            SlicingThis element introduces a set of slices on Observation.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • profile @ observation
            • 290. Observation.entryRelationship:status
              Slice Namestatus
              ShortentryRelationship
              Comments

              MAY contain zero or one [0..1] entryRelationship (CONF:1098-16333) such that it

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
              292. Observation.entryRelationship:status.nullFlavor
              Definition

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

              Control0..1
              BindingThe codes SHALL be taken from CDANullFlavor
              (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              LabelExceptional Value Detail
              294. Observation.entryRelationship:status.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
              296. Observation.entryRelationship:status.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
              298. Observation.entryRelationship:status.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
              300. Observation.entryRelationship:status.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
              302. Observation.entryRelationship:status.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
              304. Observation.entryRelationship:status.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
              306. Observation.entryRelationship:status.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
              308. Observation.entryRelationship:status.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
              310. Observation.entryRelationship:status.typeCode
              Comments

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

              Control1..1
              BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
              (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueSUBJ
              312. Observation.entryRelationship:status.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.

              Comments

              SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-16334).

              Control1..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.
              Fixed Valuetrue
              314. Observation.entryRelationship:status.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
              316. Observation.entryRelationship:status.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.
              318. Observation.entryRelationship:status.sequenceNumber
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
              320. Observation.entryRelationship:status.seperatableInd
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
              322. Observation.entryRelationship:status.act
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
              324. Observation.entryRelationship:status.encounter
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
              326. Observation.entryRelationship:status.observation
              Definition

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

              ShortBase for all types and resources
              Comments

              SHALL contain exactly one [1..1] Allergy Status Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.28:2019-06-20) (CONF:1098-16336).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Allergy Status Observation)
              Is Modifierfalse
              Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
              328. Observation.entryRelationship:status.observationMedia
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
              330. Observation.entryRelationship:status.organizer
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
              332. Observation.entryRelationship:status.procedure
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
              334. Observation.entryRelationship:status.regionOfInterest
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
              336. Observation.entryRelationship:status.substanceAdministration
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
              338. Observation.entryRelationship:status.supply
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
              340. Observation.entryRelationship:reaction
              Slice Namereaction
              ShortentryRelationship
              Comments

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

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
              342. Observation.entryRelationship:reaction.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
              344. Observation.entryRelationship:reaction.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
              346. Observation.entryRelationship:reaction.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
              348. Observation.entryRelationship:reaction.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
              350. Observation.entryRelationship:reaction.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
              352. Observation.entryRelationship:reaction.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
              354. Observation.entryRelationship:reaction.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
              356. Observation.entryRelationship:reaction.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
              358. Observation.entryRelationship:reaction.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
              360. Observation.entryRelationship:reaction.typeCode
              Comments

              SHALL contain exactly one [1..1] @typeCode="MFST" Is Manifestation of (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-16339).

              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 ValueMFST
              362. Observation.entryRelationship:reaction.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.

              Comments

              SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-16338).

              Control1..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.
              Fixed Valuetrue
              364. Observation.entryRelationship:reaction.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
              366. Observation.entryRelationship:reaction.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.
              368. Observation.entryRelationship:reaction.sequenceNumber
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
              370. Observation.entryRelationship:reaction.seperatableInd
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
              372. Observation.entryRelationship:reaction.act
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
              374. Observation.entryRelationship:reaction.encounter
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
              376. Observation.entryRelationship:reaction.observation
              Definition

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

              ShortBase for all types and resources
              Comments

              SHALL contain exactly one [1..1] Reaction Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.9:2014-06-09) (CONF:1098-16340).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Reaction Observation)
              Is Modifierfalse
              Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
              should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
              378. Observation.entryRelationship:reaction.observationMedia
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
              380. Observation.entryRelationship:reaction.organizer
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
              382. Observation.entryRelationship:reaction.procedure
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
              384. Observation.entryRelationship:reaction.regionOfInterest
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
              386. Observation.entryRelationship:reaction.substanceAdministration
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
              388. Observation.entryRelationship:reaction.supply
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
              390. Observation.entryRelationship:severity
              Slice Nameseverity
              ShortentryRelationship
              Comments

              SHOULD NOT contain zero or one [0..1] entryRelationship (CONF:1098-16341) such that it

              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
              392. Observation.entryRelationship:severity.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
              394. Observation.entryRelationship:severity.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
              396. Observation.entryRelationship:severity.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
              398. Observation.entryRelationship:severity.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
              400. Observation.entryRelationship:severity.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
              402. Observation.entryRelationship:severity.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
              404. Observation.entryRelationship:severity.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
              406. Observation.entryRelationship:severity.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
              408. Observation.entryRelationship:severity.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
              410. Observation.entryRelationship:severity.typeCode
              Comments

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

              Control1..1
              BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
              (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueSUBJ
              412. Observation.entryRelationship:severity.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.

              Comments

              SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-16343).

              Control1..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.
              Fixed Valuetrue
              414. Observation.entryRelationship:severity.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
              416. Observation.entryRelationship:severity.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.
              418. Observation.entryRelationship:severity.sequenceNumber
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
              420. Observation.entryRelationship:severity.seperatableInd
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
              422. Observation.entryRelationship:severity.act
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
              424. Observation.entryRelationship:severity.encounter
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
              426. Observation.entryRelationship:severity.observation
              Definition

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

              ShortBase for all types and resources
              Comments

              SHALL contain exactly one [1..1] Severity Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.8:2014-06-09) (CONF:1098-16344).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Severity Observation)
              Is Modifierfalse
              Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
              428. Observation.entryRelationship:severity.observationMedia
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
              430. Observation.entryRelationship:severity.organizer
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
              432. Observation.entryRelationship:severity.procedure
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
              434. Observation.entryRelationship:severity.regionOfInterest
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
              436. Observation.entryRelationship:severity.substanceAdministration
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
              438. Observation.entryRelationship:severity.supply
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
              440. Observation.entryRelationship:criticality
              Slice Namecriticality
              ShortentryRelationship
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
              442. Observation.entryRelationship:criticality.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
              444. Observation.entryRelationship:criticality.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
              446. Observation.entryRelationship:criticality.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
              448. Observation.entryRelationship:criticality.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
              450. Observation.entryRelationship:criticality.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
              452. Observation.entryRelationship:criticality.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
              454. Observation.entryRelationship:criticality.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
              456. Observation.entryRelationship:criticality.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
              458. Observation.entryRelationship:criticality.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
              460. Observation.entryRelationship:criticality.typeCode
              Comments

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

              Control1..1
              BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
              (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueSUBJ
              462. Observation.entryRelationship:criticality.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.

              Comments

              SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-32937).

              Control1..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.
              Fixed Valuetrue
              464. Observation.entryRelationship:criticality.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
              466. Observation.entryRelationship:criticality.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.
              468. Observation.entryRelationship:criticality.sequenceNumber
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
              470. Observation.entryRelationship:criticality.seperatableInd
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
              472. Observation.entryRelationship:criticality.act
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
              474. Observation.entryRelationship:criticality.encounter
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
              476. Observation.entryRelationship:criticality.observation
              Definition

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

              ShortBase for all types and resources
              Comments

              SHALL contain exactly one [1..1] Criticality Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.145) (CONF:1098-32938).

              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Criticality Observation)
              Is Modifierfalse
              Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
              478. Observation.entryRelationship:criticality.observationMedia
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
              480. Observation.entryRelationship:criticality.organizer
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
              482. Observation.entryRelationship:criticality.procedure
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
              484. Observation.entryRelationship:criticality.regionOfInterest
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
              486. Observation.entryRelationship:criticality.substanceAdministration
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
              488. Observation.entryRelationship:criticality.supply
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
              490. Observation.reference
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
              492. Observation.precondition
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
              494. Observation.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.
              496. Observation.referenceRange
              Definition

              Relates an Observation to the ObservationRange class, where the expected range of values for a particular observation can be specified.

              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
              498. Observation.referenceRange.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
              500. Observation.referenceRange.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
              502. Observation.referenceRange.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
              504. Observation.referenceRange.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
              506. Observation.referenceRange.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
              508. Observation.referenceRange.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
              510. Observation.referenceRange.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
              512. Observation.referenceRange.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
              514. Observation.referenceRange.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
              516. Observation.referenceRange.typeCode
              Control0..1
              BindingThe codes SHALL be taken from CDAActRelationshipType
              (required to http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType)
              Typecode(cs: Coded Simple Value)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed ValueREFV
              518. Observation.referenceRange.observationRange
              Control1..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationRange
              520. Observation.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.