Package org.hl7.fhir.r5.tools

Class CDSHooksResponse

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

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

public class CDSHooksResponse
extends CDSHooksElement
implements org.hl7.fhir.instance.model.api.ICompositeType

This structure is defined to allow the FHIR Validator to validate a CDSHooks Response body. TODO: This content will be moved to the CDS Hooks specification in the future

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CDSHooksResponse.CDSActionTypeCodesVS
static class	CDSHooksResponse.CDSActionTypeCodesVSEnumFactory
static class	CDSHooksResponse.CDSHooksResponseCardsComponent
static class	CDSHooksResponse.CDSHooksResponseCardsLinksComponent
static class	CDSHooksResponse.CDSHooksResponseCardsSourceComponent
static class	CDSHooksResponse.CDSHooksResponseCardsSuggestionsActionsComponent
static class	CDSHooksResponse.CDSHooksResponseCardsSuggestionsComponent
static enum	CDSHooksResponse.CDSIndicatorCodesVS
static class	CDSHooksResponse.CDSIndicatorCodesVSEnumFactory
static enum	CDSHooksResponse.CDSLinkTypeCodesVS
static class	CDSHooksResponse.CDSLinkTypeCodesVSEnumFactory
static enum	CDSHooksResponse.CDSSelectionBehaviorCodesVS
static class	CDSHooksResponse.CDSSelectionBehaviorCodesVSEnumFactory

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 List<CDSHooksResponse.CDSHooksResponseCardsComponent>	cards	An array of Cards.
protected List<CDSHooksResponse.CDSHooksResponseCardsSuggestionsActionsComponent>	systemActions	An array of Actions that the CDS Service proposes to auto-apply

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

extension

Constructor Summary

Constructors

Constructor	Description
CDSHooksResponse()	Constructor

Method Summary

Modifier and Type	Method	Description
CDSHooksResponse.CDSHooksResponseCardsComponent	addCards()
CDSHooksResponse	addCards(CDSHooksResponse.CDSHooksResponseCardsComponent t)
Base	addChild(String name)
CDSHooksResponse.CDSHooksResponseCardsSuggestionsActionsComponent	addSystemActions()
CDSHooksResponse	addSystemActions(CDSHooksResponse.CDSHooksResponseCardsSuggestionsActionsComponent t)
CDSHooksResponse	copy()
void	copyValues(CDSHooksResponse dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<CDSHooksResponse.CDSHooksResponseCardsComponent>	getCards()
CDSHooksResponse.CDSHooksResponseCardsComponent	getCardsFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
List<CDSHooksResponse.CDSHooksResponseCardsSuggestionsActionsComponent>	getSystemActions()
CDSHooksResponse.CDSHooksResponseCardsSuggestionsActionsComponent	getSystemActionsFirstRep()
String[]	getTypesForProperty(int hash, String name)
boolean	hasCards()
boolean	hasSystemActions()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
CDSHooksResponse	setCards(List<CDSHooksResponse.CDSHooksResponseCardsComponent> theCards)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
CDSHooksResponse	setSystemActions(List<CDSHooksResponse.CDSHooksResponseCardsSuggestionsActionsComponent> theSystemActions)
protected CDSHooksResponse	typedCopy()

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

cards

protected List<CDSHooksResponse.CDSHooksResponseCardsComponent> cards

An array of Cards. Cards can provide a combination of information (for reading), suggested actions (to be applied if a user selects them), and links (to launch an app if the user selects them).

systemActions

protected List<CDSHooksResponse.CDSHooksResponseCardsSuggestionsActionsComponent> systemActions

An array of Actions that the CDS Service proposes to auto-apply

Constructor Details

CDSHooksResponse

public CDSHooksResponse()

Constructor

Method Details

getCards

public List<CDSHooksResponse.CDSHooksResponseCardsComponent> getCards()

Returns:

cards (An array of Cards. Cards can provide a combination of information (for reading), suggested actions (to be applied if a user selects them), and links (to launch an app if the user selects them).)

setCards

public CDSHooksResponse setCards(List<CDSHooksResponse.CDSHooksResponseCardsComponent> theCards)

Returns:

Returns a reference to this for easy method chaining

hasCards

public boolean hasCards()

addCards

public CDSHooksResponse.CDSHooksResponseCardsComponent addCards()

addCards

public CDSHooksResponse addCards(CDSHooksResponse.CDSHooksResponseCardsComponent t)

getCardsFirstRep

public CDSHooksResponse.CDSHooksResponseCardsComponent getCardsFirstRep()

Returns:

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

getSystemActions

public List<CDSHooksResponse.CDSHooksResponseCardsSuggestionsActionsComponent> getSystemActions()

Returns:

systemActions (An array of Actions that the CDS Service proposes to auto-apply)

setSystemActions

public CDSHooksResponse setSystemActions(List<CDSHooksResponse.CDSHooksResponseCardsSuggestionsActionsComponent> theSystemActions)

Returns:

Returns a reference to this for easy method chaining

hasSystemActions

public boolean hasSystemActions()

addSystemActions

public CDSHooksResponse.CDSHooksResponseCardsSuggestionsActionsComponent addSystemActions()

addSystemActions

public CDSHooksResponse addSystemActions(CDSHooksResponse.CDSHooksResponseCardsSuggestionsActionsComponent t)

getSystemActionsFirstRep

public CDSHooksResponse.CDSHooksResponseCardsSuggestionsActionsComponent getSystemActionsFirstRep()

Returns:

The first repetition of repeating field systemActions, 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

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)

copy

public CDSHooksResponse copy()

Specified by:

copy in class CDSHooksElement

copyValues

public void copyValues(CDSHooksResponse dst)

typedCopy

protected CDSHooksResponse typedCopy()

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