Template 2.16.756.5.30.1.1.10.4.42 - DispenseItemEntryContentModule

Template Dispense Item Entry Content Module

2.16.756.5.30.1.1.10.4.42

ref

ch-pharm-

Effective Date

2016‑06‑17

Status Draft Version Label 2017

Name DispenseItemEntryContentModule Display Name Dispense Item Entry Content Module

Description

A Dispense Item belongs to one Dispensation and represents one dispensed medication. It contains the dispensed medicinal product including information such as product code, brand name and packaging information.

Context Parent nodes of template element with id 2.16.756.5.30.1.1.10.4.42

Classification CDA Entry Level Template

Open/Closed Closed (only defined elements are allowed)

Used by / Uses

Used by 0 transactions and 4 templates, Uses 10 templates

Used by	as	Name	Version
2.16.756.5.30.1.1.10.3.11	Containment	Dispense Section Content Module (2017)	2016‑06‑06
2.16.756.5.30.1.1.10.1.5		Medication Dispense document (2017)	2016‑05‑21
2.16.756.5.30.1.1.10.3.44	Containment	Medication List Section Content Module (2017)	2018‑01‑22 15:40:38
2.16.756.5.30.1.1.10.1.13		Medication List document (2017)	2018‑01‑22 15:17:26
Uses	as	Name	Version
2.16.756.5.30.1.1.10.4.33	Include	Manufactured Material Entry Content Module (2017)	DYNAMIC
2.16.756.5.30.1.1.10.4.45	Containment	MTP Reference Entry Content Module (2017)	DYNAMIC
2.16.756.5.30.1.1.10.4.47	Containment	PRE Reference Entry Content Module (2017)	DYNAMIC
2.16.756.5.30.1.1.10.4.53	Containment	PADV Reference Entry Content Module (2017)	DYNAMIC
1.3.6.1.4.1.19376.1.5.3.1.4.3	Containment	IHE Patient Medication Instructions (2014)	DYNAMIC
2.16.756.5.30.1.1.10.4.35	Include	Dosage Instructions Start/Stop, Frequency, Dose (2017)	DYNAMIC
2.16.756.5.30.1.1.10.4.36	Include	Dosage Instructions Dosage Change (2017)	DYNAMIC
1.3.6.1.4.1.19376.1.9.1.3.9.2	Containment	IHE Substitution Act Content Module (2017)	DYNAMIC
2.16.756.5.30.1.1.10.4.37	Containment	Dosage Intake Mode Entry Content Module (2017)	DYNAMIC
2.16.756.5.30.1.1.10.4.2	Containment	Annotation Comments (2017)	DYNAMIC

Relationship Specialization: template 1.3.6.1.4.1.19376.1.9.1.3.4 (DYNAMIC)

Example

<supply classCode="SPLY" moodCode="EVN">  <templateId root=" 2.16.756.5.30.1.1.10.4.42"/>  <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.19376.1.9.1.3.4"/>  <id root="5712fffe-20c6-11e6-b67b-9e71128cae77"/> <text> <reference value="#dis.1"/> </text> <quantity unit="1" value="1"/> <product> <manufacturedProduct classCode="MANU"> <templateId root="1.3.6.1.4.1.19376.1.5.3.1.4.7.2"/> <templateId root="2.16.840.1.113883.10.20.1.53"/> <manufacturedMaterial classCode="MMAT" determinerCode="KIND">  <templateId root="2.16.756.5.30.1.1.10.4.33"/>  <templateId root="1.3.6.1.4.1.19376.1.9.1.3.1"/> <code code="C09AA05" codeSystem="2.16.840.1.113883.6.73" codeSystemName="ATC WHO" displayName="ramipril"> <originalText> <reference value="#dis.1.ingredient"/> </originalText> </code> <name>TRIATEC Tabl 2.5 mg</name> <pharm:formCode code="TAB" codeSystem="2.16.840.1.113883.5.85" displayName="Tablet"/> <pharm:asContent classCode="CONT"> <pharm:containerPackagedMedicine classCode="CONT" determinerCode="INSTANCE">  <pharm:code code="7680538751228" codeSystem="2.51.1.1" codeSystemName="GTIN" displayName="TRIATEC Tabl 2.5 mg 100 Stk"/>  <pharm:name>TRIATEC Tabl 2.5 mg</pharm:name> <pharm:formCode code="TAB" codeSystem="2.16.840.1.113883.5.85" displayName="Tablet"/> <pharm:capacityQuantity value="20"/> </pharm:containerPackagedMedicine> </pharm:asContent> <pharm:ingredient classCode="ACTI"> <pharm:quantity> <pharm:numerator unit="mg" value="2.5" xsi:type="pharm:PQ"/> <pharm:denominator value="1" xsi:type="pharm:PQ"/> </pharm:quantity> <pharm:ingredient classCode="MMAT" determinerCode="KIND"> <pharm:code code="C09AA05" codeSystem="2.16.840.1.113883.6.73" codeSystemName="ATC WHO" displayName="ramipril"/> <pharm:name>Ramipril</pharm:name> </pharm:ingredient> </pharm:ingredient> </manufacturedMaterial> </manufacturedProduct> </product> <entryRelationship typeCode="REFR"> <substanceAdministration classCode="SBADM" moodCode="INT"> <id root="17931678-20b4-11e6-b67b-9e71128cae77"/> <code code="MTPItem" codeSystem="1.3.6.1.4.1.19376.1.9.2.2" displayName="Medication Treatment Plan Item" codeSystemName="IHE Pharmacy Item Type List"/> <consumable> <manufacturedProduct> <manufacturedMaterial nullFlavor="NA"/> </manufacturedProduct> <reference typeCode="XCRPT"> <externalDocument> <id root="658ab5ea-1f63-11e6-b6ba-3e1d05defe78"/> </externalDocument> </reference> </consumable> </substanceAdministration> </entryRelationship>  <entryRelationship typeCode="COMP"> <substanceAdministration classCode="SBADM" moodCode="INT"> <templateId root="1.3.6.1.4.1.19376.1.9.1.3.6"/>  <templateId root="1.3.6.1.4.1.19376.1.5.3.1.4.7.1"/> <effectiveTime xsi:type="IVL_TS"> <low value="20111129"/> </effectiveTime> <effectiveTime xsi:type="EIVL_TS" operator="A"> <event code="ACM"/> </effectiveTime> <routeCode code="PO" displayName="Oral" codeSystem="2.16.840.1.113883.5.112" codeSystemName="RouteOfAdministration"/> <doseQuantity> <center value="0.5"/> </doseQuantity> <consumable> <manufacturedProduct> <manufacturedMaterial nullFlavor="NA"/> </manufacturedProduct> </consumable> </substanceAdministration> </entryRelationship> <entryRelationship typeCode="COMP"> <substanceAdministration moodCode="INT" classCode="SBADM"> <templateId root="2.16.756.5.30.1.1.1.1.3.10.2.10.10.4.11"/> <text> <reference value="#dis.1.dosageintakemode"/> </text> <consumable> <manufacturedProduct> <manufacturedMaterial nullFlavor="NA"/> </manufacturedProduct> </consumable> </substanceAdministration> </entryRelationship> <entryRelationship typeCode="COMP"> <act classCode="ACT" moodCode="EVN"> <templateId root="1.3.6.1.4.1.19376.1.5.3.1.4.2"/> <templateId root="2.16.840.1.113883.10.20.1.40"/> <code code="48767-8" codeSystem="2.16.840.1.113883.6.1" codeSystemName="LOINC" displayName="Annotation comment"/> <text> <reference value="#dis.1.note"/> </text> <statusCode code="completed"/> </act> </entryRelationship></supply>

Item DT Card Conf Description Label

hl7:supply (Disule)

hl7:templateId II 1 … 1 M CH‑Pdule

@root uid 1 … 1 F 2.16.756.5.30.1.1.10.4.42

hl7:templateId II 1 … 1 M Dispense Item Entry TemplateID 6.3.4.5.3.2

@root uid 1 … 1 F 1.3.6.1.4.1.19376.1.9.1.3.4

hl7:templateId II 1 … 1 M 6.3.4.5.3.2

@root uid 1 … 1 F 1.3.6.1.4.1.19376.1.5.3.1.4.7.3

hl7:templateId II 1 … 1 M 6.3.4.5.3.2

@root uid 1 … 1 F 2.16.840.1.113883.10.20.1.34

hl7:id II 1 … 1 M Dispense Item ID 6.3..3.3

hl7:code CD 0 … 1 Code 6.3..3.4

CONF

The value of @code shall be drawn from value set 2.16.756.5.30.1.127.77.4.11.7 DispenseSupplyType (DYNAMIC)

hl7:text 1 … 1 M Narrative Text 6.3..3.5

hl7:reference 1 … 1 M 6.3..3.5

hl7:quantity 1 … 1 M Quantity Value 6.3..3.7

hl7:product 1 … 1 M Product 6.3..3.8

hl7:manufacturedProduct 1 … 1 M 6.3..3.8

hl7:templateId II 1 … 1 M 6.3..3.1

where [@root='1.3.6.1.4.1.19376.1.5.3.1.4.7.2']

@root uid 1 … 1 F 1.3.6.1.4.1.19376.1.5.3.1.4.7.2

hl7:templateId II 1 … 1 M 6.3..3.1

where [@root='2.16.840.1.113883.10.20.1.53']

@root uid 1 … 1 F 2.16.840.1.113883.10.20.1.53

Included 1 … 1 M from 2.16.756.5.30.1.1.10.4.33 Manufactured Material Entry Content Module (DYNAMIC)

hl7:manufacturedMaterial 1 … 1 M 6.3..3.8

@classCode cs 0 … 1 F MMAT

@determinerCode cs 0 … 1 F KIND

hl7:templateId II 1 … 1 M CH-PHARM Manufactured Material Content Module 6.3..3.8

@root uid 1 … 1 F 2.16.756.5.30.1.1.10.4.33

hl7:templateId II 1 … 1 M 6.3..3.8

@root uid 1 … 1 F 1.3.6.1.4.1.19376.1.9.1.3.1

hl7:code CE 1 … 1 R ATC Code of the medicine, if it as magistral preparation/compound medicin nullFlavor SHALL be NA 6.3..3.8

@codeSystem oid 0 … 1 F 2.16.840.1.113883.6.73

hl7:originalText ED 0 … 1 6.3..3.8

hl7:reference TEL 1 … 1 R 6.3..3.8

@nullFlavor cs 0 … 1 F NA

hl7:name EN 1 … 1 R The element SHALL contain the name of the medication. IHE PHARM PRE 6.3.4.1.3.4

@nullFlavor cs 0 … 1 F NA

pharm:formCode CE 0 … 1 This code represents the pharmaceutical dose form (e.g., tablet, capsule, liquid) and SHOULD be present, if not implied by the product. 6.3..3.8

CONF

The value of @code shall be drawn from value set 2.16.756.5.30.1.1.11.3 Pharmaceutical Dose Form (EDQM) (DYNAMIC)

hl7:lotNumberText ST 0 … 1 IHE PHARM PRE 6.3.4.1.3.6

pharm:expirationTime TS 0 … 1 IHE PHARM PRE 6.3.4.1.3.7

@value 1 … 1 R

pharm:asContent 0 … * IHE PHARM PRE 6.3.4.1.3.8

@classCode cs 1 … 1 F CONT

pharm:containerPackagedMedicine 1 … 1 M packaging of the medication IHE PHARM PRE 6.3.4.1.3.8

@classCode cs 1 … 1 F CONT

@determinerCode cs 1 … 1 F INSTANCE

pharm:code 0 … 1 In case the medicine describes a product, the GTIN code of the medication package SHOULD be specified. IHE PHARM PRE 6.3.4.1.3.8

pharm:name 0 … 1 In case the package describes a product, and the package has a brand name, it SHOULD be described. IHE PHARM PRE 6.3.4.1.3.8

pharm:formCode 0 … 1 IHE PHARM PRE 6.3.4.1.3.8

pharm:capacityQuantity PQ 1 … 1 R The element SHALL be present and describes the capacity of the packaging. IHE PHARM PRE 6.3.4.1.3.8

@unit cs 0 … 1

@value 1 … 1 R

pharm:ingredient 0 … * One or more active ingredients SHOULD be represented with this structure. 6.3..3.8

@classCode cs 1 … 1 F ACTI

pharm:quantity 0 … 1 The medication strength is represented as the ratio of the active ingredient(s) to a unit of medication 6.3..3.8

pharm:numerator 0 … 1 6.3..3.8

pharm:denominator 0 … 1 6.3..3.8

pharm:ingredient 0 … * 6.3..3.8

@classCode cs 1 … 1 F MMAT

@determinerCode cs 1 … 1 F KIND

pharm:code 0 … 1 6.3..3.8

pharm:name 1 … 1 R 6.3..3.8

hl7:author 0 … 1 Dispenser 6.3.3.10

hl7:author 0 … 1 Community Dispense document author 6.3.3.11

hl7:entryRelationship 0 … 1 If the dispense is related to a Medication Treatment Plan Item, the reference to it SHALL be present.
Contains 2.16.756.5.30.1.1.10.4.45 MTP Reference Entry Content Module (DYNAMIC) 6.3.3.12

where [@typeCode='REFR' and hl7:substanceAdministration [hl7:templateId [@root='2.16.756.5.30.1.1.10.4.45']]]

@typeCode cs 1 … 1 F REFR

hl7:entryRelationship 0 … 1 The reference to the Prescription Item this dispense is related to SHALL be present
Contains 2.16.756.5.30.1.1.10.4.47 PRE Reference Entry Content Module (DYNAMIC) 6.3.3.13

where [@typeCode='REFR' and hl7:substanceAdministration [hl7:templateId [@root='2.16.756.5.30.1.1.10.4.47']]]

@typeCode cs 1 … 1 F REFR

hl7:entryRelationship 0 … 1 Reference to Pharmaceutical Advice Item
Contains 2.16.756.5.30.1.1.10.4.53 PADV Reference Entry Content Module (DYNAMIC) 6.3.3.14

where [@typeCode='REFR' and hl7:substanceAdministration [hl7:templateId [@root='2.16.756.5.30.1.1.10.4.53']]]

@typeCode 1 … 1 F REFR

hl7:entryRelationship 0 … 1 Patient Medication Instructions
Contains 1.3.6.1.4.1.19376.1.5.3.1.4.3 IHE Patient Medication Instructions (DYNAMIC) 6.3.3.15

where [hl7:act [hl7:templateId [@root='1.3.6.1.4.1.19376.1.5.3.1.4.3']]]

@typeCode cs 1 … 1 F SUBJ

@inversionInd bl 1 … 1 F true

hl7:entryRelationship 0 … 1 Fulfillment Notes 6.3.3.16

where [hl7:act [hl7:templateId [@root='1.3.6.1.4.1.19376.1.5.3.1.4.3.1']]]

@typeCode 1 … 1 F SUBJ

@inversionInd 1 … 1 F true

hl7:act 6.3.3.16

hl7:templateId II 1 … 1 M 6.3.3.16

@root 1 … 1 F 1.3.6.1.4.1.19376.1.5.3.1.4.3.1

hl7:entryRelationship 0 … 1 Dosage Instructions 6.3.3.17

where [hl7:substanceAdministration [hl7:templateId [@root='1.3.6.1.4.1.19376.1.9.1.3.6']]]

@typeCode 1 … 1 F COMP

hl7:substanceAdministration 6.3.3.17

@moodCode 1 … 1 F INT

hl7:templateId II 1 … 1 M 6.3.3.17

@root 1 … 1 F 1.3.6.1.4.1.19376.1.9.1.3.6

Choice

1 …

Medication Treatment Plan Item Entry Additional Template ID

Elements to choose from:

hl7:templateId[@root='1.3.6.1.4.1.19376.1.5.3.1.4.7.1']
hl7:templateId[@root='1.3.6.1.4.1.19376.1.5.3.1.4.8']
hl7:templateId[@root='1.3.6.1.4.1.19376.1.5.3.1.4.9']

hl7:templateId II 0 … 1 A normal substanceAdministration act that may not contain any subordinate substanceAdministration acts. 6.3..3.3

where [@root='1.3.6.1.4.1.19376.1.5.3.1.4.7.1']

@root uid 1 … 1 F 1.3.6.1.4.1.19376.1.5.3.1.4.7.1

hl7:templateId II 0 … 1 A substanceAdministration act that records tapered dose information in subordinate. 6.3..3.3

where [@root='1.3.6.1.4.1.19376.1.5.3.1.4.8']

@root uid 1 … 1 F 1.3.6.1.4.1.19376.1.5.3.1.4.8

hl7:templateId II 0 … 1 A substanceAdministration act that records split dose information in subordinate substanceAdministration acts. 6.3..3.3

where [@root='1.3.6.1.4.1.19376.1.5.3.1.4.9']

@root uid 1 … 1 F 1.3.6.1.4.1.19376.1.5.3.1.4.9

Included from 2.16.756.5.30.1.1.10.4.35 Dosage Instructions Start/Stop, Frequency, Dose (DYNAMIC)

hl7:effectiveTime IVL_TS 0 … 1 Dosage Instructions PCC 6.3.4.16.10 - Start and Stop 6.3..3.8

where [@xsi:type='IVL_TS']

hl7:low TS 0 … 1 Start of Treatment. If Start of Treatment is unknown this element SHALL be set to null flavor "UNK". 6.3..3.8

hl7:high TS 0 … 1 End of Treatment. If Start of Treatment is unknown this element SHALL be set to null flavor "UNK". 6.3..3.8

hl7:effectiveTime EIVL_TS 0 … 1 Dosage Instructions PCC 6.3.4.16.12 - Frequency: Event based time interval, where the event is not a precise time, but is used for timing purposes (e.g., with meals, between meals, before breakfast, before sleep). 6.3..3.8

where [@operator='A' and @xsi:type='EIVL_TS']

@operator cs 1 … 1 F A

hl7:event CS 1 … 1 M 6.3..3.8

@code cs 1 … 1 R

CONF

The value of @code shall be drawn from value set 2.16.756.5.30.1.127.77.4.11.2 TimingEvent (DYNAMIC)

hl7:effectiveTime SXPR_TS 0 … 1 Dosage Instructions PCC 6.3.4.16.12 - Frequency: Multiple events within a day with the same dosage 6.3..3.8

where [@operator='A' and @xsi:type='SXPR_TS']

@operator cs 1 … 1 F A

@xsi:type cs 1 … 1 F SXPR_TS

hl7:comp 1 … * M 6.3..3.8

where [@xsi:type='EIVL_TS']

@xsi:type cs 1 … 1 F EIVL_TS

hl7:event CS 1 … 1 M 6.3..3.8

@code cs 1 … 1 R

CONF

The value of @code shall be drawn from value set 2.16.756.5.30.1.127.77.4.11.2 TimingEvent (DYNAMIC)

hl7:comp 1 … * M 6.3..3.8

where [@operator='I' and @xsi:type='EIVL_TS']

@operator cs 1 … 1 F I

@xsi:type cs 1 … 1 F EIVL_TS

hl7:event CS 1 … 1 M 6.3..3.8

@code cs 1 … 1 R

CONF

The value of @code shall be drawn from value set 2.16.756.5.30.1.127.77.4.11.2 TimingEvent (DYNAMIC)

hl7:routeCode CD (required) 0 … 1 6.3.3.17

CONF

The value of @code shall be drawn from value set 2.16.756.5.30.1.1.11.2 RouteOfAdministration (EDQM) (DYNAMIC)

hl7:approachSiteCode CD 0 … * 6.3.3.17

hl7:doseQuantity IVL_PQ 0 … 1 6.3.3.17

hl7:rateQuantity IVL_PQ 0 … 1 6.3.3.17

hl7:consumable 1 … 1 R 6.3.3.17

hl7:manufacturedProduct 1 … 1 R 6.3.3.17

hl7:manufacturedMaterial 1 … 1 R 6.3.3.17

@nullFlavor 1 … 1 F NA

Included from 2.16.756.5.30.1.1.10.4.36 Dosage Instructions Dosage Change (DYNAMIC)

hl7:entryRelationship 0 … * Dosage Instructions PCC 6.3.4.16.12 - Dosage change IHE PCC 6.3.4.16.20

where [@typeCode='COMP' and hl7:substanceAdministration and (../hl7:templateId [@root='1.3.6.1.4.1.19376.1.5.3.1.4.8'] or ../hl7:templateId [@root='1.3.6.1.4.1.19376.1.5.3.1.4.10'] or ../hl7:templateId [@root='1.3.6.1.4.1.19376.1.5.3.1.4.9'] or ../hl7:templateId [@root='1.3.6.1.4.1.19376.1.5.3.1.4.11']) and not(hl7:substanceAdministration/hl7:templateId)]

@typeCode cs 1 … 1 F COMP

hl7:sequenceNumber INT 1 … 1 M IHE PCC 6.3.4.16.20

hl7:substanceAdministration 0 … 1 R IHE PCC 6.3.4.16.20

hl7:effectiveTime EIVL_TS 0 … 1 timing purpose IHE PCC 6.3.4.16.20

where [@xsi:type='EIVL_TS']

@xsi:type cs 1 … 1 F EIVL_TS

hl7:event CS 1 … 1 M IHE PCC 6.3.4.16.20

@code cs 1 … 1 R

CONF

The value of @code shall be drawn from value set 2.16.756.5.30.1.127.77.4.11.2 TimingEvent (DYNAMIC)

hl7:doseQuantity 0 … 1 IHE PCC 6.3.4.16.20

hl7:rateQuantity 0 … 1 IHE PCC 6.3.4.16.20

hl7:consumable 0 … 1 IHE PCC 6.3.4.16.20

hl7:manufacturedProduct 1 … 1 R IHE PCC 6.3.4.16.20

hl7:manufacturedMaterial 1 … 1 R IHE PCC 6.3.4.16.20

@nullFlavor cs 1 … 1 F NA

hl7:reference 0 … * ID of parent container (Community Dispense document) 6.3.3.18

@typeCode 1 … 1 F XCRPT

hl7:externalDocument 1 … 1 R 6.3.3.18

hl7:id 1 … * M 6.3.3.18

hl7:entryRelationship 0 … * Substitution act
Contains 1.3.6.1.4.1.19376.1.9.1.3.9.2 IHE Substitution Act Content Module (DYNAMIC) 6.3.3.19

where [hl7:act [hl7:templateId [@root='1.3.6.1.4.1.19376.1.9.1.3.9.1']]]

@typeCode cs 1 … 1 F COMP

hl7:entryRelationship 0 … 1 Contains 2.16.756.5.30.1.1.10.4.37 Dosage Intake Mode Entry Content Module (DYNAMIC) (Disule)

where [hl7:substanceAdministration [hl7:templateId [@root='2.16.756.5.30.1.1.10.4.37']]]

@typeCode cs 1 … 1 F COMP

hl7:entryRelationship 0 … 1 Comment
Contains 2.16.756.5.30.1.1.10.4.2 Annotation Comments (DYNAMIC) EMED

where [hl7:act [hl7:templateId [@root='2.16.756.5.30.1.1.10.4.2']]]

@typeCode cs 1 … 1 F COMP

Template Dispense Item Entry Content Module