
Package org.hl7.fhir.r5.tools
Class CDSHooksResponse.CDSHooksResponseCardsSuggestionsComponent
java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.LogicalBase
org.hl7.fhir.r5.tools.CDSHooksElement
org.hl7.fhir.r5.tools.CDSHooksResponse.CDSHooksResponseCardsSuggestionsComponent
- 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.ICompositeType
- Enclosing class:
CDSHooksResponse
public static class CDSHooksResponse.CDSHooksResponseCardsSuggestionsComponent
extends CDSHooksElement
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base
Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason -
Field Summary
FieldsModifier and TypeFieldDescriptionDefines a suggested action.protected BooleanTypeWhen there are multiple suggestions, allows a service to indicate that a specific suggestion is recommended from all the available suggestions on the cardprotected StringTypeHuman-readable label to display for this suggestionprotected UuidTypeUnique identifier, used for auditing and logging suggestionsFields inherited from class org.hl7.fhir.r5.tools.CDSHooksElement
extension -
Constructor Summary
ConstructorsConstructorDescriptionConstructorConstructor -
Method Summary
Modifier and TypeMethodDescriptioncopy()voidbooleanequalsDeep(Base other_) booleanequalsShallow(Base other_) fhirType()booleangetLabel()getNamedProperty(int _hash, String _name, boolean _checkValid) Base[]getProperty(int hash, String name, boolean checkValid) String[]getTypesForProperty(int hash, String name) getUuid()booleanbooleanbooleanbooleanhasLabel()booleanbooleanhasUuid()booleanbooleanisEmpty()protected voidlistChildren(List<Property> children) makeProperty(int hash, String name) setIsRecommended(boolean value) setLabelElement(StringType value) setProperty(int hash, String name, Base value) setProperty(String name, Base value) setUuidElement(UuidType value) Methods inherited from class org.hl7.fhir.r5.tools.CDSHooksElement
copyValues, getExtension, hasExtension, setExtensionMethods inherited from class org.hl7.fhir.r5.model.LogicalBase
getFHIRPublicationVersion, getIdBase, setIdBaseMethods inherited from class org.hl7.fhir.r5.model.Base
addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, removeChild, setCopyUserData, setUserData, setUserDataINN, setXhtmlMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
-
Field Details
-
label
Human-readable label to display for this suggestion -
uuid
Unique identifier, used for auditing and logging suggestions -
isRecommended
When there are multiple suggestions, allows a service to indicate that a specific suggestion is recommended from all the available suggestions on the card -
actionsList
Defines a suggested action. Within a suggestion, all actions are logically AND'd together, such that a user selecting a suggestion selects all of the actions within it
-
-
Constructor Details
-
CDSHooksResponseCardsSuggestionsComponent
Constructor -
CDSHooksResponseCardsSuggestionsComponent
Constructor
-
-
Method Details
-
getLabelElement
- Returns:
label(Human-readable label to display for this suggestion). This is the underlying object with id, value and extensions. The accessor "getLabel" gives direct access to the value
-
hasLabelElement
-
hasLabel
-
setLabelElement
- Parameters:
value-label(Human-readable label to display for this suggestion). This is the underlying object with id, value and extensions. The accessor "getLabel" gives direct access to the value
-
getLabel
- Returns:
- Human-readable label to display for this suggestion
-
setLabel
- Parameters:
value- Human-readable label to display for this suggestion
-
getUuidElement
- Returns:
uuid(Unique identifier, used for auditing and logging suggestions). This is the underlying object with id, value and extensions. The accessor "getUuid" gives direct access to the value
-
hasUuidElement
-
hasUuid
-
setUuidElement
- Parameters:
value-uuid(Unique identifier, used for auditing and logging suggestions). This is the underlying object with id, value and extensions. The accessor "getUuid" gives direct access to the value
-
getUuid
- Returns:
- Unique identifier, used for auditing and logging suggestions
-
setUuid
- Parameters:
value- Unique identifier, used for auditing and logging suggestions
-
getIsRecommendedElement
- Returns:
isRecommended(When there are multiple suggestions, allows a service to indicate that a specific suggestion is recommended from all the available suggestions on the card). This is the underlying object with id, value and extensions. The accessor "getIsRecommended" gives direct access to the value
-
hasIsRecommendedElement
-
hasIsRecommended
-
setIsRecommendedElement
public CDSHooksResponse.CDSHooksResponseCardsSuggestionsComponent setIsRecommendedElement(BooleanType value) - Parameters:
value-isRecommended(When there are multiple suggestions, allows a service to indicate that a specific suggestion is recommended from all the available suggestions on the card). This is the underlying object with id, value and extensions. The accessor "getIsRecommended" gives direct access to the value
-
getIsRecommended
- Returns:
- When there are multiple suggestions, allows a service to indicate that a specific suggestion is recommended from all the available suggestions on the card
-
setIsRecommended
- Parameters:
value- When there are multiple suggestions, allows a service to indicate that a specific suggestion is recommended from all the available suggestions on the card
-
getActionsList
- Returns:
-
(Defines a suggested action. Within a suggestion, all actions are logically AND'd together, such that a user selecting a suggestion selects all of the actions within it)
invalid reference
#actions
-
setActionsList
public CDSHooksResponse.CDSHooksResponseCardsSuggestionsComponent setActionsList(List<CDSHooksResponse.CDSHooksResponseCardsSuggestionsActionsComponent> theActions) - Returns:
- Returns a reference to
thisfor easy method chaining
-
hasActions
-
addActions
-
addActions
-
getActionsFirstRep
- Returns:
- The first repetition of repeating field
, creating it if it does not already exist {3}
invalid reference
#actions
-
listChildren
- Overrides:
listChildrenin classCDSHooksElement
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedPropertyin classCDSHooksElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getPropertyin classCDSHooksElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setPropertyin classCDSHooksElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setPropertyin classCDSHooksElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makePropertyin classCDSHooksElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForPropertyin classCDSHooksElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChildin classCDSHooksElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
copy
- Specified by:
copyin classCDSHooksElement
-
copyValues
-
equalsDeep
- Overrides:
equalsDeepin classCDSHooksElement
-
equalsShallow
- Overrides:
equalsShallowin classCDSHooksElement
-
isEmpty
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classCDSHooksElement
-
fhirType
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classCDSHooksElement- Returns:
- the FHIR type name of the instance (not the java class name)
-