Implementation Guide
23.0.0 - R4 APIs

Publish Box goes here

Operation: group-export

The Bulk Data Export Operation initiates the asynchronous generation of a requested export dataset - whether that be data for all patients or data for a subset (defined group) of patients. A bulk data client can use this operation to obtain a set of FHIR resources of diverse resource types pertaining to all members of the specified Group.

FHIR Operation to obtain a detailed set of FHIR resources of diverse resource types pertaining to all members of the specified Group. The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern

GET [base]/Group/[id]/$export?{operation-parameters}

Where:

[id] can be 'Practitioner-PVID', 'Location-LOCID', 'Patient-All'

  • Practitioner-PVID identifies the group of patients that have specified responsible provider. PVID will be the id of a Practitioner resource.
  • Location-LOCID identifies the group of patients that have specified home location of care. LOCID will be the id of a Location resource.
  • Patient-All identifies the group of all patients.
Use Name Cardinality Type Binding Documentation
IN _since 0..1 FHIR instant Resources will be included in the response if their state has changed after the supplied time (e.g. if Resource.meta.lastUpdated is later than the supplied _since time).
IN _type 0..1 string of comma-delimited FHIR resource types Only resources of the specified resource types(s) SHALL be included in the response. If this parameter is omitted, the server SHALL return all supported resources within the scope of the client authorization.

The following resource types are supported as defined by the HL7 FHIR US Core Implementation Guide.
AllergyIntolerance
CarePlan
CareTeam
Condition
Device
DiagnosticReport
DocumentReference
Encounter
Goal
Immunization
Location
MedicationRequest
Medication
Observation
Organization
Patient
Practitioner
Procedure
Provenance