Create Report

Body Params
date-time
required

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

string | null
date-time
required

The date when the report was created.

files
array of objects | null

Files and photos to attach. Two modes: (1) External JSON metadata: set content_type='application/json; schema=el8_external_content_report' and provide 'external_content' JSON that includes a 'referenced_url' (and optional metadata). The JSON is stored and used to reference the external file; file bytes are not uploaded. (2) Binary upload: set content_type='application/octet-stream' and provide 'base64_content' (and optional 'original_filename'). When any file uses base64, all files in the same request must use base64. On GET, returns file references; download via the files retrieval endpoint. For JSON content, the retrieval endpoint returns the stored JSON metadata.

files
grids
array of objects

Structured lab results grids. Each grid groups results by accession number and collection/resulted timestamps.

grids
boolean
Defaults to false
enum

Status of a linked order, when applicable.

int64
required

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

int64
required
int64
required

The authoring practice for this report. Required on create.

uri

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

string
enum
required

The type of report. For laboratory reports, use 'Lab'.

date-time

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

string | null
int64 | null
date-time | null
tags
array of int64s

Practice-scoped document tags.

tags
int64 | null

Optional vendor for this report.

Response

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json