2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Allergyintolerance.profile.xml

Raw XML (canonical form)

Profile for allergyintolerance

Raw XML

<Profile xmlns="http://hl7.org/fhir">
  <id value="AllergyIntolerance"/>
  <meta>
    <lastUpdated value="2015-02-23T09:07:27.665+11:00"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/Profile/AllergyIntolerance"/>
  <name value="AllergyIntolerance"/>
  <publisher value="HL7 FHIR Project (Patient Care)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
  </contact>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/patientcare/index.cfm"/>
    </telecom>
  </contact>
  <description value="Base Profile for AllergyIntolerance Resource"/>
  <status value="draft"/>
  <date value="2015-02-23T09:07:27+11:00"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM"/>
  </mapping>
  <type value="AllergyIntolerance"/>
  <snapshot>
    <element>
      <path value="AllergyIntolerance"/>
      <short value="Allergy or Intolerance (generally: Risk Of Adverse reaction to a substance)"/>
      <definition value="Risk of harmful or undesirable, physiological response which is unique to an individual
       and associated with exposure to a substance."/>
      <comments value="Substances include, but are not limited to: a therapeutic substance administered correctly
       at an appropriate dosage for the individual; food; material derived from plants or animals;
       or venom from insect stings."/>
      <requirements value="To record a clinical assessment of a propensity, or potential risk to an individual, of
       an adverse reaction upon future exposure to the specified substance, or class of substance."/>
      <synonym value="Allergy"/>
      <synonym value="Intolerance"/>
      <synonym value="Adverse Reaction"/>
      <min value="1"/>
      <max value="1"/>
    </element>
    <element>
      <path value="AllergyIntolerance.id"/>
      <short value="Logical id of this artefact"/>
      <definition value="The logical id of the resource, as used in the url for the resoure. Once assigned, this
       value never changes."/>
      <comments value="The only time that a resource does not have an id is when it is being submitted to the
       server using a create operation. Bundles always have an id, though it is usually a generated
       UUID."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
    </element>
    <element>
      <path value="AllergyIntolerance.meta"/>
      <short value="Metadata about the resource"/>
      <definition value="The metadata about the resource. This is content that is maintained by the infrastructure.
       Changes to the content may not always be associated with version changes to the resource."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Meta"/>
      </type>
    </element>
    <element>
      <path value="AllergyIntolerance.implicitRules"/>
      <short value="A set of rules under which this content was created"/>
      <definition value="A reference to a set of rules that were followed when the resource was constructed, and
       which must be understood when processing the content."/>
      <comments value="Asserting this rule set restricts the content to be only understood by a limited set of
       trading partners. This inherently limits the usefulness of the data in the long term.
       However the existing health eco-system is highly fractured, and not yet ready to define,
       collect, and exchange data in a generally computable sense. Wherever possible, implementers
       and/or specification writers should avoid using this element as much as possible."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
      <isModifier value="true"/>
    </element>
    <element>
      <path value="AllergyIntolerance.language"/>
      <short value="Language of the resource content"/>
      <definition value="The base language in which the resource is written."/>
      <comments value="Language is provided to support indexing and accessibility (typically, services such as
       text to speech use the language tag). The html language tag in the narrative applies 
       to the narrative. The language tag on the resource may be used to specify the language
       of other presentations generated from the data in the resource  Not all the content has
       to be in the base language. The Resource.language should not be assumed to apply to the
       narrative automatically. If a language is specified, it should it also be specified on
       the div element in the html (see rules in HTML5 for information about the relationship
       between xml:lang and the html lang attribute)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="Language"/>
        <isExtensible value="false"/>
        <conformance value="required"/>
        <description value="A human language"/>
        <referenceUri value="http://tools.ietf.org/html/bcp47"/>
      </binding>
    </element>
    <element>
      <path value="AllergyIntolerance.text"/>
      <short value="Text summary of the resource, for human interpretation"/>
      <definition 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>
      <condition value="dom-1"/>
      <mapping>
        <identity value="rim"/>
        <map value="Act.text?"/>
      </mapping>
    </element>
    <element>
      <path value="AllergyIntolerance.contained"/>
      <short value="Contained, inline Resources"/>
      <definition 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>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="AllergyIntolerance.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition 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 set of 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 level of
       simplicity for everyone."/>
      <synonym value="extensions"/>
      <synonym value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="AllergyIntolerance.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition 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 set of 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 level of
       simplicity for everyone."/>
      <synonym value="extensions"/>
      <synonym value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="AllergyIntolerance.identifier"/>
      <short value="External Ids for this item"/>
      <definition 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>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".id"/>
      </mapping>
    </element>
    <element>
      <path value="AllergyIntolerance.recordedDate"/>
      <short value="When recorded"/>
      <definition value="Date when the sensitivity was recorded."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="dateTime"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".participation[typeCode=AUT].time"/>
      </mapping>
    </element>
    <element>
      <path value="AllergyIntolerance.recorder"/>
      <short value="Who recorded the sensitivity"/>
      <definition value="Indicates who has responsibility for the record."/>
      <synonym value="Author"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Practitioner"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Patient"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".participation[typeCode=AUT].role"/>
      </mapping>
    </element>
    <element>
      <path value="AllergyIntolerance.subject"/>
      <short value="Who the sensitivity is for"/>
      <definition value="The patient who has the allergy or intolerance."/>
      <synonym value="Patient"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Patient"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".participation[typeCode=SBJ].role[classCode=PAT]"/>
      </mapping>
    </element>
    <element>
      <path value="AllergyIntolerance.substance"/>
      <short value="Substance, (or class) considered to be responsible for risk"/>
      <definition value="Identification of a substance, or a class of substances, that is considered to be responsible
       for the Adverse reaction risk."/>
      <comments value="It is strongly recommended that Substance be coded with a terminology, where possible.
       For example, some terminologies used include RxNorm, Snomed CT, DM+D, NDFRT, ICD-9, IDC-10,
       UNI, ATC and CPT. Plain text should only be used if there is no appropriate terminology
       available."/>
      <synonym value="Agent"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <name value="SubstanceType"/>
        <isExtensible value="true"/>
        <conformance value="example"/>
        <description value="Type of the substance"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/substance-type"/>
        </referenceReference>
      </binding>
    </element>
    <element>
      <path value="AllergyIntolerance.status"/>
      <short value="unconfirmed | confirmed | resolved | refuted"/>
      <definition value="Assertion about certainty associated with the propensity, or potential risk, of a reaction
       to the identified Substance."/>
      <comments value="Decision support would typically raise alerts for 'Unconfirmed', 'Confirmed', and 'Resolved'
       and ignore a 'Refuted' reaction. In particular, 'Refuted' may be useful for reconciliation
       of the Adverse Reaction List. Some implementations may choose to make this field mandatory."/>
      <synonym value="State"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <isModifier value="true"/>
      <isSummary value="true"/>
      <binding>
        <name value="AllergyIntoleranceStatus"/>
        <isExtensible value="false"/>
        <conformance value="required"/>
        <description value="Assertion about certainty associated with a propensity, or potential risk, of a reaction
         to the identified Substance"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/allergy-intolerance-status"/>
        </referenceReference>
      </binding>
    </element>
    <element>
      <path value="AllergyIntolerance.criticality"/>
      <short value="low | high | unassessible - Estimated potential clinical harm"/>
      <definition value="Estimate of the potential clinical harm, or seriousness, of the reaction to the identified
       Substance."/>
      <comments value="The default criticality value for any propensity to an Adverse Reaction should be 'Low
       Risk', indicating at the very least a relative contraindication to deliberate or voluntary
       exposure to the Substance. 'High Risk' is flagged if the clinician has identified a propensity
       for a more serious or potentially life-threatening reaction, such as anaphylaxis, and
       implies an absolute contraindication to deliberate or voluntary exposure to the substance.
       If this element is missing, the criticality is unknown (though it may be known elsewhere)."/>
      <synonym value="Severity"/>
      <synonym value="Seriousness"/>
      <synonym value="Contra-indication"/>
      <synonym value="Risk"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <name value="AllergyIntoleranceCriticality"/>
        <isExtensible value="false"/>
        <conformance value="required"/>
        <description value="Estimate of the potential clinical harm, or seriousness, of a reaction to an identified
         Substance"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/allergy-intolerance-criticality"/>
        </referenceReference>
      </binding>
    </element>
    <element>
      <path value="AllergyIntolerance.type"/>
      <short value="immune | non-immune - Underlying mechanism (if known)"/>
      <definition value="Identification of the underlying physiological mechanism for the Reaction Risk."/>
      <comments value="Immune-mediated responses have been traditionally regarded as an indicator for escalation
       of significant future risk. Contemporary knowledge suggests that some reactions previously
       thought to be immune and non-immune and still carry life threatening risk.   It is acknowledged
       that many clinicians may not be in a position to distinguish the mechanism of a particular
       reaction.  This data element is included nevertheless because many legacy systems have
       captured this attribute.  Immunological testing may provide supporting evidence for the
       basis and causative substance , but no tests are 100% sensitive or specific for a sensitivity."/>
      <synonym value="Category"/>
      <synonym value="Class"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <name value="AllergyIntoleranceType"/>
        <isExtensible value="false"/>
        <conformance value="required"/>
        <description value="Identification of the underlying physiological mechanism for a Reaction Risk"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/allergy-intolerance-type"/>
        </referenceReference>
      </binding>
    </element>
    <element>
      <path value="AllergyIntolerance.category"/>
      <short value="food | medication | environment - Category of Substance"/>
      <definition value="Category of the identified Substance."/>
      <comments value="This data element has been included because it is currently being captured in some clinical
       systems. This data can be derived from the Substance where coding systems are used, and
       is effectively redundant in that situation."/>
      <synonym value="Category"/>
      <synonym value="Type"/>
      <synonym value="Reaction Type"/>
      <synonym value="Class"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <name value="AllergyIntoleranceCategory"/>
        <isExtensible value="false"/>
        <conformance value="required"/>
        <description value="Category of an identified Substance"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/allergy-intolerance-category"/>
        </referenceReference>
      </binding>
    </element>
    <element>
      <path value="AllergyIntolerance.lastOccurence"/>
      <short value="Date(/time) of last known occurence of a reaction"/>
      <definition value="Represents the date and/or time of the last known occurence of a reaction event."/>
      <comments value="This date may be replicated by one of the Onset of Reaction dates. Where a textual representation
       of the date of last occurence is required e.g 'In Childhood, '10 years ago' the Comment
       element should be used."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="dateTime"/>
      </type>
      <isSummary value="true"/>
    </element>
    <element>
      <path value="AllergyIntolerance.comment"/>
      <short value="Additional text not captured in other fields"/>
      <definition value="Additional narrative about the propensity for the Adverse Reaction, not captured in other
       fields."/>
      <comments value="For example: including reason for flagging a Seriousness of 'High Risk'; and instructions
       related to future exposure or administration of the Substance, such as administration
       within an Intensive Care Unit or under corticosteroid cover."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="AllergyIntolerance.event"/>
      <short value="Adverse Reaction Events linked to exposure to substance"/>
      <definition value="Details about each Adverse Reaction Event linked to exposure to the identified Substance."/>
      <min value="0"/>
      <max value="*"/>
    </element>
    <element>
      <path value="AllergyIntolerance.event.id"/>
      <representation value="xmlAttr"/>
      <short value="xml:id (or equivalent in JSON)"/>
      <definition value="unique id for the element within a resource (for internal references)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="AllergyIntolerance.event.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the element. In order to make the use of extensions safe and manageable, there is a
       strict set of 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 level of
       simplicity for everyone."/>
      <synonym value="extensions"/>
      <synonym value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="AllergyIntolerance.event.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the element, 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 set of 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 level of
       simplicity for everyone."/>
      <synonym value="extensions"/>
      <synonym value="user content"/>
      <synonym value="modifiers"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="AllergyIntolerance.event.substance"/>
      <short value="Specific substance considered to be responsible for event"/>
      <definition value="Identification of the specific substance considered to be responsible for the Adverse
       Reaction event. Note: the substance for a specific reaction may be different to the substance
       identified as the cause of the risk, but must be consistent with it. For instance, it
       may be a more specific substance (e.g. a brand medication) or a composite substance that
       includes the identified substance. It must be clinically safe to only process the AllergyIntolerance
      .substance and ignore the AllergyIntolerance.event.substance."/>
      <comments value="Coding of the Specific Substance with a terminology capable of triggering decision support
       should be used wherever possible.  The Substance field allows for the use of a specific
       substance or a group or class of substances, for example &quot;Penicillins&quot;. The
       specific Substance field could be used for Amoxycillin. Duplication is acceptable when
       a specific substance has been recorded in the 'Substance' field."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <name value="SubstanceType"/>
        <isExtensible value="true"/>
        <conformance value="example"/>
        <description value="Type of the substance"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/substance-type"/>
        </referenceReference>
      </binding>
    </element>
    <element>
      <path value="AllergyIntolerance.event.certainty"/>
      <short value="unlikely | likely | confirmed - clinical certainty about the specific substance"/>
      <definition value="Statement about the degree of clinical certainty that the Specific Substance was the cause
       of the Manifestation in this reaction event."/>
      <synonym value="Cause"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <name value="AllergyIntoleranceCertainty"/>
        <isExtensible value="false"/>
        <conformance value="required"/>
        <description value="Statement about the degree of clinical certainty that a Specific Substance was the cause
         of the Manifestation in an reaction event"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/reaction-event-certainty"/>
        </referenceReference>
      </binding>
    </element>
    <element>
      <path value="AllergyIntolerance.event.manifestation"/>
      <short value="Clinical symptoms/signs associated with the Event"/>
      <definition value="Clinical symptoms and/or signs that are observed or associated with the Adverse Reaction
       Event."/>
      <comments value="Manifestation can be expressed as a single word, phrase or brief description. For example:
       nausea, rash or no reaction. It is preferable that Manifestation should be coded with
       a terminology, where possible. The values entered here may be used to display on an application
       screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines.
        Terminologies commonly used include, but are not limited to, SNOMED-CT or ICD10."/>
      <synonym value="Symptoms"/>
      <synonym value="Signs"/>
      <min value="1"/>
      <max value="*"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <name value="Manifestation"/>
        <isExtensible value="true"/>
        <conformance value="example"/>
        <description value="Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction
         Event"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/manifestation-codes"/>
        </referenceReference>
      </binding>
    </element>
    <element>
      <path value="AllergyIntolerance.event.description"/>
      <short value="Description of the event as a whole"/>
      <definition value="Text description about the Reaction as a whole, including details of the manifestation
       if required."/>
      <synonym value="Narrative"/>
      <synonym value="Text"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="AllergyIntolerance.event.onset"/>
      <short value="Date(/time) when manifestations showed"/>
      <definition value="Record of the date and/or time of the onset of the Reaction."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="dateTime"/>
      </type>
      <isSummary value="true"/>
    </element>
    <element>
      <path value="AllergyIntolerance.event.duration"/>
      <short value="How long Manifestations persisted"/>
      <definition value="The amount of time that the Adverse Reaction persisted."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Duration"/>
      </type>
    </element>
    <element>
      <path value="AllergyIntolerance.event.severity"/>
      <short value="mild | moderate | severe (of event as a whole)"/>
      <definition value="Clinical assessment of the severity of the reaction event as a whole, potentially considering
       multiple different manifestations."/>
      <comments value="It is acknowledged that this assessment is very subjective. There may be some some specific
       practice domains where objective scales have been applied. Objective scales can be included
       in this model as extensions."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <name value="AllergyIntoleranceSeverity"/>
        <isExtensible value="false"/>
        <conformance value="required"/>
        <description value="Clinical assessment of the severity of a reaction event as a whole, potentially considering
         multiple different manifestations"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/reaction-event-severity"/>
        </referenceReference>
      </binding>
    </element>
    <element>
      <path value="AllergyIntolerance.event.exposureRoute"/>
      <short value="How the subject was exposed to the substance"/>
      <definition value="Identification of the route by which the subject was exposed to the substance."/>
      <comments value="Coding of the Route of Exposure with a terminology should be used wherever possible."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <name value="RouteOfAdministration"/>
        <isExtensible value="true"/>
        <conformance value="example"/>
        <description value="A coded concept describing the route or physiological path of administration of a therapeutic
         agent into or onto the body of a subject."/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/route-codes"/>
        </referenceReference>
      </binding>
    </element>
    <element>
      <path value="AllergyIntolerance.event.comment"/>
      <short value="Text about event not captured in other fields"/>
      <definition value="Additional text about the Adverse Reaction event not captured in other fields."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="AllergyIntolerance"/>
      <short value="Allergy or Intolerance (generally: Risk Of Adverse reaction to a substance)"/>
      <definition value="Risk of harmful or undesirable, physiological response which is unique to an individual
       and associated with exposure to a substance."/>
      <comments value="Substances include, but are not limited to: a therapeutic substance administered correctly
       at an appropriate dosage for the individual; food; material derived from plants or animals;
       or venom from insect stings."/>
      <requirements value="To record a clinical assessment of a propensity, or potential risk to an individual, of
       an adverse reaction upon future exposure to the specified substance, or class of substance."/>
      <synonym value="Allergy"/>
      <synonym value="Intolerance"/>
      <synonym value="Adverse Reaction"/>
      <min value="1"/>
      <max value="1"/>
    </element>
    <element>
      <path value="AllergyIntolerance.identifier"/>
      <short value="External Ids for this item"/>
      <definition 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>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".id"/>
      </mapping>
    </element>
    <element>
      <path value="AllergyIntolerance.recordedDate"/>
      <short value="When recorded"/>
      <definition value="Date when the sensitivity was recorded."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="dateTime"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".participation[typeCode=AUT].time"/>
      </mapping>
    </element>
    <element>
      <path value="AllergyIntolerance.recorder"/>
      <short value="Who recorded the sensitivity"/>
      <definition value="Indicates who has responsibility for the record."/>
      <synonym value="Author"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Practitioner"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Patient"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".participation[typeCode=AUT].role"/>
      </mapping>
    </element>
    <element>
      <path value="AllergyIntolerance.subject"/>
      <short value="Who the sensitivity is for"/>
      <definition value="The patient who has the allergy or intolerance."/>
      <synonym value="Patient"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Patient"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".participation[typeCode=SBJ].role[classCode=PAT]"/>
      </mapping>
    </element>
    <element>
      <path value="AllergyIntolerance.substance"/>
      <short value="Substance, (or class) considered to be responsible for risk"/>
      <definition value="Identification of a substance, or a class of substances, that is considered to be responsible
       for the Adverse reaction risk."/>
      <comments value="It is strongly recommended that Substance be coded with a terminology, where possible.
       For example, some terminologies used include RxNorm, Snomed CT, DM+D, NDFRT, ICD-9, IDC-10,
       UNI, ATC and CPT. Plain text should only be used if there is no appropriate terminology
       available."/>
      <synonym value="Agent"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <name value="SubstanceType"/>
        <isExtensible value="true"/>
        <conformance value="example"/>
        <description value="Type of the substance"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/substance-type"/>
        </referenceReference>
      </binding>
    </element>
    <element>
      <path value="AllergyIntolerance.status"/>
      <short value="unconfirmed | confirmed | resolved | refuted"/>
      <definition value="Assertion about certainty associated with the propensity, or potential risk, of a reaction
       to the identified Substance."/>
      <comments value="Decision support would typically raise alerts for 'Unconfirmed', 'Confirmed', and 'Resolved'
       and ignore a 'Refuted' reaction. In particular, 'Refuted' may be useful for reconciliation
       of the Adverse Reaction List. Some implementations may choose to make this field mandatory."/>
      <synonym value="State"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <isModifier value="true"/>
      <isSummary value="true"/>
      <binding>
        <name value="AllergyIntoleranceStatus"/>
        <isExtensible value="false"/>
        <conformance value="required"/>
        <description value="Assertion about certainty associated with a propensity, or potential risk, of a reaction
         to the identified Substance"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/allergy-intolerance-status"/>
        </referenceReference>
      </binding>
    </element>
    <element>
      <path value="AllergyIntolerance.criticality"/>
      <short value="low | high | unassessible - Estimated potential clinical harm"/>
      <definition value="Estimate of the potential clinical harm, or seriousness, of the reaction to the identified
       Substance."/>
      <comments value="The default criticality value for any propensity to an Adverse Reaction should be 'Low
       Risk', indicating at the very least a relative contraindication to deliberate or voluntary
       exposure to the Substance. 'High Risk' is flagged if the clinician has identified a propensity
       for a more serious or potentially life-threatening reaction, such as anaphylaxis, and
       implies an absolute contraindication to deliberate or voluntary exposure to the substance.
       If this element is missing, the criticality is unknown (though it may be known elsewhere)."/>
      <synonym value="Severity"/>
      <synonym value="Seriousness"/>
      <synonym value="Contra-indication"/>
      <synonym value="Risk"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <name value="AllergyIntoleranceCriticality"/>
        <isExtensible value="false"/>
        <conformance value="required"/>
        <description value="Estimate of the potential clinical harm, or seriousness, of a reaction to an identified
         Substance"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/allergy-intolerance-criticality"/>
        </referenceReference>
      </binding>
    </element>
    <element>
      <path value="AllergyIntolerance.type"/>
      <short value="immune | non-immune - Underlying mechanism (if known)"/>
      <definition value="Identification of the underlying physiological mechanism for the Reaction Risk."/>
      <comments value="Immune-mediated responses have been traditionally regarded as an indicator for escalation
       of significant future risk. Contemporary knowledge suggests that some reactions previously
       thought to be immune and non-immune and still carry life threatening risk.   It is acknowledged
       that many clinicians may not be in a position to distinguish the mechanism of a particular
       reaction.  This data element is included nevertheless because many legacy systems have
       captured this attribute.  Immunological testing may provide supporting evidence for the
       basis and causative substance , but no tests are 100% sensitive or specific for a sensitivity."/>
      <synonym value="Category"/>
      <synonym value="Class"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <name value="AllergyIntoleranceType"/>
        <isExtensible value="false"/>
        <conformance value="required"/>
        <description value="Identification of the underlying physiological mechanism for a Reaction Risk"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/allergy-intolerance-type"/>
        </referenceReference>
      </binding>
    </element>
    <element>
      <path value="AllergyIntolerance.category"/>
      <short value="food | medication | environment - Category of Substance"/>
      <definition value="Category of the identified Substance."/>
      <comments value="This data element has been included because it is currently being captured in some clinical
       systems. This data can be derived from the Substance where coding systems are used, and
       is effectively redundant in that situation."/>
      <synonym value="Category"/>
      <synonym value="Type"/>
      <synonym value="Reaction Type"/>
      <synonym value="Class"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <name value="AllergyIntoleranceCategory"/>
        <isExtensible value="false"/>
        <conformance value="required"/>
        <description value="Category of an identified Substance"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/allergy-intolerance-category"/>
        </referenceReference>
      </binding>
    </element>
    <element>
      <path value="AllergyIntolerance.lastOccurence"/>
      <short value="Date(/time) of last known occurence of a reaction"/>
      <definition value="Represents the date and/or time of the last known occurence of a reaction event."/>
      <comments value="This date may be replicated by one of the Onset of Reaction dates. Where a textual representation
       of the date of last occurence is required e.g 'In Childhood, '10 years ago' the Comment
       element should be used."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="dateTime"/>
      </type>
      <isSummary value="true"/>
    </element>
    <element>
      <path value="AllergyIntolerance.comment"/>
      <short value="Additional text not captured in other fields"/>
      <definition value="Additional narrative about the propensity for the Adverse Reaction, not captured in other
       fields."/>
      <comments value="For example: including reason for flagging a Seriousness of 'High Risk'; and instructions
       related to future exposure or administration of the Substance, such as administration
       within an Intensive Care Unit or under corticosteroid cover."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="AllergyIntolerance.event"/>
      <short value="Adverse Reaction Events linked to exposure to substance"/>
      <definition value="Details about each Adverse Reaction Event linked to exposure to the identified Substance."/>
      <min value="0"/>
      <max value="*"/>
    </element>
    <element>
      <path value="AllergyIntolerance.event.substance"/>
      <short value="Specific substance considered to be responsible for event"/>
      <definition value="Identification of the specific substance considered to be responsible for the Adverse
       Reaction event. Note: the substance for a specific reaction may be different to the substance
       identified as the cause of the risk, but must be consistent with it. For instance, it
       may be a more specific substance (e.g. a brand medication) or a composite substance that
       includes the identified substance. It must be clinically safe to only process the AllergyIntolerance
      .substance and ignore the AllergyIntolerance.event.substance."/>
      <comments value="Coding of the Specific Substance with a terminology capable of triggering decision support
       should be used wherever possible.  The Substance field allows for the use of a specific
       substance or a group or class of substances, for example &quot;Penicillins&quot;. The
       specific Substance field could be used for Amoxycillin. Duplication is acceptable when
       a specific substance has been recorded in the 'Substance' field."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <name value="SubstanceType"/>
        <isExtensible value="true"/>
        <conformance value="example"/>
        <description value="Type of the substance"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/substance-type"/>
        </referenceReference>
      </binding>
    </element>
    <element>
      <path value="AllergyIntolerance.event.certainty"/>
      <short value="unlikely | likely | confirmed - clinical certainty about the specific substance"/>
      <definition value="Statement about the degree of clinical certainty that the Specific Substance was the cause
       of the Manifestation in this reaction event."/>
      <synonym value="Cause"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <name value="AllergyIntoleranceCertainty"/>
        <isExtensible value="false"/>
        <conformance value="required"/>
        <description value="Statement about the degree of clinical certainty that a Specific Substance was the cause
         of the Manifestation in an reaction event"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/reaction-event-certainty"/>
        </referenceReference>
      </binding>
    </element>
    <element>
      <path value="AllergyIntolerance.event.manifestation"/>
      <short value="Clinical symptoms/signs associated with the Event"/>
      <definition value="Clinical symptoms and/or signs that are observed or associated with the Adverse Reaction
       Event."/>
      <comments value="Manifestation can be expressed as a single word, phrase or brief description. For example:
       nausea, rash or no reaction. It is preferable that Manifestation should be coded with
       a terminology, where possible. The values entered here may be used to display on an application
       screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines.
        Terminologies commonly used include, but are not limited to, SNOMED-CT or ICD10."/>
      <synonym value="Symptoms"/>
      <synonym value="Signs"/>
      <min value="1"/>
      <max value="*"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <name value="Manifestation"/>
        <isExtensible value="true"/>
        <conformance value="example"/>
        <description value="Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction
         Event"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/manifestation-codes"/>
        </referenceReference>
      </binding>
    </element>
    <element>
      <path value="AllergyIntolerance.event.description"/>
      <short value="Description of the event as a whole"/>
      <definition value="Text description about the Reaction as a whole, including details of the manifestation
       if required."/>
      <synonym value="Narrative"/>
      <synonym value="Text"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="AllergyIntolerance.event.onset"/>
      <short value="Date(/time) when manifestations showed"/>
      <definition value="Record of the date and/or time of the onset of the Reaction."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="dateTime"/>
      </type>
      <isSummary value="true"/>
    </element>
    <element>
      <path value="AllergyIntolerance.event.duration"/>
      <short value="How long Manifestations persisted"/>
      <definition value="The amount of time that the Adverse Reaction persisted."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Duration"/>
      </type>
    </element>
    <element>
      <path value="AllergyIntolerance.event.severity"/>
      <short value="mild | moderate | severe (of event as a whole)"/>
      <definition value="Clinical assessment of the severity of the reaction event as a whole, potentially considering
       multiple different manifestations."/>
      <comments value="It is acknowledged that this assessment is very subjective. There may be some some specific
       practice domains where objective scales have been applied. Objective scales can be included
       in this model as extensions."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <name value="AllergyIntoleranceSeverity"/>
        <isExtensible value="false"/>
        <conformance value="required"/>
        <description value="Clinical assessment of the severity of a reaction event as a whole, potentially considering
         multiple different manifestations"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/reaction-event-severity"/>
        </referenceReference>
      </binding>
    </element>
    <element>
      <path value="AllergyIntolerance.event.exposureRoute"/>
      <short value="How the subject was exposed to the substance"/>
      <definition value="Identification of the route by which the subject was exposed to the substance."/>
      <comments value="Coding of the Route of Exposure with a terminology should be used wherever possible."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <name value="RouteOfAdministration"/>
        <isExtensible value="true"/>
        <conformance value="example"/>
        <description value="A coded concept describing the route or physiological path of administration of a therapeutic
         agent into or onto the body of a subject."/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/route-codes"/>
        </referenceReference>
      </binding>
    </element>
    <element>
      <path value="AllergyIntolerance.event.comment"/>
      <short value="Text about event not captured in other fields"/>
      <definition value="Additional text about the Adverse Reaction event not captured in other fields."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
  </differential>
</Profile>

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.