Package org.hl7.fhir.r5.model

Class Subscription

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.BaseResource
org.hl7.fhir.r5.model.Resource
org.hl7.fhir.r5.model.DomainResource
org.hl7.fhir.r5.model.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 SubscriptionTopic.
See Also:

  • Field Details

    • 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.

    • status

      protected Enumeration<Enumerations.SubscriptionState> status
      The status of the subscription, which marks the server state for managing the subscription.

    • topic

      protected CanonicalType topic
      The reference to the subscription 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 subscription topic stream. When multiple filters are applied, evaluates to true if all the conditions are met; otherwise it returns false. (i.e., logical AND).

    • channelType

      protected Coding channelType
      The type of channel to send notifications on.

    • endpoint

      protected UrlType endpoint
      The url that describes the actual end-point to send messages to.

    • heartbeatPeriod

      protected UnsignedIntType heartbeatPeriod
      If present, a 'hearbeat" notification (keepalive) is sent via this channel with an the interval period equal to this elements integer value in seconds. If not present, a heartbeat notification is not sent.

    • timeout

      protected UnsignedIntType timeout
      If present, the maximum amount of time a server will allow before failing a notification attempt.

    • contentType

      protected CodeType contentType
      The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. The MIME types "text/plain" and "text/html" may also be used for Email subscriptions.

    • content

      protected Enumeration<Subscription.SubscriptionPayloadContent> content
      How much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content.

    • notificationUrlLocation

      protected Enumeration<Subscription.SubscriptionUrlLocation> notificationUrlLocation
      If present, where to place URLs of resources in notifications.

    • maxCount

      protected PositiveIntType maxCount
      If present, the maximum number of triggering resources that will be included in a notification bundle (e.g., a server will not include more than this number of trigger resources in a single notification). Note that this is not a strict limit on the number of entries in a bundle, as dependent resources can be included.

    • SP_CONTACT

      public static final String SP_CONTACT
      Search parameter: contact

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

      See Also:

    • 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_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: A subscription identifier
      Type: token
      Path: Subscription.identifier

      See Also:

    • IDENTIFIER

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

      Description: A subscription identifier
      Type: token
      Path: Subscription.identifier

    • SP_PAYLOAD

      public static final String SP_PAYLOAD
      Search parameter: payload

      Description: The mime-type of the notification payload
      Type: token
      Path: null

      See Also:

    • 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: null

    • 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:

    • 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: null

      See Also:

    • 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: null

    • SP_URL

      public static final String SP_URL
      Search parameter: url

      Description: The uri that will receive the notifications
      Type: uri
      Path: null

      See Also:

    • 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: null

  • Constructor Details

  • Method Details

    • getIdentifier

      public List<Identifier> getIdentifier()
      Returns:
      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.)

    • setIdentifier

      public Subscription setIdentifier(List<Identifier> theIdentifier)
      Returns:
      Returns a reference to this for easy method chaining

    • hasIdentifier

      public boolean hasIdentifier()

    • addIdentifier

      public Identifier addIdentifier()

    • addIdentifier

      public Subscription addIdentifier(Identifier t)

    • getIdentifierFirstRep

      public Identifier getIdentifierFirstRep()
      Returns:
      The first repetition of repeating field identifier, creating it if it does not already exist {3}

    • getNameElement

      public StringType getNameElement()
      Returns:
      name (A natural language name identifying the subscription.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

    • hasNameElement

      public boolean hasNameElement()

    • hasName

      public boolean hasName()

    • setNameElement

      public Subscription setNameElement(StringType value)
      Parameters:
      value - name (A natural language name identifying the subscription.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

    • getName

      public String getName()
      Returns:
      A natural language name identifying the subscription.

    • setName

      public Subscription setName(String value)
      Parameters:
      value - A natural language name identifying the subscription.

    • getStatusElement

      public Enumeration<Enumerations.SubscriptionState> getStatusElement()
      Returns:
      status (The status of the subscription, which marks the server state for managing the subscription.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

    • hasStatusElement

      public boolean hasStatusElement()

    • hasStatus

      public boolean hasStatus()

    • setStatusElement

      public Subscription setStatusElement(Enumeration<Enumerations.SubscriptionState> value)
      Parameters:
      value - status (The status of the subscription, which marks the server state for managing the subscription.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

    • getStatus

      public Enumerations.SubscriptionState getStatus()
      Returns:
      The status of the subscription, which marks the server state for managing the subscription.

    • setStatus

      public Subscription setStatus(Enumerations.SubscriptionState value)
      Parameters:
      value - The status of the subscription, which marks the server state for managing the subscription.

    • getTopicElement

      public CanonicalType getTopicElement()
      Returns:
      topic (The reference to the subscription topic to be notified about.). This is the underlying object with id, value and extensions. The accessor "getTopic" gives direct access to the value

    • hasTopicElement

      public boolean hasTopicElement()

    • hasTopic

      public boolean hasTopic()

    • setTopicElement

      public Subscription setTopicElement(CanonicalType value)
      Parameters:
      value - topic (The reference to the subscription topic to be notified about.). This is the underlying object with id, value and extensions. The accessor "getTopic" gives direct access to the value

    • getTopic

      public String getTopic()
      Returns:
      The reference to the subscription topic to be notified about.

    • setTopic

      public Subscription setTopic(String value)
      Parameters:
      value - The reference to the subscription topic to be notified about.

    • getContact

      public List<ContactPoint> getContact()
      Returns:
      contact (Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.)

    • setContact

      public Subscription setContact(List<ContactPoint> theContact)
      Returns:
      Returns a reference to this for easy method chaining

    • hasContact

      public boolean hasContact()

    • addContact

      public ContactPoint addContact()

    • addContact

      public Subscription addContact(ContactPoint t)

    • getContactFirstRep

      public ContactPoint getContactFirstRep()
      Returns:
      The first repetition of repeating field contact, creating it if it does not already exist {3}

    • getEndElement

      public InstantType getEndElement()
      Returns:
      end (The time for the server to turn the subscription off.). This is the underlying object with id, value and extensions. The accessor "getEnd" gives direct access to the value

    • hasEndElement

      public boolean hasEndElement()

    • hasEnd

      public boolean hasEnd()

    • setEndElement

      public Subscription setEndElement(InstantType value)
      Parameters:
      value - end (The time for the server to turn the subscription off.). This is the underlying object with id, value and extensions. The accessor "getEnd" gives direct access to the value

    • getEnd

      public Date getEnd()
      Returns:
      The time for the server to turn the subscription off.

    • setEnd

      public Subscription setEnd(Date value)
      Parameters:
      value - The time for the server to turn the subscription off.

    • getReasonElement

      public StringType getReasonElement()
      Returns:
      reason (A description of why this subscription is defined.). This is the underlying object with id, value and extensions. The accessor "getReason" gives direct access to the value

    • hasReasonElement

      public boolean hasReasonElement()

    • hasReason

      public boolean hasReason()

    • setReasonElement

      public Subscription setReasonElement(StringType value)
      Parameters:
      value - reason (A description of why this subscription is defined.). This is the underlying object with id, value and extensions. The accessor "getReason" gives direct access to the value

    • getReason

      public String getReason()
      Returns:
      A description of why this subscription is defined.

    • setReason

      public Subscription setReason(String value)
      Parameters:
      value - A description of why this subscription is defined.

    • getFilterBy

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

    • setFilterBy

      public Subscription setFilterBy(List<Subscription.SubscriptionFilterByComponent> theFilterBy)
      Returns:
      Returns a reference to this for easy method chaining

    • hasFilterBy

      public boolean hasFilterBy()

    • addFilterBy

      public Subscription.SubscriptionFilterByComponent addFilterBy()

    • addFilterBy

      public Subscription addFilterBy(Subscription.SubscriptionFilterByComponent t)

    • getFilterByFirstRep

      public Subscription.SubscriptionFilterByComponent getFilterByFirstRep()
      Returns:
      The first repetition of repeating field filterBy, creating it if it does not already exist {3}

    • getChannelType

      public Coding getChannelType()
      Returns:
      channelType (The type of channel to send notifications on.)

    • hasChannelType

      public boolean hasChannelType()

    • setChannelType

      public Subscription setChannelType(Coding value)
      Parameters:
      value - channelType (The type of channel to send notifications on.)

    • getEndpointElement

      public UrlType getEndpointElement()
      Returns:
      endpoint (The url that describes the actual end-point to send messages to.). This is the underlying object with id, value and extensions. The accessor "getEndpoint" gives direct access to the value

    • hasEndpointElement

      public boolean hasEndpointElement()

    • hasEndpoint

      public boolean hasEndpoint()

    • setEndpointElement

      public Subscription setEndpointElement(UrlType value)
      Parameters:
      value - endpoint (The url that describes the actual end-point to send messages to.). This is the underlying object with id, value and extensions. The accessor "getEndpoint" gives direct access to the value

    • getEndpoint

      public String getEndpoint()
      Returns:
      The url that describes the actual end-point to send messages to.

    • setEndpoint

      public Subscription setEndpoint(String value)
      Parameters:
      value - The url that describes the actual end-point to send messages to.

    • getHeader

      public List<StringType> getHeader()
      Returns:
      header (Additional headers / information to send as part of the notification.)

    • setHeader

      public Subscription setHeader(List<StringType> theHeader)
      Returns:
      Returns a reference to this for easy method chaining

    • hasHeader

      public boolean hasHeader()

    • addHeaderElement

      public StringType addHeaderElement()
      Returns:
      header (Additional headers / information to send as part of the notification.)

    • addHeader

      public Subscription addHeader(String value)
      Parameters:
      value - header (Additional headers / information to send as part of the notification.)

    • hasHeader

      public boolean hasHeader(String value)
      Parameters:
      value - header (Additional headers / information to send as part of the notification.)

    • getHeartbeatPeriodElement

      public UnsignedIntType getHeartbeatPeriodElement()
      Returns:
      heartbeatPeriod (If present, a 'hearbeat" notification (keepalive) is sent via this channel with an the interval period equal to this elements integer value in seconds. If not present, a heartbeat notification is not sent.). This is the underlying object with id, value and extensions. The accessor "getHeartbeatPeriod" gives direct access to the value

    • hasHeartbeatPeriodElement

      public boolean hasHeartbeatPeriodElement()

    • hasHeartbeatPeriod

      public boolean hasHeartbeatPeriod()

    • setHeartbeatPeriodElement

      public Subscription setHeartbeatPeriodElement(UnsignedIntType value)
      Parameters:
      value - heartbeatPeriod (If present, a 'hearbeat" notification (keepalive) is sent via this channel with an the interval period equal to this elements integer value in seconds. If not present, a heartbeat notification is not sent.). This is the underlying object with id, value and extensions. The accessor "getHeartbeatPeriod" gives direct access to the value

    • getHeartbeatPeriod

      public int getHeartbeatPeriod()
      Returns:
      If present, a 'hearbeat" notification (keepalive) is sent via this channel with an the interval period equal to this elements integer value in seconds. If not present, a heartbeat notification is not sent.

    • setHeartbeatPeriod

      public Subscription setHeartbeatPeriod(int value)
      Parameters:
      value - If present, a 'hearbeat" notification (keepalive) is sent via this channel with an the interval period equal to this elements integer value in seconds. If not present, a heartbeat notification is not sent.

    • getTimeoutElement

      public UnsignedIntType getTimeoutElement()
      Returns:
      timeout (If present, the maximum amount of time a server will allow before failing a notification attempt.). This is the underlying object with id, value and extensions. The accessor "getTimeout" gives direct access to the value

    • hasTimeoutElement

      public boolean hasTimeoutElement()

    • hasTimeout

      public boolean hasTimeout()

    • setTimeoutElement

      public Subscription setTimeoutElement(UnsignedIntType value)
      Parameters:
      value - timeout (If present, the maximum amount of time a server will allow before failing a notification attempt.). This is the underlying object with id, value and extensions. The accessor "getTimeout" gives direct access to the value

    • getTimeout

      public int getTimeout()
      Returns:
      If present, the maximum amount of time a server will allow before failing a notification attempt.

    • setTimeout

      public Subscription setTimeout(int value)
      Parameters:
      value - If present, the maximum amount of time a server will allow before failing a notification attempt.

    • getContentTypeElement

      public CodeType getContentTypeElement()
      Returns:
      contentType (The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. The MIME types "text/plain" and "text/html" may also be used for Email subscriptions.). This is the underlying object with id, value and extensions. The accessor "getContentType" gives direct access to the value

    • hasContentTypeElement

      public boolean hasContentTypeElement()

    • hasContentType

      public boolean hasContentType()

    • setContentTypeElement

      public Subscription setContentTypeElement(CodeType value)
      Parameters:
      value - contentType (The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. The MIME types "text/plain" and "text/html" may also be used for Email subscriptions.). This is the underlying object with id, value and extensions. The accessor "getContentType" gives direct access to the value

    • getContentType

      public String getContentType()
      Returns:
      The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. The MIME types "text/plain" and "text/html" may also be used for Email subscriptions.

    • setContentType

      public Subscription setContentType(String value)
      Parameters:
      value - The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. The MIME types "text/plain" and "text/html" may also be used for Email subscriptions.

    • getContentElement

      public Enumeration<Subscription.SubscriptionPayloadContent> getContentElement()
      Returns:
      content (How much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content.). This is the underlying object with id, value and extensions. The accessor "getContent" gives direct access to the value

    • hasContentElement

      public boolean hasContentElement()

    • hasContent

      public boolean hasContent()

    • setContentElement

      public Subscription setContentElement(Enumeration<Subscription.SubscriptionPayloadContent> value)
      Parameters:
      value - content (How much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content.). This is the underlying object with id, value and extensions. The accessor "getContent" gives direct access to the value

    • getContent

      public Subscription.SubscriptionPayloadContent getContent()
      Returns:
      How much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content.

    • setContent

      public Subscription setContent(Subscription.SubscriptionPayloadContent value)
      Parameters:
      value - How much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content.

    • getNotificationUrlLocationElement

      public Enumeration<Subscription.SubscriptionUrlLocation> getNotificationUrlLocationElement()
      Returns:
      notificationUrlLocation (If present, where to place URLs of resources in notifications.). This is the underlying object with id, value and extensions. The accessor "getNotificationUrlLocation" gives direct access to the value

    • hasNotificationUrlLocationElement

      public boolean hasNotificationUrlLocationElement()

    • hasNotificationUrlLocation

      public boolean hasNotificationUrlLocation()

    • setNotificationUrlLocationElement

      public Subscription setNotificationUrlLocationElement(Enumeration<Subscription.SubscriptionUrlLocation> value)
      Parameters:
      value - notificationUrlLocation (If present, where to place URLs of resources in notifications.). This is the underlying object with id, value and extensions. The accessor "getNotificationUrlLocation" gives direct access to the value

    • getNotificationUrlLocation

      public Subscription.SubscriptionUrlLocation getNotificationUrlLocation()
      Returns:
      If present, where to place URLs of resources in notifications.

    • setNotificationUrlLocation

      public Subscription setNotificationUrlLocation(Subscription.SubscriptionUrlLocation value)
      Parameters:
      value - If present, where to place URLs of resources in notifications.

    • getMaxCountElement

      public PositiveIntType getMaxCountElement()
      Returns:
      maxCount (If present, the maximum number of triggering resources that will be included in a notification bundle (e.g., a server will not include more than this number of trigger resources in a single notification). Note that this is not a strict limit on the number of entries in a bundle, as dependent resources can be included.). This is the underlying object with id, value and extensions. The accessor "getMaxCount" gives direct access to the value

    • hasMaxCountElement

      public boolean hasMaxCountElement()

    • hasMaxCount

      public boolean hasMaxCount()

    • setMaxCountElement

      public Subscription setMaxCountElement(PositiveIntType value)
      Parameters:
      value - maxCount (If present, the maximum number of triggering resources that will be included in a notification bundle (e.g., a server will not include more than this number of trigger resources in a single notification). Note that this is not a strict limit on the number of entries in a bundle, as dependent resources can be included.). This is the underlying object with id, value and extensions. The accessor "getMaxCount" gives direct access to the value

    • getMaxCount

      public int getMaxCount()
      Returns:
      If present, the maximum number of triggering resources that will be included in a notification bundle (e.g., a server will not include more than this number of trigger resources in a single notification). Note that this is not a strict limit on the number of entries in a bundle, as dependent resources can be included.

    • setMaxCount

      public Subscription setMaxCount(int value)
      Parameters:
      value - If present, the maximum number of triggering resources that will be included in a notification bundle (e.g., a server will not include more than this number of trigger resources in a single notification). Note that this is not a strict limit on the number of entries in a bundle, as dependent resources can be included.

    • listChildren

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class DomainResource

    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getProperty

      public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • fhirType

      public String fhirType()
      Specified by:
      fhirType in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      fhirType in class DomainResource

    • copy

      public Subscription copy()
      Specified by:
      copy in class DomainResource

    • copyValues

      public void copyValues(Subscription dst)

    • typedCopy

      protected Subscription typedCopy()

    • equalsDeep

      public boolean equalsDeep(Base other_)
      Overrides:
      equalsDeep in class DomainResource

    • equalsShallow

      public boolean equalsShallow(Base other_)
      Overrides:
      equalsShallow in class DomainResource

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      isEmpty in class DomainResource

    • getResourceType

      public ResourceType getResourceType()
      Specified by:
      getResourceType in class Resource