All about the common foundation capabilities.
Back to Visitors and Migrants - Introduction.
Purpose
The foundations capability cover the basic API requirements and prerequisites to utilise the Visitors and Migrants API.
Important: In order to successfully make use of the Visitors and Migrants API, initially a level of pre-existing accredited Spine connectivity will be required along with some FHIR foundation API capabilities.
Roadmap: Over time the necessity to have access to pre-existing spine services (i.e. PDS and SDS integration) is likely to be replaced by FHIR based equivalents.
Prerequisites
PDS
You’ll need to be able to provide a verified NHS Number to use an API. This can be achieved using a spine accredited system, a DBs batch-traced record (CSV), or using a Spine Mini Services Provider (HL7v3).
FHIR
In order to be a compliant FHIR server, provider systems need to expose a valid FHIR Conformance profile.
Please also refer to Development Guidance - FHIR API Guidance - Common API Guidance for full details on the common FHIR API patterns.
