Back To Index  <<  Back To Templates

active Template  eHDSI Supply

Id 1.3.6.1.4.1.12559.11.10.1.3.1.3.3 Effective Date 2020‑09‑08 10:07:41
Other versions this id:
Status active Active Version Label
Name eHDSISupply Display Name eHDSI 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 1 transaction and 11 templates, Uses 4 templates
Used by as Name Version
epsos-transactions-25 Transaction draft Send eD to country A 2013‑11‑02
1.3.6.1.4.1.12559.11.10.1.3.1.2.2 Containment active eHDSI Dispensation 2020‑09‑04 15:39:09
1.3.6.1.4.1.12559.11.10.1.3.1.1.2 link active eHDSI eDispensation 2020‑09‑09 12:09:23
1.3.6.1.4.1.12559.11.10.1.3.1.1.2 link retired eHDSI eDispensation 2020‑08‑31 08:12:35
1.3.6.1.4.1.12559.11.10.1.3.1.1.2 link retired eHDSI eDispensation 2020‑04‑16 10:41:22
1.3.6.1.4.1.12559.11.10.1.3.1.1.2 link retired epSOS-eDispensation 2020‑04‑06 19:20:14
1.3.6.1.4.1.12559.11.10.1.3.1.1.2 link retired epSOS-eDispensation 2019‑11‑11 14:43:22
1.3.6.1.4.1.12559.11.10.1.3.1.1.2 link retired epSOS-eDispensation 2018‑11‑14 10:49:04
1.3.6.1.4.1.12559.11.10.1.3.1.1.2 link retired epSOS-eDispensation 2013‑12‑20
1.3.6.1.4.1.12559.11.10.1.3.1.2.2 Containment retired eHDSI Dispensation 2020‑04‑16 12:15:19
1.3.6.1.4.1.12559.11.10.1.3.1.2.2 Containment retired Section Dispensation 2020‑01‑09 11:41:03
1.3.6.1.4.1.12559.11.10.1.3.1.2.2 Containment retired Section Dispensation 2013‑12‑20
Uses as Name Version
1.3.6.1.4.1.12559.11.10.1.3.1.3.1 Containment active eHDSI Manufactured Product DYNAMIC
2.16.840.1.113883.3.1937.777.11.10.136 Containment active eHDSI Performer (Body) DYNAMIC
2.16.840.1.113883.3.1937.777.11.10.149 Include active eHDSI Dispenser Credentialing Organization DYNAMIC
2.16.840.1.113883.3.1937.777.11.10.144 Containment active eHDSI Related Prescription DYNAMIC
Relationship Specialization: template 2.16.840.1.113883.10.20.1.34 (DYNAMIC)
ref
?
Example
Example
<supply classCode="SPLY" moodCode="EVN">
  <templateId root="1.3.6.1.4.1.12559.11.10.1.3.1.3.3"/>  <templateId root="1.3.6.1.4.1.19376.1.5.3.1.4.7.3"/>  <templateId root="2.16.840.1.113883.10.20.1.34"/>  <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. (eHDdotsply)
@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 eHDSI Supply (eHDdotsply)
@root
uid 1 … 1 F 1.3.6.1.4.1.12559.11.10.1.3.1.3.3
hl7:templateId
II.EPSOS 1 … 1 M IHE Supply entry (IHE PCC) (eHDdotsply)
@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 Supply activity (CCD) (eHDdotsply)
@root
uid 1 … 1 F 2.16.840.1.113883.10.20.1.34
hl7:id
II.EPSOS 1 … 1 M Each supply act shall have an identifier to uniquely identify the dispensation of this particular medication. (eHDdotsply)
hl7:quantity
PQ 1 … 1 M
The supply entry shall indicate the dispensed number of packages. 

The value attribute shall be present and indicate the dispensed number of packages. The unit attribute must equal UCUM unit 1. In dispensations for overall amount (such as 400 tablets), the value attribute must equal 1, and the overall amount shall be placed in hl7:supply/hl7:product/hl7:manufacturedProduct/hl7:manufacturedMaterial/epsos:asContent/epsos:containerPackagedMedicine/epsos:capacityQuantity element. See its description for more information.
(eHDdotsply)
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)
(eHDdotsply)
@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)
(eHDdotsply)
Included 0 … * R from 2.16.840.1.113883.3.1937.777.11.10.149 eHDSI Dispenser Credentialing Organization (DYNAMIC)
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 
  Example <participant typeCode="PRF">
  <participantRole classCode="LIC">
    <id root=" " extension=" "/>    <scopingEntity classCode="ORG">
      <id root=" " extension=" "/>      <desc>Name</desc>    </scopingEntity>
  </participantRole>
</participant>
hl7:participant
0 … * R (eHDdotsply)
@typeCode
cs 1 … 1 R
  CONF
The value of @typeCode shall be drawn from value set 2.16.840.1.113883.1.11.10901 ParticipationType (DYNAMIC)
@contextControlCode
cs 1 … 1 F OP
hl7:time
IVL_TS 0 … 1 R (eHDdotsply)
hl7:awarenessCode
CE.EPSOS 0 … 1 R (eHDdotsply)
  CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.10310 TargetAwareness (DYNAMIC)
hl7:participantRole
1 … 1 R (eHDdotsply)
@classCode
cs 0 … 1 F LIC
hl7:id
II.EPSOS 0 … * R (eHDdotsply)
hl7:code
CE.EPSOS 0 … 1 R (eHDdotsply)
@codeSystem
CONF 0 … 1 F 2.16.840.1.113883.5.111 (RoleCode)
hl7:addr
AD 0 … * R (eHDdotsply)
hl7:telecom
TEL 0 … * R (eHDdotsply)
hl7:scopingEntity
0 … 1 R (eHDdotsply)
@classCode
cs 0 … 1 F ORG
@determinerCode
cs 0 … 1 F INSTANCE
hl7:id
II.EPSOS 0 … * R (eHDdotsply)
hl7:code
CE.EPSOS 0 … 1 R (eHDdotsply)
  CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.16040 EntityCode (DYNAMIC)
hl7:desc
ED 0 … 1 R (eHDdotsply)
hl7:entryRelationship
1 … 1 M Related Prescription

The related prescription item is represented via an entry relationship of type code "REFR", and containing a link to the pivot eP substanceAdministration identifier.

Contains 2.16.840.1.113883.3.1937.777.11.10.144 eHDSI Related Prescription (DYNAMIC)
(eHDdotsply)
@typeCode
cs 1 … 1 F REFR
  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'
(eHDdotsply)
@typeCode
cs 1 … 1 F COMP
hl7:act
1 … 1 R (eHDdotsply)
@classCode
cs 1 … 1 F ACT
@moodCode
cs 1 … 1 F EVN
hl7:code
1 … 1 R (eHDdotsply)
@code
CONF 0 … 1 F SUBST
@codeSystem
0 … 1 F 2.16.840.1.113883.5.6 (ActClass)