XIG: CapabilityStatement/reporter-client

FHIR IG Statistics: CapabilityStatement/reporter-client

Package	hl7.fhir.us.davinci-deqm
Type	CapabilityStatement
Id	reporter-client
FHIR Version	R4
Source	http://hl7.org/fhir/us/davinci-deqm/https://build.fhir.org/ig/HL7/davinci-deqm/CapabilityStatement-reporter-client.html
URL	http://hl7.org/fhir/us/davinci-deqm/CapabilityStatement/reporter-client
Version	5.0.0
Status	active
Date	2020-07-05
Name	ReporterClientCapabilityStatement
Title	Reporter Client CapabilityStatement
Realm	us
Authority	hl7
Description	This profile defines the expected capabilities of a Da Vinci DEQM Reporter Client when conforming to the Da Vinci DEQM Implementation Guide. Reporters include systems that are primary reporters of patient healthcare information and systems that consume data from Producers. This CapabilityStatement resource includes the complete list of the recommended Da Vinci DEQM profiles and RESTful operations that a Da Vinci DEQM Reporter Client could support. Clients have the option of choosing from this list based on their local use cases and other contextual requirements.
Kind	requirements

Resources that use this resource

CapabilityStatement
NHSNCapabilityStatementEvaluationEngine	NHSN Data Evaluation Engine CapabilityStatement
SafrCapabilityStatementEvaluationEngine	US SAFR Data Evaluation Engine CapabilityStatement

Resources that this resource uses

ImplementationGuide
hl7.fhir.us.qicore	QI-Core Implementation Guide
hl7.fhir.us.davinci-deqm	Data Exchange For Quality Measures Implementation Guide
hl7.fhir.us.cqfmeasures	Quality Measure Implementation Guide

StructureDefinition
indv-measurereport-deqm	DEQM Individual MeasureReport Profile
subjectlist-measurereport-deqm	DEQM Subject List MeasureReport
summary-measurereport-deqm	DEQM Summary MeasureReport Profile

Narrative

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

Generated Narrative: CapabilityStatement reporter-client

Reporter Client CapabilityStatement

Implementation Guide Version: 5.0.0
FHIR Version: 4.0.1
Supported Formats: xml, json
Supported Patch Formats: application/json-patch+json
Published on: 2020-07-05
Published by: HL7 International / Clinical Quality Information

Note to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: `client`

Da Vinci DEQM Producer Client SHALL support at least one of the following transactions defined in the Framework Section of this Implementation Guide:

Individual Reporting
Summary Reporting

Security

For general security consideration refer to the Security and Privacy Considerations.

Summary of System-wide Interactions

SHALL support the transactioninteraction.
MAY support the batchinteraction.
MAY support the search-systeminteraction.
MAY support the history-systeminteraction.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

The relevant profiles (if any)
The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
The required, recommended, and some optional search parameters (if any).
The linked resources enabled for _include
The other resources enabled for _revinclude
The operations on the resource (if any)

Resource Type	Profile	R	S	U	C	D	Searches	`_include`	`_revinclude`	Operations
MeasureReport	Supported Profiles DEQM Summary MeasureReport Profile DEQM Individual MeasureReport Profile DEQM Subject List MeasureReport			y	y	y

Resource Conformance: SHALL MeasureReport

Core FHIR Resource
MeasureReport

Reference Policy

Interaction summary

SHALL support create.
SHOULD support update, delete.

Supported Profiles

DEQM Summary MeasureReport Profile
DEQM Individual MeasureReport Profile
DEQM Subject List MeasureReport

Documentation

The DaVinci DEQM Reporter Client SHALL be capable of supporting at least one of the DEQM MeasureReport Profiles listed above and all the DEQM, CQFM and QI Core Profiles they reference.

Source

{
  "resourceType": "CapabilityStatement",
  "id": "reporter-client",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "cqi"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 4,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/davinci-deqm/ImplementationGuide/hl7.fhir.us.davinci-deqm"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/davinci-deqm/ImplementationGuide/hl7.fhir.us.davinci-deqm"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/us/davinci-deqm/CapabilityStatement/reporter-client",
  "version": "5.0.0",
  "name": "ReporterClientCapabilityStatement",
  "title": "Reporter Client CapabilityStatement",
  "status": "active",
  "experimental": false,
  "date": "2020-07-05",
  "publisher": "HL7 International / Clinical Quality Information",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/cqi"
        }
      ]
    }
  ],
  "description": "This profile defines the expected capabilities of a Da Vinci DEQM Reporter Client when conforming to the Da Vinci DEQM Implementation Guide.  Reporters include systems that are primary reporters of patient healthcare information and systems that consume data from Producers.   This CapabilityStatement resource includes the complete list of the *recommended*  Da Vinci DEQM profiles and RESTful operations that a Da Vinci DEQM Reporter Client could support. Clients have the option of choosing from this list based on their local use cases and other contextual requirements.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "xml",
    "json"
  ],
  "patchFormat": [
    "application/json-patch+json"
  ],
  "implementationGuide": [
    "http://hl7.org/fhir/us/davinci-deqm/ImplementationGuide/hl7.fhir.us.davinci-deqm",
    "http://hl7.org/fhir/us/qicore/ImplementationGuide/hl7.fhir.us.qicore",
    "http://hl7.org/fhir/us/cqfmeasures/ImplementationGuide/hl7.fhir.us.cqfmeasures"
  ],
  "rest": [
    {
      "mode": "client",
      "documentation": "Da Vinci DEQM Producer Client **SHALL** support at least one of the following  transactions defined in the *Framework* Section of  this  Implementation Guide:\n\n- Individual Reporting\n- Summary Reporting\n\n",
      "security": {
        "description": "For general security consideration refer to the [Security and Privacy Considerations](http://hl7.org/fhir/R4/secpriv-module.html)."
      },
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "MeasureReport",
          "supportedProfile": [
            "http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/summary-measurereport-deqm",
            "http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/indv-measurereport-deqm",
            "http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/subjectlist-measurereport-deqm"
          ],
          "documentation": "The DaVinci DEQM Reporter Client **SHALL** be capable of supporting at least one of the DEQM MeasureReport Profiles listed above and all the DEQM, CQFM and QI Core Profiles they reference.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "update"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "delete"
            }
          ]
        }
      ],
      "interaction": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "code": "transaction"
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "MAY"
            }
          ],
          "code": "batch"
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "MAY"
            }
          ],
          "code": "search-system"
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "MAY"
            }
          ],
          "code": "history-system"
        }
      ]
    }
  ]
}