Package org.hl7.fhir.r5.tools

Class CDSHooksResponse.CDSHooksResponseCardsComponent

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.CDSHooksResponseCardsComponent

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.CDSHooksResponseCardsComponent
extends CDSHooksElement

See Also:

• Serialized Form

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

Fields

Modifier and Type	Field	Description
protected MarkdownType	detail	Optional detailed information to display; if provided MUST be represented in (GitHub Flavored) Markdown.
protected Enumeration<CDSHooksResponse.CDSIndicatorCodesVS>	indicator	Urgency/importance of what this card conveys.
protected List<CDSHooksResponse.CDSHooksResponseCardsLinksComponent>	links	Allows a service to suggest a link to an app that the user might want to run for additional information or to help guide a decision.
protected List<Coding>	overrideReasons	Override reasons can be selected by the end user when overriding a card without taking the suggested recommendations.
protected Enumeration<CDSHooksResponse.CDSSelectionBehaviorCodesVS>	selectionBehavior	Describes the intended selection behavior of the suggestions in the card.
protected CDSHooksResponse.CDSHooksResponseCardsSourceComponent	source	The source should be the primary source of guidance for the decision support the card represents.
protected List<CDSHooksResponse.CDSHooksResponseCardsSuggestionsComponent>	suggestions	Allows a service to suggest a set of changes in the context of the current activity (e.g.
protected StringType	summary	One-sentence, invalid input: '<'140-character summary message for display to the user inside of this card.
protected UuidType	uuid	Unique identifier of the card.

Fields inherited from class org.hl7.fhir.r5.tools.CDSHooksElement

extension

Constructor Summary

Constructors

Constructor	Description
CDSHooksResponseCardsComponent()	Constructor
CDSHooksResponseCardsComponent(String summary, CDSHooksResponse.CDSHooksResponseCardsSourceComponent source)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
CDSHooksResponse.CDSHooksResponseCardsLinksComponent	addLinks()
CDSHooksResponse.CDSHooksResponseCardsComponent	addLinks(CDSHooksResponse.CDSHooksResponseCardsLinksComponent t)
Coding	addOverrideReasons()
CDSHooksResponse.CDSHooksResponseCardsComponent	addOverrideReasons(Coding t)
CDSHooksResponse.CDSHooksResponseCardsSuggestionsComponent	addSuggestions()
CDSHooksResponse.CDSHooksResponseCardsComponent	addSuggestions(CDSHooksResponse.CDSHooksResponseCardsSuggestionsComponent t)
CDSHooksResponse.CDSHooksResponseCardsComponent	copy()
void	copyValues(CDSHooksResponse.CDSHooksResponseCardsComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
String	getDetail()
MarkdownType	getDetailElement()
CDSHooksResponse.CDSIndicatorCodesVS	getIndicator()
Enumeration<CDSHooksResponse.CDSIndicatorCodesVS>	getIndicatorElement()
List<CDSHooksResponse.CDSHooksResponseCardsLinksComponent>	getLinks()
CDSHooksResponse.CDSHooksResponseCardsLinksComponent	getLinksFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Coding>	getOverrideReasons()
Coding	getOverrideReasonsFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
CDSHooksResponse.CDSSelectionBehaviorCodesVS	getSelectionBehavior()
Enumeration<CDSHooksResponse.CDSSelectionBehaviorCodesVS>	getSelectionBehaviorElement()
CDSHooksResponse.CDSHooksResponseCardsSourceComponent	getSource()
List<CDSHooksResponse.CDSHooksResponseCardsSuggestionsComponent>	getSuggestions()
CDSHooksResponse.CDSHooksResponseCardsSuggestionsComponent	getSuggestionsFirstRep()
String	getSummary()
StringType	getSummaryElement()
String[]	getTypesForProperty(int hash, String name)
String	getUuid()
UuidType	getUuidElement()
boolean	hasDetail()
boolean	hasDetailElement()
boolean	hasIndicator()
boolean	hasIndicatorElement()
boolean	hasLinks()
boolean	hasOverrideReasons()
boolean	hasSelectionBehavior()
boolean	hasSelectionBehaviorElement()
boolean	hasSource()
boolean	hasSuggestions()
boolean	hasSummary()
boolean	hasSummaryElement()
boolean	hasUuid()
boolean	hasUuidElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
CDSHooksResponse.CDSHooksResponseCardsComponent	setDetail(String value)
CDSHooksResponse.CDSHooksResponseCardsComponent	setDetailElement(MarkdownType value)
CDSHooksResponse.CDSHooksResponseCardsComponent	setIndicator(CDSHooksResponse.CDSIndicatorCodesVS value)
CDSHooksResponse.CDSHooksResponseCardsComponent	setIndicatorElement(Enumeration<CDSHooksResponse.CDSIndicatorCodesVS> value)
CDSHooksResponse.CDSHooksResponseCardsComponent	setLinks(List<CDSHooksResponse.CDSHooksResponseCardsLinksComponent> theLinks)
CDSHooksResponse.CDSHooksResponseCardsComponent	setOverrideReasons(List<Coding> theOverrideReasons)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
CDSHooksResponse.CDSHooksResponseCardsComponent	setSelectionBehavior(CDSHooksResponse.CDSSelectionBehaviorCodesVS value)
CDSHooksResponse.CDSHooksResponseCardsComponent	setSelectionBehaviorElement(Enumeration<CDSHooksResponse.CDSSelectionBehaviorCodesVS> value)
CDSHooksResponse.CDSHooksResponseCardsComponent	setSource(CDSHooksResponse.CDSHooksResponseCardsSourceComponent value)
CDSHooksResponse.CDSHooksResponseCardsComponent	setSuggestions(List<CDSHooksResponse.CDSHooksResponseCardsSuggestionsComponent> theSuggestions)
CDSHooksResponse.CDSHooksResponseCardsComponent	setSummary(String value)
CDSHooksResponse.CDSHooksResponseCardsComponent	setSummaryElement(StringType value)
CDSHooksResponse.CDSHooksResponseCardsComponent	setUuid(String value)
CDSHooksResponse.CDSHooksResponseCardsComponent	setUuidElement(UuidType value)

Methods inherited from class org.hl7.fhir.r5.tools.CDSHooksElement

copyValues, getExtension, hasExtension, setExtension

Methods inherited from class org.hl7.fhir.r5.model.LogicalBase

getFHIRPublicationVersion, getIdBase, setIdBase

Methods 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

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

Field Details

uuid

protected UuidType uuid

Unique identifier of the card. MAY be used for auditing and logging cards and SHALL be included in any subsequent calls to the CDS service's feedback endpoint.

summary

protected StringType summary

One-sentence, invalid input: '<'140-character summary message for display to the user inside of this card.

detail

protected MarkdownType detail

Optional detailed information to display; if provided MUST be represented in (GitHub Flavored) Markdown. (For non-urgent cards, the CDS Client MAY hide these details until the user clicks a link like 'view more details...').

indicator

protected Enumeration<CDSHooksResponse.CDSIndicatorCodesVS> indicator

Urgency/importance of what this card conveys. Allowed values, in order of increasing urgency, are: info, warning, critical.

source

protected CDSHooksResponse.CDSHooksResponseCardsSourceComponent source

The source should be the primary source of guidance for the decision support the card represents.

suggestions

protected List<CDSHooksResponse.CDSHooksResponseCardsSuggestionsComponent> suggestions

Allows a service to suggest a set of changes in the context of the current activity (e.g. changing the dose of a medication currently being prescribed, for the order-sign activity).

selectionBehavior

protected Enumeration<CDSHooksResponse.CDSSelectionBehaviorCodesVS> selectionBehavior

Describes the intended selection behavior of the suggestions in the card. Allowed values are: at-most-one, indicating that the user may choose none or at most one of the suggestions; any, indicating that the end user may choose any number of suggestions including none of them and all of them

overrideReasons

protected List<Coding> overrideReasons

Override reasons can be selected by the end user when overriding a card without taking the suggested recommendations. The CDS service MAY return a list of override reasons to the CDS client.

links

protected List<CDSHooksResponse.CDSHooksResponseCardsLinksComponent> links

Allows a service to suggest a link to an app that the user might want to run for additional information or to help guide a decision.

Constructor Details

CDSHooksResponseCardsComponent

public CDSHooksResponseCardsComponent()

Constructor

CDSHooksResponseCardsComponent

public CDSHooksResponseCardsComponent(String summary,
 CDSHooksResponse.CDSHooksResponseCardsSourceComponent source)

Constructor

Method Details

getUuidElement

public UuidType getUuidElement()

Returns:

uuid (Unique identifier of the card. MAY be used for auditing and logging cards and SHALL be included in any subsequent calls to the CDS service's feedback endpoint.). This is the underlying object with id, value and extensions. The accessor "getUuid" gives direct access to the value

hasUuidElement

public boolean hasUuidElement()

hasUuid

public boolean hasUuid()

setUuidElement

public CDSHooksResponse.CDSHooksResponseCardsComponent setUuidElement(UuidType value)

Parameters:

value - uuid (Unique identifier of the card. MAY be used for auditing and logging cards and SHALL be included in any subsequent calls to the CDS service's feedback endpoint.). This is the underlying object with id, value and extensions. The accessor "getUuid" gives direct access to the value

getUuid

public String getUuid()

Returns:

Unique identifier of the card. MAY be used for auditing and logging cards and SHALL be included in any subsequent calls to the CDS service's feedback endpoint.

setUuid

public CDSHooksResponse.CDSHooksResponseCardsComponent setUuid(String value)

Parameters:

value - Unique identifier of the card. MAY be used for auditing and logging cards and SHALL be included in any subsequent calls to the CDS service's feedback endpoint.

getSummaryElement

public StringType getSummaryElement()

Returns:

summary (One-sentence, invalid input: '<'140-character summary message for display to the user inside of this card.). This is the underlying object with id, value and extensions. The accessor "getSummary" gives direct access to the value

hasSummaryElement

public boolean hasSummaryElement()

hasSummary

public boolean hasSummary()

setSummaryElement

public CDSHooksResponse.CDSHooksResponseCardsComponent setSummaryElement(StringType value)

Parameters:

value - summary (One-sentence, invalid input: '<'140-character summary message for display to the user inside of this card.). This is the underlying object with id, value and extensions. The accessor "getSummary" gives direct access to the value

getSummary

public String getSummary()

Returns:

One-sentence, invalid input: '<'140-character summary message for display to the user inside of this card.

setSummary

public CDSHooksResponse.CDSHooksResponseCardsComponent setSummary(String value)

Parameters:

value - One-sentence, invalid input: '<'140-character summary message for display to the user inside of this card.

getDetailElement

public MarkdownType getDetailElement()

Returns:

detail (Optional detailed information to display; if provided MUST be represented in (GitHub Flavored) Markdown. (For non-urgent cards, the CDS Client MAY hide these details until the user clicks a link like 'view more details...').). This is the underlying object with id, value and extensions. The accessor "getDetail" gives direct access to the value

hasDetailElement

public boolean hasDetailElement()

hasDetail

public boolean hasDetail()

setDetailElement

public CDSHooksResponse.CDSHooksResponseCardsComponent setDetailElement(MarkdownType value)

Parameters:

value - detail (Optional detailed information to display; if provided MUST be represented in (GitHub Flavored) Markdown. (For non-urgent cards, the CDS Client MAY hide these details until the user clicks a link like 'view more details...').). This is the underlying object with id, value and extensions. The accessor "getDetail" gives direct access to the value

getDetail

public String getDetail()

Returns:

Optional detailed information to display; if provided MUST be represented in (GitHub Flavored) Markdown. (For non-urgent cards, the CDS Client MAY hide these details until the user clicks a link like 'view more details...').

setDetail

public CDSHooksResponse.CDSHooksResponseCardsComponent setDetail(String value)

Parameters:

value - Optional detailed information to display; if provided MUST be represented in (GitHub Flavored) Markdown. (For non-urgent cards, the CDS Client MAY hide these details until the user clicks a link like 'view more details...').

getIndicatorElement

public Enumeration<CDSHooksResponse.CDSIndicatorCodesVS> getIndicatorElement()

Returns:

indicator (Urgency/importance of what this card conveys. Allowed values, in order of increasing urgency, are: info, warning, critical.). This is the underlying object with id, value and extensions. The accessor "getIndicator" gives direct access to the value

hasIndicatorElement

public boolean hasIndicatorElement()

hasIndicator

public boolean hasIndicator()

setIndicatorElement

public CDSHooksResponse.CDSHooksResponseCardsComponent setIndicatorElement(Enumeration<CDSHooksResponse.CDSIndicatorCodesVS> value)

Parameters:

value - indicator (Urgency/importance of what this card conveys. Allowed values, in order of increasing urgency, are: info, warning, critical.). This is the underlying object with id, value and extensions. The accessor "getIndicator" gives direct access to the value

getIndicator

public CDSHooksResponse.CDSIndicatorCodesVS getIndicator()

Returns:

Urgency/importance of what this card conveys. Allowed values, in order of increasing urgency, are: info, warning, critical.

setIndicator

public CDSHooksResponse.CDSHooksResponseCardsComponent setIndicator(CDSHooksResponse.CDSIndicatorCodesVS value)

Parameters:

value - Urgency/importance of what this card conveys. Allowed values, in order of increasing urgency, are: info, warning, critical.

getSource

public CDSHooksResponse.CDSHooksResponseCardsSourceComponent getSource()

Returns:

source (The source should be the primary source of guidance for the decision support the card represents.)

hasSource

public boolean hasSource()

setSource

public CDSHooksResponse.CDSHooksResponseCardsComponent setSource(CDSHooksResponse.CDSHooksResponseCardsSourceComponent value)

Parameters:

value - source (The source should be the primary source of guidance for the decision support the card represents.)

getSuggestions

public List<CDSHooksResponse.CDSHooksResponseCardsSuggestionsComponent> getSuggestions()

Returns:

suggestions (Allows a service to suggest a set of changes in the context of the current activity (e.g. changing the dose of a medication currently being prescribed, for the order-sign activity).)

setSuggestions

public CDSHooksResponse.CDSHooksResponseCardsComponent setSuggestions(List<CDSHooksResponse.CDSHooksResponseCardsSuggestionsComponent> theSuggestions)

Returns:

Returns a reference to this for easy method chaining

hasSuggestions

public boolean hasSuggestions()

addSuggestions

public CDSHooksResponse.CDSHooksResponseCardsSuggestionsComponent addSuggestions()

addSuggestions

public CDSHooksResponse.CDSHooksResponseCardsComponent addSuggestions(CDSHooksResponse.CDSHooksResponseCardsSuggestionsComponent t)

getSuggestionsFirstRep

public CDSHooksResponse.CDSHooksResponseCardsSuggestionsComponent getSuggestionsFirstRep()

Returns:

The first repetition of repeating field suggestions, creating it if it does not already exist {3}

getSelectionBehaviorElement

public Enumeration<CDSHooksResponse.CDSSelectionBehaviorCodesVS> getSelectionBehaviorElement()

Returns:

selectionBehavior (Describes the intended selection behavior of the suggestions in the card. Allowed values are: at-most-one, indicating that the user may choose none or at most one of the suggestions; any, indicating that the end user may choose any number of suggestions including none of them and all of them). This is the underlying object with id, value and extensions. The accessor "getSelectionBehavior" gives direct access to the value

hasSelectionBehaviorElement

public boolean hasSelectionBehaviorElement()

hasSelectionBehavior

public boolean hasSelectionBehavior()

setSelectionBehaviorElement

public CDSHooksResponse.CDSHooksResponseCardsComponent setSelectionBehaviorElement(Enumeration<CDSHooksResponse.CDSSelectionBehaviorCodesVS> value)

Parameters:

value - selectionBehavior (Describes the intended selection behavior of the suggestions in the card. Allowed values are: at-most-one, indicating that the user may choose none or at most one of the suggestions; any, indicating that the end user may choose any number of suggestions including none of them and all of them). This is the underlying object with id, value and extensions. The accessor "getSelectionBehavior" gives direct access to the value

getSelectionBehavior

public CDSHooksResponse.CDSSelectionBehaviorCodesVS getSelectionBehavior()

Returns:

Describes the intended selection behavior of the suggestions in the card. Allowed values are: at-most-one, indicating that the user may choose none or at most one of the suggestions; any, indicating that the end user may choose any number of suggestions including none of them and all of them

setSelectionBehavior

public CDSHooksResponse.CDSHooksResponseCardsComponent setSelectionBehavior(CDSHooksResponse.CDSSelectionBehaviorCodesVS value)

Parameters:

value - Describes the intended selection behavior of the suggestions in the card. Allowed values are: at-most-one, indicating that the user may choose none or at most one of the suggestions; any, indicating that the end user may choose any number of suggestions including none of them and all of them

getOverrideReasons

public List<Coding> getOverrideReasons()

Returns:

overrideReasons (Override reasons can be selected by the end user when overriding a card without taking the suggested recommendations. The CDS service MAY return a list of override reasons to the CDS client.)

setOverrideReasons

public CDSHooksResponse.CDSHooksResponseCardsComponent setOverrideReasons(List<Coding> theOverrideReasons)

Returns:

Returns a reference to this for easy method chaining

hasOverrideReasons

public boolean hasOverrideReasons()

addOverrideReasons

public Coding addOverrideReasons()

addOverrideReasons

public CDSHooksResponse.CDSHooksResponseCardsComponent addOverrideReasons(Coding t)

getOverrideReasonsFirstRep

public Coding getOverrideReasonsFirstRep()

Returns:

The first repetition of repeating field overrideReasons, creating it if it does not already exist {3}

getLinks

public List<CDSHooksResponse.CDSHooksResponseCardsLinksComponent> getLinks()

Returns:

links (Allows a service to suggest a link to an app that the user might want to run for additional information or to help guide a decision.)

setLinks

public CDSHooksResponse.CDSHooksResponseCardsComponent setLinks(List<CDSHooksResponse.CDSHooksResponseCardsLinksComponent> theLinks)

Returns:

Returns a reference to this for easy method chaining

hasLinks

public boolean hasLinks()

addLinks

public CDSHooksResponse.CDSHooksResponseCardsLinksComponent addLinks()

addLinks

public CDSHooksResponse.CDSHooksResponseCardsComponent addLinks(CDSHooksResponse.CDSHooksResponseCardsLinksComponent t)

getLinksFirstRep

public CDSHooksResponse.CDSHooksResponseCardsLinksComponent getLinksFirstRep()

Returns:

The first repetition of repeating field links, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class CDSHooksElement

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class CDSHooksElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class CDSHooksElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class CDSHooksElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class CDSHooksElement

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class CDSHooksElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class CDSHooksElement

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class CDSHooksElement

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public CDSHooksResponse.CDSHooksResponseCardsComponent copy()

Specified by:

copy in class CDSHooksElement

copyValues

public void copyValues(CDSHooksResponse.CDSHooksResponseCardsComponent dst)

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class CDSHooksElement

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class CDSHooksElement

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class CDSHooksElement

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class CDSHooksElement

Returns:

the FHIR type name of the instance (not the java class name)