Package org.hl7.fhir.r5.model
Class PlanDefinition.PlanDefinitionActionComponent
java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.Element
org.hl7.fhir.r5.model.BackboneElement
org.hl7.fhir.r5.model.PlanDefinition.PlanDefinitionActionComponent
- 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:
PlanDefinition
public static class PlanDefinition.PlanDefinitionActionComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base
Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason
-
Field Summary
Modifier and TypeFieldDescriptionprotected List
<PlanDefinition.PlanDefinitionActionComponent> Sub actions that are contained within the action.Defines whether the action can be selected multiple times.protected CodeableConcept
A code that provides a meaning, grouping, or classification for the action or action group.An expression that describes applicability criteria or start/stop conditions for the action.protected DataType
A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.protected MarkdownType
A brief 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.Customizations that should be applied to the statically defined resource.Identifies goals that this action supports.protected Enumeration
<Enumerations.ActionGroupingBehavior> Defines the grouping behavior for the action and its children.Defines input data requirements for the action.protected StringType
An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.protected CodeableReference
Identifies the facility where the action will occur; e.g.Defines the outputs of the action, if any.Indicates who should participate in performing the action described.protected Enumeration
<Enumerations.ActionPrecheckBehavior> Defines whether the action should usually be preselected.protected StringType
A user-visible prefix for the action.protected Enumeration
<Enumerations.RequestPriority> Indicates how quickly the action should be addressed with respect to other actions.protected List
<CodeableConcept> A description of why this action is necessary or appropriate.A relationship to another action such as "before" or "30-60 minutes after start of".protected Enumeration
<Enumerations.ActionRequiredBehavior> Defines the required behavior for the action.protected Enumeration
<Enumerations.ActionSelectionBehavior> Defines the selection behavior for the action and its children.protected DataType
A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any.protected MarkdownType
A text equivalent of the action to be performed.protected DataType
An optional value describing when the action should be performed.protected StringType
The textual description of the action displayed to a user.protected CanonicalType
A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.protected List
<TriggerDefinition> A description of when the action should be triggered.protected CodeableConcept
The type of action to perform (create, update, remove).Fields inherited from class org.hl7.fhir.r5.model.BackboneElement
modifierExtension
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddInput()
copy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getCode()
getInput()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
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
hasInput()
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
boolean
boolean
boolean
hasType()
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setCode
(CodeableConcept value) setDefinition
(DataType value) setDescription
(String value) setDocumentation
(List<RelatedArtifact> theDocumentation) setDynamicValue
(List<PlanDefinition.PlanDefinitionActionDynamicValueComponent> theDynamicValue) setLinkIdElement
(StringType value) setLocation
(CodeableReference value) setParticipant
(List<PlanDefinition.PlanDefinitionActionParticipantComponent> theParticipant) setPrefixElement
(StringType value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setReason
(List<CodeableConcept> theReason) setRelatedAction
(List<PlanDefinition.PlanDefinitionActionRelatedActionComponent> theRelatedAction) setSubject
(DataType value) setTextEquivalent
(String value) setTitleElement
(StringType value) setTransform
(String value) setTransformElement
(CanonicalType value) setTrigger
(List<TriggerDefinition> theTrigger) setType
(CodeableConcept value) Methods inherited from class org.hl7.fhir.r5.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.r5.model.Element
addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus
Methods inherited from class org.hl7.fhir.r5.model.Base
addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.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
-
linkId
An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration. -
prefix
A user-visible prefix for the action. For example a section or item numbering such as 1. or A. -
title
The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC. -
description
A brief 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 a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property. -
reason
A description of why this action is necessary or appropriate. -
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. -
goalId
Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action. -
subject
A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. -
trigger
A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action. -
condition
An expression that describes applicability criteria or start/stop conditions for the action. -
input
Defines input data requirements for the action. -
output
Defines the outputs of the action, if any. -
timing
An optional value describing when the action should be performed. -
location
Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc. -
participant
Indicates who should participate in performing the action described. -
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 the required behavior for the action. -
precheckBehavior
Defines whether the action should usually be preselected. -
cardinalityBehavior
Defines whether the action can be selected multiple times. -
definition
A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured. -
transform
A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input. -
dynamicValue
Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result. -
action
Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.
-
-
Constructor Details
-
PlanDefinitionActionComponent
public PlanDefinitionActionComponent()Constructor
-
-
Method Details
-
getLinkIdElement
- Returns:
linkId
(An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.). This is the underlying object with id, value and extensions. The accessor "getLinkId" gives direct access to the value
-
hasLinkIdElement
-
hasLinkId
-
setLinkIdElement
- Parameters:
value
-linkId
(An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.). This is the underlying object with id, value and extensions. The accessor "getLinkId" gives direct access to the value
-
getLinkId
- Returns:
- An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.
-
setLinkId
- Parameters:
value
- An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.
-
getPrefixElement
- Returns:
prefix
(A user-visible prefix for the action. For example a section or item numbering such as 1. or A.). 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. For example a section or item numbering such as 1. or A.). 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. For example a section or item numbering such as 1. or A.
-
setPrefix
- Parameters:
value
- A user-visible prefix for the action. For example a section or item numbering such as 1. or A.
-
getTitleElement
- Returns:
title
(The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC.). 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 textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
getTitle
- Returns:
- The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC.
-
setTitle
- Parameters:
value
- The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC.
-
getDescriptionElement
- Returns:
description
(A brief 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 brief 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 brief description of the action used to provide a summary to display to the user.
-
setDescription
- Parameters:
value
- A brief 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 PlanDefinition.PlanDefinitionActionComponent setPriorityElement(Enumeration<Enumerations.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 a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property.)
-
hasCode
-
setCode
- Parameters:
value
-code
(A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property.)
-
getReason
- Returns:
reason
(A description of why this action is necessary or appropriate.)
-
setReason
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReason
-
addReason
-
addReason
-
getReasonFirstRep
- Returns:
- The first repetition of repeating field
reason
, creating it if it does not already exist {3}
-
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 PlanDefinition.PlanDefinitionActionComponent 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 {3}
-
getGoalId
- Returns:
goalId
(Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.)
-
setGoalId
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasGoalId
-
addGoalIdElement
- Returns:
goalId
(Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.)
-
addGoalId
- Parameters:
value
-goalId
(Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.)
-
hasGoalId
- Parameters:
value
-goalId
(Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.)
-
getSubject
- Returns:
subject
(A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.)
-
getSubjectCodeableConcept
- Returns:
subject
(A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasSubjectCodeableConcept
-
getSubjectReference
- Returns:
subject
(A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasSubjectReference
-
getSubjectCanonicalType
- Returns:
subject
(A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasSubjectCanonicalType
-
hasSubject
-
setSubject
- Parameters:
value
-subject
(A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.)
-
getTrigger
- Returns:
trigger
(A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.)
-
setTrigger
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasTrigger
-
addTrigger
-
addTrigger
-
getTriggerFirstRep
- Returns:
- The first repetition of repeating field
trigger
, creating it if it does not already exist {3}
-
getCondition
- Returns:
condition
(An expression that describes applicability criteria or start/stop conditions for the action.)
-
setCondition
public PlanDefinition.PlanDefinitionActionComponent setCondition(List<PlanDefinition.PlanDefinitionActionConditionComponent> 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 {3}
-
getInput
- Returns:
input
(Defines input data requirements for the action.)
-
setInput
public PlanDefinition.PlanDefinitionActionComponent setInput(List<PlanDefinition.PlanDefinitionActionInputComponent> theInput) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasInput
-
addInput
-
addInput
-
getInputFirstRep
- Returns:
- The first repetition of repeating field
input
, creating it if it does not already exist {3}
-
getOutput
- Returns:
output
(Defines the outputs of the action, if any.)
-
setOutput
public PlanDefinition.PlanDefinitionActionComponent setOutput(List<PlanDefinition.PlanDefinitionActionOutputComponent> theOutput) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasOutput
-
addOutput
-
addOutput
-
getOutputFirstRep
- Returns:
- The first repetition of repeating field
output
, creating it if it does not already exist {3}
-
getRelatedAction
- Returns:
relatedAction
(A relationship to another action such as "before" or "30-60 minutes after start of".)
-
setRelatedAction
public PlanDefinition.PlanDefinitionActionComponent setRelatedAction(List<PlanDefinition.PlanDefinitionActionRelatedActionComponent> 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 {3}
-
getTiming
- Returns:
timing
(An optional value describing when the action should be performed.)
-
getTimingAge
- Returns:
timing
(An optional value describing when the action should be performed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingAge
-
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.)
-
getLocation
- Returns:
location
(Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc.)
-
hasLocation
-
setLocation
- Parameters:
value
-location
(Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc.)
-
getParticipant
- Returns:
participant
(Indicates who should participate in performing the action described.)
-
setParticipant
public PlanDefinition.PlanDefinitionActionComponent setParticipant(List<PlanDefinition.PlanDefinitionActionParticipantComponent> theParticipant) - 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 {3}
-
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 PlanDefinition.PlanDefinitionActionComponent setGroupingBehaviorElement(Enumeration<Enumerations.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 PlanDefinition.PlanDefinitionActionComponent setGroupingBehavior(Enumerations.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 PlanDefinition.PlanDefinitionActionComponent setSelectionBehaviorElement(Enumeration<Enumerations.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 PlanDefinition.PlanDefinitionActionComponent setSelectionBehavior(Enumerations.ActionSelectionBehavior value) - Parameters:
value
- Defines the selection behavior for the action and its children.
-
getRequiredBehaviorElement
- Returns:
requiredBehavior
(Defines the required behavior for the action.). This is the underlying object with id, value and extensions. The accessor "getRequiredBehavior" gives direct access to the value
-
hasRequiredBehaviorElement
-
hasRequiredBehavior
-
setRequiredBehaviorElement
public PlanDefinition.PlanDefinitionActionComponent setRequiredBehaviorElement(Enumeration<Enumerations.ActionRequiredBehavior> value) - Parameters:
value
-requiredBehavior
(Defines the required behavior for the action.). This is the underlying object with id, value and extensions. The accessor "getRequiredBehavior" gives direct access to the value
-
getRequiredBehavior
- Returns:
- Defines the required behavior for the action.
-
setRequiredBehavior
public PlanDefinition.PlanDefinitionActionComponent setRequiredBehavior(Enumerations.ActionRequiredBehavior value) - Parameters:
value
- Defines the required behavior for the action.
-
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 PlanDefinition.PlanDefinitionActionComponent setPrecheckBehaviorElement(Enumeration<Enumerations.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 PlanDefinition.PlanDefinitionActionComponent setPrecheckBehavior(Enumerations.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 PlanDefinition.PlanDefinitionActionComponent setCardinalityBehaviorElement(Enumeration<Enumerations.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 PlanDefinition.PlanDefinitionActionComponent setCardinalityBehavior(Enumerations.ActionCardinalityBehavior value) - Parameters:
value
- Defines whether the action can be selected multiple times.
-
getDefinition
- Returns:
definition
(A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.)
-
getDefinitionCanonicalType
- Returns:
definition
(A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasDefinitionCanonicalType
-
getDefinitionUriType
- Returns:
definition
(A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasDefinitionUriType
-
hasDefinition
-
setDefinition
- Parameters:
value
-definition
(A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.)
-
getTransformElement
- Returns:
transform
(A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.). This is the underlying object with id, value and extensions. The accessor "getTransform" gives direct access to the value
-
hasTransformElement
-
hasTransform
-
setTransformElement
- Parameters:
value
-transform
(A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.). This is the underlying object with id, value and extensions. The accessor "getTransform" gives direct access to the value
-
getTransform
- Returns:
- A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
-
setTransform
- Parameters:
value
- A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
-
getDynamicValue
- Returns:
dynamicValue
(Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.)
-
setDynamicValue
public PlanDefinition.PlanDefinitionActionComponent setDynamicValue(List<PlanDefinition.PlanDefinitionActionDynamicValueComponent> theDynamicValue) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasDynamicValue
-
addDynamicValue
-
addDynamicValue
-
getDynamicValueFirstRep
- Returns:
- The first repetition of repeating field
dynamicValue
, creating it if it does not already exist {3}
-
getAction
- Returns:
action
(Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.)
-
setAction
public PlanDefinition.PlanDefinitionActionComponent setAction(List<PlanDefinition.PlanDefinitionActionComponent> 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 {3}
-
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
- Returns:
- the FHIR type name of the instance (not the java class name)
-