Package org.hl7.fhir.dstu2016may.model
Class ActionDefinition
- java.lang.Object
-
- org.hl7.fhir.dstu2016may.model.Base
-
- org.hl7.fhir.dstu2016may.model.Element
-
- org.hl7.fhir.dstu2016may.model.Type
-
- org.hl7.fhir.dstu2016may.model.ActionDefinition
-
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement,Serializable,org.hl7.fhir.instance.model.api.IBase,org.hl7.fhir.instance.model.api.IBaseDatatype,org.hl7.fhir.instance.model.api.IBaseElement,org.hl7.fhir.instance.model.api.IBaseHasExtensions,org.hl7.fhir.instance.model.api.ICompositeType
public class ActionDefinition extends Type implements org.hl7.fhir.instance.model.api.ICompositeType
The definition of an action to be performed. Some aspects of the definition are specified statically, and some aspects can be specified dynamically by referencing logic defined in a library.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classActionDefinition.ActionDefinitionBehaviorComponentstatic classActionDefinition.ActionDefinitionCustomizationComponentstatic classActionDefinition.ActionDefinitionRelatedActionComponentstatic classActionDefinition.ActionRelationshipAnchorstatic classActionDefinition.ActionRelationshipAnchorEnumFactorystatic classActionDefinition.ActionRelationshipTypestatic classActionDefinition.ActionRelationshipTypeEnumFactorystatic classActionDefinition.ActionTypestatic classActionDefinition.ActionTypeEnumFactorystatic classActionDefinition.ParticipantTypestatic classActionDefinition.ParticipantTypeEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected List<ActionDefinition>actionSub actions that are contained within the action.protected IdentifieractionIdentifierA unique identifier for the action.protected List<ActionDefinition.ActionDefinitionBehaviorComponent>behaviorA behavior associated with the action.protected List<CodeableConcept>conceptThe concept represented by this action or its sub-actions.protected List<ActionDefinition.ActionDefinitionCustomizationComponent>customizationCustomizations that should be applied to the statically defined resource.protected StringTypedescriptionA short description of the action used to provide a summary to display to the user.protected List<Attachment>documentationDidactic or other informational resources associated with the action that can be provided to the CDS recipient.protected StringTypelabelA user-visible label for the action.protected List<Enumeration<ActionDefinition.ParticipantType>>participantTypeThe type of participant in the action.protected ActionDefinition.ActionDefinitionRelatedActionComponentrelatedActionA relationship to another action such as "before" or "30-60 minutes after start of".protected ReferenceresourceThe resource that is the target of the action (e.g.protected ResourceresourceTargetThe actual object that is the target of the reference (The resource that is the target of the action (e.g.protected List<Attachment>supportingEvidenceThe evidence grade and the sources of evidence for this action.protected StringTypetextEquivalentA text equivalent of the action to be performed.protected StringTypetitleThe title of the action displayed to a user.protected Enumeration<ActionDefinition.ActionType>typeThe type of action to perform (create, update, remove).
-
Constructor Summary
Constructors Constructor Description ActionDefinition()Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu2016may.model.Element
addExtension, addExtension, copyValues, getExtension, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setId, setIdElement
-
Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
Field Detail
-
actionIdentifier
protected Identifier actionIdentifier
A unique identifier for the action. The identifier SHALL be unique within the container in which it appears, and MAY be universally unique.
-
label
protected StringType label
A user-visible label for the action.
-
title
protected StringType title
The title of the action displayed to a user.
-
description
protected StringType description
A short 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 may not be capable of interpreting it dynamically.
-
concept
protected List<CodeableConcept> concept
The concept represented by this action or its sub-actions.
-
supportingEvidence
protected List<Attachment> supportingEvidence
The evidence grade and the sources of evidence for this action.
-
documentation
protected List<Attachment> 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.
-
relatedAction
protected ActionDefinition.ActionDefinitionRelatedActionComponent relatedAction
A relationship to another action such as "before" or "30-60 minutes after start of".
-
participantType
protected List<Enumeration<ActionDefinition.ParticipantType>> participantType
The type of participant in the action.
-
type
protected Enumeration<ActionDefinition.ActionType> type
The type of action to perform (create, update, remove).
-
behavior
protected List<ActionDefinition.ActionDefinitionBehaviorComponent> behavior
A behavior associated with the action. Behaviors define how the action is to be presented and/or executed within the receiving environment.
-
resource
protected Reference resource
The resource that is the target of the action (e.g. CommunicationRequest). The resource described here defines any aspects of the action that can be specified statically (i.e. are known at the time of definition).
-
resourceTarget
protected Resource resourceTarget
The actual object that is the target of the reference (The resource that is the target of the action (e.g. CommunicationRequest). The resource described here defines any aspects of the action that can be specified statically (i.e. are known at the time of definition).)
-
customization
protected List<ActionDefinition.ActionDefinitionCustomizationComponent> customization
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<ActionDefinition> 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
-
ActionDefinition
public ActionDefinition()
Constructor
-
-
Method Detail
-
getActionIdentifier
public Identifier getActionIdentifier()
- Returns:
actionIdentifier(A unique identifier for the action. The identifier SHALL be unique within the container in which it appears, and MAY be universally unique.)
-
hasActionIdentifier
public boolean hasActionIdentifier()
-
setActionIdentifier
public ActionDefinition setActionIdentifier(Identifier value)
- Parameters:
value-actionIdentifier(A unique identifier for the action. The identifier SHALL be unique within the container in which it appears, and MAY be universally unique.)
-
getLabelElement
public StringType getLabelElement()
- Returns:
label(A user-visible label for the action.). This is the underlying object with id, value and extensions. The accessor "getLabel" gives direct access to the value
-
hasLabelElement
public boolean hasLabelElement()
-
hasLabel
public boolean hasLabel()
-
setLabelElement
public ActionDefinition setLabelElement(StringType value)
- Parameters:
value-label(A user-visible label for the action.). This is the underlying object with id, value and extensions. The accessor "getLabel" gives direct access to the value
-
setLabel
public ActionDefinition setLabel(String value)
- Parameters:
value- A user-visible label for the action.
-
getTitleElement
public StringType 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
public boolean hasTitleElement()
-
hasTitle
public boolean hasTitle()
-
setTitleElement
public ActionDefinition setTitleElement(StringType value)
- 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
-
setTitle
public ActionDefinition setTitle(String value)
- Parameters:
value- The title of the action displayed to a user.
-
getDescriptionElement
public StringType 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
public boolean hasDescriptionElement()
-
hasDescription
public boolean hasDescription()
-
setDescriptionElement
public ActionDefinition setDescriptionElement(StringType value)
- 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
public String getDescription()
- Returns:
- A short description of the action used to provide a summary to display to the user.
-
setDescription
public ActionDefinition setDescription(String value)
- Parameters:
value- A short 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 may 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 ActionDefinition 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 may 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 may not be capable of interpreting it dynamically.
-
setTextEquivalent
public ActionDefinition 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 may not be capable of interpreting it dynamically.
-
getConcept
public List<CodeableConcept> getConcept()
- Returns:
concept(The concept represented by this action or its sub-actions.)
-
hasConcept
public boolean hasConcept()
-
addConcept
public CodeableConcept addConcept()
- Returns:
concept(The concept represented by this action or its sub-actions.)
-
addConcept
public ActionDefinition addConcept(CodeableConcept t)
-
getSupportingEvidence
public List<Attachment> getSupportingEvidence()
- Returns:
supportingEvidence(The evidence grade and the sources of evidence for this action.)
-
hasSupportingEvidence
public boolean hasSupportingEvidence()
-
addSupportingEvidence
public Attachment addSupportingEvidence()
- Returns:
supportingEvidence(The evidence grade and the sources of evidence for this action.)
-
addSupportingEvidence
public ActionDefinition addSupportingEvidence(Attachment t)
-
getDocumentation
public List<Attachment> 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.)
-
hasDocumentation
public boolean hasDocumentation()
-
addDocumentation
public Attachment addDocumentation()
- 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.)
-
addDocumentation
public ActionDefinition addDocumentation(Attachment t)
-
getRelatedAction
public ActionDefinition.ActionDefinitionRelatedActionComponent getRelatedAction()
- Returns:
relatedAction(A relationship to another action such as "before" or "30-60 minutes after start of".)
-
hasRelatedAction
public boolean hasRelatedAction()
-
setRelatedAction
public ActionDefinition setRelatedAction(ActionDefinition.ActionDefinitionRelatedActionComponent value)
- Parameters:
value-relatedAction(A relationship to another action such as "before" or "30-60 minutes after start of".)
-
getParticipantType
public List<Enumeration<ActionDefinition.ParticipantType>> getParticipantType()
- Returns:
participantType(The type of participant in the action.)
-
hasParticipantType
public boolean hasParticipantType()
-
addParticipantTypeElement
public Enumeration<ActionDefinition.ParticipantType> addParticipantTypeElement()
- Returns:
participantType(The type of participant in the action.)
-
addParticipantType
public ActionDefinition addParticipantType(ActionDefinition.ParticipantType value)
- Parameters:
value-participantType(The type of participant in the action.)
-
hasParticipantType
public boolean hasParticipantType(ActionDefinition.ParticipantType value)
- Parameters:
value-participantType(The type of participant in the action.)
-
getTypeElement
public Enumeration<ActionDefinition.ActionType> getTypeElement()
- Returns:
type(The type of action to perform (create, update, remove).). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value
-
hasTypeElement
public boolean hasTypeElement()
-
hasType
public boolean hasType()
-
setTypeElement
public ActionDefinition setTypeElement(Enumeration<ActionDefinition.ActionType> value)
- Parameters:
value-type(The type of action to perform (create, update, remove).). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value
-
getType
public ActionDefinition.ActionType getType()
- Returns:
- The type of action to perform (create, update, remove).
-
setType
public ActionDefinition setType(ActionDefinition.ActionType value)
- Parameters:
value- The type of action to perform (create, update, remove).
-
getBehavior
public List<ActionDefinition.ActionDefinitionBehaviorComponent> getBehavior()
- Returns:
behavior(A behavior associated with the action. Behaviors define how the action is to be presented and/or executed within the receiving environment.)
-
hasBehavior
public boolean hasBehavior()
-
addBehavior
public ActionDefinition.ActionDefinitionBehaviorComponent addBehavior()
- Returns:
behavior(A behavior associated with the action. Behaviors define how the action is to be presented and/or executed within the receiving environment.)
-
addBehavior
public ActionDefinition addBehavior(ActionDefinition.ActionDefinitionBehaviorComponent t)
-
getResource
public Reference getResource()
- Returns:
resource(The resource that is the target of the action (e.g. CommunicationRequest). The resource described here defines any aspects of the action that can be specified statically (i.e. are known at the time of definition).)
-
hasResource
public boolean hasResource()
-
setResource
public ActionDefinition setResource(Reference value)
- Parameters:
value-resource(The resource that is the target of the action (e.g. CommunicationRequest). The resource described here defines any aspects of the action that can be specified statically (i.e. are known at the time of definition).)
-
getResourceTarget
public Resource getResourceTarget()
- Returns:
resourceThe 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). The resource described here defines any aspects of the action that can be specified statically (i.e. are known at the time of definition).)
-
setResourceTarget
public ActionDefinition setResourceTarget(Resource value)
- Parameters:
value-resourceThe 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). The resource described here defines any aspects of the action that can be specified statically (i.e. are known at the time of definition).)
-
getCustomization
public List<ActionDefinition.ActionDefinitionCustomizationComponent> getCustomization()
- Returns:
customization(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.)
-
hasCustomization
public boolean hasCustomization()
-
addCustomization
public ActionDefinition.ActionDefinitionCustomizationComponent addCustomization()
- Returns:
customization(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.)
-
addCustomization
public ActionDefinition addCustomization(ActionDefinition.ActionDefinitionCustomizationComponent t)
-
getAction
public List<ActionDefinition> 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.)
-
hasAction
public boolean hasAction()
-
addAction
public ActionDefinition addAction()
- 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.)
-
addAction
public ActionDefinition addAction(ActionDefinition t)
-
listChildren
protected void listChildren(List<Property> childrenList)
- Overrides:
listChildrenin classElement
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public void setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
Description copied from class:Basemake an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property- Overrides:
makePropertyin classElement- Returns:
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
copy
public ActionDefinition copy()
-
typedCopy
protected ActionDefinition typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other)
- Overrides:
equalsDeepin classElement
-
equalsShallow
public boolean equalsShallow(Base other)
- Overrides:
equalsShallowin classElement
-
-