Back To Index << Back To Templates

# Template epSOS CDA Supply

Id | 1.3.6.1.4.1.12559.11.10.1.3.1.3.3 | Effective Date | 2013‑12‑20 Other versions this id: eHDSISupply as of 2023‑04‑20 13:42:50 eHDSISupply as of 2022‑04‑12 08:41:12 eHDSISupply as of 2020‑09‑08 10:07:41 eHDSISupply as of 2020‑08‑31 08:23:17 eHDSISupply as of 2020‑04‑16 13:03:23 epSOSCDASupply as of 2019‑11‑11 14:18:44 epSOSCDASupply as of 2019‑02‑11 15:06:51
Status | Retired | Version Label |
Name | epSOSCDASupply | Display Name | epSOS CDA Supply
Description | Dispensed Medicine Entry Content Module
Context | Parent nodes of template element with id 1.3.6.1.4.1.12559.11.10.1.3.1.3.3
Classification | CDA Entry Level Template
Open/Closed | Open (other than defined elements are allowed)
Used by / Uses |
Used by 0 transactions and 0 templates, Uses 4 templates
Uses | as | Name | Version
--- | --- | --- | ---
1.3.6.1.4.1.12559.11.10.1.3.1.3.1 | Containment | eHDSI Manufactured Product | DYNAMIC
2.16.840.1.113883.3.1937.777.11.10.136 | Containment | eHDSI Performer (Body) | DYNAMIC
2.16.840.1.113883.3.1937.777.11.10.134 | Containment | eHDSI Participant (Body) | DYNAMIC
2.16.840.1.113883.3.1937.777.11.10.144 | Containment | eHDSI Related Prescription | DYNAMIC
Relationship | Specialization: template 2.16.840.1.113883.10.20.1.8 Medication section (DYNAMIC) ref ccd1-
Example |
Example
<supply classCode="SPLY" moodCode="EVN"> <templateId root="2.16.840.1.113883.10.20.1.34"/> <templateId root="1.3.6.1.4.1.19376.1.5.3.1.4.7.3"/> <templateId root="1.3.6.1.4.1.12559.11.10.1.3.1.3.3"/> <id root="" extension=""/> <quantity value="" unit=""/> <product> <!-- ... --> </product> <performer typeCode="PRF"> <time value=""/> <assignedEntity> <id root="" extension=""/> <addr/> <telecom use="" value=""/> <assignedPerson> <name/> </assignedPerson> <representedOrganization> <name/> </representedOrganization> </assignedEntity> </performer> <!-- related prescription --> <entryRelationship typeCode="REFR"> <substanceAdministration classCode="SBADM" moodCode="INT"> <!-- ... --> </substanceAdministration> </entryRelationship> <!-- Optional Substitution Act --> <entryRelationship typeCode="COMP"> <act classCode="ACT" moodCode="EVN"> <!-- ... --> </act> </entryRelationship> <entryRelationship typeCode="COMP"> <substanceAdministration classCode="SBADM" moodCode="INT"> <doseQuantity/> </substanceAdministration> </entryRelationship> <!-- Optional Patient instrctions --> <entryRelationship typeCode="SUBJ"> <!-- ... --> </entryRelationship></supply>
Item | DT | Card | Conf | Description | Label
--- | --- | --- | --- | --- | ---
hl7:supply |  | 1 … 1 | R | The element shall be present. The moodCode attribute shall be INT to reflect that a medication has been prescribed, or EVN to indicate that the prescription has been filled. |
@classCode | cs | 1 … 1 | F | SPLY
@moodCode | cs | 1 … 1 | F | EVN
| CONF |
The value of @moodCode SHALL be drawn from value set 2.16.840.1.113883.1.11.19461 x_DocumentSubstanceMood (DYNAMIC)
hl7:templateId | II.EPSOS | 1 … 1 | M |  |
@root | uid | 1 … 1 | F | 2.16.840.1.113883.10.20.1.34
hl7:templateId | II.EPSOS | 1 … 1 | M |  |
@root | uid | 1 … 1 | F | 1.3.6.1.4.1.19376.1.5.3.1.4.7.3
hl7:templateId | II.EPSOS | 1 … 1 | M |  |
@root | uid | 1 … 1 | F | 1.3.6.1.4.1.12559.11.10.1.3.1.3.3
hl7:id | II.EPSOS | 1 … 1 | M | Each supply act shall have an identifier to uniquely identify the dispensation of this particular medication. |
hl7:quantity | PQ | 1 … 1 | M | The supply entry should indicate the quantity supplied (such as tablets or containers). The value attribute shall be present and indicates the quantity of medication supplied. If the medication is supplied in dosing units (tablets or capsules), then the unit attribute need not be present (and should be set to 1 if present). Otherwise, the unit element shall be present to indicate the quantity (e.g., volume or mass) of medication supplied. |
hl7:product |  | 1 … 1 | R | Product The <product> element shall be present, and shall contain a <manufacturedProduct> entry, conforming to the Medicine Entry template. This is the actual medication dispensed, and may include packaging information. Contains 1.3.6.1.4.1.12559.11.10.1.3.1.3.1 eHDSI Manufactured Product (DYNAMIC) |
@typeCode | cs | 0 … 1 | F | PRD
hl7:performer |  | 1 … 1 | R | Dispenser The <performer> element shall be present to indicate who actually filled (moodCode='EVN') the prescription. The dispenser is described within the specific entry structure of the prescription under the /ClinicalDocument/component/structuredBody/component/section/entry/supply/performer XML element.
Data element | HL7 V3 Data Type | CDA Header position (relative XPath expression)
Dispensation Time | TS | performer/time
Dispenser Name | PN | performer/assignedEntity/assignedPerson/name
Dispenser identifier | II | performer/assignedEntity/id
Pharmacy Organization Identifier | II | performer/assignedEntity/representedOrganization/id
Pharmacy Organization Name | ON | performer/assignedEntity/representedOrganization/name
Pharmacy Organization Address | AD | performer/assignedEntity/representedOrganization/addr
Contains 2.16.840.1.113883.3.1937.777.11.10.136 eHDSI Performer (Body) (DYNAMIC) |
hl7:participant |  | 0 … * | R | Dispenser Credentialing Organization The organization which provided the credentialing for the dispenser needs to be expressed via a <participant> structure, which is in addition to the <performer> element specified earlier. The type code of the <participant> element shall be "PRF", and the class code of the <participantRole> element shall be "LIC". The ID of the participation role is optional, and when present it shall be the dispenser ID as specified in the <performer> structure. The credentialing organization (College) is represented by the <scopingEntity> element with a class code of "ORG". The name is represented by the <desc> element, and the credentialing organization (College) ID is represented by the <id> element of the scoping entity Contains 2.16.840.1.113883.3.1937.777.11.10.134 eHDSI Participant (Body) (DYNAMIC) |
| Example | <participant typeCode="PRF"> <participantRole classCode="LIC"> <id root=" " extension=" "/> <scopingEntity classCode="ORG"> <id root=" " extension=" "/> <desc>Name</desc> </scopingEntity> </participantRole></participant>
hl7:entryRelationship |  | 1 … 1 | M | Related Prescription The related prescription item is represented via an entry relationship of type code "REFR", and containing a prescription entry as described in section 12.1.2.4. The prescription item ID is required within the Dispensed Medication Entry. Contains 2.16.840.1.113883.3.1937.777.11.10.144 eHDSI Related Prescription (DYNAMIC) |
| Example | <entryRelationship typeCode="REFR"> <substanceAdministration classCode="SBADM" moodCode="INT"> <!-- ... --> </substanceAdministration></entryRelationship>
hl7:entryRelationship |  | 0 … 1 | R | Substitution An entry relationship may be present to inform that a substitution occured. When present, this entry relationship SHALL contain one and only one act. This act SHALL have the code element valorized with @code=’SUBST' and @codeSystem='2.16.840.1.113883.5.6' |
@typeCode | cs | 1 … 1 | F | COMP
hl7:act |  | 1 … 1 | R |  |
@classCode | cs | 1 … 1 | F | ACT
@moodCode | cs | 1 … 1 | F | EVN
hl7:code |  | 1 … 1 | R |  |
@code | CONF | 0 … 1 | F | SUBST
@codeSystem | 0 … 1 | F | 2.16.840.1.113883.5.6 (ActClass)