New Zealand HPI Implementation Guide
0.9.0 - CI Build
New Zealand HPI Implementation Guide, published by Ministry of Health. This is not an authorized publication; it is the continuous build for version 0.9.0). This version is based on the current content of https://github.com/HL7NZ/hpi/ and changes regularly. See the Directory of published versions
This is the computable resource that describes the RESTful endpoint
Practitioner query
| Code | Documentation |
|---|---|
| read | Used to retrieve a Practitioner resource by Id. |
| search-type | Queries against the resource type. Will return a Bundle (even if there are no matching resources). |
| Name | Type | Documentation |
|---|---|---|
| identifier | token | |
| name | string | Not case sensitive |
| family | string | |
| given | string | |
| gender | token | |
| birthdate | date | Supports a search on practitioner birthdate |
PractitionerRole query
| Code | Documentation |
|---|---|
| read | Used to retrieve a PractitionerRole resource by Id. |
| search-type | Queries against the resource type. Will return a Bundle (even if there are no matching resources). |
| create | Create a new PractitionerRole |
| update | Update an existing PractitionerRole |
| Name | Type | Documentation |
|---|---|---|
| practitioner | reference | Given a Practitioner id, returns the PractitionerRoles associated with that id |
| organization | reference | Given a Organization id, returns the PractitionerRoles associated with that id |
| location | token | Given a Location id, returns the PractitionerRoles associated with that id |
| identifier | token | Returns PractitionerRoles based on identifier |
| role | token | Returns PractitionerRoles based on role |
| active | token | To enable exclusion of inactive PractitionerRoles |
| Name |
|---|
| practitioner |
| organization |
| location |
Organization query
| Code | Documentation |
|---|---|
| read | Used to retrieve an Organization resource by Id. |
| search-type | Queries against the resource type. Will return a Bundle (even if there are no matching resources). |
| Name | Type | Documentation |
|---|---|---|
| active | token | To enable exclusion of inactive organizations |
| name | string | Will only return active organizations |
| identifier | token | The HPI Organization id or the New Zealand Business Number (NZBN). |
| partOf | reference | Locates Organizations that are 'part of' another. |
Location query
| Code | Documentation |
|---|---|
| search-type | Queries against the resource type. Will return a Bundle (even if there are no matching resources). |
| Name | Type | Documentation |
|---|---|---|
| identifier | token | Retrieve the Location with the identifier |
| name | string | Retrieve the Locations with the matching name or alias |
| type | token | Retrieve Locations of the given type |
| address | string | Retrieve the Locations by address |
| organization | reference | Locations with the given ManagingOrganization |
| dhb | token | Locations that are in a DHBs catchment area. This is a custom search |
| status | token | The current status of the Location |