Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-Subscription | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R5_Subscription_R4 | ||
This cross-version profile allows R5 Subscription content to be represented via FHIR R4 Subscription resources.
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..* | Subscription(4.0.1) | Server push subscription criteria | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
   extension:identifier |
0..* | Identifier | R5: Additional identifiers (business identifier) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.identifier Constraints: ext-1 | |
| extension:name |
0..1 | string | R5: Human readable name for this subscription (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.name Constraints: ext-1 | |
| extension:topic |
1..1 | canonical(Cross-version Profile for R5.SubscriptionTopic for use in FHIR R4(0.1.0) | Basic) | R5: Reference to the subscription topic being subscribed to (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.topic Constraints: ext-1 | |
| extension:managingEntity |
0..1 | Reference(Cross-version Profile for R5.CareTeam for use in FHIR R4(0.1.0) | CareTeam | Cross-version Profile for R5.HealthcareService for use in FHIR R4(0.1.0) | HealthcareService | Cross-version Profile for R5.Organization for use in FHIR R4(0.1.0) | Organization | Cross-version Profile for R5.RelatedPerson for use in FHIR R4(0.1.0) | RelatedPerson | Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR R4(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR R4(0.1.0) | PractitionerRole) | R5: Entity responsible for Subscription changes (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.managingEntity Constraints: ext-1 | |
| extension:filterBy |
0..* | (Complex) | R5: Criteria for narrowing the subscription topic stream (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.filterBy Constraints: ext-1 | |
| extension:parameter |
0..* | (Complex) | R5: Channel type (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.parameter Constraints: ext-1 | |
| extension:heartbeatPeriod |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period]] | R5: Interval in seconds to send 'heartbeat' notification (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period Constraints: ext-1 | |
| extension:timeout |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout]] | R5: Timeout in seconds to attempt notification delivery (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout Constraints: ext-1 | |
| extension:content |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content]] | R5: empty | id-only | full-resource (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Constraints: ext-1 | |
 extension:maxCount |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count]] | R5: Maximum number of events that can be combined in a single notification (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count Constraints: ext-1 | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| status |
?!Σ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus  (required): The status of a subscription. |
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
 extension:status |
0..1 | code | R5: requested | active | error | off | entered-in-error URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.status Binding: R5SubscriptionStatusForR4 (0.1.0) (required): The status of a subscription. Constraints: ext-1 | |
| reason |
Σ | 1..1 | string | Description of why this subscription was created |
| criteria |
Σ | 1..1 | string | Rule for server push |
 channel |
Σ | 1..1 | BackboneElement | The channel on which to report matches to the criteria |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
| type |
Σ | 1..1 | code | rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:channelType |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type]] | R5: Channel type for notifications additional types URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type Constraints: ext-1 | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Subscription.status | Base | required |
SubscriptionStatus
|
📍4.0.1 | tx.fhir.org |
| Subscription.channel.type | Base | required | SubscriptionChannelType | 📍4.0.1 | FHIR Std. |
| 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 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(canonical) = '#').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 | Subscription.implicitRules, Subscription.extension, Subscription.extension:identifier, Subscription.extension:name, Subscription.extension:topic, Subscription.extension:managingEntity, Subscription.extension:filterBy, Subscription.extension:parameter, Subscription.extension:heartbeatPeriod, Subscription.extension:timeout, Subscription.extension:content, Subscription.extension:maxCount, Subscription.modifierExtension, Subscription.status, Subscription.status.extension, Subscription.status.extension:status, Subscription.reason, Subscription.criteria, Subscription.channel, Subscription.channel.modifierExtension, Subscription.channel.type, Subscription.channel.type.extension, Subscription.channel.type.extension:channelType | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Subscription.extension, Subscription.extension:identifier, Subscription.extension:name, Subscription.extension:topic, Subscription.extension:managingEntity, Subscription.extension:filterBy, Subscription.extension:parameter, Subscription.extension:heartbeatPeriod, Subscription.extension:timeout, Subscription.extension:content, Subscription.extension:maxCount, Subscription.modifierExtension, Subscription.status.extension, Subscription.status.extension:status, Subscription.channel.modifierExtension, Subscription.channel.type.extension, Subscription.channel.type.extension:channelType | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Subscription
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Subscription |
0..* | Subscription(4.0.1) | Server push subscription criteria | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:identifier |
0..* | Identifier | R5: Additional identifiers (business identifier) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.identifier | |
| extension:name |
0..1 | string | R5: Human readable name for this subscription (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.name | |
| extension:topic |
1..1 | canonical(Cross-version Profile for R5.SubscriptionTopic for use in FHIR R4(0.1.0) | Basic) | R5: Reference to the subscription topic being subscribed to (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.topic | |
| extension:managingEntity |
0..1 | Reference(Cross-version Profile for R5.CareTeam for use in FHIR R4(0.1.0) | CareTeam | Cross-version Profile for R5.HealthcareService for use in FHIR R4(0.1.0) | HealthcareService | Cross-version Profile for R5.Organization for use in FHIR R4(0.1.0) | Organization | Cross-version Profile for R5.RelatedPerson for use in FHIR R4(0.1.0) | RelatedPerson | Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR R4(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR R4(0.1.0) | PractitionerRole) | R5: Entity responsible for Subscription changes (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.managingEntity | |
| extension:filterBy |
0..* | (Complex) | R5: Criteria for narrowing the subscription topic stream (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.filterBy | |
| extension:parameter |
0..* | (Complex) | R5: Channel type (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.parameter | |
| extension:heartbeatPeriod |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period]] | R5: Interval in seconds to send 'heartbeat' notification (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period | |
| extension:timeout |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout]] | R5: Timeout in seconds to attempt notification delivery (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout | |
| extension:content |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content]] | R5: empty | id-only | full-resource (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content | |
| extension:maxCount |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count]] | R5: Maximum number of events that can be combined in a single notification (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count | |
 status |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:status |
0..1 | code | R5: requested | active | error | off | entered-in-error URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.status Binding: R5SubscriptionStatusForR4 (0.1.0) (required): The status of a subscription. | |
| channel |
||||
| type |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:channelType |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type]] | R5: Channel type for notifications additional types URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Subscription |
0..* | Subscription(4.0.1) | 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): A human language.
| |||||
| 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 | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..* | Identifier | R5: Additional identifiers (business identifier) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.identifier Constraints: ext-1 | |||||
| extension:name |
0..1 | string | R5: Human readable name for this subscription (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.name Constraints: ext-1 | |||||
| extension:topic |
1..1 | canonical(Cross-version Profile for R5.SubscriptionTopic for use in FHIR R4(0.1.0) | Basic) | R5: Reference to the subscription topic being subscribed to (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.topic Constraints: ext-1 | |||||
| extension:managingEntity |
0..1 | Reference(Cross-version Profile for R5.CareTeam for use in FHIR R4(0.1.0) | CareTeam | Cross-version Profile for R5.HealthcareService for use in FHIR R4(0.1.0) | HealthcareService | Cross-version Profile for R5.Organization for use in FHIR R4(0.1.0) | Organization | Cross-version Profile for R5.RelatedPerson for use in FHIR R4(0.1.0) | RelatedPerson | Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR R4(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR R4(0.1.0) | PractitionerRole) | R5: Entity responsible for Subscription changes (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.managingEntity Constraints: ext-1 | |||||
| extension:filterBy |
0..* | (Complex) | R5: Criteria for narrowing the subscription topic stream (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.filterBy Constraints: ext-1 | |||||
| extension:parameter |
0..* | (Complex) | R5: Channel type (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.parameter Constraints: ext-1 | |||||
| extension:heartbeatPeriod |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period]] | R5: Interval in seconds to send 'heartbeat' notification (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period Constraints: ext-1 | |||||
| extension:timeout |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout]] | R5: Timeout in seconds to attempt notification delivery (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout Constraints: ext-1 | |||||
| extension:content |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content]] | R5: empty | id-only | full-resource (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Constraints: ext-1 | |||||
| extension:maxCount |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count]] | R5: Maximum number of events that can be combined in a single notification (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| status |
?!Σ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:status |
0..1 | code | R5: requested | active | error | off | entered-in-error URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.status Binding: R5SubscriptionStatusForR4 (0.1.0) (required): The status of a subscription. Constraints: ext-1 | |||||
 value |
0..1 | string | Primitive value for code | |||||
| contact |
Σ | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | ||||
| end |
Σ | 0..1 | instant | When to automatically delete the subscription | ||||
| reason |
Σ | 1..1 | string | Description of why this subscription was created | ||||
| criteria |
Σ | 1..1 | string | Rule for server push | ||||
| 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| type |
Σ | 1..1 | code | rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:channelType |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type]] | R5: Channel type for notifications additional types URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for code | |||||
| endpoint |
Σ | 0..1 | url | Where the channel points to | ||||
| payload |
Σ | 0..1 | code | MIME type to send, or omit for no payload Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | ||||
| 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 | tx.fhir.org |
| Subscription.status | Base | required |
SubscriptionStatus
|
📍4.0.1 | tx.fhir.org |
| Subscription.channel.type | Base | required | SubscriptionChannelType | 📍4.0.1 | FHIR Std. |
| Subscription.channel.payload | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| 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 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(canonical) = '#').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 | Subscription.meta, Subscription.implicitRules, Subscription.language, Subscription.text, Subscription.extension, Subscription.extension:identifier, Subscription.extension:name, Subscription.extension:topic, Subscription.extension:managingEntity, Subscription.extension:filterBy, Subscription.extension:parameter, Subscription.extension:heartbeatPeriod, Subscription.extension:timeout, Subscription.extension:content, Subscription.extension:maxCount, Subscription.modifierExtension, Subscription.status, Subscription.status.extension, Subscription.status.extension:status, Subscription.contact, Subscription.end, Subscription.reason, Subscription.criteria, Subscription.error, Subscription.channel, Subscription.channel.extension, Subscription.channel.modifierExtension, Subscription.channel.type, Subscription.channel.type.extension, Subscription.channel.type.extension:channelType, Subscription.channel.endpoint, Subscription.channel.payload, Subscription.channel.header | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Subscription.extension, Subscription.extension:identifier, Subscription.extension:name, Subscription.extension:topic, Subscription.extension:managingEntity, Subscription.extension:filterBy, Subscription.extension:parameter, Subscription.extension:heartbeatPeriod, Subscription.extension:timeout, Subscription.extension:content, Subscription.extension:maxCount, Subscription.modifierExtension, Subscription.status.extension, Subscription.status.extension:status, Subscription.channel.extension, Subscription.channel.modifierExtension, Subscription.channel.type.extension, Subscription.channel.type.extension:channelType | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Subscription
Summary
Mandatory: 2 elements
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Subscription |
0..* | Subscription(4.0.1) | Server push subscription criteria | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:identifier |
0..* | Identifier | R5: Additional identifiers (business identifier) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.identifier Constraints: ext-1 | |
| extension:name |
0..1 | string | R5: Human readable name for this subscription (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.name Constraints: ext-1 | |
| extension:topic |
1..1 | canonical(Cross-version Profile for R5.SubscriptionTopic for use in FHIR R4(0.1.0) | Basic) | R5: Reference to the subscription topic being subscribed to (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.topic Constraints: ext-1 | |
| extension:managingEntity |
0..1 | Reference(Cross-version Profile for R5.CareTeam for use in FHIR R4(0.1.0) | CareTeam | Cross-version Profile for R5.HealthcareService for use in FHIR R4(0.1.0) | HealthcareService | Cross-version Profile for R5.Organization for use in FHIR R4(0.1.0) | Organization | Cross-version Profile for R5.RelatedPerson for use in FHIR R4(0.1.0) | RelatedPerson | Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR R4(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR R4(0.1.0) | PractitionerRole) | R5: Entity responsible for Subscription changes (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.managingEntity Constraints: ext-1 | |
| extension:filterBy |
0..* | (Complex) | R5: Criteria for narrowing the subscription topic stream (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.filterBy Constraints: ext-1 | |
| extension:parameter |
0..* | (Complex) | R5: Channel type (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.parameter Constraints: ext-1 | |
| extension:heartbeatPeriod |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period]] | R5: Interval in seconds to send 'heartbeat' notification (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period Constraints: ext-1 | |
| extension:timeout |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout]] | R5: Timeout in seconds to attempt notification delivery (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout Constraints: ext-1 | |
| extension:content |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content]] | R5: empty | id-only | full-resource (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Constraints: ext-1 | |
| extension:maxCount |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count]] | R5: Maximum number of events that can be combined in a single notification (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count Constraints: ext-1 | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| status |
?!Σ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:status |
0..1 | code | R5: requested | active | error | off | entered-in-error URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.status Binding: R5SubscriptionStatusForR4 (0.1.0) (required): The status of a subscription. Constraints: ext-1 | |
| reason |
Σ | 1..1 | string | Description of why this subscription was created |
| criteria |
Σ | 1..1 | string | Rule for server push |
| channel |
Σ | 1..1 | BackboneElement | The channel on which to report matches to the criteria |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
| type |
Σ | 1..1 | code | rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:channelType |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type]] | R5: Channel type for notifications additional types URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type Constraints: ext-1 | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Subscription.status | Base | required |
SubscriptionStatus
|
📍4.0.1 | tx.fhir.org |
| Subscription.channel.type | Base | required | SubscriptionChannelType | 📍4.0.1 | FHIR Std. |
| 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 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(canonical) = '#').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 | Subscription.implicitRules, Subscription.extension, Subscription.extension:identifier, Subscription.extension:name, Subscription.extension:topic, Subscription.extension:managingEntity, Subscription.extension:filterBy, Subscription.extension:parameter, Subscription.extension:heartbeatPeriod, Subscription.extension:timeout, Subscription.extension:content, Subscription.extension:maxCount, Subscription.modifierExtension, Subscription.status, Subscription.status.extension, Subscription.status.extension:status, Subscription.reason, Subscription.criteria, Subscription.channel, Subscription.channel.modifierExtension, Subscription.channel.type, Subscription.channel.type.extension, Subscription.channel.type.extension:channelType | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Subscription.extension, Subscription.extension:identifier, Subscription.extension:name, Subscription.extension:topic, Subscription.extension:managingEntity, Subscription.extension:filterBy, Subscription.extension:parameter, Subscription.extension:heartbeatPeriod, Subscription.extension:timeout, Subscription.extension:content, Subscription.extension:maxCount, Subscription.modifierExtension, Subscription.status.extension, Subscription.status.extension:status, Subscription.channel.modifierExtension, Subscription.channel.type.extension, Subscription.channel.type.extension:channelType | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Subscription
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Subscription |
0..* | Subscription(4.0.1) | Server push subscription criteria | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:identifier |
0..* | Identifier | R5: Additional identifiers (business identifier) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.identifier | |
| extension:name |
0..1 | string | R5: Human readable name for this subscription (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.name | |
| extension:topic |
1..1 | canonical(Cross-version Profile for R5.SubscriptionTopic for use in FHIR R4(0.1.0) | Basic) | R5: Reference to the subscription topic being subscribed to (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.topic | |
| extension:managingEntity |
0..1 | Reference(Cross-version Profile for R5.CareTeam for use in FHIR R4(0.1.0) | CareTeam | Cross-version Profile for R5.HealthcareService for use in FHIR R4(0.1.0) | HealthcareService | Cross-version Profile for R5.Organization for use in FHIR R4(0.1.0) | Organization | Cross-version Profile for R5.RelatedPerson for use in FHIR R4(0.1.0) | RelatedPerson | Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR R4(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR R4(0.1.0) | PractitionerRole) | R5: Entity responsible for Subscription changes (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.managingEntity | |
| extension:filterBy |
0..* | (Complex) | R5: Criteria for narrowing the subscription topic stream (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.filterBy | |
| extension:parameter |
0..* | (Complex) | R5: Channel type (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.parameter | |
| extension:heartbeatPeriod |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period]] | R5: Interval in seconds to send 'heartbeat' notification (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period | |
| extension:timeout |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout]] | R5: Timeout in seconds to attempt notification delivery (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout | |
| extension:content |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content]] | R5: empty | id-only | full-resource (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content | |
| extension:maxCount |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count]] | R5: Maximum number of events that can be combined in a single notification (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count | |
| status |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:status |
0..1 | code | R5: requested | active | error | off | entered-in-error URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.status Binding: R5SubscriptionStatusForR4 (0.1.0) (required): The status of a subscription. | |
| channel |
||||
| type |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:channelType |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type]] | R5: Channel type for notifications additional types URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Subscription |
0..* | Subscription(4.0.1) | 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): A human language.
| |||||
| 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 | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..* | Identifier | R5: Additional identifiers (business identifier) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.identifier Constraints: ext-1 | |||||
| extension:name |
0..1 | string | R5: Human readable name for this subscription (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.name Constraints: ext-1 | |||||
| extension:topic |
1..1 | canonical(Cross-version Profile for R5.SubscriptionTopic for use in FHIR R4(0.1.0) | Basic) | R5: Reference to the subscription topic being subscribed to (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.topic Constraints: ext-1 | |||||
| extension:managingEntity |
0..1 | Reference(Cross-version Profile for R5.CareTeam for use in FHIR R4(0.1.0) | CareTeam | Cross-version Profile for R5.HealthcareService for use in FHIR R4(0.1.0) | HealthcareService | Cross-version Profile for R5.Organization for use in FHIR R4(0.1.0) | Organization | Cross-version Profile for R5.RelatedPerson for use in FHIR R4(0.1.0) | RelatedPerson | Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR R4(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR R4(0.1.0) | PractitionerRole) | R5: Entity responsible for Subscription changes (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.managingEntity Constraints: ext-1 | |||||
| extension:filterBy |
0..* | (Complex) | R5: Criteria for narrowing the subscription topic stream (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.filterBy Constraints: ext-1 | |||||
| extension:parameter |
0..* | (Complex) | R5: Channel type (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.parameter Constraints: ext-1 | |||||
| extension:heartbeatPeriod |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period]] | R5: Interval in seconds to send 'heartbeat' notification (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period Constraints: ext-1 | |||||
| extension:timeout |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout]] | R5: Timeout in seconds to attempt notification delivery (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout Constraints: ext-1 | |||||
| extension:content |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content]] | R5: empty | id-only | full-resource (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Constraints: ext-1 | |||||
| extension:maxCount |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count]] | R5: Maximum number of events that can be combined in a single notification (new) URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| status |
?!Σ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:status |
0..1 | code | R5: requested | active | error | off | entered-in-error URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.status Binding: R5SubscriptionStatusForR4 (0.1.0) (required): The status of a subscription. Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for code | |||||
| contact |
Σ | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | ||||
| end |
Σ | 0..1 | instant | When to automatically delete the subscription | ||||
| reason |
Σ | 1..1 | string | Description of why this subscription was created | ||||
| criteria |
Σ | 1..1 | string | Rule for server push | ||||
| 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| type |
Σ | 1..1 | code | rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:channelType |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type]] | R5: Channel type for notifications additional types URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for code | |||||
| endpoint |
Σ | 0..1 | url | Where the channel points to | ||||
| payload |
Σ | 0..1 | code | MIME type to send, or omit for no payload Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | ||||
| 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 | tx.fhir.org |
| Subscription.status | Base | required |
SubscriptionStatus
|
📍4.0.1 | tx.fhir.org |
| Subscription.channel.type | Base | required | SubscriptionChannelType | 📍4.0.1 | FHIR Std. |
| Subscription.channel.payload | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| 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 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(canonical) = '#').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 | Subscription.meta, Subscription.implicitRules, Subscription.language, Subscription.text, Subscription.extension, Subscription.extension:identifier, Subscription.extension:name, Subscription.extension:topic, Subscription.extension:managingEntity, Subscription.extension:filterBy, Subscription.extension:parameter, Subscription.extension:heartbeatPeriod, Subscription.extension:timeout, Subscription.extension:content, Subscription.extension:maxCount, Subscription.modifierExtension, Subscription.status, Subscription.status.extension, Subscription.status.extension:status, Subscription.contact, Subscription.end, Subscription.reason, Subscription.criteria, Subscription.error, Subscription.channel, Subscription.channel.extension, Subscription.channel.modifierExtension, Subscription.channel.type, Subscription.channel.type.extension, Subscription.channel.type.extension:channelType, Subscription.channel.endpoint, Subscription.channel.payload, Subscription.channel.header | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Subscription.extension, Subscription.extension:identifier, Subscription.extension:name, Subscription.extension:topic, Subscription.extension:managingEntity, Subscription.extension:filterBy, Subscription.extension:parameter, Subscription.extension:heartbeatPeriod, Subscription.extension:timeout, Subscription.extension:content, Subscription.extension:maxCount, Subscription.modifierExtension, Subscription.status.extension, Subscription.status.extension:status, Subscription.channel.extension, Subscription.channel.modifierExtension, Subscription.channel.type.extension, Subscription.channel.type.extension:channelType | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Subscription
Summary
Mandatory: 2 elements
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r5.r4#0.1.0 based on FHIR 4.0.1. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change