org.hl7.fhir.instance.client

Interface IFHIRClient

All Known Implementing Classes:

WorkerContext.NullClient

public interface IFHIRClient

FHIR RESTful Client Interface.

Author:

Claude Nanjo, Grahame Grieve

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IFHIRClient.VersionInfo

Method Summary

Modifier and Type	Method and Description
<T extends Resource> OperationOutcome	create(Class<T> resourceClass, T resource) Create a new resource with a server assigned id.
<T extends Resource> boolean	delete(Class<T> resourceClass, String id) Delete the resource with the given ID.
ValueSet	expandValueset(ValueSet source) invoke the expand operation and pass the value set for expansion
Bundle	fetchFeed(String url) Use this to follow a link found in a feed (e.g.
String	getAddress() for debugging- the server address that the client is using
Conformance	getConformanceStatement() Method returns a conformance statement for the system queried.
Conformance	getConformanceStatement(boolean useOptionsVerb) Method returns a conformance statement for the system queried.
Conformance	getConformanceStatementQuick() Method returns a conformance statement for the system queried.
Conformance	getConformanceStatementQuick(boolean useOptionsVerb) Method returns a conformance statement for the system queried.
int	getMaximumRecordCount() Returns the maximum record count specified for list operations such as search and history.
String	getPreferredFeedFormat() Returns the feed format in effect.
String	getPreferredResourceFormat() Returns the resource format in effect.
IFHIRClient.VersionInfo	getVersions() Get the Java verion of client and reference implementation, the client FHIR version, the server FHIR version, and the server software version.
<T extends Resource> Bundle	history() Retrieve the update history for all resource types since the start of server records.
<T extends Resource> Bundle	history(Calendar lastUpdate) Retrieve the update history for all resource types since the specified calendar date.
<T extends Resource> Bundle	history(Calendar lastUpdate, Class<T> resourceClass) Retrieve the update history for a resource type since the specified calendar date.
<T extends Resource> Bundle	history(Calendar lastUpdate, Class<T> resourceClass, String id) Retrieve the update history for a resource with given id since last update time.
<T extends Resource> Bundle	history(Class<T> resourceClass)
<T extends Resource> Bundle	history(Class<T> resource, String id) Retrieve the entire update history for a resource with the given id.
<T extends Resource> Bundle	history(Date lastUpdate)
<T extends Resource> Bundle	history(Date lastUpdate, Class<T> resourceClass)
<T extends Resource> Bundle	history(Date lastUpdate, Class<T> resourceClass, String id)
IFHIRClient	initialize(String baseServiceUrl) Call method to initialize FHIR client.
void	initialize(String baseServiceUrl, int recordCount) Call method to initialize FHIR client.
<T extends Resource> Parameters	operateType(Class<T> resourceClass, String name, Parameters params) Invoke an operation at the type level
<T extends Resource> T	read(Class<T> resource, String id) Read the current state of a resource.
<T extends Resource> Bundle	search(Class<T> resourceClass, Map<String,String> params) Return all results matching search query parameters for the given resource class.
<T extends Resource> Bundle	searchPost(Class<T> resourceClass, T resource, Map<String,String> params) Return all results matching search query parameters for the given resource class.
void	setMaximumRecordCount(int recordCount) Sets the maximum record count for list operations such as history and search.
void	setPreferredFeedFormat(FeedFormat feedFormat) Override the default feed format of 'application/atom+xml'.
void	setPreferredResourceFormat(ResourceFormat resourceFormat) Override the default resource format of 'application/fhir+xml'.
Bundle	transaction(Bundle batch) Update or create a set of resources
<T extends Resource> T	update(Class<T> resourceClass, T resource, String id) Update an existing resource by its id or create it if it is a new resource, not present on the server
<T extends Resource> OperationOutcome	validate(Class<T> resourceClass, T resource, String id) Validate resource payload.
<T extends Resource> T	vread(Class<T> resource, String id, String versionid) Read the state of a specific version of the resource

Method Detail

getVersions

IFHIRClient.VersionInfo getVersions()

Get the Java verion of client and reference implementation, the client FHIR version, the server FHIR version, and the server software version. The server information will be blank if no service URL is provided

Returns:

the version information

initialize

IFHIRClient initialize(String baseServiceUrl)
                throws URISyntaxException

Call method to initialize FHIR client. This method must be invoked with a valid base server URL prior to using the client. Invalid base server URLs will result in a URISyntaxException being thrown.

Parameters:

baseServiceUrl - Base service URL for FHIR Service.

Returns:

Throws:

URISyntaxException

initialize

void initialize(String baseServiceUrl,
                int recordCount)
         throws URISyntaxException

Call method to initialize FHIR client. This method must be invoked with a valid base server URL prior to using the client. Invalid base server URLs will result in a URISyntaxException being thrown.

Parameters:

baseServiceUrl - The base service URL

resultCount - Maximum size of the result set

Throws:

URISyntaxException

setPreferredResourceFormat

void setPreferredResourceFormat(ResourceFormat resourceFormat)

Override the default resource format of 'application/fhir+xml'. This format is used to set Accept and Content-Type headers for client requests.

Parameters:

resourceFormat -

getPreferredResourceFormat

String getPreferredResourceFormat()

Returns the resource format in effect.

Returns:

setPreferredFeedFormat

void setPreferredFeedFormat(FeedFormat feedFormat)

Override the default feed format of 'application/atom+xml'. This format is used to set Accept and Content-Type headers for client requests.

Parameters:

resourceFormat -

getPreferredFeedFormat

String getPreferredFeedFormat()

Returns the feed format in effect.

Returns:

getMaximumRecordCount

int getMaximumRecordCount()

Returns the maximum record count specified for list operations such as search and history.

Returns:

setMaximumRecordCount

void setMaximumRecordCount(int recordCount)

Sets the maximum record count for list operations such as history and search.

Parameters:

recordCount -

getConformanceStatement

Conformance getConformanceStatement()

Method returns a conformance statement for the system queried.

Returns:

getConformanceStatement

Conformance getConformanceStatement(boolean useOptionsVerb)

Method returns a conformance statement for the system queried.

Parameters:

useOptionsVerb - If 'true', use OPTION rather than GET.

Returns:

getConformanceStatementQuick

Conformance getConformanceStatementQuick()

Method returns a conformance statement for the system queried.

Returns:

getConformanceStatementQuick

Conformance getConformanceStatementQuick(boolean useOptionsVerb)

Method returns a conformance statement for the system queried.

Parameters:

useOptionsVerb - If 'true', use OPTION rather than GET.

Returns:

read

<T extends Resource> T read(Class<T> resource,
                            String id)

Read the current state of a resource.

Parameters:

resource -

id -

Returns:

vread

<T extends Resource> T vread(Class<T> resource,
                             String id,
                             String versionid)

Read the state of a specific version of the resource

Parameters:

resource -

id -

versionid -

Returns:

update

<T extends Resource> T update(Class<T> resourceClass,
                              T resource,
                              String id)

Update an existing resource by its id or create it if it is a new resource, not present on the server

Parameters:

resourceClass -

resource -

id -

Returns:

delete

<T extends Resource> boolean delete(Class<T> resourceClass,
                                    String id)

Delete the resource with the given ID.

Parameters:

resourceClass -

id -

Returns:

create

<T extends Resource> OperationOutcome create(Class<T> resourceClass,
                                             T resource)

Create a new resource with a server assigned id. Return the newly created resource with the id the server assigned.

Parameters:

resourceClass -

resource -

Returns:

history

<T extends Resource> Bundle history(Calendar lastUpdate,
                                    Class<T> resourceClass,
                                    String id)

Retrieve the update history for a resource with given id since last update time. Last update may be null TODO - ensure this is the case.

Parameters:

lastUpdate -

resourceClass -

id -

Returns:

history

<T extends Resource> Bundle history(Date lastUpdate,
                                    Class<T> resourceClass,
                                    String id)

history

<T extends Resource> Bundle history(Class<T> resource,
                                    String id)

Retrieve the entire update history for a resource with the given id. Last update may be null TODO - ensure this is the case.

Parameters:

lastUpdate -

resourceClass -

id -

Returns:

history

<T extends Resource> Bundle history(Calendar lastUpdate,
                                    Class<T> resourceClass)

Retrieve the update history for a resource type since the specified calendar date. Last update may be null TODO - ensure this is the case.

Parameters:

lastUpdate -

resourceClass -

id -

Returns:

history

<T extends Resource> Bundle history(Date lastUpdate,
                                    Class<T> resourceClass)

history

<T extends Resource> Bundle history(Class<T> resourceClass)

history

<T extends Resource> Bundle history(Calendar lastUpdate)

Retrieve the update history for all resource types since the specified calendar date. Last update may be null Note:

Parameters:

lastUpdate -

resourceClass -

id -

Returns:

history

<T extends Resource> Bundle history(Date lastUpdate)

history

<T extends Resource> Bundle history()

Retrieve the update history for all resource types since the start of server records. Note:

Parameters:

lastUpdate -

resourceClass -

id -

Returns:

validate

<T extends Resource> OperationOutcome validate(Class<T> resourceClass,
                                               T resource,
                                               String id)

Validate resource payload.

Parameters:

resourceClass -

resource -

id -

Returns:

search

<T extends Resource> Bundle search(Class<T> resourceClass,
                                   Map<String,String> params)

Return all results matching search query parameters for the given resource class.

Parameters:

resourceClass -

params -

Returns:

searchPost

<T extends Resource> Bundle searchPost(Class<T> resourceClass,
                                       T resource,
                                       Map<String,String> params)

Return all results matching search query parameters for the given resource class. This includes a resource as one of the parameters, and performs a post

Parameters:

resourceClass -

params -

Returns:

transaction

Bundle transaction(Bundle batch)

Update or create a set of resources

Parameters:

batch -

Returns:

fetchFeed

Bundle fetchFeed(String url)

Use this to follow a link found in a feed (e.g. paging in a search)

Parameters:

link - - the URL provided by the server

Returns:

the feed the server returns

expandValueset

ValueSet expandValueset(ValueSet source)
                 throws Exception

invoke the expand operation and pass the value set for expansion

Parameters:

source -

Returns:

Throws:

Exception

operateType

<T extends Resource> Parameters operateType(Class<T> resourceClass,
                                            String name,
                                            Parameters params)

Invoke an operation at the type level

Parameters:

resourceClass - - the type on which to perform the operation

name - - the name of the operation to invoke

params - - parameters to pass to the operation. If the parameters are all simple, a GET will be performed

Returns:

getAddress

String getAddress()

for debugging- the server address that the client is using

Returns: