Fetches a HC Professional Enterprise ID for the professional specified by the professional ID parameter.
| URL |
/ws/rest/v1/professional/epid/query |
| GET Parameters |
The following query parameters are allowed:
- ${size} The maximum number number of EPIDs to return. Defaults to 50.
- ${start} The starting offset for listing EPIDs. Defaults to 10.
- The following search possible parameters will be "and"ed together
- ${firstname} The provider's given name.
- ${surname} The professional’s family name.
- ${fosaid} The FOSAID for the facility a provider is posted to.
- ${location} The code for the organizational unit under which the provider is posted.
- ${category} The category (or cadre) of the provider.
- ${type} The type of the provider 'PPS' for paid-public sector or 'CHW' for community health worker.
- {format}The response format. One of 'hl7' or 'json'.
|
| GET Response |
HTTP 200 - OK
The HTTP response body will contain a list of matching EIDSs as specified by the ${format} parameter:
- If ${format}=json. Example:
{
"epids": {211312,131241241,12398213,12312,123}
"total_size" : 300,
"start": 10
}
- ${format}=hl7. one per professional that matches the criteria, that contains the details of that professional. These messages will be contained within a RSS feed XML message. HL7v2 message specification and mapping:
|
| GET Error |
- HTTP 500 - Server Error - If the server encountered an error.
- HTTP 400 - Bad Request - If the parameters are malformed.
|
| GET Example |
/ws/rest/v1/professional/epid/query/?foasid=123&size=5&start=10 |
| Notes |
Need to good way for limiting response length. See A collection: the list of bugs in the Launchpad API |
Other Resources: Use Case:PR-WS-2
