Package org.hl7.fhir.r5.tools

Class CDSHooksResponse.CDSHooksResponseCardsSourceComponent

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

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.CDSHooksResponseCardsSourceComponent
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 UrlType	icon	An absolute URL to an icon for the source of this card.
protected StringType	label	A short, human-readable label to display for the source of the information displayed on this card.
protected Coding	topic	A topic describes the content of the card by providing a high-level categorization that can be useful for filtering, searching or ordered display of related cards in the CDS client's UI.
protected UrlType	url	An optional absolute URL to load (via GET, in a browser context) when a user clicks on this link to learn more about the organization or data set that provided the information on this card.

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

extension

Constructor Summary

Constructors

Constructor	Description
CDSHooksResponseCardsSourceComponent()	Constructor
CDSHooksResponseCardsSourceComponent(String label)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
CDSHooksResponse.CDSHooksResponseCardsSourceComponent	copy()
void	copyValues(CDSHooksResponse.CDSHooksResponseCardsSourceComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
String	getIcon()
UrlType	getIconElement()
String	getLabel()
StringType	getLabelElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
Coding	getTopic()
String[]	getTypesForProperty(int hash, String name)
String	getUrl()
UrlType	getUrlElement()
boolean	hasIcon()
boolean	hasIconElement()
boolean	hasLabel()
boolean	hasLabelElement()
boolean	hasTopic()
boolean	hasUrl()
boolean	hasUrlElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
CDSHooksResponse.CDSHooksResponseCardsSourceComponent	setIcon(String value)
CDSHooksResponse.CDSHooksResponseCardsSourceComponent	setIconElement(UrlType value)
CDSHooksResponse.CDSHooksResponseCardsSourceComponent	setLabel(String value)
CDSHooksResponse.CDSHooksResponseCardsSourceComponent	setLabelElement(StringType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
CDSHooksResponse.CDSHooksResponseCardsSourceComponent	setTopic(Coding value)
CDSHooksResponse.CDSHooksResponseCardsSourceComponent	setUrl(String value)
CDSHooksResponse.CDSHooksResponseCardsSourceComponent	setUrlElement(UrlType 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, setXhtml

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

label

protected StringType label

A short, human-readable label to display for the source of the information displayed on this card. If a url is also specified, this MAY be the text for the hyperlink.

url

protected UrlType url

An optional absolute URL to load (via GET, in a browser context) when a user clicks on this link to learn more about the organization or data set that provided the information on this card.

icon

protected UrlType icon

An absolute URL to an icon for the source of this card. The icon returned by this URL SHOULD be a 100x100 pixel PNG image without any transparent regions. The CDS Client may ignore or scale the image during display as appropriate for user experience.

topic

protected Coding topic

A topic describes the content of the card by providing a high-level categorization that can be useful for filtering, searching or ordered display of related cards in the CDS client's UI. This specification does not prescribe a standard set of topics

Constructor Details

CDSHooksResponseCardsSourceComponent

public CDSHooksResponseCardsSourceComponent()

Constructor

CDSHooksResponseCardsSourceComponent

public CDSHooksResponseCardsSourceComponent(String label)

Constructor

Method Details

getLabelElement

public StringType getLabelElement()

Returns:

label (A short, human-readable label to display for the source of the information displayed on this card. If a url is also specified, this MAY be the text for the hyperlink.). 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 CDSHooksResponse.CDSHooksResponseCardsSourceComponent setLabelElement(StringType value)

Parameters:

value - label (A short, human-readable label to display for the source of the information displayed on this card. If a url is also specified, this MAY be the text for the hyperlink.). This is the underlying object with id, value and extensions. The accessor "getLabel" gives direct access to the value

getLabel

public String getLabel()

Returns:

A short, human-readable label to display for the source of the information displayed on this card. If a url is also specified, this MAY be the text for the hyperlink.

setLabel

public CDSHooksResponse.CDSHooksResponseCardsSourceComponent setLabel(String value)

Parameters:

value - A short, human-readable label to display for the source of the information displayed on this card. If a url is also specified, this MAY be the text for the hyperlink.

getUrlElement

public UrlType getUrlElement()

Returns:

url (An optional absolute URL to load (via GET, in a browser context) when a user clicks on this link to learn more about the organization or data set that provided the information on this card.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value

hasUrlElement

public boolean hasUrlElement()

hasUrl

public boolean hasUrl()

setUrlElement

public CDSHooksResponse.CDSHooksResponseCardsSourceComponent setUrlElement(UrlType value)

Parameters:

value - url (An optional absolute URL to load (via GET, in a browser context) when a user clicks on this link to learn more about the organization or data set that provided the information on this card.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value

getUrl

public String getUrl()

Returns:

An optional absolute URL to load (via GET, in a browser context) when a user clicks on this link to learn more about the organization or data set that provided the information on this card.

setUrl

public CDSHooksResponse.CDSHooksResponseCardsSourceComponent setUrl(String value)

Parameters:

value - An optional absolute URL to load (via GET, in a browser context) when a user clicks on this link to learn more about the organization or data set that provided the information on this card.

getIconElement

public UrlType getIconElement()

Returns:

icon (An absolute URL to an icon for the source of this card. The icon returned by this URL SHOULD be a 100x100 pixel PNG image without any transparent regions. The CDS Client may ignore or scale the image during display as appropriate for user experience.). This is the underlying object with id, value and extensions. The accessor "getIcon" gives direct access to the value

hasIconElement

public boolean hasIconElement()

hasIcon

public boolean hasIcon()

setIconElement

public CDSHooksResponse.CDSHooksResponseCardsSourceComponent setIconElement(UrlType value)

Parameters:

value - icon (An absolute URL to an icon for the source of this card. The icon returned by this URL SHOULD be a 100x100 pixel PNG image without any transparent regions. The CDS Client may ignore or scale the image during display as appropriate for user experience.). This is the underlying object with id, value and extensions. The accessor "getIcon" gives direct access to the value

getIcon

public String getIcon()

Returns:

An absolute URL to an icon for the source of this card. The icon returned by this URL SHOULD be a 100x100 pixel PNG image without any transparent regions. The CDS Client may ignore or scale the image during display as appropriate for user experience.

setIcon

public CDSHooksResponse.CDSHooksResponseCardsSourceComponent setIcon(String value)

Parameters:

value - An absolute URL to an icon for the source of this card. The icon returned by this URL SHOULD be a 100x100 pixel PNG image without any transparent regions. The CDS Client may ignore or scale the image during display as appropriate for user experience.

getTopic

public Coding getTopic()

Returns:

topic (A topic describes the content of the card by providing a high-level categorization that can be useful for filtering, searching or ordered display of related cards in the CDS client's UI. This specification does not prescribe a standard set of topics)

hasTopic

public boolean hasTopic()

setTopic

public CDSHooksResponse.CDSHooksResponseCardsSourceComponent setTopic(Coding value)

Parameters:

value - topic (A topic describes the content of the card by providing a high-level categorization that can be useful for filtering, searching or ordered display of related cards in the CDS client's UI. This specification does not prescribe a standard set of topics)

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.CDSHooksResponseCardsSourceComponent copy()

Specified by:

copy in class CDSHooksElement

copyValues

public void copyValues(CDSHooksResponse.CDSHooksResponseCardsSourceComponent 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)