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

Draft as of 2024-08-04

Definitions for the 2.16.840.1.113883.10.22.4.30--20240804210307 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.30
    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.
    Fixed ValueEVN
    12. Procedure.code
    Definition

    LOINC code representing the act of specimen collection

    Control0..1
    Must Supporttrue
    14. Procedure.code.code
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Value33882-2
    16. Procedure.code.codeSystem
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Value2.16.840.1.113883.6.1
    18. Procedure.effectiveTime
    Definition

    Date and time of specimen collection

    Control0..1
    Must Supporttrue
    20. Procedure.methodCode
    Control0..1
    BindingThe codes SHALL be taken from IPS Results Specimen Collection Method
    (required to http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.76--20240802105320)

    IPS Results Specimen Collection Method

    Must Supporttrue
    22. Procedure.targetSiteCode
    Control0..1
    BindingThe codes SHALL be taken from IPS Body Site
    (required to http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips)

    IPS Body Site

    Must Supporttrue
    24. Procedure.participant
    Definition

    One single participant, which is the product of the procedure (PRD), role of specimen (SPEC) played by the playingEntity, which conveys the type of specimen collected (blood, urine, tissue, ...)

    Control0..1
    Must Supporttrue
    26. Procedure.participant.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 ValuePRD
    28. Procedure.participant.participantRole
    Control1..1
    Must Supporttrue
    30. Procedure.participant.participantRole.classCode
    Control0..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 ValueSPEC
    32. Procedure.participant.participantRole.id
    Control0..1
    Must Supporttrue
    34. Procedure.participant.participantRole.playingEntity
    Control1..1
    Must Supporttrue
    36. Procedure.participant.participantRole.playingEntity.classCode
    Control0..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 ValueENT
    38. Procedure.participant.participantRole.playingEntity.determinerCode
    Control0..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 ValueINSTANCE
    40. Procedure.participant.participantRole.playingEntity.code
    Control1..1
    BindingThe codes SHOULD be taken from IPS Specimen Type
    (preferred to http://hl7.org/uv/ips/fhir/ValueSet/specimen-type)

    IPS Specimen Type

    Must Supporttrue

    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.30
      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.
      Fixed ValueEVN
      12. Procedure.code
      Definition

      LOINC code representing the act of specimen collection


      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
      Control0..1
      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()))
      14. Procedure.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 Value33882-2
      16. Procedure.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.6.1
      18. Procedure.effectiveTime
      Definition

      Date and time of specimen collection

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
      Must Supporttrue
      20. Procedure.methodCode
      Definition

      Drawn from concept domain ProcedureMethod

      Control0..1
      BindingThe codes SHALL be taken from IPS Results Specimen Collection Method
      (required to http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.76--20240802105320)

      IPS Results Specimen Collection Method

      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
      Must Supporttrue
      22. Procedure.targetSiteCode
      Definition

      Drawn from concept domain ActSite

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

      IPS Body Site

      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
      Must Supporttrue
      24. Procedure.participant
      Definition

      One single participant, which is the product of the procedure (PRD), role of specimen (SPEC) played by the playingEntity, which conveys the type of specimen collected (blood, urine, tissue, ...)

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
      Must Supporttrue
      26. Procedure.participant.typeCode
      Control1..1
      BindingThe codes SHALL be taken from CDAParticipationType
      (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
      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 ValuePRD
      28. Procedure.participant.participantRole
      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole
      Must Supporttrue
      30. Procedure.participant.participantRole.classCode
      Control0..1
      BindingThe codes SHALL be taken from CDARoleClassRoot
      (required to http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot)
      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.
      Default ValueROL
      Fixed ValueSPEC
      32. Procedure.participant.participantRole.id
      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
      Must Supporttrue
      34. Procedure.participant.participantRole.playingEntity
      Control1..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity
      Must Supporttrue
      36. Procedure.participant.participantRole.playingEntity.classCode
      Control0..1
      BindingThe codes SHALL be taken from EntityClassRoot
      (required to http://terminology.hl7.org/ValueSet/v3-EntityClassRoot)
      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.
      Default ValueENT
      Fixed ValueENT
      38. Procedure.participant.participantRole.playingEntity.determinerCode
      Control0..1
      BindingThe codes SHALL be taken from EntityDeterminer
      (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
      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 ValueINSTANCE
      40. Procedure.participant.participantRole.playingEntity.code
      Control1..1
      BindingThe codes SHOULD be taken from IPS Specimen Type
      (preferred to http://hl7.org/uv/ips/fhir/ValueSet/specimen-type)

      IPS Specimen Type

      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
      Must Supporttrue

      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.30
        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.
        Fixed ValueEVN
        36. Procedure.id
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        38. Procedure.code
        Definition

        LOINC code representing the act of specimen collection

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
        Must Supporttrue
        40. Procedure.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
        42. Procedure.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 Value33882-2
        44. Procedure.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.6.1
        46. Procedure.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
        48. Procedure.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
        50. Procedure.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
        52. Procedure.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.
        54. Procedure.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.
        56. Procedure.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
        58. Procedure.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
        60. Procedure.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
        62. 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.
        64. Procedure.text
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        66. Procedure.statusCode
        Control0..1
        BindingThe codes SHALL be taken from ActStatus
        (required to http://terminology.hl7.org/ValueSet/v3-ActStatus)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
        68. Procedure.effectiveTime
        Definition

        Date and time of specimen collection

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

        Drawn from concept domain ProcedureMethod

        Control0..1
        BindingThe codes SHALL be taken from IPS Results Specimen Collection Method
        (required to http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.76--20240802105320)

        IPS Results Specimen Collection Method

        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        Must Supporttrue
        76. Procedure.approachSiteCode
        Definition

        Drawn from concept domain ActSite

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

        Drawn from concept domain ActSite

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

        IPS Body Site

        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
        Must Supporttrue
        80. Procedure.subject
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
        82. Procedure.specimen
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
        84. Procedure.performer
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
        86. Procedure.author
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
        88. Procedure.informant
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
        90. Procedure.participant
        Definition

        One single participant, which is the product of the procedure (PRD), role of specimen (SPEC) played by the playingEntity, which conveys the type of specimen collected (blood, urine, tissue, ...)

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
        Must Supporttrue
        92. Procedure.participant.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
        94. Procedure.participant.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
        96. Procedure.participant.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
        98. Procedure.participant.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
        100. Procedure.participant.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
        102. Procedure.participant.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
        104. Procedure.participant.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
        106. Procedure.participant.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
        108. Procedure.participant.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
        110. Procedure.participant.typeCode
        Control1..1
        BindingThe codes SHALL be taken from CDAParticipationType
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType)
        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 ValuePRD
        112. Procedure.participant.contextControlCode
        Control0..1
        BindingThe codes SHALL be taken from CDAContextControl
        (required to http://hl7.org/cda/stds/core/ValueSet/CDAContextControl)
        Typecode(cs: Coded Simple Value)
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Fixed ValueOP
        114. Procedure.participant.sdtcFunctionCode
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namefunctionCode.
        116. Procedure.participant.time
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
        118. Procedure.participant.awarenessCode
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        120. Procedure.participant.participantRole
        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole
        Must Supporttrue
        122. Procedure.participant.participantRole.nullFlavor
        Definition

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

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

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
        126. Procedure.participant.participantRole.typeId
        Definition

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

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        128. Procedure.participant.participantRole.typeId.nullFlavor
        Definition

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

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

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

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

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

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

        Identifies the type as an HL7 Registered model

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

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

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

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        140. Procedure.participant.participantRole.classCode
        Control0..1
        BindingThe codes SHALL be taken from CDARoleClassRoot
        (required to http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot)
        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.
        Default ValueROL
        Fixed ValueSPEC
        142. Procedure.participant.participantRole.id
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        Must Supporttrue
        144. Procedure.participant.participantRole.sdtcIdentifiedBy
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
        146. Procedure.participant.participantRole.code
        Control0..1
        BindingFor example codes, see CDARoleCode
        (example to http://hl7.org/cda/stds/core/ValueSet/CDARoleCode)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        148. Procedure.participant.participantRole.addr
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
        150. Procedure.participant.participantRole.telecom
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
        152. Procedure.participant.participantRole.playingDevice
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Device
        154. Procedure.participant.participantRole.playingEntity
        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity
        Must Supporttrue
        156. Procedure.participant.participantRole.playingEntity.nullFlavor
        Definition

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

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

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
        160. Procedure.participant.participantRole.playingEntity.typeId
        Definition

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

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        162. Procedure.participant.participantRole.playingEntity.typeId.nullFlavor
        Definition

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

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

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

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

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

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

        Identifies the type as an HL7 Registered model

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

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

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

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

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        174. Procedure.participant.participantRole.playingEntity.classCode
        Control0..1
        BindingThe codes SHALL be taken from EntityClassRoot
        (required to http://terminology.hl7.org/ValueSet/v3-EntityClassRoot)
        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.
        Default ValueENT
        Fixed ValueENT
        176. Procedure.participant.participantRole.playingEntity.determinerCode
        Control0..1
        BindingThe codes SHALL be taken from EntityDeterminer
        (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
        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 ValueINSTANCE
        178. Procedure.participant.participantRole.playingEntity.code
        Control1..1
        BindingThe codes SHOULD be taken from IPS Specimen Type
        (preferred to http://hl7.org/uv/ips/fhir/ValueSet/specimen-type)

        IPS Specimen Type

        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        Must Supporttrue
        180. Procedure.participant.participantRole.playingEntity.quantity
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
        182. Procedure.participant.participantRole.playingEntity.name
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN
        184. Procedure.participant.participantRole.playingEntity.sdtcBirthTime
        Definition

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

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namebirthTime.
        186. Procedure.participant.participantRole.playingEntity.desc
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        188. Procedure.participant.participantRole.scopingEntity
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Entity
        190. Procedure.entryRelationship
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
        192. Procedure.reference
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
        194. Procedure.precondition
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
        196. 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.
        198. 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.