Data Exchange For Quality Measures STU2 for FHIR R4
2.0.0 - STU2 Release

This page is part of the Da Vinci Data Exchange for Quality Measures (DEQM) FHIR IG (v2.0.0: STU 2) based on FHIR R4. The current version which supercedes this version is 3.1.0. For a full list of available versions, see the Directory of published versions

: Consumer Server CapabilityStatement - TTL Representation

Raw ttl | Download

@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

 a fhir:CapabilityStatement;
  fhir:nodeRole fhir:treeRoot;
  fhir:Resource.id [ fhir:value "consumer-server"];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ];
     fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">Consumer Server CapabilityStatement</h2><ul><li>Implementation Guide Version: 2.0.0</li><li>FHIR Version: 4.0.1</li><li>Supported formats: xml, json</li><li>Published: 2020-07-05</li><li>Published by: HL7 International - Clinical Quality Information Work Group</li></ul><p><p>This profile defines the expected capabilities of a Da Vinci DEQM Consumer Server when conforming to the Da Vinci DEQM Implementation Guide.  Consumers include systems that are primary consumers of patient healthcare information and systems that consume data from Producers.  This CapabilityStatement resource includes the complete list of the <em>recommended</em>  Da Vinci DEQM profiles and RESTful operations that a Da Vinci DEQM Consumer Server could support. Servers have the option of choosing from this list based on their local use cases and other contextual requirements.</p></p><h3 id=\"igs\" class=\"no_toc\">SHALL Support the Following Implementation Guides:</h3><ul><li><a href=\"http://hl7.org/fhir/us/qicore/ImplementationGuide/hl7.fhir.us.qicore%7C4.0.0\">http://hl7.org/fhir/us/qicore/ImplementationGuide/hl7.fhir.us.qicore|4.0.0</a></li></ul><ul><li><a href=\"http://hl7.org/fhir/us/cqfmeasures/ImplementationGuide/hl7.fhir.us.cqfmeasures%7C2.0.0\">http://hl7.org/fhir/us/cqfmeasures/ImplementationGuide/hl7.fhir.us.cqfmeasures|2.0.0</a></li></ul><h3 id=\"behavior\">FHIR RESTful Capabilities</h3><p>Da Vinci DEQM Consumer Server <strong>SHALL</strong></p><ol><li>Support the Submit Data transaction defined in the <em>Framework</em> Section of  this  Implementation Guide.</li><li>Declare a CapabilityStatement identifying the list of supported profiles and operations.\n<ul><li>Use the <a href=\"http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/extension-submitDataUpdateType\">DEQM Submit Data Update Type Extension</a> to indicate whether it whether it supports snapshot or incremental data exchange.</li></ul>\n</li><li>Implement the FHIR RESTful API for operations including returning the appropriate response classes as described in the FHIR specification for <a href=\"http://hl7.org/fhir/R4/operations.html\">Extended Operations on the RESTful API </a>.</li><li>Support both xml and json resource formats for all interactions.</li></ol><p id=\"security\"><strong>Security:</strong></p><p>For general security consideration refer to the <a href=\"http://hl7.org/fhir/R4/secpriv-module.html\">Security and Privacy Considerations</a>.</p><p><strong>Summary of System Wide Interactions</strong></p><li><strong>MAY</strong> support the	<code>transaction</code> interaction.</li><li><strong>MAY</strong> support the	<code>batch</code> interaction.</li><li><strong>MAY</strong> support the	<code>search-system</code> interaction.</li><li><strong>MAY</strong> support the	<code>history-system</code> interaction.</li><h3 id=\"resource--details\" class=\"no_toc\">RESTful Capabilities by Resource/Profile:</h3><p><strong>Summary of Search Criteria</strong></p><table class=\"grid\"><thead><tr><th>Resource Type</th><th>Supported Profiles</th><th>Supported Searches</th><th>Supported <code>_includes</code></th><th>Supported <code>_revincludes</code></th><th>Supported Operations</th></tr></thead><tbody><tr><td><a href=\"#measure\">Measure</a></td><td><a href=\"http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/measure-cqfm\">CQFM Measure</a></td><td>\n							\n						</td><td>\n							\n						</td><td>\n              \n            </td><td>\n							data-requirements, submit-data\n						</td></tr></tbody></table><br/><h4 id=\"measure\" class=\"no_toc\">Measure</h4><p>Conformance Expectation:	<strong>SHALL</strong></p><p>Supported Profiles:\n				\n											<a href=\"http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/measure-cqfm\">CQFM Measure</a>\n				\n				</p><p>Profile Interaction Summary:</p><ul><li><strong>SHOULD</strong> support \n																							<code>read</code>.</li></ul><p>Operation  Summary:</p><ul><li><strong>SHALL</strong> support the \n																								<a href=\"http://hl7.org/fhir/OperationDefinition/Measure-data-requirements\">$data-requirements</a> operation\n																								, \n																								<a href=\"http://hl7.org/fhir/OperationDefinition/Measure-submit-data\">$submit-data</a> operation\n																								<p><p><strong>SHALL</strong> Use the <a href=\"http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/extension-submitDataUpdateType\">DEQM Submit Data Update Type Extension</a> to indicate whether it whether it supports snapshot or incremental data exchange.  <strong>SHALL</strong> reject the submit data payload if there is mismatch between the Consumer’s stated capabilities and the required modifier extension by returning a 400 Bad Request http error code. An OperationOutcome <strong>SHOULD</strong> be returned stating that the [snapshot/incremental] update is not supported .</p></p></li></ul><p>Fetch and Search Criteria:</p><ul><li>\n					A Server <strong>SHOULD</strong> be capable of returning a Measure resource using:\n					<br/>\n						<code class=\"highlighter-rouge\">GET [base]/Measure/[id]</code>\n				</li><br/>  <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet -->  <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr/><br/></div>"
  ];
  fhir:CapabilityStatement.url [ fhir:value "http://hl7.org/fhir/us/davinci-deqm/CapabilityStatement/consumer-server"];
  fhir:CapabilityStatement.version [ fhir:value "2.0.0"];
  fhir:CapabilityStatement.name [ fhir:value "ConsumerServerCapabilityStatement"];
  fhir:CapabilityStatement.title [ fhir:value "Consumer Server CapabilityStatement"];
  fhir:CapabilityStatement.status [ fhir:value "active"];
  fhir:CapabilityStatement.experimental [ fhir:value "false"^^xsd:boolean];
  fhir:CapabilityStatement.date [ fhir:value "2020-07-05"^^xsd:date];
  fhir:CapabilityStatement.publisher [ fhir:value "HL7 International - Clinical Quality Information Work Group"];
  fhir:CapabilityStatement.contact [
     fhir:index 0;
     fhir:ContactDetail.telecom [
       fhir:index 0;
       fhir:ContactPoint.system [ fhir:value "url" ];
       fhir:ContactPoint.value [ fhir:value "http://www.hl7.org/Special/committees/cqi/index.cfm" ]     ]
  ];
  fhir:CapabilityStatement.description [ fhir:value "This profile defines the expected capabilities of a Da Vinci DEQM Consumer Server when conforming to the Da Vinci DEQM Implementation Guide.  Consumers include systems that are primary consumers 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 Consumer Server could support. Servers have the option of choosing from this list based on their local use cases and other contextual requirements."];
  fhir:CapabilityStatement.jurisdiction [
     fhir:index 0;
     fhir:CodeableConcept.coding [
       fhir:index 0;
       fhir:Coding.system [ fhir:value "urn:iso:std:iso:3166" ];
       fhir:Coding.code [ fhir:value "US" ]     ]
  ];
  fhir:CapabilityStatement.kind [ fhir:value "requirements"];
  fhir:CapabilityStatement.fhirVersion [ fhir:value "4.0.1"];
  fhir:CapabilityStatement.format [
     fhir:value "xml";
     fhir:index 0
  ], [
     fhir:value "json";
     fhir:index 1
  ];
  fhir:CapabilityStatement.patchFormat [
     fhir:value "application/json-patch+json";
     fhir:index 0
  ];
  fhir:CapabilityStatement.implementationGuide [
     fhir:value "http://hl7.org/fhir/us/davinci-deqm/ImplementationGuide/hl7.fhir.us.davinci-deqm|2.0.0";
     fhir:index 0;
     fhir:link <http://hl7.org/fhir/us/davinci-deqm/ImplementationGuide/hl7.fhir.us.davinci-deqm|2.0.0>
  ], [
     fhir:value "http://hl7.org/fhir/us/qicore/ImplementationGuide/hl7.fhir.us.qicore|4.0.0";
     fhir:index 1;
     fhir:link <http://hl7.org/fhir/us/qicore/ImplementationGuide/hl7.fhir.us.qicore|4.0.0>
  ], [
     fhir:value "http://hl7.org/fhir/us/cqfmeasures/ImplementationGuide/hl7.fhir.us.cqfmeasures|2.0.0";
     fhir:index 2;
     fhir:link <http://hl7.org/fhir/us/cqfmeasures/ImplementationGuide/hl7.fhir.us.cqfmeasures|2.0.0>
  ];
  fhir:CapabilityStatement.rest [
     fhir:index 0;
     fhir:CapabilityStatement.rest.mode [ fhir:value "server" ];
     fhir:CapabilityStatement.rest.documentation [ fhir:value "Da Vinci DEQM Consumer Server **SHALL**\n\n1. Support the Submit Data transaction defined in the *Framework* Section of  this  Implementation Guide.\n1. Declare a CapabilityStatement identifying the list of supported profiles and operations.\n   - Use the [DEQM Submit Data Update Type Extension](http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/extension-submitDataUpdateType) to indicate whether it whether it supports snapshot or incremental data exchange.\n1. Implement the FHIR RESTful API for operations including returning the appropriate response classes as described in the FHIR specification for [Extended Operations on the RESTful API ](http://hl7.org/fhir/R4/operations.html).\n1. Support both xml and json resource formats for all interactions." ];
     fhir:CapabilityStatement.rest.security [
       fhir:CapabilityStatement.rest.security.description [ fhir:value "For general security consideration refer to the [Security and Privacy Considerations](http://hl7.org/fhir/R4/secpriv-module.html)." ]     ];
     fhir:CapabilityStatement.rest.resource [
       fhir:index 0;
       fhir:Element.extension [
         fhir:index 0;
         fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
         fhir:Extension.valueCode [ fhir:value "SHALL" ]       ];
       fhir:CapabilityStatement.rest.resource.type [ fhir:value "Measure" ];
       fhir:CapabilityStatement.rest.resource.supportedProfile [
         fhir:value "http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/measure-cqfm";
         fhir:index 0;
         fhir:link <http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/measure-cqfm>       ];
       fhir:CapabilityStatement.rest.resource.interaction [
         fhir:index 0;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHOULD" ]         ];
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "read" ]       ];
       fhir:CapabilityStatement.rest.resource.operation [
         fhir:index 0;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHALL" ]         ];
         fhir:CapabilityStatement.rest.resource.operation.name [ fhir:value "data-requirements" ];
         fhir:CapabilityStatement.rest.resource.operation.definition [
           fhir:value "http://hl7.org/fhir/OperationDefinition/Measure-data-requirements";
           fhir:link <http://hl7.org/fhir/OperationDefinition/Measure-data-requirements>         ]       ], [
         fhir:index 1;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHALL" ]         ], [
           fhir:index 1;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/extension-submitDataUpdateType" ];
           fhir:Extension.valueCode [ fhir:value "incremental" ]         ];
         fhir:CapabilityStatement.rest.resource.operation.name [ fhir:value "submit-data" ];
         fhir:CapabilityStatement.rest.resource.operation.definition [
           fhir:value "http://hl7.org/fhir/OperationDefinition/Measure-submit-data";
           fhir:link <http://hl7.org/fhir/OperationDefinition/Measure-submit-data>         ];
         fhir:CapabilityStatement.rest.resource.operation.documentation [ fhir:value "**SHALL** Use the [DEQM Submit Data Update Type Extension](http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/extension-submitDataUpdateType) to indicate whether it whether it supports snapshot or incremental data exchange.  **SHALL** reject the submit data payload if there is mismatch between the Consumer’s stated capabilities and the required modifier extension by returning a 400 Bad Request http error code. An OperationOutcome **SHOULD** be returned stating that the [snapshot/incremental] update is not supported ." ]       ]     ];
     fhir:CapabilityStatement.rest.interaction [
       fhir:index 0;
       fhir:Element.extension [
         fhir:index 0;
         fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
         fhir:Extension.valueCode [ fhir:value "MAY" ]       ];
       fhir:CapabilityStatement.rest.interaction.code [ fhir:value "transaction" ]     ], [
       fhir:index 1;
       fhir:Element.extension [
         fhir:index 0;
         fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
         fhir:Extension.valueCode [ fhir:value "MAY" ]       ];
       fhir:CapabilityStatement.rest.interaction.code [ fhir:value "batch" ]     ], [
       fhir:index 2;
       fhir:Element.extension [
         fhir:index 0;
         fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
         fhir:Extension.valueCode [ fhir:value "MAY" ]       ];
       fhir:CapabilityStatement.rest.interaction.code [ fhir:value "search-system" ]     ], [
       fhir:index 3;
       fhir:Element.extension [
         fhir:index 0;
         fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
         fhir:Extension.valueCode [ fhir:value "MAY" ]       ];
       fhir:CapabilityStatement.rest.interaction.code [ fhir:value "history-system" ]     ]
  ].

# - ontology header ------------------------------------------------------------

 a owl:Ontology;
  owl:imports fhir:fhir.ttl.