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:
${ws.size} the requested number of EIDs to return
${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. |
| GET Response |
HTTP 200 - OK
The HTTP response body will contain a list of matching EIDSs as specified by the ${format} parameter:
{
"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.
|
| 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/?gender=m®_body=2 |
| 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
