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

Create Entitlement

Create Entitlement for Patient

This operation is used to create a patient’s entitlement to some form of subsidised healthcare.

Current functionality is limited to creating a Community Services Card entitlement.

Scenarios

1. A person presents with a community services card, however the card is not returned when searching for the patients entitlements.
2. A dependent child of a community services card holder presents, and a community services card is not returned when searching for the patients entitlements.

Create Entitlement processing steps:

1. The user inputs CSC details to create the Entitlement.
2. The integrating application sends a POST request to the NES Coverage endpoint with a payload containing the NesEntitlement resource to be created, excluding ids.
3. The request is validated - ALT: Validation failure. Operation Outcome resource returned
4. The Entitlement is created in the database and an ID is assigned.
5. A newly created NesEntitlement, including its ID, is returned to the client

Create Entitlement Request Example

create CSC Entitlement request

Create Entitlement Rules and Errors

For Request rules and errors click here

Rule	Error code	Error description	Error text	Http code
A Create Entitlement request must include: type of entitlement beneficiary (NHI number of the patient) identifier (the entitlement card number) contained Patient resource organisation approving the entitlement (payor)	EM07201 EM07201 EM07201 EM07201 EM07201	Is a required field Is a required field Is a required field Is a required field Is a required field	type is a required field beneficiary is a required field identifier is a required field contained patient is a required field payor is a required field	400 Bad request 400 Bad request 400 Bad request 400 Bad request 400 Bad request
The contained patient must match Entitlement beneficiary and validate with the National Health Index	EM02008	The patient identity information supplied does not match the patient identity information in the NHI.	The patient identity information supplied does not match the patient identity information in the NHI.	400 Bad request
A request to create an entitlement can be made against any valid NHI Identifier (live or dormant) for that patient.	EM02002	Cannot be found.	NHI number supplied cannot be found.	400 Bad request
A Create Patient entitlement request must include a valid CSC Card Number.	EM12006	The CSC Card Number must be known to Te Whatu Ora.	The CSC Card Number must be known to Te Whatu Ora.	400 Bad request
A Patient can only be linked to 1 active Entitlement type i.e. CSC or CSCDependent.	EM12001	The patient cannot have both CSC and CSCDependent Entitlements active at the same time.	The patient cannot have both CSC and CSCDependent Entitlements active at the same time.	400 Bad request
A Patient can have a maximum of one Active CSC Entitlement.	EM12002	The patient cannot have more than one active CSC Entitlement.	The patient cannot have more than one active CSC Entitlement.	400 Bad request
A CSC Entitlement can only be associated to one (non-dependent) Patient.	EM12003	The CSC Entitlement is already assigned to another patient.	The CSC Entitlement is already assigned to another patient.	400 Bad request
A patient can have multiple CSC dependent entitlements.
A CSC Dependent entitlement can only be created for a person 18 or younger.	EM12016	The patient is not a valid age to be a CSC Dependent.	The patient is not a valid age to be a CSC Dependent.	400 Bad request