API Technical Details
Authentication
The API uses Bearer authentication and the access token is obtain via Client Credentials grant.
URLs & Endpoints
Authentication & Base URLs
Authentication and Base URLs will be provided as part of the Onboarding process.
Endpoint
| Operation | Endpoint | Description |
|---|---|---|
| GET | /immunization | Retrieves Covid-19 Immunisation details from the Covid Immunisation Register (CIR) database for the NHI specified in the request. |
High Level View
Insert High Level Overview Diagram here
Technical Details
GET
Click here for technical details and examples for GET implementation
Security Requirements
What security requirements do the vendors need to fulfil? Or what security details do we need to convey to the vendors?
Technical Requirements
What technical requirements do vendors need to fulfil? Or what technical details do we need to convey to the vendors?
| NOTE: NHI needs to be passed to be able to request a patient's Covid-19 Immunisation records. This can be done by implementing Digital Identity for Health, details of which can be found here. Add the link to DI page |