EHI Export
Canvas supports the export of electronic health information (EHI) based on FHIR Bulk Data Access.
Creating a Single Patient Export #
In the UI #
To generate a single patient export, navigate to Fhir bulk data exports in your admin settings.
Click on ADD FHIR BULK DATA EXPORT to pull up the tool. Select the appropriate Oauth application from the dropdown. These are typically created by your team as a part of implementation. Support can also help to create one if needed. Export type defaults to ‘Patient’. Search for the patient and click Start Export.
The export will generate links to the output files for each resource. Clicking each will download the files locally.
Using the API #
You can initiate a single patient export by issuing a request like the one below:
GET https://fumage-<instance-name>.canvasmedical.com/Patient/<id>/$export
Creating a Population Export #
Canvas also supports exporting EHI for a group of patients or all patients. To request an export, please contact support and provide the following information:
- Your instance name (the url of your instance)
- Your username
- Your role
- The group of patients, or specify all patients
- The purpose of the export.
The Canvas team can initiate the bulk export on your behalf. The output will be availble within the ADD FHIR BULK DATA EXPORT table.
Format #
EHI is exported as standard FHIR R4 resources in Newline Delimited JSON format, as outlined by the FHIR Bulk Data Access pattern.
Resources #
The resources in scope for the response are:
- The patient resource itself.
- Any resource that is associated with the patient.
The table below lists the Canvas resources included in the patient recordset: