Package org.hl7.fhir.r5.model

Class SubscriptionStatus

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

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 SubscriptionStatus
extends DomainResource

The SubscriptionStatus resource describes the state of a Subscription during notifications. It is not persisted.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SubscriptionStatus.SubscriptionNotificationType
static class	SubscriptionStatus.SubscriptionNotificationTypeEnumFactory
static class	SubscriptionStatus.SubscriptionStatusNotificationEventComponent

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected List<CodeableConcept>	error	A record of errors that occurred when the server processed a notification.
protected Integer64Type	eventsSinceSubscriptionStart	The total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated.
protected List<SubscriptionStatus.SubscriptionStatusNotificationEventComponent>	notificationEvent	Detailed information about events relevant to this subscription notification.
protected Enumeration<Enumerations.SubscriptionStatusCodes>	status	The status of the subscription, which marks the server state for managing the subscription.
protected Reference	subscription	The reference to the Subscription which generated this notification.
protected CanonicalType	topic	The reference to the SubscriptionTopic for the Subscription which generated this notification.
protected Enumeration<SubscriptionStatus.SubscriptionNotificationType>	type	The type of event being conveyed with this notification.

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

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
SubscriptionStatus()	Constructor
SubscriptionStatus(SubscriptionStatus.SubscriptionNotificationType type, Reference subscription)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
CodeableConcept	addError()
SubscriptionStatus	addError(CodeableConcept t)
SubscriptionStatus.SubscriptionStatusNotificationEventComponent	addNotificationEvent()
SubscriptionStatus	addNotificationEvent(SubscriptionStatus.SubscriptionStatusNotificationEventComponent t)
SubscriptionStatus	copy()
void	copyValues(SubscriptionStatus dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<CodeableConcept>	getError()
CodeableConcept	getErrorFirstRep()
long	getEventsSinceSubscriptionStart()
Integer64Type	getEventsSinceSubscriptionStartElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<SubscriptionStatus.SubscriptionStatusNotificationEventComponent>	getNotificationEvent()
SubscriptionStatus.SubscriptionStatusNotificationEventComponent	getNotificationEventFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
Enumerations.SubscriptionStatusCodes	getStatus()
Enumeration<Enumerations.SubscriptionStatusCodes>	getStatusElement()
Reference	getSubscription()
String	getTopic()
CanonicalType	getTopicElement()
SubscriptionStatus.SubscriptionNotificationType	getType()
Enumeration<SubscriptionStatus.SubscriptionNotificationType>	getTypeElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasError()
boolean	hasEventsSinceSubscriptionStart()
boolean	hasEventsSinceSubscriptionStartElement()
boolean	hasNotificationEvent()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubscription()
boolean	hasTopic()
boolean	hasTopicElement()
boolean	hasType()
boolean	hasTypeElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
SubscriptionStatus	setError(List<CodeableConcept> theError)
SubscriptionStatus	setEventsSinceSubscriptionStart(long value)
SubscriptionStatus	setEventsSinceSubscriptionStartElement(Integer64Type value)
SubscriptionStatus	setNotificationEvent(List<SubscriptionStatus.SubscriptionStatusNotificationEventComponent> theNotificationEvent)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
SubscriptionStatus	setStatus(Enumerations.SubscriptionStatusCodes value)
SubscriptionStatus	setStatusElement(Enumeration<Enumerations.SubscriptionStatusCodes> value)
SubscriptionStatus	setSubscription(Reference value)
SubscriptionStatus	setTopic(String value)
SubscriptionStatus	setTopicElement(CanonicalType value)
SubscriptionStatus	setType(SubscriptionStatus.SubscriptionNotificationType value)
SubscriptionStatus	setTypeElement(Enumeration<SubscriptionStatus.SubscriptionNotificationType> value)
protected SubscriptionStatus	typedCopy()

Methods inherited from class org.hl7.fhir.r5.model.DomainResource

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setText

Methods inherited from class org.hl7.fhir.r5.model.Resource

copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath

Methods inherited from class org.hl7.fhir.r5.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r5.model.Base

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, 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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

status

protected Enumeration<Enumerations.SubscriptionStatusCodes> status

The status of the subscription, which marks the server state for managing the subscription.

type

protected Enumeration<SubscriptionStatus.SubscriptionNotificationType> type

The type of event being conveyed with this notification.

eventsSinceSubscriptionStart

protected Integer64Type eventsSinceSubscriptionStart

The total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated. This number is NOT incremented for handshake and heartbeat notifications.

notificationEvent

protected List<SubscriptionStatus.SubscriptionStatusNotificationEventComponent> notificationEvent

Detailed information about events relevant to this subscription notification.

subscription

protected Reference subscription

The reference to the Subscription which generated this notification.

topic

protected CanonicalType topic

The reference to the SubscriptionTopic for the Subscription which generated this notification.

error

protected List<CodeableConcept> error

A record of errors that occurred when the server processed a notification.

Constructor Details

SubscriptionStatus

public SubscriptionStatus()

Constructor

SubscriptionStatus

public SubscriptionStatus(SubscriptionStatus.SubscriptionNotificationType type,
 Reference subscription)

Constructor

Method Details

getStatusElement

public Enumeration<Enumerations.SubscriptionStatusCodes> 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 SubscriptionStatus setStatusElement(Enumeration<Enumerations.SubscriptionStatusCodes> 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.SubscriptionStatusCodes getStatus()

Returns:

The status of the subscription, which marks the server state for managing the subscription.

setStatus

public SubscriptionStatus setStatus(Enumerations.SubscriptionStatusCodes value)

Parameters:

value - The status of the subscription, which marks the server state for managing the subscription.

getTypeElement

public Enumeration<SubscriptionStatus.SubscriptionNotificationType> getTypeElement()

Returns:

type (The type of event being conveyed with this notification.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

hasTypeElement

public boolean hasTypeElement()

hasType

public boolean hasType()

setTypeElement

public SubscriptionStatus setTypeElement(Enumeration<SubscriptionStatus.SubscriptionNotificationType> value)

Parameters:

value - type (The type of event being conveyed with this notification.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

getType

public SubscriptionStatus.SubscriptionNotificationType getType()

Returns:

The type of event being conveyed with this notification.

setType

public SubscriptionStatus setType(SubscriptionStatus.SubscriptionNotificationType value)

Parameters:

value - The type of event being conveyed with this notification.

getEventsSinceSubscriptionStartElement

public Integer64Type getEventsSinceSubscriptionStartElement()

Returns:

eventsSinceSubscriptionStart (The total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated. This number is NOT incremented for handshake and heartbeat notifications.). This is the underlying object with id, value and extensions. The accessor "getEventsSinceSubscriptionStart" gives direct access to the value

hasEventsSinceSubscriptionStartElement

public boolean hasEventsSinceSubscriptionStartElement()

hasEventsSinceSubscriptionStart

public boolean hasEventsSinceSubscriptionStart()

setEventsSinceSubscriptionStartElement

public SubscriptionStatus setEventsSinceSubscriptionStartElement(Integer64Type value)

Parameters:

value - eventsSinceSubscriptionStart (The total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated. This number is NOT incremented for handshake and heartbeat notifications.). This is the underlying object with id, value and extensions. The accessor "getEventsSinceSubscriptionStart" gives direct access to the value

getEventsSinceSubscriptionStart

public long getEventsSinceSubscriptionStart()

Returns:

The total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated. This number is NOT incremented for handshake and heartbeat notifications.

setEventsSinceSubscriptionStart

public SubscriptionStatus setEventsSinceSubscriptionStart(long value)

Parameters:

value - The total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated. This number is NOT incremented for handshake and heartbeat notifications.

getNotificationEvent

public List<SubscriptionStatus.SubscriptionStatusNotificationEventComponent> getNotificationEvent()

Returns:

notificationEvent (Detailed information about events relevant to this subscription notification.)

setNotificationEvent

public SubscriptionStatus setNotificationEvent(List<SubscriptionStatus.SubscriptionStatusNotificationEventComponent> theNotificationEvent)

Returns:

Returns a reference to this for easy method chaining

hasNotificationEvent

public boolean hasNotificationEvent()

addNotificationEvent

public SubscriptionStatus.SubscriptionStatusNotificationEventComponent addNotificationEvent()

addNotificationEvent

public SubscriptionStatus addNotificationEvent(SubscriptionStatus.SubscriptionStatusNotificationEventComponent t)

getNotificationEventFirstRep

public SubscriptionStatus.SubscriptionStatusNotificationEventComponent getNotificationEventFirstRep()

Returns:

The first repetition of repeating field notificationEvent, creating it if it does not already exist {3}

getSubscription

public Reference getSubscription()

Returns:

subscription (The reference to the Subscription which generated this notification.)

hasSubscription

public boolean hasSubscription()

setSubscription

public SubscriptionStatus setSubscription(Reference value)

Parameters:

value - subscription (The reference to the Subscription which generated this notification.)

getTopicElement

public CanonicalType getTopicElement()

Returns:

topic (The reference to the SubscriptionTopic for the Subscription which generated this notification.). 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 SubscriptionStatus setTopicElement(CanonicalType value)

Parameters:

value - topic (The reference to the SubscriptionTopic for the Subscription which generated this notification.). 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 SubscriptionTopic for the Subscription which generated this notification.

setTopic

public SubscriptionStatus setTopic(String value)

Parameters:

value - The reference to the SubscriptionTopic for the Subscription which generated this notification.

getError

public List<CodeableConcept> getError()

Returns:

error (A record of errors that occurred when the server processed a notification.)

setError

public SubscriptionStatus setError(List<CodeableConcept> theError)

Returns:

Returns a reference to this for easy method chaining

hasError

public boolean hasError()

addError

public CodeableConcept addError()

addError

public SubscriptionStatus addError(CodeableConcept t)

getErrorFirstRep

public CodeableConcept getErrorFirstRep()

Returns:

The first repetition of repeating field error, creating it if it does not already exist {3}

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

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild 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

Returns:

the FHIR type name of the instance (not the java class name)

copy

public SubscriptionStatus copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(SubscriptionStatus dst)

typedCopy

protected SubscriptionStatus 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