Package org.hl7.fhir.r5.model

Class CapabilityStatement.CapabilityStatementRestComponent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.BackboneElement

org.hl7.fhir.r5.model.CapabilityStatement.CapabilityStatementRestComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

CapabilityStatement

public static class CapabilityStatement.CapabilityStatementRestComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

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 List<CanonicalType>	compartment	An absolute URI which is a reference to the definition of a compartment that the system supports.
protected MarkdownType	documentation	Information about the system's restful capabilities that apply across all applications, such as security.
protected List<CapabilityStatement.SystemInteractionComponent>	interaction	A specification of restful operations supported by the system.
protected Enumeration<CapabilityStatement.RestfulCapabilityMode>	mode	Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.
protected List<CapabilityStatement.CapabilityStatementRestResourceOperationComponent>	operation	Definition of an operation or a named query together with its parameters and their meaning and type.
protected List<CapabilityStatement.CapabilityStatementRestResourceComponent>	resource	A specification of the restful capabilities of the solution for a specific resource type.
protected List<CapabilityStatement.CapabilityStatementRestResourceSearchParamComponent>	searchParam	Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.
protected CapabilityStatement.CapabilityStatementRestSecurityComponent	security	Information about security implementation from an interface perspective - what a client needs to know.

Fields inherited from class org.hl7.fhir.r5.model.BackboneElement

modifierExtension

Fields inherited from class org.hl7.fhir.r5.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
CapabilityStatementRestComponent()	Constructor
CapabilityStatementRestComponent(CapabilityStatement.RestfulCapabilityMode mode)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
CapabilityStatement.CapabilityStatementRestComponent	addCompartment(String value)
CanonicalType	addCompartmentElement()
CapabilityStatement.SystemInteractionComponent	addInteraction()
CapabilityStatement.CapabilityStatementRestComponent	addInteraction(CapabilityStatement.SystemInteractionComponent t)
CapabilityStatement.CapabilityStatementRestResourceOperationComponent	addOperation()
CapabilityStatement.CapabilityStatementRestComponent	addOperation(CapabilityStatement.CapabilityStatementRestResourceOperationComponent t)
CapabilityStatement.CapabilityStatementRestResourceComponent	addResource()
CapabilityStatement.CapabilityStatementRestComponent	addResource(CapabilityStatement.CapabilityStatementRestResourceComponent t)
CapabilityStatement.CapabilityStatementRestResourceSearchParamComponent	addSearchParam()
CapabilityStatement.CapabilityStatementRestComponent	addSearchParam(CapabilityStatement.CapabilityStatementRestResourceSearchParamComponent t)
CapabilityStatement.CapabilityStatementRestComponent	copy()
void	copyValues(CapabilityStatement.CapabilityStatementRestComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<CanonicalType>	getCompartment()
String	getDocumentation()
MarkdownType	getDocumentationElement()
List<CapabilityStatement.SystemInteractionComponent>	getInteraction()
CapabilityStatement.SystemInteractionComponent	getInteractionFirstRep()
CapabilityStatement.RestfulCapabilityMode	getMode()
Enumeration<CapabilityStatement.RestfulCapabilityMode>	getModeElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<CapabilityStatement.CapabilityStatementRestResourceOperationComponent>	getOperation()
CapabilityStatement.CapabilityStatementRestResourceOperationComponent	getOperationFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<CapabilityStatement.CapabilityStatementRestResourceComponent>	getResource()
CapabilityStatement.CapabilityStatementRestResourceComponent	getResourceFirstRep()
List<CapabilityStatement.CapabilityStatementRestResourceSearchParamComponent>	getSearchParam()
CapabilityStatement.CapabilityStatementRestResourceSearchParamComponent	getSearchParamFirstRep()
CapabilityStatement.CapabilityStatementRestSecurityComponent	getSecurity()
String[]	getTypesForProperty(int hash, String name)
boolean	hasCompartment()
boolean	hasCompartment(String value)
boolean	hasDocumentation()
boolean	hasDocumentationElement()
boolean	hasInteraction()
boolean	hasMode()
boolean	hasModeElement()
boolean	hasOperation()
boolean	hasResource()
boolean	hasSearchParam()
boolean	hasSecurity()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
CapabilityStatement.CapabilityStatementRestComponent	setCompartment(List<CanonicalType> theCompartment)
CapabilityStatement.CapabilityStatementRestComponent	setDocumentation(String value)
CapabilityStatement.CapabilityStatementRestComponent	setDocumentationElement(MarkdownType value)
CapabilityStatement.CapabilityStatementRestComponent	setInteraction(List<CapabilityStatement.SystemInteractionComponent> theInteraction)
CapabilityStatement.CapabilityStatementRestComponent	setMode(CapabilityStatement.RestfulCapabilityMode value)
CapabilityStatement.CapabilityStatementRestComponent	setModeElement(Enumeration<CapabilityStatement.RestfulCapabilityMode> value)
CapabilityStatement.CapabilityStatementRestComponent	setOperation(List<CapabilityStatement.CapabilityStatementRestResourceOperationComponent> theOperation)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
CapabilityStatement.CapabilityStatementRestComponent	setResource(List<CapabilityStatement.CapabilityStatementRestResourceComponent> theResource)
CapabilityStatement.CapabilityStatementRestComponent	setSearchParam(List<CapabilityStatement.CapabilityStatementRestResourceSearchParamComponent> theSearchParam)
CapabilityStatement.CapabilityStatementRestComponent	setSecurity(CapabilityStatement.CapabilityStatementRestSecurityComponent value)

Methods inherited from class org.hl7.fhir.r5.model.BackboneElement

addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.r5.model.Element

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

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, 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, 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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement

getUserData, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

addExtension, getExtension, hasExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

addModifierExtension, getModifierExtension, hasModifierExtension

Field Details

mode

protected Enumeration<CapabilityStatement.RestfulCapabilityMode> mode

Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.

documentation

protected MarkdownType documentation

Information about the system's restful capabilities that apply across all applications, such as security.

security

protected CapabilityStatement.CapabilityStatementRestSecurityComponent security

Information about security implementation from an interface perspective - what a client needs to know.

resource

protected List<CapabilityStatement.CapabilityStatementRestResourceComponent> resource

A specification of the restful capabilities of the solution for a specific resource type.

interaction

protected List<CapabilityStatement.SystemInteractionComponent> interaction

A specification of restful operations supported by the system.

searchParam

protected List<CapabilityStatement.CapabilityStatementRestResourceSearchParamComponent> searchParam

Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation. This is only for searches executed against the system-level endpoint.

operation

protected List<CapabilityStatement.CapabilityStatementRestResourceOperationComponent> operation

Definition of an operation or a named query together with its parameters and their meaning and type.

compartment

protected List<CanonicalType> compartment

An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .

Constructor Details

CapabilityStatementRestComponent

public CapabilityStatementRestComponent()

Constructor

CapabilityStatementRestComponent

public CapabilityStatementRestComponent(CapabilityStatement.RestfulCapabilityMode mode)

Constructor

Method Details

getModeElement

public Enumeration<CapabilityStatement.RestfulCapabilityMode> getModeElement()

Returns:

mode (Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.). This is the underlying object with id, value and extensions. The accessor "getMode" gives direct access to the value

hasModeElement

public boolean hasModeElement()

hasMode

public boolean hasMode()

setModeElement

public CapabilityStatement.CapabilityStatementRestComponent setModeElement(Enumeration<CapabilityStatement.RestfulCapabilityMode> value)

Parameters:

value - mode (Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.). This is the underlying object with id, value and extensions. The accessor "getMode" gives direct access to the value

getMode

public CapabilityStatement.RestfulCapabilityMode getMode()

Returns:

Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.

setMode

public CapabilityStatement.CapabilityStatementRestComponent setMode(CapabilityStatement.RestfulCapabilityMode value)

Parameters:

value - Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.

getDocumentationElement

public MarkdownType getDocumentationElement()

Returns:

documentation (Information about the system's restful capabilities that apply across all applications, such as security.). This is the underlying object with id, value and extensions. The accessor "getDocumentation" gives direct access to the value

hasDocumentationElement

public boolean hasDocumentationElement()

hasDocumentation

public boolean hasDocumentation()

setDocumentationElement

public CapabilityStatement.CapabilityStatementRestComponent setDocumentationElement(MarkdownType value)

Parameters:

value - documentation (Information about the system's restful capabilities that apply across all applications, such as security.). This is the underlying object with id, value and extensions. The accessor "getDocumentation" gives direct access to the value

getDocumentation

public String getDocumentation()

Returns:

Information about the system's restful capabilities that apply across all applications, such as security.

setDocumentation

public CapabilityStatement.CapabilityStatementRestComponent setDocumentation(String value)

Parameters:

value - Information about the system's restful capabilities that apply across all applications, such as security.

getSecurity

public CapabilityStatement.CapabilityStatementRestSecurityComponent getSecurity()

Returns:

security (Information about security implementation from an interface perspective - what a client needs to know.)

hasSecurity

public boolean hasSecurity()

setSecurity

public CapabilityStatement.CapabilityStatementRestComponent setSecurity(CapabilityStatement.CapabilityStatementRestSecurityComponent value)

Parameters:

value - security (Information about security implementation from an interface perspective - what a client needs to know.)

getResource

public List<CapabilityStatement.CapabilityStatementRestResourceComponent> getResource()

Returns:

resource (A specification of the restful capabilities of the solution for a specific resource type.)

setResource

public CapabilityStatement.CapabilityStatementRestComponent setResource(List<CapabilityStatement.CapabilityStatementRestResourceComponent> theResource)

Returns:

Returns a reference to this for easy method chaining

hasResource

public boolean hasResource()

addResource

public CapabilityStatement.CapabilityStatementRestResourceComponent addResource()

addResource

public CapabilityStatement.CapabilityStatementRestComponent addResource(CapabilityStatement.CapabilityStatementRestResourceComponent t)

getResourceFirstRep

public CapabilityStatement.CapabilityStatementRestResourceComponent getResourceFirstRep()

Returns:

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

getInteraction

public List<CapabilityStatement.SystemInteractionComponent> getInteraction()

Returns:

interaction (A specification of restful operations supported by the system.)

setInteraction

public CapabilityStatement.CapabilityStatementRestComponent setInteraction(List<CapabilityStatement.SystemInteractionComponent> theInteraction)

Returns:

Returns a reference to this for easy method chaining

hasInteraction

public boolean hasInteraction()

addInteraction

public CapabilityStatement.SystemInteractionComponent addInteraction()

addInteraction

public CapabilityStatement.CapabilityStatementRestComponent addInteraction(CapabilityStatement.SystemInteractionComponent t)

getInteractionFirstRep

public CapabilityStatement.SystemInteractionComponent getInteractionFirstRep()

Returns:

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

getSearchParam

public List<CapabilityStatement.CapabilityStatementRestResourceSearchParamComponent> getSearchParam()

Returns:

searchParam (Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation. This is only for searches executed against the system-level endpoint.)

setSearchParam

public CapabilityStatement.CapabilityStatementRestComponent setSearchParam(List<CapabilityStatement.CapabilityStatementRestResourceSearchParamComponent> theSearchParam)

Returns:

Returns a reference to this for easy method chaining

hasSearchParam

public boolean hasSearchParam()

addSearchParam

public CapabilityStatement.CapabilityStatementRestResourceSearchParamComponent addSearchParam()

addSearchParam

public CapabilityStatement.CapabilityStatementRestComponent addSearchParam(CapabilityStatement.CapabilityStatementRestResourceSearchParamComponent t)

getSearchParamFirstRep

public CapabilityStatement.CapabilityStatementRestResourceSearchParamComponent getSearchParamFirstRep()

Returns:

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

getOperation

public List<CapabilityStatement.CapabilityStatementRestResourceOperationComponent> getOperation()

Returns:

operation (Definition of an operation or a named query together with its parameters and their meaning and type.)

setOperation

public CapabilityStatement.CapabilityStatementRestComponent setOperation(List<CapabilityStatement.CapabilityStatementRestResourceOperationComponent> theOperation)

Returns:

Returns a reference to this for easy method chaining

hasOperation

public boolean hasOperation()

addOperation

public CapabilityStatement.CapabilityStatementRestResourceOperationComponent addOperation()

addOperation

public CapabilityStatement.CapabilityStatementRestComponent addOperation(CapabilityStatement.CapabilityStatementRestResourceOperationComponent t)

getOperationFirstRep

public CapabilityStatement.CapabilityStatementRestResourceOperationComponent getOperationFirstRep()

Returns:

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

getCompartment

public List<CanonicalType> getCompartment()

Returns:

compartment (An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .)

setCompartment

public CapabilityStatement.CapabilityStatementRestComponent setCompartment(List<CanonicalType> theCompartment)

Returns:

Returns a reference to this for easy method chaining

hasCompartment

public boolean hasCompartment()

addCompartmentElement

public CanonicalType addCompartmentElement()

Returns:

compartment (An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .)

addCompartment

public CapabilityStatement.CapabilityStatementRestComponent addCompartment(String value)

Parameters:

value - compartment (An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .)

hasCompartment

public boolean hasCompartment(String value)

Parameters:

value - compartment (An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .)

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneElement

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class BackboneElement

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 BackboneElement

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 BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public CapabilityStatement.CapabilityStatementRestComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(CapabilityStatement.CapabilityStatementRestComponent dst)

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class BackboneElement

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class BackboneElement

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class BackboneElement

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class BackboneElement

Returns:

the FHIR type name of the instance (not the java class name)