Carequality Subscription Implementation Guide for Push Notifications
1.0.0 - CI Build
Carequality Subscription Implementation Guide for Push Notifications
1.0.0 - CI Build
This page is part of the Carequality Subscription Implementation Guide for Push Notifications (v1.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: https://carequality.org/IG/push-notifications/StructureDefinition/CEQextension | Version: 1.0.0 | |||
| Draft as of 2024-12-18 | Computable Name: CEQextension | |||
Additional Elements to Support Carequality Subscription Notifications
Context of Use
This extension may be used on the following element(s):
Usage info
Usage:
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension |
0..* | Extension | Carequality Subscription Required Elements | |
  extension |
5..* | Extension | Extension | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:subIdentifier |
S | 1..1 | Extension | A Business Identifier |
  extension |
0..0 | |||
| url |
1..1 | uri | "subIdentifier" | |
  value[x] |
0..1 | string | Value of extension | |
| extension:searchParamName |
1..1 | Extension | Filter label | |
| extension |
0..0 | |||
| url |
1..1 | uri | "searchParamName" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:searchModifier |
1..1 | Extension | = | eq | ne | gt | lt | ge | le | sa | eb | ap | above | below | in | not-in | of-type | |
| extension |
0..0 | |||
| url |
1..1 | uri | "searchModifier" | |
| value[x] |
0..1 | code | Value of extension | |
| extension:endUser |
1..1 | Extension | End recipient of the notification | |
| extension |
0..0 | |||
| url |
1..1 | uri | "endUser" | |
| value[x] |
0..1 | string | Value of extension | |
 extension:CQOrganization |
1..1 | Extension | Recipient CQ Directory Reference | |
 extension |
0..0 | |||
| url |
1..1 | uri | "CQOrganization" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "https://carequality.org/IG/push-notifications/StructureDefinition/CEQextension" | |
 value[x] |
0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension |
0..* | Extension | Carequality Subscription Required Elements | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
5..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:subIdentifier |
S | 1..1 | Extension | A Business Identifier |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "subIdentifier" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:searchParamName |
1..1 | Extension | Filter label | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "searchParamName" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:searchModifier |
1..1 | Extension | = | eq | ne | gt | lt | ge | le | sa | eb | ap | above | below | in | not-in | of-type | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "searchModifier" | |
| value[x] |
0..1 | code | Value of extension | |
| extension:endUser |
1..1 | Extension | End recipient of the notification | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "endUser" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:CQOrganization |
1..1 | Extension | Recipient CQ Directory Reference | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "CQOrganization" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "https://carequality.org/IG/push-notifications/StructureDefinition/CEQextension" | |
| Documentation for this format | ||||
This structure is derived from Extension
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension |
0..* | Extension | Carequality Subscription Required Elements | |
| extension |
5..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:subIdentifier |
S | 1..1 | Extension | A Business Identifier |
| extension |
0..0 | |||
| url |
1..1 | uri | "subIdentifier" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:searchParamName |
1..1 | Extension | Filter label | |
| extension |
0..0 | |||
| url |
1..1 | uri | "searchParamName" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:searchModifier |
1..1 | Extension | = | eq | ne | gt | lt | ge | le | sa | eb | ap | above | below | in | not-in | of-type | |
| extension |
0..0 | |||
| url |
1..1 | uri | "searchModifier" | |
| value[x] |
0..1 | code | Value of extension | |
| extension:endUser |
1..1 | Extension | End recipient of the notification | |
| extension |
0..0 | |||
| url |
1..1 | uri | "endUser" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:CQOrganization |
1..1 | Extension | Recipient CQ Directory Reference | |
| extension |
0..0 | |||
| url |
1..1 | uri | "CQOrganization" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "https://carequality.org/IG/push-notifications/StructureDefinition/CEQextension" | |
| value[x] |
0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension |
0..* | Extension | Carequality Subscription Required Elements | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
5..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:subIdentifier |
S | 1..1 | Extension | A Business Identifier |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "subIdentifier" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:searchParamName |
1..1 | Extension | Filter label | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "searchParamName" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:searchModifier |
1..1 | Extension | = | eq | ne | gt | lt | ge | le | sa | eb | ap | above | below | in | not-in | of-type | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "searchModifier" | |
| value[x] |
0..1 | code | Value of extension | |
| extension:endUser |
1..1 | Extension | End recipient of the notification | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "endUser" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:CQOrganization |
1..1 | Extension | Recipient CQ Directory Reference | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "CQOrganization" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "https://carequality.org/IG/push-notifications/StructureDefinition/CEQextension" | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |