This resource contains recorded details about a patient’s allergy or intolerance to medication, food, materials, or other substances. It provides a holistic view of a documented allergy so that you know whether the allergy is current and needs to be treated, or how severe the patient’s reaction may be for a given allergy. A documented allergy may be active or resolved, and the patient’s reaction may be anywhere from moderate to severe.
You can retrieve, receive, or save allergy information.
$write
This operation allows you to save new or updated allergy details to a patient’s chart.
cURL request example
Request Body Schema
- resourceTyperequired, string
Identifies the type of the resource
Value:Bundle
- typerequired, string
Identifies this bundle as a message
Value:message
- entryrequired, Array of MessageHeader, AllergyIntolerance, Patient or Other
An array of FHIR resources. At a minimum, an AllergyIntolerance should include the following entries:
- AllergyIntolerance - The allergy or intolerance being described
- Patient - The patient who has the allergy or intolerance
If other resources are included, due to being referenced within an entry, they should conform to the applicable Redox profile.
- resourcerequired, object
Additional metadata about the message including the event
- resourceTyperequired, string
Identifies the type of the resource
Value:MessageHeader
- sourcerequired, object
Information about the sender of the message. This will typically be populated by Redox.
- endpointrequired, string
Identifies the routing target to send acknowledgements to.
- namestring
Human-readable name for the source system.
- eventCodingrequired, object
This describes the message being communicated
- systemstring
The identification of the code system that defines the meaning of the symbol in the code.
- codestring
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Value:AllergyIntolerance-New
An entry in the bundle containing a FHIR resource
- timestampstring
The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.