Carequality Subscription Implementation Guide for Push Notifications
0.1.1 - CI Build
Carequality Subscription Implementation Guide for Push Notifications
0.1.1 - CI Build
Carequality Subscription Implementation Guide for Push Notifications, published by Carequality. This guide is not an authorized publication; it is the continuous build for version 0.1.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Carequality/CEQSubscription/ and changes regularly. See the Directory of published versions
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
These define constraints on FHIR resources for systems conforming to this implementation guide.
| CEQ R5 Subscription Notification Status |
Profile on the Parameters resource to enable R5-style topic-based subscription notifications in FHIR R4. |
| Carequality Notification Bundle |
This Bundle is configured as a history bundle and has at least two entries, the first is the CEQSubscriptionStatus Profile that has the basic information with the date and time the topic was triggered, number of notifications to date and, the second is the Encounter (or other, if CareGap) Resource. Display names must be present for Encounter.subject, Encounter.participant.individual and Encounter.diagnosis.condition for compliance with HHS Notification regulations or those resources must be included in the bundle. |
| Carequality Subscription Profile |
Extended Elements and Constraints Specific to the Carequality Use Case Carequality has defined a custom flow for a Subscription that removes the criteria use in favor of specific events defined as URIs. This adds requirements that the PatientID and an identifier be added to the resource. The identifier element is the endpoint id [Base]/fhir/Subscription/[identifier] A termination (Subscription.end) date is required and may not be more than 2 years from original date of subscription. A renewal may be submitted prior to expiry for a period of up to two additional years. |
These define constraints on FHIR data types for systems conforming to this implementation guide.
| Backport R5 Subscription Topic Canonical |
Canonical reference to the subscription topic being subscribed to. |
| Carequality Subscription Required Elements |
Additional Elements to Support Carequality Subscription Notifications |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
| An Example Discharge Encounter |
Example of a US Core R4 Encounter |
| CEQ-Condition |
Example Condition for the Bundle Reference |
| CQ Notification Bundle Example |
Example of the CQ Notification Bundle with a SubscriptionStatus and payload URL |
| Carequality Subscription Submission Capability Statement |
Capability Statement to describe the requirements for a Notification Recipient Actor |
| Dr. David Anydoc |
Example of a US Core R4 Practitioner |
| Eve Anyperson |
Example of a US Core R4 Patient |
| Example Encounter |
Example Encounter for use within the Example Notification Bundle |
| Example Location |
Example Location for use within the Example Encounter |
| Example Subscribing |
Example of a full Resource for a Carequality Subscription |
| SubscriptionStatus Example |
An example of the Carequality Subscription Status Profile |
| Veterinarian's Hospital |
Example of a US Core R4 Organization |