Data Exchange For Quality Measures R4 Artifacts Implementation Guide: STU1 Ballot 1 (for FHIR 3.5.0)

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

StructureDefinition-subscription-deqm

​The DEQM Subscription Profile is defined for sending notifications to a subscriber (Aggregator) when a Provider system has determined the DEQM Measure data is ready as is described in the exchange of quality measure data option 3.

Mandatory Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present).

Each Subscription must have:

  1. The Measure Subscription modifier extension

Additional Profile specific implementation guidance:

  • This profile adds a modifier extension to modify the value of the criteria element to a DEQM Measure instance id.
  • ​By invoking the $data-requirements operation on a subscriber’s (Aggregator) endpoint for the Measure instance specified in criteria , the server can discover what data is needed to calculate that particular measure.
  • The system sends a notification to the subscriber, if it has determined that it has the requisite measure data the subscriber needs for the measure, or if the information has been updated. None

Examples

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/subscription-deqm

Published on Tue Jun 19 00:00:00 AEST 2018 as a active by Da Vinci Project.

This profile builds on Subscription

Summary

Must-Support: 1 element

Extensions

This structure refers to these extensions:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription I0..*Server push subscription criteria
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension-measureSubscription ?!SI0..*codeExtension
URL: http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/extension-measureSubscription
Binding: PublicationStatus (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1coderequested | active | error | off
Binding: SubscriptionStatus (required)
... contact Σ0..*ContactPointContact details for source (e.g. troubleshooting)
... end Σ0..1instantWhen to automatically delete the subscription
... reason Σ1..1stringDescription of why this subscription was created
... criteria Σ1..1stringRule for server push
... error Σ0..1stringLatest error note
... channel ΣI1..1BackboneElementThe channel on which to report matches to the criteria
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... type Σ1..1coderest-hook | websocket | email | sms | message
Binding: SubscriptionChannelType (required)
.... endpoint Σ0..1urlWhere the channel points to
.... payload Σ0..1stringMIME type to send, or omit for no payload
.... header Σ0..*stringUsage depends on the channel type
... tag Σ0..*CodingA tag to add to matching resources
Binding: SubscriptionTag (example)

doco Documentation for this format

Summary

Must-Support: 1 element

Extensions

This structure refers to these extensions:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription I0..*Server push subscription criteria
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension-measureSubscription ?!SI0..*codeExtension
URL: http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/extension-measureSubscription
Binding: PublicationStatus (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1coderequested | active | error | off
Binding: SubscriptionStatus (required)
... contact Σ0..*ContactPointContact details for source (e.g. troubleshooting)
... end Σ0..1instantWhen to automatically delete the subscription
... reason Σ1..1stringDescription of why this subscription was created
... criteria Σ1..1stringRule for server push
... error Σ0..1stringLatest error note
... channel ΣI1..1BackboneElementThe channel on which to report matches to the criteria
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... type Σ1..1coderest-hook | websocket | email | sms | message
Binding: SubscriptionChannelType (required)
.... endpoint Σ0..1urlWhere the channel points to
.... payload Σ0..1stringMIME type to send, or omit for no payload
.... header Σ0..*stringUsage depends on the channel type
... tag Σ0..*CodingA tag to add to matching resources
Binding: SubscriptionTag (example)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron


Quick Start

Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.

Use cases:

  • currently none defined