Back To Index  <<  Back To Templates

 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
Classification CDA entry level template
Relationship Specialization: template 2.16.840.1.113883.10.20.1.8 (DYNAMIC)
Context Parent nodes of template element with id 1.3.6.1.4.1.12559.11.10.1.3.1.3.3
Version valid from 2013‑11‑29 16:30:29 status Under develeopment
Open/Closed Open (other than defined elements are allowed)
Description Dispensed Medicine Entry Content Module
Used in
Used in 1 template
Id Name as of
1.3.6.1.4.1.12559.11.10.1.3.1.2.2 SectionDispensation  Section Dispensation 2013‑11‑29 15:09:17
link11 Dependency: 1.3.6.1.4.1.12559.11.10.1.3.1.1.2 epSOS-eD  epSOS-eDispensation 2012‑05‑03
Item DT Card Conf Desc Label
hl7:supply
0 .. * 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
cs 1 .. 1  
  CONF
The value of @moodCode shall be drawn from value set DocumentSubstanceMood (DYNAMIC)
alert Error: Cannot find value set "DocumentSubstanceMood"
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 1 .. 1 M (epSOSCDASupply)
treeblank treetree @root
1 .. 1 F 2.16.840.1.113883.10.20.1.34
treetree hl7:templateId
II 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 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 1 .. * Each supply act shall have an identifier to uniquely identify the dispensation of this particular medication. (epSOSCDASupply)
treetree hl7:quantity
PQ 0 .. 1 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 inherited template rules epSOS CDA ManufacturedProduct (DYNAMIC) with overridden cardinality 1 .. 1 Required
treetree hl7:performer
1 .. 1 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 inherited template rules CDA Performer (Body) (DYNAMIC) with overridden cardinality 1 .. 1
treetree hl7:participant
1 .. * 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 inherited template rules CDA Participant (Body) (DYNAMIC) with overridden cardinality 1 .. *
treetree hl7:entryRelationship
where
[hl7:substanceAdministration [hl7:templateId [@root='2.16.840.1.113883.10.20.1.24' or @root='1.3.6.1.4.1.12559.11.10.1.3.1.3.2' or @root='1.3.6.1.4.1.19376.1.5.3.1.4.7' or @root='1.3.6.1.4.1.19376.1.5.3.1.4.7.1' or @root='1.3.6.1.4.1.19376.1.5.3.1.4.11' or @root='1.3.6.1.4.1.19376.1.5.3.1.4.9']]]
0 .. * 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 inherited template rules epSOS CDA substanceAdministration (DYNAMIC) with overridden cardinality 0 .. *
treetree hl7:entryRelationship
0 .. 1 Substitution
An entry relationship may be present to inform that a substitution occured. When present, this entry re-lationship 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)
Contains an element from template CDA Clinical Statement (DYNAMIC) with overridden cardinality 0 .. 1
treetree hl7:entryRelationship
where
[hl7:substanceAdministration [hl7:templateId [@root='2.16.840.1.113883.10.20.1.24' or @root='1.3.6.1.4.1.12559.11.10.1.3.1.3.2' or @root='1.3.6.1.4.1.19376.1.5.3.1.4.7' or @root='1.3.6.1.4.1.19376.1.5.3.1.4.7.1' or @root='1.3.6.1.4.1.19376.1.5.3.1.4.11' or @root='1.3.6.1.4.1.19376.1.5.3.1.4.9']]]
0 .. 1 Change of Dosage Information
If for some reason the dispense included a change in the dosing of the dispensed medication, the new dosing informationis represented via an entry relationship of type code "COMP", and containing a substance administration entry, which in turn contains the different dosing information.
(epSOSCDASupply)
Example
<entryRelationship typeCode="COMP">
  <substanceAdministration classCode="SBADM" moodCode="INT">
    <!-- Only changed dosage/administration information should be recorded -->
    <effectiveTime xsi:type="IVL_TS">
      <low value=" "/>
      <high value=" "/>
    </effectiveTime>
    <effectiveTime operator="A" xsi:type="TS|PIVL_TS|EIVL_TS|SXPR_TS"> : </effectiveTime>
    <routeCode code=" " codeSystem=" " displayName=" " codeSystemName=" "/>
    <doseQuantity value=" " unit=" "/>
    <approachSiteCode code=" " codeSystem=" " displayName=" " codeSystemName=" "/>
    <rateQuantity value=" " unit=" "/>
  </substanceAdministration>
</entryRelationship>
Contains inherited template rules epSOS CDA substanceAdministration (DYNAMIC) with overridden cardinality 0 .. 1
treetree hl7:entryRelationship
0 .. 1 Patient Instructions
Any optional patient instructions can be specified as an entry relationship of type "SUBJ". This entry relationship contains an Act as described in the Patient Medication Instructions Entry Content Module.
(epSOSCDASupply)
Example
<entryRelationship typeCode="SUBJ" inversionInd="true">
  <act classCode="ACT" moodCode="INT"> ... </act>
</entryRelationship>
Contains an element from template CDA Clinical Statement (DYNAMIC) with overridden cardinality 0 .. 1
treetree hl7:precondition
0 .. * In a CDA document, the preconditions for use of the medication are recorded in the <precondition> element. The value attribute of the <reference> element is a URL that points to the CDA narrative describing those preconditions. (epSOSCDASupply)
Example
<precondition>
  <criterion>
    <text>
      <reference value=" "/>
    </text>
  </criterion>
</precondition>
Contains inherited template rules CDA Precondition (DYNAMIC) with overridden cardinality 0 .. *