Davinci Data Exchange Module
The Davinci Data Exchange module enables the $davinci-data-export operation under the Da Vinci - Member Attribution (ATR) List IG. It is built on top of the FHIR Bulk Export Operation, and can be invoked on the Group-level (requiring the same permissions), using the endpoint
[fhir base]/Group/[id]/$davinci-data-export
Initiating a job is exactly the same as $export
, with some additional parameters (see next section). Response is also the same, returning a polling URL once a job is initiated successfully, which would eventually resolve to a list of Binary file URLs that can be used to access the NDJSON data gathered as a part of the export.
Aside from the FHIR Bulk Export's existing request parameters, the following parameters are also supported:
Name | Optional? | Multiple Allowed? | Description | Example |
---|---|---|---|---|
exportType | No | No | The code that indicates the type of export to be performed. | hl7.fhir.us.davinci-pdex#provider-delta |
_until | Yes | No | Only resources that were last updated before the given time will be included. If this parameter is absent, all resources created or updated before the job start time will be exported. This parameter is usually paired with the `_since` parameter. | 2019-10-25T11:14:00Z |
_patient | Yes | Yes | Only resources pertaining to a specific patient/member will be included. | {"reference":"Patient/1553"} |
The following export types are supported:
Category | Description | Value |
---|---|---|
ATR |
Async export of Member Attribution List (Group, Patient, Coverage) Export the Attribution list (member/patient) to review |
hl7.fhir.us.davinci-atr |
Download |
Async export and updates the FHIR group (member attribution list) The download of the data (intent for initial and can be subsequent) |
hl7.fhir.us.davinci-pdex#provider-download |
Delta |
Async export and updates the FHIR group (member attribution list) Delta of initial to be more performant |
hl7.fhir.us.davinci-pdex#provider-delta |
Snapshot |
Async export Provides snapshot for viewing purposes |
hl7.fhir.us.davinci-pdex#provider-snapshot |
Payer-to-Payer |
Support multi-member Payer-to-Payer bulk data exchange Data exchanged is limited to data with a service date no earlier than 5 years prior to the date of the data request |
hl7.fhir.us.davinci-pdex#payertopayer |
Note that ATR, Download, Delta, and Snapshot can only be called on groups that have profile http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provider-group
, while Payer-to-payer requires groups to have the characteristic code match
under the code system http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMultiMemberMatchResultCS
.
ATR | Download | Delta | Snapshot | Payer-to-Payer | |
---|---|---|---|---|---|
patient | x | ||||
_since | x | x | * | ||
_until | x | ||||
_type | x | x | |||
_typeFilter | x | x |
- Member Attribution List automatically updated depending on these values. Each member element in the Group record, that is processed by the export operation, should be updated with the execution date/time in lastTransmitted, list of resources (resourceTypes) in lastResources and query filters (filterQueries) in lastFilters.
* limited to 5 years before current date
You are about to leave the Smile Digital Health documentation and navigate to the Open Source HAPI-FHIR Documentation.