Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
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
| Draft as of 2023-09-29 |
Definitions for the DrugVehicle logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. ParticipantRole | |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. ParticipantRole.classCode | |
| Comments | SHALL contain exactly one [1..1] @classCode="MANU" (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:81-7490). |
| Fixed Value | MANU |
| 4. ParticipantRole.templateId | |
| Control | 1..? |
| Slicing | This element introduces a set of slices on ParticipantRole.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 6. ParticipantRole.templateId:primary | |
| Slice Name | primary |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:81-7495) such that it, SHALL not contain [0..0] extension. |
| Control | 1..1 |
| 8. ParticipantRole.templateId:primary.root | |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.24" (CONF:81-10493). |
| Control | 1..? |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.24 |
| 10. ParticipantRole.templateId:primary.extension | |
| Control | 0..0 |
| 12. ParticipantRole.code | |
| Comments | SHALL contain exactly one [1..1] code (CONF:81-19137). |
| Control | 1..? |
| 14. ParticipantRole.code.code | |
| Comments | This code SHALL contain exactly one [1..1] @code="412307009" Drug Vehicle (CONF:81-19138). |
| Control | 1..? |
| Pattern Value | 412307009 |
| 16. ParticipantRole.code.codeSystem | |
| Comments | 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). |
| Control | 1..? |
| Pattern Value | 2.16.840.1.113883.6.96 |
| 18. ParticipantRole.playingEntity | |
| Comments | SHALL contain exactly one [1..1] playingEntity (CONF:81-7492). |
| Control | 1..? |
| 20. ParticipantRole.playingEntity.code | |
| Short | This playingEntity/code is used to supply a coded term for the drug vehicle. |
| Comments | This playingEntity SHALL contain exactly one [1..1] code (CONF:81-7493). |
| Control | 1..? |
| 22. ParticipantRole.playingEntity.name | |
| Comments | This playingEntity MAY contain zero or one [0..1] name (CONF:81-7494). |
| Control | 0..1 |
| Invariants | 81-10087: This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087). () |
Guidance on how to interpret the contents of this table can be found here
| 0. ParticipantRole | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Control | 10..1* |
| Is Modifier | false |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 2. ParticipantRole.classCode | |
| Comments | SHALL contain exactly one [1..1] @classCode="MANU" (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:81-7490). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassRoot |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Default Value | ROL |
| Fixed Value | MANU |
| 4. 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 |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Slicing | This element introduces a set of slices on ParticipantRole.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 6. ParticipantRole.templateId:primary | |
| Slice Name | primary |
| 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 |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:81-7495) such that it, SHALL not contain [0..0] extension. |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 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. |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.24" (CONF:81-10493). |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.24 |
| 10. ParticipantRole.templateId:primary.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..0 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 12. ParticipantRole.code | |
| Comments | SHALL contain exactly one [1..1] code (CONF:81-19137). |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from v3 Code System RoleCode |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 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. |
| Comments | This code SHALL contain exactly one [1..1] @code="412307009" Drug Vehicle (CONF:81-19138). |
| Control | 1..1 |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code |
| Pattern Value | 412307009 |
| 16. ParticipantRole.code.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Comments | 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). |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System |
| Pattern Value | 2.16.840.1.113883.6.96 |
| 18. ParticipantRole.code.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
| Label | Qualifier |
| 20. ParticipantRole.playingEntity | |
| Comments | SHALL contain exactly one [1..1] playingEntity (CONF:81-7492). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity |
| 22. ParticipantRole.playingEntity.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassRoot |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Default Value | ENT |
| 24. ParticipantRole.playingEntity.code | |
| Short | This playingEntity/code is used to supply a coded term for the drug vehicle. |
| Comments | This playingEntity SHALL contain exactly one [1..1] code (CONF:81-7493). |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from EntityCode |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 26. ParticipantRole.playingEntity.name | |
| Comments | This playingEntity MAY contain zero or one [0..1] name (CONF:81-7494). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN |
| Invariants | 81-10087: This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087). () |
Guidance on how to interpret the contents of this table can be found here
| 0. ParticipantRole | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Control | 1..1 |
| Is Modifier | false |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 2. ParticipantRole.classCode | |
| Comments | SHALL contain exactly one [1..1] @classCode="MANU" (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:81-7490). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RoleClassRoot |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Default Value | ROL |
| Fixed Value | MANU |
| 4. 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 |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Slicing | This element introduces a set of slices on ParticipantRole.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 6. ParticipantRole.templateId:primary | |
| Slice Name | primary |
| 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 |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:81-7495) such that it, SHALL not contain [0..0] extension. |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 8. 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. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 10. 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. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 12. 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). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 14. 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. |
| Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.24" (CONF:81-10493). |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.24 |
| 16. ParticipantRole.templateId:primary.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 0..0 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 18. ParticipantRole.id | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 20. ParticipantRole.sdtcIdentifiedBy | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy. |
| 22. ParticipantRole.code | |
| Comments | SHALL contain exactly one [1..1] code (CONF:81-19137). |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from v3 Code System RoleCode |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 24. ParticipantRole.code.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from NullFlavor |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 26. 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. |
| Comments | This code SHALL contain exactly one [1..1] @code="412307009" Drug Vehicle (CONF:81-19138). |
| Control | 1..1 |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code |
| Pattern Value | 412307009 |
| 28. ParticipantRole.code.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Comments | 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). |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System |
| Pattern Value | 2.16.840.1.113883.6.96 |
| 30. ParticipantRole.code.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System Name |
| 32. ParticipantRole.code.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Code System Version |
| 34. ParticipantRole.code.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Display Name |
| 36. 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. |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet. |
| 38. 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. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSetVersion. |
| 40. ParticipantRole.code.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| Label | Original Text |
| 42. ParticipantRole.code.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
| Label | Qualifier |
| 44. ParticipantRole.code.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Label | Translation |
| 46. ParticipantRole.addr | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD |
| 48. ParticipantRole.telecom | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| 50. ParticipantRole.playingDevice | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Device |
| 52. ParticipantRole.playingEntity | |
| Comments | SHALL contain exactly one [1..1] playingEntity (CONF:81-7492). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity |
| 54. ParticipantRole.playingEntity.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassRoot |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Default Value | ENT |
| 56. ParticipantRole.playingEntity.determinerCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | INSTANCE |
| 58. 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 |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 60. ParticipantRole.playingEntity.code | |
| Short | This playingEntity/code is used to supply a coded term for the drug vehicle. |
| Comments | This playingEntity SHALL contain exactly one [1..1] code (CONF:81-7493). |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from EntityCode |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 62. ParticipantRole.playingEntity.quantity | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ |
| 64. ParticipantRole.playingEntity.name | |
| Comments | This playingEntity MAY contain zero or one [0..1] name (CONF:81-7494). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN |
| Invariants | 81-10087: This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087). () |
| 66. ParticipantRole.playingEntity.sdtcBirthTime | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namebirthTime. |
| 68. ParticipantRole.playingEntity.desc | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| 70. ParticipantRole.scopingEntity | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Entity |
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#2.1 based on FHIR 5.0.0. Generated 2023-09-29
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change