Electronic Health Information (EHI) Export Format

Overview

Thyra EHR enables a user to export the electronic health information (EHI) it produces and electronically manages, for a single patient and for the patient population. This page describes the structure and syntax of that export so the data can be interpreted and used without additional developer assistance.

How the export is produced

• Single patient (FHIR operation) | GET {base}/Patient/{id}/$ehi-export
• Base URL https://api.thyrahealth.com/fhir/R4
• Patient-initiated | the patient portal "Export Records" function
• Patient population | a bulk export job

Export package structure (a ZIP archive, organized by type)

• FHIR R4 (4.0.1) resources in JSON/NDJSON conformant to US Core 6.1.0 (demographics, allergies, problems/conditions, medications, immunizations, lab results & vital signs, encounters, procedures, care plans, care teams, goals, devices, coverage/insurance, document references, provenance)
• Consolidated CDA (C-CDA) documents in XML (HL7 C-CDA Release 2.1)
• Human-readable PDF renderings
• Coverage/insurance data and provenance

Syntax and interpretation

• FHIR JSON follows HL7 FHIR R4 (4.0.1) with US Core 6.1.0 / USCDI v3 element definitions and value sets
• C-CDA XML follows HL7 CDA R2 Consolidated CDA templates (Release 2.1)
• Files are named by FHIR resource type or document
• Provenance links exported data to its source

Keeping the format up to date

Thyra EHR maintains a process to keep the export format(s) current with the referenced standards.