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 Topic.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSubscription.SubscriptionChannelComponentstatic classSubscription.SubscriptionChannelPayloadComponentstatic classSubscription.SubscriptionFilterByComponentstatic classSubscription.SubscriptionFilterByMatchTypestatic classSubscription.SubscriptionFilterByMatchTypeEnumFactorystatic classSubscription.SubscriptionPayloadContentstatic classSubscription.SubscriptionPayloadContentEnumFactorystatic classSubscription.SubscriptionStatusstatic classSubscription.SubscriptionStatusEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected Subscription.SubscriptionChannelComponentchannelDetails where to send notifications when resources are received that meet the criteria.protected List<ContactPoint>contactContact details for a human to contact about the subscription.static ca.uhn.fhir.rest.gclient.TokenClientParamCONTACTFluent Client search parameter constant for contactprotected InstantTypeendThe time for the server to turn the subscription off.protected List<CodeableConcept>errorA record of the last error that occurred when the server processed a notification.protected UnsignedIntTypeeventCountA 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").protected List<Subscription.SubscriptionFilterByComponent>filterByThe filter properties to be applied to narrow the topic stream.protected List<Identifier>identifierA 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.protected StringTypenameA natural language name identifying the subscription.static ca.uhn.fhir.rest.gclient.TokenClientParamPAYLOADFluent Client search parameter constant for payloadprotected StringTypereasonA description of why this subscription is defined.static StringSP_CONTACTSearch parameter: contactstatic StringSP_PAYLOADSearch parameter: payloadstatic StringSP_STATUSSearch parameter: statusstatic StringSP_TYPESearch parameter: typestatic StringSP_URLSearch parameter: urlprotected Enumeration<Subscription.SubscriptionStatus>statusThe status of the subscription, which marks the server state for managing the subscription.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected ReferencetopicThe reference to the topic to be notified about.static ca.uhn.fhir.rest.gclient.TokenClientParamTYPEFluent Client search parameter constant for typestatic ca.uhn.fhir.rest.gclient.UriClientParamURLFluent Client search parameter constant for url-
Fields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
-
Fields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description Subscription()ConstructorSubscription(Subscription.SubscriptionStatus status, Reference topic, Subscription.SubscriptionChannelComponent channel)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
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.
-
status
protected Enumeration<Subscription.SubscriptionStatus> status
The status of the subscription, which marks the server state for managing the subscription.
-
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.
-
channel
protected Subscription.SubscriptionChannelComponent channel
Details where to send notifications when resources are received that meet the criteria.
-
SP_CONTACT
public static final String SP_CONTACT
Search parameter: contactDescription: 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 contactDescription: Contact details for the subscription
Type: token
Path: Subscription.contact
-
SP_PAYLOAD
public static final String SP_PAYLOAD
Search parameter: payloadDescription: 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 payloadDescription: The mime-type of the notification payload
Type: token
Path: Subscription.channel.payload.contentType
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: 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 statusDescription: The current state of the subscription
Type: token
Path: Subscription.status
-
SP_TYPE
public static final String SP_TYPE
Search parameter: typeDescription: 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 typeDescription: The type of channel for the sent notifications
Type: token
Path: Subscription.channel.type
-
SP_URL
public static final String SP_URL
Search parameter: urlDescription: 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 urlDescription: The uri that will receive the notifications
Type: uri
Path: Subscription.channel.endpoint
-
-
Constructor Detail
-
Subscription
public Subscription()
Constructor
-
Subscription
public Subscription(Subscription.SubscriptionStatus status, Reference topic, Subscription.SubscriptionChannelComponent channel)
Constructor
-
-
Method Detail
-
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
thisfor 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
-
setName
public Subscription setName(String value)
- Parameters:
value- A natural language name identifying the subscription.
-
getStatusElement
public Enumeration<Subscription.SubscriptionStatus> 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<Subscription.SubscriptionStatus> 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 Subscription.SubscriptionStatus getStatus()
- Returns:
- The status of the subscription, which marks the server state for managing the subscription.
-
setStatus
public Subscription setStatus(Subscription.SubscriptionStatus value)
- Parameters:
value- The status of the subscription, which marks the server state for managing the subscription.
-
getTopic
public Reference getTopic()
- Returns:
topic(The reference to the topic to be notified about.)
-
hasTopic
public boolean hasTopic()
-
setTopic
public Subscription setTopic(Reference value)
- Parameters:
value-topic(The reference to the 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
thisfor 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
-
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
-
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 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
thisfor 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}
-
getError
public List<CodeableConcept> getError()
- Returns:
error(A record of the last error that occurred when the server processed a notification.)
-
setError
public Subscription setError(List<CodeableConcept> theError)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasError
public boolean hasError()
-
addError
public CodeableConcept addError()
-
addError
public Subscription addError(CodeableConcept t)
-
getErrorFirstRep
public CodeableConcept getErrorFirstRep()
- Returns:
- The first repetition of repeating field
error, creating it if it does not already exist {3}
-
getEventCountElement
public UnsignedIntType getEventCountElement()
- Returns:
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.). This is the underlying object with id, value and extensions. The accessor "getEventCount" gives direct access to the value
-
hasEventCountElement
public boolean hasEventCountElement()
-
hasEventCount
public boolean hasEventCount()
-
setEventCountElement
public Subscription setEventCountElement(UnsignedIntType value)
- Parameters:
value-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.). This is the underlying object with id, value and extensions. The accessor "getEventCount" gives direct access to the value
-
getEventCount
public int getEventCount()
- Returns:
- 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.
-
setEventCount
public Subscription setEventCount(int value)
- Parameters:
value- 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.
-
getChannel
public Subscription.SubscriptionChannelComponent getChannel()
- Returns:
channel(Details where to send notifications when resources are received that meet the criteria.)
-
hasChannel
public boolean hasChannel()
-
setChannel
public Subscription setChannel(Subscription.SubscriptionChannelComponent value)
- Parameters:
value-channel(Details where to send notifications when resources are received that meet the criteria.)
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public Subscription copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(Subscription dst)
-
typedCopy
protected Subscription typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-