POST: /Patient/$export

Patient-level export — all patients, resource types the token is scoped for. Exportable types: AllergyIntolerance, CarePlan, CareTeam, Condition, Coverage, Device, DiagnosticReport, DocumentReference, Encounter, Goal, Immunization, Medication, MedicationDispense, MedicationRequest, Observation, Organization, Patient, Practitioner, Procedure, Questionnaire, QuestionnaireResponse, RelatedPerson, ServiceRequest, Specimen. Same per-type scope gating and skip-on-missing-scope behavior as system-level export. Only _outputFormat, _since, and _type are supported — sending any other Bulk Data IG parameter (_until, _elements, patient, includeAssociatedData, _typeFilter, organizeOutputBy, allowPartialManifests) fails the request. Parameters are sent as query params on the POST, not as a FHIR Parameters resource body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Must contain "ndjson" (e.g. application/fhir+ndjson, application/ndjson, or ndjson). Defaults to application/fhir+ndjson.

Only include resources with meta.lastUpdated after this instant.

string

Comma-separated FHIR resource type(s) to restrict the export to.

Response
202

Accepted. The export always runs asynchronously — there is no synchronous response. The Content-Location response header gives the polling URL: {fhir-base}/fhir-services/$export-status/{jobId}.

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here!