ca.uhn.fhir.rest.client

Interface IGenericClient

All Superinterfaces:

IRestfulClient

All Known Implementing Classes:

GenericClient

public interface IGenericClient
extends IRestfulClient

Method Summary

Modifier and Type	Method and Description
BaseConformance	conformance() Deprecated. Use fetchConformance() instead
ICreate	create() Fluent method for the "create" operation, which creates a new resource instance on the server
MethodOutcome	create(IBaseResource theResource) Deprecated. Use fluent method instead. This method will be removed.
IDelete	delete() Fluent method for the "delete" operation, which performs a logical delete on a server resource
MethodOutcome	delete(Class<? extends IBaseResource> theType, IdDt theId) Deprecated. Use delete() instead
MethodOutcome	delete(Class<? extends IBaseResource> theType, String theId) Deprecated. Use delete() instead
IFetchConformanceUntyped	fetchConformance() Retrieves the server's conformance statement
void	forceConformanceCheck() Force the client to fetch the server's conformance statement and validate that it is appropriate for this client.
IGetTags	getTags() Fluent method for the "get tags" operation
IHistory	history() Implementation of the "history" method
<T extends IBaseResource> Bundle	history(Class<T> theType, IdDt theId, DateTimeDt theSince, Integer theLimit) Deprecated. As of 0.9, use the fluent history() method instead
<T extends IBaseResource> Bundle	history(Class<T> theType, String theId, DateTimeDt theSince, Integer theLimit) Deprecated. As of 0.9, use the fluent history() method instead
IGetPage	loadPage() Loads the previous/next bundle of resources from a paged set, using the link specified in the "link type=next" tag within the atom bundle.
IMeta	meta() Fluent method for the "meta" operations, which can be used to get, add and remove tags and other Meta elements from a resource or across the server.
IOperation	operation() Implementation of the FHIR "extended operations" action
IRead	read() Fluent method for "read" and "vread" methods.
<T extends IBaseResource> T	read(Class<T> theType, String theId) Implementation of the "instance read" method.
<T extends IBaseResource> T	read(Class<T> theType, UriDt theUrl) Perform the "read" operation (retrieve the latest version of a resource instance by ID) using an absolute URL.
IBaseResource	read(UriDt theUrl) Perform the "read" operation (retrieve the latest version of a resource instance by ID) using an absolute URL.
void	registerInterceptor(IClientInterceptor theInterceptor) Register a new interceptor for this client.
IUntypedQuery	search() Search for resources matching a given set of criteria.
<T extends IBaseResource> Bundle	search(Class<T> theType, Map<String,List<IQueryParameterType>> theParams) Implementation of the "instance search" method.
<T extends IBaseResource> Bundle	search(Class<T> theType, UriDt theUrl) Perform the "search" operation using an absolute URL.
Bundle	search(UriDt theUrl)
void	setLogRequestAndResponse(boolean theLogRequestAndResponse) If set to true, the client will log all requests and all responses.
ITransaction	transaction() Send a transaction (collection of resources) to the server to be executed as a single unit
List<IBaseResource>	transaction(List<IBaseResource> theResources) Deprecated. Use transaction()
void	unregisterInterceptor(IClientInterceptor theInterceptor) Remove an intercaptor that was previously registered using IRestfulClient.registerInterceptor(IClientInterceptor)
IUpdate	update() Fluent method for the "update" operation, which performs a logical delete on a server resource
MethodOutcome	update(IdDt theId, IBaseResource theResource) Implementation of the "instance update" method.
MethodOutcome	update(String theId, IBaseResource theResource) Implementation of the "instance update" method.
IValidate	validate() Validate a resource
MethodOutcome	validate(IBaseResource theResource) Implementation of the "type validate" method.
<T extends IBaseResource> T	vread(Class<T> theType, IdDt theId) Implementation of the "instance vread" method.
<T extends IBaseResource> T	vread(Class<T> theType, IdDt theId, IdDt theVersionId) Deprecated. Deprecated in 0.7 - IdDt can contain an ID and a version, so this class doesn't make a lot of sense
<T extends IBaseResource> T	vread(Class<T> theType, String theId, String theVersionId) Implementation of the "instance vread" method.

Methods inherited from interface ca.uhn.fhir.rest.client.api.IRestfulClient

fetchResourceFromUrl, getFhirContext, getHttpClient, getServerBase, setEncoding, setPrettyPrint, setSummary

Method Detail

conformance

@Deprecated
BaseConformance conformance()

Deprecated. Use fetchConformance() instead

Retrieves and returns the server conformance statement

create

ICreate create()

Fluent method for the "create" operation, which creates a new resource instance on the server

create

@Deprecated
MethodOutcome create(IBaseResource theResource)

Deprecated. Use fluent method instead. This method will be removed.

Implementation of the "type create" method.

Parameters:

theResource - The resource to create

Returns:

An outcome

delete

IDelete delete()

Fluent method for the "delete" operation, which performs a logical delete on a server resource

delete

@Deprecated
MethodOutcome delete(Class<? extends IBaseResource> theType,
                                 IdDt theId)

Deprecated. Use delete() instead

Implementation of the "delete instance" method.

Parameters:

theType - The type of resource to delete

theId - the ID of the resource to delete

Returns:

An outcome

delete

@Deprecated
MethodOutcome delete(Class<? extends IBaseResource> theType,
                                 String theId)

Deprecated. Use delete() instead

Implementation of the "delete instance" method.

Parameters:

theType - The type of resource to delete

theId - the ID of the resource to delete

Returns:

An outcome

fetchConformance

IFetchConformanceUntyped fetchConformance()

Retrieves the server's conformance statement

forceConformanceCheck

void forceConformanceCheck()
                    throws FhirClientConnectionException

Force the client to fetch the server's conformance statement and validate that it is appropriate for this client.

Throws:

FhirClientConnectionException - if the conformance statement cannot be read, or if the client

FhirClientInappropriateForServerException - If the conformance statement indicates that the server is inappropriate for this client (e.g. it implements the wrong version of FHIR)

getTags

IGetTags getTags()

Fluent method for the "get tags" operation

history

IHistory history()

Implementation of the "history" method

history

@Deprecated
<T extends IBaseResource> Bundle history(Class<T> theType,
                                                     IdDt theId,
                                                     DateTimeDt theSince,
                                                     Integer theLimit)

Deprecated. As of 0.9, use the fluent history() method instead

Implementation of the "history instance" method.

Parameters:

theType - The type of resource to return the history for, or null to search for history across all resources

theId - The ID of the resource to return the history for, or null to search for all resource instances. Note that if this param is not null, theType must also not be null

theSince - If not null, request that the server only return resources updated since this time

theLimit - If not null, request that the server return no more than this number of resources. Note that the server may return less even if more are available, but should not return more according to the FHIR specification.

Returns:

A bundle containing returned resources

history

@Deprecated
<T extends IBaseResource> Bundle history(Class<T> theType,
                                                     String theId,
                                                     DateTimeDt theSince,
                                                     Integer theLimit)

Deprecated. As of 0.9, use the fluent history() method instead

Implementation of the "history instance" method.

Parameters:

theType - The type of resource to return the history for, or null to search for history across all resources

theId - The ID of the resource to return the history for, or null to search for all resource instances. Note that if this param is not null, theType must also not be null

theSince - If not null, request that the server only return resources updated since this time

theLimit - If not null, request that the server return no more than this number of resources. Note that the server may return less even if more are available, but should not return more according to the FHIR specification.

Returns:

A bundle containing returned resources

loadPage

IGetPage loadPage()

Loads the previous/next bundle of resources from a paged set, using the link specified in the "link type=next" tag within the atom bundle.

See Also:

Bundle.getLinkNext()

meta

IMeta meta()

Fluent method for the "meta" operations, which can be used to get, add and remove tags and other Meta elements from a resource or across the server.

Since:

1.1

operation

IOperation operation()

Implementation of the FHIR "extended operations" action

read

IRead read()

Fluent method for "read" and "vread" methods.

read

<T extends IBaseResource> T read(Class<T> theType,
                                 String theId)

Implementation of the "instance read" method.

Parameters:

theType - The type of resource to load

theId - The ID to load

Returns:

The resource

read

<T extends IBaseResource> T read(Class<T> theType,
                                 UriDt theUrl)

Perform the "read" operation (retrieve the latest version of a resource instance by ID) using an absolute URL.

Parameters:

theType - The resource type that is being retrieved

theUrl - The absolute URL, e.g. "http://example.com/fhir/Patient/123"

Returns:

The returned resource from the server

read

IBaseResource read(UriDt theUrl)

Perform the "read" operation (retrieve the latest version of a resource instance by ID) using an absolute URL.

Parameters:

theUrl - The absolute URL, e.g. "http://example.com/fhir/Patient/123"

Returns:

The returned resource from the server

registerInterceptor

void registerInterceptor(IClientInterceptor theInterceptor)

Register a new interceptor for this client. An interceptor can be used to add additional logging, or add security headers, or pre-process responses, etc.

Specified by:

registerInterceptor in interface IRestfulClient

search

IUntypedQuery search()

Search for resources matching a given set of criteria. Searching is a very powerful feature in FHIR with many features for specifying exactly what should be seaerched for and how it should be returned. See the specification on search for more information.

search

<T extends IBaseResource> Bundle search(Class<T> theType,
                                        Map<String,List<IQueryParameterType>> theParams)

Implementation of the "instance search" method.

Parameters:

theType - The type of resource to load

theParams -

search

<T extends IBaseResource> Bundle search(Class<T> theType,
                                        UriDt theUrl)

Perform the "search" operation using an absolute URL.

Parameters:

theType - The primary resource type that is being retrieved

theUrl - The absolute URL, e.g. "http://example.com/fhir/Patient/123"

Returns:

The returned bundle from the server

search

Bundle search(UriDt theUrl)

setLogRequestAndResponse

void setLogRequestAndResponse(boolean theLogRequestAndResponse)

If set to true, the client will log all requests and all responses. This is probably not a good production setting since it will result in a lot of extra logging, but it can be useful for troubleshooting.

Parameters:

theLogRequestAndResponse - Should requests and responses be logged

transaction

ITransaction transaction()

Send a transaction (collection of resources) to the server to be executed as a single unit

transaction

@Deprecated
List<IBaseResource> transaction(List<IBaseResource> theResources)

Deprecated. Use transaction()

Implementation of the "transaction" method.

Parameters:

theResources - The resources to create/update in a single transaction

Returns:

A list of resource stubs (these will not be fully populated) containing IDs and other metadata

unregisterInterceptor

void unregisterInterceptor(IClientInterceptor theInterceptor)

Remove an intercaptor that was previously registered using IRestfulClient.registerInterceptor(IClientInterceptor)

Specified by:

unregisterInterceptor in interface IRestfulClient

update

IUpdate update()

Fluent method for the "update" operation, which performs a logical delete on a server resource

update

MethodOutcome update(IdDt theId,
                     IBaseResource theResource)

Implementation of the "instance update" method.

Parameters:

theId - The ID to update

theResource - The new resource body

Returns:

An outcome containing the results and possibly the new version ID

update

MethodOutcome update(String theId,
                     IBaseResource theResource)

Implementation of the "instance update" method.

Parameters:

theId - The ID to update

theResource - The new resource body

Returns:

An outcome containing the results and possibly the new version ID

validate

IValidate validate()

Validate a resource

validate

MethodOutcome validate(IBaseResource theResource)

Implementation of the "type validate" method.

Parameters:

theResource - The resource to validate

Returns:

An outcome containing any validation issues

vread

<T extends IBaseResource> T vread(Class<T> theType,
                                  IdDt theId)

Implementation of the "instance vread" method. Note that this method expects theId to contain a resource ID as well as a version ID, and will fail if it does not.

Note that if an absolute resource ID is passed in (i.e. a URL containing a protocol and host as well as the resource type and ID) the server base for the client will be ignored, and the URL passed in will be queried.

Parameters:

theType - The type of resource to load

theId - The ID to load, including the resource ID and the resource version ID. Valid values include "Patient/123/_history/222", or "http://example.com/fhir/Patient/123/_history/222"

Returns:

The resource

vread

@Deprecated
<T extends IBaseResource> T vread(Class<T> theType,
                                              IdDt theId,
                                              IdDt theVersionId)

Deprecated. Deprecated in 0.7 - IdDt can contain an ID and a version, so this class doesn't make a lot of sense

Implementation of the "instance vread" method.

Parameters:

theType - The type of resource to load

theId - The ID to load

theVersionId - The version ID

Returns:

The resource

vread

<T extends IBaseResource> T vread(Class<T> theType,
                                  String theId,
                                  String theVersionId)

Implementation of the "instance vread" method.

Parameters:

theType - The type of resource to load

theId - The ID to load

theVersionId - The version ID

Returns:

The resource