Zedmed Get provider

POSThttps://preview.ontross.com/api/integrations/zedmed/get-provider

input.doctor_code

string

required

Zedmed treating-doctor code.

Example

"DEMO_DOC"

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"

provider

object

The doctor's record, null when the code matches nothing.

provider.doctor_code

string

Treating physician lookup value usable in subsequent requests.

Example

"DEMO_DOC"

provider.name

string

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

Example

"Dr Alex Bennett"

provider.family_name

string

Surname of the patient or doctor being returned.

Example

"Bennett"

provider.given_name

string

First name of the patient or doctor being returned.

Example

"Alex"

provider.title

string

Salutation such as Dr or Mrs.

Example

"Dr"

provider.clinic_codes

array

Every clinic code this doctor is rostered at.

clinics

array

Active clinics, or only those the doctor attends.

clinics[].clinic_code

string

Site lookup value usable in subsequent requests.

Example

"DEMO_CLINIC"

clinics[].clinic_name

string

Readable name of the clinic behind the code.

Example

"Demo Family Practice"

clinics[].file_numbering

string

Which numbering scheme the clinic uses for patient files.

Example

"A"

clinics[].default_account_holder

string

Who the clinic bills by default for new patients.

Example

"P"

clinics[].default_preferred_contact_method

string

How the clinic contacts new patients by default.

Example

"SMS"

curl --request POST \
  --url https://preview.ontross.com/api/integrations/zedmed/get-provider \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"doctor_code":"DEMO_DOC"},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "doctor_code": "DEMO_DOC"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "provider": {
      "doctor_code": "DEMO_DOC",
      "name": "Dr Alex Bennett",
      "family_name": "Bennett",
      "given_name": "Alex",
      "title": "Dr",
      "clinic_codes": [
        "string"
      ]
    },
    "clinics": [
      {
        "clinic_code": "DEMO_CLINIC",
        "clinic_name": "Demo Family Practice",
        "file_numbering": "A",
        "default_account_holder": "P",
        "default_preferred_contact_method": "SMS"
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}