Package org.hl7.fhir.r5.tools

Class CDSHooksServices.CDSHooksServicesServicesComponent

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.CDSHooksServices.CDSHooksServicesServicesComponent

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:

CDSHooksServices

public static class CDSHooksServices.CDSHooksServicesServicesComponent
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 StringType	description	The description of this Services
protected StringType	hook	The hook this Services should be invoked on
protected CodeType	id	The {id} portion of the URL to this service which is available at ```{baseUrl}/cds-services/{id}```
protected List<CDSHooksServices.CDSHooksServicesServicesPrefetchComponent>	prefetchList	An object containing key/value pairs of FHIR queries that this Services is requesting the CDS Client to perform and provide on each Services call.
protected StringType	title	The human-friendly name of this Services (Recommended)
protected StringType	usageRequirements	Human-friendly description of any preconditions for the use of this CDS Services

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

extension

Constructor Summary

Constructors

Constructor	Description
CDSHooksServicesServicesComponent()	Constructor
CDSHooksServicesServicesComponent(String hook, String id, String description)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
CDSHooksServices.CDSHooksServicesServicesComponent	addPrefetch(CDSHooksServices.CDSHooksServicesServicesPrefetchComponent t)
CDSHooksServices.CDSHooksServicesServicesComponent	copy()
void	copyValues(CDSHooksServices.CDSHooksServicesServicesComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
String	getDescription()
StringType	getDescriptionElement()
String	getHook()
StringType	getHookElement()
String	getId()
CodeType	getIdElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<CDSHooksServices.CDSHooksServicesServicesPrefetchComponent>	getPrefetchList()
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getTitle()
StringType	getTitleElement()
String[]	getTypesForProperty(int hash, String name)
String	getUsageRequirements()
StringType	getUsageRequirementsElement()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasHook()
boolean	hasHookElement()
boolean	hasId()
boolean	hasIdElement()
boolean	hasPrefetch()
boolean	hasTitle()
boolean	hasTitleElement()
boolean	hasUsageRequirements()
boolean	hasUsageRequirementsElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
CDSHooksServices.CDSHooksServicesServicesComponent	setDescription(String value)
CDSHooksServices.CDSHooksServicesServicesComponent	setDescriptionElement(StringType value)
CDSHooksServices.CDSHooksServicesServicesComponent	setHook(String value)
CDSHooksServices.CDSHooksServicesServicesComponent	setHookElement(StringType value)
CDSHooksServices.CDSHooksServicesServicesComponent	setId(String value)
CDSHooksServices.CDSHooksServicesServicesComponent	setIdElement(CodeType value)
CDSHooksServices.CDSHooksServicesServicesComponent	setPrefetchList(List<CDSHooksServices.CDSHooksServicesServicesPrefetchComponent> thePrefetch)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
CDSHooksServices.CDSHooksServicesServicesComponent	setTitle(String value)
CDSHooksServices.CDSHooksServicesServicesComponent	setTitleElement(StringType value)
CDSHooksServices.CDSHooksServicesServicesComponent	setUsageRequirements(String value)
CDSHooksServices.CDSHooksServicesServicesComponent	setUsageRequirementsElement(StringType 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

hook

protected StringType hook

The hook this Services should be invoked on

title

protected StringType title

The human-friendly name of this Services (Recommended)

id

protected CodeType id

The {id} portion of the URL to this service which is available at ```{baseUrl}/cds-services/{id}```

description

protected StringType description

The description of this Services

usageRequirements

protected StringType usageRequirements

Human-friendly description of any preconditions for the use of this CDS Services

prefetchList

protected List<CDSHooksServices.CDSHooksServicesServicesPrefetchComponent> prefetchList

An object containing key/value pairs of FHIR queries that this Services is requesting the CDS Client to perform and provide on each Services call. The key is a string that describes the type of data being requested and the value is a string representing the FHIR query

Constructor Details

CDSHooksServicesServicesComponent

public CDSHooksServicesServicesComponent()

Constructor

CDSHooksServicesServicesComponent

public CDSHooksServicesServicesComponent(String hook,
 String id,
 String description)

Constructor

Method Details

getHookElement

public StringType getHookElement()

Returns:

hook (The hook this Services should be invoked on). This is the underlying object with id, value and extensions. The accessor "getHook" gives direct access to the value

hasHookElement

public boolean hasHookElement()

hasHook

public boolean hasHook()

setHookElement

public CDSHooksServices.CDSHooksServicesServicesComponent setHookElement(StringType value)

Parameters:

value - hook (The hook this Services should be invoked on). This is the underlying object with id, value and extensions. The accessor "getHook" gives direct access to the value

getHook

public String getHook()

Returns:

The hook this Services should be invoked on

setHook

public CDSHooksServices.CDSHooksServicesServicesComponent setHook(String value)

Parameters:

value - The hook this Services should be invoked on

getTitleElement

public StringType getTitleElement()

Returns:

title (The human-friendly name of this Services (Recommended)). 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 CDSHooksServices.CDSHooksServicesServicesComponent setTitleElement(StringType value)

Parameters:

value - title (The human-friendly name of this Services (Recommended)). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value

getTitle

public String getTitle()

Returns:

The human-friendly name of this Services (Recommended)

setTitle

public CDSHooksServices.CDSHooksServicesServicesComponent setTitle(String value)

Parameters:

value - The human-friendly name of this Services (Recommended)

getIdElement

public CodeType getIdElement()

Returns:

id (The {id} portion of the URL to this service which is available at ```{baseUrl}/cds-services/{id}```). This is the underlying object with id, value and extensions. The accessor "getId" gives direct access to the value

hasIdElement

public boolean hasIdElement()

hasId

public boolean hasId()

setIdElement

public CDSHooksServices.CDSHooksServicesServicesComponent setIdElement(CodeType value)

Parameters:

value - id (The {id} portion of the URL to this service which is available at ```{baseUrl}/cds-services/{id}```). This is the underlying object with id, value and extensions. The accessor "getId" gives direct access to the value

getId

public String getId()

Returns:

The {id} portion of the URL to this service which is available at ```{baseUrl}/cds-services/{id}```

setId

public CDSHooksServices.CDSHooksServicesServicesComponent setId(String value)

Parameters:

value - The {id} portion of the URL to this service which is available at ```{baseUrl}/cds-services/{id}```

getDescriptionElement

public StringType getDescriptionElement()

Returns:

description (The description of this Services). 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 CDSHooksServices.CDSHooksServicesServicesComponent setDescriptionElement(StringType value)

Parameters:

value - description (The description of this Services). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

getDescription

public String getDescription()

Returns:

The description of this Services

setDescription

public CDSHooksServices.CDSHooksServicesServicesComponent setDescription(String value)

Parameters:

value - The description of this Services

getUsageRequirementsElement

public StringType getUsageRequirementsElement()

Returns:

usageRequirements (Human-friendly description of any preconditions for the use of this CDS Services). This is the underlying object with id, value and extensions. The accessor "getUsageRequirements" gives direct access to the value

hasUsageRequirementsElement

public boolean hasUsageRequirementsElement()

hasUsageRequirements

public boolean hasUsageRequirements()

setUsageRequirementsElement

public CDSHooksServices.CDSHooksServicesServicesComponent setUsageRequirementsElement(StringType value)

Parameters:

value - usageRequirements (Human-friendly description of any preconditions for the use of this CDS Services). This is the underlying object with id, value and extensions. The accessor "getUsageRequirements" gives direct access to the value

getUsageRequirements

public String getUsageRequirements()

Returns:

Human-friendly description of any preconditions for the use of this CDS Services

setUsageRequirements

public CDSHooksServices.CDSHooksServicesServicesComponent setUsageRequirements(String value)

Parameters:

value - Human-friendly description of any preconditions for the use of this CDS Services

getPrefetchList

public List<CDSHooksServices.CDSHooksServicesServicesPrefetchComponent> getPrefetchList()

Returns:

invalid reference

#prefetch

(An object containing key/value pairs of FHIR queries that this Services is requesting the CDS Client to perform and provide on each Services call. The key is a string that describes the type of data being requested and the value is a string representing the FHIR query)

setPrefetchList

public CDSHooksServices.CDSHooksServicesServicesComponent setPrefetchList(List<CDSHooksServices.CDSHooksServicesServicesPrefetchComponent> thePrefetch)

Returns:

Returns a reference to this for easy method chaining

hasPrefetch

public boolean hasPrefetch()

addPrefetch

public CDSHooksServices.CDSHooksServicesServicesComponent addPrefetch(CDSHooksServices.CDSHooksServicesServicesPrefetchComponent t)

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

Specified by:

copy in class CDSHooksElement

copyValues

public void copyValues(CDSHooksServices.CDSHooksServicesServicesComponent 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)