Allergyintolerance.profile.xml

Profile for allergyintolerance

Raw XML

<Profile xmlns="http://hl7.org/fhir">
  <text>
    <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre>
&lt;<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance" title="Indicates the patient has a susceptibility to an adverse reaction upon exposure to a specified
         substance."><b>AllergyIntolerance</b></a> xmlns=&quot;http://hl7.org/fhir&quot;&gt; <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span>
 &lt;!-- from <a href="resources.html">Resource</a>: <a href="extensibility.html">extension</a>, <a href="extensibility.html#modifierExtension">modifierExtension</a>, language, <a href="narrative.html#Narrative">text</a>, and <a href="references.html#contained">contained</a> --&gt;
 &lt;<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.identifier" title="This records identifiers associated with this allergy/intolerance concern that are defined
         by business processed and/ or used to refer to it when a direct URL reference to the resource
         itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)."><b>identifier</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="datatypes.html#Identifier">Identifier</a></span> <span style="color: navy">External Ids for this item</span><span style="color: Gray"> --&gt;</span>&lt;/identifier&gt;
 &lt;<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.criticality" title="Criticality of the sensitivity."><b>criticality</b></a> value=&quot;[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]&quot;/&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy"><a href="criticality.html" style="color: navy">fatal | high | medium | low</a></span><span style="color: Gray"> --&gt;</span>
 &lt;<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.sensitivityType" title="Type of the sensitivity."><b>sensitivityType</b></a> value=&quot;[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]&quot;/&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy"><a href="sensitivitytype.html" style="color: navy">allergy | intolerance | unknown</a></span><span style="color: Gray"> --&gt;</span>
 &lt;<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.recordedDate" title="Date when the sensitivity was recorded."><b>recordedDate</b></a> value=&quot;[<span style="color: darkgreen"><a href="datatypes.html#dateTime">dateTime</a></span>]&quot;/&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">When recorded</span><span style="color: Gray"> --&gt;</span>
 &lt;<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.status" title="Status of the sensitivity (this element modifies the meaning of other elements)"><span style="text-decoration: underline"><b>status</b></span></a> value=&quot;[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]&quot;/&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy"><a href="sensitivitystatus.html" style="color: navy">suspected | confirmed | refuted | resolved</a></span><span style="color: Gray"> --&gt;</span>
 &lt;<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.subject" title="The patient who has the allergy or intolerance."><b>subject</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="patient.html#Patient">Patient</a>)</span> <span style="color: navy">Who the sensitivity is for</span><span style="color: Gray"> --&gt;</span>&lt;/subject&gt;
 &lt;<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.recorder" title="Indicates who has responsibility for the record."><b>recorder</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="practitioner.html#Practitioner">Practitioner</a>|<a href="patient.html#Patient">Patient</a>)</span> <span style="color: navy">Who recorded the sensitivity</span><span style="color: Gray"> --&gt;</span>&lt;/recorder&gt;
 &lt;<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.substance" title="The substance that causes the sensitivity."><b>substance</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="substance.html#Substance">Substance</a>)</span> <span style="color: navy">The substance that causes the sensitivity</span><span style="color: Gray"> --&gt;</span>&lt;/substance&gt;
 &lt;<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.reaction" title="Reactions associated with the sensitivity."><b>reaction</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="adversereaction.html#AdverseReaction">AdverseReaction</a>)</span> <span style="color: navy">Reactions associated with the sensitivity</span><span style="color: Gray"> --&gt;</span>&lt;/reaction&gt;
 &lt;<a class="dict" href="allergyintolerance-definitions.html#AllergyIntolerance.sensitivityTest" title="Observations that confirm or refute the sensitivity."><b>sensitivityTest</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="observation.html#Observation">Observation</a>)</span> <span style="color: navy">
     Observations that confirm or refute</span><span style="color: Gray"> --&gt;</span>&lt;/sensitivityTest&gt;
&lt;/AllergyIntolerance&gt;
</pre></div>
  </text>
  <name value="allergyintolerance"/>
  <publisher value="FHIR Project"/>
  <description value="Basic Profile. Indicates the patient has a susceptibility to an adverse reaction upon
   exposure to a specified substance."/>
  <status value="draft"/>
  <date value="2014-09-30"/>
  <requirements value="Scope and Usage Allergy/Intolerance resources are used to provide information about adverse
   sensitivities to substances that lead to physiologic changes that are clinically observable.
   An adverse sensitivity is defined as:   A condition expected to result in undesirable
   physiologic reaction to an amount of a substance that would not produce a reaction in
   most individuals. The substance is the trigger of an immunologic response that produces
   the observed physiologic changes, or in some instances nonimmunologic mechanisms that
   produce clinically identical physiologic changes. The immunologic response might be considered
   the actual cause of the reaction, but it is exposure to the trigger substance that is
   clinically observable.   This definition excludes clinically identical episodes that may
   be caused by physical agents, such as heat, cold, sunlight, or vibration, by exercise
   activity, or by infectious agents. Those conditions caused by physical agents or infectious
   would be captured on the problem list (List/Condition Resources). The allergy/intolerance
   list is a list of conditions that represent a propensity unique to this individual for
   a reaction upon future exposure to a specified substance.   Note that this specification
   draws a distinction between the patients condition/problem list and an allergy/intolerance
   list, even though allergies and intolerances are also conditions. This is because the
   distinction is a long established clinical workflow, even to patients. Asking an individual
   &quot;if they have any problems&quot; is not going to invoke an account of their past
   reactions to medications or foods. Instead, they are asked if they &quot;have any allergies&quot;.
   An allergy/intolerance is also different in that a potential harm from exposure to an
   external substance that may be ordered by a provider in the course of their care but is
   not inherent to exposure to that substance for the general population."/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM"/>
  </mapping>
  <mapping>
    <identity value="v2"/>
    <uri value="http://hl7.org/v2"/>
    <name value="HL7 v2"/>
  </mapping>
  <structure>
    <type value="AllergyIntolerance"/>
    <publish value="true"/>
    <element>
      <path value="AllergyIntolerance"/>
      <definition>
        <short value="Drug, food, environmental and others"/>
        <formal value="Indicates the patient has a susceptibility to an adverse reaction upon exposure to a specified
         substance."/>
        <min value="1"/>
        <max value="1"/>
        <type>
          <code value="Resource"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value="Observation[moodCode=EVN, code&lt;AllergyIntolerance]"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="AllergyIntolerance.extension"/>
      <definition>
        <short value="Additional Content defined by implementations"/>
        <formal value="May be used to represent additional information that is not part of the basic definition
         of the resource. In order to make the use of extensions safe and manageable, there is
         a strict governance applied to the definition and use of extensions. Though any implementer
         is allowed to define an extension, there is a set of requirements that SHALL be met as
         part of the definition of the extension."/>
        <comments value="there can be no stigma associated with the use of extensions by any application, project,
         or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
          The use of extensions is what allows the FHIR specification to retain a core simplicity
         for everyone."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="AllergyIntolerance.modifierExtension"/>
      <definition>
        <short value="Extensions that cannot be ignored"/>
        <formal value="May be used to represent additional information that is not part of the basic definition
         of the resource, and that modifies the understanding of the element that contains it.
         Usually modifier elements provide negation or qualification. In order to make the use
         of extensions safe and manageable, there is a strict governance applied to the definition
         and use of extensions. Though any implementer is allowed to define an extension, there
         is a set of requirements that SHALL be met as part of the definition of the extension.
         Applications processing a resource are required to check for modifier extensions."/>
        <comments value="there can be no stigma associated with the use of extensions by any application, project,
         or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
          The use of extensions is what allows the FHIR specification to retain a core simplicity
         for everyone."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="AllergyIntolerance.text"/>
      <definition>
        <short value="Text summary of the resource, for human interpretation"/>
        <formal value="A human-readable narrative that contains a summary of the resource, and may be used to
         represent the content of the resource to a human. The narrative need not encode all the
         structured data, but is required to contain sufficient detail to make it &quot;clinically
         safe&quot; for a human to just read the narrative. Resource definitions may define what
         content should be represented in the narrative to ensure clinical safety."/>
        <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have
         a narrative."/>
        <synonym value="narrative"/>
        <synonym value="html"/>
        <synonym value="xhtml"/>
        <synonym value="display"/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="Narrative"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="AllergyIntolerance.contained"/>
      <definition>
        <short value="Contained, inline Resources"/>
        <formal value="These resources do not have an independent existence apart from the resource that contains
         them - they cannot be identified independently, and nor can they have their own independent
         transaction scope."/>
        <comments value="This should never be done when the content can be identified properly, as once identification
         is lost, it is extremely difficult (and context dependent) to restore it again."/>
        <synonym value="inline resources"/>
        <synonym value="anonymous resources"/>
        <synonym value="contained resources"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Resource"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="AllergyIntolerance.identifier"/>
      <definition>
        <short value="External Ids for this item"/>
        <formal value="This records identifiers associated with this allergy/intolerance concern that are defined
         by business processed and/ or used to refer to it when a direct URL reference to the resource
         itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)."/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Identifier"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".id"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="AllergyIntolerance.criticality"/>
      <definition>
        <short value="fatal | high | medium | low"/>
        <formal value="Criticality of the sensitivity."/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="code"/>
        </type>
        <isModifier value="false"/>
        <binding>
          <name value="Criticality"/>
          <isExtensible value="false"/>
          <conformance value="required"/>
          <referenceResource>
            <reference value="http://hl7.org/fhir/vs/criticality"/>
          </referenceResource>
        </binding>
        <mapping>
          <identity value="rim"/>
          <map value=".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=&quot;criticality&quot;
          ].value"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="AllergyIntolerance.sensitivityType"/>
      <definition>
        <short value="allergy | intolerance | unknown"/>
        <formal value="Type of the sensitivity."/>
        <min value="1"/>
        <max value="1"/>
        <type>
          <code value="code"/>
        </type>
        <isModifier value="false"/>
        <binding>
          <name value="SensitivityType"/>
          <isExtensible value="false"/>
          <conformance value="required"/>
          <referenceResource>
            <reference value="http://hl7.org/fhir/vs/sensitivitytype"/>
          </referenceResource>
        </binding>
        <mapping>
          <identity value="rim"/>
          <map value=".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=&quot;sensitivity&quot;
          ].value"/>
        </mapping>
        <mapping>
          <identity value="v2"/>
          <map value="IAM-9-Sensitivity to Causative Agent Code"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="AllergyIntolerance.recordedDate"/>
      <definition>
        <short value="When recorded"/>
        <formal value="Date when the sensitivity was recorded."/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="dateTime"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".participation[typeCode=AUT].time"/>
        </mapping>
        <mapping>
          <identity value="v2"/>
          <map value="IAM-20-Statused at Date/Time"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="AllergyIntolerance.status"/>
      <definition>
        <short value="suspected | confirmed | refuted | resolved"/>
        <formal value="Status of the sensitivity."/>
        <min value="1"/>
        <max value="1"/>
        <type>
          <code value="code"/>
        </type>
        <isModifier value="true"/>
        <binding>
          <name value="SensitivityStatus"/>
          <isExtensible value="false"/>
          <conformance value="required"/>
          <referenceResource>
            <reference value="http://hl7.org/fhir/vs/sensitivitystatus"/>
          </referenceResource>
        </binding>
        <mapping>
          <identity value="rim"/>
          <map value=".status (suspected/confirmed differentiated by uncertaintyCode)"/>
        </mapping>
        <mapping>
          <identity value="v2"/>
          <map value="IAM-17-Allergy Clinical Status Code"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="AllergyIntolerance.subject"/>
      <definition>
        <short value="Who the sensitivity is for"/>
        <formal value="The patient who has the allergy or intolerance."/>
        <min value="1"/>
        <max value="1"/>
        <type>
          <code value="ResourceReference"/>
          <profile value="http://hl7.org/fhir/profiles/Patient"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".participation[typeCode=SBJ].role[classCode=PAT]"/>
        </mapping>
        <mapping>
          <identity value="v2"/>
          <map value="PID-3-Patient ID List"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="AllergyIntolerance.recorder"/>
      <definition>
        <short value="Who recorded the sensitivity"/>
        <formal value="Indicates who has responsibility for the record."/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="ResourceReference"/>
          <profile value="http://hl7.org/fhir/profiles/Practitioner"/>
        </type>
        <type>
          <code value="ResourceReference"/>
          <profile value="http://hl7.org/fhir/profiles/Patient"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".participation[typeCode=AUT].role"/>
        </mapping>
        <mapping>
          <identity value="v2"/>
          <map value="IAM-14-Reported By (if patient) / IAM-18-Statused By Person (if practitioner)"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="AllergyIntolerance.substance"/>
      <definition>
        <short value="The substance that causes the sensitivity"/>
        <formal value="The substance that causes the sensitivity."/>
        <min value="1"/>
        <max value="1"/>
        <type>
          <code value="ResourceReference"/>
          <profile value="http://hl7.org/fhir/profiles/Substance"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".participation[typeCode=SBJ].role[classCode=ADMM]"/>
        </mapping>
        <mapping>
          <identity value="v2"/>
          <map value="AL1-3-Allergen Code/Mnemonic/Description / IAM-3-Allergen Code/Mnemonic/Description"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="AllergyIntolerance.reaction"/>
      <definition>
        <short value="Reactions associated with the sensitivity"/>
        <formal value="Reactions associated with the sensitivity."/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="ResourceReference"/>
          <profile value="http://hl7.org/fhir/profiles/AdverseReaction"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".outboundRelationship[typeCode=SPRT].target[classCode=OBS, moodCode=EVN, code&lt;AdverseReaction]"/>
        </mapping>
        <mapping>
          <identity value="v2"/>
          <map value="IAM-7-Allergy Unique Identifier (Overloaded concept)"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="AllergyIntolerance.sensitivityTest"/>
      <definition>
        <short value="Observations that confirm or refute"/>
        <formal value="Observations that confirm or refute the sensitivity."/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="ResourceReference"/>
          <profile value="http://hl7.org/fhir/profiles/Observation"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".outboundRelationship[typeCode=SPRT].target[classCode=OBS, moodCode=EVN, code&lt;SensitivityTest]"/>
        </mapping>
        <mapping>
          <identity value="v2"/>
          <map value="OBX-21-Observation Instance Identifier (Subject to Ch7 caveats)"/>
        </mapping>
      </definition>
    </element>
    <searchParam>
      <name value="_id"/>
      <type value="token"/>
      <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/>
    </searchParam>
    <searchParam>
      <name value="_language"/>
      <type value="token"/>
      <documentation value="The language of the resource"/>
    </searchParam>
    <searchParam>
      <name value="date"/>
      <type value="date"/>
      <documentation value="Recorded date/time."/>
      <xpath value="f:AllergyIntolerance/f:recordedDate"/>
    </searchParam>
    <searchParam>
      <name value="recorder"/>
      <type value="reference"/>
      <documentation value="Who recorded the sensitivity"/>
      <xpath value="f:AllergyIntolerance/f:recorder"/>
    </searchParam>
    <searchParam>
      <name value="status"/>
      <type value="token"/>
      <documentation value="The status of the sensitivity"/>
      <xpath value="f:AllergyIntolerance/f:status"/>
    </searchParam>
    <searchParam>
      <name value="subject"/>
      <type value="reference"/>
      <documentation value="The subject that the sensitivity is about"/>
      <xpath value="f:AllergyIntolerance/f:subject"/>
    </searchParam>
    <searchParam>
      <name value="substance"/>
      <type value="reference"/>
      <documentation value="The name or code of the substance that produces the sensitivity"/>
      <xpath value="f:AllergyIntolerance/f:substance"/>
    </searchParam>
    <searchParam>
      <name value="type"/>
      <type value="token"/>
      <documentation value="The type of sensitivity"/>
      <xpath value="f:AllergyIntolerance/f:sensitivityType"/>
    </searchParam>
  </structure>
</Profile>