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

Draft as of 2020-05-08

Definitions for the 2.16.840.1.113883.10.22.4.38--20200508173848 logical model.

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

0. Procedure
Control0..*
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. Procedure.templateId
Control1..?
SlicingThis element introduces a set of slices on Procedure.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
  • 4. Procedure.templateId:primary
    Slice Nameprimary
    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
    Must Supporttrue
    6. Procedure.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.38
    8. Procedure.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 ValuePROC
    10. Procedure.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.
    Pattern ValueRQO
    12. Procedure.id
    Control0..*
    Must Supporttrue
    14. Procedure.code
    Control1..1
    BindingThe codes SHOULD be taken from IPS Results Laboratory/Pathology Observation
    (preferred to http://hl7.org/fhir/uv/ips/ValueSet/procedures-uv-ips)

    IPS Procedures

    Must Supporttrue
    16. Procedure.text
    Definition

    The element if present points to the text describing the data being recorded; including any dates, comments, et cetera. The contains a URI in value attribute. This URI points to the free text description of the element (problem, procedure,...) in the document that is being described.

    Control0..1
    Must Supporttrue
    18. Procedure.text.reference
    Control1..1
    Must Supporttrue
    20. Procedure.text.reference.value
    Definition

    When used it shall refer to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1

    Control1..1
    Typeurl
    Primitive ValueThis 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. Procedure.statusCode
    Control1..1
    BindingThe codes SHALL be taken from ActStatusActiveCompletedAbortedCancelled
    (required to http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.22--20170502000000)

    ActStatusActiveCompletedAbortedCancelled

    Must Supporttrue
    24. Procedure.effectiveTime
    Control0..1
    26. Procedure.targetSiteCode
    Control0..*
    BindingThe codes SHOULD be taken from IPS Body Site
    (preferred to http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips)

    IPS Body Site

    28. Procedure.entryRelationship
    Control1..?
    SlicingThis element introduces a set of slices on Procedure.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ profile
    • 30. Procedure.entryRelationship:entryRelationship-1
      Slice NameentryRelationship-1
      Control0..*
      InvariantsentryRelationship-1: contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) ()
      32. Procedure.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 ValueCOMP
      34. Procedure.entryRelationship:entryRelationship-1.inversionInd
      Control1..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 Valuetrue
      36. Procedure.entryRelationship:entryRelationship-1.act:entryRelationship-1
      Slice NameentryRelationship-1
      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(IPS Internal Reference)

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

      0. Procedure
      Definition

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

      ShortBase for all types and resources
      Control0..*
      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.
      2. Procedure.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 Procedure.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ root
      • value @ extension
      • 4. Procedure.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. Procedure.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.38
        8. Procedure.classCode
        Control1..1
        BindingThe codes SHALL be taken from ActClassProcedure
        (required to http://terminology.hl7.org/ValueSet/v3-ActClassProcedure)
        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 ValuePROC
        10. Procedure.moodCode
        Control1..1
        BindingThe codes SHALL be taken from x_DocumentProcedureMood
        (required to http://terminology.hl7.org/ValueSet/v3-xDocumentProcedureMood)
        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.
        Pattern ValueRQO
        12. Procedure.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

        The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

        Control0..*1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IIstring
        Is Modifierfalse
        Must Supporttrue
        14. Procedure.code
        Definition

        Drawn from concept domain ActCode


        The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy").

        ShortIdentification of the procedure
        Control10..1
        BindingThe codes SHOULD be taken from For example codes, see IPS Results Laboratory/Pathology Observationhttp://hl7.org/fhir/ValueSet/procedure-code
        (preferred to http://hl7.org/fhir/uv/ips/ValueSet/procedures-uv-ips)

        IPS Procedures


        A code to identify a specific procedure .

        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CDCodeableConcept
        Is Modifierfalse
        Must Supporttrue
        Requirements

        0..1 to account for primarily narrative only resources.

        Alternate Namestype
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        16. Procedure.text
        Definition

        The element if present points to the text describing the data being recorded; including any dates, comments, et cetera. The contains a URI in value attribute. This URI points to the free text description of the element (problem, procedure,...) in the document that is being described.


        A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

        ShortText summary of the resource, for human interpretation
        Comments

        Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EDNarrative
        Is Modifierfalse
        Must Supporttrue
        Alternate Namesnarrative, html, xhtml, display
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        18. Procedure.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.

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
        Must Supporttrue
        LabelReference
        20. Procedure.text.reference.value
        Definition

        When used it shall refer to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1

        Control1..1
        Typeurl
        Primitive ValueThis 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. Procedure.statusCode
        Control1..1
        BindingThe codes SHALL be taken from ActStatusActiveCompletedAbortedCancelled
        (required to http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.22--20170502000000)

        ActStatusActiveCompletedAbortedCancelled

        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
        Must Supporttrue
        24. Procedure.effectiveTime
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
        26. Procedure.targetSiteCode
        Definition

        Drawn from concept domain ActSite

        Control0..*
        BindingThe codes SHOULD be taken from IPS Body Site
        (preferred to http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips)

        IPS Body Site

        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
        28. Procedure.entryRelationship
        Control1..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
        SlicingThis element introduces a set of slices on Procedure.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ profile
        • 30. Procedure.entryRelationship:entryRelationship-1
          Slice NameentryRelationship-1
          Control0..*
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
          InvariantsentryRelationship-1: contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) ()
          32. Procedure.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 ValueCOMP
          34. Procedure.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.

          Control1..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 Valuetrue
          36. Procedure.entryRelationship:entryRelationship-1.act:entryRelationship-1
          Slice NameentryRelationship-1
          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
          This element is affected by the following invariants: MD1557037N1l27l287l23l17, MD1557037N1l27l287l23l19, MD1557037N1l27l287l23l21
          Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(IPS Internal Reference)
          Is Modifierfalse
          Must Supporttrue
          InvariantsMD1557037N1l27l287l23l17: The @moodCode of the reference SHALL match the @moodCode of the referenced element ()
          MD1557037N1l27l287l23l19: The root and extension attributes SHALL identify an element defined elsewhere in the same document. ()
          MD1557037N1l27l287l23l21: The code of the reference SHALL match the code of the referenced element ()

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

          0. Procedure
          Definition

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

          ShortBase for all types and resources
          Control0..*
          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.
          2. Procedure.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. Procedure.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. Procedure.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. Procedure.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. Procedure.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. Procedure.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. Procedure.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. Procedure.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. Procedure.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 Procedure.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ root
          • value @ extension
          • 20. Procedure.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. Procedure.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. Procedure.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. Procedure.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. Procedure.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.38
            30. Procedure.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. Procedure.classCode
            Control1..1
            BindingThe codes SHALL be taken from ActClassProcedure
            (required to http://terminology.hl7.org/ValueSet/v3-ActClassProcedure)
            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 ValuePROC
            34. Procedure.moodCode
            Control1..1
            BindingThe codes SHALL be taken from x_DocumentProcedureMood
            (required to http://terminology.hl7.org/ValueSet/v3-xDocumentProcedureMood)
            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.
            Pattern ValueRQO
            36. Procedure.id
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
            Must Supporttrue
            38. Procedure.code
            Definition

            Drawn from concept domain ActCode

            Control1..1
            BindingThe codes SHOULD be taken from IPS Results Laboratory/Pathology Observation
            (preferred to http://hl7.org/fhir/uv/ips/ValueSet/procedures-uv-ips)

            IPS Procedures

            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
            Must Supporttrue
            40. Procedure.negationInd
            Control0..1
            Typeboolean(bl: Boolean)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            42. Procedure.text
            Definition

            The element if present points to the text describing the data being recorded; including any dates, comments, et cetera. The contains a URI in value attribute. This URI points to the free text description of the element (problem, procedure,...) in the document that is being described.

            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
            Must Supporttrue
            44. Procedure.text.nullFlavor
            Definition

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

            Control0..1
            Typestring(st: Character String)
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as unadorned text.
            60. Procedure.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.

            Control1..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
            Must Supporttrue
            LabelReference
            62. Procedure.text.reference.nullFlavor
            Definition

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

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

            When used it shall refer to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1

            Control1..1
            Typeurl
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            66. Procedure.text.reference.useablePeriod
            Definition

            Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.

            Control0..*
            TypeChoice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
            Default Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
            XML FormatThe type of this property is determined using the xsi:typeattribute.
            LabelUseable Period
            68. Procedure.text.reference.use
            Definition

            One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.

            Control0..*
            BindingThe codes SHALL be taken from TelecommunicationAddressUse (2.0.0)
            (required to http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|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.
            LabelUse Code
            70. Procedure.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
            72. Procedure.statusCode
            Control1..1
            BindingThe codes SHALL be taken from ActStatusActiveCompletedAbortedCancelled
            (required to http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.22--20170502000000)

            ActStatusActiveCompletedAbortedCancelled

            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
            Must Supporttrue
            74. Procedure.effectiveTime
            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
            76. Procedure.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
            78. Procedure.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
            80. Procedure.methodCode
            Definition

            Drawn from concept domain ProcedureMethod

            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
            82. Procedure.approachSiteCode
            Definition

            Drawn from concept domain ActSite

            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
            84. Procedure.targetSiteCode
            Definition

            Drawn from concept domain ActSite

            Control0..*
            BindingThe codes SHOULD be taken from IPS Body Site
            (preferred to http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips)

            IPS Body Site

            Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
            86. Procedure.subject
            Control0..1
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
            88. Procedure.specimen
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
            90. Procedure.performer
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
            92. Procedure.author
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
            94. Procedure.informant
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
            96. Procedure.participant
            Control0..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
            98. Procedure.entryRelationship
            Control1..*
            Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
            SlicingThis element introduces a set of slices on Procedure.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ profile
            • 100. Procedure.entryRelationship:entryRelationship-1
              Slice NameentryRelationship-1
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
              InvariantsentryRelationship-1: contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) ()
              102. Procedure.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
              104. Procedure.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
              106. Procedure.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
              108. Procedure.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
              110. Procedure.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
              112. Procedure.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
              114. Procedure.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
              116. Procedure.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
              118. Procedure.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
              120. Procedure.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 ValueCOMP
              122. Procedure.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.

              Control1..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 Valuetrue
              124. Procedure.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
              126. Procedure.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.
              128. Procedure.entryRelationship:entryRelationship-1.sequenceNumber
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
              130. Procedure.entryRelationship:entryRelationship-1.seperatableInd
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
              132. Procedure.entryRelationship:entryRelationship-1.act:entryRelationship-1
              Slice NameentryRelationship-1
              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
              This element is affected by the following invariants: MD1557037N1l27l287l23l17, MD1557037N1l27l287l23l19, MD1557037N1l27l287l23l21
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(IPS Internal Reference)
              Is Modifierfalse
              Must Supporttrue
              InvariantsMD1557037N1l27l287l23l17: The @moodCode of the reference SHALL match the @moodCode of the referenced element ()
              MD1557037N1l27l287l23l19: The root and extension attributes SHALL identify an element defined elsewhere in the same document. ()
              MD1557037N1l27l287l23l21: The code of the reference SHALL match the code of the referenced element ()
              134. Procedure.entryRelationship:entryRelationship-1.encounter
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
              136. Procedure.entryRelationship:entryRelationship-1.observation
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
              138. Procedure.entryRelationship:entryRelationship-1.observationMedia
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
              140. Procedure.entryRelationship:entryRelationship-1.organizer
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
              142. Procedure.entryRelationship:entryRelationship-1.procedure
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
              144. Procedure.entryRelationship:entryRelationship-1.regionOfInterest
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
              146. Procedure.entryRelationship:entryRelationship-1.substanceAdministration
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
              148. Procedure.entryRelationship:entryRelationship-1.supply
              Control0..1
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
              150. Procedure.reference
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
              152. Procedure.precondition
              Control0..*
              Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
              154. Procedure.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.
              156. Procedure.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.