Integrations (API keys)

Integrations is a tab on the Birth Registry head, marked Beta. It gathers everything about how another system sends records into your registry: the API keys it signs in with, a log of the FHIR ingestions it has sent, and the developer resources its builders need. If you bring births in from a spreadsheet instead, you want Import births — no key is involved.

Who can open it

Integrations is for roles that can write records (Admin and Provider); the read-only Viewer doesn’t see the tab. Only a practice Admin can issue or revoke a key — a Provider sees the list of keys without those controls.

What “Beta” means here

Connecting an EHR or data partner through the Registry API is a limited-availability beta. If your practice is taking part, the tab opens with a Limited-availability beta notice above the tools described below. If it isn’t, the tab shows only the notice “Integrations are in a limited-availability beta” — contact support to join.

API keys

Each connected system gets its own API key — a per-source bearer token. One key per source means you can see what each system sent and cut one off without touching the others.

To issue a key (Admin):

Enter a Key name for the system it’s for — for example Epic EHR.
Choose its Scopes — what the key may do:
- Scribe — record births, read nothing — send records in.
- Read ingestion receipts — check the outcome of what was sent.
Both are on by default. Grant only what the system needs: the Scribe key (write only) button narrows the key to sending records.
Select Issue key. The full key appears once, under Copy your API key now — store it somewhere safe. It can’t be shown again, because only a fingerprint of it is kept; if it’s lost, revoke it and issue a new one.

The key list shows each key’s Name, Scopes, Issued by, Created, Last used, and Status (Active or Revoked). Revoke stops a key immediately — any system using it can no longer import records. The tab also shows the Import endpoint the system sends to.

FHIR ingestions

FHIR ingestions is a read-only log of the most recent records sent by your connected systems: when each was Received, its Reference, the Key that sent it, how many records Landed and how many were Rejected, and its Status (Queued, Processing, Completed, or Failed). Select a reference to copy it. The log shows counts only — no patient details. A developer reads the per-record outcomes from the ingestion status API using the reference.

Connected identities and developer resources

Connected identities — the link Manage provider identities on the Team page opens Team, where you manage the provider records that partner systems attribute births to.
Sandbox & developer resources — the OpenAPI spec for the ingestion API. A sandbox for safe test sends is marked coming soon.

For the technical side — authentication, sending records, and reading results — see the Registry API guide.

Privacy & data security — how keys protect your practice’s data.
Import births — bring births in from a spreadsheet.