Package org.linuxforhealth.fhir.model.resource

Class PlanDefinition.Action

  • All Implemented Interfaces:
    Visitable
    Enclosing class:
    PlanDefinition
    public static class PlanDefinition.Action
extends BackboneElement
    An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification.

    • Method Detail

      • getPrefix

        public String getPrefix()
        A user-visible prefix for the action.
        Returns:
        An immutable object of type String that may be null.

      • getTitle

        public String getTitle()
        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.
        Returns:
        An immutable object of type String that may be null.

      • getDescription

        public String getDescription()
        A brief description of the action used to provide a summary to display to the user.
        Returns:
        An immutable object of type String that may be null.

      • getTextEquivalent

        public String getTextEquivalent()
        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.
        Returns:
        An immutable object of type String that may be null.

      • getPriority

        public RequestPriority getPriority()
        Indicates how quickly the action should be addressed with respect to other actions.
        Returns:
        An immutable object of type RequestPriority that may be null.

      • getCode

        public java.util.List<CodeableConcept> getCode()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getReason

        public java.util.List<CodeableConcept> getReason()
        A description of why this action is necessary or appropriate.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getDocumentation

        public java.util.List<RelatedArtifact> getDocumentation()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type RelatedArtifact that may be empty.

      • getGoalId

        public java.util.List<Id> getGoalId()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type Id that may be empty.

      • getSubject

        public Element getSubject()
        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.
        Returns:
        An immutable object of type CodeableConcept, Reference or Canonical that may be null.

      • getTrigger

        public java.util.List<TriggerDefinition> getTrigger()
        A description of when the action should be triggered.
        Returns:
        An unmodifiable list containing immutable objects of type TriggerDefinition that may be empty.

      • getInput

        public java.util.List<DataRequirement> getInput()
        Defines input data requirements for the action.
        Returns:
        An unmodifiable list containing immutable objects of type DataRequirement that may be empty.

      • getOutput

        public java.util.List<DataRequirement> getOutput()
        Defines the outputs of the action, if any.
        Returns:
        An unmodifiable list containing immutable objects of type DataRequirement that may be empty.

      • getType

        public CodeableConcept getType()
        The type of action to perform (create, update, remove).
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getDefinition

        public Element getDefinition()
        A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.
        Returns:
        An immutable object of type Canonical or Uri that may be null.

      • getTransform

        public Canonical getTransform()
        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.
        Returns:
        An immutable object of type Canonical that may be null.

      • getDynamicValue

        public java.util.List<PlanDefinition.Action.DynamicValue> getDynamicValue()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type PlanDefinition.Action.DynamicValue that may be empty.

      • getAction

        public java.util.List<PlanDefinition.Action> getAction()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type PlanDefinition.Action that may be empty.

      • accept

        public void accept​(java.lang.String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object