Skip to main content
POST
/
api
/
2.0
/
reports
/
Create Report
curl --request POST \
  --url https://sandbox.elationemr.com/api/2.0/reports/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "chart_date": "2023-11-07T05:31:56Z",
  "document_date": "2023-11-07T05:31:56Z",
  "patient": 123,
  "physician": 123,
  "practice": 123,
  "custom_title": "<string>",
  "files": [
    {
      "base64_content": "<string>",
      "content_type": "<string>",
      "document": "<string>",
      "external_content": "<unknown>",
      "original_filename": "<string>"
    }
  ],
  "grids": [
    {
      "accession_number": "<string>",
      "collected_date": "2023-11-07T05:31:56Z",
      "note": "<string>",
      "resulted_date": "2023-11-07T05:31:56Z",
      "results": [
        {
          "is_abnormal": true,
          "note": "<string>",
          "reference_max": "<string>",
          "reference_min": "<string>",
          "test": {
            "code": "<string>",
            "loinc": "<string>",
            "name": "<string>"
          },
          "test_category": {
            "description": "<string>",
            "value": "<string>"
          },
          "text": "<string>",
          "value": "<string>",
          "units": "<string>"
        }
      ]
    }
  ],
  "is_urgent": false,
  "printable_view": "<string>",
  "reported_date": "2023-11-07T05:31:56Z",
  "requisition_number": "<string>",
  "signed_by": 123,
  "signed_date": "2023-11-07T05:31:56Z",
  "tags": [
    123
  ],
  "vendor": 123
}
'
{
  "chart_date": "2023-11-07T05:31:56Z",
  "document_date": "2023-11-07T05:31:56Z",
  "patient": 123,
  "physician": 123,
  "practice": 123,
  "created_date": "2023-11-07T05:31:56Z",
  "custom_title": "<string>",
  "deleted_date": "2023-11-07T05:31:56Z",
  "files": [
    {
      "base64_content": "<string>",
      "content_type": "<string>",
      "document": "<string>",
      "external_content": "<unknown>",
      "id": 123,
      "original_filename": "<string>"
    }
  ],
  "grids": [
    {
      "accession_number": "<string>",
      "collected_date": "2023-11-07T05:31:56Z",
      "note": "<string>",
      "resulted_date": "2023-11-07T05:31:56Z",
      "results": [
        {
          "is_abnormal": true,
          "note": "<string>",
          "reference_max": "<string>",
          "reference_min": "<string>",
          "test": {
            "code": "<string>",
            "loinc": "<string>",
            "name": "<string>"
          },
          "test_category": {
            "description": "<string>",
            "value": "<string>"
          },
          "text": "<string>",
          "value": "<string>",
          "units": "<string>"
        }
      ]
    }
  ],
  "id": 123,
  "images": [
    {
      "document": "<string>",
      "id": 123
    }
  ],
  "is_urgent": false,
  "printable_view": "<string>",
  "reported_date": "2023-11-07T05:31:56Z",
  "requisition_number": "<string>",
  "routed_document_delegates": [
    {
      "created_date": "2023-11-07T05:31:56Z",
      "deleted_date": "2023-11-07T05:31:56Z",
      "group": 123,
      "id": 123,
      "user": 123
    }
  ],
  "signed_by": 123,
  "signed_date": "2023-11-07T05:31:56Z",
  "tags": [
    123
  ],
  "vendor": 123
}

​
File Uploading

Files are attached via the files array in the request body. Two formats are supported.

​
JSON files

Files uploaded as external_content are saved as doc_files. 
{
  "files": [
    {
      "external_content": {
        "summary": "this is summary line 1\nthis is line2",
        "referenced_url": "https://external.data.com/path_to_data"
      }
    }
  ]
}

​
Base64 files

PDFs uploaded as base64 are rasterized and saved as doc_images if they are 20 pages or fewer. PDFs longer than 20 pages and all other file types are saved as doc_files. 
{
  "files": [
    {
      "original_filename": "test.png",
      "content_type": "application/octet-stream",
      "base64_content": "<base64_string>"
    }
  ]
}

​
Lab Report Requirements

You must provide at least one grid, and each grid must contain a LOINC-coded result. For each LOINC-coded result, you must provide the value and the units.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
​
chart_date
string<date-time>
required

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

​
document_date
string<date-time>
required

The date when the report was created.

​
patient
integer<int64>
required

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

​
physician
integer<int64>
required
​
practice
integer<int64>
required

The authoring practice for this report. Required on create.

​
report_type
enum<string>
required

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

Available options:
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
​
custom_title
string | null
Maximum string length: 255
​
files
object[] | 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.

​
grids
object[]

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

​
is_urgent
boolean
default:false
​
order_status
enum<string> | null

Status of a linked order, when applicable.

Available options:
CANCELED,
COMPLETED,
DISCONTINUED,
ERROR, ORDER NOT FOUND,
IN PROCESS,
ON HOLD,
REPLACED,
SCHEDULED
​
printable_view
string<uri>

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

​
reported_date
string<date-time>

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

​
requisition_number
string | null
Maximum string length: 100
​
signed_by
integer<int64> | null
​
signed_date
string<date-time> | null
​
tags
integer<int64>[]

Practice-scoped document tags.

​
vendor
integer<int64> | null

Optional vendor for this report.

Response

201 - application/json
​
chart_date
string<date-time>
required

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

​
document_date
string<date-time>
required

The date when the report was created.

​
patient
integer<int64>
required

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

​
physician
integer<int64>
required
​
practice
integer<int64>
required

The authoring practice for this report. Required on create.

​
report_type
enum<string>
required

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

Available options:
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
​
created_date
string<date-time> | null
read-only
​
custom_title
string | null
Maximum string length: 255
​
deleted_date
string<date-time> | null
read-only
​
files
object[] | 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.

​
grids
object[]

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

​
id
integer
read-only
​
images
object[] | null
read-only

Read-only. Images derived from uploaded files. Upload using the 'files' field; retrieve specific images via the images endpoint.

​
is_urgent
boolean
default:false
​
order_status
enum<string> | null

Status of a linked order, when applicable.

Available options:
CANCELED,
COMPLETED,
DISCONTINUED,
ERROR, ORDER NOT FOUND,
IN PROCESS,
ON HOLD,
REPLACED,
SCHEDULED
​
printable_view
string<uri>

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

​
reported_date
string<date-time>

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

​
requisition_number
string | null
Maximum string length: 100
​
routed_document_delegates
object[]
read-only

Read-only. Users and groups that have been delegated to review this report.

​
signed_by
integer<int64> | null
​
signed_date
string<date-time> | null
​
tags
integer<int64>[]

Practice-scoped document tags.

​
vendor
integer<int64> | null

Optional vendor for this report.