Allergy or intolerance (generally: risk of adverse reaction to a substance)
Retrieving a patient’s allergy intolerances
The logical ID (of the patient to retrieve) is passed as part of the URL. The logical ID is found as the result of a search.
GET https://tw171.open.allscripts.com/FHIR/Patient/id/AllergyIntolerance
GET https://tw171.open.allscripts.com/FHIR/Patient/id/AllergyIntolerance?date=eq2016-01-01
| Name | Required? | Type | Description |
|---|---|---|---|
| id | yes | URL | The logical ID of the patient. This is retrieved using the search function. |
| date | no | string | A string representing a date to include in the search. See below for more information. |
A DAF AllergyIntolerance is returned.
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | 0..* | Identifier associated with the allergy/intolerance concern that are defined by the business processes and/or used to refer to it when a direct URL reference to the resource is not appropriate. For example, in CDA documents or in written/printed documentation. | |
| onset | dateTime | 0..1 | Date and/or time of the onset of the allergy or intolerance. |
| recordedDate | dateTime | 0..1 | Date when the sensitivity was recorded. |
| recorder | Reference(Practitioner, Patient) | 0..1 | Individual who recorded the allergy and takes responsibility for its content. Options include either DAF-Practitioner profile or DAF-Patient profile. |
| patient | Reference(Patient) | 1..1 | Defines constraints and extensions on the patient resource for use in querying and retrieving patient demographic information. |
| reporter | Reference(Patient, RelatedPerson, Practitioner) | 0..1 | Source of the information about the allergy that is recorded. |
| substance | CodeableConcept | 1..1 | Identification of a substance or class of substances that is considered to be responsible for the adverse reaction risk. AllergyIntolerance.substance has an extensible binding to a value set consisting of: NDF-RT (codes for drug class allergies), RXNORM (codes limited to term types- TTY- such as BN or Brand Name, IN or Ingredient, MIN or multiple ingredient, and PIN or precise ingredient for drug ingredient allergies) or SNOMED CT (used when no other code from the other code systems is appropriate, such as No Known Allergies, No Known Food Allergies, No Known Drug Allergies, or No Known Environmental Allergies). For more information on this value set, see: http://hl7.org/fhir/ValueSet/allergyintolerance-substance-code. |
| status | code | 0..1 | Assertion about certainty associated with the propensity or potential risk of a reaction to the identified substance. The codes shall be taken from the AllergyIntoleranceStatus value set which includes: Active, Unconfirmed, Confirmed, Inactive, Resolved, Refuted, and Entered in Error. Decision support would typically raise alerts for Unconfirmed, Confirmed, and Resolved and ignore a Refuted reaction. In particular, Refuted may be useful for reconciliation of the Adverse Reaction List. Conformance is required and as such, some implementations may choose to make this field mandatory. For more information on this value set, see: http://hl7.org/fhir/ValueSet/allergy-intolerance-status. |
| criticality | code | 0..1 | Estimate of the potential clinical harm or seriousness of the reaction to the identified substance. The codes shall be taken from the AllergyIntoleranceCriticality value set with required conformance and include: CRITL-Low, CRITH-High, and CRITU-Unable to determine. For more information on this value set, see: http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality. |
| type | code | 0..1 | Identification of the underlying physiological mechanism for a reaction risk. This value set includes two types: Allergy or Intolerance. For more information on this value set, see: http://hl7.org/fhir/ValueSet/allergy-intolerance-type. |
| category | code | 0..1 | Category of the allergy. Options include: Food, Medication, Environment, and Other. For more information on this value set, see: http://hl7.org/fhir/ValueSet/allergy-intolerance-category. |
| lastOccurence | dateTime | 0..1 | Date and time of the last known occurrence of the reaction. |
| note | Annotation | 0..1 | Additional text not captured in other fields. |
| reaction | Backbone element - http://www.hl7.org/fhir/daf/daf-allergyintolerance-definitions.html#daf-allergyintolerance.AllergyIntolerance.reaction | 0..* | Details about each adverse reaction event linked to exposure to the identified substance. |
| – reaction.substance | CodeableConcept | 0..1 | Identification of the specific substance 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 must be consistent with it. For instance, it may be a more specific substance such as a brand medication or a composite substance that includes the identified substance. It must be clinically safe to only process the AllergyIntolerance.substance and ignore the AllergyIntolerance.event.substance. For more information on this value set, see: http://hl7.org/fhir/ValueSet/substance-code. |
| – reaction.manifestation | CodeableConcept | 1..* | Clinical symptoms and signs associated with the event. For more information on this value set, see: http://hl7.org/fhir/ValueSet/manifestation-codes. |
| – reaction.description | string | 0..1 | Description of the event as a whole. |
| – reaction.onset | dateTime | 0..1 | Date and time when manifestations showed. |
| – reaction.severity | code | 0..1 | Severity of the reaction or of the event as a whole. Options include: Mild, Moderate, or Severe. For more information on this value set, see: http://hl7.org/fhir/ValueSet/reaction-event-severity. |
| – reaction.exposureRoute | CodeableConcept | 0..1 | How the subject was exposed to the substance. For more information on this value set, see: http://hl7.org/fhir/ValueSet/route-codes. |
| – reaction.note | Annotation | 0..1 | Text about the event not captured in other fields. |
Searching by date
Dates are passed in as query parameters in the URL. Since the URL parameters cannot handle comparators (for example, >, <=) these are passed as part of the date.
date=eq2016-01-01
date=gt2016-01-01
The following comparators are supported:
| Comparator | Description |
|---|---|
| eq | equal |
| gt | greater than |
| ge | greater than or equal |
| lt | less than |
| le | less than or equal |
To search for a date range, pass the date twice.
For example: date=ge2010-01-01&date=le2010-12-31
This search would include every day in the year 2010.