Zedmed Search patients

POSThttps://preview.ontross.com/api/integrations/zedmed/search-patients

input.date_of_birth

string

Date of birth in ISO 8601 format: YYYY-MM-DD.

Example

"1994-01-14"

input.phone

string

Full patient phone number. Spaces, parentheses, hyphens, and + are accepted.

Example

"+61 491 570 006"

input.limit

integer

Maximum number of matching patients to return. Defaults to 50; maximum 100.

Example

50

Default

50

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"

patients

array

Patients matching your date of birth or phone search.

patients[].patient_id

integer

Numeric record key for subsequent patient lookups.

Example

900000001

patients[].given_name

string

First name of the patient or doctor being returned.

Example

"Alex"

patients[].family_name

string

Surname of the patient or doctor being returned.

Example

"Bennett"

patients[].popular_name

string

The name the patient actually goes by.

Example

"Al"

patients[].date_of_birth

string

Patient's birth value returned unchanged by the gateway.

Example

"1994-01-14T00:00:00"

patients[].home_phone

string

Landline Zedmed holds for the patient's home.

Example

"02 5550 1234"

patients[].work_phone

string

Daytime number Zedmed holds for the patient.

Example

"02 5550 1235"

patients[].mobile_phone

string

Cell number Zedmed holds for the patient.

Example

"0491 570 006"

patients[].status_code

string

Short code for patient record or appointment status.

Example

"A"

patients[].usual_doctor

string

Code of the doctor the patient normally sees.

Example

"DEMO_DOC"

patients[].usual_clinic

string

Code of the clinic the patient normally attends.

Example

"DEMO_CLINIC"

curl --request POST \
  --url https://preview.ontross.com/api/integrations/zedmed/search-patients \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"date_of_birth":"1994-01-14","phone":"+61 491 570 006","limit":50},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "date_of_birth": "1994-01-14",
    "phone": "+61 491 570 006",
    "limit": 50
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "patients": [
      {
        "patient_id": 900000001,
        "given_name": "Alex",
        "family_name": "Bennett",
        "popular_name": "Al",
        "date_of_birth": "1994-01-14T00:00:00",
        "home_phone": "02 5550 1234",
        "work_phone": "02 5550 1235",
        "mobile_phone": "0491 570 006",
        "status_code": "A",
        "usual_doctor": "DEMO_DOC",
        "usual_clinic": "DEMO_CLINIC"
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}