Used to retrieve a Practitioner resource by Id HTTP Request 'GET' Scope required: practitioner:read / Practitioner.r

Queries against the Practitioner using name and other search parameters. Will return a Bundle (even if there are no matching resources) HTTP Request: 'GET' Scope required: practitioner:search / Practitioner.s

Creates a new Practitioner record HTTP Request 'POST' Scope required: practitioner:write / Practitioner.c

An operation that updates a health providers name, birthdate, death-date HTTP Request 'POST' Scope required: practitioner:write / Practitioner.u

For searching a Practitioner resource using their council/board registration number

Should contain the person’s full name, include all given names and family name.

Use with name and birthdate. Search by gender alone is not allowed.

Use with name and gender. Search by birthdate alone is not allowed.

Used to retrieve a PractitionerRole resource by Id. HTTP Request 'GET' Scope required: pracrole:read / PractitionerRole.r

Queries against PractitionerRole using hpi-person-id and other parameters. Will return a Bundle (even if there are no matching resources) HTTP Request 'GET' Scope required: pracrole:search / PractitionerRole.s

Create a new PractitionerRole HTTP Request 'POST' Scope required: pracrole:create / PractitionerRole.c

Update contact details and end date on an existing PractitionerRole record. HTTP Request 'PUT' Scope required: pracrole:write / PractitionerRole.u

Given an hpi-person-id, returns the PractitionerRole records associated with that id

Not yet enabled. Given an hpi-organization-id, returns the PractitionerRole records associated with that id

Given an hpi-facility-id, returns the PractitionerRole records associated with that id

Returns PractitionerRole records based on role code

To enable exclusion of inactive PractitionerRole records

Used to retrieve an Organization resource by Id. HTTP Request 'GET' Scope required: organization:read / Organization.r

Queries against the Organization using name or other parameters. Will return a Bundle (even if there are no matching resources). HTTP Request 'GET' Scope required: organization:search / Organization.s

To enable exclusion of inactive organizations

For searching using the organisation’s name or an alias name

For searching using an organisation’s New Zealand Business Number (NZBN) or their legacy NZHIS agency code.

For searching using an organisation's type E.g. DHB, RA, Educational institution

For retrieving organizations that are 'part of' another.

Used to retrieve an Location resource by Id. HTTP Request 'GET' Scope required: location:read / Location.r

Queries against the Location using name or other parameters. Will return a Bundle (even if there are no matching resources). HTTP Request 'GET' Scope required: location:search / Location.s

For searching using an organization’s legacy NZHIS facility code.

For searching using the Locations name or alias name

Retrieve Locations of the given type

Retrieve the Locations by address

Retrieve Locations with the given ManagingOrganization

Searching for Locations that are in a DHBs catchment area.

Not yet enabled. To enable exclusion of inactive locations

Search by EDI address