Class SubscriptionTopic
- 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.SubscriptionTopic
-
- 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 SubscriptionTopic extends DomainResource
Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSubscriptionTopic.CriteriaNotExistsBehaviorstatic classSubscriptionTopic.CriteriaNotExistsBehaviorEnumFactorystatic classSubscriptionTopic.InteractionTriggerstatic classSubscriptionTopic.InteractionTriggerEnumFactorystatic classSubscriptionTopic.SubscriptionTopicCanFilterByComponentstatic classSubscriptionTopic.SubscriptionTopicEventTriggerComponentstatic classSubscriptionTopic.SubscriptionTopicNotificationShapeComponentstatic classSubscriptionTopic.SubscriptionTopicResourceTriggerComponentstatic classSubscriptionTopic.SubscriptionTopicResourceTriggerQueryCriteriaComponent
-
Field Summary
Fields Modifier and Type Field Description protected DateTypeapprovalDateThe date on which the asset content was approved by the publisher.protected List<SubscriptionTopic.SubscriptionTopicCanFilterByComponent>canFilterByList of properties by which Subscriptions on the SubscriptionTopic can be filtered.protected List<ContactDetail>contactContact details to assist a user in finding and communicating with the publisher.protected MarkdownTypecopyrightA copyright statement relating to the SubscriptionTopic and/or its contents.protected DateTimeTypedateFor draft definitions, indicates the date of initial creation.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for datestatic ca.uhn.fhir.rest.gclient.UriClientParamDERIVED_OR_SELFFluent Client search parameter constant for derived-or-selfprotected List<CanonicalType>derivedFromThe canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic.protected MarkdownTypedescriptionA free text natural language description of the Topic from the consumer's perspective.protected PeriodeffectivePeriodThe period during which the SubscriptionTopic content was or is planned to be effective.protected List<SubscriptionTopic.SubscriptionTopicEventTriggerComponent>eventTriggerEvent definition which can be used to trigger the SubscriptionTopic.protected BooleanTypeexperimentalA flag to indicate that this TopSubscriptionTopicic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.protected List<Identifier>identifierBusiness identifiers assigned to this SubscriptionTopic by the performer and/or other systems.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierprotected List<CodeableConcept>jurisdictionA jurisdiction in which the Topic is intended to be used.protected DateTypelastReviewDateThe date on which the asset content was last reviewed.protected List<SubscriptionTopic.SubscriptionTopicNotificationShapeComponent>notificationShapeList of properties to describe the shape (e.g., resources) included in notifications from this Subscription Topic.protected StringTypepublisherHelps establish the "authority/credibility" of the SubscriptionTopic.protected MarkdownTypepurposeExplains why this Topic is needed and why it has been designed as it has.static ca.uhn.fhir.rest.gclient.UriClientParamRESOURCEFluent Client search parameter constant for resourceprotected List<SubscriptionTopic.SubscriptionTopicResourceTriggerComponent>resourceTriggerA definition of a resource-based event that triggers a notification based on the SubscriptionTopic.static StringSP_DATESearch parameter: datestatic StringSP_DERIVED_OR_SELFSearch parameter: derived-or-selfstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_RESOURCESearch parameter: resourcestatic StringSP_STATUSSearch parameter: statusstatic StringSP_TITLESearch parameter: titlestatic StringSP_TRIGGER_DESCRIPTIONSearch parameter: trigger-descriptionstatic StringSP_URLSearch parameter: urlstatic StringSP_VERSIONSearch parameter: versionprotected Enumeration<Enumerations.PublicationStatus>statusThe current state of the SubscriptionTopic.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected StringTypetitleA short, descriptive, user-friendly title for the SubscriptionTopic, for example, "admission".static ca.uhn.fhir.rest.gclient.StringClientParamTITLEFluent Client search parameter constant for titlestatic ca.uhn.fhir.rest.gclient.StringClientParamTRIGGER_DESCRIPTIONFluent Client search parameter constant for trigger-descriptionprotected UriTypeurlAn absolute URL that is used to identify this SubscriptionTopic when it is referenced in a specification, model, design or an instance.static ca.uhn.fhir.rest.gclient.UriClientParamURLFluent Client search parameter constant for urlprotected List<UsageContext>useContextThe content was developed with a focus and intent of supporting the contexts that are listed.protected StringTypeversionThe identifier that is used to identify this version of the SubscriptionTopic when it is referenced in a specification, model, design or instance.static ca.uhn.fhir.rest.gclient.TokenClientParamVERSIONFluent Client search parameter constant for version-
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 SubscriptionTopic()ConstructorSubscriptionTopic(String url, Enumerations.PublicationStatus status)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, 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
-
-
-
-
Field Detail
-
url
protected UriType url
An absolute URL that is used to identify this SubscriptionTopic when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this Topic is (or will be) published. The URL SHOULD include the major version of the Topic. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier
protected List<Identifier> identifier
Business identifiers assigned to this SubscriptionTopic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.
-
version
protected StringType version
The identifier that is used to identify this version of the SubscriptionTopic when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Topic author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.
-
title
protected StringType title
A short, descriptive, user-friendly title for the SubscriptionTopic, for example, "admission".
-
derivedFrom
protected List<CanonicalType> derivedFrom
The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic.
-
status
protected Enumeration<Enumerations.PublicationStatus> status
The current state of the SubscriptionTopic.
-
experimental
protected BooleanType experimental
A flag to indicate that this TopSubscriptionTopicic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date
protected DateTimeType date
For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.
-
publisher
protected StringType publisher
Helps establish the "authority/credibility" of the SubscriptionTopic. May also allow for contact.
-
contact
protected List<ContactDetail> contact
Contact details to assist a user in finding and communicating with the publisher.
-
description
protected MarkdownType description
A free text natural language description of the Topic from the consumer's perspective.
-
useContext
protected List<UsageContext> useContext
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions.
-
jurisdiction
protected List<CodeableConcept> jurisdiction
A jurisdiction in which the Topic is intended to be used.
-
purpose
protected MarkdownType purpose
Explains why this Topic is needed and why it has been designed as it has.
-
copyright
protected MarkdownType copyright
A copyright statement relating to the SubscriptionTopic and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SubscriptionTopic.
-
approvalDate
protected DateType approvalDate
The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
lastReviewDate
protected DateType lastReviewDate
The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.
-
effectivePeriod
protected Period effectivePeriod
The period during which the SubscriptionTopic content was or is planned to be effective.
-
resourceTrigger
protected List<SubscriptionTopic.SubscriptionTopicResourceTriggerComponent> resourceTrigger
A definition of a resource-based event that triggers a notification based on the SubscriptionTopic. The criteria may be just a human readable description and/or a full FHIR search string or FHIRPath expression. Multiple triggers are considered OR joined (e.g., a resource update matching ANY of the definitions will trigger a notification).
-
eventTrigger
protected List<SubscriptionTopic.SubscriptionTopicEventTriggerComponent> eventTrigger
Event definition which can be used to trigger the SubscriptionTopic.
-
canFilterBy
protected List<SubscriptionTopic.SubscriptionTopicCanFilterByComponent> canFilterBy
List of properties by which Subscriptions on the SubscriptionTopic can be filtered. May be defined Search Parameters (e.g., Encounter.patient) or parameters defined within this SubscriptionTopic context (e.g., hub.event).
-
notificationShape
protected List<SubscriptionTopic.SubscriptionTopicNotificationShapeComponent> notificationShape
List of properties to describe the shape (e.g., resources) included in notifications from this Subscription Topic.
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: Date status first applied
Type: date
Path: SubscriptionTopic.date
- See Also:
- Constant Field Values
-
DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Fluent Client search parameter constant for dateDescription: Date status first applied
Type: date
Path: SubscriptionTopic.date
-
SP_DERIVED_OR_SELF
public static final String SP_DERIVED_OR_SELF
Search parameter: derived-or-selfDescription: A server defined search that matches either the url or derivedFrom
Type: uri
Path: SubscriptionTopic.url | SubscriptionTopic.derivedFrom
- See Also:
- Constant Field Values
-
DERIVED_OR_SELF
public static final ca.uhn.fhir.rest.gclient.UriClientParam DERIVED_OR_SELF
Fluent Client search parameter constant for derived-or-selfDescription: A server defined search that matches either the url or derivedFrom
Type: uri
Path: SubscriptionTopic.url | SubscriptionTopic.derivedFrom
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Business Identifier for SubscriptionTopic
Type: token
Path: SubscriptionTopic.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Business Identifier for SubscriptionTopic
Type: token
Path: SubscriptionTopic.identifier
-
SP_RESOURCE
public static final String SP_RESOURCE
Search parameter: resourceDescription: Allowed Data type or Resource (reference to definition) for this definition, searches resourceTrigger, eventTrigger, and notificationShape for matches.
Type: uri
Path: SubscriptionTopic.resourceTrigger.resource
- See Also:
- Constant Field Values
-
RESOURCE
public static final ca.uhn.fhir.rest.gclient.UriClientParam RESOURCE
Fluent Client search parameter constant for resourceDescription: Allowed Data type or Resource (reference to definition) for this definition, searches resourceTrigger, eventTrigger, and notificationShape for matches.
Type: uri
Path: SubscriptionTopic.resourceTrigger.resource
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: draft | active | retired | unknown
Type: token
Path: SubscriptionTopic.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: draft | active | retired | unknown
Type: token
Path: SubscriptionTopic.status
-
SP_TITLE
public static final String SP_TITLE
Search parameter: titleDescription: Name for this SubscriptionTopic (Human friendly)
Type: string
Path: SubscriptionTopic.title
- See Also:
- Constant Field Values
-
TITLE
public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
Fluent Client search parameter constant for titleDescription: Name for this SubscriptionTopic (Human friendly)
Type: string
Path: SubscriptionTopic.title
-
SP_TRIGGER_DESCRIPTION
public static final String SP_TRIGGER_DESCRIPTION
Search parameter: trigger-descriptionDescription: Text representation of the trigger
Type: string
Path: SubscriptionTopic.resourceTrigger.description
- See Also:
- Constant Field Values
-
TRIGGER_DESCRIPTION
public static final ca.uhn.fhir.rest.gclient.StringClientParam TRIGGER_DESCRIPTION
Fluent Client search parameter constant for trigger-descriptionDescription: Text representation of the trigger
Type: string
Path: SubscriptionTopic.resourceTrigger.description
-
SP_URL
public static final String SP_URL
Search parameter: urlDescription: Logical canonical URL to reference this SubscriptionTopic (globally unique)
Type: uri
Path: SubscriptionTopic.url
- See Also:
- Constant Field Values
-
URL
public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
Fluent Client search parameter constant for urlDescription: Logical canonical URL to reference this SubscriptionTopic (globally unique)
Type: uri
Path: SubscriptionTopic.url
-
SP_VERSION
public static final String SP_VERSION
Search parameter: versionDescription: Business version of the SubscriptionTopic
Type: token
Path: SubscriptionTopic.version
- See Also:
- Constant Field Values
-
VERSION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
Fluent Client search parameter constant for versionDescription: Business version of the SubscriptionTopic
Type: token
Path: SubscriptionTopic.version
-
-
Constructor Detail
-
SubscriptionTopic
public SubscriptionTopic()
Constructor
-
SubscriptionTopic
public SubscriptionTopic(String url, Enumerations.PublicationStatus status)
Constructor
-
-
Method Detail
-
getUrlElement
public UriType getUrlElement()
- Returns:
url(An absolute URL that is used to identify this SubscriptionTopic when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this Topic is (or will be) published. The URL SHOULD include the major version of the Topic. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
hasUrlElement
public boolean hasUrlElement()
-
hasUrl
public boolean hasUrl()
-
setUrlElement
public SubscriptionTopic setUrlElement(UriType value)
- Parameters:
value-url(An absolute URL that is used to identify this SubscriptionTopic when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this Topic is (or will be) published. The URL SHOULD include the major version of the Topic. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
getUrl
public String getUrl()
- Returns:
- An absolute URL that is used to identify this SubscriptionTopic when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this Topic is (or will be) published. The URL SHOULD include the major version of the Topic. For more information see [Technical and Business Versions](resource.html#versions).
-
setUrl
public SubscriptionTopic setUrl(String value)
- Parameters:
value- An absolute URL that is used to identify this SubscriptionTopic when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this Topic is (or will be) published. The URL SHOULD include the major version of the Topic. For more information see [Technical and Business Versions](resource.html#versions).
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(Business identifiers assigned to this SubscriptionTopic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.)
-
setIdentifier
public SubscriptionTopic setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public SubscriptionTopic addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist {3}
-
getVersionElement
public StringType getVersionElement()
- Returns:
version(The identifier that is used to identify this version of the SubscriptionTopic when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Topic author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
hasVersionElement
public boolean hasVersionElement()
-
hasVersion
public boolean hasVersion()
-
setVersionElement
public SubscriptionTopic setVersionElement(StringType value)
- Parameters:
value-version(The identifier that is used to identify this version of the SubscriptionTopic when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Topic author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
getVersion
public String getVersion()
- Returns:
- The identifier that is used to identify this version of the SubscriptionTopic when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Topic author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.
-
setVersion
public SubscriptionTopic setVersion(String value)
- Parameters:
value- The identifier that is used to identify this version of the SubscriptionTopic when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Topic author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.
-
getTitleElement
public StringType getTitleElement()
- Returns:
title(A short, descriptive, user-friendly title for the SubscriptionTopic, for example, "admission".). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
hasTitleElement
public boolean hasTitleElement()
-
hasTitle
public boolean hasTitle()
-
setTitleElement
public SubscriptionTopic setTitleElement(StringType value)
- Parameters:
value-title(A short, descriptive, user-friendly title for the SubscriptionTopic, for example, "admission".). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
getTitle
public String getTitle()
- Returns:
- A short, descriptive, user-friendly title for the SubscriptionTopic, for example, "admission".
-
setTitle
public SubscriptionTopic setTitle(String value)
- Parameters:
value- A short, descriptive, user-friendly title for the SubscriptionTopic, for example, "admission".
-
getDerivedFrom
public List<CanonicalType> getDerivedFrom()
- Returns:
derivedFrom(The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic.)
-
setDerivedFrom
public SubscriptionTopic setDerivedFrom(List<CanonicalType> theDerivedFrom)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasDerivedFrom
public boolean hasDerivedFrom()
-
addDerivedFromElement
public CanonicalType addDerivedFromElement()
- Returns:
derivedFrom(The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic.)
-
addDerivedFrom
public SubscriptionTopic addDerivedFrom(String value)
- Parameters:
value-derivedFrom(The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic.)
-
hasDerivedFrom
public boolean hasDerivedFrom(String value)
- Parameters:
value-derivedFrom(The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic.)
-
getStatusElement
public Enumeration<Enumerations.PublicationStatus> getStatusElement()
- Returns:
status(The current state of the SubscriptionTopic.). 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 SubscriptionTopic setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
- Parameters:
value-status(The current state of the SubscriptionTopic.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public Enumerations.PublicationStatus getStatus()
- Returns:
- The current state of the SubscriptionTopic.
-
setStatus
public SubscriptionTopic setStatus(Enumerations.PublicationStatus value)
- Parameters:
value- The current state of the SubscriptionTopic.
-
getExperimentalElement
public BooleanType getExperimentalElement()
- Returns:
experimental(A flag to indicate that this TopSubscriptionTopicic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
-
hasExperimentalElement
public boolean hasExperimentalElement()
-
hasExperimental
public boolean hasExperimental()
-
setExperimentalElement
public SubscriptionTopic setExperimentalElement(BooleanType value)
- Parameters:
value-experimental(A flag to indicate that this TopSubscriptionTopicic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
-
getExperimental
public boolean getExperimental()
- Returns:
- A flag to indicate that this TopSubscriptionTopicic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
setExperimental
public SubscriptionTopic setExperimental(boolean value)
- Parameters:
value- A flag to indicate that this TopSubscriptionTopicic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
getDateElement
public DateTimeType getDateElement()
- Returns:
date(For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
hasDateElement
public boolean hasDateElement()
-
hasDate
public boolean hasDate()
-
setDateElement
public SubscriptionTopic setDateElement(DateTimeType value)
- Parameters:
value-date(For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
getDate
public Date getDate()
- Returns:
- For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.
-
setDate
public SubscriptionTopic setDate(Date value)
- Parameters:
value- For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.
-
getPublisherElement
public StringType getPublisherElement()
- Returns:
publisher(Helps establish the "authority/credibility" of the SubscriptionTopic. May also allow for contact.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
hasPublisherElement
public boolean hasPublisherElement()
-
hasPublisher
public boolean hasPublisher()
-
setPublisherElement
public SubscriptionTopic setPublisherElement(StringType value)
- Parameters:
value-publisher(Helps establish the "authority/credibility" of the SubscriptionTopic. May also allow for contact.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
getPublisher
public String getPublisher()
- Returns:
- Helps establish the "authority/credibility" of the SubscriptionTopic. May also allow for contact.
-
setPublisher
public SubscriptionTopic setPublisher(String value)
- Parameters:
value- Helps establish the "authority/credibility" of the SubscriptionTopic. May also allow for contact.
-
getContact
public List<ContactDetail> getContact()
- Returns:
contact(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
public SubscriptionTopic setContact(List<ContactDetail> theContact)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContact
public boolean hasContact()
-
addContact
public ContactDetail addContact()
-
addContact
public SubscriptionTopic addContact(ContactDetail t)
-
getContactFirstRep
public ContactDetail getContactFirstRep()
- Returns:
- The first repetition of repeating field
contact, creating it if it does not already exist {3}
-
getDescriptionElement
public MarkdownType getDescriptionElement()
- Returns:
description(A free text natural language description of the Topic from the consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
public boolean hasDescriptionElement()
-
hasDescription
public boolean hasDescription()
-
setDescriptionElement
public SubscriptionTopic setDescriptionElement(MarkdownType value)
- Parameters:
value-description(A free text natural language description of the Topic from the consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
public String getDescription()
- Returns:
- A free text natural language description of the Topic from the consumer's perspective.
-
setDescription
public SubscriptionTopic setDescription(String value)
- Parameters:
value- A free text natural language description of the Topic from the consumer's perspective.
-
getUseContext
public List<UsageContext> getUseContext()
- Returns:
useContext(The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions.)
-
setUseContext
public SubscriptionTopic setUseContext(List<UsageContext> theUseContext)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasUseContext
public boolean hasUseContext()
-
addUseContext
public UsageContext addUseContext()
-
addUseContext
public SubscriptionTopic addUseContext(UsageContext t)
-
getUseContextFirstRep
public UsageContext getUseContextFirstRep()
- Returns:
- The first repetition of repeating field
useContext, creating it if it does not already exist {3}
-
getJurisdiction
public List<CodeableConcept> getJurisdiction()
- Returns:
jurisdiction(A jurisdiction in which the Topic is intended to be used.)
-
setJurisdiction
public SubscriptionTopic setJurisdiction(List<CodeableConcept> theJurisdiction)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasJurisdiction
public boolean hasJurisdiction()
-
addJurisdiction
public CodeableConcept addJurisdiction()
-
addJurisdiction
public SubscriptionTopic addJurisdiction(CodeableConcept t)
-
getJurisdictionFirstRep
public CodeableConcept getJurisdictionFirstRep()
- Returns:
- The first repetition of repeating field
jurisdiction, creating it if it does not already exist {3}
-
getPurposeElement
public MarkdownType getPurposeElement()
- Returns:
purpose(Explains why this Topic is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
-
hasPurposeElement
public boolean hasPurposeElement()
-
hasPurpose
public boolean hasPurpose()
-
setPurposeElement
public SubscriptionTopic setPurposeElement(MarkdownType value)
- Parameters:
value-purpose(Explains why this Topic is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
-
getPurpose
public String getPurpose()
- Returns:
- Explains why this Topic is needed and why it has been designed as it has.
-
setPurpose
public SubscriptionTopic setPurpose(String value)
- Parameters:
value- Explains why this Topic is needed and why it has been designed as it has.
-
getCopyrightElement
public MarkdownType getCopyrightElement()
- Returns:
copyright(A copyright statement relating to the SubscriptionTopic and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SubscriptionTopic.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
hasCopyrightElement
public boolean hasCopyrightElement()
-
hasCopyright
public boolean hasCopyright()
-
setCopyrightElement
public SubscriptionTopic setCopyrightElement(MarkdownType value)
- Parameters:
value-copyright(A copyright statement relating to the SubscriptionTopic and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SubscriptionTopic.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
getCopyright
public String getCopyright()
- Returns:
- A copyright statement relating to the SubscriptionTopic and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SubscriptionTopic.
-
setCopyright
public SubscriptionTopic setCopyright(String value)
- Parameters:
value- A copyright statement relating to the SubscriptionTopic and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SubscriptionTopic.
-
getApprovalDateElement
public DateType getApprovalDateElement()
- Returns:
approvalDate(The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.). This is the underlying object with id, value and extensions. The accessor "getApprovalDate" gives direct access to the value
-
hasApprovalDateElement
public boolean hasApprovalDateElement()
-
hasApprovalDate
public boolean hasApprovalDate()
-
setApprovalDateElement
public SubscriptionTopic setApprovalDateElement(DateType value)
- Parameters:
value-approvalDate(The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.). This is the underlying object with id, value and extensions. The accessor "getApprovalDate" gives direct access to the value
-
getApprovalDate
public Date getApprovalDate()
- Returns:
- The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
setApprovalDate
public SubscriptionTopic setApprovalDate(Date value)
- Parameters:
value- The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
getLastReviewDateElement
public DateType getLastReviewDateElement()
- Returns:
lastReviewDate(The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value
-
hasLastReviewDateElement
public boolean hasLastReviewDateElement()
-
hasLastReviewDate
public boolean hasLastReviewDate()
-
setLastReviewDateElement
public SubscriptionTopic setLastReviewDateElement(DateType value)
- Parameters:
value-lastReviewDate(The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value
-
getLastReviewDate
public Date getLastReviewDate()
- Returns:
- The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.
-
setLastReviewDate
public SubscriptionTopic setLastReviewDate(Date value)
- Parameters:
value- The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.
-
getEffectivePeriod
public Period getEffectivePeriod()
- Returns:
effectivePeriod(The period during which the SubscriptionTopic content was or is planned to be effective.)
-
hasEffectivePeriod
public boolean hasEffectivePeriod()
-
setEffectivePeriod
public SubscriptionTopic setEffectivePeriod(Period value)
- Parameters:
value-effectivePeriod(The period during which the SubscriptionTopic content was or is planned to be effective.)
-
getResourceTrigger
public List<SubscriptionTopic.SubscriptionTopicResourceTriggerComponent> getResourceTrigger()
- Returns:
resourceTrigger(A definition of a resource-based event that triggers a notification based on the SubscriptionTopic. The criteria may be just a human readable description and/or a full FHIR search string or FHIRPath expression. Multiple triggers are considered OR joined (e.g., a resource update matching ANY of the definitions will trigger a notification).)
-
setResourceTrigger
public SubscriptionTopic setResourceTrigger(List<SubscriptionTopic.SubscriptionTopicResourceTriggerComponent> theResourceTrigger)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasResourceTrigger
public boolean hasResourceTrigger()
-
addResourceTrigger
public SubscriptionTopic.SubscriptionTopicResourceTriggerComponent addResourceTrigger()
-
addResourceTrigger
public SubscriptionTopic addResourceTrigger(SubscriptionTopic.SubscriptionTopicResourceTriggerComponent t)
-
getResourceTriggerFirstRep
public SubscriptionTopic.SubscriptionTopicResourceTriggerComponent getResourceTriggerFirstRep()
- Returns:
- The first repetition of repeating field
resourceTrigger, creating it if it does not already exist {3}
-
getEventTrigger
public List<SubscriptionTopic.SubscriptionTopicEventTriggerComponent> getEventTrigger()
- Returns:
eventTrigger(Event definition which can be used to trigger the SubscriptionTopic.)
-
setEventTrigger
public SubscriptionTopic setEventTrigger(List<SubscriptionTopic.SubscriptionTopicEventTriggerComponent> theEventTrigger)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEventTrigger
public boolean hasEventTrigger()
-
addEventTrigger
public SubscriptionTopic.SubscriptionTopicEventTriggerComponent addEventTrigger()
-
addEventTrigger
public SubscriptionTopic addEventTrigger(SubscriptionTopic.SubscriptionTopicEventTriggerComponent t)
-
getEventTriggerFirstRep
public SubscriptionTopic.SubscriptionTopicEventTriggerComponent getEventTriggerFirstRep()
- Returns:
- The first repetition of repeating field
eventTrigger, creating it if it does not already exist {3}
-
getCanFilterBy
public List<SubscriptionTopic.SubscriptionTopicCanFilterByComponent> getCanFilterBy()
- Returns:
canFilterBy(List of properties by which Subscriptions on the SubscriptionTopic can be filtered. May be defined Search Parameters (e.g., Encounter.patient) or parameters defined within this SubscriptionTopic context (e.g., hub.event).)
-
setCanFilterBy
public SubscriptionTopic setCanFilterBy(List<SubscriptionTopic.SubscriptionTopicCanFilterByComponent> theCanFilterBy)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCanFilterBy
public boolean hasCanFilterBy()
-
addCanFilterBy
public SubscriptionTopic.SubscriptionTopicCanFilterByComponent addCanFilterBy()
-
addCanFilterBy
public SubscriptionTopic addCanFilterBy(SubscriptionTopic.SubscriptionTopicCanFilterByComponent t)
-
getCanFilterByFirstRep
public SubscriptionTopic.SubscriptionTopicCanFilterByComponent getCanFilterByFirstRep()
- Returns:
- The first repetition of repeating field
canFilterBy, creating it if it does not already exist {3}
-
getNotificationShape
public List<SubscriptionTopic.SubscriptionTopicNotificationShapeComponent> getNotificationShape()
- Returns:
notificationShape(List of properties to describe the shape (e.g., resources) included in notifications from this Subscription Topic.)
-
setNotificationShape
public SubscriptionTopic setNotificationShape(List<SubscriptionTopic.SubscriptionTopicNotificationShapeComponent> theNotificationShape)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasNotificationShape
public boolean hasNotificationShape()
-
addNotificationShape
public SubscriptionTopic.SubscriptionTopicNotificationShapeComponent addNotificationShape()
-
addNotificationShape
public SubscriptionTopic addNotificationShape(SubscriptionTopic.SubscriptionTopicNotificationShapeComponent t)
-
getNotificationShapeFirstRep
public SubscriptionTopic.SubscriptionTopicNotificationShapeComponent getNotificationShapeFirstRep()
- Returns:
- The first repetition of repeating field
notificationShape, creating it if it does not already exist {3}
-
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 SubscriptionTopic copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(SubscriptionTopic dst)
-
typedCopy
protected SubscriptionTopic 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
-
-