Consolidated CDA Release 2.2
2.2 - CI Build United States of America flag

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

Resource Profile: DrugVehicle - Detailed Descriptions

Active as of 2022-05-13

Definitions for the 2.16.840.1.113883.10.20.22.4.24 resource profile.

1. ParticipantRole
Control1..1
2. ParticipantRole.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassRoot
Typecode
Requirements

SHALL contain exactly one [1..1] @classCode="MANU" (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:81-7490).

Default ValueROL
Pattern ValueMANU
3. 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/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on ParticipantRole.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
4. ParticipantRole.templateId:primary
SliceNameprimary
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/fhir/cda/StructureDefinition/II
Requirements

SHALL contain exactly one [1..1] templateId (CONF:81-7495) such that it

5. ParticipantRole.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 NullFlavor
Typecode
6. ParticipantRole.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
7. ParticipantRole.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
8. ParticipantRole.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
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.24" (CONF:81-10493).

Pattern Value2.16.840.1.113883.10.20.22.4.24
9. ParticipantRole.templateId:primary.extension
Definition

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

Control0..1
Typestring
10. ParticipantRole.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
11. ParticipantRole.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
12. ParticipantRole.code
Control1..1
BindingThe codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

SHALL contain exactly one [1..1] code (CONF:81-19137).

13. ParticipantRole.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 NullFlavor
Typecode
14. ParticipantRole.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.

Control1..1
Typestring
Requirements

This code SHALL contain exactly one [1..1] @code="412307009" Drug Vehicle (CONF:81-19138).

Pattern Value412307009
15. ParticipantRole.code.codeSystem
Definition

Specifies the code system that defines the code.

Control1..1
Typestring
Requirements

This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.96" (CodeSystem: SNOMED CT urn:oid:2.16.840.1.113883.6.96) (CONF:81-26502).

Pattern Value2.16.840.1.113883.6.96
16. ParticipantRole.code.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
17. ParticipantRole.code.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..1
Typestring
18. ParticipantRole.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
19. ParticipantRole.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
20. ParticipantRole.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
21. ParticipantRole.code.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
22. ParticipantRole.code.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
23. ParticipantRole.code.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
24. ParticipantRole.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
25. ParticipantRole.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
26. ParticipantRole.playingDevice
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Device
27. ParticipantRole.playingEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PlayingEntity
Requirements

SHALL contain exactly one [1..1] playingEntity (CONF:81-7492).

28. ParticipantRole.playingEntity.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassRoot
Typecode
Default ValueENT
29. ParticipantRole.playingEntity.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
30. 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/fhir/cda/StructureDefinition/II
31. ParticipantRole.playingEntity.code
Control1..1
BindingThe codes SHALL be taken from EntityCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

This playingEntity SHALL contain exactly one [1..1] code (CONF:81-7493).

32. ParticipantRole.playingEntity.quantity
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
33. ParticipantRole.playingEntity.name
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/EN
Requirements

This playingEntity MAY contain zero or one [0..1] name (CONF:81-7494).

InvariantsDefined on this element
81-10087: This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087). (: )
34. ParticipantRole.playingEntity.desc
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
35. ParticipantRole.scopingEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Entity