Create a Visit

post https://api.axlehealth-dev.com/v1/visits

Creating a Visit requires an existing Patient and Address to be provided.
Once a Visit is created, a health professional will be assigned and the visit will occur.
If a visit datetime is provided, the visit will be created in the Confirmed state. If a visit datetime is not provided, the visit will be created in the Unscheduled state.

Body Params

patient_id

string

required

Patient's ID

address

object

Patient's address. This address will be added to the list of patient's addresses

visit_datetime

string

Local datetime of the Visit in ISO-8601 format

requisitioning_provider_id

string

Provider requisitioning Service. Required if Service specifies provider_requisition_required: true. Otherwise optional.

provider_notes

string

is_self_pay

boolean

required

true - If true, the scheduling link will include patient payment. If false, your account will be billed directly for the Service.

service_ids

string

required

IDs of the services to be performed

timeslot_preferences

array of objects

Timewindows of the timeslot preferences for the visit, with start and end in ISO-8601 datetime format

timeslot_preferences

meta

object

Customizable JSON field that you can use to attach key-value data to your visit.

responses

array of objects

Patient responses to prompts related to the visit. The response_value should be whatever type is necessary to sufficiently respond to the prompt. For example, a checkbox could have a boolean response_value while a textfield should have a string response_value.

responses

Response

xxxxxxxxxx
curl --request POST \
     --url https://api.axlehealth-dev.com/v1/visits \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{"is_self_pay":true}'

201Created