Skip to main content

Registries

UHI touches four registries, and only one of them belongs to UHI. After this page you will know which identifier goes in which field, and which ones onboarding asks you for.

RegistryIdentifiesWhere it appears in UHI
Network registryA subscriber on the UHI network: an EUA, an HSPA or the gatewayPOST /api/v1/networkregistry/lookup, to fetch a counterparty's public key before a signed point to point call
ABHAThe patientorder.customer.id, and the person ids in chat
HPRThe practitionerfulfillment.agent.id, and an hpr_id tag
HFRThe facility or storeAn hfr_id tag on a fulfillment

The network registry is UHI's ownโ€‹

The other three are ABDM registries that UHI quotes. The network registry is UHI's, and it holds something the others do not: the public key each subscriber registered at onboarding. Both sides of a signed call look the counterparty up in it. UHI gateway has the lookup and the signing.

Onboarding does not ask for the other threeโ€‹

The onboarding form asks for your organisation details, your role, your callback URL and your public key. It does not ask for an HPR ID or an HFR entry, and no UHI document in this portal makes either a condition of joining the network.

They arrive by the back door instead. Your application must have completed M2 with HIE-CM before it can be onboarded to any UHI service, and that route does require a facility in the HFR and a professional in the HPR. See Onboarding for the gate, and HIE-CM's registries for what M4 writes into them.

What UHI never doesโ€‹

UHI creates no registry entry. It issues no ABHA number, registers no professional and enrols no facility. Every identifier in a UHI message was written by a milestone on HIE-CM and is being quoted here, which is why a wrong one fails at the far end rather than at the gateway.