Zedmed List providers

POSThttps://preview.ontross.com/api/integrations/zedmed/list-providers

input.clinic_code

string

Optional clinic/site code to restrict providers.

Example

"DEMO_CLINIC"

input.family_name_prefix

string

Optional family-name prefix.

Example

"Benn"

input.given_name_prefix

string

Optional given-name prefix.

Example

"Alex"

input.limit

integer

Maximum providers to return. Defaults to 100; maximum 500.

Example

100

Default

100

auth_id

string

required

Saved connection to run this operation through, from the Authentication page. It decides which practice and login the call uses.

Example

"00000000-0000-4000-8000-000000000000"

providers

array

Active treating doctors, skipping surgeon-only and assist-only entries.

providers[].doctor_code

string

Treating physician lookup value usable in subsequent requests.

Example

"DEMO_DOC"

providers[].name

string

Doctor's full display name from the treating doctor record.

Example

"Dr Alex Bennett"

providers[].family_name

string

Surname of the patient or doctor being returned.

Example

"Bennett"

providers[].given_name

string

First name of the patient or doctor being returned.

Example

"Alex"

providers[].title

string

Salutation such as Dr or Mrs.

Example

"Dr"

providers[].clinic_codes

array

Every clinic code this doctor is rostered at.

curl --request POST \
  --url https://preview.ontross.com/api/integrations/zedmed/list-providers \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"clinic_code":"DEMO_CLINIC","family_name_prefix":"Benn","given_name_prefix":"Alex","limit":100},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "clinic_code": "DEMO_CLINIC",
    "family_name_prefix": "Benn",
    "given_name_prefix": "Alex",
    "limit": 100
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "providers": [
      {
        "doctor_code": "DEMO_DOC",
        "name": "Dr Alex Bennett",
        "family_name": "Bennett",
        "given_name": "Alex",
        "title": "Dr",
        "clinic_codes": [
          "string"
        ]
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}