New Zealand MWS IG
1.1.5 - Release

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

## Search Co Payment Count

### Get Year-to-date Co-payments for Whanau

#### Overview

Get the count of co-payments for the given NHIs in the PSC year-to-date

#### Get Year-to-date Co-payments for Whanau processing steps:

1. The pharmacist supplies the list of NHIs which constitute the family unit and the integrating application sends an HTTP GET request for the count of co-payments for the given NHIs over the PSC year-to-date
2. The request is validated - ALT: Validation failure. Operation Outcome resource returned
3. Any dormant NHIs associated with the input NHIs are added to the list - ALT: NHI not found. Operation Outcome resource returned
4. The count of co-payments for the list of NHIs over the PSC year to date is returned from the claims system
5. The response containing the count of co-payments is returned.

#### Get Year-to-date Co-payments for Whanau Response Example

​search co-payment response

#### Get Year-to-date Co-payments for Whanau - Business Rules and Errors

Business Rule | HTTP error | EM error | Codesystem displayname | Additional description
--- | --- | --- | --- | ---
NHI number is a required search parameter | 400 Bad request |  |  | Not supported. The FHIR endpoint on this server does not know how to handle GET operation with parameters [category]
the NHI number parameter must exist in NHI | 404 Not found | EM02002 | Cannot be found | The NHI id cannot be found
No more than 20 NHIs may be provided | 400 Bad request | EM07243 | Parameter cardinality rules not met | Max of 20 NHIs may be provided
copayment_ytd parameter must be true | 400 Bad request | EM07201 | Missing a required field | copayment_ytd parameter must be true