Da Vinci - Member Attribution (ATR) List
2.1.0-preview - STU 2.0.0 United States of America flag

Da Vinci - Member Attribution (ATR) List, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.1.0-preview built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-atr/ and changes regularly. See the Directory of published versions

OperationDefinition: DaVinci Data Export

Official URL: http://hl7.org/fhir/us/davinci-atr/OperationDefinition/davinci-data-export Version: 2.1.0-preview
Active as of 2021-07-22 Computable Name: DaVinciDataExport

Exports data about members of the Group

Introduction

This operation is a profiled version of the Bulk Data Export Operation). The parameters defined in the base Bulk Data Export operation are reused in this specification.

The operation is being proposed as a generic export mechanism for multiple DaVinci use cases. Each use case will define the specific content to be exported using the export operation. The davinci-data-export operation is being defined to allow the flexibility to DaVinci use cases to specify the type of content that needs to be exported. The existing $export in the Bulk Data IG limits the exporting of data to the Patient Compartment and a server implementing $export cannot change the content being returned for each use case unless the variations are specified in the Bulk Data export parameters. Similar to any FHIR operation, Consumers need to obtain authorization to successfully invoke the operation.

Each DaVinci use case as part of its implementation guide can define the exportType parameter and the behavior expected. For Member Attribution List (ATR) IG, this is specified in the davinci-data-export requirements.

Producers SHALL return values from the operation as per the FHIR Operation Response Specification

Generated Narrative: OperationDefinition davinci-data-export

URL: [base]/Group/[id]/$davinci-data-export

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INpatient0..*Reference

The Members whose data has to be exported, when omitted the data about all members in the Group should be exported. The references are pointing to resources in the FHIR Server supporting the davinci-data-export operation. The server will ignore invalid references to patients or if the patients are not part of the Group. For each member that is invalid or ignored an operation outcome has to be returned detailing the specific error.This parameter is exactly the same parameter defined in the latest Bulk Data Export operation.

INexportType0..1canonical

The code that indicates the type of export to be performed. For e.g hl7.fhir.us.davinci-atr to indicate Member Attribution export, and hl7.fhir.us.davinci-pdex for a PDex Export. Servers are supposed to provide the export guidance in the individual IGs. This is a new parameter added to the operation that is not present in the Bulk Data Export operation.

IN_since0..1instant

Resources updated after the specified time will be included in the response. When omitted, the Server is free to export all data for the members. This parameter is exactly the same parameter defined in the Bulk Data Export operation.

IN_until0..1instant

Resources updated before the specified time will be included in the response. When omitted, the Server is free to export all data for the members until the time the export operation is started. This is a new parameter added to the operation that is not present in the Bulk Data Export operation.

IN_type0..1string

The resources that need to be extracted for the patients. This is a string of comma-delimited FHIR resource types. This is the same parameter defined in the Bulk Data Export operation specification. This parameter is exactly the same parameter defined in the Bulk Data Export operation.

IN_typeFilter0..1string

The list of Queries that need to be executed for the resources to be exported. This will allow the consumer to limit the data being exported. This is a string of comma delimited FHIR REST queries. This parameter is exactly the same parameter defined in the latest Bulk Data Export operation.