exporting-bulk-fhir

Extract clinical notes from FHIR Bulk Data exports and process them through local de-identification and NER.

5.0k|615|Updated Oct 4, 2025
One-click install
npx skills add https://github.com/maziyarpanahi/openmed --skill exporting-bulk-fhir
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: exporting-bulk-fhir
Source: https://github.com/maziyarpanahi/openmed/tree/main/skills/exporting-bulk-fhir
Command: npx skills add https://github.com/maziyarpanahi/openmed --skill exporting-bulk-fhir

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill turns population-scale FHIR Bulk Data exports into a controlled, streaming workflow for extracting clinical notes and processing them locally, without sending patient data to a cloud NLP service.

Core Features & Use Cases

  • Bulk Export Coordination: Kick off system-, group-, or patient-level asynchronous FHIR exports, poll job status, download NDJSON manifests, and clean up completed jobs.
  • Cohort-Scale Note Processing: Extract text from DocumentReference and DiagnosticReport resources while streaming files line by line instead of loading entire datasets into memory.
  • Privacy-First NLP: De-identify every note before persistence, then run OpenMed biomedical entity recognition for population research, clinical analytics, and data warehouse pipelines.
  • Use Case: Export all clinical notes for a defined patient cohort, process each note through local de-identification and NER, and retain only approved de-identified findings for downstream FHIR workflows.

Quick Start

Use the exporting-bulk-fhir skill to run a SMART Backend Services FHIR group export for DocumentReference and DiagnosticReport resources, stream the resulting NDJSON through local OpenMed de-identification and NER, and remove the completed bulk export job.

Frequently Asked Questions about exporting-bulk-fhir

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I extract clinical notes from a FHIR bulk export without loading everything into memory?

You can stream NDJSON files line by line to extract clinical notes from DocumentReference and DiagnosticReport resources during a FHIR bulk export, avoiding loading entire datasets into memory. This approach processes each resource sequentially as the asynchronous download occurs.

How does SMART Backend Services authentication work for asynchronous FHIR exports?

SMART Backend Services authentication secures asynchronous FHIR bulk exports by allowing system-level data retrieval and job status polling. It supports downloading NDJSON manifests for group, patient, or system-level EHR exports while maintaining strict clinical data access controls.

Can I run biomedical NER on cohort-scale clinical notes while keeping data local?

Yes, you can run biomedical NER on cohort-scale clinical notes locally by applying de-identification before persistence and using OpenMed biomedical entity recognition. This workflow prevents sending PHI to cloud NLP services while enabling safe clinical analytics and population research.

What is the correct order for de-identifying clinical notes extracted from NDJSON?

The correct approach is PHI-safe ordering, where de-identification occurs before persistence of clinical notes extracted from NDJSON streams. This ensures patient data is scrubbed from DocumentReference and DiagnosticReport text before any biomedical NER processing or downstream storage takes place.

Does this workflow support incremental or filtered retrieval for FHIR group exports?

Yes, the workflow supports incremental or filtered retrieval for system, group, or patient-level asynchronous FHIR exports. It coordinates bulk export polling, downloads NDJSON manifests, and cleans up completed jobs to manage cohort-scale clinical data extraction efficiently.

What are the limitations of processing FHIR bulk exports with local NLP pipelines?

Limitations include the necessity of managing asynchronous export polling and streamed resource parsing for large NDJSON files. You must also maintain local infrastructure for PHI-safe de-identification before persistence and handle cohort-scale processing without relying on external cloud NLP services.