New Zealand NES IG
1.4.0-SNAPSHOT - Release

New Zealand NES IG - Local Development build (v1.4.0-SNAPSHOT) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Search Entitlement

Search Entitlements


This is typically used to return all entitlements for a person.
The Entitlement service will return one Entitlement for each type. This will be the active entitlement if there is one, or the last end-dated entitlement.

Search EntitlementsIntegrating application userIntegrating application userIntegrating applicationIntegrating application<FHIR API> NES Entitlement<FHIR API> NES EntitlementDBDBLook up personsentitlements using their NHInumberGET[base]/Coverage?beneficiary=[NHInumber]Validate[]RequestReturn Bundle containingpersons EntitlementrecordsDisplay Entitlement details

Get Entitlements for Patient processing steps:

  1. The user requests a a persons entitlements using an NHI number.
  2. The integrating application sends a GET request to the NES Coverage endpoint with the ‘beneficiary’ query parameter specifying the patient’s NHI number.
  3. The request is validated - ALT: Validation failure. Operation Outcome resource returned.
  4. The entitlements is retrieved from the database.
  5. A bundle of NESEntitlements is returned to the client.

Search Entitlement Response Example

For a search entitlement response example click here

Search Entitlement Rules and Errors

For Request rules and errors click here
Rule Error code Error description Error text Http code
A search entitlement must include an NHI at minimum (Coverage.beneficiary)