Zedmed Get patient

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

input.patient_id

integer

required

Zedmed patient identifier.

Example

900000001

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"

patient

object

Full patient record, null when the id matches nothing.

patient.patient_id

integer

Numeric record key for subsequent patient lookups.

Example

900000001

patient.given_name

string

First name of the patient or doctor being returned.

Example

"Alex"

patient.family_name

string

Surname of the patient or doctor being returned.

Example

"Bennett"

patient.popular_name

string

The name the patient actually goes by.

Example

"Al"

patient.date_of_birth

string

Patient's birth value returned unchanged by the gateway.

Example

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

patient.home_phone

string

Landline Zedmed holds for the patient's home.

Example

"02 5550 1234"

patient.work_phone

string

Daytime number Zedmed holds for the patient.

Example

"02 5550 1235"

patient.mobile_phone

string

Cell number Zedmed holds for the patient.

Example

"0491 570 006"

patient.status_code

string

Short code for patient record or appointment status.

Example

"A"

patient.usual_doctor

string

Code of the doctor the patient normally sees.

Example

"DEMO_DOC"

patient.usual_clinic

string

Code of the clinic the patient normally attends.

Example

"DEMO_CLINIC"

patient.title

string

Title

patient.gender

string

Gender

patient.home_address_line_1

string

Home address line 1

patient.home_address_line_2

string

Home address line 2

patient.home_suburb_town

string

Home suburb town

patient.home_postcode

string

Home postcode

patient.mailing_address_line_1

string

Mailing address line 1

patient.mailing_address_line_2

string

Mailing address line 2

patient.mailing_suburb_town

string

Mailing suburb town

patient.mailing_postcode

string

Mailing postcode

patient.email_address

string

Email address recorded on the patient file.

Example

"alex.bennett@example.test"

patient.medicare_number

string

Medicare number

patient.medicare_number_expiry

string

Medicare number expiry

patient.file_numbers

array

List of file numbers.

patient.file_numbers[].file_number

string

The patient's chart number at one particular clinic.

Example

"DEMO000123"

patient.file_numbers[].clinic_code

string

Site lookup value associated with this chart reference.

Example

"DEMO_CLINIC"

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

Request BODY

{
  "input": {
    "patient_id": 900000001
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "patient": {
      "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",
      "title": "",
      "gender": "",
      "home_address_line_1": "",
      "home_address_line_2": "",
      "home_suburb_town": "",
      "home_postcode": "",
      "mailing_address_line_1": "",
      "mailing_address_line_2": "",
      "mailing_suburb_town": "",
      "mailing_postcode": "",
      "email_address": "alex.bennett@example.test",
      "medicare_number": "",
      "medicare_number_expiry": "string",
      "file_numbers": [
        {
          "file_number": "DEMO000123",
          "clinic_code": "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"
}