extension shown: fhir [x]

Subscription

Defined in the fhir.schema.org extension.
Canonical URL: http://schema.org/Subscription

Thing > Resource > DomainResource > Subscription
infrastructure.exchange > Subscription

Base StructureDefinition for Subscription Resource

Usage: Fewer than 10 domains
PropertyExpected TypeDescription
Properties from Subscription
Subscription.channel BackboneElement Details where to send notifications when resources are received that meet the criteria.
Subscription.channel.endpoint Text The uri that describes the actual end-point to send messages to.
Subscription.channel.header Text Additional headers / information to send as part of the notification.
Subscription.channel.payload Text The mime type to send the payload in - either application/xml+fhir, or application/json+fhir. If the mime type is blank, then there is no payload in the notification, just a notification.
Subscription.channel.type subscription-channel-type The type of channel to send notifications on.
Subscription.contact ContactPoint Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
Subscription.criteria Text The rules that the server should use to determine when to generate notifications for this subscription.
Subscription.end DateTime The time for the server to turn the subscription off.
Subscription.error Text A record of the last error that occurred when the server processed a notification.
Subscription.reason Text A description of why this subscription is defined.
Subscription.status subscription-status The status of the subscription, which marks the server state for managing the subscription.
Subscription.tag Coding A tag to add to any resource that matches the criteria, after the subscription is processed.
Properties from DomainResource
DomainResource.contained Resource These 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.
DomainResource.extension Extension May be used to represent additional information that is not part of the basic definition of the resource. In order 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.
DomainResource.modifierExtension Extension May 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. Usually modifier elements provide negation or qualification. In order 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.
DomainResource.text Narrative A human-readable narrative that contains a summary of the resource, and may 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.
Properties from Resource
Resource.id Text The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Resource.implicitRules Text A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Resource.language http://tools.ietf.org/html/bcp47 The base language in which the resource is written.
Resource.meta Meta The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Properties from Thing
additionalType URL An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
alternateName Text An alias for the item.
description Text A description of the item.
disambiguatingDescription Text A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
image URL  or
ImageObject 
An image of the item. This can be a URL or a fully described ImageObject.
mainEntityOfPage CreativeWork  or
URL 
Indicates a page (or other CreativeWork) for which this thing is the main entity being described.

See background notes for details.
Inverse property: mainEntity.
name Text The name of the item.
potentialAction Action Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
sameAs URL URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Freebase page, or official website.
url URL URL of the item.

Available supertypes defined in extensions

Schema Version 2.2