| Page File Name | subscription-introduction.xml |
| Responsible Workgroup | fhir |
| Maturity Label | Draft |
| Maturity Level | 3 |
| Standards Status | trial-use |
| Management Comments | |
| Workgroup Comments | |
Exists In publish.ini |
No |
| Exists In Source Directory | Yes |
'deprecated' Literal Count |
0 |
| Zulip Link Count | 0 |
| Confluence Link Count | 0 |
'Conformant' conformance language appears in all-upper case. 'Non-conformant' covers all other cases appearing in the content.
| Literal | Conformant | Non-Conformant |
|---|---|---|
| SHALL | 0 | 0 |
| SHALL NOT | 0 | 0 |
| SHOULD | 0 | 0 |
| SHOULD NOT | 0 | 0 |
| MAY | 0 | 0 |
| MAY NOT | 0 | 0 |
| Word | Artifact Class |
|---|---|
SubscriptionTopic.canFilterBy | Element |
| Word | Known Typo |
|---|
| Source | Missing Alt Text | Not In Figure Tag |
|---|
| Page File Name | subscription-notes.xml |
| Responsible Workgroup | fhir |
| Maturity Label | Draft |
| Maturity Level | 3 |
| Standards Status | trial-use |
| Management Comments | |
| Workgroup Comments | |
Exists In publish.ini |
No |
| Exists In Source Directory | Yes |
'deprecated' Literal Count |
0 |
| Zulip Link Count | 0 |
| Confluence Link Count | 0 |
'Conformant' conformance language appears in all-upper case. 'Non-conformant' covers all other cases appearing in the content.
| Literal | Conformant | Non-Conformant |
|---|---|---|
| SHALL | 16 | 0 |
| SHALL NOT | 4 | 0 |
| SHOULD | 11 | 10 |
| SHOULD NOT | 0 | 0 |
| MAY | 14 | 18 |
| MAY NOT | 0 | 0 |
| Word | Artifact Class |
|---|
| Word | Known Typo |
|---|---|
'secure-mq' | No |
JWT | No |
channelType | No |
desireable | Yes |
filterBy.resourceType | No |
heartbeatPeriod | No |
wss:// | No |
| Source | Missing Alt Text | Not In Figure Tag |
|---|---|---|
subscription-channel-email.svg | Yes | No |
subscription-channel-messaging.svg | Yes | No |
subscription-channel-rest-hook.svg | Yes | No |
subscription-channel-websocket.svg | Yes | No |
| Path | Is Required | Not Array | Trial Use | Has fixed[x] | Has pattern[x] | Required Binding | External Required Binding | Check meaningWhenMissing |
Is Modifier |
|---|---|---|---|---|---|---|---|---|---|
Subscription |
X | |
|||||||
Subscription.identifier |
X | |
|||||||
Subscription.name |
|
||||||||
Subscription.status |
X | NO 'other' or 'unknown' | |
X | |||||
Subscription.topic |
X | |
|||||||
Subscription.contact |
X | |
|||||||
Subscription.end |
|
||||||||
Subscription.managingEntity |
|
||||||||
Subscription.reason |
|
||||||||
Subscription.filterBy |
X | |
|||||||
Subscription.filterBy.resource |
|
||||||||
Subscription.filterBy.filterParameter |
X | |
|||||||
Subscription.filterBy.comparator |
optional - NO 'other' or 'unknown' | |
X | ||||||
Subscription.filterBy.modifier |
optional - NO 'other' or 'unknown' | |
X | ||||||
Subscription.filterBy.value |
X | |
|||||||
Subscription.filterBy.event |
X | |
|||||||
Subscription.channelType |
X | |
|||||||
Subscription.endpoint |
|
||||||||
Subscription.parameter |
X | |
|||||||
Subscription.parameter.name |
X | |
|||||||
Subscription.parameter.value |
X | |
|||||||
Subscription.heartbeatPeriod |
|
||||||||
Subscription.timeout |
|
||||||||
Subscription.contentType |
optional - NO 'other' or 'unknown' | |
X | ||||||
Subscription.content |
optional - NO 'other' or 'unknown' | |
X | ||||||
Subscription.maxCount |
|
| Id | Name | Publication Status | FMM | Standards Status | IsExperimental | Workgroup | Description |
|---|---|---|---|---|---|---|---|
Subscription-events |
Events |
Draft | 0 | trial-use | False | fhir | This operation is used to search for and return notifications that have been previously triggered by a topic-based Subscription. |
Subscription-get-ws-binding-token |
GetWsBindingToken |
Draft | 2 | trial-use | False | fhir | This operation is used to get a token for a websocket client to use in order to bind to one or more subscriptions. |
Subscription-status |
Status |
Draft | 2 | trial-use | False | fhir | This operation is used to return the current status information about one or more topic-based Subscriptions. |
| Id | Name | Publication Status | FMM | Standards Status | IsExperimental | WorkGroup | Search Type | Description |
|---|---|---|---|---|---|---|---|---|
Subscription-contact |
contact |
Draft | trial-use | False | fhir | token | Contact details for the subscription | |
Subscription-content-level |
content-level |
Draft | trial-use | False | fhir | token | Content level included in notifications | |
Subscription-filter-event |
filter-event |
Draft | trial-use | False | fhir | token | Filter event used to narrow notifications | |
Subscription-filter-value |
filter-value |
Draft | trial-use | False | fhir | string | Filter value used to narrow notifications | |
Subscription-identifier |
identifier |
Draft | trial-use | False | fhir | token | A subscription identifier | |
Subscription-name |
name |
Draft | trial-use | False | fhir | string | A human-readable name | |
Subscription-owner |
owner |
Draft | trial-use | False | fhir | reference | The managing entity | |
Subscription-payload |
payload |
Active | trial-use | False | fhir | token | The mime-type of notifications | |
Subscription-status |
status |
Draft | trial-use | False | fhir | token | The current state of the subscription | |
Subscription-topic |
topic |
Draft | trial-use | False | fhir | uri | The canonical topic url that triggers notifications | |
Subscription-type |
type |
Draft | trial-use | False | fhir | token | The type of channel for the sent notifications | |
Subscription-url |
url |
Draft | trial-use | False | fhir | uri | The uri that will receive the notifications |