Web Service:PR-WS-2

{{WebServicePage|Query For Providers

|number=PR-WS-2 |description=Fetches a HC Professional Enterprise ID for the professional specified by the professional ID parameter. |applications=Interoperability Layer, Point-Of-Care? |url=/ws/rest/v2/query/providers |params=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’.

|example=?foasid=123&size=2&start=10 |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:

{
providers: {
211312: {

providerDetails : ‘http://rhea-pr.ihris.org/webservices/details/provider?epid=211312’, editProvider : ‘http://rhea-pr.ihris.org/webservices/edit/provider?epid=211312’, addPost : ‘http://rhea-pr.ihris.org/webservices/add/post?epid=211312’, queryPosts : ‘http://rhea-pr.ihris.org/webservices/details/post?epid=211312’, viewProvider : ‘http://rhea-pr.ihris.org/providerregistry/view?id=person%7C23123123

}, 131241241: {

},

}, 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:

|error=*HTTP 500 - Server Error - If the server encountered an error.

  • HTTP 400 - Bad Request - If the parameters are malformed.

|notes=Need to good way for limiting response length. See A collection: the list of bugs in the Launchpad API |resources=[[Use Case:PR-WS-2]]

}}