Tross
ZEDMED

Create patient

Atomically create a patient and their chart reference at one explicit clinic.

POSThttps://api.ontross.com/api/integrations/zedmed/create-patient
Request Fields
input.clinic_code
string
required
Zedmed clinic/site code. Use a value returned by list-clinics; this is a format-only example, not a default.
Example
"CLN"
input.given_name
string
required
Patient's legal given name.
Example
"Alex"
input.family_name
string
required
Patient's legal family name.
Example
"Bennett"
input.date_of_birth
string
required
Date of birth in ISO 8601 format: YYYY-MM-DD.
Example
"1994-01-14"
input.status_code
string
required
Zedmed patient status code. Supply the code configured for a current patient, for example CUR.
Example
"CUR"
input.pull_file
boolean
required
Whether Zedmed should pull the patient's file. Required explicitly because it is normally inherited from the desktop form.
Example
true
input.send_recall
boolean
required
Value for Zedmed's SEND_RECALL patient flag. Required explicitly because the desktop UI may inherit it from the signed-in session.
Example
true
input.title
string
Optional title, such as Mr or Ms.
Example
"Ms"
input.popular_name
string
Optional preferred name.
Example
"Alex"
input.gender
string
Optional Zedmed sex-at-birth code.
Example
"F"
input.type_code
string
Optional practice-configured patient type code. Omit unless you know a valid code for the target practice.
Example
"P"
input.home_address_line_1
string
Optional first line of the home address.
Example
"12 Example Street"
input.home_address_line_2
string
Optional second line of the home address.
Example
"Unit 4"
input.home_suburb_town
string
Optional home suburb or town.
Example
"Sampletown"
input.home_postcode
string
Optional home postcode.
Example
"3000"
input.mailing_address_line_1
string
Optional first line of the mailing address.
Example
"PO Box 123"
input.mailing_address_line_2
string
Optional second line of the mailing address.
Example
"Example House"
input.mailing_suburb_town
string
Optional mailing suburb or town.
Example
"Sampletown"
input.mailing_postcode
string
Optional mailing postcode.
Example
"3000"
input.home_phone
string
Optional home phone number.
Example
"03 0000 0000"
input.work_phone
string
Optional work phone number.
Example
"03 0000 0001"
input.mobile_phone
string
Optional mobile phone number.
Example
"0400 000 000"
input.email_address
string
Optional email address.
Example
"alex.bennett@example.test"
input.medicare_number
string
Optional Medicare number.
Example
"0000 00000 0"
input.medicare_number_expiry
string
Optional Medicare expiry date in ISO 8601 format: YYYY-MM-DD.
Example
"2027-12-31"
input.usual_doctor
string
Optional usual treating-doctor code. Use a code returned by list-providers; omit when none is selected.
Example
"DEMO_DOC"
input.preferred_contact_method
string
Optional practice-configured contact-method code. Omit unless you know a valid code for the target practice.
Example
"SMS"
input.suppress_account_reminder
boolean
Optional account-reminder preference. Null leaves no inferred setting.
Example
false
input.allow_sms
boolean
Optional SMS permission. Null leaves no inferred setting.
Example
true
input.do_not_send_sms
boolean
Optional SMS suppression. Null leaves no inferred setting.
Example
false
input.pbs_co_payment_relief
boolean
Optional PBS co-payment relief flag. Null leaves no inferred setting.
Example
false
input.blocked_from_online_bookings
boolean
Optional online-booking block. Null leaves no inferred setting.
Example
false
Output Fields
patient_id
integer
New Zedmed patient identifier.
Example
900000001
file_number
string
Chart number created at the selected clinic.
Example
"900000001"
clinic_code
string
Clinic/site where the chart number was created.
Example
"CLN"
Code
curl --request POST \
  --url https://api.ontross.com/api/integrations/zedmed/create-patient \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"clinic_code":"CLN","given_name":"Alex","family_name":"Bennett","date_of_birth":"1994-01-14","status_code":"CUR","pull_file":true,"send_recall":true,"title":"Ms","popular_name":"Alex","gender":"F","type_code":"P","home_address_line_1":"12 Example Street","home_address_line_2":"Unit 4","home_suburb_town":"Sampletown","home_postcode":"3000","mailing_address_line_1":"PO Box 123","mailing_address_line_2":"Example House","mailing_suburb_town":"Sampletown","mailing_postcode":"3000","home_phone":"03 0000 0000","work_phone":"03 0000 0001","mobile_phone":"0400 000 000","email_address":"alex.bennett@example.test","medicare_number":"0000 00000 0","medicare_number_expiry":"2027-12-31","usual_doctor":"DEMO_DOC","preferred_contact_method":"SMS","suppress_account_reminder":false,"allow_sms":true,"do_not_send_sms":false,"pbs_co_payment_relief":false,"blocked_from_online_bookings":false}}'
Request BODY
{
  "input": {
    "clinic_code": "CLN",
    "given_name": "Alex",
    "family_name": "Bennett",
    "date_of_birth": "1994-01-14",
    "status_code": "CUR",
    "pull_file": true,
    "send_recall": true,
    "title": "Ms",
    "popular_name": "Alex",
    "gender": "F",
    "type_code": "P",
    "home_address_line_1": "12 Example Street",
    "home_address_line_2": "Unit 4",
    "home_suburb_town": "Sampletown",
    "home_postcode": "3000",
    "mailing_address_line_1": "PO Box 123",
    "mailing_address_line_2": "Example House",
    "mailing_suburb_town": "Sampletown",
    "mailing_postcode": "3000",
    "home_phone": "03 0000 0000",
    "work_phone": "03 0000 0001",
    "mobile_phone": "0400 000 000",
    "email_address": "alex.bennett@example.test",
    "medicare_number": "0000 00000 0",
    "medicare_number_expiry": "2027-12-31",
    "usual_doctor": "DEMO_DOC",
    "preferred_contact_method": "SMS",
    "suppress_account_reminder": false,
    "allow_sms": true,
    "do_not_send_sms": false,
    "pbs_co_payment_relief": false,
    "blocked_from_online_bookings": false
  }
}
Response BODY
{
  "patient_id": 900000001,
  "file_number": "900000001",
  "clinic_code": "CLN"
}