Skip to main content

FHIR export format

Your records belong to you. A practice owner can export every record at any time, free. This page explains the FHIR part of that export, so another system can read it.

What you get

  • Files in the HL7 FHIR R4 bulk data format: one file per resource type, named like Patient.ndjson. Each line of a file is one complete FHIR resource in JSON.
  • Resources follow the US Core 6.1.0 profiles where one exists. Each resource keeps the ID it has in Kaivo Health EHR, so references between resources, and to the CSV files of the full export, line up.
  • If a record cannot be converted, OperationOutcome.ndjson names its type and ID. That record is still in the CSV files of the full export.
  • The full export also holds every record as CSV and JSON, every uploaded document in its original format, and signed notes as PDF. Records with no FHIR R4 equivalent, such as shift logs, incidents and the audit log, are in the CSV files only.

Resource types

FHIR resource types in the Kaivo Health export
Resource Profile What it holds
Organization US Core Organization Your practice: name, NPI, address and phone.
Location US Core Location Each site, with its address and time zone.
Practitioner US Core Practitioner Each member of your team: name, work email, NPI when known, state licenses.
PractitionerRole US Core PractitionerRole Each member's roles in the practice.
Patient US Core Patient Each client: legal and preferred names, date of birth, sex assigned at birth, gender identity, pronouns, languages, MRN, and legal representatives as contacts.
EpisodeOfCare FHIR R4 Each episode of care, with its admission and discharge dates and level of care.
Appointment FHIR R4 Every appointment, including cancelled ones and no-shows, with the client, staff and site.
Encounter US Core Encounter Each visit that took place. Telehealth visits are marked as virtual. A group session gives one encounter for each client who attended.
Condition US Core Condition (problems and health concerns) Diagnoses with their ICD-10-CM codes, and problems on the treatment plan.
AllergyIntolerance US Core AllergyIntolerance Allergies, with RxNorm codes for medicines when recorded.
Flag FHIR R4 Safety and care alerts shown on the client's chart.
Questionnaire and QuestionnaireResponse FHIR R4 and US Core QuestionnaireResponse Each measure (such as PHQ-9 and GAD-7, or a measure you built) and each set of answers.
Observation US Core Observation (screening assessment) The total score of each measure, with LOINC codes for PHQ-9 and GAD-7.
CarePlan and Goal US Core CarePlan and Goal Treatment plans with their goals, objectives and interventions.
MedicationRequest US Core MedicationRequest Medication orders with RxNorm codes, dose, route, frequency and directions.
MedicationStatement FHIR R4 Medications recorded from an outside record.
MedicationAdministration FHIR R4 Each dose given, refused or held, with the reason.
DocumentReference US Core DocumentReference Clinical notes, with their full text and any amendments, and each uploaded document. In the full export, a document's entry points to its file in the same archive. In a FHIR-only export, it gives the Kaivo address that downloads the file.
Consent FHIR R4 Signed consents, including 42 CFR Part 2 consents, and whether they were revoked.
Provenance US Core Provenance Who wrote or signed a record, and when.

Codes that Kaivo defines itself, such as appointment kinds and staff roles, use the code systems under https://kaivohealth.com/fhir/CodeSystem/. Each such code also has a plain-language text.

Sensitive records

  • Records of a 42 CFR Part 2 program carry HL7 security labels: 42CFRPart2, restricted confidentiality (R), SUD and NORDSCLCD (no redisclosure without consent). Every record about a client of a Part 2 program is labelled. The export includes the notice that 42 CFR 2.32 requires.
  • Psychotherapy notes are left out of exports unless the owner chooses to include them in the full export. SUD counseling notes are handled the same way. When included, they carry their own security labels.

How an owner gets it

  • The FHIR files are part of the full practice export.
  • A FHIR-only export follows the FHIR Bulk Data Access pattern: the owner starts an export, checks its status, and downloads each file. Owners must have signed in within the last 10 minutes.
  • Files are stored encrypted. Each download link works for 5 minutes. The files of a FHIR-only export can be downloaded for 24 hours after it is ready; then Kaivo deletes them. Deleted files stay encrypted in the storage's version history for about three months before they are removed for good. Every export and download is recorded in the practice's audit log.
  • Kaivo's automated tests check the export of a fictional practice with the official HL7 FHIR validator against FHIR R4 and US Core 6.1.0.