Package org.hl7.fhir.dstu2016may.model
Class GuidanceResponse.GuidanceResponseActionComponent
- java.lang.Object
-
- org.hl7.fhir.dstu2016may.model.Base
-
- org.hl7.fhir.dstu2016may.model.Element
-
- org.hl7.fhir.dstu2016may.model.BackboneElement
-
- org.hl7.fhir.dstu2016may.model.GuidanceResponse.GuidanceResponseActionComponent
-
- 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:
- GuidanceResponse
public static class GuidanceResponse.GuidanceResponseActionComponent extends BackboneElement implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected List<GuidanceResponse.GuidanceResponseActionComponent>actionSub actions.protected IdentifieractionIdentifierA unique identifier for the action.protected List<GuidanceResponse.GuidanceResponseActionBehaviorComponent>behaviorA behavior associated with the action.protected List<CodeableConcept>conceptThe concept represented by this action or its sub-actions.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<Reference>participantThe participant in the action.protected List<Resource>participantTargetThe actual objects that are the target of the reference (The participant in the action.)protected GuidanceResponse.GuidanceResponseActionRelatedActionComponentrelatedActionA 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 CodeTypetypeThe type of action to perform (create, update, remove).-
Fields inherited from class org.hl7.fhir.dstu2016may.model.BackboneElement
modifierExtension
-
-
Constructor Summary
Constructors Constructor Description GuidanceResponseActionComponent()Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu2016may.model.BackboneElement
addModifierExtension, addModifierExtension, copyValues, getModifierExtension, hasModifierExtension
-
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
-
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
-
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.
-
relatedAction
protected GuidanceResponse.GuidanceResponseActionRelatedActionComponent relatedAction
A relationship to another action such as "before" or "30-60 minutes after start of".
-
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.
-
participant
protected List<Reference> participant
The participant in the action.
-
participantTarget
protected List<Resource> participantTarget
The actual objects that are the target of the reference (The participant in the action.)
-
behavior
protected List<GuidanceResponse.GuidanceResponseActionBehaviorComponent> 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).
-
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).)
-
action
protected List<GuidanceResponse.GuidanceResponseActionComponent> action
Sub actions.
-
-
Constructor Detail
-
GuidanceResponseActionComponent
public GuidanceResponseActionComponent()
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 GuidanceResponse.GuidanceResponseActionComponent 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 GuidanceResponse.GuidanceResponseActionComponent 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 GuidanceResponse.GuidanceResponseActionComponent 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 GuidanceResponse.GuidanceResponseActionComponent 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 GuidanceResponse.GuidanceResponseActionComponent 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 GuidanceResponse.GuidanceResponseActionComponent 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 GuidanceResponse.GuidanceResponseActionComponent 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 GuidanceResponse.GuidanceResponseActionComponent 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 GuidanceResponse.GuidanceResponseActionComponent 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 GuidanceResponse.GuidanceResponseActionComponent 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 GuidanceResponse.GuidanceResponseActionComponent addSupportingEvidence(Attachment t)
-
getRelatedAction
public GuidanceResponse.GuidanceResponseActionRelatedActionComponent getRelatedAction()
- Returns:
relatedAction(A relationship to another action such as "before" or "30-60 minutes after start of".)
-
hasRelatedAction
public boolean hasRelatedAction()
-
setRelatedAction
public GuidanceResponse.GuidanceResponseActionComponent setRelatedAction(GuidanceResponse.GuidanceResponseActionRelatedActionComponent value)
- Parameters:
value-relatedAction(A relationship to another action such as "before" or "30-60 minutes after start of".)
-
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 GuidanceResponse.GuidanceResponseActionComponent addDocumentation(Attachment t)
-
getParticipant
public List<Reference> getParticipant()
- Returns:
participant(The participant in the action.)
-
hasParticipant
public boolean hasParticipant()
-
addParticipant
public Reference addParticipant()
- Returns:
participant(The participant in the action.)
-
addParticipant
public GuidanceResponse.GuidanceResponseActionComponent addParticipant(Reference t)
-
getParticipantTarget
public List<Resource> getParticipantTarget()
- Returns:
participant(The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. The participant in the action.)
-
getTypeElement
public CodeType 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 GuidanceResponse.GuidanceResponseActionComponent setTypeElement(CodeType 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
-
setType
public GuidanceResponse.GuidanceResponseActionComponent setType(String value)
- Parameters:
value- The type of action to perform (create, update, remove).
-
getBehavior
public List<GuidanceResponse.GuidanceResponseActionBehaviorComponent> 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 GuidanceResponse.GuidanceResponseActionBehaviorComponent 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 GuidanceResponse.GuidanceResponseActionComponent addBehavior(GuidanceResponse.GuidanceResponseActionBehaviorComponent t)
-
getResource
public Reference getResource()
- Returns:
resource(The resource that is the target of the action (e.g. CommunicationRequest).)
-
hasResource
public boolean hasResource()
-
setResource
public GuidanceResponse.GuidanceResponseActionComponent setResource(Reference value)
- Parameters:
value-resource(The resource that is the target of the action (e.g. CommunicationRequest).)
-
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).)
-
setResourceTarget
public GuidanceResponse.GuidanceResponseActionComponent 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).)
-
getAction
public List<GuidanceResponse.GuidanceResponseActionComponent> getAction()
- Returns:
action(Sub actions.)
-
hasAction
public boolean hasAction()
-
addAction
public GuidanceResponse.GuidanceResponseActionComponent addAction()
- Returns:
action(Sub actions.)
-
addAction
public GuidanceResponse.GuidanceResponseActionComponent addAction(GuidanceResponse.GuidanceResponseActionComponent t)
-
listChildren
protected void listChildren(List<Property> childrenList)
- Overrides:
listChildrenin classBackboneElement
-
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 void setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public void 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
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 classBackboneElement- Returns:
- 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 GuidanceResponse.GuidanceResponseActionComponent copy()
- Specified by:
copyin classBackboneElement
-
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
-
-