AllergyIntolerance Resource

Introduction

  • This page documents the implementation of the FHIR AllergyIntolerance resource for the OpenMRS FHIR Module

  • Allergy or Intolerance; a propensity, or a potential risk to an individual, to have an adverse reaction on future exposure to the specified substance, or class of substance.

  • For more information on the FHIR AllergyIntolerance resource, please refer to https://www.hl7.org/fhir/allergyintolerance.html.

Populating the FHIR AllergyIntolerance Resource 

Shown below is how attributes of the FHIR AllergyIntolerance Resource map to the attributes of the OpenMRS Person object. The left side of the relationship indicates the OpenMRS attribute; the right indicates the FHIR Person resource mapping.

AllergyIntolerance JSON Representation

Shown below is an  out FHIR AllergyIntolerance Resource.



AllergyIntolerance
{ "resourceType": "AllergyIntolerance", "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "active" } ], "text": "Active" }, "type": "allergy", "category": [ "medication" ], "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification", "code": "confirmed" } ], "text": "Confirmed" }, "code": { "coding": [ { "code": "5085AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" } ] }, "patient": { "reference": "Patient/da7f524f-27ce-4bb2-86d6-6d1d05312bd5", "type": "Patient" }, "recorder": { "reference": "Practitioner/c98a1558-e131-11de-babe-001e378eb67e", "type": "Practitioner" }, "reaction": [ { "manifestation": [ { "coding": [ { "code": "5088AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" } ], "text": "manifestation text" } ], "severity": "severe" } ] }



Available RESTful web services for the Person Resource supported by the API



Note: placeholder "{release}" below must be replaced by the FHIR Release - currently "R3" and "R4" are implemented. See more on the  FHIR Release support  page.

GET Requests

Read (GET Request)

Read (GET Request)

url

description

/ws/fhir/{release}/AllergyIntolerance/{id}

Returns a FHIR AllergyIntolerance resource identified by a openmrs allergy UUID

Outcomes:

  • Returns a FHIR AllergyIntolerance resource if the specified allergy exists

  • Returns an Operation Outcome resource with a 404 error message if the specified allergy does not exist

Search (GET Request)

/ws/fhir/{release}/AllergyIntolerance?_id={id}

Returns a list of FHIR AllergyIntolerance resources identified by a allergy UUID

/ws/fhir/{release}/AllergyIntolerance?patient.identifier={identifier}

Search allergies belongs to the patient specified in the identifier

/ws/fhir/{release}/AllergyIntolerance?patient.name={name}

Search allergies belongs to the patient specified by the name



POST Requests

None to date