Subscription

open class Subscription: DomainResource

A server push subscription criteria.

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 is able to take an appropriate action.

  • A server push subscription criteria.

    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 is able to take an appropriate action.

    Declaration

    Swift

    override open class var resourceType: String

  • The channel on which to report matches to the criteria.

    Declaration

    Swift

    public var channel: SubscriptionChannel?

  • Contact details for source (e.g. troubleshooting).

    Declaration

    Swift

    public var contact: [ContactPoint]?

  • Rule for server push criteria.

    Declaration

    Swift

    public var criteria: FHIRString?
  • end

    When to automatically delete the subscription.

    Declaration

    Swift

    public var end: Instant?

  • Latest error note.

    Declaration

    Swift

    public var error: FHIRString?

  • Description of why this subscription was created.

    Declaration

    Swift

    public var reason: FHIRString?

  • The status of the subscription, which marks the server state for managing the subscription.

    Declaration

    Swift

    public var status: SubscriptionStatus?
  • tag

    A tag to add to matching resources.

    Declaration

    Swift

    public var tag: [Coding]?

  • Convenience initializer, taking all required properties as arguments.

    Declaration

    Swift

    public convenience init(channel: SubscriptionChannel, criteria: FHIRString, reason: FHIRString, status: SubscriptionStatus)

  • Convenience initializer, taking all required properties as arguments.

    Declaration

    Swift

    override open func populate(from json: FHIRJSON, context instCtx: inout FHIRInstantiationContext)

  • Undocumented

    Declaration

    Swift

    open class Subscription: DomainResource