Medication | Immunization

0. References

1. Read

Return a single Immunization for the specified id.

All requests MUST contain a valid ‘Authorization’ header and SHOULD 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/fhir+json or application/fhir+xml.

1.1. Response

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

2. Search

Search for all immunization resources for a patient. Fetches a bundle of all Immunization resources for the specified patient.

All requests MUST contain a valid ‘Authorization’ header and SHOULD 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/fhir+xml or application/fhir+json.

2.1. Search Parameters

The search parameters and combinations that are mandated as a minimum in the API for the Immunization resource are detailed below.

Query parameters conformance will be categorised as:

MUST - these search parameters MUST be implemented for the specified resource type.

SHOULD - these search parameters are expected to be implemented, if the data to support the query is present in the host system.

Additional search parameters MAY be added to reflect local requirements.

To be conformant, provider systems are required to implement all of the MUST parameters.

The parameters can be used independently or in combination to help refine the search results returned.

Search parameter combinations for the Immunization resource are as follows:

This section outlines the search parameter syntax used, with some examples provided.

2.1.1. notgiven

See token for details on this parameter.

To filter on notgiven ( true | false )

GET [baseUrl]/Immunization?patient=1&notgiven=false

Return all Immunization resources with a notgiven of false and Patient with a logical id of 1.

2.1.2. patient

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

This MUST 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]/Immunization?patient=42

Return all Immunization resources for Patient with a logical id of 42

This SHOULD be supported for all 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]/Immunization?patient.identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210

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

2.1.3. status

See token for details on this parameter.

To filter on status ( completed | entered-in-error )

GET [baseUrl]/Immunization?patient=1&status=completed

Return all Immunization resources with a status of completed and Patient with a logical id of 1.

2.1.4. vaccination-procedure-code

See token for details on this parameter.

To search for Immunizations with a specific immunisation procedure code ofSeasonal influenza vaccination:

GET [baseUrl]/Immunization?patient=[id]&vaccination-procedure-code=http://snomed.info/sct|822851000000102

Return all Immunization resources with SNOMED CT code of 822851000000102 and Patient with a logical id of 1.

GET [baseUrl]/Immunization?patient=1&vaccination-procedure-code=822851000000102

Return all Immunization resources with code of 822851000000102 from any CodeSystem and Patient with a logical id of 1.

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 MUST 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.

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

3.1 cURL

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

3.2 Explore the Response

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