Skip to main content

Subscription

PropertyValue
Publisher
NameSubscription
URLhttp://hl7.org/fhir/StructureDefinition/Subscription
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
Subscription0..*SubscriptionThe 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.
Subscription.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Subscription.meta0..1MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Subscription.implicitRules0..1uriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Subscription.language0..1codeThe base language in which the resource is written.
Subscription.text0..1NarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Subscription.contained0..*ResourceThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Subscription.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Subscription.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Subscription.status1..1codeThe status of the subscription, which marks the server state for managing the subscription.
Subscription.contact0..*ContactPointContact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
Subscription.end0..1instantThe time for the server to turn the subscription off.
Subscription.reason1..1stringA description of why this subscription is defined.
Subscription.criteria1..1stringThe rules that the server should use to determine when to generate notifications for this subscription.
Subscription.error0..1stringA record of the last error that occurred when the server processed a notification.
Subscription.channel1..1BackboneElementDetails where to send notifications when resources are received that meet the criteria.
Subscription.channel.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Subscription.channel.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Subscription.channel.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Subscription.channel.type1..1codeThe type of channel to send notifications on.
Subscription.channel.endpoint0..1urlThe url that describes the actual end-point to send messages to.
Subscription.channel.payload0..1codeThe mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification. The mime type "text/plain" may also be used for Email and SMS subscriptions.
Subscription.channel.header0..*stringAdditional headers / information to send as part of the notification.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
contacttokenContact details for the subscriptionSubscription.contact
criteriastringThe search rules used to determine when to send a notificationSubscription.criteria
payloadtokenThe mime-type of the notification payloadSubscription.channel.payload
statustokenThe current state of the subscriptionSubscription.status
typetokenThe type of channel for the sent notificationsSubscription.channel.type
urluriThe uri that will receive the notificationsSubscription.channel.endpoint