You might need to send a file to your connection(s) to provide clinical or administrative context for patients you share. Typically, you send a file to save to a patient’s chart.
With Redox, you can send files to your connection(s) with either of these two methods:
- Upload and reference a file (recommended)
- Embed a file
Upload and reference file | Embed file | |
|---|---|---|
Best for | Regularly sending large files. This is our recommended method since it improves our ability to process the request without errors. | Occasionally sending small files. |
File size limit | Up to 30 MB. The file limit is separate from the overall request limit. For example, if the request limit is 10 MB, the uploaded file doesn’t need to fit within that threshold. | Must fit within the request’s size limit. Check limits by traffic type. Best practice: We recommend not embedding files over 200 KB. |
Encoding | base64 Redox handles encoding the file. | base64 You must encode the file yourself. |
Environment type | For paid accounts, available in any environment. For free accounts, only available in staging or production. If you try to upload files in a development environment with a free account, we return a 403 Forbidden error. | Available in any environment. |
Available file download in the Redox dashboard | Yes | No |
You can send any valid file type to your connection(s).
For security reasons, we recommend not sending executable or archived files since they might contain exploitable vectors that could corrupt your connection’s system. Before delivering the request, we use content-inspecting firewalls, which rejects suspicious payloads.
With the Redox FHIR® API, use the DocumentReference resource to send a generic file. Or, if you’re sending a results or vitals document, send it as a FHIR® Attachment in the DiagnosticReport or Observation resources.
With the Redox Data Model API, use the Media, Notes, or Results requests to send a file.
Check out our how-tos for uploading or embedding files: