
Class Subscription
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.BaseResource
-
- org.hl7.fhir.dstu3.model.Resource
-
- org.hl7.fhir.dstu3.model.DomainResource
-
- org.hl7.fhir.dstu3.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 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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Subscription.SubscriptionChannelComponent
static class
Subscription.SubscriptionChannelType
static class
Subscription.SubscriptionChannelTypeEnumFactory
static class
Subscription.SubscriptionStatus
static class
Subscription.SubscriptionStatusEnumFactory
-
Field Summary
Fields Modifier and Type Field Description static ca.uhn.fhir.rest.gclient.TokenClientParam
ADD_TAG
Fluent Client search parameter constant for add-tagprotected Subscription.SubscriptionChannelComponent
channel
Details where to send notifications when resources are received that meet the criteria.protected List<ContactPoint>
contact
Contact details for a human to contact about the subscription.static ca.uhn.fhir.rest.gclient.TokenClientParam
CONTACT
Fluent Client search parameter constant for contactprotected StringType
criteria
The rules that the server should use to determine when to generate notifications for this subscription.static ca.uhn.fhir.rest.gclient.StringClientParam
CRITERIA
Fluent Client search parameter constant for criteriaprotected InstantType
end
The time for the server to turn the subscription off.protected StringType
error
A record of the last error that occurred when the server processed a notification.static ca.uhn.fhir.rest.gclient.StringClientParam
PAYLOAD
Fluent Client search parameter constant for payloadprotected StringType
reason
A description of why this subscription is defined.static String
SP_ADD_TAG
Search parameter: add-tagstatic String
SP_CONTACT
Search parameter: contactstatic String
SP_CRITERIA
Search parameter: criteriastatic String
SP_PAYLOAD
Search parameter: payloadstatic String
SP_STATUS
Search parameter: statusstatic String
SP_TYPE
Search parameter: typestatic String
SP_URL
Search parameter: urlprotected Enumeration<Subscription.SubscriptionStatus>
status
The status of the subscription, which marks the server state for managing the subscription.static ca.uhn.fhir.rest.gclient.TokenClientParam
STATUS
Fluent Client search parameter constant for statusprotected List<Coding>
tag
A tag to add to any resource that matches the criteria, after the subscription is processed.static ca.uhn.fhir.rest.gclient.TokenClientParam
TYPE
Fluent Client search parameter constant for typestatic ca.uhn.fhir.rest.gclient.UriClientParam
URL
Fluent Client search parameter constant for url-
Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description Subscription()
ConstructorSubscription(Enumeration<Subscription.SubscriptionStatus> status, StringType reason, StringType criteria, Subscription.SubscriptionChannelComponent channel)
Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, 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.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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
-
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.
-
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.
-
channel
protected Subscription.SubscriptionChannelComponent channel
Details where to send notifications when resources are received that meet the criteria.
-
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: payloadDescription: 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 payloadDescription: The mime-type of the notification payload
Type: string
Path: Subscription.channel.payload
-
SP_CRITERIA
public static final String SP_CRITERIA
Search parameter: criteriaDescription: 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 criteriaDescription: 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-tagDescription: 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-tagDescription: 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: 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_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
-
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
-
-
Constructor Detail
-
Subscription
public Subscription()
Constructor
-
Subscription
public Subscription(Enumeration<Subscription.SubscriptionStatus> status, StringType reason, StringType criteria, Subscription.SubscriptionChannelComponent channel)
Constructor
-
-
Method Detail
-
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.
-
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
-
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.
-
getCriteriaElement
public StringType getCriteriaElement()
- Returns:
criteria
(The rules that the server should use to determine when to generate notifications for this subscription.). This is the underlying object with id, value and extensions. The accessor "getCriteria" gives direct access to the value
-
hasCriteriaElement
public boolean hasCriteriaElement()
-
hasCriteria
public boolean hasCriteria()
-
setCriteriaElement
public Subscription setCriteriaElement(StringType value)
- Parameters:
value
-criteria
(The rules that the server should use to determine when to generate notifications for this subscription.). This is the underlying object with id, value and extensions. The accessor "getCriteria" gives direct access to the value
-
getCriteria
public String getCriteria()
- Returns:
- The rules that the server should use to determine when to generate notifications for this subscription.
-
setCriteria
public Subscription setCriteria(String value)
- Parameters:
value
- The rules that the server should use to determine when to generate notifications for this subscription.
-
getErrorElement
public StringType getErrorElement()
- Returns:
error
(A record of the last error that occurred when the server processed a notification.). This is the underlying object with id, value and extensions. The accessor "getError" gives direct access to the value
-
hasErrorElement
public boolean hasErrorElement()
-
hasError
public boolean hasError()
-
setErrorElement
public Subscription setErrorElement(StringType value)
- Parameters:
value
-error
(A record of the last error that occurred when the server processed a notification.). This is the underlying object with id, value and extensions. The accessor "getError" gives direct access to the value
-
getError
public String getError()
- Returns:
- A record of the last error that occurred when the server processed a notification.
-
setError
public Subscription setError(String value)
- Parameters:
value
- A record of the last error that occurred when the server processed a notification.
-
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.)
-
getTag
public List<Coding> getTag()
- Returns:
tag
(A tag to add to any resource that matches the criteria, after the subscription is processed.)
-
setTag
public Subscription setTag(List<Coding> theTag)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasTag
public boolean hasTag()
-
addTag
public Subscription addTag(Coding t)
-
getTagFirstRep
public Coding getTagFirstRep()
- Returns:
- The first repetition of repeating field
tag
, creating it if it does not already exist
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
public Subscription copy()
- Specified by:
copy
in classDomainResource
-
typedCopy
protected Subscription typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceType
in classResource
-
-