Athena Prod Book appointment

POSThttps://preview.ontross.com/api/integrations/athena-prod/book-appointment

input.org_id

integer

required

Athena practice ID; also the scheduling context id.

Example

32817

input.department_id

integer

required

Runtime Athena context department.

Example

1

input.patient_id

integer

required

Practice patient ID to book.

Example

1133

input.slot_id

string

required

Open slot ID from availability search, e.g. '32817-4-10.385543'.

Example

"68421-4-10.396654"

input.appointment_type_id

string

required

Appointment type ID for the booking, e.g. '164'.

Example

"175"

input.primary_insurance_id

string

Patient insurance package ID for primary coverage; omit for self-pay.

Example

"4307"

input.secondary_insurance_id

string

Patient insurance package ID for secondary coverage; omit when none.

Example

"4308"

input.authorization_id

string

Referral/authorization record ID, if any.

Example

"86432"

Default

""

input.note

string

Scheduling note stored on the appointment.

Example

"Patient requests an interpreter for this visit."

Default

""

input.display_note_on_schedule

boolean

Show the note on the calendar.

Example

true

Default

true

input.is_urgent

boolean

Flag the appointment as urgent.

Example

false

Default

false

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"

outcome

string

Whether the slot was booked.

Example

"booked"

booked_appointment_ids

array

IDs created by the booking.

appointment_id

string

The created appointment ID (first booked id).

Example

"976543"

appointment_link_id

string

Link ID when the booking is part of a linked set.

Example

"4680"

curl --request POST \
  --url https://preview.ontross.com/api/integrations/athena-prod/book-appointment \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"appointment_type_id":"164","department_id":1,"is_urgent":false,"note":"","org_id":32817,"patient_id":1133,"primary_insurance_id":"3296","slot_id":"32817-4-10.385543"},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "appointment_type_id": "164",
    "department_id": 1,
    "is_urgent": false,
    "note": "",
    "org_id": 32817,
    "patient_id": 1133,
    "primary_insurance_id": "3296",
    "slot_id": "32817-4-10.385543"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "outcome": "booked",
    "booked_appointment_ids": [
      "string"
    ],
    "appointment_id": "976543",
    "appointment_link_id": "4680"
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}