v1

latestOpenAPI 3.1.02026-07-24447622848.7 KB

Reports

Create Report

post/api/2.0/reports/

Request body

chart_datestring date-time required

The date used for chart chronology and ordering. May differ from document_date.

created_datestring date-time nullable

custom_titlestring nullable

deleted_datestring date-time nullable

document_datestring date-time required

The date when the report was created.

idinteger

is_urgentboolean

patientinteger required

The patient this report belongs to. The patient must belong to the specified practice.

physicianinteger required

practiceinteger required

The authoring practice for this report. Required on create.

printable_viewstring uri

URL to a printable PDF view of the report. You may pass the optional 'print_header' query param to select a header.

report_type'Allergist' | 'Audiology' | 'Billing' | 'Business' | 'Cardiac' | 'CarePlan' | 'Consent' | 'Consultation' | 'Correspondence' | 'Cosmetic' | 'DME' | 'Dermatology' | 'Diabetes' | 'Directives' | 'EKG' | 'ENT' | 'Endocrinology' | 'Exams' | 'EyeVision' | 'Forms' | 'GI' | 'History' | 'Home' | 'Hospice' | 'Hospital' | 'Imaging' | 'Incoming' | 'Injection' | 'Insurance' | 'Intake' | 'Lab' | 'Legal' | 'Misc' | 'Neuro' | 'Nursing' | 'OBGYN' | 'OT' | 'OldRecord' | 'Oncology' | 'Ophth' | 'Ortho' | 'Outgoing' | 'PT' | 'PaperRx' | 'Pathology' | 'PatientForm' | 'Pediatric' | 'Pharmacy' | 'Preop' | 'PriorAuth' | 'Procedures' | 'Psych' | 'Pulmonary' | 'Quality' | 'Radiology' | 'SNF' | 'Screening' | 'Sleep' | 'Surgery' | 'Testing' | 'Therapy' | 'Ultrasound' | 'UrgentCare' | 'Urology' | 'Women' required

reported_datestring date-time

The timestamp when the report was created by an external system, usually the same as "document_date".

requisition_numberstring nullable

signed_byinteger nullable

signed_datestring date-time nullable

tagsinteger[]

Practice-scoped document tags.

vendorinteger nullable

Optional vendor for this report.

Response

chart_datestring date-time required

The date used for chart chronology and ordering. May differ from document_date.

created_datestring date-time nullable

custom_titlestring nullable

deleted_datestring date-time nullable

document_datestring date-time required

The date when the report was created.

idinteger

is_urgentboolean

patientinteger required

The patient this report belongs to. The patient must belong to the specified practice.

physicianinteger required

practiceinteger required

The authoring practice for this report. Required on create.

printable_viewstring uri

URL to a printable PDF view of the report. You may pass the optional 'print_header' query param to select a header.

report_type'Allergist' | 'Audiology' | 'Billing' | 'Business' | 'Cardiac' | 'CarePlan' | 'Consent' | 'Consultation' | 'Correspondence' | 'Cosmetic' | 'DME' | 'Dermatology' | 'Diabetes' | 'Directives' | 'EKG' | 'ENT' | 'Endocrinology' | 'Exams' | 'EyeVision' | 'Forms' | 'GI' | 'History' | 'Home' | 'Hospice' | 'Hospital' | 'Imaging' | 'Incoming' | 'Injection' | 'Insurance' | 'Intake' | 'Lab' | 'Legal' | 'Misc' | 'Neuro' | 'Nursing' | 'OBGYN' | 'OT' | 'OldRecord' | 'Oncology' | 'Ophth' | 'Ortho' | 'Outgoing' | 'PT' | 'PaperRx' | 'Pathology' | 'PatientForm' | 'Pediatric' | 'Pharmacy' | 'Preop' | 'PriorAuth' | 'Procedures' | 'Psych' | 'Pulmonary' | 'Quality' | 'Radiology' | 'SNF' | 'Screening' | 'Sleep' | 'Surgery' | 'Testing' | 'Therapy' | 'Ultrasound' | 'UrgentCare' | 'Urology' | 'Women' required

reported_datestring date-time

The timestamp when the report was created by an external system, usually the same as "document_date".

requisition_numberstring nullable

signed_byinteger nullable

signed_datestring date-time nullable

tagsinteger[]

Practice-scoped document tags.

vendorinteger nullable

Optional vendor for this report.