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:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected List<PlanDefinition.PlanDefinitionActionComponent>actionSub actions that are contained within the action.protected Enumeration<Enumerations.ActionCardinalityBehavior>cardinalityBehaviorDefines whether the action can be selected multiple times.protected CodeableConceptcodeA code that provides a meaning, grouping, or classification for the action or action group.protected List<PlanDefinition.PlanDefinitionActionConditionComponent>conditionAn expression that describes applicability criteria or start/stop conditions for the action.protected DataTypedefinitionA reference to an ActivityDefinition that describes the action to be taken in detail, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, or an ObservationDefinition that specifies what observation should be captured.protected StringTypedescriptionA brief description of the action used to provide a summary to display to the user.protected List<RelatedArtifact>documentationDidactic or other informational resources associated with the action that can be provided to the CDS recipient.protected List<PlanDefinition.PlanDefinitionActionDynamicValueComponent>dynamicValueCustomizations that should be applied to the statically defined resource.protected List<IdType>goalIdIdentifies goals that this action supports.protected Enumeration<Enumerations.ActionGroupingBehavior>groupingBehaviorDefines the grouping behavior for the action and its children.protected List<PlanDefinition.PlanDefinitionActionInputComponent>inputDefines input data requirements for the action.protected StringTypelinkIdAn identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestGroup.protected CodeableReferencelocationIdentifies the facility where the action will occur; e.g.protected List<PlanDefinition.PlanDefinitionActionOutputComponent>outputDefines the outputs of the action, if any.protected List<PlanDefinition.PlanDefinitionActionParticipantComponent>participantIndicates who should participate in performing the action described.protected Enumeration<Enumerations.ActionPrecheckBehavior>precheckBehaviorDefines whether the action should usually be preselected.protected StringTypeprefixA user-visible prefix for the action.protected Enumeration<Enumerations.RequestPriority>priorityIndicates how quickly the action should be addressed with respect to other actions.protected List<CodeableConcept>reasonA description of why this action is necessary or appropriate.protected List<PlanDefinition.PlanDefinitionActionRelatedActionComponent>relatedActionA relationship to another action such as "before" or "30-60 minutes after start of".protected Enumeration<Enumerations.ActionRequiredBehavior>requiredBehaviorDefines the required behavior for the action.protected Enumeration<Enumerations.ActionSelectionBehavior>selectionBehaviorDefines the selection behavior for the action and its children.protected DataTypesubjectA code, group definition, or canonical reference that describes the intended subject of the action and its children, if any.protected StringTypetextEquivalentA text equivalent of the action to be performed.protected DataTypetimingAn optional value describing when the action should be performed.protected StringTypetitleThe textual description of the action displayed to a user.protected CanonicalTypetransformA 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>triggerA description of when the action should be triggered.protected CodeableConcepttypeThe type of action to perform (create, update, remove).-
Fields inherited from class org.hl7.fhir.r5.model.BackboneElement
modifierExtension
-
-
Constructor Summary
Constructors Constructor Description PlanDefinitionActionComponent()Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r5.model.BackboneElement
addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, removeExtension, setModifierExtension
-
Methods inherited from class org.hl7.fhir.r5.model.Element
addExtension, addExtension, addExtension, 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.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, 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
-
-
-
-
Field Detail
-
linkId
protected StringType linkId
An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestGroup.
-
prefix
protected StringType prefix
A user-visible prefix for the action. For example a section or item numbering such as 1. or A.
-
title
protected StringType 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
protected StringType description
A brief description of the action used to provide a summary to display to the user.
-
textEquivalent
protected StringType 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
protected Enumeration<Enumerations.RequestPriority> priority
Indicates how quickly the action should be addressed with respect to other actions.
-
code
protected CodeableConcept 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
protected List<CodeableConcept> reason
A description of why this action is necessary or appropriate.
-
documentation
protected List<RelatedArtifact> 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
protected List<IdType> 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
protected DataType 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
protected List<TriggerDefinition> trigger
A description of when the action should be triggered.
-
condition
protected List<PlanDefinition.PlanDefinitionActionConditionComponent> condition
An expression that describes applicability criteria or start/stop conditions for the action.
-
input
protected List<PlanDefinition.PlanDefinitionActionInputComponent> input
Defines input data requirements for the action.
-
output
protected List<PlanDefinition.PlanDefinitionActionOutputComponent> output
Defines the outputs of the action, if any.
-
relatedAction
protected List<PlanDefinition.PlanDefinitionActionRelatedActionComponent> relatedAction
A relationship to another action such as "before" or "30-60 minutes after start of".
-
location
protected CodeableReference location
Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc.
-
participant
protected List<PlanDefinition.PlanDefinitionActionParticipantComponent> participant
Indicates who should participate in performing the action described.
-
type
protected CodeableConcept type
The type of action to perform (create, update, remove).
-
groupingBehavior
protected Enumeration<Enumerations.ActionGroupingBehavior> groupingBehavior
Defines the grouping behavior for the action and its children.
-
selectionBehavior
protected Enumeration<Enumerations.ActionSelectionBehavior> selectionBehavior
Defines the selection behavior for the action and its children.
-
requiredBehavior
protected Enumeration<Enumerations.ActionRequiredBehavior> requiredBehavior
Defines the required behavior for the action.
-
precheckBehavior
protected Enumeration<Enumerations.ActionPrecheckBehavior> precheckBehavior
Defines whether the action should usually be preselected.
-
cardinalityBehavior
protected Enumeration<Enumerations.ActionCardinalityBehavior> cardinalityBehavior
Defines whether the action can be selected multiple times.
-
definition
protected DataType definition
A reference to an ActivityDefinition that describes the action to be taken in detail, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, or an ObservationDefinition that specifies what observation should be captured.
-
transform
protected CanonicalType 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
protected List<PlanDefinition.PlanDefinitionActionDynamicValueComponent> 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
protected List<PlanDefinition.PlanDefinitionActionComponent> 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 Detail
-
PlanDefinitionActionComponent
public PlanDefinitionActionComponent()
Constructor
-
-
Method Detail
-
getLinkIdElement
public StringType getLinkIdElement()
- Returns:
linkId(An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestGroup.). This is the underlying object with id, value and extensions. The accessor "getLinkId" gives direct access to the value
-
hasLinkIdElement
public boolean hasLinkIdElement()
-
hasLinkId
public boolean hasLinkId()
-
setLinkIdElement
public PlanDefinition.PlanDefinitionActionComponent setLinkIdElement(StringType value)
- Parameters:
value-linkId(An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestGroup.). This is the underlying object with id, value and extensions. The accessor "getLinkId" gives direct access to the value
-
getLinkId
public String getLinkId()
- Returns:
- An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestGroup.
-
setLinkId
public PlanDefinition.PlanDefinitionActionComponent setLinkId(String value)
- Parameters:
value- An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestGroup.
-
getPrefixElement
public StringType 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
public boolean hasPrefixElement()
-
hasPrefix
public boolean hasPrefix()
-
setPrefixElement
public PlanDefinition.PlanDefinitionActionComponent setPrefixElement(StringType value)
- 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
public String getPrefix()
- Returns:
- A user-visible prefix for the action. For example a section or item numbering such as 1. or A.
-
setPrefix
public PlanDefinition.PlanDefinitionActionComponent setPrefix(String value)
- Parameters:
value- A user-visible prefix for the action. For example a section or item numbering such as 1. or A.
-
getTitleElement
public StringType 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
public boolean hasTitleElement()
-
hasTitle
public boolean hasTitle()
-
setTitleElement
public PlanDefinition.PlanDefinitionActionComponent setTitleElement(StringType value)
- 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
public String 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
public PlanDefinition.PlanDefinitionActionComponent setTitle(String value)
- 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
public StringType 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
public boolean hasDescriptionElement()
-
hasDescription
public boolean hasDescription()
-
setDescriptionElement
public PlanDefinition.PlanDefinitionActionComponent setDescriptionElement(StringType value)
- 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
public String getDescription()
- Returns:
- A brief description of the action used to provide a summary to display to the user.
-
setDescription
public PlanDefinition.PlanDefinitionActionComponent setDescription(String value)
- Parameters:
value- A brief description of the action used to provide a summary to display to the user.
-
getTextEquivalentElement
public StringType 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
public boolean hasTextEquivalentElement()
-
hasTextEquivalent
public boolean hasTextEquivalent()
-
setTextEquivalentElement
public PlanDefinition.PlanDefinitionActionComponent setTextEquivalentElement(StringType value)
- 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
public String 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
public PlanDefinition.PlanDefinitionActionComponent setTextEquivalent(String value)
- 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
public Enumeration<Enumerations.RequestPriority> 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
public boolean hasPriorityElement()
-
hasPriority
public boolean 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
public Enumerations.RequestPriority getPriority()
- Returns:
- Indicates how quickly the action should be addressed with respect to other actions.
-
setPriority
public PlanDefinition.PlanDefinitionActionComponent setPriority(Enumerations.RequestPriority value)
- Parameters:
value- Indicates how quickly the action should be addressed with respect to other actions.
-
getCode
public CodeableConcept 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
public boolean hasCode()
-
setCode
public PlanDefinition.PlanDefinitionActionComponent setCode(CodeableConcept value)
- 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
public List<CodeableConcept> getReason()
- Returns:
reason(A description of why this action is necessary or appropriate.)
-
setReason
public PlanDefinition.PlanDefinitionActionComponent setReason(List<CodeableConcept> theReason)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReason
public boolean hasReason()
-
addReason
public CodeableConcept addReason()
-
addReason
public PlanDefinition.PlanDefinitionActionComponent addReason(CodeableConcept t)
-
getReasonFirstRep
public CodeableConcept getReasonFirstRep()
- Returns:
- The first repetition of repeating field
reason, creating it if it does not already exist {3}
-
getDocumentation
public List<RelatedArtifact> 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
thisfor easy method chaining
-
hasDocumentation
public boolean hasDocumentation()
-
addDocumentation
public RelatedArtifact addDocumentation()
-
addDocumentation
public PlanDefinition.PlanDefinitionActionComponent addDocumentation(RelatedArtifact t)
-
getDocumentationFirstRep
public RelatedArtifact getDocumentationFirstRep()
- Returns:
- The first repetition of repeating field
documentation, creating it if it does not already exist {3}
-
getGoalId
public List<IdType> 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
public PlanDefinition.PlanDefinitionActionComponent setGoalId(List<IdType> theGoalId)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasGoalId
public boolean hasGoalId()
-
addGoalIdElement
public IdType 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
public PlanDefinition.PlanDefinitionActionComponent addGoalId(String value)
- 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
public boolean hasGoalId(String value)
- 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
public DataType 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
public CodeableConcept getSubjectCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException
- 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
public boolean hasSubjectCodeableConcept()
-
getSubjectReference
public Reference getSubjectReference() throws org.hl7.fhir.exceptions.FHIRException
- 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
public boolean hasSubjectReference()
-
getSubjectCanonicalType
public CanonicalType getSubjectCanonicalType() throws org.hl7.fhir.exceptions.FHIRException
- 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
public boolean hasSubjectCanonicalType()
-
hasSubject
public boolean hasSubject()
-
setSubject
public PlanDefinition.PlanDefinitionActionComponent setSubject(DataType value)
- 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
public List<TriggerDefinition> getTrigger()
- Returns:
trigger(A description of when the action should be triggered.)
-
setTrigger
public PlanDefinition.PlanDefinitionActionComponent setTrigger(List<TriggerDefinition> theTrigger)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasTrigger
public boolean hasTrigger()
-
addTrigger
public TriggerDefinition addTrigger()
-
addTrigger
public PlanDefinition.PlanDefinitionActionComponent addTrigger(TriggerDefinition t)
-
getTriggerFirstRep
public TriggerDefinition getTriggerFirstRep()
- Returns:
- The first repetition of repeating field
trigger, creating it if it does not already exist {3}
-
getCondition
public List<PlanDefinition.PlanDefinitionActionConditionComponent> 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
thisfor easy method chaining
-
hasCondition
public boolean hasCondition()
-
addCondition
public PlanDefinition.PlanDefinitionActionConditionComponent addCondition()
-
addCondition
public PlanDefinition.PlanDefinitionActionComponent addCondition(PlanDefinition.PlanDefinitionActionConditionComponent t)
-
getConditionFirstRep
public PlanDefinition.PlanDefinitionActionConditionComponent getConditionFirstRep()
- Returns:
- The first repetition of repeating field
condition, creating it if it does not already exist {3}
-
getInput
public List<PlanDefinition.PlanDefinitionActionInputComponent> getInput()
- Returns:
input(Defines input data requirements for the action.)
-
setInput
public PlanDefinition.PlanDefinitionActionComponent setInput(List<PlanDefinition.PlanDefinitionActionInputComponent> theInput)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasInput
public boolean hasInput()
-
addInput
public PlanDefinition.PlanDefinitionActionInputComponent addInput()
-
addInput
public PlanDefinition.PlanDefinitionActionComponent addInput(PlanDefinition.PlanDefinitionActionInputComponent t)
-
getInputFirstRep
public PlanDefinition.PlanDefinitionActionInputComponent getInputFirstRep()
- Returns:
- The first repetition of repeating field
input, creating it if it does not already exist {3}
-
getOutput
public List<PlanDefinition.PlanDefinitionActionOutputComponent> 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
thisfor easy method chaining
-
hasOutput
public boolean hasOutput()
-
addOutput
public PlanDefinition.PlanDefinitionActionOutputComponent addOutput()
-
addOutput
public PlanDefinition.PlanDefinitionActionComponent addOutput(PlanDefinition.PlanDefinitionActionOutputComponent t)
-
getOutputFirstRep
public PlanDefinition.PlanDefinitionActionOutputComponent getOutputFirstRep()
- Returns:
- The first repetition of repeating field
output, creating it if it does not already exist {3}
-
getRelatedAction
public List<PlanDefinition.PlanDefinitionActionRelatedActionComponent> 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
thisfor easy method chaining
-
hasRelatedAction
public boolean hasRelatedAction()
-
addRelatedAction
public PlanDefinition.PlanDefinitionActionRelatedActionComponent addRelatedAction()
-
addRelatedAction
public PlanDefinition.PlanDefinitionActionComponent addRelatedAction(PlanDefinition.PlanDefinitionActionRelatedActionComponent t)
-
getRelatedActionFirstRep
public PlanDefinition.PlanDefinitionActionRelatedActionComponent getRelatedActionFirstRep()
- Returns:
- The first repetition of repeating field
relatedAction, creating it if it does not already exist {3}
-
getTiming
public DataType getTiming()
- Returns:
timing(An optional value describing when the action should be performed.)
-
getTimingAge
public Age getTimingAge() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
timing(An optional value describing when the action should be performed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingAge
public boolean hasTimingAge()
-
getTimingDuration
public Duration getTimingDuration() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
timing(An optional value describing when the action should be performed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingDuration
public boolean hasTimingDuration()
-
getTimingRange
public Range getTimingRange() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
timing(An optional value describing when the action should be performed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingRange
public boolean hasTimingRange()
-
getTimingTiming
public Timing getTimingTiming() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
timing(An optional value describing when the action should be performed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingTiming
public boolean hasTimingTiming()
-
hasTiming
public boolean hasTiming()
-
setTiming
public PlanDefinition.PlanDefinitionActionComponent setTiming(DataType value)
- Parameters:
value-timing(An optional value describing when the action should be performed.)
-
getLocation
public CodeableReference getLocation()
- Returns:
location(Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc.)
-
hasLocation
public boolean hasLocation()
-
setLocation
public PlanDefinition.PlanDefinitionActionComponent setLocation(CodeableReference value)
- Parameters:
value-location(Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc.)
-
getParticipant
public List<PlanDefinition.PlanDefinitionActionParticipantComponent> 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
thisfor easy method chaining
-
hasParticipant
public boolean hasParticipant()
-
addParticipant
public PlanDefinition.PlanDefinitionActionParticipantComponent addParticipant()
-
addParticipant
public PlanDefinition.PlanDefinitionActionComponent addParticipant(PlanDefinition.PlanDefinitionActionParticipantComponent t)
-
getParticipantFirstRep
public PlanDefinition.PlanDefinitionActionParticipantComponent getParticipantFirstRep()
- Returns:
- The first repetition of repeating field
participant, creating it if it does not already exist {3}
-
getType
public CodeableConcept getType()
- Returns:
type(The type of action to perform (create, update, remove).)
-
hasType
public boolean hasType()
-
setType
public PlanDefinition.PlanDefinitionActionComponent setType(CodeableConcept value)
- Parameters:
value-type(The type of action to perform (create, update, remove).)
-
getGroupingBehaviorElement
public Enumeration<Enumerations.ActionGroupingBehavior> 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
public boolean hasGroupingBehaviorElement()
-
hasGroupingBehavior
public boolean 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
public Enumerations.ActionGroupingBehavior 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
public Enumeration<Enumerations.ActionSelectionBehavior> 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
public boolean hasSelectionBehaviorElement()
-
hasSelectionBehavior
public boolean 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
public Enumerations.ActionSelectionBehavior 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
public Enumeration<Enumerations.ActionRequiredBehavior> 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
public boolean hasRequiredBehaviorElement()
-
hasRequiredBehavior
public boolean 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
public Enumerations.ActionRequiredBehavior 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
public Enumeration<Enumerations.ActionPrecheckBehavior> 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
public boolean hasPrecheckBehaviorElement()
-
hasPrecheckBehavior
public boolean 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
public Enumerations.ActionPrecheckBehavior 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
public Enumeration<Enumerations.ActionCardinalityBehavior> 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
public boolean hasCardinalityBehaviorElement()
-
hasCardinalityBehavior
public boolean 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
public Enumerations.ActionCardinalityBehavior 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
public DataType getDefinition()
- Returns:
definition(A reference to an ActivityDefinition that describes the action to be taken in detail, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, or an ObservationDefinition that specifies what observation should be captured.)
-
getDefinitionCanonicalType
public CanonicalType getDefinitionCanonicalType() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
definition(A reference to an ActivityDefinition that describes the action to be taken in detail, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, or an ObservationDefinition that specifies what observation should be captured.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasDefinitionCanonicalType
public boolean hasDefinitionCanonicalType()
-
getDefinitionUriType
public UriType getDefinitionUriType() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
definition(A reference to an ActivityDefinition that describes the action to be taken in detail, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, or an ObservationDefinition that specifies what observation should be captured.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasDefinitionUriType
public boolean hasDefinitionUriType()
-
hasDefinition
public boolean hasDefinition()
-
setDefinition
public PlanDefinition.PlanDefinitionActionComponent setDefinition(DataType value)
- Parameters:
value-definition(A reference to an ActivityDefinition that describes the action to be taken in detail, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, or an ObservationDefinition that specifies what observation should be captured.)
-
getTransformElement
public CanonicalType 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
public boolean hasTransformElement()
-
hasTransform
public boolean hasTransform()
-
setTransformElement
public PlanDefinition.PlanDefinitionActionComponent setTransformElement(CanonicalType value)
- 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
public String 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
public PlanDefinition.PlanDefinitionActionComponent setTransform(String value)
- 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
public List<PlanDefinition.PlanDefinitionActionDynamicValueComponent> 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
thisfor easy method chaining
-
hasDynamicValue
public boolean hasDynamicValue()
-
addDynamicValue
public PlanDefinition.PlanDefinitionActionDynamicValueComponent addDynamicValue()
-
addDynamicValue
public PlanDefinition.PlanDefinitionActionComponent addDynamicValue(PlanDefinition.PlanDefinitionActionDynamicValueComponent t)
-
getDynamicValueFirstRep
public PlanDefinition.PlanDefinitionActionDynamicValueComponent getDynamicValueFirstRep()
- Returns:
- The first repetition of repeating field
dynamicValue, creating it if it does not already exist {3}
-
getAction
public List<PlanDefinition.PlanDefinitionActionComponent> 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
thisfor easy method chaining
-
hasAction
public boolean hasAction()
-
addAction
public PlanDefinition.PlanDefinitionActionComponent addAction()
-
addAction
public PlanDefinition.PlanDefinitionActionComponent addAction(PlanDefinition.PlanDefinitionActionComponent t)
-
getActionFirstRep
public PlanDefinition.PlanDefinitionActionComponent getActionFirstRep()
- Returns:
- The first repetition of repeating field
action, creating it if it does not already exist {3}
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classBackboneElement
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
copy
public PlanDefinition.PlanDefinitionActionComponent copy()
- Specified by:
copyin classBackboneElement
-
copyValues
public void copyValues(PlanDefinition.PlanDefinitionActionComponent dst)
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classBackboneElement
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classBackboneElement
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classBackboneElement
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classBackboneElement
-
-