Convert document to FHIR resource
/lang2fhir/documentExtracts text from a PDF, image, RTF, or XML/C-CDA document and converts it into a structured FHIR resource.
The complete JSON request body is limited to 32 MiB (33,554,432 bytes). The application enforces this whole-envelope limit, including base64-encoded document content.
Patient identifier handling. When generating a patient (or patient-canvas) resource, US Core requires Patient.identifier (a business identifier such as an MRN). When the source text contains an identifier, it is extracted with an appropriate URI system. When the source text does not contain a detectable identifier, a synthetic one is generated with system: "urn:phenoml:lang2fhir-generated-id" and a UUID value so the resource remains FHIR-valid and US Core conformant. Callers who need a tenant-specific namespace should rewrite the synthetic system after extraction.
Body parameters
FHIR version to use
Type of FHIR resource to create. Accepts any FHIR resource type or US Core profile name.
Base64 encoded file content.
Supported file types: PDF (application/pdf), PNG (image/png), JPEG (image/jpeg), TIFF (image/tiff), RTF (application/rtf), XML/C-CDA (text/xml).
TIFF, RTF, and XML/C-CDA uploads are available on dedicated instances only.
File type is auto-detected from content magic bytes.
The decoded file must not exceed 20 MiB. RTF and XML/C-CDA documents whose extracted text exceeds 1 MiB are rejected.
Generic XML must include an XML declaration; C-CDA documents rooted at ClinicalDocument may omit it.
Optional processing configuration shared across document endpoints.
Optional per-page classifications, applied before extraction; accepts up to 20 classifications. When omitted or empty, every page with extracted text is used. This is a caller-defined list, not a fixed taxonomy: choose each classification id and describe the pages that belong to it. Each page is assigned at most one classification; a page that does not clearly match any, or that cannot be classified, is kept and left ungrouped. Pages matching a drop classification are removed before extraction. Pages matching a group classification are kept; on /lang2fhir/document/multi, resources extracted from them include the classification id in resources[].group and as a FHIR meta.tag. When every page is dropped, /lang2fhir/document returns 422 and /lang2fhir/document/multi returns success false with page_classifications. Example ids such as clinical and admin are illustrative, not a fixed set.
Unique, non-blank classification id. Returned as page_classifications[].classification_id and, for group classifications, as resources[].group and the FHIR meta.tag code. The reserved id "ungrouped" is not allowed.
Non-blank natural-language description of the pages that belong to this classification. Each page's text is compared against these descriptions, so describe what distinguishes these pages from the rest of the document.
Operation applied to pages assigned this classification. group keeps the pages and labels resources extracted from them with this id. drop removes the pages before extraction.
groupdropFaithfulness audit of the generated resources (honored by /lang2fhir/create/multi and /lang2fhir/document/multi). When resource_review is omitted, the audit runs with these default targets: Encounter checks dates; Procedure and DiagnosticReport check dates and codes; Observation, Condition, and MedicationRequest check codes. Supplying resource_review replaces the defaults with the listed targets; an empty targets list turns the audit off. For each selected resource type an LLM checks whether selected dates and clinical code concepts are actually supported by the full source document. An unsupported individual coding is removed when another coding remains in its concept. Resources with an unsupported structural field, a profile-required coding, or no coding remaining in an affected concept, are pulled out of the returned bundle and reported under resource_review in the response. Encounters, and diagnostic reports built from the source's report dates, are never pulled out, because other resources in the bundle reference them: an unsupported field is removed from them when their profile does not require it, and kept and reported when it does.
The resource types to audit and which date or clinical code field kinds to check. An empty list turns the audit off.
Successfully created FHIR resource from document