Class Subscription

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

    public class Subscription
    extends DomainResource
    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.
    See Also:
    Serialized Form
    • Field Detail

      • contact

        protected List<ContactPoint> contact
        Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
      • end

        protected InstantType end
        The time for the server to turn the subscription off.
      • reason

        protected StringType reason
        A description of why this subscription is defined.
      • criteria

        protected StringType criteria
        The rules that the server should use to determine when to generate notifications for this subscription.
      • error

        protected StringType error
        A record of the last error that occurred when the server processed a notification.
      • tag

        protected List<Coding> tag
        A tag to add to any resource that matches the criteria, after the subscription is processed.
      • SP_PAYLOAD

        public static final String SP_PAYLOAD
        Search parameter: payload

        Description: The mime-type of the notification payload
        Type: string
        Path: Subscription.channel.payload

        See Also:
        Constant Field Values
      • PAYLOAD

        public static final ca.uhn.fhir.rest.gclient.StringClientParam PAYLOAD
        Fluent Client search parameter constant for payload

        Description: The mime-type of the notification payload
        Type: string
        Path: Subscription.channel.payload

      • SP_CRITERIA

        public static final String SP_CRITERIA
        Search parameter: criteria

        Description: The search rules used to determine when to send a notification
        Type: string
        Path: Subscription.criteria

        See Also:
        Constant Field Values
      • CRITERIA

        public static final ca.uhn.fhir.rest.gclient.StringClientParam CRITERIA
        Fluent Client search parameter constant for criteria

        Description: The search rules used to determine when to send a notification
        Type: string
        Path: Subscription.criteria

      • SP_ADD_TAG

        public static final String SP_ADD_TAG
        Search parameter: add-tag

        Description: A tag to be added to the resource matching the criteria
        Type: token
        Path: Subscription.tag

        See Also:
        Constant Field Values
      • ADD_TAG

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam ADD_TAG
        Fluent Client search parameter constant for add-tag

        Description: A tag to be added to the resource matching the criteria
        Type: token
        Path: Subscription.tag

      • SP_CONTACT

        public static final String SP_CONTACT
        Search parameter: contact

        Description: Contact details for the subscription
        Type: token
        Path: Subscription.contact

        See Also:
        Constant Field Values
      • CONTACT

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTACT
        Fluent Client search parameter constant for contact

        Description: Contact details for the subscription
        Type: token
        Path: Subscription.contact

      • SP_TYPE

        public static final String SP_TYPE
        Search parameter: type

        Description: The type of channel for the sent notifications
        Type: token
        Path: Subscription.channel.type

        See Also:
        Constant Field Values
      • TYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
        Fluent Client search parameter constant for type

        Description: The type of channel for the sent notifications
        Type: token
        Path: Subscription.channel.type

      • SP_URL

        public static final String SP_URL
        Search parameter: url

        Description: The uri that will receive the notifications
        Type: uri
        Path: Subscription.channel.endpoint

        See Also:
        Constant Field Values
      • URL

        public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
        Fluent Client search parameter constant for url

        Description: The uri that will receive the notifications
        Type: uri
        Path: Subscription.channel.endpoint

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: The current state of the subscription
        Type: token
        Path: Subscription.status

        See Also:
        Constant Field Values
      • STATUS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
        Fluent Client search parameter constant for status

        Description: The current state of the subscription
        Type: token
        Path: Subscription.status