Da Vinci Prior Authorization Support (PAS) FHIR IG
2.2.1 - STU 2.2 United States of America flag

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.1 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

Resource Profile: PAS Subscription

Official URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-subscription Version: 2.2.1
Standards status: Trial-use 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

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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.
... 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
....... Slices for value[x] Content/Rules for all slices
........ value[x]:valueCode 0..1 code Value of extension
Binding: Backported R5 Subscription Content Value Set (required)
Required Pattern: full-resource

doco Documentation for this format

Terminology Bindings

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

Constraints

Id Grade Path(s) Description Expression

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Subscription 0..* BackportSubscription Server push subscription criteria
... 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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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.
... 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
....... Slices for value[x] Content/Rules for all slices
........ 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

doco Documentation for this format

Terminology Bindings

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

Constraints

Id Grade Path(s) Description Expression

Summary

Mandatory: 1 element
Must-Support: 1 element

Maturity: 4

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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.
... 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
....... Slices for value[x] Content/Rules for all slices
........ value[x]:valueCode 0..1 code Value of extension
Binding: Backported R5 Subscription Content Value Set (required)
Required Pattern: full-resource

doco Documentation for this format

Terminology Bindings

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

Constraints

Id Grade Path(s) Description Expression

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Subscription 0..* BackportSubscription Server push subscription criteria
... 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

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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.
... 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
....... Slices for value[x] Content/Rules for all slices
........ 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

doco Documentation for this format

Terminology Bindings

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

Constraints

Id Grade Path(s) Description Expression

Summary

Mandatory: 1 element
Must-Support: 1 element

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron