Calling the $davinci-data-export Operation

 

These tutorials show how to call the $davinci-data-export operation for each export type a provider system can use, and explain the effect of the parameters each export type supports.

Export TypeexportType ValueUse It ToTutorial
ATRhl7.fhir.us.davinci-atrRetrieve the Member Attribution List: the Group and its members' Patient and Coverage resources.ATR Export
Downloadhl7.fhir.us.davinci-pdex#provider-downloadRetrieve the data of the Group members, for an initial load or a refresh, and record what was sent.Download Export
Deltahl7.fhir.us.davinci-pdex#provider-deltaRetrieve only the data that changed since the members were last exported.Delta Export
Snapshothl7.fhir.us.davinci-pdex#provider-snapshotRetrieve the data of the Group members for viewing, without recording what was sent.Snapshot Export

The parameters each export type accepts are listed in Supported Parameters per Export Type.

Common Request Rules

 

All export types share the following rules:

  • The request is a POST to [FHIR base]/Group/[id]/$davinci-data-export, where the Group has the profile http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provider-group.
  • The Prefer: respond-async header is required.
  • _since and _until are sent as valueInstant.
  • _type is sent once, with a comma-separated list of resource types, for example Encounter,Coverage. If _type is repeated, only the first value is used.
  • patient can be repeated to select several members. Patients that are not members of the Group are reported in an OperationOutcome in the response.

The server responds with HTTP 202 Accepted and a Content-Location header with the URL to poll. See Polling the Export Job.