Difference between revisions of "2.16.840.1.113883.10.22.4.4/static-2016-11-11T000000"

From HL7 IPS
Jump to: navigation, search
(Automated ADBot page content)
(Automated ADBot page content)
Line 1: Line 1:
<
+
<table xmlns="http://www.w3.org/1999/

Revision as of 20:02, 27 March 2018

Id2.16.840.1.113883.10.22.4.4Effective Date valid from 2016‑11‑11
StatusKyellow.png DraftVersion Label
NameIPSMedicationEntryDisplay NameIPS Medication Entry
Description
<div class="yui-wk-div">An IPS Medication entry describes a medication statement, that is a substance administration that has actually occurred (e.g., pills ingested or injections given) or are intended to occur (e.g., "take 2 tablets twice a day for the next 10 days"). Medication activities in "INT" mood are reflections of what a clinician intends a patient to be taking. For example, a clinician may intend that a patient to be administered Lisinopril 20 mg PO for blood pressure control. If what was actually administered was Lisinopril 10 mg., then the Medication activities in
                   the "EVN" mood would reflect actual use.<br clear="none"/>
   <br clear="none"/>The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay, but it could be derived from the medications information recorded into a GP's EHR-system, in form of prescribed medication, or administration statements.<br clear="none"/>The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the
                   patient, clinician or other party maintains. <br clear="none"/>
   <br clear="none"/> A medication statement is usually less specific than an a prescription or a medication administration record. &#160;<br clear="none"/>
   <br clear="none"/>This entry is composed by a main substanceAdministration act and a subordinate substanceAdministration act, unless it is asserted that there are no medications data.&#160;<br clear="none"/>
<br clear="none"/>The first conveys information as the product, the period of administration and the route of administration; the latter is used to provide dosage information as the frequency of intakes or the amount of the medication given.</div>
ContextParent nodes of template element with id 2.16.840.1.113883.10.22.4.4
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 2 templates, Uses 3 templates
Used by as NameVersion
2.16.840.1.113883.10.22.3.1ContainmentKyellow.png IPS Medication Summary Section ()2016‑11‑11
2.16.840.1.113883.10.22.1.1Link.pngKyellow.png International Patient Summary ()2017‑04‑11
Uses as NameVersion
2.16.840.1.113883.10.22.4.2ContainmentKyellow.png IPS ManufacturedProduct ()DYNAMIC
2.16.840.1.113883.10.22.4.14ContainmentKyellow.png IPS Body Author ()DYNAMIC
2.16.840.1.113883.10.22.4.33ContainmentKyellow.png IPS Subordinate SubstanceAdministration ()DYNAMIC
RelationshipAdaptation: template 1.3.6.1.4.1.12559.11.10.1.3.1.3.4 Medication Item (2013‑12‑20)
ref
(from repository: epsos-)
Example
Example
<substanceAdministration classCode="SBADM" moodCode="INT">
  <templateId root="2.16.840.1.113883.10.22.4.4"/>  <code code="DRUG" codeSystem="2.16.840.1.113883.5.4" displayName="Drug"/>  <statusCode code="active"/>  <effectiveTime>
    <width value="2" unit="wk"/>  </effectiveTime>
  <consumable typeCode="CSM">
    <!-- template 'IPS ManufacturedProduct' (dynamic) -->
  </consumable>
  <entryRelationship typeCode="COMP">
    <substanceAdministration classCode="SBADM" moodCode="EVN">
      <statusCode code="active"/>      <effectiveTime xsi:type="PIVL_TS" institutionSpecified="true">
        <period value="12" unit="h"/>      </effectiveTime>
      <doseQuantity value="2" unit="{puff}"/>      <consumable>
        <manufacturedProduct>
          <manufacturedMaterial nullFlavor="NA"/>        </manufacturedProduct>
      </consumable>
    </substanceAdministration>
  </entryRelationship>
</substanceAdministration>
Example
No medication infos
<substanceAdministration classCode="SBADM" moodCode="INT">
  <templateId root="2.16.840.1.113883.10.22.4.4"/>  <code code="X-DrugTreatmentNotKnown" codeSystem="2.16.840.1.113883.5.1150.999.1" displayName="Drug treatment not known"/>  <statusCode code="completed"/>  <effectiveTime nullFlavor="NA" xsi:type="IVL_TS"/>  <consumable>
    <manufacturedProduct>
      <manufacturedMaterial nullFlavor="NA"/>    </manufacturedProduct>
  </consumable>
</substanceAdministration>
ItemDTCardConfDescriptionLabel
hl7:substanceAdministration
RIPSM...ntry
Treetree.png@classCode
cs1 … 1FSBADM
Treetree.png@moodCode
cs1 … 1RIf the statement refers to a prescribed medication then a <substanceAdministration> intent (moodCode='INT') is used; otherwise, to record medications which are stated to have taken, the moodCode shall be set to 'EVN'.
 CONF
The value of @moodCode shall be drawn from value set 2.16.840.1.113883.11.20.9.18 MoodCodeEvnInt (DYNAMIC)
Treetree.pnghl7:templateId
II1 … 1MIPSM...ntry
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.22.4.4
Treetree.pnghl7:id
II0 … *RIPSM...ntry
Treetree.pnghl7:code
CD.IPS1 … 1R<div>The &lt;code&gt; element is valorized with the Substance Administration ACT code "DRUG" unless it is used for asserting the &#160;known absence of medication treatments or no information about them.</div>IPSM...ntry
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.11.22.14 DRUGActCode (DYNAMIC)
or
The value of @code shall be drawn from value set 2.16.840.1.113883.11.22.15 Absent or Unknown Medication (DYNAMIC)
Treetree.pnghl7:text
ED0 … 1RThe URI given in the value attribute of the <reference> element points to an element in the narrative content that contains the complete text describing the medication. In a CDA document, the URI given in the value attribute of the <reference> element points to an element in the narrative content that contains the complete text describing the medication.IPSM...ntry
Treeblank.pngTreetree.pnghl7:reference
TEL1 … 1MIPSM...ntry
Treeblank.pngTreeblank.pngTreetree.png@value
1 … 1RReference pointing to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1
Treetree.pnghl7:statusCode
CS1 … 1MIPSM...ntry
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.11.22.12 ActStatusActiveCompletedAbortedSuspended (DYNAMIC)
 Example<statusCode code="active"/>
Choice1 … 1
The &lt;effectiveTime&gt; element encodes the period of administration of the medication, it is always expressed as an interval of time.<br clear="none"/>It may be expressed using the &lt;low&gt; and &lt;high&gt; OR with the &lt;width&gt; element.<br clear="none"/>The first is used to indicate a specified interval (e.g. from march 15th, 2017); the latter for indicating a 'floating' period (e.g. 2 weeks) <i>.</i>
Elements to choose from:
  • hl7:effectiveTime[hl7:low | hl7:high]
  • hl7:effectiveTime[hl7:width]
Treeblank.pngTreetree.pnghl7:effectiveTime
IVL_TS0 … 1C<b>Case 1: specified interval</b>

<br clear="none"/>The &lt;low&gt; and &lt;high&gt; values of the first &lt;effectiveTime&gt; element represent the start and stop times for the medication. The &lt;low&gt; value represents the start time, and the &lt;high&gt; value represents the stop time. If either the &lt;low&gt; or the &lt;high&gt; value is unknown, this shall be recorded by setting the nullFlavor attribute to UNK.<br clear="none"/> <br clear="none"/>In case of unbounded period (continous terapy) the &lt;high&gt; element will be valued with the nullFlavor attribute to NA.<br clear="none"/> <br clear="none"/>The &lt;high&gt; value records the end of the medication regime according to the information provided in the prescription or order. For example, if the prescription is for enough medication to last 30 days, then the high value should contain a date that is 30 days later then the &lt;low&gt; value. The rationale is that a provider, seeing an un-refilled prescription would normally assume that the medication is no longer being taken, even if the intent of the treatment plan is to continue the medication indefinitely.<i>

   <br clear="none"/>
</i>
IPSM...ntry
Treeblank.pngTreeblank.png where [hl7:low or
hl7:high]
Treeblank.pngTreeblank.pngTreetree.png@nullFlavor
cs0 … 1 
 Example
Known Interval
<effectiveTime>
  <low value="20130321"/>  <high value="20140321"/></effectiveTime>
 Example
Information not available about the period
<effectiveTime nullFlavor="NI"/>
 Example
Unknown end date
<effectiveTime>
  <low value="20130321"/>  <high nullFlavor="UNK"/></effectiveTime>
 Example
Continuous terapy
<effectiveTime>
  <low value="20130321"/>  <high nullFlavor="NA"/></effectiveTime>
Treeblank.pngTreeblank.pngTreetree.pnghl7:low
IVXB_TS1 … 1RIPSM...ntry
Treeblank.pngTreeblank.pngTreetree.pnghl7:high
IVXB_TS0 … 1RIPSM...ntry
Treeblank.pngTreetree.pnghl7:effectiveTime
IVL_TS0 … 1C<b>Case 2: 'floating' period<br clear="none"/> </b>The width element is used to specify a period of (actual or intended) administration &#160;that is not anchored to any specific date (e.g. a two weeks therapy.....)IPSM...ntry
Treeblank.pngTreeblank.png where [hl7:width]
 Example
2 week period
<effectiveTime>
  <width value="2" unit="wk"/></effectiveTime>
Treeblank.pngTreeblank.pngTreetree.pnghl7:width
PQ1 … 1RIPSM...ntry
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@unit
cs1 … 1R
 CONF
The value of @unit shall be drawn from value set 2.16.840.1.113883.11.22.13 Time units (UCUM) (DYNAMIC)
Treetree.pnghl7:routeCode
CE.IPS0 … 1RThe &lt;routeCode&gt; element specifies the route of administration using the EDQM route of administration vocabulary. <br clear="none"/>A code must be specified if the route is known.&#160;<br clear="none"/>

<br clear="none"/> <div>Since the EDQM Standards Terms, together with UCUM,&#160;is one of the IDMP terminologies actually available for usage, this code system has been selected &#160;as referecne terminology for representing Pharmaceutical Dose forms; Packages and Route of Administration.<br clear="none"/>

   <br clear="none"/>It is known that also alternative jurisdictional and international terminologies are also used for this concept domain, as NCI or SNOMED CT.<br clear="none"/>
<br clear="none"/>Official NCI and EDQM maps for the route of administration are available from the EDQM site.</div>
IPSM...ntry
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.11.22.33 Medicine Route of Administration (DYNAMIC)
Treetree.pnghl7:doseQuantity
IVL_PQNPIPSM...ntry
Treetree.pnghl7:consumable
1 … 1MContains 2.16.840.1.113883.10.22.4.2 IPS ManufacturedProduct (DYNAMIC)IPSM...ntry
Treeblank.png where [not(@nullFlavor)]
Treeblank.pngTreetree.png@typeCode
cs1 … 1FCSM
Treetree.pnghl7:author
0 … *Contains 2.16.840.1.113883.10.22.4.14 IPS Body Author (DYNAMIC)IPSM...ntry
Treetree.pnghl7:entryRelationship
0 … *CUnless medications are unknown or known absent, at least one subordinated &lt;substanceAdministration&gt; has to be present to convey information about dosages (dose, frequency of intakes,..). <br clear="none"/>Subordinated &lt;substanceAdministration&gt;&#160;elements can be also used either to handle split dosing, or to support combination medications.
Contains 2.16.840.1.113883.10.22.4.33 IPS Subordinate SubstanceAdministration (DYNAMIC)
IPSM...ntry
Treeblank.pngTreetree.png@typeCode
cs1 … 1FCOMP
 ConstraintAt least one subordinate <substanceAdministration> element SHALL be present unless medications are unknown or known absent.
Treeblank.pngTreetree.pnghl7:sequenceNumber
INT0 … 1Sequence number of the Subordinate Substance AdministrationIPSM...ntry