Subscription

The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action.

Structure

Search Parameters

payload (token)

The mime-type of the notification payload

Subscription.channel.payload

_id (token)

Logical id of this artifact

Resource.id

_query (token)

A custom search profile that describes a specific defined query operation

SubscriptionCustomChannelSearchParameter (token)

This SearchParameter enables query of subscriptions by additional channel type.

extension('http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type').value.ofType(Coding)

_content (string)

Search on the entire content of the resource

SubscriptionPayloadTypeSearchParameter (token)

This SearchParameter enables query of subscriptions by payload type.

extension('http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content').value.ofType(code)

url (uri)

The uri that will receive the notifications

Subscription.channel.endpoint

_tag (token)

Tags applied to this resource

Resource.meta.tag

_type (token)

Derived from the R4B Definition

$this.type().name

_profile (uri)

Profiles this resource claims to conform to

Resource.meta.profile

SubscriptionFilterCriteriaSearchParameter (string)

This SearchParameter enables query of subscriptions by filter criteria.

extension('http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria').value.ofType(string)

_lastUpdated (date)

When the resource version last changed

Resource.meta.lastUpdated

contact (token)

Contact details for the subscription

Subscription.contact

SubscriptionIdentifierSearchParameter (token)

This SearchParameter enables query of subscriptions by identifier.

extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.identifier').value.ofType(Identifier)

SubscriptionTopicSearchParameter (string)

This SearchParameter enables query of subscriptions by canonical topic url.

Subscription.criteria

status (token)

The current state of the subscription

Subscription.status

criteria (string)

The search rules used to determine when to send a notification

Subscription.criteria

_text (string)

Search on the narrative of the resource

_haste-health-author (reference)

The author of the resource

Resource.meta.extension.where(url='https://haste.health/author').value

_security (token)

Security Labels applied to this resource

Resource.meta.security

type (token)

The type of channel for the sent notifications

Subscription.channel.type

_source (uri)

Identifies where the resource comes from

Resource.meta.source