ca.uhn.fhir.rest.gclient

Interface ICreateTyped

All Superinterfaces:

IClientExecutable<ICreateTyped,MethodOutcome>

All Known Subinterfaces:

ICreateWithQueryTyped

public interface ICreateTyped
extends IClientExecutable<ICreateTyped,MethodOutcome>

Method Summary

Modifier and Type	Method and Description
ICreateWithQuery	conditional()
ICreateTyped	conditionalByUrl(String theSearchUrl) Specifies that the create should be performed as a conditional create against a given search URL.
ICreateTyped	prefer(PreferReturnEnum theReturn) Add a Prefer header to the request, which requests that the server include or suppress the resource body as a part of the result.
ICreateTyped	withId(IdDt theId) If you want the explicitly state an ID for your created resource, put that ID here.
ICreateTyped	withId(String theId) If you want the explicitly state an ID for your created resource, put that ID here.

Methods inherited from interface ca.uhn.fhir.rest.gclient.IClientExecutable

andLogRequestAndResponse, elementsSubset, encodedJson, encodedXml, execute, prettyPrint, summaryMode

Method Detail

conditional

ICreateWithQuery conditional()

Since:

HAPI 0.9 / FHIR DSTU 2

conditionalByUrl

ICreateTyped conditionalByUrl(String theSearchUrl)

Specifies that the create should be performed as a conditional create against a given search URL.

Parameters:

theSearchUrl - The search URL to use. The format of this URL should be of the form [ResourceType]?[Parameters], for example: Patient?name=Smith&identifier=13.2.4.11.4%7C847366

Since:

HAPI 0.9 / FHIR DSTU 2

prefer

ICreateTyped prefer(PreferReturnEnum theReturn)

Add a Prefer header to the request, which requests that the server include or suppress the resource body as a part of the result. If a resource is returned by the server it will be parsed an accessible to the client via MethodOutcome.getResource()

Since:

HAPI 1.1

withId

ICreateTyped withId(IdDt theId)

If you want the explicitly state an ID for your created resource, put that ID here. You generally do not need to invoke this method, so that the server will assign the ID itself.

Note that creating a resource by ID is no longer supported as of FHIR DSTU2. You should use the IGenericClient.update() operation to create-by-ID in DSTU2.

withId

ICreateTyped withId(String theId)

If you want the explicitly state an ID for your created resource, put that ID here. You generally do not need to invoke this method, so that the server will assign the ID itself.

Note that creating a resource by ID is no longer supported as of FHIR DSTU2. You should use the IGenericClient.update() operation to create-by-ID in DSTU2.