Package ca.uhn.fhir.jpa.topic

Class R4SubscriptionTopicBuilder

java.lang.Object

ca.uhn.fhir.jpa.topic.R4SubscriptionTopicBuilder

public class R4SubscriptionTopicBuilder
extends Object

Builder class for creating and configuring FHIR R4 SubscriptionTopic resources.

In R4, SubscriptionTopic is represented as a Basic resource with extensions, following the pattern outlined in the FHIR Subscriptions Backport implementation guide. This builder provides a fluent API to create these resources without needing to handle extension management directly.

See Also:

• For conversion between R4 Basic and R5 SubscriptionTopic

Constructor Summary

Constructors

Constructor	Description
R4SubscriptionTopicBuilder()	Creates a new builder with a Basic resource having the SubscriptionTopic code

Method Summary

Modifier and Type	Method	Description
R4SubscriptionTopicBuilder	addCanFilterBy()	Start defining a can-filter-by extension
R4SubscriptionTopicBuilder	addNotificationShape()	Start defining a notification shape extension
R4SubscriptionTopicBuilder	addNotificationShapeInclude(String theIncludeParam)	Add an include parameter to the current notification shape
R4SubscriptionTopicBuilder	addNotificationShapeRevInclude(String theRevIncludeParam)	Add a revInclude parameter to the current notification shape
R4SubscriptionTopicBuilder	addResourceTrigger()	Start defining a resource trigger
R4SubscriptionTopicBuilder	addResourceTriggerQueryCriteria()	Start defining a query criteria extension for the current resource trigger
R4SubscriptionTopicBuilder	addResourceTriggerSupportedInteraction(String theInteractionCode)	Add a supported interaction to the current resource trigger
org.hl7.fhir.r4.model.Basic	build()	Return the built Basic resource representing the SubscriptionTopic
R4SubscriptionTopicBuilder	setCanFilterByDescription(String theDescription)	Set the description for the current can-filter-by
R4SubscriptionTopicBuilder	setCanFilterByParameter(String theFilterParameter)	Set the filter parameter for the current can-filter-by
R4SubscriptionTopicBuilder	setCanFilterByResource(String theResourceType)	Set the resource type for the current can-filter-by
R4SubscriptionTopicBuilder	setDate(Date theDate)	Set the date the topic was last updated
R4SubscriptionTopicBuilder	setDescription(String theDescription)	Set the description of the topic
R4SubscriptionTopicBuilder	setId(String theId)	Set the logical ID of the SubscriptionTopic
R4SubscriptionTopicBuilder	setName(String theName)	Set the name of the topic
R4SubscriptionTopicBuilder	setNotificationShapeResource(String theResourceType)	Set the resource type for the current notification shape
R4SubscriptionTopicBuilder	setResourceTriggerDescription(String theDescription)	Set the description for the current resource trigger
R4SubscriptionTopicBuilder	setResourceTriggerFhirPathCriteria(String theFhirPathExpression)	Add FHIRPath criteria to the current resource trigger
R4SubscriptionTopicBuilder	setResourceTriggerQueryCriteriaCurrent(String theCurrentQuery)	Set the current query string for the current resource trigger's query criteria
R4SubscriptionTopicBuilder	setResourceTriggerQueryCriteriaPrevious(String thePreviousQuery)	Set the previous query string for the current resource trigger's query criteria
R4SubscriptionTopicBuilder	setResourceTriggerQueryCriteriaRequireBoth(boolean theRequireBoth)	Set requireBoth flag for the current resource trigger's query criteria
R4SubscriptionTopicBuilder	setResourceTriggerResource(String theResourceType)	Set the resource type for the current resource trigger
R4SubscriptionTopicBuilder	setStatus(org.hl7.fhir.r4.model.Enumerations.PublicationStatus theStatus)	Set the status of the topic (note: uses modifier extension)
R4SubscriptionTopicBuilder	setTitle(String theTitle)	Set the title of the topic
R4SubscriptionTopicBuilder	setUrl(String theUrl)	Set the canonical URL of the topic
R4SubscriptionTopicBuilder	setVersion(String theVersion)	Set the version of the topic

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

R4SubscriptionTopicBuilder

public R4SubscriptionTopicBuilder()

Creates a new builder with a Basic resource having the SubscriptionTopic code

Method Details

setId

public R4SubscriptionTopicBuilder setId(String theId)

Set the logical ID of the SubscriptionTopic

setUrl

public R4SubscriptionTopicBuilder setUrl(String theUrl)

Set the canonical URL of the topic

setVersion

public R4SubscriptionTopicBuilder setVersion(String theVersion)

Set the version of the topic

setName

public R4SubscriptionTopicBuilder setName(String theName)

Set the name of the topic

setTitle

public R4SubscriptionTopicBuilder setTitle(String theTitle)

Set the title of the topic

setDate

public R4SubscriptionTopicBuilder setDate(Date theDate)

Set the date the topic was last updated

setDescription

public R4SubscriptionTopicBuilder setDescription(String theDescription)

Set the description of the topic

setStatus

public R4SubscriptionTopicBuilder setStatus(org.hl7.fhir.r4.model.Enumerations.PublicationStatus theStatus)

Set the status of the topic (note: uses modifier extension)

addResourceTrigger

public R4SubscriptionTopicBuilder addResourceTrigger()

Start defining a resource trigger

setResourceTriggerDescription

public R4SubscriptionTopicBuilder setResourceTriggerDescription(String theDescription)

Set the description for the current resource trigger

setResourceTriggerResource

public R4SubscriptionTopicBuilder setResourceTriggerResource(String theResourceType)

Set the resource type for the current resource trigger

addResourceTriggerSupportedInteraction

public R4SubscriptionTopicBuilder addResourceTriggerSupportedInteraction(String theInteractionCode)

Add a supported interaction to the current resource trigger

setResourceTriggerFhirPathCriteria

public R4SubscriptionTopicBuilder setResourceTriggerFhirPathCriteria(String theFhirPathExpression)

Add FHIRPath criteria to the current resource trigger

addResourceTriggerQueryCriteria

public R4SubscriptionTopicBuilder addResourceTriggerQueryCriteria()

Start defining a query criteria extension for the current resource trigger

setResourceTriggerQueryCriteriaPrevious

public R4SubscriptionTopicBuilder setResourceTriggerQueryCriteriaPrevious(String thePreviousQuery)

Set the previous query string for the current resource trigger's query criteria

setResourceTriggerQueryCriteriaCurrent

public R4SubscriptionTopicBuilder setResourceTriggerQueryCriteriaCurrent(String theCurrentQuery)

Set the current query string for the current resource trigger's query criteria

setResourceTriggerQueryCriteriaRequireBoth

public R4SubscriptionTopicBuilder setResourceTriggerQueryCriteriaRequireBoth(boolean theRequireBoth)

Set requireBoth flag for the current resource trigger's query criteria

addCanFilterBy

public R4SubscriptionTopicBuilder addCanFilterBy()

Start defining a can-filter-by extension

setCanFilterByDescription

public R4SubscriptionTopicBuilder setCanFilterByDescription(String theDescription)

Set the description for the current can-filter-by

setCanFilterByResource

public R4SubscriptionTopicBuilder setCanFilterByResource(String theResourceType)

Set the resource type for the current can-filter-by

setCanFilterByParameter

public R4SubscriptionTopicBuilder setCanFilterByParameter(String theFilterParameter)

Set the filter parameter for the current can-filter-by

addNotificationShape

public R4SubscriptionTopicBuilder addNotificationShape()

Start defining a notification shape extension

setNotificationShapeResource

public R4SubscriptionTopicBuilder setNotificationShapeResource(String theResourceType)

Set the resource type for the current notification shape

addNotificationShapeInclude

public R4SubscriptionTopicBuilder addNotificationShapeInclude(String theIncludeParam)

Add an include parameter to the current notification shape

addNotificationShapeRevInclude

public R4SubscriptionTopicBuilder addNotificationShapeRevInclude(String theRevIncludeParam)

Add a revInclude parameter to the current notification shape

build

public org.hl7.fhir.r4.model.Basic build()

Return the built Basic resource representing the SubscriptionTopic