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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`SubscriptionStatus.SubscriptionNotificationType`
`static class`	`SubscriptionStatus.SubscriptionNotificationTypeEnumFactory`
`static class`	`SubscriptionStatus.SubscriptionStatusNotificationEventComponent`

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 IntegerType`	`eventsInNotification`	The total number of actual events represented within this 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.SubscriptionState>`	`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 notificaiton.

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, SP_RES_ID, SP_RES_LANGUAGE

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

All Methods Instance Methods Concrete Methods
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()`
`int`	`getEventsInNotification()`
`IntegerType`	`getEventsInNotificationElement()`
`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.SubscriptionState`	`getStatus()`
`Enumeration<Enumerations.SubscriptionState>`	`getStatusElement()`
`Reference`	`getSubscription()`
`String`	`getTopic()`
`CanonicalType`	`getTopicElement()`
`SubscriptionStatus.SubscriptionNotificationType`	`getType()`
`Enumeration<SubscriptionStatus.SubscriptionNotificationType>`	`getTypeElement()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasError()`
`boolean`	`hasEventsInNotification()`
`boolean`	`hasEventsInNotificationElement()`
`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)`
`SubscriptionStatus`	`setError(List<CodeableConcept> theError)`
`SubscriptionStatus`	`setEventsInNotification(int value)`
`SubscriptionStatus`	`setEventsInNotificationElement(IntegerType value)`
`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.SubscriptionState value)`
`SubscriptionStatus`	`setStatusElement(Enumeration<Enumerations.SubscriptionState> 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, 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, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, 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

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, setId

- Field Detail
  - status
```
protected Enumeration<Enumerations.SubscriptionState> 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 notificaiton.
  - 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.
  - eventsInNotification
```
protected IntegerType eventsInNotification
```
    The total number of actual events represented within this notification. For handshake and heartbeat notifications, this will be zero or not present. For event-notifications, this number may be one or more, depending on server batching.
  - 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 Detail
  - SubscriptionStatus
```
public SubscriptionStatus()
```
    Constructor
  - SubscriptionStatus
```
public SubscriptionStatus(SubscriptionStatus.SubscriptionNotificationType type,
                          Reference subscription)
```
    Constructor
- Method Detail
  - 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 SubscriptionStatus 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 SubscriptionStatus setStatus(Enumerations.SubscriptionState 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 notificaiton.). 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 notificaiton.). 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 notificaiton.
  - setType
```
public SubscriptionStatus setType(SubscriptionStatus.SubscriptionNotificationType value)
```
    Parameters:
    
    value - The type of event being conveyed with this notificaiton.
  - 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.
  - getEventsInNotificationElement
```
public IntegerType getEventsInNotificationElement()
```
    Returns:
    
    eventsInNotification (The total number of actual events represented within this notification. For handshake and heartbeat notifications, this will be zero or not present. For event-notifications, this number may be one or more, depending on server batching.). This is the underlying object with id, value and extensions. The accessor "getEventsInNotification" gives direct access to the value
  - hasEventsInNotificationElement
```
public boolean hasEventsInNotificationElement()
```
  - hasEventsInNotification
```
public boolean hasEventsInNotification()
```
  - setEventsInNotificationElement
```
public SubscriptionStatus setEventsInNotificationElement(IntegerType value)
```
    Parameters:
    
    value - eventsInNotification (The total number of actual events represented within this notification. For handshake and heartbeat notifications, this will be zero or not present. For event-notifications, this number may be one or more, depending on server batching.). This is the underlying object with id, value and extensions. The accessor "getEventsInNotification" gives direct access to the value
  - getEventsInNotification
```
public int getEventsInNotification()
```
    Returns:
    
    The total number of actual events represented within this notification. For handshake and heartbeat notifications, this will be zero or not present. For event-notifications, this number may be one or more, depending on server batching.
  - setEventsInNotification
```
public SubscriptionStatus setEventsInNotification(int value)
```
    Parameters:
    
    value - The total number of actual events represented within this notification. For handshake and heartbeat notifications, this will be zero or not present. For event-notifications, this number may be one or more, depending on server batching.
  - 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
  - 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 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

Class SubscriptionStatus

Nested Class Summary

Field Summary

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

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

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

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

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

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

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

Field Detail

status

type

eventsSinceSubscriptionStart

eventsInNotification

notificationEvent

subscription

topic

error

Constructor Detail

SubscriptionStatus

SubscriptionStatus

Method Detail

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getTypeElement

hasTypeElement

hasType

setTypeElement

getType

setType

getEventsSinceSubscriptionStartElement

hasEventsSinceSubscriptionStartElement

hasEventsSinceSubscriptionStart

setEventsSinceSubscriptionStartElement

getEventsSinceSubscriptionStart

setEventsSinceSubscriptionStart

getEventsInNotificationElement

hasEventsInNotificationElement

hasEventsInNotification

setEventsInNotificationElement

getEventsInNotification

setEventsInNotification

getNotificationEvent

setNotificationEvent

hasNotificationEvent

addNotificationEvent

addNotificationEvent

getNotificationEventFirstRep

getSubscription

hasSubscription

setSubscription

getTopicElement

hasTopicElement

hasTopic

setTopicElement

getTopic

setTopic

getError

setError

hasError

addError

addError

getErrorFirstRep

listChildren

getNamedProperty

getProperty

setProperty

setProperty