Clinical | Allergy Intolerance

0. References

1. Read

Return a single AllergyIntolerance for the specified id.

All requests SHALL contain a valid ‘Authorization’ header and SHALL contain an ‘Accept’ header. The `Accept` header indicates the format of the response the client is able to understand, this will be one of the following application/json+fhir or application/xml+fhir.

1.1. Response

A full set of response codes can be found here API Response Codes. FHIR Servers SHALL support the following response codes:

2. Search

Search for all allergies for a patient. Fetches a bundle of all AllergyIntolerance resources for the specified patient.

All requests SHALL contain a valid ‘Authorization’ header and SHALL contain an ‘Accept’ header. The `Accept` header indicates the format of the response the client is able to understand, this will be one of the following application/json+fhir or application/xml+fhir.

2.1. Search Parameters

This implementation guide outlines some suggested search parameters for the AllergyIntolerance resource in the table below. To be conformant, provider systems are required to implement all of the SHALL parameters. Provider systems may implement the full list of search parameters for the AllergyIntolerance resource (HL7 FHIR STU3 AllergyIntolerance).

2.1.1. clinical-status

See token for details on this parameter.

To filter on clinical-status ( active | inactive | resolved )

GET [baseUrl]/AllergyIntolerance?patient=1&clinical-status=refuted

Return all AllergyIntolerance resources with a clinical-status of refuted and Patient with a logical id of 1.

2.1.2. date

See date for details on this parameter. ‘date’ can be used multiple times as a search parameter

GET [baseUrl]/AllergyIntolerance?patient=1&date=ge2010-01-01&date=le2011-12-31

Return all AllergyIntolerance resources that have a date greater than or equal to 1st Jan 2010, a date less than or equal to 31st Dec 2011 and Patient with a logical id of 1.

2.1.3. patient

See reference for details on this parameter. The patient parameter can be used two ways:

This SHALL be supported for all endpoint provider systems.

id is the logical id of the patient on the server which can be obtained by a Patient resource query.

GET [baseUrl]/AllergyIntolerance?patient=42

Return all AllergyIntolerance resources for Patients with a logical id of 42

This SHOULD be supported by middleware systems (e.g. enterprise application integration (EAI) and the enterprise service bus (ESB)) and MAY be supported for endpoint provider systems.

system is a uniform resource identifier which defines which CodeSystem the identifer belongs to. For NHS Number this would be https://fhir.nhs.uk/Id/nhs-number and code would be the NHS Number.

GET [baseUrl]/AllergyIntolerance?patient.identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210

Return all AllergyIntolerance resources for Patients with a NHS Number of 9876543210

2.2. Search Response

If the search fails (cannot be executed, not that there is no matches), the return value is a status code 4xx or 5xx with an OperationOutcome.

If the search succeeds, the return content is a Bundle with type = searchset containing the results of the search as a list of resources in a defined order. The result list can be long, so servers MAY use paging. If they do, they SHALL use this Paging method for breaking the list into pages if appropriate. The server MAY also return an OperationOutcome resource with additional information about the search; if one is sent it SHALL NOT include any errors, and it shall be marked with an entry mode of include.

A full set of response codes can be found here API Response Codes. FHIR Servers SHALL support the following response codes:

3. Example

3.1 cURL

Return all AllergyIntolerance resources for Patient with an id of 1, the format of the response body will be xml. Replace ‘baseUrl’ with the actual base Url of the FHIR Server.

curl -X GET -H 'Accept: application/xml+fhir' -H 'Authorisation: BEARER [token]' -v 'https://data.developer.nhs.uk/ccri/STU3/AllergyIntolerance?patient=1'

3.2 Explore the Response

Explore the response in XML & JSON on the Reference Implementation below

Reference Implementation
XML Patient id search RI viewer
JSON Patient id search RI viewer