Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.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-ccda/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/DrugVehicle | Version: 4.0.0-ballot | |||
Draft as of 2024-12-19 | 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.
Usage:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from ParticipantRole
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 | |
playingEntity | 1..1 | PlayingEntity | ||
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). | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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) role-choice: playingDevice and playingEntity are mutually exclusive |
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
@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 | ||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
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 | II-1: An II instance must have either a root or an nullFlavor. |
@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 | ||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
ParticipantRole.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.templateId:drug-vehicle.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.classCode | required | Fixed Value: MANUhttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot | |
ParticipantRole.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCode | |
ParticipantRole.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.playingEntity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.playingEntity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.playingEntity.classCode | required | EntityClassRoothttp://terminology.hl7.org/ValueSet/v3-EntityClassRoot | |
ParticipantRole.playingEntity.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
ParticipantRole.playingEntity.code | example | CDAEntityCodehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityCode |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | ParticipantRole.typeId, ParticipantRole.playingEntity.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() | |
role-choice | error | ParticipantRole | playingDevice and playingEntity are mutually exclusive : (playingDevice | playingEntity).count() <= 1 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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) role-choice: playingDevice and playingEntity are mutually exclusive |
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
@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 | ||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
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 | II-1: An II instance must have either a root or an nullFlavor. |
@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 | ||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
ParticipantRole.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.templateId:drug-vehicle.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.classCode | required | Fixed Value: MANUhttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot | |
ParticipantRole.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCode | |
ParticipantRole.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.playingEntity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.playingEntity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.playingEntity.classCode | required | EntityClassRoothttp://terminology.hl7.org/ValueSet/v3-EntityClassRoot | |
ParticipantRole.playingEntity.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
ParticipantRole.playingEntity.code | example | CDAEntityCodehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityCode |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | ParticipantRole.typeId, ParticipantRole.playingEntity.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() | |
role-choice | error | ParticipantRole | playingDevice 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:
Differential View
This structure is derived from ParticipantRole
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 | |
playingEntity | 1..1 | PlayingEntity | ||
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). | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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) role-choice: playingDevice and playingEntity are mutually exclusive |
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
@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 | ||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
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 | II-1: An II instance must have either a root or an nullFlavor. |
@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 | ||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
ParticipantRole.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.templateId:drug-vehicle.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.classCode | required | Fixed Value: MANUhttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot | |
ParticipantRole.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCode | |
ParticipantRole.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.playingEntity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.playingEntity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.playingEntity.classCode | required | EntityClassRoothttp://terminology.hl7.org/ValueSet/v3-EntityClassRoot | |
ParticipantRole.playingEntity.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
ParticipantRole.playingEntity.code | example | CDAEntityCodehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityCode |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | ParticipantRole.typeId, ParticipantRole.playingEntity.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() | |
role-choice | error | ParticipantRole | playingDevice and playingEntity are mutually exclusive : (playingDevice | playingEntity).count() <= 1 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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) role-choice: playingDevice and playingEntity are mutually exclusive |
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
@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 | ||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
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 | II-1: An II instance must have either a root or an nullFlavor. |
@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 | ||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
ParticipantRole.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.templateId:drug-vehicle.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.classCode | required | Fixed Value: MANUhttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot | |
ParticipantRole.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCode | |
ParticipantRole.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.playingEntity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.playingEntity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.playingEntity.classCode | required | EntityClassRoothttp://terminology.hl7.org/ValueSet/v3-EntityClassRoot | |
ParticipantRole.playingEntity.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
ParticipantRole.playingEntity.code | example | CDAEntityCodehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityCode |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | ParticipantRole.typeId, ParticipantRole.playingEntity.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() | |
role-choice | error | ParticipantRole | playingDevice 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: