Consolidated CDA (C-CDA)
4.0.0 - STU4 United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v4.0.0: CCDA 4.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Logical Model: Drug Vehicle

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/DrugVehicle Version: 4.0.0
Draft as of 2025-06-20 Computable Name: DrugVehicle
Other Identifiers: OID:2.16.840.1.113883.10.20.22.4.24

This template represents the vehicle (e.g., saline, dextrose) for administering a medication.

Usages:

Changes since version 3.0.0:

  • No changes

    • Formal Views of Template Content

    Description of Template, Differentials, Snapshots and how the different presentations work.

    This structure is derived from ParticipantRole

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. ParticipantRole ParticipantRole XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, code, addr, telecom, playingDevice, playingEntity, scopingEntity
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root
    .... templateId:drug-vehicle 1..1 II
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.24
    ..... @extension 0..0
    ... @classCode 1..1 cs Fixed Value: MANU
    ... code 1..1 CE
    .... @code 1..1 cs Required Pattern: 412307009
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.96
    .... code 1..1 CE This playingEntity/code is used to supply a coded term for the drug vehicle.
    .... name 0..1 PN This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087).

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. ParticipantRole C 1..1 ParticipantRole XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, code, addr, telecom, playingDevice, playingEntity, scopingEntity
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: role-choice
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    .... templateId:drug-vehicle 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.24
    ... @classCode 1..1 cs Binding: CDARoleClassRoot (required)
    Fixed Value: MANU
    ... id 0..* II
    ... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
    XML: identifiedBy (urn:hl7-org:sdtc)
    ... code 1..1 CE Binding: CDARoleCode (example)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: 412307009
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.96
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... translation 0..* CD
    ... addr 0..* AD
    ... telecom 0..* TEL
    ... (Choice of one) 0..1
    .... playingDevice 0..1 Device
    .... playingEntity 1..1 PlayingEntity
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @classCode 0..1 cs Binding: EntityClassRoot (required)
    ..... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
    Fixed Value: INSTANCE
    ..... code 1..1 CE This playingEntity/code is used to supply a coded term for the drug vehicle.
    Binding: CDAEntityCode (example)
    ..... quantity 0..* PQ
    ..... name 0..1 PN This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087).
    ..... sdtcBirthTime 0..1 TS XML Namespace: urn:hl7-org:sdtc
    XML: birthTime (urn:hl7-org:sdtc)
    ..... desc 0..1 ED
    ... scopingEntity 0..1 Entity

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    ParticipantRole.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.templateId:drug-vehicle.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.classCoderequiredFixed Value: MANU
    http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
    ParticipantRole.codeexampleCDARoleCode
    http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
    ParticipantRole.code.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.playingEntity.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.playingEntity.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.playingEntity.classCoderequiredEntityClassRoot
    http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
    ParticipantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
    http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
    ParticipantRole.playingEntity.codeexampleCDAEntityCode
    http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode

    Constraints

    IdGradePath(s)DetailsRequirements
    II-1errorParticipantRole.typeId, ParticipantRole.playingEntity.typeIdAn II instance must have either a root or an nullFlavor.
    : root.exists() or nullFlavor.exists()
    role-choiceerrorParticipantRoleplayingDevice and playingEntity are mutually exclusive
    : (playingDevice | playingEntity).count() <= 1
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. ParticipantRole C 1..1 ParticipantRole XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, code, addr, telecom, playingDevice, playingEntity, scopingEntity
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: role-choice
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    .... templateId:drug-vehicle 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.24
    ... @classCode 1..1 cs Binding: CDARoleClassRoot (required)
    Fixed Value: MANU
    ... id 0..* II
    ... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
    XML: identifiedBy (urn:hl7-org:sdtc)
    ... code 1..1 CE Binding: CDARoleCode (example)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: 412307009
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.96
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... translation 0..* CD
    ... addr 0..* AD
    ... telecom 0..* TEL
    ... (Choice of one) 0..1
    .... playingDevice 0..1 Device
    .... playingEntity 1..1 PlayingEntity
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @classCode 0..1 cs Binding: EntityClassRoot (required)
    ..... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
    Fixed Value: INSTANCE
    ..... code 1..1 CE This playingEntity/code is used to supply a coded term for the drug vehicle.
    Binding: CDAEntityCode (example)
    ..... quantity 0..* PQ
    ..... name 0..1 PN This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087).
    ..... sdtcBirthTime 0..1 TS XML Namespace: urn:hl7-org:sdtc
    XML: birthTime (urn:hl7-org:sdtc)
    ..... desc 0..1 ED
    ... scopingEntity 0..1 Entity

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    ParticipantRole.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.templateId:drug-vehicle.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.classCoderequiredFixed Value: MANU
    http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
    ParticipantRole.codeexampleCDARoleCode
    http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
    ParticipantRole.code.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.playingEntity.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.playingEntity.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.playingEntity.classCoderequiredEntityClassRoot
    http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
    ParticipantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
    http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
    ParticipantRole.playingEntity.codeexampleCDAEntityCode
    http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode

    Constraints

    IdGradePath(s)DetailsRequirements
    II-1errorParticipantRole.typeId, ParticipantRole.playingEntity.typeIdAn II instance must have either a root or an nullFlavor.
    : root.exists() or nullFlavor.exists()
    role-choiceerrorParticipantRoleplayingDevice and playingEntity are mutually exclusive
    : (playingDevice | playingEntity).count() <= 1

    This structure is derived from ParticipantRole

    Summary

    Mandatory: 9 elements
    Fixed: 1 element
    Prohibited: 1 element

    Slices

    This structure defines the following Slices:

    • The element 1 is sliced based on the value of ParticipantRole.templateId

    Differential View

    This structure is derived from ParticipantRole

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. ParticipantRole ParticipantRole XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, code, addr, telecom, playingDevice, playingEntity, scopingEntity
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root
    .... templateId:drug-vehicle 1..1 II
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.24
    ..... @extension 0..0
    ... @classCode 1..1 cs Fixed Value: MANU
    ... code 1..1 CE
    .... @code 1..1 cs Required Pattern: 412307009
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.96
    .... code 1..1 CE This playingEntity/code is used to supply a coded term for the drug vehicle.
    .... name 0..1 PN This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087).

    doco Documentation for this format

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. ParticipantRole C 1..1 ParticipantRole XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, code, addr, telecom, playingDevice, playingEntity, scopingEntity
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: role-choice
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    .... templateId:drug-vehicle 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.24
    ... @classCode 1..1 cs Binding: CDARoleClassRoot (required)
    Fixed Value: MANU
    ... id 0..* II
    ... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
    XML: identifiedBy (urn:hl7-org:sdtc)
    ... code 1..1 CE Binding: CDARoleCode (example)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: 412307009
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.96
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... translation 0..* CD
    ... addr 0..* AD
    ... telecom 0..* TEL
    ... (Choice of one) 0..1
    .... playingDevice 0..1 Device
    .... playingEntity 1..1 PlayingEntity
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @classCode 0..1 cs Binding: EntityClassRoot (required)
    ..... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
    Fixed Value: INSTANCE
    ..... code 1..1 CE This playingEntity/code is used to supply a coded term for the drug vehicle.
    Binding: CDAEntityCode (example)
    ..... quantity 0..* PQ
    ..... name 0..1 PN This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087).
    ..... sdtcBirthTime 0..1 TS XML Namespace: urn:hl7-org:sdtc
    XML: birthTime (urn:hl7-org:sdtc)
    ..... desc 0..1 ED
    ... scopingEntity 0..1 Entity

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    ParticipantRole.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.templateId:drug-vehicle.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.classCoderequiredFixed Value: MANU
    http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
    ParticipantRole.codeexampleCDARoleCode
    http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
    ParticipantRole.code.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.playingEntity.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.playingEntity.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.playingEntity.classCoderequiredEntityClassRoot
    http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
    ParticipantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
    http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
    ParticipantRole.playingEntity.codeexampleCDAEntityCode
    http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode

    Constraints

    IdGradePath(s)DetailsRequirements
    II-1errorParticipantRole.typeId, ParticipantRole.playingEntity.typeIdAn II instance must have either a root or an nullFlavor.
    : root.exists() or nullFlavor.exists()
    role-choiceerrorParticipantRoleplayingDevice and playingEntity are mutually exclusive
    : (playingDevice | playingEntity).count() <= 1

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. ParticipantRole C 1..1 ParticipantRole XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, code, addr, telecom, playingDevice, playingEntity, scopingEntity
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: role-choice
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    .... templateId:drug-vehicle 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.24
    ... @classCode 1..1 cs Binding: CDARoleClassRoot (required)
    Fixed Value: MANU
    ... id 0..* II
    ... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
    XML: identifiedBy (urn:hl7-org:sdtc)
    ... code 1..1 CE Binding: CDARoleCode (example)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: 412307009
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.96
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... translation 0..* CD
    ... addr 0..* AD
    ... telecom 0..* TEL
    ... (Choice of one) 0..1
    .... playingDevice 0..1 Device
    .... playingEntity 1..1 PlayingEntity
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @classCode 0..1 cs Binding: EntityClassRoot (required)
    ..... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
    Fixed Value: INSTANCE
    ..... code 1..1 CE This playingEntity/code is used to supply a coded term for the drug vehicle.
    Binding: CDAEntityCode (example)
    ..... quantity 0..* PQ
    ..... name 0..1 PN This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087).
    ..... sdtcBirthTime 0..1 TS XML Namespace: urn:hl7-org:sdtc
    XML: birthTime (urn:hl7-org:sdtc)
    ..... desc 0..1 ED
    ... scopingEntity 0..1 Entity

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    ParticipantRole.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.templateId:drug-vehicle.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.classCoderequiredFixed Value: MANU
    http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
    ParticipantRole.codeexampleCDARoleCode
    http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
    ParticipantRole.code.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.playingEntity.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.playingEntity.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    ParticipantRole.playingEntity.classCoderequiredEntityClassRoot
    http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
    ParticipantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
    http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
    ParticipantRole.playingEntity.codeexampleCDAEntityCode
    http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode

    Constraints

    IdGradePath(s)DetailsRequirements
    II-1errorParticipantRole.typeId, ParticipantRole.playingEntity.typeIdAn II instance must have either a root or an nullFlavor.
    : root.exists() or nullFlavor.exists()
    role-choiceerrorParticipantRoleplayingDevice and playingEntity are mutually exclusive
    : (playingDevice | playingEntity).count() <= 1

    This structure is derived from ParticipantRole

    Summary

    Mandatory: 9 elements
    Fixed: 1 element
    Prohibited: 1 element

    Slices

    This structure defines the following Slices:

    • The element 1 is sliced based on the value of ParticipantRole.templateId

     

    Other representations of profile: CSV, Excel