Back To Index  <<  Back To Templates

draft Template  epSOS CDA Supply

Template 1.3.6.1.4.1.12559.11.10.1.3.1.3.3 - epSOSCDASupply
Id 1.3.6.1.4.1.12559.11.10.1.3.1.3.3
Version valid from 2013‑12‑20 status draft Under develeopment
Classification CDA Entry Level Template
Context Parent nodes of template element with id 1.3.6.1.4.1.12559.11.10.1.3.1.3.3
Open/Closed Open (other than defined elements are allowed)
Description Dispensed Medicine Entry Content Module
Used by / Uses
Used by / Uses 6 templates
Used by Template id as Name Version
1.3.6.1.4.1.12559.11.10.1.3.1.2.2 Containment SectionDispensation Section Dispensation 2013‑12‑20
1.3.6.1.4.1.12559.11.10.1.3.1.1.2 link epSOS-eD epSOS-eDispensation 2013‑12‑20
Uses Template id as Name Version
1.3.6.1.4.1.12559.11.10.1.3.1.3.1 Containment epSOSCDAManufacturedProduct DYNAMIC
2.16.840.1.113883.3.1937.777.10.10.136 Containment epSOSCDAPerformerBody DYNAMIC
2.16.840.1.113883.3.1937.777.10.10.134 Containment CDAParticipantBody DYNAMIC
2.16.840.1.113883.3.1937.777.10.10.144 Containment epSOSRelatedPrescriptionItem DYNAMIC
Relationship Specialization: template 2.16.840.1.113883.10.20.1.8 (DYNAMIC)
Item DT Card Conf Description Label
hl7:supply
0 .. * R The <supply> 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. (epSOSCDASupply)
treetree @classCode
1 .. 1 F SPLY
treetree @moodCode
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)
  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>
treetree hl7:templateId
II.EPSOS 1 .. 1 M (epSOSCDASupply)
treeblank treetree @root
1 .. 1 F 2.16.840.1.113883.10.20.1.34
treetree hl7:templateId
II.EPSOS 1 .. 1 M (epSOSCDASupply)
treeblank treetree @root
1 .. 1 F 1.3.6.1.4.1.19376.1.5.3.1.4.7.3
treetree hl7:templateId
II.EPSOS 1 .. 1 M (epSOSCDASupply)
treeblank treetree @root
1 .. 1 F 1.3.6.1.4.1.12559.11.10.1.3.1.3.3
treetree hl7:id
II.EPSOS 1 .. 1 M Each supply act shall have an identifier to uniquely identify the dispensation of this particular medication. (epSOSCDASupply)
treetree 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. (epSOSCDASupply)
treetree hl7:product
where
[hl7:manufacturedProduct [hl7:templateId/@root='1.3.6.1.4.1.12559.11.10.1.3.1.3.1']]
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.
(epSOSCDASupply)
treeblank treetree @typeCode
0 .. 1 F PRD
  Contains 1.3.6.1.4.1.12559.11.10.1.3.1.3.1 epSOS CDA ManufacturedProduct (DYNAMIC)
treetree 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
(epSOSCDASupply)
  Contains 2.16.840.1.113883.3.1937.777.10.10.136 CDA Performer (Body) (DYNAMIC)
treetree 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
(epSOSCDASupply)
  Example <participant typeCode="PRF">
  <participantRole classCode="LIC">
    <id root=" " extension=" "/>
    <scopingEntity classCode="ORG">
      <id root=" " extension=" "/>
      <desc>Name</desc>    </scopingEntity>
  </participantRole>
</participant>
  Contains 2.16.840.1.113883.3.1937.777.10.10.134 CDA Participant (Body) (DYNAMIC)
treetree hl7:entryRelationship
1 .. 1 M Related Prescription Item
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.
(epSOSCDASupply)
  Example <entryRelationship typeCode="REFR">
  <substanceAdministration classCode="SBADM" moodCode="INT">
    <!-- ... -->
  </substanceAdministration>
</entryRelationship>
  Contains 2.16.840.1.113883.3.1937.777.10.10.144 epSOS Related Prescription Item (DYNAMIC)
treetree 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'
(epSOSCDASupply)
treeblank treetree @typeCode
1 .. 1 F COMP
treeblank treetree hl7:act
1 .. 1 R (epSOSCDASupply)
treeblank treeblank treetree @classCode
1 .. 1 F ACT
treeblank treeblank treetree @moodCode
1 .. 1 F EVN
treeblank treeblank treetree hl7:code
1 .. 1 R (epSOSCDASupply)
treeblank treeblank treeblank treetree @code
1 .. 1 F SUBST
treeblank treeblank treeblank treetree @codeSystem
1 .. 1 F 2.16.840.1.113883.5.6 (ActClass)