Fact Of Death Direct Enquiry Response Implementation Guide
0.1.0 - ci-build
Fact Of Death Direct Enquiry Response Implementation Guide
0.1.0 - ci-build
Fact Of Death Direct Enquiry Response Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://onyxhealth.io/fhir/fodder/StructureDefinition/fodder-deceased-patient-subscription | Version: 0.1.0 | |||
| Draft as of 2026-04-26 | Computable Name: DeceasedPatientSubscription | |||
A Subscription profile (R5 backport on R4) by which a client registers interest in mortality notifications for one or more known patient identifiers. The Subscription SHALL reference the FODDER Deceased Patient Identified SubscriptionTopic in Subscription.criteria, SHALL declare at least one filterCriteria on Subscription.criteria, SHALL use channel type rest-hook, and SHALL request payload content id-only. Upon receiving a notification, the subscriber retrieves the matched Patient via GET Patient/{id} from the FODDER server.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Subscription |
0..* | BackportSubscription | Server push subscription criteria | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!SΣ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. |
| reason |
SΣ | 1..1 | string | Description of why this subscription was created |
 criteria |
SΣC | 1..1 | string | Canonical URL for the topic used to generate events Constraints: fodder-criteria-topic |
   Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:filterCriteria |
SΣ | 1..* | string | Backported R5 FilterBy Criteria URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria |
 channel |
Σ | 1..1 | BackboneElement | The channel on which to report matches to the criteria |
 Slices for extension |
Content/Rules for all slices | |||
 extension:heartbeatPeriod |
S | 0..1 | unsignedInt | Backport R5 Subscription Heartbeat Period URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period |
| extension:timeout |
0..1 | unsignedInt | Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout | |
| extension:maxCount |
0..1 | positiveInt | Maximum number of triggering resources included in notification bundles URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
SΣ | 1..1 | code | rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. Fixed Value: rest-hook |
| Slices for extension |
Content/Rules for all slices | |||
| extension:customChannelType |
SΣ | 0..1 | Coding | Extended channel type for notifications URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type |
| endpoint |
SΣ | 1..1 | url | Where the channel points to |
| payload |
SΣC | 1..1 | code | MIME type to send, or omit for no payload Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Constraints: fodder-payload-mime |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
 extension:content |
SΣ | 1..1 | (Complex) | Backport R5 Subscription Payload Content Information URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content |
 extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content" | |
 Slices for value[x] |
0..1 | code | Notification content level Slice: Unordered, Closed by type:$this | |
| value[x]:valueCode |
0..1 | code | Value of extension Binding: Backported R5 Subscription Content Value Set (required) Fixed Value: id-only | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Subscription.status | Base | required | SubscriptionStatus | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Subscription.channel.type | Base | required | SubscriptionChannelType | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Subscription.channel.payload | Base | required | MimeType | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Subscription.channel.payload.extension:content.value[x]:valueCode | Base | required | Backported R5 Subscription Content Value Set | 📦1.1.0 | Subscriptions R5 Backport v1.1 |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Subscription | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Subscription | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Subscription | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Subscription | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Subscription | A resource should have narrative for robust management |
text.`div`.exists()
|
| 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()
|
| fodder-criteria-topic | error | Subscription.criteria | Subscription.criteria SHALL be the FODDER Deceased Patient Identified SubscriptionTopic canonical URL. |
$this = 'https://onyxhealth.io/fhir/fodder/SubscriptionTopic/deceased-patient-identified'
|
| fodder-payload-mime | error | Subscription.channel.payload | Subscription.channel.payload SHALL be 'application/fhir+json'. |
$this = 'application/fhir+json'
|
This structure is derived from BackportSubscription
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Subscription |
0..* | BackportSubscription | Server push subscription criteria | |
 status |
S | 1..1 | code | requested | active | error | off |
| reason |
S | 1..1 | string | Description of why this subscription was created |
| criteria |
C | 1..1 | string | Canonical URL for the topic used to generate events Constraints: fodder-criteria-topic |
| extension |
1..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:filterCriteria |
1..* | BackportFilterCriteria | Backported R5 FilterBy Criteria | |
| channel |
||||
| Slices for extension |
Content/Rules for all slices | |||
| extension:heartbeatPeriod |
S | 0..1 | BackportHeartbeatPeriod | Backport R5 Subscription Heartbeat Period |
| type |
S | 1..1 | code | rest-hook | websocket | email | sms | message Fixed Value: rest-hook |
| endpoint |
S | 1..1 | url | Where the channel points to |
| payload |
SC | 1..1 | code | MIME type to send, or omit for no payload Constraints: fodder-payload-mime |
| Slices for extension |
Content/Rules for all slices | |||
| extension:content |
1..1 | BackportPayloadContent | Backport R5 Subscription Payload Content Information | |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueCode |
0..1 | code | Value of extension Fixed Value: id-only | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| fodder-criteria-topic | error | Subscription.criteria | Subscription.criteria SHALL be the FODDER Deceased Patient Identified SubscriptionTopic canonical URL. |
$this = 'https://onyxhealth.io/fhir/fodder/SubscriptionTopic/deceased-patient-identified'
|
| fodder-payload-mime | error | Subscription.channel.payload | Subscription.channel.payload SHALL be 'application/fhir+json'. |
$this = 'application/fhir+json'
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Subscription |
0..* | BackportSubscription | Server push subscription criteria | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| status |
?!SΣ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. | ||||
| contact |
Σ | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | ||||
| end |
Σ | 0..1 | instant | When to automatically delete the subscription | ||||
| reason |
SΣ | 1..1 | string | Description of why this subscription was created | ||||
| criteria |
SΣC | 1..1 | string | Canonical URL for the topic used to generate events Constraints: fodder-criteria-topic | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:filterCriteria |
SΣ | 1..* | string | Backported R5 FilterBy Criteria URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria | ||||
 value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| error |
Σ | 0..1 | string | Latest error note | ||||
| channel |
Σ | 1..1 | BackboneElement | The channel on which to report matches to the criteria | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:heartbeatPeriod |
S | 0..1 | unsignedInt | Backport R5 Subscription Heartbeat Period URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period | ||||
| extension:timeout |
0..1 | unsignedInt | Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout | |||||
| extension:maxCount |
0..1 | positiveInt | Maximum number of triggering resources included in notification bundles URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
SΣ | 1..1 | code | rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. Fixed Value: rest-hook | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:customChannelType |
SΣ | 0..1 | Coding | Extended channel type for notifications URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type | ||||
| value |
0..1 | code | Primitive value for code | |||||
| endpoint |
SΣ | 1..1 | url | Where the channel points to | ||||
| payload |
SΣC | 1..1 | code | MIME type to send, or omit for no payload Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Constraints: fodder-payload-mime | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:content |
SΣ | 1..1 | (Complex) | Backport R5 Subscription Payload Content Information URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content" | |||||
| Slices for value[x] |
0..1 | code | Notification content level Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueCode |
0..1 | code | Value of extension Binding: Backported R5 Subscription Content Value Set (required) Fixed Value: id-only | |||||
| value |
0..1 | code | Primitive value for code | |||||
| header |
Σ | 0..* | string | Usage depends on the channel type | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Subscription.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Subscription.status | Base | required | SubscriptionStatus | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Subscription.channel.type | Base | required | SubscriptionChannelType | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Subscription.channel.payload | Base | required | MimeType | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Subscription.channel.payload.extension:content.value[x]:valueCode | Base | required | Backported R5 Subscription Content Value Set | 📦1.1.0 | Subscriptions R5 Backport v1.1 |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Subscription | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Subscription | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Subscription | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Subscription | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Subscription | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | Subscription.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| 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()
|
| fodder-criteria-topic | error | Subscription.criteria | Subscription.criteria SHALL be the FODDER Deceased Patient Identified SubscriptionTopic canonical URL. |
$this = 'https://onyxhealth.io/fhir/fodder/SubscriptionTopic/deceased-patient-identified'
|
| fodder-payload-mime | error | Subscription.channel.payload | Subscription.channel.payload SHALL be 'application/fhir+json'. |
$this = 'application/fhir+json'
|
This structure is derived from BackportSubscription
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Subscription |
0..* | BackportSubscription | Server push subscription criteria | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!SΣ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. |
| reason |
SΣ | 1..1 | string | Description of why this subscription was created |
| criteria |
SΣC | 1..1 | string | Canonical URL for the topic used to generate events Constraints: fodder-criteria-topic |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:filterCriteria |
SΣ | 1..* | string | Backported R5 FilterBy Criteria URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria |
| channel |
Σ | 1..1 | BackboneElement | The channel on which to report matches to the criteria |
| Slices for extension |
Content/Rules for all slices | |||
| extension:heartbeatPeriod |
S | 0..1 | unsignedInt | Backport R5 Subscription Heartbeat Period URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period |
| extension:timeout |
0..1 | unsignedInt | Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout | |
| extension:maxCount |
0..1 | positiveInt | Maximum number of triggering resources included in notification bundles URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
SΣ | 1..1 | code | rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. Fixed Value: rest-hook |
| Slices for extension |
Content/Rules for all slices | |||
| extension:customChannelType |
SΣ | 0..1 | Coding | Extended channel type for notifications URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type |
| endpoint |
SΣ | 1..1 | url | Where the channel points to |
| payload |
SΣC | 1..1 | code | MIME type to send, or omit for no payload Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Constraints: fodder-payload-mime |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:content |
SΣ | 1..1 | (Complex) | Backport R5 Subscription Payload Content Information URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content" | |
| Slices for value[x] |
0..1 | code | Notification content level Slice: Unordered, Closed by type:$this | |
| value[x]:valueCode |
0..1 | code | Value of extension Binding: Backported R5 Subscription Content Value Set (required) Fixed Value: id-only | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Subscription.status | Base | required | SubscriptionStatus | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Subscription.channel.type | Base | required | SubscriptionChannelType | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Subscription.channel.payload | Base | required | MimeType | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Subscription.channel.payload.extension:content.value[x]:valueCode | Base | required | Backported R5 Subscription Content Value Set | 📦1.1.0 | Subscriptions R5 Backport v1.1 |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Subscription | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Subscription | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Subscription | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Subscription | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Subscription | A resource should have narrative for robust management |
text.`div`.exists()
|
| 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()
|
| fodder-criteria-topic | error | Subscription.criteria | Subscription.criteria SHALL be the FODDER Deceased Patient Identified SubscriptionTopic canonical URL. |
$this = 'https://onyxhealth.io/fhir/fodder/SubscriptionTopic/deceased-patient-identified'
|
| fodder-payload-mime | error | Subscription.channel.payload | Subscription.channel.payload SHALL be 'application/fhir+json'. |
$this = 'application/fhir+json'
|
Differential View
This structure is derived from BackportSubscription
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Subscription |
0..* | BackportSubscription | Server push subscription criteria | |
| status |
S | 1..1 | code | requested | active | error | off |
| reason |
S | 1..1 | string | Description of why this subscription was created |
| criteria |
C | 1..1 | string | Canonical URL for the topic used to generate events Constraints: fodder-criteria-topic |
| extension |
1..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:filterCriteria |
1..* | BackportFilterCriteria | Backported R5 FilterBy Criteria | |
| channel |
||||
| Slices for extension |
Content/Rules for all slices | |||
| extension:heartbeatPeriod |
S | 0..1 | BackportHeartbeatPeriod | Backport R5 Subscription Heartbeat Period |
| type |
S | 1..1 | code | rest-hook | websocket | email | sms | message Fixed Value: rest-hook |
| endpoint |
S | 1..1 | url | Where the channel points to |
| payload |
SC | 1..1 | code | MIME type to send, or omit for no payload Constraints: fodder-payload-mime |
| Slices for extension |
Content/Rules for all slices | |||
| extension:content |
1..1 | BackportPayloadContent | Backport R5 Subscription Payload Content Information | |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueCode |
0..1 | code | Value of extension Fixed Value: id-only | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| fodder-criteria-topic | error | Subscription.criteria | Subscription.criteria SHALL be the FODDER Deceased Patient Identified SubscriptionTopic canonical URL. |
$this = 'https://onyxhealth.io/fhir/fodder/SubscriptionTopic/deceased-patient-identified'
|
| fodder-payload-mime | error | Subscription.channel.payload | Subscription.channel.payload SHALL be 'application/fhir+json'. |
$this = 'application/fhir+json'
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Subscription |
0..* | BackportSubscription | Server push subscription criteria | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| status |
?!SΣ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. | ||||
| contact |
Σ | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | ||||
| end |
Σ | 0..1 | instant | When to automatically delete the subscription | ||||
| reason |
SΣ | 1..1 | string | Description of why this subscription was created | ||||
| criteria |
SΣC | 1..1 | string | Canonical URL for the topic used to generate events Constraints: fodder-criteria-topic | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:filterCriteria |
SΣ | 1..* | string | Backported R5 FilterBy Criteria URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria | ||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| error |
Σ | 0..1 | string | Latest error note | ||||
| channel |
Σ | 1..1 | BackboneElement | The channel on which to report matches to the criteria | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:heartbeatPeriod |
S | 0..1 | unsignedInt | Backport R5 Subscription Heartbeat Period URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period | ||||
| extension:timeout |
0..1 | unsignedInt | Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout | |||||
| extension:maxCount |
0..1 | positiveInt | Maximum number of triggering resources included in notification bundles URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
SΣ | 1..1 | code | rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. Fixed Value: rest-hook | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:customChannelType |
SΣ | 0..1 | Coding | Extended channel type for notifications URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type | ||||
| value |
0..1 | code | Primitive value for code | |||||
| endpoint |
SΣ | 1..1 | url | Where the channel points to | ||||
| payload |
SΣC | 1..1 | code | MIME type to send, or omit for no payload Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Constraints: fodder-payload-mime | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:content |
SΣ | 1..1 | (Complex) | Backport R5 Subscription Payload Content Information URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content" | |||||
| Slices for value[x] |
0..1 | code | Notification content level Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueCode |
0..1 | code | Value of extension Binding: Backported R5 Subscription Content Value Set (required) Fixed Value: id-only | |||||
| value |
0..1 | code | Primitive value for code | |||||
| header |
Σ | 0..* | string | Usage depends on the channel type | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Subscription.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Subscription.status | Base | required | SubscriptionStatus | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Subscription.channel.type | Base | required | SubscriptionChannelType | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Subscription.channel.payload | Base | required | MimeType | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Subscription.channel.payload.extension:content.value[x]:valueCode | Base | required | Backported R5 Subscription Content Value Set | 📦1.1.0 | Subscriptions R5 Backport v1.1 |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Subscription | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Subscription | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Subscription | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Subscription | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Subscription | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | Subscription.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| 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()
|
| fodder-criteria-topic | error | Subscription.criteria | Subscription.criteria SHALL be the FODDER Deceased Patient Identified SubscriptionTopic canonical URL. |
$this = 'https://onyxhealth.io/fhir/fodder/SubscriptionTopic/deceased-patient-identified'
|
| fodder-payload-mime | error | Subscription.channel.payload | Subscription.channel.payload SHALL be 'application/fhir+json'. |
$this = 'application/fhir+json'
|
This structure is derived from BackportSubscription
Other representations of profile: CSV, Excel, Schematron