Sign in

v1

latestOpenAPI 3.1.02026-07-24447622848.7 KB
Sleep Orders

Partially Update Sleep Order

Retrieve a single sleep order

patch/api/2.0/sleep_orders/{id}/

Path parameters

idinteger required

Request body

ancillary_companyinteger
ccsinteger[]

Array of Physician IDs to copy for the order.

chart_datestring date-time
clinical_reasonstring

The clinical reason for the order.

confidentialboolean
created_datestring date-time nullable
deleted_datestring date-time nullable
document_datestring date-time
follow_up_methodstring nullable

How to notify the patient of the results.

idinteger
patientinteger

The patient the order is associated with. Patient must belong to the specified practice.

practiceinteger

The practice the order is associated with.

prescribing_userinteger

The user associated with the order. User ID must tie to a physician in the practice.

signed_byinteger nullable
signed_datestring date-time nullable
sleep_centerinteger nullable

The sleep center the order is associated with.

test_datestring date nullable

The date on which the tests should be performed, or were performed. Can be different than document_date, create_date.

Response

ancillary_companyinteger required
ccsinteger[]

Array of Physician IDs to copy for the order.

chart_datestring date-time required
clinical_reasonstring required

The clinical reason for the order.

confidentialboolean
created_datestring date-time nullable
deleted_datestring date-time nullable
document_datestring date-time required
follow_up_methodstring nullable

How to notify the patient of the results.

idinteger
patientinteger required

The patient the order is associated with. Patient must belong to the specified practice.

practiceinteger required

The practice the order is associated with.

prescribing_userinteger required

The user associated with the order. User ID must tie to a physician in the practice.

signed_byinteger nullable
signed_datestring date-time nullable
sleep_centerinteger nullable

The sleep center the order is associated with.

test_datestring date nullable

The date on which the tests should be performed, or were performed. Can be different than document_date, create_date.