xCaliber healthCare Data Mesh

AllergyIntolerance

Overview

This resource ensures accurate and comprehensive documentation of patient allergies, improving patient safety and healthcare decision-making. It facilitates the systematic recording of allergy-related data, using standardized codes for interoperability and enhancing the overall quality of healthcare services. Developers can leverage this source object to build features and applications that support the management of patient allergies.

Use Cases

  • Clinical decision support - Check for allergies before prescribing medications, ordering foods, and administering treatments.
  • Adverse reaction avoidance - Prevent administrations of substances to which the patient is allergic or intolerant.
  • Inventory management - Manage inventories and purchasing to avoid allergens.
  • Public health reporting - Analyze allergy prevalence across populations for research.
  • Clinical documentation - Record allergies in clinical notes, and medical history.
  • Emergency awareness - Highlight critical allergies during emergencies to inform treatment.

EHR Data Model

EHRSupported?Mapped Source Object
AthenaAllergies
ElationAllergy, Drug Intolerance
EpicAllergy

Object Definition

{
  "resourceType": "AllergyIntolerance",
  "id": "fishallergy",
  "text": {
    "status": "additional",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p>allergy is to fresh fish. Tolerates canned fish</p>\n      <p>recordedDate:2015-08-06T00:00:00-06:00</p>\n      <p>substance:Fish - dietary (substance)</p>\n    </div>"
  },
  "identifier": [
    {
      "system": "http://acme.com/ids/patients/risks",
      "value": "49476535"
    }
  ],
  "clinicalStatus": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
        "code": "active",
        "display": "Active"
      }
    ]
  },
  "verificationStatus": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
        "code": "confirmed",
        "display": "Confirmed"
      }
    ]
  },
  "category": [
    "food"
  ],
  "code": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "227037002",
        "display": "Fish - dietary (substance)"
      }
    ],
    "text": "Allergic to fresh fish. Tolerates canned fish"
  },
  "patient": {
    "reference": "Patient/example"
  },
  "recordedDate": "2015-08-06T15:37:31-06:00",
  "recorder": {
    "reference": "Practitioner/example"
  },
  "meta": {
    "tag": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
        "code": "HTEST",
        "display": "test health data"
      }
    ]
  }
}

Data Fields

Data FieldTypeDescription
resourceTypeAllergyIntoleranceThis is a AllergyIntolerance resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can 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 "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedBackboneElementThese 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.
extensionExtensionMay be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionExtensionMay 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierIdentifierBusiness identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
clinicalStatusCodeableConceptThe clinical status of the allergy or intolerance.
verificationStatusCodeableConceptAssertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).
typecodeIdentification of the underlying physiological mechanism for the reaction risk.
categorycodeCategory of the identified substance.
criticalitycodeEstimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.
codeCodeableConceptCode for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a negated/excluded code for a specific substance or class (e.g., "No latex allergy") or a general or categorical negated statement (e.g., "No known allergy", "No known drug allergies"). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.
patientReferenceThe patient who has the allergy or intolerance.
encounterReferenceThe encounter when the allergy or intolerance was asserted.
onsetDateTimestringEstimated or actual date, date-time, or age when allergy or intolerance was identified.
onsetAgeAgeEstimated or actual date, date-time, or age when allergy or intolerance was identified.
onsetPeriodPeriodEstimated or actual date, date-time, or age when allergy or intolerance was identified.
onsetRangeRangeEstimated or actual date, date-time, or age when allergy or intolerance was identified.
onsetStringstringEstimated or actual date, date-time, or age when allergy or intolerance was identified.
recordedDatedateTimeThe recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.
recorderReferenceIndividual who recorded the record and takes responsibility for its content.
asserterReferenceThe source of the information about the allergy that is recorded.
lastOccurrencedateTimeRepresents the date and/or time of the last known occurrence of a reaction event.
noteAnnotationAdditional narrative about the propensity for the Adverse Reaction, not captured in other fields.
reactionBackboneElementDetails about each adverse reaction event linked to exposure to the identified substance.
reaction.idstringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
reaction.extensionExtensionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
reaction.modifierExtensionExtensionMay 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
reaction.substanceCodeableConceptIdentification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.
reaction.manifestationCodeableConceptClinical symptoms and/or signs that are observed or associated with the adverse reaction event.
reaction.descriptionstringText description about the reaction as a whole, including details of the manifestation if required.
reaction.onsetdateTimeRecord of the date and/or time of the onset of the Reaction.
reaction.severitycodeClinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.
reaction.exposureRouteCodeableConceptIdentification of the route by which the subject was exposed to the substance.
reaction.noteAnnotationAdditional text about the adverse reaction event not captured in other fields.

Extensions

NameURL
DELETEDDATEhttp://xcaliber-fhir/structureDefinition/deleted-date
REACTIVATEDATEhttp://xcaliber-fhir/structureDefinition/reactivate-date
SEVERITYSNOMEDCODEhttp://xcaliber-fhir/structureDefinition/severity-code
DEACTIVATEDDATEhttp://xcaliber-fhir/structureDefinition/deactivate-date
SECTIONNOTEhttp://xcaliber-fhir/structureDefinition/section-note
NKDAhttp://xcaliber-fhir/structureDefinition/nkda
LASTMODIFIEDBYhttp://xcaliber-fhir/structureDefinition/last-modified-by
LASTMODIFIEDDATETIMEhttp://xcaliber-fhir/structureDefinition/last-modified-date-time
LASTUPDATEDhttp://xcaliber-fhir/structureDefinition/last-updated
NOTELASTMODIFIEDBYhttp://xcaliber-fhir/structureDefinition/note-last-modified-by
NOTELASTMODIFIEDDATETIMEhttp://xcaliber-fhir/structureDefinition/note-last-modified-date-time

Operations & APIs

AllergyIntolerance-GET

AllergyIntolerance-POST

AllergyIntolerance ID-GET

AllergyIntolerance ID-PUT

AllergyIntolerance ID-Delete

AllergyIntolerance Export-POST