2.16.840.1.113883.10.22.4.1/static-2016-11-10T000000

From HL7 IPS
Revision as of 20:02, 27 March 2018 by ADbot (talk | contribs) (Automated ADBot page content)
Jump to: navigation, search
Id2.16.840.1.113883.10.22.4.1Effective Date valid from 2016‑11‑10
StatusKyellow.png DraftVersion Label
NameIPSEntryAllergyOrIntoleranceDisplay NameIPS Allergy or Intolerance
Description
This template reflects a discrete observation about a patient's allergy or intolerance.
     <div>Because it is a discrete observation, it will have a statusCode of "completed".</div>

<div>The effectiveTime, also referred to as the "biologically relevant time" is the time at which the observation holds for the patient.</div> <div>For a provider seeing a patient in the clinic today, observing a history of penicillin allergy that developed five years ago, the effectiveTime is five years ago.</div> <div>The effectiveTime of the Allergy - Intolerance Observation gives an indication of whether or not the underlying allergy/intolerance is resolved. If known to be resolved, then an effectiveTime/high would be present.&#160;</div>

<div>If the date of resolution is not known, then effectiveTime/high will be present with a nullFlavor of "UNK".&#160;<br/>It is recommended that the agent responsible for an allergy or adverse reaction would be used for describing the allergy, however the possibility that pre-coordinate codes (e.g. "allergy to nuts") will be used has been here also considered.<br/>The agent responsible for &#160;an allergy or adverse reaction it is not always a manufactured material (for example, food allergies), nor is it necessarily consumed; however &#160;the playingEntity classCode = "MMAT" for all agents, manufactured or not is expected to be used. This choice depends on thecharacteristics of the base CDA R2 specification.</div>
ContextParent nodes of template element with id 2.16.840.1.113883.10.22.4.1
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 3 templates, Uses 4 templates
Used by as NameVersion
2.16.840.1.113883.10.22.4.5ContainmentKyellow.png IPS Allergy and Intolerance Concern ()2016‑11‑11
2.16.840.1.113883.10.22.3.2Link.pngKyellow.png IPS Allergies and Intolerances 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.6ContainmentKyellow.png IPS Reaction Manifestation ()DYNAMIC
2.16.840.1.113883.10.22.4.18ContainmentKyellow.png IPS Criticality Observation ()DYNAMIC
2.16.840.1.113883.10.22.10ContainmentKyellow.png IPS Allergy Certainty Observation ()DYNAMIC
2.16.840.1.113883.10.22.4.21ContainmentKyellow.png IPS Allergy Status Observation ()DYNAMIC
RelationshipAdaptation: template 2.16.840.1.113883.10.20.1.18 (DYNAMIC)
Adaptation: template 1.3.6.1.4.1.19376.1.5.3.1.4.5 IHE Problem Entry (DYNAMIC)
ref
(from repository: IHE-PCC-)

Adaptation: template 1.3.6.1.4.1.19376.1.5.3.1.4.6 Allergies And Intolerances (DYNAMIC)
ref
(from repository: epsos-)
Example
Example
<observation classCode="OBS" moodCode="EVN">
  <templateId root="2.16.840.1.113883.10.22.4.1"/>  <id root=" " extension=" "/>  <!-- This is the code that shows what kind of allergy or intolerance -->
  <code code="X-AoI" displayName="Allergy or Intolerance" codeSystem="2.16.840.1.113883.5.1150.999.1"/>  <text>
    <reference value="#ref1"/>  </text>
  <statusCode code="completed"/>  <effectiveTime>
    <low value="20170701"/>  </effectiveTime>
  <!-- This is the allergen - the substance that caused the allergy -->
  <participant typeCode="CSM">
    <participantRole classCode="MANU">
      <playingEntity classCode="MMAT">
        <code code=" " codeSystem=" ">
          <originalText>
            <reference value="#substance"/>          </originalText>
        </code>
        <name>...</name>      </playingEntity>
    </participantRole>
  </participant>
  <!-- This is how the allergy manifests itself -->
  <entryRelationship typeCode="MFST" inversionInd="true">
    <!-- template 2.16.840.1.113883.10.22.4.6 'IPS Reaction Manifestation' (dynamic) -->
  </entryRelationship>
  <entryRelationship typeCode="SUBJ" inversionInd="true">
    <!-- template 2.16.840.1.113883.10.22.4.18 'IPS Criticality Observation' (dynamic) -->
  </entryRelationship>
  <entryRelationship typeCode="SUBJ" inversionInd="true">
    <!-- template 2.16.840.1.113883.10.22.4.19 'IPS Certainty Observation' (dynamic) -->
  </entryRelationship>
  <entryRelationship typeCode="REFR" inversionInd="false">
    <!-- template 2.16.840.1.113883.10.22.4.21 'IPS Allergy Status Observation' (dynamic) -->
  </entryRelationship>
</observation>
Example
No Known Allergies
<observation classCode="OBS" moodCode="EVN">
  <templateId root="2.16.840.1.113883.10.22.4.1"/>  <code code="allergy" displayName="Allergy" codeSystem="2.16.840.1.113883.4.642.1.122"/>  <statusCode code="completed"/>  <effectiveTime>
    <low nullFlavor="UNK"/>  </effectiveTime>
  <value code="X-NoKnownAllergy" displayName="No known allergy" codeSystem="2.16.840.1.113883.5.1150.999.1"/></observation>
Example
No Information available about allergies or intolerances
<observation classCode="OBS" moodCode="EVN">
  <templateId root="2.16.840.1.113883.10.22.4.1"/>  <code code="X-AoI" displayName="Allergy or Intolerance" codeSystem="2.16.840.1.113883.5.1150.999.1"/>  <statusCode code="completed"/>  <effectiveTime>
    <low nullFlavor="NA"/>  </effectiveTime>
  <value code="X-AllergicDispositionNotKnown" displayName="Allergic disposition not known" codeSystem="2.16.840.1.113883.5.1150.999.1"/></observation>
Example
Minimum Set (active propensity; agent known)
<observation classCode="OBS" moodCode="EVN">
  <templateId root="2.16.840.1.113883.10.22.4.1"/>  <code code="X-AoI" displayName="Allergy or Intolerance" codeSystem="2.16.840.1.113883.5.1150.999.1"/>  <statusCode code="completed"/>  <effectiveTime>
    <low nullFlavor="UNK"/>  </effectiveTime>
  <participant typeCode="CSM">
    <participantRole classCode="MANU">
      <playingEntity classCode="MMAT">
        <code code="13577000" codeSystem="2.16.840.1.113883.6.96" displayName="Nut"/>      </playingEntity>
    </participantRole>
  </participant>
</observation>
ItemDTCardConfDescriptionLabel
hl7:observation
RIPSE...ance
Treetree.png@classCode
cs1 … 1FOBS
Treetree.png@moodCode
cs1 … 1FEVN
Treetree.pnghl7:templateId
II1 … 1MIPSE...ance
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.22.4.1
Treetree.pnghl7:id
II0 … *RIPSE...ance
Treetree.pnghl7:code
CD.IPS1 … 1MThis element describes whether this condition refers to an allergy, non-allergy intolerance, or unknown class of intolerance (not known to be allergy or intolerance).IPSE...ance
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.11.22.2 Allergy or Intolerance Type (DYNAMIC)
Treetree.pnghl7:text
ED0 … 1RThe text element if present points to the text describing the problem being recorded; including any dates, comments, et cetera. The <reference> contains a URI in value attribute. This URI points to the free text description of the problem in the document that is being described.</reference>IPSE...ance
Treeblank.pngTreetree.pnghl7:reference
TEL1 … 1MIPSE...ance
Treeblank.pngTreeblank.pngTreetree.png@value
1 … 1RWhen used it shall refer to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1
Treetree.pnghl7:statusCode
CS1 … 1MA clinical document normally records only those condition observation events that have been completed, not observations that are in any other state. Therefore, the <statusCode> shall always have code='completed'.</statusCode>IPSE...ance
Treeblank.pngTreetree.png@code
cs1 … 1Fcompleted
Treetree.pnghl7:effectiveTime
IVL_TS1 … 1M The effectiveTime, also referred to as the "biologically relevant time" is the time at which the observation holds for the patient. For a provider seeing a patient in the clinic today, observing a history of penicillin allergy that developed five years ago, the effectiveTime is five years ago. The effectiveTime of the Allergy - Intolerance&#160; Observation may give an indication of whether or not the underlying allergy/intolerance is resolved.&#160;<br clear="none"/> The &lt;low&gt; and &lt;high&gt; values should be no more precise than known, but as precise as possible. IPSE...ance
Treeblank.pngTreetree.pnghl7:low
IVXB_TS1 … 1RThe effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became biologically active.IPSE...ance
Treeblank.pngTreetree.pnghl7:high
IVXB_TS0 … 1CThe effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became biologically resolved.<br clear="none"/>If the date of resolution is not known, then effectiveTime/high will be present with a nullFlavor of "UNK".IPSE...ance
 ConstraintIf this condition is known to be resolved, then the effectiveTime/high would be present.
Choice0 … 1
The coded form of the observation value can be used :<br clear="none"/>

<ul>

   <li>either to indicate known absent conditions (e.g. NKA) or the nonavailability&#160;of information;&#160;</li>
   <li>or to provide pre-coordinated codes describing the propensity to specific substances (e.g. allergy to nuts).&#160;<br clear="none"/>
   </li>
</ul>The choice reflects these options.
Elements to choose from:
  • hl7:value[1]
  • hl7:value[2]
Treeblank.pngTreetree.pnghl7:value
CD.IPS (preferred)0 … 1IPSE...ance
Treeblank.pngTreeblank.png where [1]
 CONF
The value of @code comes preferably from value set 2.16.840.1.113883.11.22.10 IPS Allergy or Intolerance Conditions (DYNAMIC)
Treeblank.pngTreetree.pnghl7:value
CD.IPS (required)0 … 1CWhen the value is used to describe the absence of information the participant used for indicating the allergy agent shall be omitted.<br clear="none"/>IPSE...ance
Treeblank.pngTreeblank.png where [2]
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.11.22.9 Absent or Unknown Allergies (DYNAMIC)
Treetree.pnghl7:participant
0 … 1CThe substance that causes the allergy or intolerance should be specified in the &lt;participant&gt; structure.&#160;<br clear="none"/>This is the preferred way an allergy is supposed to be expressed.<br/>However it is recognized that in some contexts a controlled vocabulary is used for describing the allergy to a substance; or for asserting known absence or unavailability of information.&#160;<br/>In this case the &lt;participant&gt; structure shall be omitted.<br/>The agent responsible for an allergy or adverse reaction is not always a manufactured material (for example, food allergies), nor is it necessarily consumed. The following constraints reflect limitations in the base CDA R2 specification, and should be used to represent any type of responsible agent, i.e., use playingEntity classCode = "MMAT" for all agents, manufactured or not.IPSE...ance
Treeblank.pngTreetree.png@typeCode
cs1 … 1FCSM
 ConstraintIF the observation/value element is present and valued with a code derived form the  2.16.840.1.113883.11.22.9 Absent or Unknown Allergies value set THEN the  observation/participant element used to describe the agent SHALL be omitted.
Treeblank.pngTreetree.pnghl7:participantRole
1 … 1RIPSE...ance
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FMANU
Treeblank.pngTreeblank.pngTreetree.pnghl7:playingEntity
1 … 1RIPSE...ance
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FMMAT
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:code
CD.IPS (preferred)1 … 1RCode for the substance causing the allergy or intolerance.IPSE...ance
 CONF
The value of @code comes preferably from value set 2.16.840.1.113883.11.22.11 Adverse Reaction Agents (DYNAMIC)
Treetree.pnghl7:entryRelationship
0 … *RThe contained entry describes the reactions that are manifestations (typeCode='MFST') of the reported allergy or intolerance.
Contains 2.16.840.1.113883.10.22.4.6 IPS Reaction Manifestation (DYNAMIC)
IPSE...ance
Treeblank.png where [hl7:observation [hl7:code [concat(@code,@codeSystem)=doc('include/voc-2.16.840.1.113883.11.22.16-2017-04-07T000000.xml')//valueSet [1]/conceptList/concept/concat(@code,@codeSystem) or @nullFlavor]]]
Treeblank.pngTreetree.png@typeCode
cs1 … 1FMFST
Treeblank.pngTreetree.png@inversionInd
cs1 … 1Ftrue
Treetree.pnghl7:entryRelationship
0 … 1R<b>Criticality</b> <br clear="none"/>The contained entry describes the gravity of the potential risk for future life-threatening adverse reactions when exposed to a substance known to cause an adverse reaction in that individual.
Contains 2.16.840.1.113883.10.22.4.18 IPS Criticality Observation (DYNAMIC)
IPSE...ance
Treeblank.png where [hl7:observation [hl7:code [(@code='82606-5' and @codeSystem='2.16.840.1.113883.6.1')]]]
Treeblank.pngTreetree.png@typeCode
cs1 … 1FSUBJ
Treeblank.pngTreetree.png@inversionInd
cs1 … 1Ftrue
Treetree.pnghl7:entryRelationship
0 … 1R<b>Certainty or Verification Status</b> <br clear="none"/>The contained entry describes the certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
Contains 2.16.840.1.113883.10.22.10 IPS Allergy Certainty Observation (DYNAMIC)
IPSE...ance
Treeblank.png where [hl7:observation [hl7:code [(@code='NEW-LOINC-CERTAINTY' and @codeSystem='2.16.840.1.113883.6.1')]]]
Treeblank.pngTreetree.png@typeCode
cs1 … 1FSUBJ
Treeblank.pngTreetree.png@inversionInd
cs1 … 1Ftrue
Treetree.pnghl7:entryRelationship
0 … 1R<b>Status of the Allergy or Intolerance&#160;</b> <br clear="none"/>The contained entry describes the current status of the allergy or intolerance, for example, whether it is active, in remission, resolved, and so on ...
Contains 2.16.840.1.113883.10.22.4.21 IPS Allergy Status Observation (DYNAMIC)
IPSE...ance
Treeblank.png where [hl7:observation [hl7:code [(@code='33999-4' and @codeSystem='2.16.840.1.113883.6.1') or @nullFlavor]]]
Treeblank.pngTreetree.png@typeCode
cs1 … 1FREFR
Treeblank.pngTreetree.png@inversionInd
cs1 … 1Ffalse