International Patient Summary (IPS)
1.1.0-ballot - CI Build

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

Logical Model: IPSAllergyAndIntoleranceConcern - Detailed Descriptions

Draft as of 2024-08-04

Definitions for the 2.16.840.1.113883.10.22.4.5--20240804100924 logical model.

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

0. Act
Control0..*
Must Supporttrue
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. Act.templateId
Control1..?
SlicingThis element introduces a set of slices on Act.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
  • 4. Act.templateId:primary
    Slice Nameprimary
    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
    Must Supporttrue
    6. Act.templateId:primary.root
    Control1..1
    Typestring
    Primitive ValueThis 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 Value2.16.840.1.113883.10.22.4.5
    8. Act.classCode
    Control1..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueACT
    10. Act.moodCode
    Control1..1
    Typecode
    Primitive ValueThis 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
    12. Act.id
    Control0..*
    Must Supporttrue
    14. Act.code
    Control1..1
    Must Supporttrue
    16. Act.code.code
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueCONC
    18. Act.code.codeSystem
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Value2.16.840.1.113883.5.6
    20. Act.statusCode
    Definition

    As long as the underlying conditions are of concern to the author (i.e., as long as allergies, whether active or resolved, is of ongoing concern and interest to the author), the statusCode is “ active ”. The concern is tracked by the author.

    Only when the underlying allergies are no longer of concern then the statusCode is set to “ completed ”. The author is no more tracking this concern and no further actions are expected.

    Control1..1
    BindingThe codes SHALL be taken from x_ActStatusActiveComplete
    (required to http://terminology.hl7.org/ValueSet/v3-xActStatusActiveComplete)

    x_ActStatusActiveComplete

    Must Supporttrue
    22. Act.effectiveTime
    Control1..1
    Must Supporttrue
    24. Act.effectiveTime.low
    Definition

    This element asserts when the concern became active. This equates to the time the concern was authored in the patient's chart and the author started tracking this concern.

    Control1..1
    Must Supporttrue
    26. Act.effectiveTime.high
    Definition

    This element asserts when the clinician deemed there is no longer any need to track the underlying conditions.If statusCode/@code="completed" Completed, then effectiveTime SHALL contain [1..1] high

    Control0..1
    This element is affected by the following invariants: MD1557037N1l27l352l30l19l10l12
    InvariantsMD1557037N1l27l352l30l19l10l12: If statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high ()
    28. Act.entryRelationship
    Control1..?
    SlicingThis element introduces a set of slices on Act.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ resolve()
    • 30. Act.entryRelationship:entryRelationship-1
      Slice NameentryRelationship-1
      Control1..*
      Must Supporttrue
      InvariantsentryRelationship-1: contains IPS Allergy or Intolerance 2.16.840.1.113883.10.22.4.1 (2024-08-04) ()
      32. Act.entryRelationship:entryRelationship-1.typeCode
      Control1..1
      Typecode
      Primitive ValueThis 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
      34. Act.entryRelationship:entryRelationship-1.inversionInd
      Control0..1
      Typeboolean
      Primitive ValueThis 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 Valuefalse
      36. Act.entryRelationship:entryRelationship-1.observation
      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(IPS Allergy or Intolerance)
      Must Supporttrue

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

      0. Act
      Definition

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

      ShortBase for all types and resources
      Control0..*
      Is Modifierfalse
      Must Supporttrue
      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. Act.templateId
      Definition

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

      Control1..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
      SlicingThis element introduces a set of slices on Act.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ root
      • value @ extension
      • 4. Act.templateId:primary
        Slice Nameprimary
        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
        Must Supporttrue
        6. Act.templateId:primary.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
        Primitive ValueThis 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.10.22.4.5
        8. Act.classCode
        Control1..1
        BindingThe codes SHALL be taken from XActClassDocumentEntryAct (2.0.0)
        (required to http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0)
        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueACT
        10. Act.moodCode
        Control1..1
        BindingThe codes SHALL be taken from XDocumentActMood (2.0.0)
        (required to http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0)
        Typecode
        Primitive ValueThis 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
        12. Act.id
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        Must Supporttrue
        14. Act.code
        Control1..1
        BindingFor example codes, see v3 Code System ActCode
        (example to http://terminology.hl7.org/ValueSet/v3-ActCode)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
        Must Supporttrue
        16. Act.code.code
        Definition

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

        Control0..1
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        LabelCode
        Fixed ValueCONC
        18. Act.code.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
        Fixed Value2.16.840.1.113883.5.6
        20. Act.statusCode
        Definition

        As long as the underlying conditions are of concern to the author (i.e., as long as allergies, whether active or resolved, is of ongoing concern and interest to the author), the statusCode is “ active ”. The concern is tracked by the author.

        Only when the underlying allergies are no longer of concern then the statusCode is set to “ completed ”. The author is no more tracking this concern and no further actions are expected.

        Control1..1
        BindingThe codes SHALL be taken from x_ActStatusActiveComplete
        (required to http://terminology.hl7.org/ValueSet/v3-xActStatusActiveComplete)

        x_ActStatusActiveComplete

        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
        Must Supporttrue
        22. Act.effectiveTime
        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
        Must Supporttrue
        24. Act.effectiveTime.low
        Definition

        This element asserts when the concern became active. This equates to the time the concern was authored in the patient's chart and the author started tracking this concern.

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
        Must Supporttrue
        LabelLow Boundary
        26. Act.effectiveTime.high
        Definition

        This element asserts when the clinician deemed there is no longer any need to track the underlying conditions.If statusCode/@code="completed" Completed, then effectiveTime SHALL contain [1..1] high

        Control0..1
        This element is affected by the following invariants: MD1557037N1l27l352l30l19l10l12
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
        LabelHigh Boundary
        InvariantsMD1557037N1l27l352l30l19l10l12: If statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high ()
        28. Act.entryRelationship
        Control1..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
        SlicingThis element introduces a set of slices on Act.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ resolve()
        • 30. Act.entryRelationship:entryRelationship-1
          Slice NameentryRelationship-1
          Control1..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
          Must Supporttrue
          InvariantsentryRelationship-1: contains IPS Allergy or Intolerance 2.16.840.1.113883.10.22.4.1 (2024-08-04) ()
          32. Act.entryRelationship:entryRelationship-1.typeCode
          Control1..1
          BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
          (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship)
          Typecode
          Primitive ValueThis 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
          34. Act.entryRelationship:entryRelationship-1.inversionInd
          Definition

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

          Control0..1
          Typeboolean
          Primitive ValueThis 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 Valuefalse
          36. Act.entryRelationship:entryRelationship-1.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
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(IPS Allergy or Intolerance)
          Is Modifierfalse
          Must Supporttrue

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

          0. Act
          Definition

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

          ShortBase for all types and resources
          Control0..*
          Is Modifierfalse
          Must Supporttrue
          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. Act.nullFlavor
          Definition

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

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

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

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

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

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

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

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

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

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

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

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

          Identifies the type as an HL7 Registered model

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

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

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

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

          Control1..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
          SlicingThis element introduces a set of slices on Act.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ root
          • value @ extension
          • 20. Act.templateId:primary
            Slice Nameprimary
            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
            Must Supporttrue
            22. Act.templateId:primary.nullFlavor
            Definition

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

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

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

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

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

            Control0..1
            Typeboolean(bl: Boolean)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelDisplayable
            28. Act.templateId:primary.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
            Primitive ValueThis 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.10.22.4.5
            30. Act.templateId:primary.extension
            Definition

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

            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.
            LabelExtension
            32. Act.classCode
            Control1..1
            BindingThe codes SHALL be taken from XActClassDocumentEntryAct (2.0.0)
            (required to http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0)
            Typecode
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed ValueACT
            34. Act.moodCode
            Control1..1
            BindingThe codes SHALL be taken from XDocumentActMood (2.0.0)
            (required to http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0)
            Typecode
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed ValueEVN
            36. Act.negationInd
            Control0..1
            Typeboolean(bl: Boolean)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            38. Act.id
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
            Must Supporttrue
            40. Act.code
            Control1..1
            BindingFor example codes, see v3 Code System ActCode
            (example to http://terminology.hl7.org/ValueSet/v3-ActCode)
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
            Must Supporttrue
            42. Act.code.nullFlavor
            Definition

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

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

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

            Control0..1
            Typecode(cs: Coded Simple Value)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            LabelCode
            Fixed ValueCONC
            46. Act.code.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
            Fixed Value2.16.840.1.113883.5.6
            48. Act.code.codeSystemName
            Definition

            The common name of the coding system.

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

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

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

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

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

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

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

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

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

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

            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
            LabelOriginal Text
            60. Act.code.qualifier
            Definition

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

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

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

            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
            XML FormatThe type of this property is determined using the xsi:typeattribute.
            LabelTranslation
            64. Act.text
            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
            66. Act.statusCode
            Definition

            As long as the underlying conditions are of concern to the author (i.e., as long as allergies, whether active or resolved, is of ongoing concern and interest to the author), the statusCode is “ active ”. The concern is tracked by the author.

            Only when the underlying allergies are no longer of concern then the statusCode is set to “ completed ”. The author is no more tracking this concern and no further actions are expected.

            Control1..1
            BindingThe codes SHALL be taken from x_ActStatusActiveComplete
            (required to http://terminology.hl7.org/ValueSet/v3-xActStatusActiveComplete)

            x_ActStatusActiveComplete

            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
            Must Supporttrue
            68. Act.effectiveTime
            Control1..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
            Must Supporttrue
            70. Act.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
            72. Act.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.
            74. Act.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
            76. Act.effectiveTime.low
            Definition

            This element asserts when the concern became active. This equates to the time the concern was authored in the patient's chart and the author started tracking this concern.

            Control1..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
            Must Supporttrue
            LabelLow Boundary
            78. Act.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
            80. Act.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
            82. Act.effectiveTime.high
            Definition

            This element asserts when the clinician deemed there is no longer any need to track the underlying conditions.If statusCode/@code="completed" Completed, then effectiveTime SHALL contain [1..1] high

            Control0..1
            This element is affected by the following invariants: MD1557037N1l27l352l30l19l10l12
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
            LabelHigh Boundary
            InvariantsMD1557037N1l27l352l30l19l10l12: If statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high ()
            84. Act.priorityCode
            Control0..1
            BindingFor example codes, see ActPriority
            (example to http://terminology.hl7.org/ValueSet/v3-ActPriority)
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
            86. Act.languageCode
            Control0..1
            BindingThe codes SHALL be taken from AllLanguages
            (required to http://hl7.org/fhir/ValueSet/all-languages)
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
            88. Act.subject
            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
            90. Act.specimen
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
            92. Act.performer
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
            94. Act.author
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
            96. Act.informant
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
            98. Act.participant
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
            100. Act.entryRelationship
            Control1..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
            SlicingThis element introduces a set of slices on Act.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ resolve()
            • 102. Act.entryRelationship:entryRelationship-1
              Slice NameentryRelationship-1
              Control1..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
              Must Supporttrue
              InvariantsentryRelationship-1: contains IPS Allergy or Intolerance 2.16.840.1.113883.10.22.4.1 (2024-08-04) ()
              104. Act.entryRelationship:entryRelationship-1.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
              106. Act.entryRelationship:entryRelationship-1.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
              108. Act.entryRelationship:entryRelationship-1.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
              110. Act.entryRelationship:entryRelationship-1.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
              112. Act.entryRelationship:entryRelationship-1.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
              114. Act.entryRelationship:entryRelationship-1.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
              116. Act.entryRelationship:entryRelationship-1.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
              118. Act.entryRelationship:entryRelationship-1.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
              120. Act.entryRelationship:entryRelationship-1.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
              122. Act.entryRelationship:entryRelationship-1.typeCode
              Control1..1
              BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
              (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship)
              Typecode
              Primitive ValueThis 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
              124. Act.entryRelationship:entryRelationship-1.inversionInd
              Definition

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

              Control0..1
              Typeboolean
              Primitive ValueThis 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 Valuefalse
              126. Act.entryRelationship:entryRelationship-1.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
              128. Act.entryRelationship:entryRelationship-1.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.
              130. Act.entryRelationship:entryRelationship-1.sequenceNumber
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
              132. Act.entryRelationship:entryRelationship-1.seperatableInd
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
              134. Act.entryRelationship:entryRelationship-1.act
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
              136. Act.entryRelationship:entryRelationship-1.encounter
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
              138. Act.entryRelationship:entryRelationship-1.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
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(IPS Allergy or Intolerance)
              Is Modifierfalse
              Must Supporttrue
              140. Act.entryRelationship:entryRelationship-1.observationMedia
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
              142. Act.entryRelationship:entryRelationship-1.organizer
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
              144. Act.entryRelationship:entryRelationship-1.procedure
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
              146. Act.entryRelationship:entryRelationship-1.regionOfInterest
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
              148. Act.entryRelationship:entryRelationship-1.substanceAdministration
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
              150. Act.entryRelationship:entryRelationship-1.supply
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
              152. Act.reference
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
              154. Act.precondition
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
              156. Act.sdtcPrecondition2
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition2
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameprecondition2.
              158. Act.sdtcInFulfillmentOf1
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
              XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameinFulfillmentOf1.