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 describes a particular client's request to be notified about a Topic.
    See Also:
    Serialized Form
    • Field Detail

      • identifier

        protected List<Identifier> identifier
        A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.
      • name

        protected StringType name
        A natural language name identifying the subscription.
      • topic

        protected Reference topic
        The reference to the topic to be notified about.
      • 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.
      • filterBy

        protected List<Subscription.SubscriptionFilterByComponent> filterBy
        The filter properties to be applied to narrow the topic stream. When multiple filters are applied, evaluates to true if all the conditions are met; otherwise it returns false. (i.e., logical AND).
      • error

        protected List<CodeableConcept> error
        A record of the last error that occurred when the server processed a notification.
      • eventCount

        protected UnsignedIntType eventCount
        A record of the number of events for which the server has attempted delivery on this subscription (i.e., the number of events that occurred while the subscription is in an "active" or "error" state -- not "requested" or "off"). Server Initializes to 0 for a new subscription. Repeated attempts at delivery of the *same* event notification do not increment this counter. Valid values are unsigned integers (0+). The decmial type is used to ensure that counts can grow larger than 32-bit values.
      • 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_PAYLOAD

        public static final String SP_PAYLOAD
        Search parameter: payload

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

        See Also:
        Constant Field Values
      • PAYLOAD

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

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

      • 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

      • 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