$davinci-data-export

Exports clinical, claims, encounter, and prior-authorization data for the members of a Group as ndjson, defined by the Da Vinci ATR IG and referenced by the Da Vinci PDex IG. It is the bulk entry point for both Provider Access (Group produced by $provider-member-match) and Payer-to-Payer (Group produced by $bulk-member-match).

The operation is always asynchronous and follows the FHIR Bulk Data export pattern: kick-off returns 202 Accepted with Content-Location, the client polls the status URL, and downloads each ndjson file referenced in the completed manifest.

exportType selects the PDex scenario the request runs under and governs consent rules and data scope per the IG (see exportType values). The kick-off endpoint is owned by Payerbox's interop app; status polling, output download, and cancellation are served by Aidbox at its standard Bulk Data Export URLs ($export-status, signed output URLs).

Auth

SMART Backend Services and Client Credentials. The caller's OAuth client must be allowed to read the Group and the resource types referenced by _type (and their referenced resources, since Aidbox $export chases references). See Authentication.

Kick-off

Endpoint

POST <base>/fhir/Group/<group-id>/$davinci-data-export

<group-id> is the id of a Group resource — typically MatchedMembers from $provider-member-match or $bulk-member-match. Prefer: respond-async is required. Requests without it are rejected with 400.

Parameters

The request body must be a FHIR Parameters resource. Unsupported parameter names are rejected with 400. Aidbox's $export also validates the body against its BulkExportProfile and returns 422 on shape errors (for example, an empty parameter[]).

Example

POST /fhir/Group/<group-id>/$davinci-data-export
Content-Type: application/fhir+json
Prefer: respond-async

{
  "resourceType": "Parameters",
  "parameter": [
    {"name": "exportType", "valueCanonical": "hl7.fhir.us.davinci-pdex#payertopayer"},
    {"name": "_type",      "valueString":    "Patient,Coverage,ExplanationOfBenefit,Condition,Observation,MedicationRequest"},
    {"name": "_since",     "valueInstant":   "2021-01-01T00:00:00Z"}
  ]
}

HTTP/1.1 202 Accepted
Content-Location: <base>/fhir/$export-status/<job-id>

HTTP/1.1 400 Bad Request
Content-Type: application/fhir+json

{
  "resourceType": "OperationOutcome",
  "issue": [{
    "severity": "error",
    "code": "processing",
    "diagnostics": "This operation requires Prefer: respond-async header"
  }]
}

HTTP/1.1 400 Bad Request
Content-Type: application/fhir+json

HTTP/1.1 404 Not Found
Content-Type: application/fhir+json

{
  "resourceType": "OperationOutcome",
  "id": "not-found",
  "issue": [{
    "severity": "fatal",
    "code": "not-found",
    "diagnostics": "Resource Group/<id> not found"
  }]
}

Status polling

Endpoint

GET <base>/fhir/$export-status/<job-id>

Served by Aidbox per the FHIR Bulk Data status spec. <job-id> is the id at the end of the Content-Location from kick-off.

Parameters

Example

GET /fhir/$export-status/<job-id>

HTTP/1.1 202 Accepted
X-Progress: in-progress
Retry-After: 30

HTTP/1.1 200 OK
Content-Type: application/json

{
  "transactionTime": "2026-05-15T13:40:00Z",
  "request": "<base>/fhir/Group/<group-id>/$export",
  "requiresAccessToken": true,
  "output": [
    {"type": "Patient",              "url": "<signed-url>/patient.ndjson"},
    {"type": "Coverage",             "url": "<signed-url>/coverage.ndjson"},
    {"type": "ExplanationOfBenefit", "url": "<signed-url>/eob.ndjson"}
  ],
  "error": [],
  "deleted": []
}

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
  "resourceType": "BulkExportStatus",
  "id": "<job-id>",
  "status": "error",
  "request": "<base>/fhir/Group/<group-id>/$export",
  "extension": [{
    "url": "urn:url:extension:BulkExportStatus.internal-error",
    "valueString": "<reason>"
  }]
}

Output download

Endpoint

Each entry in the completed manifest's output[].url is a pre-signed URL pointing at the object-store bucket Aidbox is configured to use (S3, MinIO, etc.). Fetch them directly:

GET <output-url>
Authorization: Bearer <token>      # only if `requiresAccessToken: true`
Accept: application/fhir+ndjson

Each file is newline-delimited JSON — one FHIR resource per line. Stream-parse line by line.

Example

GET <signed-url>/patient.ndjson
Accept: application/fhir+ndjson

HTTP/1.1 200 OK
Content-Type: application/fhir+ndjson

{"resourceType":"Patient","id":"patient-1","name":[{"family":"Smith","given":["John"]}],"gender":"male","birthDate":"1970-05-15"}
{"resourceType":"Patient","id":"patient-2","name":[{"family":"Doe","given":["Jane"]}],"gender":"female","birthDate":"1985-03-12"}

Cancellation

Endpoint

DELETE <base>/fhir/$export-status/<job-id>

Served by Aidbox per the FHIR Bulk Data cancel spec. Returns 202 Accepted for a known job (running or terminal) and 404 for an unknown id.

Example

DELETE /fhir/$export-status/<job-id>

HTTP/1.1 202 Accepted

exportType values

Errors

For architectural context see the Provider Access and Payer-to-Payer pillars.