# Uds Plus Data Submitter CapabilityStatement - De-Identified, Anonymized FHIR Profiles Library v0.1.0

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **Uds Plus Data Submitter CapabilityStatement**

## CapabilityStatement: Uds Plus Data Submitter CapabilityStatement 

| | | |
| :--- | :--- | :--- |
| *Official URL*:http://hl7.org/fhir/us/uds-plus/CapabilityStatement/uds-plus-data-submitter-client | *Version*:0.1.0 | |
| * Standards status: *[Trial-use](http://hl7.org/fhir/R4/versions.html#std-process) | [Maturity Level](http://hl7.org/fhir/versions.html#maturity): 1 | *Computable Name*:UdsPlusDataSubmitter |

 
This is a CapabilityStatement that defines the expected capabilities of the Data Submitter actor. 

 [Raw OpenAPI-Swagger Definition file](uds-plus-data-submitter-client.openapi.json) | [Download](uds-plus-data-submitter-client.openapi.json) 

## Data Receiver

(Requirements Definition Capability Statement)

Canonical URL: http://hl7.org/fhir/us/uds-plus/CapabilityStatement/uds-plus-data-submitter-client

Published by: **HL7 International - Public Health Work Group** 

This is a CapabilityStatement that defines the expected capabilities of the Data Submitter actor as a client. 

## General

* FHIR Version:: Supported formats:
  * 4.0.1: json

## REST behavior

The primary focus of the Data Submitter actor as a client is to invoke the Group/$export operation identified below and extract the UDS+ data using US Core and QI Core profiles. In certain cases, the Data Submitter MAY have to invoke individual patient api's to extract the necessary UDS+ data when the Data Source does not support Group/$export operation. data. 

 **Security:** 

Implementations must meet the general security requirements documented in FHIR [Security guidance](http://hl7.org/fhir/security.html).

In addition the Data Submitter actor as a client needs to meet the security requirements as outlined in the [SMART on FHIR Backend Services Authorization](spec.md#smart-on-fhir-backend-services-authorization)

### Resource summary

* US Core data APIs and Data elements: QI Core data APIs and Data elements
  * [SHALL](#USCore-search-type): [SHALL](#QICore-search-type)
  * [SHALL](#USCore-read): [SHALL](#QICore-read)
  * : 
  * : 
  * : 
  * : 
  * : 
  * : 

### FHIR Operations summary

As a client, the Data Submitter has to be capable of invoking the below operation on the Data Source.

*  [Bulk Data Export ([BaseURL]/Group/[Id]/$export)](http://hl7.org/fhir/uv/bulkdata/OperationDefinition-group-export.html) 

As a client, the Data Submitter has to be capable of invoking the below operation on the Data Receiver to submit the manifest file.

*  [Bulk Data Import ([BaseURL]/$import)](http://hl7.org/fhir/us/uds-plus/OperationDefinition-import.html) 

###  US Core APIs and data elements 

Profiles: All US Core profiles 

#### Interactions

*  search:  read
  * Search for specific US Core resource profile instances.: Retrieve specific US Core resource profile instances

###  QI Core data elements 

Profiles: All QI Core profiles 

#### Interactions

*  search:  read
  * Search for specific QI Core resource profile instances.: Retrieve QI Core resource profile instances



## Resource Content

```json
{
  "resourceType" : "CapabilityStatement",
  "id" : "uds-plus-data-submitter-client",
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "cgp"
  }],
  "url" : "http://hl7.org/fhir/us/uds-plus/CapabilityStatement/uds-plus-data-submitter-client",
  "version" : "0.1.0",
  "name" : "UdsPlusDataSubmitter",
  "title" : "Uds Plus Data Submitter CapabilityStatement",
  "status" : "draft",
  "date" : "2020-12-06",
  "publisher" : "HL7 International / Cross Group Projects",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/cgp"
    }]
  }],
  "description" : "This is a CapabilityStatement that defines the expected capabilities of the Data Submitter actor.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "US"
    }]
  }],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : ["json"],
  "rest" : [{
    "mode" : "client",
    "documentation" : "The primary focus of the Data Submitter is to invoke the Group/[id]/$export operation and gather the UDS+ data using US Core and QI Core profiles.",
    "security" : {
      "description" : "Implementations must meet the general security requirements documented in the security section of the implementation guide."
    },
    "operation" : [{
      "name" : "export",
      "definition" : "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/group-export"
    },
    {
      "name" : "import",
      "definition" : "http://hl7.org/fhir/us/uds-plus/OperationDefinition/import"
    }]
  }]
}

```
