Web Service:PR-WS-2: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 5: Line 5:
  |url=/ws/rest/v1/professional/epid/query
  |url=/ws/rest/v1/professional/epid/query
  |params=The following query parameters are allowed:
  |params=The following query parameters are allowed:
*${size} The requested number of EIDs to return
*${size} The maximum number number of EPIDs to return
*${start} The starting offset for listing EIDs
*${start} The starting offset for listing EPIDs.
*${given_name} The professional’s given name.
*The following search possible parameters will be "and"ed together
*${family_name} The professional’s family name.
**${firstname} The provider's  given name.  
*${dob} The date of birth of the professional. This date can be partial, both the day and month may be left off if required. This should be specified in the following format:  dd/MM/yyyy.  Examples: 04/06/1986 or 06/1986 or 1986
**${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:
*{format}The response format.  One of:
**HL7
**HL7
**JSON
**JSON
${ws.size} the requested number of EIDs to return
  |example=?foasid=123&size=5&start=10
${ws.start} the starting offset for listing IDS
*${gender} The gender of the professional. ‘m’ or ‘f’ are valid arguments.
*${addr_province}  The province where the professional lives. See [Rwanda_Administrative_Structure_ISO_codes.ods] for codes to use with this parameter.
*${addr_district} The district where the professional lives. See Rwanda_Administrative_Structure_ISO_codes.ods for codes to use with this parameter.
*${addr_sector} The sector where the professional lives. See Rwanda_Administrative_Structure_ISO_codes.ods for codes to use with this parameter.
*${addr_village} The village where the professional lives. See Rwanda_Administrative_Structure_ISO_codes.ods for codes to use with this parameter.
*{addr_cell} The cell where the professional lives. See Rwanda_Administrative_Structure_ISO_codes.ods for codes to use with this parameter.
*{birth_country} The country that the professional was born in. The value of this parameter should be one of the standard list of ISO country codes.
*{tel_number} The professional’s telephone number (cell phone or land line).
*{edu_level} The education level of the professional. Valid values are
**0 = Pre-primary education
**1 = Primary education or first stage of basic education
**2 = Lower secondary or second stage of basic education
**3 = (Upper) secondary education
**4 = Post-secondary non-tertiary education
**5 = First stage of tertiary education
**6 = Second stage of tertiary education
${reg_body} The Registration Body of the professional. Valid values are
**1 = Physicians
**2 = Nurses
**3 = Not applicable
${reg_status} The Registration Status of the professional.  Valid values are:
**1 = Active / full registration
**2 = Limited registration
**3 = Student registration
**4 = Suspended registration
**5 = Terminated registration
**6 = Nullified
**7 = Pending
**8 = Inactive registration
${occ_group} The Occupation Group of the professional.  See RwandaHCFacilitiesHCProfessionalRegistriesv1.7July18_pilot_final.docx - Annex 2 for the codes to use with this parameter.
${occ_code} The Occupation Code of the professional.See RwandaHCFacilitiesHCProfessionalRegistriesv1.7July18_pilot_final.docx - Annex 2 for the codes to use with this parameter.
${hours_per_week} Number of hours per week worked by the professional.
${hours_per_week_gt} The parameter with the ‘_gt’ suffix is used for queries for hour per week greater than the given value.
${hours_per_week_lt} The parameter with the ‘_lt’ suffix is used for queries for hour per week less than the given value.
  |example=?gender=m&reg_body=2
  |response=HTTP 200 - OK
  |response=HTTP 200 - OK
The HTTP response body will contain a list of matching EIDSs as specified by the ${format} parameter:
The HTTP response body will contain a list of matching EIDSs as specified by the ${format} parameter:

Revision as of 12:51, 30 October 2012

Web Service: PR-WS-2 Query For Providers

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
  • ${start} The starting offset for listing EPIDs.
  • 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
    • JSON
GET Response HTTP 200 - OK

The HTTP response body will contain a list of matching EIDSs as specified by the ${format} parameter:

  • ${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:
  • The RSS XML will contain a list of HL7 message in each item element. See QueryProfessionalRSS.xml
  • The HL7 v2.5 PMU_B01 messages for each professional will be specified as in Register-or-Query-Professional
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

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Web_Service:PR-WS-2&oldid=46621"