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

FHIR IG Statistics: CapabilityStatement/producer-client

Packagehl7.fhir.us.davinci-deqm
TypeCapabilityStatement
Idproducer-client
FHIR VersionR4
Sourcehttp://hl7.org/fhir/us/davinci-deqm/https://build.fhir.org/ig/HL7/davinci-deqm/CapabilityStatement-producer-client.html
URLhttp://hl7.org/fhir/us/davinci-deqm/CapabilityStatement/producer-client
Version5.0.0
Statusactive
Date2020-07-05
NameProducerClientCapabilityStatement
TitleProducer Client CapabilityStatement
Realmus
Authorityhl7
DescriptionThis profile defines the expected capabilities of a Da Vinci DEQM Producer Client when conforming to the Da Vinci DEQM Implementation Guide. Producers include systems that are primary producers of patient healthcare information. This CapabilityStatement resource includes the complete list of the *recommended* Da Vinci DEQM profiles and RESTful operations that are Da Vinci DEQM Producer Client could support. Clients have the option of choosing from this list based on their local use cases and other contextual requirements.
Kindrequirements

Resources that use this resource

No resources found

Resources that this resource uses

ImplementationGuide
hl7.fhir.us.qicoreQI-Core Implementation Guide
hl7.fhir.us.davinci-deqmData Exchange For Quality Measures Implementation Guide
hl7.fhir.us.cqfmeasuresQuality Measure Implementation Guide
OperationDefinition
bulk-submit-dataBulk Submit Data
StructureDefinition
crmi-shareablemeasureCRMI Shareable Measure
datax-measurereport-deqmDEQM Data Exchange MeasureReport Profile

Narrative

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

Generated Narrative: CapabilityStatement producer-client

Producer 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 the Submit Data transaction defined in the Framework Section of this Implementation Guide.

Security

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

Summary of System-wide Interactions
  • MAY 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 TypeProfileRSUCSearches_include_revincludeOperations
Library y
MeasureSupported Profiles
  CRMI Shareable Measure		y$data-requirements, $submit-data, $bulk-submit-data
MeasureReportSupported Profiles
  DEQM Data Exchange MeasureReport Profile		y

Resource Conformance: SHOULD Library

Core FHIR Resource
Library
Reference Policy
Interaction summary
  • SHOULD support read.

Resource Conformance: SHALL Measure

Core FHIR Resource
Measure
Reference Policy
Interaction summary
  • SHOULD support read.

Supported Profiles

CRMI Shareable Measure

Extended Operations
ConformanceOperationDocumentation
SHALL$data-requirements
SHALL$submit-data

It is the responsibility of the Producer to discover whether snapshot or incremental data exchange is supported by the inspection of the Consumer Server CapabilityStatement.

SHOULD$bulk-submit-data

It is the responsibility of the Producer to discover whether snapshot or incremental data exchange is supported by the inspection of the Consumer Server CapabilityStatement.

Resource Conformance: SHALL MeasureReport

Core FHIR Resource
MeasureReport
Reference Policy
Interaction summary
  • SHOULD support create.

Supported Profiles

DEQM Data Exchange MeasureReport Profile

Documentation
  • The DaVinci DEQM Producer Client SHALL be capable of supporting the DEQM MeasureReport Profiles and all the DEQM and QI Core Profiles they reference.
  • The required DEQM Submit Data Update Type Extension is used to indicate whether the payload is a snapshot or incremental update for both the initial transaction and subsequent updates.

Source

{
  "resourceType": "CapabilityStatement",
  "id": "producer-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/producer-client",
  "version": "5.0.0",
  "name": "ProducerClientCapabilityStatement",
  "title": "Producer 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 Producer Client when conforming to the Da Vinci DEQM Implementation Guide. Producers include systems that are primary producers of patient healthcare information.  This CapabilityStatement resource includes the complete list of the *recommended*  Da Vinci DEQM profiles and RESTful operations that are  Da Vinci DEQM Producer 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 the Submit Data transaction defined in the *Framework* Section of  this  Implementation Guide.\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": "SHOULD"
            }
          ],
          "type": "Library",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "read"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Measure",
          "supportedProfile": [
            "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablemeasure"
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "read"
            }
          ],
          "operation": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "data-requirements",
              "definition": "http://hl7.org/fhir/OperationDefinition/Measure-data-requirements"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "submit-data",
              "definition": "http://hl7.org/fhir/OperationDefinition/Measure-submit-data",
              "documentation": "It is the responsibility of the Producer to discover whether snapshot or incremental data exchange is supported by the inspection of the Consumer Server CapabilityStatement."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "bulk-submit-data",
              "definition": "http://hl7.org/fhir/us/davinci-deqm/OperationDefinition/bulk-submit-data",
              "documentation": "It is the responsibility of the Producer to discover whether snapshot or incremental data exchange is supported by the inspection of the Consumer Server CapabilityStatement."
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "MeasureReport",
          "supportedProfile": [
            "http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/datax-measurereport-deqm"
          ],
          "documentation": "- The DaVinci DEQM Producer Client **SHALL** be capable of supporting the DEQM MeasureReport Profiles and all the DEQM and QI Core Profiles they reference. \n- The required DEQM Submit Data Update Type Extension  is used to indicate whether the payload is a snapshot or incremental update for both the initial transaction and subsequent updates.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "create"
            }
          ]
        }
      ],
      "interaction": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "MAY"
            }
          ],
          "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"
        }
      ]
    }
  ]
}