Package org.hl7.fhir.r4.model
Class RequestGroup.RequestGroupActionComponent
java.lang.Object
org.hl7.fhir.r4.model.Base
org.hl7.fhir.r4.model.Element
org.hl7.fhir.r4.model.BackboneElement
org.hl7.fhir.r4.model.RequestGroup.RequestGroupActionComponent
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseBackboneElement
,org.hl7.fhir.instance.model.api.IBaseElement
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
- Enclosing class:
RequestGroup
public static class RequestGroup.RequestGroupActionComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected List
<RequestGroup.RequestGroupActionComponent> Sub actions.Defines whether the action can be selected multiple times.protected List
<CodeableConcept> A code that provides meaning for the action or action group.An expression that describes applicability criteria, or start/stop conditions for the action.protected StringType
A short description of the action used to provide a summary to display to the user.protected List
<RelatedArtifact> Didactic or other informational resources associated with the action that can be provided to the CDS recipient.protected Enumeration
<RequestGroup.ActionGroupingBehavior> Defines the grouping behavior for the action and its children.The participant that should perform or be responsible for this action.The actual objects that are the target of the reference (The participant that should perform or be responsible for this action.)protected Enumeration
<RequestGroup.ActionPrecheckBehavior> Defines whether the action should usually be preselected.protected StringType
A user-visible prefix for the action.protected Enumeration
<RequestGroup.RequestPriority> Indicates how quickly the action should be addressed with respect to other actions.A relationship to another action such as "before" or "30-60 minutes after start of".protected Enumeration
<RequestGroup.ActionRequiredBehavior> Defines expectations around whether an action is required.protected Reference
The resource that is the target of the action (e.g.protected Resource
The actual object that is the target of the reference (The resource that is the target of the action (e.g.protected Enumeration
<RequestGroup.ActionSelectionBehavior> Defines the selection behavior for the action and its children.protected StringType
A text equivalent of the action to be performed.protected Type
An optional value describing when the action should be performed.protected StringType
The title of the action displayed to a user.protected CodeableConcept
The type of action to perform (create, update, remove).Fields inherited from class org.hl7.fhir.r4.model.BackboneElement
modifierExtension
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddCode()
copy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getCode()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Deprecated.Use Reference#setResource(IBaseResource) insteadBase[]
getProperty
(int hash, String name, boolean checkValid) getTitle()
getType()
String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
hasCode()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasTitle()
boolean
boolean
hasType()
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setAction
(List<RequestGroup.RequestGroupActionComponent> theAction) setCode
(List<CodeableConcept> theCode) setCondition
(List<RequestGroup.RequestGroupActionConditionComponent> theCondition) setDescription
(String value) setDescriptionElement
(StringType value) setDocumentation
(List<RelatedArtifact> theDocumentation) setParticipant
(List<Reference> theParticipant) setPrefixElement
(StringType value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setRelatedAction
(List<RequestGroup.RequestGroupActionRelatedActionComponent> theRelatedAction) setResource
(Reference value) setResourceTarget
(Resource value) setTextEquivalent
(String value) setTitleElement
(StringType value) setType
(CodeableConcept value) Methods inherited from class org.hl7.fhir.r4.model.BackboneElement
addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension
Methods inherited from class org.hl7.fhir.r4.model.Element
addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, 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.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions
addExtension, getExtension, hasExtension
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
addModifierExtension, getModifierExtension, hasModifierExtension
-
Field Details
-
prefix
A user-visible prefix for the action. -
title
The title of the action displayed to a user. -
description
A short description of the action used to provide a summary to display to the user. -
textEquivalent
A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically. -
priority
Indicates how quickly the action should be addressed with respect to other actions. -
code
A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template. -
documentation
Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources. -
condition
An expression that describes applicability criteria, or start/stop conditions for the action. -
timing
An optional value describing when the action should be performed. -
participant
The participant that should perform or be responsible for this action. -
participantTarget
The actual objects that are the target of the reference (The participant that should perform or be responsible for this action.) -
type
The type of action to perform (create, update, remove). -
groupingBehavior
Defines the grouping behavior for the action and its children. -
selectionBehavior
Defines the selection behavior for the action and its children. -
requiredBehavior
Defines expectations around whether an action is required. -
precheckBehavior
Defines whether the action should usually be preselected. -
cardinalityBehavior
Defines whether the action can be selected multiple times. -
resource
The resource that is the target of the action (e.g. CommunicationRequest). -
resourceTarget
The actual object that is the target of the reference (The resource that is the target of the action (e.g. CommunicationRequest).) -
action
Sub actions.
-
-
Constructor Details
-
RequestGroupActionComponent
public RequestGroupActionComponent()Constructor
-
-
Method Details
-
getPrefixElement
- Returns:
prefix
(A user-visible prefix for the action.). This is the underlying object with id, value and extensions. The accessor "getPrefix" gives direct access to the value
-
hasPrefixElement
-
hasPrefix
-
setPrefixElement
- Parameters:
value
-prefix
(A user-visible prefix for the action.). This is the underlying object with id, value and extensions. The accessor "getPrefix" gives direct access to the value
-
getPrefix
- Returns:
- A user-visible prefix for the action.
-
setPrefix
- Parameters:
value
- A user-visible prefix for the action.
-
getTitleElement
- Returns:
title
(The title of the action displayed to a user.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
hasTitleElement
-
hasTitle
-
setTitleElement
- Parameters:
value
-title
(The title of the action displayed to a user.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
getTitle
- Returns:
- The title of the action displayed to a user.
-
setTitle
- Parameters:
value
- The title of the action displayed to a user.
-
getDescriptionElement
- Returns:
description
(A short description of the action used to provide a summary to display to the user.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
-
hasDescription
-
setDescriptionElement
- Parameters:
value
-description
(A short description of the action used to provide a summary to display to the user.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
- Returns:
- A short description of the action used to provide a summary to display to the user.
-
setDescription
- Parameters:
value
- A short description of the action used to provide a summary to display to the user.
-
getTextEquivalentElement
- Returns:
textEquivalent
(A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.). This is the underlying object with id, value and extensions. The accessor "getTextEquivalent" gives direct access to the value
-
hasTextEquivalentElement
-
hasTextEquivalent
-
setTextEquivalentElement
- Parameters:
value
-textEquivalent
(A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.). This is the underlying object with id, value and extensions. The accessor "getTextEquivalent" gives direct access to the value
-
getTextEquivalent
- Returns:
- A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.
-
setTextEquivalent
- Parameters:
value
- A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.
-
getPriorityElement
- Returns:
priority
(Indicates how quickly the action should be addressed with respect to other actions.). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value
-
hasPriorityElement
-
hasPriority
-
setPriorityElement
public RequestGroup.RequestGroupActionComponent setPriorityElement(Enumeration<RequestGroup.RequestPriority> value) - Parameters:
value
-priority
(Indicates how quickly the action should be addressed with respect to other actions.). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value
-
getPriority
- Returns:
- Indicates how quickly the action should be addressed with respect to other actions.
-
setPriority
- Parameters:
value
- Indicates how quickly the action should be addressed with respect to other actions.
-
getCode
- Returns:
code
(A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template.)
-
setCode
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCode
-
addCode
-
addCode
-
getCodeFirstRep
- Returns:
- The first repetition of repeating field
code
, creating it if it does not already exist
-
getDocumentation
- Returns:
documentation
(Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.)
-
setDocumentation
public RequestGroup.RequestGroupActionComponent setDocumentation(List<RelatedArtifact> theDocumentation) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasDocumentation
-
addDocumentation
-
addDocumentation
-
getDocumentationFirstRep
- Returns:
- The first repetition of repeating field
documentation
, creating it if it does not already exist
-
getCondition
- Returns:
condition
(An expression that describes applicability criteria, or start/stop conditions for the action.)
-
setCondition
public RequestGroup.RequestGroupActionComponent setCondition(List<RequestGroup.RequestGroupActionConditionComponent> theCondition) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasCondition
-
addCondition
-
addCondition
-
getConditionFirstRep
- Returns:
- The first repetition of repeating field
condition
, creating it if it does not already exist
-
getRelatedAction
- Returns:
relatedAction
(A relationship to another action such as "before" or "30-60 minutes after start of".)
-
setRelatedAction
public RequestGroup.RequestGroupActionComponent setRelatedAction(List<RequestGroup.RequestGroupActionRelatedActionComponent> theRelatedAction) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasRelatedAction
-
addRelatedAction
-
addRelatedAction
-
getRelatedActionFirstRep
- Returns:
- The first repetition of repeating field
relatedAction
, creating it if it does not already exist
-
getTiming
- Returns:
timing
(An optional value describing when the action should be performed.)
-
getTimingDateTimeType
- Returns:
timing
(An optional value describing when the action should be performed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingDateTimeType
-
getTimingAge
- Returns:
timing
(An optional value describing when the action should be performed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingAge
-
getTimingPeriod
- Returns:
timing
(An optional value describing when the action should be performed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingPeriod
-
getTimingDuration
- Returns:
timing
(An optional value describing when the action should be performed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingDuration
-
getTimingRange
- Returns:
timing
(An optional value describing when the action should be performed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingRange
-
getTimingTiming
- Returns:
timing
(An optional value describing when the action should be performed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingTiming
-
hasTiming
-
setTiming
- Parameters:
value
-timing
(An optional value describing when the action should be performed.)
-
getParticipant
- Returns:
participant
(The participant that should perform or be responsible for this action.)
-
setParticipant
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasParticipant
-
addParticipant
-
addParticipant
-
getParticipantFirstRep
- Returns:
- The first repetition of repeating field
participant
, creating it if it does not already exist
-
getParticipantTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getType
- Returns:
type
(The type of action to perform (create, update, remove).)
-
hasType
-
setType
- Parameters:
value
-type
(The type of action to perform (create, update, remove).)
-
getGroupingBehaviorElement
- Returns:
groupingBehavior
(Defines the grouping behavior for the action and its children.). This is the underlying object with id, value and extensions. The accessor "getGroupingBehavior" gives direct access to the value
-
hasGroupingBehaviorElement
-
hasGroupingBehavior
-
setGroupingBehaviorElement
public RequestGroup.RequestGroupActionComponent setGroupingBehaviorElement(Enumeration<RequestGroup.ActionGroupingBehavior> value) - Parameters:
value
-groupingBehavior
(Defines the grouping behavior for the action and its children.). This is the underlying object with id, value and extensions. The accessor "getGroupingBehavior" gives direct access to the value
-
getGroupingBehavior
- Returns:
- Defines the grouping behavior for the action and its children.
-
setGroupingBehavior
public RequestGroup.RequestGroupActionComponent setGroupingBehavior(RequestGroup.ActionGroupingBehavior value) - Parameters:
value
- Defines the grouping behavior for the action and its children.
-
getSelectionBehaviorElement
- Returns:
selectionBehavior
(Defines the selection behavior for the action and its children.). This is the underlying object with id, value and extensions. The accessor "getSelectionBehavior" gives direct access to the value
-
hasSelectionBehaviorElement
-
hasSelectionBehavior
-
setSelectionBehaviorElement
public RequestGroup.RequestGroupActionComponent setSelectionBehaviorElement(Enumeration<RequestGroup.ActionSelectionBehavior> value) - Parameters:
value
-selectionBehavior
(Defines the selection behavior for the action and its children.). This is the underlying object with id, value and extensions. The accessor "getSelectionBehavior" gives direct access to the value
-
getSelectionBehavior
- Returns:
- Defines the selection behavior for the action and its children.
-
setSelectionBehavior
public RequestGroup.RequestGroupActionComponent setSelectionBehavior(RequestGroup.ActionSelectionBehavior value) - Parameters:
value
- Defines the selection behavior for the action and its children.
-
getRequiredBehaviorElement
- Returns:
requiredBehavior
(Defines expectations around whether an action is required.). This is the underlying object with id, value and extensions. The accessor "getRequiredBehavior" gives direct access to the value
-
hasRequiredBehaviorElement
-
hasRequiredBehavior
-
setRequiredBehaviorElement
public RequestGroup.RequestGroupActionComponent setRequiredBehaviorElement(Enumeration<RequestGroup.ActionRequiredBehavior> value) - Parameters:
value
-requiredBehavior
(Defines expectations around whether an action is required.). This is the underlying object with id, value and extensions. The accessor "getRequiredBehavior" gives direct access to the value
-
getRequiredBehavior
- Returns:
- Defines expectations around whether an action is required.
-
setRequiredBehavior
public RequestGroup.RequestGroupActionComponent setRequiredBehavior(RequestGroup.ActionRequiredBehavior value) - Parameters:
value
- Defines expectations around whether an action is required.
-
getPrecheckBehaviorElement
- Returns:
precheckBehavior
(Defines whether the action should usually be preselected.). This is the underlying object with id, value and extensions. The accessor "getPrecheckBehavior" gives direct access to the value
-
hasPrecheckBehaviorElement
-
hasPrecheckBehavior
-
setPrecheckBehaviorElement
public RequestGroup.RequestGroupActionComponent setPrecheckBehaviorElement(Enumeration<RequestGroup.ActionPrecheckBehavior> value) - Parameters:
value
-precheckBehavior
(Defines whether the action should usually be preselected.). This is the underlying object with id, value and extensions. The accessor "getPrecheckBehavior" gives direct access to the value
-
getPrecheckBehavior
- Returns:
- Defines whether the action should usually be preselected.
-
setPrecheckBehavior
public RequestGroup.RequestGroupActionComponent setPrecheckBehavior(RequestGroup.ActionPrecheckBehavior value) - Parameters:
value
- Defines whether the action should usually be preselected.
-
getCardinalityBehaviorElement
- Returns:
cardinalityBehavior
(Defines whether the action can be selected multiple times.). This is the underlying object with id, value and extensions. The accessor "getCardinalityBehavior" gives direct access to the value
-
hasCardinalityBehaviorElement
-
hasCardinalityBehavior
-
setCardinalityBehaviorElement
public RequestGroup.RequestGroupActionComponent setCardinalityBehaviorElement(Enumeration<RequestGroup.ActionCardinalityBehavior> value) - Parameters:
value
-cardinalityBehavior
(Defines whether the action can be selected multiple times.). This is the underlying object with id, value and extensions. The accessor "getCardinalityBehavior" gives direct access to the value
-
getCardinalityBehavior
- Returns:
- Defines whether the action can be selected multiple times.
-
setCardinalityBehavior
public RequestGroup.RequestGroupActionComponent setCardinalityBehavior(RequestGroup.ActionCardinalityBehavior value) - Parameters:
value
- Defines whether the action can be selected multiple times.
-
getResource
- Returns:
resource
(The resource that is the target of the action (e.g. CommunicationRequest).)
-
hasResource
-
setResource
- Parameters:
value
-resource
(The resource that is the target of the action (e.g. CommunicationRequest).)
-
getResourceTarget
- Returns:
resource
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The resource that is the target of the action (e.g. CommunicationRequest).)
-
setResourceTarget
- Parameters:
value
-resource
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The resource that is the target of the action (e.g. CommunicationRequest).)
-
getAction
- Returns:
action
(Sub actions.)
-
setAction
public RequestGroup.RequestGroupActionComponent setAction(List<RequestGroup.RequestGroupActionComponent> theAction) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasAction
-
addAction
-
addAction
-
getActionFirstRep
- Returns:
- The first repetition of repeating field
action
, creating it if it does not already exist
-
listChildren
- Overrides:
listChildren
in classBackboneElement
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classBackboneElement
- 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 classBackboneElement
- 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 classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
copy
- Specified by:
copy
in classBackboneElement
-
copyValues
-
equalsDeep
- Overrides:
equalsDeep
in classBackboneElement
-
equalsShallow
- Overrides:
equalsShallow
in classBackboneElement
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classBackboneElement
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classBackboneElement
-