Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

## Logical Model: Drug Vehicle

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/DrugVehicle | Version: 2.1
Draft as of 2023-09-29 | 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:

- Use this Logical Model: Immunization Activity and Medication Activity

### Formal Views of Profile Content

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

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from CDAR2.ParticipantRole

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ParticipantRole |  |  | CDAR2.ParticipantRole | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, templateId, id, sdtcIdentifiedBy, code, addr, telecom, playingDevice, playingEntity, scopingEntity
classCode |  | 1..1 | cs | Fixed Value: MANU
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:root
templateId:primary |  | 1..1 | II |
root |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.24
extension |  | 0..0 |  |
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
playingEntity |  | 1..1 | PlayingEntity |
code |  | 1..1 | CE | This playingEntity/code is used to supply a coded term for the drug vehicle.
name | C | 0..1 | PN | 81-10087: This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087).
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
81-10087 | warning | ParticipantRole.playingEntity.name | This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087). : |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ParticipantRole |  | 1..1 | CDAR2.ParticipantRole | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, templateId, id, sdtcIdentifiedBy, code, addr, telecom, playingDevice, playingEntity, scopingEntity Base for all types and resources
@classCode |  | 1..1 | cs | Binding: RoleClassRoot (required) Fixed Value: MANU
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:root
templateId:primary |  | 1..1 | II |
@root |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.24
code |  | 1..1 | CE | Binding: v3 Code System RoleCode (extensible)
@code |  | 1..1 | cs | Required Pattern: 412307009
@codeSystem |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.96
playingEntity |  | 1..1 | PlayingEntity |
@classCode |  | 1..1 | cs | Binding: EntityClassRoot (required)
code |  | 1..1 | CE | This playingEntity/code is used to supply a coded term for the drug vehicle. Binding: EntityCode (extensible)
name | C | 0..1 | PN | 81-10087: This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087).
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
ParticipantRole.classCode | required | Fixed Value: MANU
ParticipantRole.code | extensible | RoleCode
ParticipantRole.playingEntity.classCode | required | EntityClassRoot
ParticipantRole.playingEntity.code | extensible | EntityCode

#### Constraints

Id | Grade | Path(s) | Details | Requirements
81-10087 | warning | ParticipantRole.playingEntity.name | This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087). : |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ParticipantRole |  | 1..1 | CDAR2.ParticipantRole | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, templateId, id, sdtcIdentifiedBy, code, addr, telecom, playingDevice, playingEntity, scopingEntity Base for all types and resources
@classCode |  | 1..1 | cs | Binding: RoleClassRoot (required) Fixed Value: MANU
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:root
templateId:primary |  | 1..1 | II |
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (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
id |  | 0..* | II |
sdtcIdentifiedBy |  | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
code |  | 1..1 | CE | Binding: v3 Code System RoleCode (extensible)
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (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 |
playingDevice |  | 0..1 | Device |
playingEntity |  | 1..1 | PlayingEntity |
@classCode |  | 1..1 | cs | Binding: EntityClassRoot (required)
@determinerCode |  | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE
templateId |  | 0..* | II |
code |  | 1..1 | CE | This playingEntity/code is used to supply a coded term for the drug vehicle. Binding: EntityCode (extensible)
quantity |  | 0..* | PQ |
name | C | 0..1 | PN | 81-10087: 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 |
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
ParticipantRole.classCode | required | Fixed Value: MANU
ParticipantRole.templateId:primary.nullFlavor | required | NullFlavor
ParticipantRole.code | extensible | RoleCode
ParticipantRole.code.nullFlavor | required | NullFlavor
ParticipantRole.playingEntity.classCode | required | EntityClassRoot
ParticipantRole.playingEntity.determinerCode | required | Fixed Value: INSTANCE
ParticipantRole.playingEntity.code | extensible | EntityCode

#### Constraints

Id | Grade | Path(s) | Details | Requirements
81-10087 | warning | ParticipantRole.playingEntity.name | This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087). : |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |

This structure is derived from CDAR2.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 CDAR2.ParticipantRole

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ParticipantRole |  |  | CDAR2.ParticipantRole | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, templateId, id, sdtcIdentifiedBy, code, addr, telecom, playingDevice, playingEntity, scopingEntity
classCode |  | 1..1 | cs | Fixed Value: MANU
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:root
templateId:primary |  | 1..1 | II |
root |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.24
extension |  | 0..0 |  |
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
playingEntity |  | 1..1 | PlayingEntity |
code |  | 1..1 | CE | This playingEntity/code is used to supply a coded term for the drug vehicle.
name | C | 0..1 | PN | 81-10087: This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087).
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
81-10087 | warning | ParticipantRole.playingEntity.name | This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087). : |

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ParticipantRole |  | 1..1 | CDAR2.ParticipantRole | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, templateId, id, sdtcIdentifiedBy, code, addr, telecom, playingDevice, playingEntity, scopingEntity Base for all types and resources
@classCode |  | 1..1 | cs | Binding: RoleClassRoot (required) Fixed Value: MANU
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:root
templateId:primary |  | 1..1 | II |
@root |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.24
code |  | 1..1 | CE | Binding: v3 Code System RoleCode (extensible)
@code |  | 1..1 | cs | Required Pattern: 412307009
@codeSystem |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.96
playingEntity |  | 1..1 | PlayingEntity |
@classCode |  | 1..1 | cs | Binding: EntityClassRoot (required)
code |  | 1..1 | CE | This playingEntity/code is used to supply a coded term for the drug vehicle. Binding: EntityCode (extensible)
name | C | 0..1 | PN | 81-10087: This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087).
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
ParticipantRole.classCode | required | Fixed Value: MANU
ParticipantRole.code | extensible | RoleCode
ParticipantRole.playingEntity.classCode | required | EntityClassRoot
ParticipantRole.playingEntity.code | extensible | EntityCode

#### Constraints

Id | Grade | Path(s) | Details | Requirements
81-10087 | warning | ParticipantRole.playingEntity.name | This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087). : |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ParticipantRole |  | 1..1 | CDAR2.ParticipantRole | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, templateId, id, sdtcIdentifiedBy, code, addr, telecom, playingDevice, playingEntity, scopingEntity Base for all types and resources
@classCode |  | 1..1 | cs | Binding: RoleClassRoot (required) Fixed Value: MANU
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:root
templateId:primary |  | 1..1 | II |
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (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
id |  | 0..* | II |
sdtcIdentifiedBy |  | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
code |  | 1..1 | CE | Binding: v3 Code System RoleCode (extensible)
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (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 |
playingDevice |  | 0..1 | Device |
playingEntity |  | 1..1 | PlayingEntity |
@classCode |  | 1..1 | cs | Binding: EntityClassRoot (required)
@determinerCode |  | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE
templateId |  | 0..* | II |
code |  | 1..1 | CE | This playingEntity/code is used to supply a coded term for the drug vehicle. Binding: EntityCode (extensible)
quantity |  | 0..* | PQ |
name | C | 0..1 | PN | 81-10087: 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 |
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
ParticipantRole.classCode | required | Fixed Value: MANU
ParticipantRole.templateId:primary.nullFlavor | required | NullFlavor
ParticipantRole.code | extensible | RoleCode
ParticipantRole.code.nullFlavor | required | NullFlavor
ParticipantRole.playingEntity.classCode | required | EntityClassRoot
ParticipantRole.playingEntity.determinerCode | required | Fixed Value: INSTANCE
ParticipantRole.playingEntity.code | extensible | EntityCode

#### Constraints

Id | Grade | Path(s) | Details | Requirements
81-10087 | warning | ParticipantRole.playingEntity.name | This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087). : |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |

This structure is derived from CDAR2.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