CareConnect Immunizations FHIR STU3 retreival format included on a pointer denotes that the provider supports the CareConnect Immunization FHIR STU3 - Search capability at the URL endpoint included in the pointer.
In alignment with national stratergy, providers should be aiming to implement a complete implementation of the CareConnect API, but this page outlines the minimum conformance to the standard required for endpoints which will be included within NRL pointers to immunization data.
In the NRL pointer, the retrieval format code for this structure is as follows:
|https://fhir.nhs.uk/STU3/CodeSystem/NRL-FormatCode-1||urn:nhs-ic:fhir:stu3:careconnect-immunizations-fhir-stu3||CareConnect Immunizations FHIR STU3|
Endpoint and Search Parameters
The HL7 FHIR Search specification details the use of chaining search parameters to retrive resources, including allowing for parameters which request the inclusion of resources that reference another specific resource. This allows a consumer to retrieve all or part of the information a provider holds.
The URL incuded in the pointer MUST be to the Immunization endpoint on the server, and MUST include the patient identifier parameter.
The consumer MAY add other chained search paramters to the request.
The Provider endpoint MUST support the following search parameters, which the consumer can include in their request as part of a chained search.
The provider must support the
Where referenced resources are not supported by the
A consumer should consider the following, when implementing a consumer for a CareConnect API endpoint:
- A consumer MUST not assume all referenced resources are supported by the
_includeparameter so SHOULD be able to make seperate calls to retrieve referenced resources, within the response from the provider
Retrieval Authentication and Authorization
CareConnect Immunizations FHIR STU3 retrieval format endpoints MUST support the SSP Read retrieval interaction.
All Immunizations For A Patient - referenced resources NOT include
All Immunizations For A Patient - referenced resources INCLUDED