public class ActionDefinition extends Type implements org.hl7.fhir.instance.model.api.ICompositeType
| Modifier and Type | Class and Description |
|---|---|
static class |
ActionDefinition.ActionDefinitionBehaviorComponent |
static class |
ActionDefinition.ActionDefinitionCustomizationComponent |
static class |
ActionDefinition.ActionDefinitionRelatedActionComponent |
static class |
ActionDefinition.ActionRelationshipAnchor |
static class |
ActionDefinition.ActionRelationshipAnchorEnumFactory |
static class |
ActionDefinition.ActionRelationshipType |
static class |
ActionDefinition.ActionRelationshipTypeEnumFactory |
static class |
ActionDefinition.ActionType |
static class |
ActionDefinition.ActionTypeEnumFactory |
static class |
ActionDefinition.ParticipantType |
static class |
ActionDefinition.ParticipantTypeEnumFactory |
| Modifier and Type | Field and Description |
|---|---|
protected List<ActionDefinition> |
action
Sub actions that are contained within the action.
|
protected Identifier |
actionIdentifier
A unique identifier for the action.
|
protected List<ActionDefinition.ActionDefinitionBehaviorComponent> |
behavior
A behavior associated with the action.
|
protected List<CodeableConcept> |
concept
The concept represented by this action or its sub-actions.
|
protected List<ActionDefinition.ActionDefinitionCustomizationComponent> |
customization
Customizations that should be applied to the statically defined resource.
|
protected StringType |
description
A short description of the action used to provide a summary to display to the user.
|
protected List<Attachment> |
documentation
Didactic or other informational resources associated with the action that can be provided to the CDS recipient.
|
protected StringType |
label
A user-visible label for the action.
|
protected List<Enumeration<ActionDefinition.ParticipantType>> |
participantType
The type of participant in the action.
|
protected ActionDefinition.ActionDefinitionRelatedActionComponent |
relatedAction
A relationship to another action such as "before" or "30-60 minutes after start of".
|
protected Reference |
resource
The resource that is the target of the action (e.g.
|
protected Resource |
resourceTarget
The actual object that is the target of the reference (The resource that is the target of the action (e.g.
|
protected List<Attachment> |
supportingEvidence
The evidence grade and the sources of evidence for this action.
|
protected StringType |
textEquivalent
A text equivalent of the action to be performed.
|
protected StringType |
title
The title of the action displayed to a user.
|
protected Enumeration<ActionDefinition.ActionType> |
type
The type of action to perform (create, update, remove).
|
| Constructor and Description |
|---|
ActionDefinition()
Constructor
|
addExtension, addExtension, copyValues, getExtension, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setId, setIdElementcastToActionDefinition, 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, setUserDataINNprotected Identifier actionIdentifier
protected StringType label
protected StringType title
protected StringType description
protected StringType textEquivalent
protected List<CodeableConcept> concept
protected List<Attachment> supportingEvidence
protected List<Attachment> documentation
protected ActionDefinition.ActionDefinitionRelatedActionComponent relatedAction
protected List<Enumeration<ActionDefinition.ParticipantType>> participantType
protected Enumeration<ActionDefinition.ActionType> type
protected List<ActionDefinition.ActionDefinitionBehaviorComponent> behavior
protected Reference resource
protected Resource resourceTarget
protected List<ActionDefinition.ActionDefinitionCustomizationComponent> customization
protected List<ActionDefinition> action
public ActionDefinition()
public Identifier getActionIdentifier()
actionIdentifier (A unique identifier for the action. The identifier SHALL be unique within the container in which it appears, and MAY be universally unique.)public boolean hasActionIdentifier()
public ActionDefinition setActionIdentifier(Identifier value)
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.)public StringType getLabelElement()
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 valuepublic boolean hasLabelElement()
public boolean hasLabel()
public ActionDefinition setLabelElement(StringType value)
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 valuepublic ActionDefinition setLabel(String value)
value - A user-visible label for the action.public StringType getTitleElement()
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 valuepublic boolean hasTitleElement()
public boolean hasTitle()
public ActionDefinition setTitleElement(StringType value)
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 valuepublic ActionDefinition setTitle(String value)
value - The title of the action displayed to a user.public StringType getDescriptionElement()
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 valuepublic boolean hasDescriptionElement()
public boolean hasDescription()
public ActionDefinition setDescriptionElement(StringType value)
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 valuepublic String getDescription()
public ActionDefinition setDescription(String value)
value - A short description of the action used to provide a summary to display to the user.public StringType getTextEquivalentElement()
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 valuepublic boolean hasTextEquivalentElement()
public boolean hasTextEquivalent()
public ActionDefinition setTextEquivalentElement(StringType value)
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 valuepublic String getTextEquivalent()
public ActionDefinition setTextEquivalent(String value)
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.public List<CodeableConcept> getConcept()
concept (The concept represented by this action or its sub-actions.)public boolean hasConcept()
public CodeableConcept addConcept()
concept (The concept represented by this action or its sub-actions.)public ActionDefinition addConcept(CodeableConcept t)
public List<Attachment> getSupportingEvidence()
supportingEvidence (The evidence grade and the sources of evidence for this action.)public boolean hasSupportingEvidence()
public Attachment addSupportingEvidence()
supportingEvidence (The evidence grade and the sources of evidence for this action.)public ActionDefinition addSupportingEvidence(Attachment t)
public List<Attachment> getDocumentation()
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.)public boolean hasDocumentation()
public Attachment addDocumentation()
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.)public ActionDefinition addDocumentation(Attachment t)
public ActionDefinition.ActionDefinitionRelatedActionComponent getRelatedAction()
relatedAction (A relationship to another action such as "before" or "30-60 minutes after start of".)public boolean hasRelatedAction()
public ActionDefinition setRelatedAction(ActionDefinition.ActionDefinitionRelatedActionComponent value)
value - relatedAction (A relationship to another action such as "before" or "30-60 minutes after start of".)public List<Enumeration<ActionDefinition.ParticipantType>> getParticipantType()
participantType (The type of participant in the action.)public boolean hasParticipantType()
public Enumeration<ActionDefinition.ParticipantType> addParticipantTypeElement()
participantType (The type of participant in the action.)public ActionDefinition addParticipantType(ActionDefinition.ParticipantType value)
value - participantType (The type of participant in the action.)public boolean hasParticipantType(ActionDefinition.ParticipantType value)
value - participantType (The type of participant in the action.)public Enumeration<ActionDefinition.ActionType> getTypeElement()
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 valuepublic boolean hasTypeElement()
public boolean hasType()
public ActionDefinition setTypeElement(Enumeration<ActionDefinition.ActionType> value)
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 valuepublic ActionDefinition.ActionType getType()
public ActionDefinition setType(ActionDefinition.ActionType value)
value - The type of action to perform (create, update, remove).public List<ActionDefinition.ActionDefinitionBehaviorComponent> getBehavior()
behavior (A behavior associated with the action. Behaviors define how the action is to be presented and/or executed within the receiving environment.)public boolean hasBehavior()
public ActionDefinition.ActionDefinitionBehaviorComponent addBehavior()
behavior (A behavior associated with the action. Behaviors define how the action is to be presented and/or executed within the receiving environment.)public ActionDefinition addBehavior(ActionDefinition.ActionDefinitionBehaviorComponent t)
public Reference getResource()
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).)public boolean hasResource()
public ActionDefinition setResource(Reference value)
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).)public Resource getResourceTarget()
resource The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The resource that is the target of the action (e.g. CommunicationRequest). The resource described here defines any aspects of the action that can be specified statically (i.e. are known at the time of definition).)public ActionDefinition setResourceTarget(Resource value)
value - resource The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The resource that is the target of the action (e.g. CommunicationRequest). The resource described here defines any aspects of the action that can be specified statically (i.e. are known at the time of definition).)public List<ActionDefinition.ActionDefinitionCustomizationComponent> getCustomization()
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.)public boolean hasCustomization()
public ActionDefinition.ActionDefinitionCustomizationComponent addCustomization()
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.)public ActionDefinition addCustomization(ActionDefinition.ActionDefinitionCustomizationComponent t)
public List<ActionDefinition> getAction()
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.)public boolean hasAction()
public ActionDefinition addAction()
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.)public ActionDefinition addAction(ActionDefinition t)
protected void listChildren(List<Property> childrenList)
listChildren in class Elementpublic Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
getProperty in class Elementorg.hl7.fhir.exceptions.FHIRExceptionpublic void setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class Elementorg.hl7.fhir.exceptions.FHIRExceptionpublic void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class Elementorg.hl7.fhir.exceptions.FHIRExceptionpublic Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
makeProperty in class Elementorg.hl7.fhir.exceptions.FHIRExceptionpublic ActionDefinition copy()
protected ActionDefinition typedCopy()
public boolean equalsDeep(Base other)
equalsDeep in class Elementpublic boolean equalsShallow(Base other)
equalsShallow in class ElementCopyright © 2014–2018 University Health Network. All rights reserved.