FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/uds-plus-data-submitter-client

Packagefhir.hrsa.uds-plus
TypeCapabilityStatement
Iduds-plus-data-submitter-client
FHIR VersionR4
Sourcehttp://fhir.org/guides/hrsa/uds-plus/http://fhir.org/guides/hrsa/uds-plus/STU2/CapabilityStatement-uds-plus-data-submitter-client.html
URLhttp://fhir.org/guides/hrsa/uds-plus/CapabilityStatement/uds-plus-data-submitter-client
Version2.0.0
Statusdraft
Date2020-12-06
NameUdsPlusDataSubmitter
TitleUds Plus Data Submitter CapabilityStatement
Realmus
Authorityhl7
DescriptionThis is a CapabilityStatement that defines the expected capabilities of the Data Submitter actor.
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

OperationDefinition
group-exportFHIR Bulk Data Group Level Export
importUDS Plus Import

Narrative

Note: links and images are rebased to the (stated) source

Data Receiver

(Requirements Definition Capability Statement)

Canonical URL: http://fhir.org/guides/hrsa/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: 4.0.1
Supported formats: 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.

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

Resource summary

Resource Search Read Read Version Instance History Resource History Create Update Delete
UDS+ profiles SHALL SHALL

FHIR Operations summary

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

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



UDS+ profiles

Profiles: All UDS+ profiles

Interactions

Name Description
  search

Search for specific UDS+ resource profile instances.

  read

Retrieve specific UDS+ resource profile instances




Source

{
  "resourceType": "CapabilityStatement",
  "id": "uds-plus-data-submitter-client",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://fhir.org/guides/hrsa/uds-plus/CapabilityStatement/uds-plus-data-submitter-client",
  "version": "2.0.0",
  "name": "UdsPlusDataSubmitter",
  "title": "Uds Plus Data Submitter CapabilityStatement",
  "status": "draft",
  "date": "2020-12-06",
  "publisher": "HRSA BPHC",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "https://bphc.hrsa.gov/"
        }
      ]
    }
  ],
  "description": "This is a CapabilityStatement that defines the expected capabilities of the Data Submitter actor.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001"
        }
      ]
    }
  ],
  "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://fhir.org/guides/hrsa/uds-plus/OperationDefinition/import"
        }
      ]
    }
  ]
}