HPD Retrieval API icon

HPD Retrieval API

1.0.x
(0 reviews)

Regional Health Provider Directory (HPD) is the single source of truth for registered health professional data for use in digital ordering, on-boarding, and reporting processes. It curates Registration data from the MoH Health Professional Index (HPI), Employment data from Northern Region District HR systems and Awanui GP and Practice data. The HPD Retrieval API provides consumer systems the ability to retrieve one or more Practitioner, PractitionerRole, Location, and Organization resources using different search criteria and receive the data in JSON, FHIR-like or FHIR-like Bundle message format.

HPD Retrieval API provides the following operations:

  1. HTTP GET /api/hpdentity/v1/{{ENTITY_TYPE}}/{{ID}}/{{RETURN_TYPE}}

    This API operation allows the consumer to retrieve a record from any one of these entities - Organization, Location, Practitioner or PractitionerRole, using HPI ID, HPD GUID or HPD ID.

  2. POST /api/{{PATH_NAME}}/v1/{{SLUG_NAME}}

    This API operation allows the consumer to search one or more entity records using input slug name and one or more query objects.

Reviews