SMART Operations for Flat File Export (draft proposal)

Goals

Healthcare organizations have many reasons for bulk-data export, including, populating a data warehouse for operational or clinical analytics, leveraging population health and decision support tools from external vendor, migrating from one EHR vendor to another, and submitting data to regulatory agencies like CMS. Today, bulk export is often accomplished through proprietary pipelines. Every data transfer operation becomes an engineering and mapping project. This specification sketches out a FHIR-based approach to bulk export.

Design Sketch

Two operations are defined: one to kick off a (potentially long-running) job to perform the export, and one to check the status of an ongoing export. Systems may also include functions to list jobs, pause jobs and cancel jobs.

  • $smart-export. Parameters include since, dataType, and targetSystem, and targetPath. If the dataType is omitted, all supported FHIR resource types should be exported. Returns a job ID.

  • $smart-export-status: Parameters include jobId. Returns a status (active | canceled | paused | completed) and a progress (percent completion, from 0 to 100).

Authentication:

SMART backend services specification

Example queries:

POST /$smart-export?since=2017-05-01T00:00:00.000Z&dataType=Patient,Observation,DocumentReference&targetSystem=local&targetPath=server3/exports/may-05
→ SMART Export jobId = "abc"
GET /$smart-export-status?jobId=abc
→ status: active, progress: 30%.

Output format:

Exported FHIR resources should be in the form of newline delmited JSON and may be split across multiple files created within the export path.

The SMART on FHIR API is evolving in parallel with the FHIR ballot releases. If you spot problems, please file an issue. Or better yet, you can edit this page.