New Zealand NES IG - Local Development build (v1.4.6) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Search Entitlement
Search Entitlements
Overview
This operation is used to return all entitlements for a person. The Entitlement service will return one entitlement record of each type (if applicable). This will be the active entitlement, or the last end-dated entitlement where no active entitlement exits.
Get Entitlements for Patient processing steps:
The user requests a a persons entitlements using an NHI number.
The integrating application sends a GET request to the NES Coverage endpoint with the 'beneficiary' query parameter specifying the patient's NHI number.
The request is validated - ALT: Validation failure. Operation Outcome resource returned.
The entitlements is retrieved from the database.
A bundle of NESEntitlements is returned to the client.
Search Entitlement Response Example
For a search entitlement response example click here