Skip to main content
The provider directory lists the clinicians at a clinic who can write notes. Use it to show a patient who they will see, to match a clinician in your system to one in ClinikEHR, or to find the clinician_id to send when a clinician is asked for. It is read-only. No request can add a provider, change one, or change a credential: the clinic manages its team in ClinikEHR. A provider carries no patient information, so providers:read is not a patient-data permission: the add-on, the agreement and the organization’s data approval are not needed. See Permissions. A provider that does not exist, belongs to another clinic, is not a clinician, or whose membership has expired returns 404 with code: "not_found". The cases are never told apart. See Errors.

​
Who is listed

A member of staff is listed when the clinic gives them a clinical role (a doctor, nurse or other clinician who can write notes) and their membership has not expired. Reception, billing, accounting, cashier and similar roles are not listed. A clinic owner who has no staff record is not listed. A provider’s id is the same id the clinician pickers in ClinikEHR use, so it can be sent as clinician_id wherever a clinician is asked for.

​
What a provider looks like

A licence is shown as recorded, including one whose date has passed. Read expires_on before you rely on it.

​
What is never returned

  • Email address, phone number and home address.
  • DEA registration numbers.
  • Anything about how the clinician signs in, who supervises them, or what they are allowed to do in ClinikEHR.
  • Whether a licence or NPI has been verified. The directory says what is on file, not that it was checked.

​
List providers

Each read is recorded in the clinic’s audit trail, as every read of clinic data is.

​
As FHIR

Send Accept: application/fhir+json and a list becomes a Bundle of Practitioner, a single read a bare Practitioner. The NPI is an identifier, each licence a qualification, and the role, title, department and specialties ride as extensions. See FHIR. PractitionerRole is not available yet.

​
Test keys

A test key sees three fictional providers, named SANDBOX …, with obviously fictional NPIs and licences. It never sees a real clinic’s team.

​
Outside clinicians are a different resource

A patient’s own doctor, referrer or specialist is not a member of the clinic’s team. Those contacts are in Outside care providers.