The AllergyIntolerance resource implements the FHIR R4 AllergyIntolerance specification and US Core v3.1.1 AllergyIntolerance profile

Fields

Name Type Cardinality Required Description
identifier Identifier 0..*   External ids for this item
clinicalStatus CodeableConcept 0..1   active | inactive | resolved ValueSet
verificationStatus CodeableConcept 1..1 * unconfirmed | confirmed | refuted | entered-in-error ValueSet
type code 0..1   allergy | intolerance - Underlying mechanism (if known)
category code 0..*   food | medication | environment | biologic
criticality code 0..1   low | high | unable-to-assess
code CodeableConcept 1..1 * Code that identifies the allergy or intolerance - ValueSet
patient Reference 1..1 * Who the sensitivity is for
encounter Reference 0..1   Encounter when the allergy or intolerance was asserted. When allergy or intolerance was identified
onsetDateTime dateTime 0..1   When allergy or intolerance was identified
onsetAge Age 0..1   When allergy or intolerance was identified
onsetPeriod Period 0..1   When allergy or intolerance was identified
onsetRange Range 0..1   When allergy or intolerance was identified
onsetString string 0..1   When allergy or intolerance was identified
recordedDate dateTime 0..1   Date first version of the resource instance was recorded
recorder Reference 0..1   Who recorded the sensitivity
asserter Reference 0..1   Source of the information about the allergy
lastOccurrence dateTime 0..1   Date(/time) of last known occurrence of a reaction
note Annotation 0..*   Additional text not captured in other fields
reaction BackboneElement 0..*   Adverse Reaction Events linked to exposure to substance
reaction.manifestation CodeableConcept 1..*   ValueSet

Interactions

Read

Get an AllergyIntolerance entry by id

GET /AllergyIntolerance/:id

Example

Request

https://r4cert.medicasoft.us/api/fhir/AllergyIntolerance/45576200-f225-2251-935f-c839c9e17bd7

Response

{
  "resourceType": "AllergyIntolerance",
  "clinicalStatus": {
    "coding": [
      {
        "code": "active",
        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical"
      }
    ]
  },
  "verificationStatus": {
    "coding": [
      {
        "code": "confirmed",
        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification"
      }
    ]
  },
  "type": "allergy",
  "category": [
    "food"
  ],
  "code": {
    "coding": [
      {
        "code": "300913006",
        "system": "http://snomed.info/sct",
        "display": "Shellfish allergy"
      }
    ],
    "text": "Shellfish allergy"
  },
  "patient": {
    "reference": "Patient/bcfa83df-ee8c-9721-cc07-bdcfc2b1e3f2"
  },
  "recordedDate": "1943-01-03T00:56:44-04:00",
  "reaction": [
    {
      "manifestation": [
        {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "271807003",
              "display": "skin rash"
            }
          ],
          "text": "skin rash"
        }
      ],
      "severity": "mild"
    }
  ],
  "id": "45576200-f225-2251-935f-c839c9e17bd7"
}

Query AllergyIntolerance resources

GET /AllergyIntolerance?:query_parameters

Parameters

Name Type Description
severity token mild | moderate | severe (of event as a whole)
date date Date record was believed accurate
manifestation token Clinical symptoms/signs associated with the Event
recorder reference Who recorded the sensitivity
code token Code that identifies the allergy or intolerance
verification-status token unconfirmed | confirmed | refuted | entered-in-error
clinical-status token active | inactive | resolved
patient reference Who the sensitivity is for
_include   AllergyIntolerance:recorder | AllergyIntolerance:asserter | AllergyIntolerance:patient | AllergyIntolerance:encounter
_revinclude   Provenance:target

Errors

Code Description
400 Invalid parameters
404 Resource not found