healthcare
practitioner

List all practitioners

get/healthcare/{connection_id}/practitioner

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/healthcare/{connection_id}/practitioner
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring date-time

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sort'name' | 'updated_at' | 'created_at'
order'asc' | 'desc'
querystring

Query string to search. eg. email address or name

location_idstring

The location ID to filter by

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring

Unique identifier for the practitioner

created_atstring date-time

When the practitioner record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

When the practitioner record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

Full name of the practitioner

first_namestring

Given name of the practitioner

last_namestring

Family name of the practitioner

titlestring

Professional title or prefix (e.g. Dr.)

gender'MALE' | 'FEMALE' | 'OTHER' | 'UNKNOWN'

Administrative gender of the practitioner

image_urlstring

Photo of the practitioner

languagesstring[]

Language codes the practitioner can communicate in

location_idsstring[]

Locations where the practitioner provides care

is_activeboolean

Whether the practitioner record is in active use

rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.