...
Parameter | Option Value | Default Option | Description |
|---|---|---|---|
paging | boolean | true | Defines if pagination is required |
page | number | 1 | Defines which page number to return. |
pageSize | number | 10 | Defines the total PageSize for the response |
distance | number | 10 | Defines radius within which you need to generate the organization Units |
unit | m | km | mi | km | Define the unit for the distance |
level | number | 7 | Defines hierarchy level of the orgUnit |
phoneNumber | text (phone Number) | N/A | DHIS2 core element | Defines the phone number of the location |
DHIS2 custom ou attribute | |||
type | text | Defines the type of the location. | |
tags | text (csv) | N/A | Defines the tags the locations are associated with. |
services | text (csv) | N/A | Defines the services offered by the locations. |
area | text | N/A | Defines the area where the locations is located. |
subArea | text | N/A | Defines the subArea where the locations is located. |
text (phone Number) | N/A | Defines the whatsapp number of the location | |
text | url | N/A | Defines the fb url for the location | |
responseFhir | boolean | No | Defines if the response would be in FHIR or DHIS2 format |
URL (for GET request):
https://{{host}}/api/v2/locator?paging=false&coordinates=lat,lng&distance=5&unit=km
...
| Code Block | ||
|---|---|---|
| ||
{
"paging": true,
"page": 1,
"pageSize": 10,
"ancestor": {
"id": "a23acb2452xyz",
"code": "KE"
},
"organisationunit": {
"id", "q13we2452wsd",
"shortName": "Sub Hospital"
},
"coordinates": lat,lng,
"points": [lat,lng],
"distance": 5,
"unit": "km",
"level": 7,
"phoneNumber": "180999093107",
"area": "Managua",
"subArea": "Ciudad Sandino",
"type": "Public",
"tags": "tag1,tag2",
"services": "service1,service2",
"whatsapp": "977984123145",
"facebook": "https://fb.me/facility1",
"latitude": lat,
"longitude": lon,
"responseFhir": false
} |
Response (In DHIS2):
| Code Block | ||
|---|---|---|
| ||
{
"pager": {...}
"organisationUnits": [
{
"id": "xkcEJARvo2O",
"parentId": "15561086",
"code": "KE-CODE-123",
"name": "Facility Clinic (KE-CODE-123)",
"shortName": "Facility Clinic",
"description": null,
"openingDate": "2023-02-11",
"closedDate": null,
"comment": null,
"url": null,
"contactPerson": null,
"address": "street1, city, subarea, area",
"email": "mymail@gmail.com",
"phoneNumber": "+254541483334",
"path": "",
"level": "7",
"area": "Nairobi",
"subArea": "Starehe",
"latitude": "-1.28575",
"longitude": "39.81234",
"geometry": "{\"type\":\"Point\",\"coordinates\":[39.81234,-1.28575]}",
"distance": 0.0,
"openingHours": "Mon-Fri,8:00,17:00;Sat,9:00,14:00;Public Holiday,9:00,14:00;Sun,Closed",
"services": "CCS,CNT,ANC,STI,HVS,HVT",
"locationType": "OUT",
"type": "Public",
"tags": "KEUNV",
"fb": null,
"whatsapp": null,
"showContactInfo": "TLF"
}
]
} |
Note: The attributes sequence might be different from the sequence listed above.
Response (in FHIR):
| Code Block | ||
|---|---|---|
| ||
{ "pager": { "page": 1, "pageCount": 1, "total": 1, "pageSize": 1, "first": true, "last": true }, "locations": [ { "resourceType": "Location", "id": "d5AeP1W7nT", "identifier": [ { "system": "http://www.acme.org/identifiers/location", "value": "US-FH-1235" }, { "system": "http://www.acme.org/identifiers/location", "value": "/s7JFm0K2cN/8xqYb6V3gL/i4hDz9R1mE/a2XpM3G6rC/c9NlB7P8jY/u3RcT5L9vH/d5AeP1W7nT" } ], "name": "Riverside General Hospital (US-FH-1235)", "alias": [ "Riverside General Hospital" ], "description": null, "status": "active", "mode": "instance", "address": { "street1": "123 Main Street", "street2": null, "city": "Any City", "state": "NY", "postalCode": 12345, "country": "United State" }, "contact": { "telecom": [ { "system": "phone", "value": "+14722240000", "use": null } ] }, "position": { "longitude": 30.7983, "latitude": -10.25 }, "hoursOfOperation": "Mon-Fri,8:00,17:00", "healthCareServices": "COV,STI" } } ] } |