Back To Index  <<  Back To Templates

draft Template  IHE Medication Treatment Plan Item Entry Content Module

Id 1.3.6.1.4.1.19376.1.9.1.3.7
ref
ch-pharm-
 		Effective Date 2022‑02‑24 11:14:07
Status draft Draft Version Label 2022
Name IHEMedicationTreatmentPlanItemEntryContentModule Display Name IHE Medication Treatment Plan Item Entry Content Module
Description
A Medication Treatment Plan Item belongs to one medication treatment plan and represents one medication. It may be associated with one or more observations. A Medication Treatment Plan Item describes the medicine and dosage information as well as other information such as patient and optionally fulfillment instructions.
Context Parent nodes of template element with id 1.3.6.1.4.1.19376.1.9.1.3.7
Label 6.3.4.E1
Classification CDA Entry Level Template
Open/Closed Open (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 17 templates, Uses 7 templates
Used by as Name Version
1.3.6.1.4.1.19376.1.9.1.2.5 Containment pending IHE Medication List Section Content Module (PML 2017) 2018‑01‑10 08:39:19
1.3.6.1.4.1.19376.1.9.1.1.5 link draft IHE Pharmacy Medication List (PML 2017) 2018‑01‑17 18:06:02
1.3.6.1.4.1.19376.1.9.1.2.6 Containment pending IHE Medication Treatment Plan Section Content Module (2021) 2017‑04‑03 07:47:01
1.3.6.1.4.1.19376.1.9.1.1.6 link pending IHE Medication Treatment Plan Document Content Module (2017) 2019‑10‑16 16:37:16
1.3.6.1.4.1.19376.1.9.1.3.10 Containment draft IHE MTP Reference Entry Content Module (2022) 2022‑02‑23 10:03:10
1.3.6.1.4.1.19376.1.9.1.3.2 link draft IHE Prescription Item Entry Content Module (2020) 2022‑02‑24 11:17:42
1.3.6.1.4.1.19376.1.9.1.2.1 link pending IHE Prescription Section Content Module (PRE 2017) 2018‑01‑10 11:13:04
1.3.6.1.4.1.19376.1.9.1.1.1 link draft IHE Community Prescription Content Module (PRE 2021) 2018‑01‑17 16:46:48
1.3.6.1.4.1.19376.1.9.1.3.11 link pending IHE PRE Reference Entry Content Module (2017) 2017‑01‑11 11:10:04
1.3.6.1.4.1.19376.1.9.1.3.3 link draft IHE Pharmaceutical Advice Item Entry Content Module (2022) 2022‑06‑30 14:58:28
notice Circular reference found with 1.3.6.1.4.1.19376.1.9.1.3.3, please check
1.3.6.1.4.1.19376.1.9.1.2.2 link pending IHE Pharmaceutical Advice Section Content Moudule (PADV 2017) 2018‑01‑10 11:13:04
1.3.6.1.4.1.19376.1.9.1.1.2 link pending IHE Pharmacy Pharmaceutical Advice Document Content Module (PADV 2017) 2019‑10‑16 16:42:19
1.3.6.1.4.1.19376.1.9.1.3.13 link pending IHE PADV Reference Entry Content Module (2017) 2017‑10‑11 12:06:00
1.3.6.1.4.1.19376.1.9.1.3.4 link draft IHE Dispense Item Entry Content Module (2022) 2022‑02‑17 13:16:06
notice Circular reference found with 1.3.6.1.4.1.19376.1.9.1.3.4, please check
1.3.6.1.4.1.19376.1.9.1.2.3 link pending IHE Dispense Section Content Module (DIS 2017) 2018‑01‑10 11:13:04
1.3.6.1.4.1.19376.1.9.1.1.3 link pending IHE Pharmacy Dispense Document Content Module (DIS 2017) 2019‑10‑16 16:41:16
1.3.6.1.4.1.19376.1.9.1.3.12 link pending IHE DIS Reference Entry Content Module (2017) 2017‑01‑11 12:32:40
Uses as Name Version
1.3.6.1.4.1.19376.1.9.1.3.1 Include pending IHE MedicineEntryContentModule (2020) DYNAMIC
2.16.756.5.30.1.1.10.4.36 Include draft Dosage Instructions Related Components (2021) DYNAMIC
1.3.6.1.4.1.19376.1.5.3.1.4.4.1 Containment pending IHE Internal Reference Entry (2014) DYNAMIC
1.3.6.1.4.1.19376.1.5.3.1.4.3 Containment draft IHE Patient Medication Instructions (2014) DYNAMIC
1.3.6.1.4.1.19376.1.5.3.1.4.3.1 Containment draft Fulfillment Instructions (2020) DYNAMIC
2.16.756.5.30.1.1.10.4.38 Containment pending Prescribed Quantity Entry Content Module (2017) DYNAMIC
1.3.6.1.4.1.19376.1.9.1.3.9.1 Containment pending IHE Substitution Permission Content Module (2017) DYNAMIC
Relationship Version: template 1.3.6.1.4.1.19376.1.9.1.3.7 IHE Medication Treatment Plan Item Entry Content Module (2017‑03‑31 14:43:01)
ref
ch-pharm-

Specialization: template 2.16.840.1.113883.10.20.1.24 Medication activity (DYNAMIC)
ref
ccd1-
Example
Example
<substanceAdministration classCode="SBADM" moodCode="INT">
  <templateId root="1.3.6.1.4.1.19376.1.9.1.3.7"/>  <templateId root="2.16.840.1.113883.10.20.1.24"/>  <templateId root="1.3.6.1.4.1.19376.1.5.3.1.4.7"/>  <id root="1.2.3.999" extension="--example only--"/>  <code/>  <text/>  <statusCode code="completed"/>  <effectiveTime xsi:type="IVL_TS">
    <low value=" "/>    <high value=" "/>  </effectiveTime>  <effectiveTime operator="A" xsi:type="TS|PIVL_TS|EIVL_TS|PIVL_PPD_TS|SXPR_TS"/>  <routeCode/>  <approachSiteCode/>  <doseQuantity>
    <low value="1"/>  </doseQuantity>  <rateQuantity>
    <low value="1"/>  </rateQuantity>  <consumable/>  <!--Author(s) in case of usage elsewhere as in a MTP document -->
  <author>...</author>  <author>...</author>  <entryRelationship typeCode="RSON">
    <act classCode="ACT" moodCode="EVN">
      <templateId root="1.3.6.1.4.1.19376.1.5.3.1.4.4.1"/>      <id/>    </act>  </entryRelationship>  <entryRelationship typeCode="SUBJ" inversionInd="true">
    <act classCode="ACT" moodCode="INT">
      <templateId root="2.16.840.1.113883.10.20.1.49"/>      <templateId root="1.3.6.1.4.1.19376.1.5.3.1.4.3"/>      <code code="PINSTRUCT" codeSystem="1.3.6.1.4.1.19376.1.5.3.2" displayName=""/>    </act>  </entryRelationship>  <entryRelationship typeCode="SUBJ" inversionInd="true">
    <act classCode="ACT" moodCode="INT">
      <templateId root="2.16.840.1.113883.10.20.1.43"/>      <templateId root="1.3.6.1.4.1.19376.1.5.3.1.4.3.1"/>      <code code="FINSTRUCT" codeSystem="1.3.6.1.4.1.19376.1.5.3.2" displayName=""/>    </act>  </entryRelationship>  <entryRelationship typeCode="COMP">
    <supply classCode="SPLY" moodCode="RQO"/>  </entryRelationship>  <entryRelationship typeCode="COMP">
    <act classCode="ACT" moodCode="DEF">
      <templateId root="1.3.6.1.4.1.19376.1.9.1.3.9.1"/>    </act>  </entryRelationship>  <reference typeCode="XCRPT">
    <externalDocument>
      <id/>    </externalDocument>  </reference>  <precondition>
    <criterion>
      <text>
        <reference/>      </text>    </criterion>  </precondition></substanceAdministration>
Item DT Card Conf Description Label
hl7:substanceAdministration
 		6.3.4.E1.3.1 Medication Treatment Plan Item Entry General Specification 6.3.dots.3.1
@classCode
 		cs 1 … 1 F SBADM
@moodCode
 		cs 1 … 1 F INT
hl7:templateId
 		II 1 … 1 M 6.3.dots.3.1
@root
 		uid 1 … 1 F 1.3.6.1.4.1.19376.1.9.1.3.7
hl7:templateId
 		II 1 … 1 M 6.3.dots.3.1
@root
 		uid 1 … 1 F 1.3.6.1.4.1.19376.1.9.1.3.6
hl7:templateId
 		II 1 … 1 M 6.3.dots.3.1
@root
 		uid 1 … 1 F 2.16.840.1.113883.10.20.1.24
hl7:templateId
 		II 1 … 1 M 6.3.dots.3.1
@root
 		uid 1 … 1 F 1.3.6.1.4.1.19376.1.5.3.1.4.7
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[@root='1.3.6.1.4.1.19376.1.5.3.1.4.10']
  • hl7:templateId[@root='1.3.6.1.4.1.19376.1.5.3.1.4.11']
hl7:templateId
 		II 0 … 1 A normal substanceAdministration act that may not contain any subordinate substanceAdministration acts. 6.3.dots.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.dots.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.dots.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
hl7:templateId
 		II 0 … 1 A substanceAdministration act that records conditional dose information in subordinate substanceAdministration acts. 6.3.dots.3.3
where [@root='1.3.6.1.4.1.19376.1.5.3.1.4.10']
@root
 		uid 1 … 1 F 1.3.6.1.4.1.19376.1.5.3.1.4.10
hl7:templateId
 		II 0 … 1 A substanceAdministration act that records combination medication component information in subordinate substanceAdministration acts. 6.3.dots.3.3
where [@root='1.3.6.1.4.1.19376.1.5.3.1.4.11']
@root
 		uid 1 … 1 F 1.3.6.1.4.1.19376.1.5.3.1.4.11
hl7:id
 		II 1 … 1 M Medication Treatment Plan Item ID 6.3.dots.3.4
hl7:code
 		CD 0 … 1 Code 6.3.dots.1.5
hl7:text
 		ED 1 … 1 M Narrative Text 6.3.dots.3.6
hl7:statusCode
 		CS 0 … 1 Status Code 6.3.dots.3.7
@code
 		CONF 0 … 1 F completed
hl7:effectiveTime
 		1 … * R Dosage Instructions 6.3.dots.3.8
hl7:effectiveTime
 		IVL_TS 0 … 1 Dosage Instructions PCC 6.3.4.16.10 - Start and Stop 6.3.dots.3.8
where [@xsi:type='IVL_TS']
hl7:effectiveTime
 		0 … 1 Dosage Instructions PCC 6.3.4.16.12 - Frequency 6.3.dots.3.8
where [@operator='A']
@operator
 		st 1 … 1 F A
hl7:routeCode
 		CE 0 … 1 6.3.dots.3.1
hl7:approachSiteCode
 		CD 0 … * 6.3.dots.3.1
hl7:doseQuantity
 		IVL_PQ 0 … 1 6.3.dots.3.1
hl7:rateQuantity
 		IVL_PQ 0 … 1 6.3.dots.3.1
hl7:consumable
 		1 … 1 R Consumable 6.3.dots3.10
hl7:manufacturedProduct
 		1 … 1 M 6.3.dots3.10
hl7:templateId
 		II 1 … 1 M 6.3.dots.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.dots.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 1.3.6.1.4.1.19376.1.9.1.3.1 IHE MedicineEntryContentModule (DYNAMIC)
hl7:manufacturedMaterial
 		1 … 1 M 6.3.dots.3.1
@classCode
 		0 … 1 F MMAT
@determinerCode
 		0 … 1 F KIND
hl7:templateId
 		II 1 … 1 M Medicine Entry Template ID 6.3.dots.3.2
@root
 		uid 1 … 1 F 1.3.6.1.4.1.19376.1.9.1.3.1
hl7:code
 		CE 1 … 1 R Code 6.3.dots.3.3
hl7:originalText
 		ED 0 … 1 6.3.dots.3.3
hl7:reference
 		TEL 1 … 1 R 6.3.dots.3.3
@nullFlavor
 		cs 0 … 1 F NA
hl7:name
 		EN 1 … 1 R Name 6.3.dots.3.4
@nullFlavor
 		cs 0 … 1 F NA
pharm:formCode
 		CE 0 … 1 Form Code 6.3.dots.3.5
hl7:lotNumberText
 		ST 0 … 1 Lot Number 6.3.dots.3.6
pharm:expirationTime
 		TS 0 … 1 Expiration Date 6.3.dots.3.7
@value
 		1 … 1 R
pharm:asContent
 		0 … 1 Packaging 6.3.dots.3.8
@classCode
 		1 … 1 F CONT
pharm:containerPackagedMedicine
 		1 … 1 R 6.3.dots.3.8
@classCode
 		1 … 1 F CONT
@determinerCode
 		1 … 1 F INSTANCE
pharm:code
 		0 … * 6.3.dots.3.8
pharm:name
 		0 … * 6.3.dots.3.8
pharm:formCode
 		0 … 1 6.3.dots.3.8
  Schematron assert role red error  
  test not(pharm:capacityQuantity) or pharm:formCode  
  Message pharm:formCode SHALL be present if pharm:asSuperContent present  
pharm:capacityQuantity
 		PQ 1 … 1 M 6.3.dots.3.8
@unit
 		cs 0 … 1  
@value
 		1 … 1 R
pharm:asSuperContent
 		0 … 1 6.3.dots.3.8
pharm:containerPackagedMedicine
 		1 … 1 R 6.3.dots.3.8
@classCode
 		1 … 1 F CONT
@determinerCode
 		1 … 1 F INSTANCE
pharm:capacityQuantity
 		PQ 1 … 1 M 6.3.dots.3.8
@unit
 		cs 0 … 1  
@value
 		1 … 1 R
pharm:asSpecializedKind
 		0 … * R Generic Equivalent 6.3.dots.3.9
@classCode
 		1 … 1 F GRIC
pharm:generalizedMedicineClass
 		0 … * 6.3.dots.3.9
@classCode
 		1 … 1 F MMAT
pharm:code
 		1 … 1 R 6.3.dots.3.9
pharm:name
 		0 … * 6.3.dots.3.9
pharm:ingredient
 		0 … * Active Ingredient List 6.3.dots3.10
@classCode
 		1 … 1 F ACTI
pharm:quantity
 		RTO_PQ_PQ 0 … 1 The medication strength is represented as the ratio of the active ingredient(s) to a unit of medication 6.3.dots3.10
hl7:numerator
 		PQ 0 … 1 6.3.dots3.10
hl7:denominator
 		PQ 0 … 1 6.3.dots3.10
pharm:ingredient
 		0 … * 6.3.dots3.10
@classCode
 		1 … 1 F MMAT
@determinerCode
 		1 … 1 F KIND
pharm:code
 		0 … 1 6.3.dots3.10
pharm:name
 		1 … 1 R 6.3.dots3.10
hl7:author
 		0 … 1 Medication Treatment Plan Author 6.3.dots3.11
hl7:author
 		0 … 1 Community Medication Treatment Plan document author 6.3.dots3.12
Included from 2.16.756.5.30.1.1.10.4.36 Dosage Instructions Related Components (DYNAMIC)
hl7:entryRelationship
 		0 … * Dosage Instructions PCC 6.3.4.16.20 - Related components 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
 		1 … 1 M For split, tapered or conditional dosing, the subordinate component shall specify only the changed <frequency> and/or <doseAmount> elements.
 IHE PCC 6.3.4.16.20
@moodCode
 		cs 1 … 1 R INT for an intent or EVN for an event.
@classCode
 		cs 1 … 1 F SBADM
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
 		IVL_PQ 0 … 1 IHE PCC 6.3.4.16.20
@unit
 		cs 1 … 1 R
  CONF
The value of @unit shall be drawn from value set 2.16.756.5.30.1.1.11.83 UnitCode (DYNAMIC)
@value
 		cs 1 … 1 R
hl7:rateQuantity
 		IVL_PQ 0 … 1 IHE PCC 6.3.4.16.20
hl7:consumable
 		1 … 1 M IHE PCC 6.3.4.16.20
hl7:manufacturedProduct
 		1 … 1 M 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:entryRelationship
 		0 … 1 Reason
Contains 1.3.6.1.4.1.19376.1.5.3.1.4.4.1 IHE Internal Reference Entry (DYNAMIC) 		6.3.dots3.13
where [hl7:act [hl7:templateId [@root='1.3.6.1.4.1.19376.1.5.3.1.4.4.1']]]
@typeCode
 		cs 1 … 1 F RSON
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.dots3.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 Fullfillment Instructions
Contains 1.3.6.1.4.1.19376.1.5.3.1.4.3.1 Fulfillment Instructions (DYNAMIC) 		6.3.dots3.16
where [hl7:act [hl7:templateId [@root='1.3.6.1.4.1.19376.1.5.3.1.4.3.1']]]
@typeCode
 		cs 1 … 1 F SUBJ
@inversionInd
 		bl 1 … 1 F true
hl7:entryRelationship
 		0 … 1 Amount of units of the consumable to dispense
Contains 2.16.756.5.30.1.1.10.4.38 Prescribed Quantity Entry Content Module (DYNAMIC) 		6.3.dots3.17
where [hl7:supply [@classCode='SPLY' and @moodCode='RQO']]
@typeCode
 		cs 1 … 1 F COMP
hl7:entryRelationship
 		0 … * Substitution permission
Contains 1.3.6.1.4.1.19376.1.9.1.3.9.1 IHE Substitution Permission Content Module (DYNAMIC) 		6.3.dots3.18
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:reference
 		0 … 1 ID of parent container (Community Medication Treatment Plan document) 6.3.dots3.19
@typeCode
 		cs 1 … 1 F XCRPT
hl7:externalDocument
 		0 … 1 6.3.dots3.19
hl7:id
 		0 … * 6.3.dots3.19
hl7:precondition
 		0 … 1 Precondition Criterion 6.3.dots3.20
hl7:criterion
 		0 … 1 6.3.dots3.20
hl7:text
 		0 … * 6.3.dots3.20
hl7:reference
 		0 … * 6.3.dots3.20