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

4.1.6 Resource AllergyIntolerance - Examples

Example Index:

A typical Food AllergyXMLJSON
A typical Medication allergy from a clinical systemXMLJSON

4.1.6.1 Food Allergy

XML

A typical Food Allergy (id = "example")

Raw XML

<AllergyIntolerance xmlns="http://hl7.org/fhir">
  <id value="example"/>


  <!--   an identifier used for this Adverse Reaction Risk   -->
  <identifier>
    <system value="http://acme.com/ids/patients/risks"/>
    <value value="49476534"/>
  </identifier>

  <!--   the date that this entry was recorded   -->  
  <recordedDate value="2014-10-09T14:58:00+11:00"/>
  
  <!--   who made the record / last updated it   -->
  <recorder>
    <reference value="Practitioner/example"/>
  </recorder>
  
  <!--   the subject (patient) that actually has the risk of adverse reaction   -->
  <subject>
    <reference value="Patient/example"/>
  </subject>

  <!--   subtance - either coded, or text. A few times, 
    there's a full description of a complex substance - in these caes, use the
    extension [url] to refer to a Substance resource   -->
  <substance>
    <coding>
      <system value="http://snomed.info/sct"/>
      <code value="227493005"/>
      <display value="Cashew nuts"/>
    </coding>
  </substance>
 
  <!--   this individual has had several reactions, and there is no 
    question that the allergy is real and serious   --> 
  <status value="confirmed"/>
  <criticality value="high"/>
  
  <!--   note: it's often unknown whether an allergy is mediated by an immune response, and not
   as significant as once thought   -->
  <type value="immune"/>
  
  <!--   this categorisation is implied by &quot;cashew nut&quot; and therefore basically 
    redundant, but many systems collect this field anyway, since it's either 
    useful when the substance is not coded, or it's quicker to sort/filter on
    than using terminology based reasoning   -->
  <category value="food"/>
  
  <!--   last happened June 2012. Typically, systems either track lastOccurence,
     or a list of events.   -->
  <lastOccurence value="2012-06"/>
  
  <!--   past events. There's no claim that this is all the events, and 
     that should not be assumed   -->
  <event> 
    <!--   
      It's possible to list specific things to which the patient responded,
      e.g. chocolate (that happened to contain cashew nuts). This event has
      such a specific substance. Note that systems should ensure that what
      goes in here does not conflict with the substance above, and systems
      processing the data can be sure that what is here does not contravene
      the substance above
      -->
    <substance>
      <coding>
        <system value="http://www.nlm.nih.gov/research/umls/rxnorm"/>
        <code value="C3214954"/>
        <display value="cashew nut allergenic extract Injectable Product"/>
      </coding>  
    </substance>
    
    <!--   this was a challenge protocol   -->
    <certainty value="confirmed"/>
    <manifestation>
      <coding>
        <system value="http://snomed.info/sct"/>
        <code value="39579001"/>
        <display value="Anaphylactic reaction"/>
      </coding>
    </manifestation>
    <description value="Challenge Protocol. Severe Reaction to 1/8 cashew. Epinephrine administered"/>
    <onset value="2012-06-12"/>
    <severity value="severe"/>
  </event>
  <event> 
    <!--   this was the first occurence   -->
    <certainty value="likely"/>
    <manifestation>
      <coding>
        <system value="http://snomed.info/sct"/>
        <code value="64305001"/>
        <display value="Urticaria"/>
      </coding>
    </manifestation>
    <onset value="2004"/>
    <severity value="moderate"/>
  </event>
</AllergyIntolerance>

JSON

A typical Food Allergy

Raw JSON (Canonical)

{
  "resourceType": "AllergyIntolerance",
  "id": "example",
  "identifier": [
    {
      "system": "http://acme.com/ids/patients/risks",
      "value": "49476534"
    }
  ],
  "recordedDate": "2014-10-09T14:58:00+11:00",
  "recorder": {
    "reference": "Practitioner/example"
  },
  "subject": {
    "reference": "Patient/example"
  },
  "substance": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "227493005",
        "display": "Cashew nuts"
      }
    ]
  },
  "status": "confirmed",
  "criticality": "high",
  "type": "immune",
  "category": "food",
  "lastOccurence": "2012-06",
  "event": [
    {
      "substance": {
        "coding": [
          {
            "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
            "code": "C3214954",
            "display": "cashew nut allergenic extract Injectable Product"
          }
        ]
      },
      "certainty": "confirmed",
      "manifestation": [
        {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "39579001",
              "display": "Anaphylactic reaction"
            }
          ]
        }
      ],
      "description": "Challenge Protocol. Severe Reaction to 1/8 cashew. Epinephrine administered",
      "onset": "2012-06-12",
      "severity": "severe"
    },
    {
      "certainty": "likely",
      "manifestation": [
        {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "64305001",
              "display": "Urticaria"
            }
          ]
        }
      ],
      "onset": "2004",
      "severity": "moderate"
    }
  ]
}

4.1.6.2 Medication Allergy

XML

A typical Medication allergy from a clinical system (id = "medication")

Raw XML

<AllergyIntolerance xmlns="http://hl7.org/fhir">
  <id value="medication"/>
  
  <!--   the date that this entry was recorded   -->  
  <recordedDate value="2010-03-01"/>
  
  <!--   who made the record / last updated it   -->
  <recorder>
    <reference value="Practitioner/13"/>
  </recorder>
  
  <!--   the subject (patient) that actually has the risk of adverse reaction   -->
  <subject>
    <reference value="Patient/example"/>
  </subject>

  <!--   subtance, coded from RxNorm   -->
  <substance>
    <coding>
      <system value="http://www.nlm.nih.gov/research/umls/rxnorm"/>
      <code value="314422"/>
      <display value="ALLERGENIC EXTRACT, PENICILLIN"/>
    </coding>
  </substance>
 
  <status value="unconfirmed"/>
  <criticality value="high"/> 
  <category value="medication"/>
  
  <event> 
    <manifestation>
      <coding>
        <system value="http://snomed.info/sct"/>
        <code value="247472004"/>
        <display value="Hives"/>
      </coding>
    </manifestation>
  </event>
</AllergyIntolerance>

JSON

A typical Medication allergy from a clinical system

Raw JSON (Canonical)

{
  "resourceType": "AllergyIntolerance",
  "id": "medication",
  "recordedDate": "2010-03-01",
  "recorder": {
    "reference": "Practitioner/13"
  },
  "subject": {
    "reference": "Patient/example"
  },
  "substance": {
    "coding": [
      {
        "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
        "code": "314422",
        "display": "ALLERGENIC EXTRACT, PENICILLIN"
      }
    ]
  },
  "status": "unconfirmed",
  "criticality": "high",
  "category": "medication",
  "event": [
    {
      "manifestation": [
        {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "247472004",
              "display": "Hives"
            }
          ]
        }
      ]
    }
  ]
}

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.