Dump FHIR Record

Overview

dump_fhir_record retrieves the complete FHIR medical record for a patient in a single call, covering all available client-facing resource types (medication requests, medication dispenses, medication statements, procedures, care plans, diagnostic reports, labs, vitals, conditions, allergies/intolerances, encounters, and immunizations). It is intended for comprehensive record dumps rather than retrieving a single resource type. It supports filtering by date range and returns a structured output suitable for downstream processing or LLM summarization.

Required Parameters

None — all parameters are optional.

Optional Parameters

person_id (string) — default None. If not provided, extracted from the access token.

start_date / end_date (date, YYYY-MM-DDTHH:MM:SS) — default None. Inclusive datetime bounds; no bound applied if omitted.

ignore_cache (boolean) — default false. Bypasses cached FHIR data.

debug (boolean) — default false.

Returns

  • result (string, optional) — the aggregated record dump. Each resource type's data is wrapped in delimiter lines: ===== RESOURCE: {index} - {resource_type} [{records_returned}] ========== END RESOURCE: ... =====.
  • error (string, optional) — accumulated error messages for any resource types that failed; other resource types are still included in result.
  • urls (list of strings, optional)
  • meta — aggregated retrieval metadata merged across all resource types.
  • debug — populated only when debug is true.

Notes

Unlike get_fhir_record, which targets one FHIR resource type per call, dump_fhir_record always retrieves every client-facing resource type for the patient. A failure retrieving one resource type is isolated into error rather than aborting the whole dump.



Did this page help you?