New Zealand NES IG
1.4.7-snapshot - Release

New Zealand NES IG - Local Development build (v1.4.7-snapshot) 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 all active entitlements, end-dated entitlements will not be returned.

A person may have:

  • one CSC entitlement.
  • multiple CSC-dependent entitlements, if they are a dependent child and parents with a CSC each, or are part of multiple family units (Note: Cannot also have a CSC entitlement).
  • multiple PSC entitlements (one for each family unit they belong to (if that family unit is eligible).
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)