| Package | hl7.cda.us.ccda |
| Type | StructureDefinition |
| Id | DrugVehicle |
| FHIR Version | R5 |
| Source | http://hl7.org/cda/us/ccda/https://build.fhir.org/ig/HL7/CDA-ccda/StructureDefinition-DrugVehicle.html |
| URL | http://hl7.org/cda/us/ccda/StructureDefinition/DrugVehicle |
| Version | 4.0.0 |
| Status | draft |
| Date | 2025-06-26T21:09:45+00:00 |
| Name | DrugVehicle |
| Title | Drug Vehicle |
| Realm | us |
| Authority | hl7 |
| Description | This template represents the vehicle (e.g., saline, dextrose) for administering a medication. |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole |
| Kind | logical |
| StructureDefinition | |
| ImmunizationActivity | Immunization Activity |
| MedicationActivity | Medication Activity |
| StructureDefinition | |
| ParticipantRole | ParticipantRole (CDA Class) |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition DrugVehicle
| 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 | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "DrugVehicle",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
"_valueBoolean": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode": "not-applicable"
}
]
}
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:v3"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "participantRole"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
"valueUri": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style",
"valueCode": "cda"
}
],
"url": "http://hl7.org/cda/us/ccda/StructureDefinition/DrugVehicle",
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:2.16.840.1.113883.10.20.22.4.24"
}
],
"version": "4.0.0",
"name": "DrugVehicle",
"title": "Drug Vehicle",
"status": "draft",
"date": "2025-06-26T21:09:45+00:00",
"publisher": "Health Level Seven",
"contact": [
{
"name": "HL7 International - Structured Documents",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/structure"
}
]
}
],
"description": "This template represents the vehicle (e.g., saline, dextrose) for administering a medication.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US"
}
]
}
],
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole",
"baseDefinition": "http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "2.0.1-sd"
}
],
"element": [
{
"id": "ParticipantRole",
"path": "ParticipantRole",
"short": "Base for all types and resources",
"definition": "Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.",
"min": 1,
"max": "1",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "role-choice",
"severity": "error",
"human": "playingDevice and playingEntity are mutually exclusive",
"expression": "(playingDevice | playingEntity).count() <= 1",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ParticipantRole.nullFlavor",
"path": "ParticipantRole.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "ParticipantRole.realmCode",
"path": "ParticipantRole.realmCode",
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.realmCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id": "ParticipantRole.typeId",
"path": "ParticipantRole.typeId",
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min": 0,
"max": "1",
"base": {
"path": "InfrastructureRoot.typeId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint": [
{
"key": "II-1",
"severity": "error",
"human": "An II instance must have either a root or an nullFlavor.",
"expression": "root.exists() or nullFlavor.exists()",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id": "ParticipantRole.typeId.nullFlavor",
"path": "ParticipantRole.typeId.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "ParticipantRole.typeId.assigningAuthorityName",
"path": "ParticipantRole.typeId.assigningAuthorityName",
"representation": [
"xmlAttr"
],
"label": "Assigning Authority Name",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "II.assigningAuthorityName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "ParticipantRole.typeId.displayable",
"path": "ParticipantRole.typeId.displayable",
"representation": [
"xmlAttr"
],
"label": "Displayable",
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min": 0,
"max": "1",
"base": {
"path": "II.displayable",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id": "ParticipantRole.typeId.root",
"path": "ParticipantRole.typeId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "Identifies the type as an HL7 Registered model",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString": "2.16.840.1.113883.1.3"
},
{
"id": "ParticipantRole.typeId.extension",
"path": "ParticipantRole.typeId.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"min": 1,
"max": "1",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "ParticipantRole.templateId",
"path": "ParticipantRole.templateId",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "root"
}
],
"rules": "open"
},
"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",
"min": 1,
"max": "*",
"base": {
"path": "InfrastructureRoot.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "ParticipantRole.templateId:drug-vehicle",
"path": "ParticipantRole.templateId",
"sliceName": "drug-vehicle",
"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",
"min": 1,
"max": "1",
"base": {
"path": "InfrastructureRoot.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "ParticipantRole.templateId:drug-vehicle.nullFlavor",
"path": "ParticipantRole.templateId.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "ParticipantRole.templateId:drug-vehicle.assigningAuthorityName",
"path": "ParticipantRole.templateId.assigningAuthorityName",
"representation": [
"xmlAttr"
],
"label": "Assigning Authority Name",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "II.assigningAuthorityName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "ParticipantRole.templateId:drug-vehicle.displayable",
"path": "ParticipantRole.templateId.displayable",
"representation": [
"xmlAttr"
],
"label": "Displayable",
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min": 0,
"max": "1",
"base": {
"path": "II.displayable",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id": "ParticipantRole.templateId:drug-vehicle.root",
"path": "ParticipantRole.templateId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"patternString": "2.16.840.1.113883.10.20.22.4.24"
},
{
"id": "ParticipantRole.templateId:drug-vehicle.extension",
"path": "ParticipantRole.templateId.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"min": 0,
"max": "0",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "ParticipantRole.classCode",
"path": "ParticipantRole.classCode",
"representation": [
"xmlAttr"
],
"comment": "SHALL contain exactly one [1..1] @classCode=\"MANU\" (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:81-7490).",
"min": 1,
"max": "1",
"base": {
"path": "ParticipantRole.classCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"defaultValueCode": "ROL",
"fixedCode": "MANU",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot"
}
},
{
"id": "ParticipantRole.id",
"path": "ParticipantRole.id",
"min": 0,
"max": "*",
"base": {
"path": "ParticipantRole.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "ParticipantRole.sdtcIdentifiedBy",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "identifiedBy"
}
],
"path": "ParticipantRole.sdtcIdentifiedBy",
"min": 0,
"max": "*",
"base": {
"path": "ParticipantRole.sdtcIdentifiedBy",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
}
]
},
{
"id": "ParticipantRole.code",
"path": "ParticipantRole.code",
"comment": "SHALL contain exactly one [1..1] code (CONF:81-19137).",
"min": 1,
"max": "1",
"base": {
"path": "ParticipantRole.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDARoleCode"
}
},
{
"id": "ParticipantRole.code.nullFlavor",
"path": "ParticipantRole.code.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "ParticipantRole.code.code",
"path": "ParticipantRole.code.code",
"representation": [
"xmlAttr"
],
"label": "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.",
"comment": "This code SHALL contain exactly one [1..1] @code=\"412307009\" Drug Vehicle (CONF:81-19138).",
"min": 1,
"max": "1",
"base": {
"path": "CD.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"patternCode": "412307009"
},
{
"id": "ParticipantRole.code.codeSystem",
"path": "ParticipantRole.code.codeSystem",
"representation": [
"xmlAttr"
],
"label": "Code System",
"definition": "Specifies the code system that defines the code.",
"comment": "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).",
"min": 1,
"max": "1",
"base": {
"path": "CD.codeSystem",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"patternString": "2.16.840.1.113883.6.96"
},
{
"id": "ParticipantRole.code.codeSystemName",
"path": "ParticipantRole.code.codeSystemName",
"representation": [
"xmlAttr"
],
"label": "Code System Name",
"definition": "The common name of the coding system.",
"min": 0,
"max": "1",
"base": {
"path": "CD.codeSystemName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "ParticipantRole.code.codeSystemVersion",
"path": "ParticipantRole.code.codeSystemVersion",
"representation": [
"xmlAttr"
],
"label": "Code System Version",
"definition": "If applicable, a version descriptor defined specifically for the given code system.",
"min": 0,
"max": "1",
"base": {
"path": "CD.codeSystemVersion",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "ParticipantRole.code.displayName",
"path": "ParticipantRole.code.displayName",
"representation": [
"xmlAttr"
],
"label": "Display Name",
"definition": "A name or title for the code, under which the sending system shows the code value to its users.",
"min": 0,
"max": "1",
"base": {
"path": "CD.displayName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "ParticipantRole.code.sdtcValueSet",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSet"
}
],
"path": "ParticipantRole.code.sdtcValueSet",
"representation": [
"xmlAttr"
],
"definition": "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"min": 0,
"max": "1",
"base": {
"path": "CD.valueSet",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid"
]
}
]
},
{
"id": "ParticipantRole.code.sdtcValueSetVersion",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSetVersion"
}
],
"path": "ParticipantRole.code.sdtcValueSetVersion",
"representation": [
"xmlAttr"
],
"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.",
"min": 0,
"max": "1",
"base": {
"path": "CD.sdtcValueSetVersion",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "ParticipantRole.code.originalText",
"path": "ParticipantRole.code.originalText",
"label": "Original Text",
"definition": "The text or phrase used as the basis for the coding.",
"min": 0,
"max": "1",
"base": {
"path": "CD.originalText",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id": "ParticipantRole.code.qualifier",
"path": "ParticipantRole.code.qualifier",
"label": "Qualifier",
"definition": "Specifies additional codes that increase the specificity of the the primary code.",
"min": 0,
"max": "0",
"base": {
"path": "CD.qualifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CR"
}
]
},
{
"id": "ParticipantRole.code.translation",
"path": "ParticipantRole.code.translation",
"representation": [
"typeAttr"
],
"label": "Translation",
"definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"min": 0,
"max": "*",
"base": {
"path": "CD.translation",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
]
},
{
"id": "ParticipantRole.addr",
"path": "ParticipantRole.addr",
"min": 0,
"max": "*",
"base": {
"path": "ParticipantRole.addr",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AD"
}
]
},
{
"id": "ParticipantRole.telecom",
"path": "ParticipantRole.telecom",
"min": 0,
"max": "*",
"base": {
"path": "ParticipantRole.telecom",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
}
]
},
{
"id": "ParticipantRole.playingDevice",
"path": "ParticipantRole.playingDevice",
"min": 0,
"max": "1",
"base": {
"path": "ParticipantRole.playingDevice",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Device"
}
]
},
{
"id": "ParticipantRole.playingEntity",
"path": "ParticipantRole.playingEntity",
"comment": "SHALL contain exactly one [1..1] playingEntity (CONF:81-7492).",
"min": 1,
"max": "1",
"base": {
"path": "ParticipantRole.playingEntity",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity"
}
]
},
{
"id": "ParticipantRole.playingEntity.nullFlavor",
"path": "ParticipantRole.playingEntity.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "ParticipantRole.playingEntity.realmCode",
"path": "ParticipantRole.playingEntity.realmCode",
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.realmCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id": "ParticipantRole.playingEntity.typeId",
"path": "ParticipantRole.playingEntity.typeId",
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min": 0,
"max": "1",
"base": {
"path": "InfrastructureRoot.typeId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint": [
{
"key": "II-1",
"severity": "error",
"human": "An II instance must have either a root or an nullFlavor.",
"expression": "root.exists() or nullFlavor.exists()",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id": "ParticipantRole.playingEntity.typeId.nullFlavor",
"path": "ParticipantRole.playingEntity.typeId.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "ParticipantRole.playingEntity.typeId.assigningAuthorityName",
"path": "ParticipantRole.playingEntity.typeId.assigningAuthorityName",
"representation": [
"xmlAttr"
],
"label": "Assigning Authority Name",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "II.assigningAuthorityName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "ParticipantRole.playingEntity.typeId.displayable",
"path": "ParticipantRole.playingEntity.typeId.displayable",
"representation": [
"xmlAttr"
],
"label": "Displayable",
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min": 0,
"max": "1",
"base": {
"path": "II.displayable",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id": "ParticipantRole.playingEntity.typeId.root",
"path": "ParticipantRole.playingEntity.typeId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "Identifies the type as an HL7 Registered model",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString": "2.16.840.1.113883.1.3"
},
{
"id": "ParticipantRole.playingEntity.typeId.extension",
"path": "ParticipantRole.playingEntity.typeId.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"min": 1,
"max": "1",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "ParticipantRole.playingEntity.templateId",
"path": "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",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "ParticipantRole.playingEntity.classCode",
"path": "ParticipantRole.playingEntity.classCode",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"base": {
"path": "PlayingEntity.classCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"defaultValueCode": "ENT",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityClassRoot"
}
},
{
"id": "ParticipantRole.playingEntity.determinerCode",
"path": "ParticipantRole.playingEntity.determinerCode",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"base": {
"path": "PlayingEntity.determinerCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "INSTANCE",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id": "ParticipantRole.playingEntity.code",
"path": "ParticipantRole.playingEntity.code",
"short": "This playingEntity/code is used to supply a coded term for the drug vehicle.",
"comment": "This playingEntity SHALL contain exactly one [1..1] code (CONF:81-7493).",
"min": 1,
"max": "1",
"base": {
"path": "PlayingEntity.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode"
}
},
{
"id": "ParticipantRole.playingEntity.quantity",
"path": "ParticipantRole.playingEntity.quantity",
"min": 0,
"max": "*",
"base": {
"path": "PlayingEntity.quantity",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PQ"
}
]
},
{
"id": "ParticipantRole.playingEntity.name",
"path": "ParticipantRole.playingEntity.name",
"short": "This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087).",
"comment": "This playingEntity MAY contain zero or one [0..1] name (CONF:81-7494).",
"min": 0,
"max": "1",
"base": {
"path": "PlayingEntity.name",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PN"
}
]
},
{
"id": "ParticipantRole.playingEntity.sdtcBirthTime",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "birthTime"
}
],
"path": "ParticipantRole.playingEntity.sdtcBirthTime",
"definition": "The purpose of this extension is to allow the recording of the subscriber or member of a health plan in cases where the health plan eligibility system has different information on file than the provider does for the patient.",
"min": 0,
"max": "1",
"base": {
"path": "PlayingEntity.sdtcBirthTime",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TS"
}
]
},
{
"id": "ParticipantRole.playingEntity.desc",
"path": "ParticipantRole.playingEntity.desc",
"min": 0,
"max": "1",
"base": {
"path": "PlayingEntity.desc",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id": "ParticipantRole.scopingEntity",
"path": "ParticipantRole.scopingEntity",
"min": 0,
"max": "1",
"base": {
"path": "ParticipantRole.scopingEntity",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Entity"
}
]
}
]
},
"differential": {
"element": [
{
"id": "ParticipantRole.templateId",
"path": "ParticipantRole.templateId",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "root"
}
],
"rules": "open"
},
"min": 1
},
{
"id": "ParticipantRole.templateId:drug-vehicle",
"path": "ParticipantRole.templateId",
"sliceName": "drug-vehicle",
"min": 1,
"max": "1"
},
{
"id": "ParticipantRole.templateId:drug-vehicle.root",
"path": "ParticipantRole.templateId.root",
"min": 1,
"patternString": "2.16.840.1.113883.10.20.22.4.24"
},
{
"id": "ParticipantRole.templateId:drug-vehicle.extension",
"path": "ParticipantRole.templateId.extension",
"max": "0"
},
{
"id": "ParticipantRole.classCode",
"path": "ParticipantRole.classCode",
"comment": "SHALL contain exactly one [1..1] @classCode=\"MANU\" (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:81-7490).",
"min": 1,
"fixedCode": "MANU"
},
{
"id": "ParticipantRole.code",
"path": "ParticipantRole.code",
"comment": "SHALL contain exactly one [1..1] code (CONF:81-19137).",
"min": 1
},
{
"id": "ParticipantRole.code.code",
"path": "ParticipantRole.code.code",
"comment": "This code SHALL contain exactly one [1..1] @code=\"412307009\" Drug Vehicle (CONF:81-19138).",
"min": 1,
"patternCode": "412307009"
},
{
"id": "ParticipantRole.code.codeSystem",
"path": "ParticipantRole.code.codeSystem",
"comment": "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).",
"min": 1,
"patternString": "2.16.840.1.113883.6.96"
},
{
"id": "ParticipantRole.playingEntity",
"path": "ParticipantRole.playingEntity",
"comment": "SHALL contain exactly one [1..1] playingEntity (CONF:81-7492).",
"min": 1
},
{
"id": "ParticipantRole.playingEntity.code",
"path": "ParticipantRole.playingEntity.code",
"short": "This playingEntity/code is used to supply a coded term for the drug vehicle.",
"comment": "This playingEntity SHALL contain exactly one [1..1] code (CONF:81-7493).",
"min": 1
},
{
"id": "ParticipantRole.playingEntity.name",
"path": "ParticipantRole.playingEntity.name",
"short": "This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087).",
"comment": "This playingEntity MAY contain zero or one [0..1] name (CONF:81-7494).",
"max": "1"
}
]
}
}