Scalable Consent Management, published by HL7 International / Community Based Collaborative Care. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-consent-management/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTSubscription | Version: 0.1.0 | |||
Standards status: Trial-use | Maturity Level: 1 | Computable Name: FASTSubscription |
A profile for FAST subscriptions.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Subscription
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Subscription | Server push subscription criteria | |
![]() ![]() ![]() |
1..1 | code | requested | active | error | off Required Pattern: active | |
![]() ![]() ![]() |
1..1 | string | Rule for server push Required Pattern: http://hl7.org/fhir/us/consent-management/SubscriptionTopic/FASTConsentSubscriptionTopic | |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Backported R5 FilterBy Criteria URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | code | rest-hook | websocket | email | sms | message Required Pattern: rest-hook | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Backport R5 Subscription Payload Content Information URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Binding: Backported R5 Subscription Content Value Set (required) |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Subscription | Server push subscription criteria | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!Σ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. Required Pattern: active |
![]() ![]() ![]() |
Σ | 1..1 | string | Description of why this subscription was created |
![]() ![]() ![]() |
Σ | 1..1 | string | Rule for server push Required Pattern: http://hl7.org/fhir/us/consent-management/SubscriptionTopic/FASTConsentSubscriptionTopic |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Backported R5 FilterBy Criteria URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria |
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | The channel on which to report matches to the criteria |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. Required Pattern: rest-hook |
![]() ![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Backport R5 Subscription Payload Content Information URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Binding: Backported R5 Subscription Content Value Set (required) |
![]() |
Path | Conformance | ValueSet / Code | URI |
Subscription.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/subscription-status|4.0.1 from the FHIR Standard | |
Subscription.channel.type | required | Pattern: rest-hookhttp://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1 from the FHIR Standard | |
Subscription.channel.payload | required | Mime Types (a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 | **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() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Subscription | Server push subscription criteria | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. Required Pattern: active | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When to automatically delete the subscription | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | Description of why this subscription was created | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | Rule for server push Required Pattern: http://hl7.org/fhir/us/consent-management/SubscriptionTopic/FASTConsentSubscriptionTopic | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Backported R5 FilterBy Criteria URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() |
Σ | 0..1 | string | Latest error note | ||||
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | The channel on which to report matches to the criteria | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. Required Pattern: rest-hook | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | url | Where the channel points to | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Backport R5 Subscription Payload Content Information URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Binding: Backported R5 Subscription Content Value Set (required) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for code | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Usage depends on the channel type | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Subscription.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Subscription.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/subscription-status|4.0.1 from the FHIR Standard | ||||
Subscription.channel.type | required | Pattern: rest-hookhttp://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1 from the FHIR Standard | ||||
Subscription.channel.payload | required | Mime Types (a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 | **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() |
This structure is derived from Subscription
Summary
Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 2 elements
Extensions
This structure refers to these extensions:
Maturity: 1
Differential View
This structure is derived from Subscription
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Subscription | Server push subscription criteria | |
![]() ![]() ![]() |
1..1 | code | requested | active | error | off Required Pattern: active | |
![]() ![]() ![]() |
1..1 | string | Rule for server push Required Pattern: http://hl7.org/fhir/us/consent-management/SubscriptionTopic/FASTConsentSubscriptionTopic | |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Backported R5 FilterBy Criteria URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | code | rest-hook | websocket | email | sms | message Required Pattern: rest-hook | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Backport R5 Subscription Payload Content Information URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Binding: Backported R5 Subscription Content Value Set (required) |
![]() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Subscription | Server push subscription criteria | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!Σ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. Required Pattern: active |
![]() ![]() ![]() |
Σ | 1..1 | string | Description of why this subscription was created |
![]() ![]() ![]() |
Σ | 1..1 | string | Rule for server push Required Pattern: http://hl7.org/fhir/us/consent-management/SubscriptionTopic/FASTConsentSubscriptionTopic |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Backported R5 FilterBy Criteria URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria |
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | The channel on which to report matches to the criteria |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. Required Pattern: rest-hook |
![]() ![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Backport R5 Subscription Payload Content Information URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Binding: Backported R5 Subscription Content Value Set (required) |
![]() |
Path | Conformance | ValueSet / Code | URI |
Subscription.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/subscription-status|4.0.1 from the FHIR Standard | |
Subscription.channel.type | required | Pattern: rest-hookhttp://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1 from the FHIR Standard | |
Subscription.channel.payload | required | Mime Types (a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 | **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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Subscription | Server push subscription criteria | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. Required Pattern: active | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When to automatically delete the subscription | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | Description of why this subscription was created | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | Rule for server push Required Pattern: http://hl7.org/fhir/us/consent-management/SubscriptionTopic/FASTConsentSubscriptionTopic | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Backported R5 FilterBy Criteria URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() |
Σ | 0..1 | string | Latest error note | ||||
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | The channel on which to report matches to the criteria | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. Required Pattern: rest-hook | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | url | Where the channel points to | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Backport R5 Subscription Payload Content Information URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Binding: Backported R5 Subscription Content Value Set (required) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for code | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Usage depends on the channel type | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Subscription.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Subscription.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/subscription-status|4.0.1 from the FHIR Standard | ||||
Subscription.channel.type | required | Pattern: rest-hookhttp://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1 from the FHIR Standard | ||||
Subscription.channel.payload | required | Mime Types (a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 | **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() |
This structure is derived from Subscription
Summary
Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 2 elements
Extensions
This structure refers to these extensions:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron