Package org.hl7.fhir.r5.tools

Class CDSHooksRequest

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

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 CDSHooksRequest
extends CDSHooksElement
implements org.hl7.fhir.instance.model.api.ICompositeType

This structure is defined to allow the FHIR Validator to validate a CDSHooks Request 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 class	CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent
static class	CDSHooksRequest.CDSHooksRequestPrefetchComponent

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 CDSHookContext	context	Hook-specific contextual data that the CDS service will need
protected CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent	fhirAuthorization	A structure holding an OAuth 2.0 bearer access token granting the CDS Service access to FHIR resources, along with supplemental information relating to the token
protected UrlType	fhirServer	The base URL of the CDS Client's FHIR server.
protected CodeType	hook	The hook that triggered this CDS Service call
protected UuidType	hookInstance	While working in the CDS Client, a user can perform multiple actions in series or in parallel.
protected List<CDSHooksRequest.CDSHooksRequestPrefetchComponent>	prefetchList	An object containing key/value pairs of FHIR queries that this Request is requesting the CDS Client to perform and provide on each Request call.

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

extension

Constructor Summary

Constructors

Constructor	Description
CDSHooksRequest()	Constructor
CDSHooksRequest(String hook, String hookInstance, CDSHookContext context)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
CDSHooksRequest	addPrefetch(CDSHooksRequest.CDSHooksRequestPrefetchComponent t)
CDSHooksRequest	copy()
void	copyValues(CDSHooksRequest dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
CDSHookContext	getContext()
CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent	getFhirAuthorization()
String	getFhirServer()
UrlType	getFhirServerElement()
String	getHook()
CodeType	getHookElement()
String	getHookInstance()
UuidType	getHookInstanceElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<CDSHooksRequest.CDSHooksRequestPrefetchComponent>	getPrefetchList()
Base[]	getProperty(int hash, String name, boolean checkValid)
String[]	getTypesForProperty(int hash, String name)
boolean	hasContext()
boolean	hasFhirAuthorization()
boolean	hasFhirServer()
boolean	hasFhirServerElement()
boolean	hasHook()
boolean	hasHookElement()
boolean	hasHookInstance()
boolean	hasHookInstanceElement()
boolean	hasPrefetch()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
CDSHooksRequest	setContext(CDSHookContext value)
CDSHooksRequest	setFhirAuthorization(CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent value)
CDSHooksRequest	setFhirServer(String value)
CDSHooksRequest	setFhirServerElement(UrlType value)
CDSHooksRequest	setHook(String value)
CDSHooksRequest	setHookElement(CodeType value)
CDSHooksRequest	setHookInstance(String value)
CDSHooksRequest	setHookInstanceElement(UuidType value)
CDSHooksRequest	setPrefetchList(List<CDSHooksRequest.CDSHooksRequestPrefetchComponent> thePrefetch)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
protected CDSHooksRequest	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, 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 CodeType hook

The hook that triggered this CDS Service call

hookInstance

protected UuidType hookInstance

While working in the CDS Client, a user can perform multiple actions in series or in parallel. For example, a clinician might prescribe two drugs in a row; each prescription action would be assigned a unique hookInstance. This allows a CDS Service to uniquely identify each hook invocation

fhirServer

protected UrlType fhirServer

The base URL of the CDS Client's FHIR server. If fhirAuthorization is provided, this field is REQUIRED. The scheme MUST be https when production data is exchanged

fhirAuthorization

protected CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent fhirAuthorization

A structure holding an OAuth 2.0 bearer access token granting the CDS Service access to FHIR resources, along with supplemental information relating to the token

context

protected CDSHookContext context

Hook-specific contextual data that the CDS service will need

prefetchList

protected List<CDSHooksRequest.CDSHooksRequestPrefetchComponent> prefetchList

An object containing key/value pairs of FHIR queries that this Request is requesting the CDS Client to perform and provide on each Request 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

CDSHooksRequest

public CDSHooksRequest()

Constructor

CDSHooksRequest

public CDSHooksRequest(String hook,
 String hookInstance,
 CDSHookContext context)

Constructor

Method Details

getHookElement

public CodeType getHookElement()

Returns:

hook (The hook that triggered this CDS Service call). 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 CDSHooksRequest setHookElement(CodeType value)

Parameters:

value - hook (The hook that triggered this CDS Service call). 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 that triggered this CDS Service call

setHook

public CDSHooksRequest setHook(String value)

Parameters:

value - The hook that triggered this CDS Service call

getHookInstanceElement

public UuidType getHookInstanceElement()

Returns:

hookInstance (While working in the CDS Client, a user can perform multiple actions in series or in parallel. For example, a clinician might prescribe two drugs in a row; each prescription action would be assigned a unique hookInstance. This allows a CDS Service to uniquely identify each hook invocation). This is the underlying object with id, value and extensions. The accessor "getHookInstance" gives direct access to the value

hasHookInstanceElement

public boolean hasHookInstanceElement()

hasHookInstance

public boolean hasHookInstance()

setHookInstanceElement

public CDSHooksRequest setHookInstanceElement(UuidType value)

Parameters:

value - hookInstance (While working in the CDS Client, a user can perform multiple actions in series or in parallel. For example, a clinician might prescribe two drugs in a row; each prescription action would be assigned a unique hookInstance. This allows a CDS Service to uniquely identify each hook invocation). This is the underlying object with id, value and extensions. The accessor "getHookInstance" gives direct access to the value

getHookInstance

public String getHookInstance()

Returns:

While working in the CDS Client, a user can perform multiple actions in series or in parallel. For example, a clinician might prescribe two drugs in a row; each prescription action would be assigned a unique hookInstance. This allows a CDS Service to uniquely identify each hook invocation

setHookInstance

public CDSHooksRequest setHookInstance(String value)

Parameters:

value - While working in the CDS Client, a user can perform multiple actions in series or in parallel. For example, a clinician might prescribe two drugs in a row; each prescription action would be assigned a unique hookInstance. This allows a CDS Service to uniquely identify each hook invocation

getFhirServerElement

public UrlType getFhirServerElement()

Returns:

fhirServer (The base URL of the CDS Client's FHIR server. If fhirAuthorization is provided, this field is REQUIRED. The scheme MUST be https when production data is exchanged). This is the underlying object with id, value and extensions. The accessor "getFhirServer" gives direct access to the value

hasFhirServerElement

public boolean hasFhirServerElement()

hasFhirServer

public boolean hasFhirServer()

setFhirServerElement

public CDSHooksRequest setFhirServerElement(UrlType value)

Parameters:

value - fhirServer (The base URL of the CDS Client's FHIR server. If fhirAuthorization is provided, this field is REQUIRED. The scheme MUST be https when production data is exchanged). This is the underlying object with id, value and extensions. The accessor "getFhirServer" gives direct access to the value

getFhirServer

public String getFhirServer()

Returns:

The base URL of the CDS Client's FHIR server. If fhirAuthorization is provided, this field is REQUIRED. The scheme MUST be https when production data is exchanged

setFhirServer

public CDSHooksRequest setFhirServer(String value)

Parameters:

value - The base URL of the CDS Client's FHIR server. If fhirAuthorization is provided, this field is REQUIRED. The scheme MUST be https when production data is exchanged

getFhirAuthorization

public CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent getFhirAuthorization()

Returns:

fhirAuthorization (A structure holding an OAuth 2.0 bearer access token granting the CDS Service access to FHIR resources, along with supplemental information relating to the token)

hasFhirAuthorization

public boolean hasFhirAuthorization()

setFhirAuthorization

public CDSHooksRequest setFhirAuthorization(CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent value)

Parameters:

value - fhirAuthorization (A structure holding an OAuth 2.0 bearer access token granting the CDS Service access to FHIR resources, along with supplemental information relating to the token)

getContext

public CDSHookContext getContext()

Returns:

context (Hook-specific contextual data that the CDS service will need)

hasContext

public boolean hasContext()

setContext

public CDSHooksRequest setContext(CDSHookContext value)

Parameters:

value - context (Hook-specific contextual data that the CDS service will need)

getPrefetchList

public List<CDSHooksRequest.CDSHooksRequestPrefetchComponent> getPrefetchList()

Returns:

invalid reference

#prefetch

(An object containing key/value pairs of FHIR queries that this Request is requesting the CDS Client to perform and provide on each Request 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 CDSHooksRequest setPrefetchList(List<CDSHooksRequest.CDSHooksRequestPrefetchComponent> thePrefetch)

Returns:

Returns a reference to this for easy method chaining

hasPrefetch

public boolean hasPrefetch()

addPrefetch

public CDSHooksRequest addPrefetch(CDSHooksRequest.CDSHooksRequestPrefetchComponent 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

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 CDSHooksRequest copy()

Specified by:

copy in class CDSHooksElement

copyValues

public void copyValues(CDSHooksRequest dst)

typedCopy

protected CDSHooksRequest 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