Consolidated CDA
3.0.0-ballot - ballot United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . 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: 3.0.0-ballot
Draft as of 2023-12-21 Computable Name: DrugVehicle
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.20.22.4.24

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

Usage:

Formal Views of Profile Content

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

This structure is derived from ParticipantRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. ParticipantRole ParticipantRoleXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, code, addr, telecom, playingDevice, playingEntity, scopingEntity
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:drug-vehicle 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.24
..... @extension 0..0
... @classCode 1..1csFixed Value: MANU
... code 1..1CE
.... @code 1..1csRequired Pattern: 412307009
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
.... code 1..1CEThis playingEntity/code is used to supply a coded term for the drug vehicle.
.... name 0..1PNThis 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 & Constraintsdoco
.. ParticipantRole C1..1ParticipantRoleXML 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
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:drug-vehicle 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.24
... @classCode 1..1csBinding: RoleClassRoot (required)
Fixed Value: MANU
... code 1..1CEBinding: v3 Code System RoleCode (example)
.... @code 1..1csRequired Pattern: 412307009
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
.... @classCode 1..1csBinding: EntityClassRoot (required)
.... code 1..1CEThis playingEntity/code is used to supply a coded term for the drug vehicle.
Binding: EntityCode (example)
.... name 0..1PNThis playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087).

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ParticipantRole.classCoderequiredFixed Value: MANU
ParticipantRole.codeexampleRoleCode
ParticipantRole.playingEntity.classCoderequiredEntityClassRoot
ParticipantRole.playingEntity.codeexampleEntityCode

Constraints

IdGradePath(s)DetailsRequirements
role-choiceerrorParticipantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1
NameFlagsCard.TypeDescription & Constraintsdoco
.. ParticipantRole C1..1ParticipantRoleXML 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
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
.... templateId:drug-vehicle 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.24
... @classCode 1..1csBinding: RoleClassRoot (required)
Fixed Value: MANU
... id 0..*II
... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
... code 1..1CEBinding: v3 Code System RoleCode (example)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csRequired Pattern: 412307009
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... translation 0..*CD
... addr 0..*AD
... telecom 0..*TEL
... (Choice of one) 0..1
.... playingDevice 0..1Device
.... playingEntity 1..1PlayingEntity
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @classCode 1..1csBinding: EntityClassRoot (required)
..... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... code 1..1CEThis playingEntity/code is used to supply a coded term for the drug vehicle.
Binding: EntityCode (example)
..... quantity 0..*PQ
..... name 0..1PNThis playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087).
..... sdtcBirthTime 0..1TSXML Namespace: urn:hl7-org:sdtc
XML: birthTime (urn:hl7-org:sdtc)
..... desc 0..1ED
... scopingEntity 0..1Entity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ParticipantRole.nullFlavorrequiredCDANullFlavor
ParticipantRole.typeId.nullFlavorrequiredCDANullFlavor
ParticipantRole.templateId:drug-vehicle.nullFlavorrequiredCDANullFlavor
ParticipantRole.classCoderequiredFixed Value: MANU
ParticipantRole.codeexampleRoleCode
ParticipantRole.code.nullFlavorrequiredCDANullFlavor
ParticipantRole.playingEntity.nullFlavorrequiredCDANullFlavor
ParticipantRole.playingEntity.typeId.nullFlavorrequiredCDANullFlavor
ParticipantRole.playingEntity.classCoderequiredEntityClassRoot
ParticipantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
ParticipantRole.playingEntity.codeexampleEntityCode

Constraints

IdGradePath(s)DetailsRequirements
role-choiceerrorParticipantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1

This structure is derived from ParticipantRole

Summary

Mandatory: 8 elements
Fixed Value: 1 element
Prohibited: 1 element

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from ParticipantRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. ParticipantRole ParticipantRoleXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, code, addr, telecom, playingDevice, playingEntity, scopingEntity
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:drug-vehicle 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.24
..... @extension 0..0
... @classCode 1..1csFixed Value: MANU
... code 1..1CE
.... @code 1..1csRequired Pattern: 412307009
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
.... code 1..1CEThis playingEntity/code is used to supply a coded term for the drug vehicle.
.... name 0..1PNThis 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 & Constraintsdoco
.. ParticipantRole C1..1ParticipantRoleXML 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
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:drug-vehicle 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.24
... @classCode 1..1csBinding: RoleClassRoot (required)
Fixed Value: MANU
... code 1..1CEBinding: v3 Code System RoleCode (example)
.... @code 1..1csRequired Pattern: 412307009
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
.... @classCode 1..1csBinding: EntityClassRoot (required)
.... code 1..1CEThis playingEntity/code is used to supply a coded term for the drug vehicle.
Binding: EntityCode (example)
.... name 0..1PNThis playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087).

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ParticipantRole.classCoderequiredFixed Value: MANU
ParticipantRole.codeexampleRoleCode
ParticipantRole.playingEntity.classCoderequiredEntityClassRoot
ParticipantRole.playingEntity.codeexampleEntityCode

Constraints

IdGradePath(s)DetailsRequirements
role-choiceerrorParticipantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ParticipantRole C1..1ParticipantRoleXML 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
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
.... templateId:drug-vehicle 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.24
... @classCode 1..1csBinding: RoleClassRoot (required)
Fixed Value: MANU
... id 0..*II
... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
... code 1..1CEBinding: v3 Code System RoleCode (example)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csRequired Pattern: 412307009
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... translation 0..*CD
... addr 0..*AD
... telecom 0..*TEL
... (Choice of one) 0..1
.... playingDevice 0..1Device
.... playingEntity 1..1PlayingEntity
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @classCode 1..1csBinding: EntityClassRoot (required)
..... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... code 1..1CEThis playingEntity/code is used to supply a coded term for the drug vehicle.
Binding: EntityCode (example)
..... quantity 0..*PQ
..... name 0..1PNThis playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087).
..... sdtcBirthTime 0..1TSXML Namespace: urn:hl7-org:sdtc
XML: birthTime (urn:hl7-org:sdtc)
..... desc 0..1ED
... scopingEntity 0..1Entity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ParticipantRole.nullFlavorrequiredCDANullFlavor
ParticipantRole.typeId.nullFlavorrequiredCDANullFlavor
ParticipantRole.templateId:drug-vehicle.nullFlavorrequiredCDANullFlavor
ParticipantRole.classCoderequiredFixed Value: MANU
ParticipantRole.codeexampleRoleCode
ParticipantRole.code.nullFlavorrequiredCDANullFlavor
ParticipantRole.playingEntity.nullFlavorrequiredCDANullFlavor
ParticipantRole.playingEntity.typeId.nullFlavorrequiredCDANullFlavor
ParticipantRole.playingEntity.classCoderequiredEntityClassRoot
ParticipantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
ParticipantRole.playingEntity.codeexampleEntityCode

Constraints

IdGradePath(s)DetailsRequirements
role-choiceerrorParticipantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1

This structure is derived from ParticipantRole

Summary

Mandatory: 8 elements
Fixed Value: 1 element
Prohibited: 1 element

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel