Da Vinci Prior Authorization Support (PAS) FHIR IG
2.2.0 - STU 2.2
Da Vinci Prior Authorization Support (PAS) FHIR IG
2.2.0 - STU 2.2
Da Vinci Prior Authorization Support (PAS) FHIR IG, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pas/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-subscription | Version: 2.2.0 | ||||
| Standards status: Trial-use Active as of 2026-03-02 | Maturity Level: 4 | Computable Name: PASSubscription | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.24.42.74 | |||||
The profile for PAS subscription.
Information on how this profile is used and interpreted is found in the Specification page.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| 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 |
?!Σ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. Required Pattern: active |
| reason |
Σ | 1..1 | string | Description of why this subscription was created |
 criteria |
SΣ | 1..1 | string | Canonical URL for the topic used to generate events Required Pattern: http://hl7.org/fhir/us/davinci-pas/SubscriptionTopic/PASSubscriptionTopic |
   Slices for extension |
Content/Rules for all slices | |||
   extension:filterCriteria |
SΣ | 0..* | string | Filtering critiera applied to events 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 |
0..1 | unsignedInt | Interval in seconds to send 'heartbeat' notification 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 |
Σ | 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 |
| 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 |
Σ | 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) |
 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) Required Pattern: full-resource | |
| 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()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Subscription |
0..* | BackportSubscription | Server push subscription criteria | |
 status |
1..1 | code | requested | active | error | off Required Pattern: active | |
| criteria |
1..1 | string | Canonical URL for the topic used to generate events Required Pattern: http://hl7.org/fhir/us/davinci-pas/SubscriptionTopic/PASSubscriptionTopic | |
| channel |
||||
| type |
1..1 | code | rest-hook | websocket | email | sms | message Required Pattern: rest-hook | |
| endpoint |
S | 1..1 | url | Where the channel points to |
| payload |
||||
| 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 Required Pattern: full-resource | |
| Documentation for this format | ||||
| 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 |
?!Σ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. Required Pattern: active | ||||
| 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 |
SΣ | 1..1 | string | Canonical URL for the topic used to generate events Required Pattern: http://hl7.org/fhir/us/davinci-pas/SubscriptionTopic/PASSubscriptionTopic | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:filterCriteria |
SΣ | 0..* | string | Filtering critiera applied to events 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 |
0..1 | unsignedInt | Interval in seconds to send 'heartbeat' notification 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 |
Σ | 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 | ||||
| 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 |
Σ | 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) | ||||
| 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) Required Pattern: full-resource | |||||
| 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()
|
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 |
?!Σ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. Required Pattern: active |
| reason |
Σ | 1..1 | string | Description of why this subscription was created |
| criteria |
SΣ | 1..1 | string | Canonical URL for the topic used to generate events Required Pattern: http://hl7.org/fhir/us/davinci-pas/SubscriptionTopic/PASSubscriptionTopic |
| Slices for extension |
Content/Rules for all slices | |||
| extension:filterCriteria |
SΣ | 0..* | string | Filtering critiera applied to events 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 |
0..1 | unsignedInt | Interval in seconds to send 'heartbeat' notification 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 |
Σ | 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 |
| 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 |
Σ | 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) |
| 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) Required Pattern: full-resource | |
| 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()
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Subscription |
0..* | BackportSubscription | Server push subscription criteria | |
| status |
1..1 | code | requested | active | error | off Required Pattern: active | |
| criteria |
1..1 | string | Canonical URL for the topic used to generate events Required Pattern: http://hl7.org/fhir/us/davinci-pas/SubscriptionTopic/PASSubscriptionTopic | |
| channel |
||||
| type |
1..1 | code | rest-hook | websocket | email | sms | message Required Pattern: rest-hook | |
| endpoint |
S | 1..1 | url | Where the channel points to |
| payload |
||||
| 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 Required Pattern: full-resource | |
| Documentation for this format | ||||
Snapshot ViewView
| 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 |
?!Σ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. Required Pattern: active | ||||
| 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 |
SΣ | 1..1 | string | Canonical URL for the topic used to generate events Required Pattern: http://hl7.org/fhir/us/davinci-pas/SubscriptionTopic/PASSubscriptionTopic | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:filterCriteria |
SΣ | 0..* | string | Filtering critiera applied to events 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 |
0..1 | unsignedInt | Interval in seconds to send 'heartbeat' notification 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 |
Σ | 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 | ||||
| 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 |
Σ | 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) | ||||
| 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) Required Pattern: full-resource | |||||
| 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()
|
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Financial Management.
Package hl7.fhir.us.davinci-pas#2.2.0 based on FHIR 4.0.1.
Generated
2026-03-02
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change