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
Capstmt
CapabilityStatement summary
Practitioner
Interactions
| Code | Documentation |
|---|
| read |
Used to retrieve a Practitioner resource by Id. |
| search-type |
|
Search Parameters
| Name | Type | Definition | Documentation |
|---|
| name |
string |
|
Not case sensitive |
| identifier |
token |
|
Will only return active identifiers |
| family |
string |
|
|
| given |
string |
|
|
| gender |
token |
|
|
| birthdate |
date |
http://hl7.org.nz/fhir/hpi/SearchParameter/HpiPractitionerBirthdate |
This is a custom search |
| ra-identifier |
token |
http://hl7.org.nz/fhir/hpi/SearchParameter/HpiPractitionerRaIdentifier |
This is a custom search. It queries on the identifier suplied by the Registartion Authority (Practitioner.qualification.identifier) |
PractitionerRole
Interactions
| Code | Documentation |
|---|
| read |
Used to retrieve a PractitionerRole resource by Id. |
| update |
|
| search-type |
|
Search Parameters
| Name | Type | Definition | Documentation |
|---|
| practitioner |
reference |
|
Given a Practitoner id, returns the PractitonerRoles associated with that id |
| organization |
reference |
|
Given a Organization id, returns the PractitonerRoles associated with that id |
| location |
token |
|
Given a Location id, returns the PractitonerRoles associated with that id |
| identifier |
token |
|
Returns PractitionerRoles based on identifier |
| role |
token |
|
Returns PractitionerRoles based on role |
Organization
Interactions
| Code | Documentation |
|---|
| read |
Used to retrieve an Organization resource by Id. |
| search-type |
|
Search Parameters
| Name | Type | Definition | Documentation |
|---|
| name |
string |
|
Will only return active organizations |
| identifier |
token |
|
The HPI Organization id. |
| partOf |
reference |
|
Locates Organizations that are 'part of' another. For example, [host]/Organization?partOf=cmdhb would return all Organizations
like hospitals that are part of the Organization with the id 'cmdhd' |
Location
Interactions
| Code | Documentation |
|---|
| search-type |
|
Search Parameters
| Name | Type | Definition | Documentation |
|---|
| identifier |
token |
|
Retrieve the Location with the identifier |
| name |
string |
|
Retrieve the Locations with the matching name |
| type |
token |
|
Retrieve Locations of the given type |
| address |
string |
|
Retrieve the Locations by address |
| organization |
reference |
|
Locations with the given ManagingOrganization |
| dhb |
token |
http://hl7.fhir.org/fhir/SearchParameter/dhb |
Locations that are in a DHBs catchment area. This is a custom search |