This API is an HL7 V3 API and uses:
- synchronous interactions, using HL7 V3 SOAP web services
- asynchronous interactions, using HL7 V3 ebXML messaging
The asynchronous pattern is used for interactions which either do not require an immediate response or might take longer, for example:
- prescribing system is informed of the final outcome of the cancellation request
- this is currently delivered by Spine to an MHS Endpoint and could be minutes, hours or days from the initial cancellation request
For more details, see HL7 V3.
Message Handling System (MHS) adaptor
To remove the complexity of building your own Message Handling System, we offer a pre-assured, client side MHS adaptor that you can integrate into your own infrastructure.
It makes it easier to connect to the NHS Spine and perform business operations by exposing a RESTful API that conforms to the HL7 V3 standard.
Security and authorisation
This API is user-restricted, meaning that an end user must be present and authenticated to use it.
The end user must be:
We support the following security patterns:
- user-restricted HL7 V3 API, using NHS Care Identity Service 2 (NHS CIS2)
- user-restricted HL7 V3 API, using CIS
For more details see user-restricted APIs.
For some activities, the end user must be authorised to perform that activity.
The API itself does not perform any authorisation checks. Rather, the calling system is expected to perform them. The authorisation rules are specified in our national Role Based Access Control (RBAC) database.
For more details see our national Role Based Access Control (RBAC) database on the registration authorities and smartcards page.
For a full list of interactions for this API, see the Medication Management v2.3.1 section in the Spine Message Implementation Manual (MIM) version 4.2.00.
Note that only the following interaction IDs are supported - the others were not implemented.
||Parent Prescription (Non-Urgent)
||Patient Prescription Release Request
||Patient Prescription Release Response
||Nominated Prescription Release Request
||Nominated Prescription Release Response
||Prescription Release Rejection
||Dispense Proposal Return
||Subsequent Cancel Response
||Dispense Claim Information
||Dispense Reimbursement Claim
||Dispense No Claim Notification
||Rebuild Dispense History
For details on the general structure of the interactions, see HL7 V3.
Before you begin any development work using this API, contact us to discuss your best options.
Last edited: 3 May 2023 12:53 pm