Package org.hl7.fhir.r5.tools

Class CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent

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

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:

CDSHooksRequest

public static class CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent
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	accessToken	This is the OAuth 2.0 access token that provides access to the FHIR server
protected IntegerType	expiresIn	The lifetime in seconds of the access token.
protected IdType	patient	The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server
protected StringType	scope	The scopes the access token grants the CDS Service
protected StringType	subject	The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server
protected CodeType	tokenType	Fixed value: Bearer

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

extension

Constructor Summary

Constructors

Constructor	Description
CDSHooksRequestFhirAuthorizationComponent()	Constructor
CDSHooksRequestFhirAuthorizationComponent(String accessToken, String tokenType, int expiresIn, String scope, String subject)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent	copy()
void	copyValues(CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
String	getAccessToken()
StringType	getAccessTokenElement()
int	getExpiresIn()
IntegerType	getExpiresInElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
String	getPatient()
IdType	getPatientElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getScope()
StringType	getScopeElement()
String	getSubject()
StringType	getSubjectElement()
String	getTokenType()
CodeType	getTokenTypeElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAccessToken()
boolean	hasAccessTokenElement()
boolean	hasExpiresIn()
boolean	hasExpiresInElement()
boolean	hasPatient()
boolean	hasPatientElement()
boolean	hasScope()
boolean	hasScopeElement()
boolean	hasSubject()
boolean	hasSubjectElement()
boolean	hasTokenType()
boolean	hasTokenTypeElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent	setAccessToken(String value)
CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent	setAccessTokenElement(StringType value)
CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent	setExpiresIn(int value)
CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent	setExpiresInElement(IntegerType value)
CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent	setPatient(String value)
CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent	setPatientElement(IdType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent	setScope(String value)
CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent	setScopeElement(StringType value)
CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent	setSubject(String value)
CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent	setSubjectElement(StringType value)
CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent	setTokenType(String value)
CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent	setTokenTypeElement(CodeType 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

accessToken

protected StringType accessToken

This is the OAuth 2.0 access token that provides access to the FHIR server

tokenType

protected CodeType tokenType

Fixed value: Bearer

expiresIn

protected IntegerType expiresIn

The lifetime in seconds of the access token.

scope

protected StringType scope

The scopes the access token grants the CDS Service

subject

protected StringType subject

The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server

patient

protected IdType patient

The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server

Constructor Details

CDSHooksRequestFhirAuthorizationComponent

public CDSHooksRequestFhirAuthorizationComponent()

Constructor

CDSHooksRequestFhirAuthorizationComponent

public CDSHooksRequestFhirAuthorizationComponent(String accessToken,
 String tokenType,
 int expiresIn,
 String scope,
 String subject)

Constructor

Method Details

getAccessTokenElement

public StringType getAccessTokenElement()

Returns:

accessToken (This is the OAuth 2.0 access token that provides access to the FHIR server). This is the underlying object with id, value and extensions. The accessor "getAccessToken" gives direct access to the value

hasAccessTokenElement

public boolean hasAccessTokenElement()

hasAccessToken

public boolean hasAccessToken()

setAccessTokenElement

public CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent setAccessTokenElement(StringType value)

Parameters:

value - accessToken (This is the OAuth 2.0 access token that provides access to the FHIR server). This is the underlying object with id, value and extensions. The accessor "getAccessToken" gives direct access to the value

getAccessToken

public String getAccessToken()

Returns:

This is the OAuth 2.0 access token that provides access to the FHIR server

setAccessToken

public CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent setAccessToken(String value)

Parameters:

value - This is the OAuth 2.0 access token that provides access to the FHIR server

getTokenTypeElement

public CodeType getTokenTypeElement()

Returns:

tokenType (Fixed value: Bearer). This is the underlying object with id, value and extensions. The accessor "getTokenType" gives direct access to the value

hasTokenTypeElement

public boolean hasTokenTypeElement()

hasTokenType

public boolean hasTokenType()

setTokenTypeElement

public CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent setTokenTypeElement(CodeType value)

Parameters:

value - tokenType (Fixed value: Bearer). This is the underlying object with id, value and extensions. The accessor "getTokenType" gives direct access to the value

getTokenType

public String getTokenType()

Returns:

Fixed value: Bearer

setTokenType

public CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent setTokenType(String value)

Parameters:

value - Fixed value: Bearer

getExpiresInElement

public IntegerType getExpiresInElement()

Returns:

expiresIn (The lifetime in seconds of the access token.). This is the underlying object with id, value and extensions. The accessor "getExpiresIn" gives direct access to the value

hasExpiresInElement

public boolean hasExpiresInElement()

hasExpiresIn

public boolean hasExpiresIn()

setExpiresInElement

public CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent setExpiresInElement(IntegerType value)

Parameters:

value - expiresIn (The lifetime in seconds of the access token.). This is the underlying object with id, value and extensions. The accessor "getExpiresIn" gives direct access to the value

getExpiresIn

public int getExpiresIn()

Returns:

The lifetime in seconds of the access token.

setExpiresIn

public CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent setExpiresIn(int value)

Parameters:

value - The lifetime in seconds of the access token.

getScopeElement

public StringType getScopeElement()

Returns:

scope (The scopes the access token grants the CDS Service). This is the underlying object with id, value and extensions. The accessor "getScope" gives direct access to the value

hasScopeElement

public boolean hasScopeElement()

hasScope

public boolean hasScope()

setScopeElement

public CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent setScopeElement(StringType value)

Parameters:

value - scope (The scopes the access token grants the CDS Service). This is the underlying object with id, value and extensions. The accessor "getScope" gives direct access to the value

getScope

public String getScope()

Returns:

The scopes the access token grants the CDS Service

setScope

public CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent setScope(String value)

Parameters:

value - The scopes the access token grants the CDS Service

getSubjectElement

public StringType getSubjectElement()

Returns:

subject (The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server). This is the underlying object with id, value and extensions. The accessor "getSubject" gives direct access to the value

hasSubjectElement

public boolean hasSubjectElement()

hasSubject

public boolean hasSubject()

setSubjectElement

public CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent setSubjectElement(StringType value)

Parameters:

value - subject (The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server). This is the underlying object with id, value and extensions. The accessor "getSubject" gives direct access to the value

getSubject

public String getSubject()

Returns:

The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server

setSubject

public CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent setSubject(String value)

Parameters:

value - The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server

getPatientElement

public IdType getPatientElement()

Returns:

patient (The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server). This is the underlying object with id, value and extensions. The accessor "getPatient" gives direct access to the value

hasPatientElement

public boolean hasPatientElement()

hasPatient

public boolean hasPatient()

setPatientElement

public CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent setPatientElement(IdType value)

Parameters:

value - patient (The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server). This is the underlying object with id, value and extensions. The accessor "getPatient" gives direct access to the value

getPatient

public String getPatient()

Returns:

The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server

setPatient

public CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent setPatient(String value)

Parameters:

value - The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server

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

Specified by:

copy in class CDSHooksElement

copyValues

public void copyValues(CDSHooksRequest.CDSHooksRequestFhirAuthorizationComponent 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)