Skip to Content
Skip to content

Registry API

Other systems resolve facilities through the registry's FHIR R5 API, which follows the IHE mobile Care Services Discovery (mCSD) profile. Reading is open: no account or key is needed.

Read and search

Each facility is two resources with the same id, its UUID: a Location (the place) and an Organization (the body that runs it).

RequestReturns
GET /fhir/metadataCapabilityStatement
GET /fhir/Location/{uuid}One facility as a place
GET /fhir/Organization/{uuid}One facility as an operating body
GET /fhir/Location?name=…&address-state=…Search; up to 100 per page
GET /fhir/Location/_history?_since=…Everything changed since a time (mCSD update feed)
GET /fhir/HealthcareService?location=Location/{uuid}Services offered at a facility
GET /fhir/CodeSystem/zhfr-facility-typeFacility type codes

Search parameters

_id, identifier, name, type, status (active or inactive), address-state, partof, _lastUpdated, _count, _offset.

Examples

curl https://zhfr.moh.gov.zm/fhir/Location/21688d9f-0b26-41bb-932a-47f177a4b4d6
curl "https://zhfr.moh.gov.zm/fhir/Location?identifier=http://hapi.moh.gov.zm/fhir/sid/facility-master-code|1000"
curl "https://zhfr.moh.gov.zm/fhir/Location?type=https://zhfr.moh.gov.zm/facility-type|health-centre&address-state=Lusaka"
curl "https://zhfr.moh.gov.zm/fhir/Location/_history?_since=2026-10-01T00:00:00Z"

Keep a local copy current by polling _history with the time of your last successful poll, instead of downloading everything each night.

Identifiers

IdentifierSystemExample
MFL codehttp://hapi.moh.gov.zm/fhir/sid/facility-master-code1000
ZHFR IDhttps://zhfr.moh.gov.zm/facility-idZHFR-01000-8
UUIDurn:ietf:rfc:3986urn:uuid:21688d9f-0b26-41bb-932a-47f177a4b4d6
DHIS2 org unithttps://dhis2.moh.gov.zm/uid

Store the UUID or the MFL code, never a name: names change and repeat.

Contributing data

Private facility operators and professional councils can submit through the contribution API (POST /zhfr/contribute/Organization, /Location, /Bundle, /licence). A submission returns 202 Accepted: it is queued for a curator, not published. Access needs a Keycloak client or API key issued by the Ministry of Health.

Systems that keep a copy of the registry can also be registered for change notifications (FHIR R5 subscription-notification bundles).

Try it

Bulk data

The directory's CSV button downloads exactly the facilities a search finds.