Struct Client

pub struct Client<Version = DefaultVersion>(/* private fields */);

FHIR REST Client.

Implementations

impl<V: FhirVersion> Client<V>

where (StatusCode, V::OperationOutcome): Into<Error>,

pub async fn capabilities(&self) -> Result<V::CapabilityStatement, Error>

Get the server’s capabilities. Fails if the respective FHIR version is not supported at all.

pub async fn read<R: AnyResource<V> + DeserializeOwned>( &self, id: &str, ) -> Result<Option<R>, Error>

Read the current version of a specific FHIR resource.

pub async fn read_version<R: AnyResource<V> + DeserializeOwned>( &self, id: &str, version_id: &str, ) -> Result<Option<R>, Error>

Read a specific version of a specific FHIR resource.

pub async fn read_referenced( &self, reference: &V::Reference, ) -> Result<V::Resource, Error>

Read the resource that is targeted in the reference.

pub async fn history<R>(&self, id: Option<&str>) -> Result<Page<V, R>, Error>

where R: AnyResource<V> + TryFrom<V::Resource, Error = WrongResourceType> + 'static, for<'a> &'a R: TryFrom<&'a V::Resource>,

Retrieve the history of the specified resource type or a specific resource.

pub async fn create<R: AnyResource<V> + Serialize + Send + Sync>( &self, resource: &R, ) -> Result<(String, Option<String>), Error>

Create a new FHIR resource on the FHIR server. Returns the resource ID and version ID.

pub async fn update<R: AnyResource<V> + Serialize + Send + Sync>( &self, resource: &R, conditional: bool, ) -> Result<(bool, String), Error>

Update a FHIR resource (or create it if it did not exist). If conditional update is selected, the resource is only updated if the version ID matches the expectations.

pub async fn delete( &self, resource_type: V::ResourceType, id: &str, ) -> Result<(), Error>

Delete a FHIR resource on the server.

pub async fn search_all( &self, queries: SearchParameters, ) -> Result<Page<V, V::Resource>, Error>

Search for FHIR resources of any type given the query parameters.

pub async fn search<R>( &self, queries: SearchParameters, ) -> Result<Page<V, R>, Error>

where R: AnyResource<V> + TryFrom<V::Resource, Error = WrongResourceType> + 'static, for<'a> &'a R: TryFrom<&'a V::Resource>,

Search for FHIR resources of a given type given the query parameters.

pub async fn search_custom<R, F>( &self, make_request: F, ) -> Result<Page<V, R>, Error>

where R: TryFrom<V::Resource> + Send + Sync + 'static, for<'a> &'a R: TryFrom<&'a V::Resource>, F: FnOnce(&Client) -> RequestBuilder + Send,

Search for FHIR resources via a custom request. This allows sending POST requests instead of GET when necessary. You can construct the request yourself to any URL and send any data. The endpoint is expected to send a FHIR-conform bundle.

You can specify the expected search entry type via the type parameter. This can be either the generic resource or a specific resource.

Keep in mind that mismatching origins to the base URL are rejected if not explicitly allowed via the flag in the builder ([ClientBuilder::allow_origin_mismatch]). Similarly, if the server responds with a different major FHIR version than the client is configured for, the response is rejected if not explicitly allowed via the flag in the builder ([ClientBuilder::allow_version_mismatch]).

pub fn patch_via_fhir<'a>( &self, resource_type: V::ResourceType, id: &'a str, ) -> PatchViaFhir<'a, V>

Begin building a patch request for a FHIR resource on the server via the FHIRPath Patch method.

pub fn patch_via_json<'a>( &self, resource_type: V::ResourceType, id: &'a str, ) -> PatchViaJson<'a, V>

Begin building a patch request for a FHIR resource on the server via the JSON Patch method.

pub fn batch(&self) -> BatchTransaction<V>

Start building a new batch request.

pub fn transaction(&self) -> BatchTransaction<V>

Start building a new transaction request.

impl Client<FhirR5>

pub async fn operation_encounter_everything( &self, id: &str, ) -> Result<Bundle, Error>

Operation $everything on Encounter, returning a Bundle with all resources for an Encounter record.

impl Client<FhirR5>

pub async fn operation_patient_everything( &self, id: &str, ) -> Result<Bundle, Error>

Operation $everything on Patient, returning a Bundle with all resources for an Patient record.

impl Client<FhirR5>

pub async fn operation_patient_match( &self, patient: Patient, only_certain: bool, count: i32, ) -> Result<Bundle, Error>

Operation $match on Patient, returning matches for Patient records based on a given incomplete Patient resource.

impl Client<FhirR5>

pub async fn operation_subscription_status( &self, id: &str, ) -> Result<SubscriptionStatus, Error>

Operation $status on Subscription, returning the SubcriptionStatus.

impl Client<FhirR5>

pub async fn operation_subscription_events( &self, id: &str, events_since: Option<i64>, events_until: Option<i64>, content: Option<SubscriptionPayloadContent>, ) -> Result<Bundle, Error>

Operation $events on Subscription, returning the previous notifications that were triggered by a topic.

impl<V: FhirVersion> Client<V>

pub fn builder() -> ClientBuilder<V>

Start building a new client with custom settings.

pub fn new(base_url: Url) -> Result<Self, Error>

Create a new client with default settings.

pub fn base_url(&self) -> &Url

Get the configured base URL.

pub fn request_settings(&self) -> RequestSettings

Get the request settings configured in this client.

pub fn set_request_settings(&self, settings: RequestSettings)

Set the request settings for this client. Be warned that this can be subject to race conditions. Prefer to use Self::patch_request_settings. Basically same as client.patch_request_settings(|_| new_settings).

pub fn patch_request_settings<F>(&self, mutator: F)

where F: FnOnce(RequestSettings) -> RequestSettings,

Patch the request settings atomically. Blocks all requests until the change to request settings is finished.

pub fn stu3(self) -> Client<FhirStu3>

Switch the client to STU3 mode.

pub fn r4b(self) -> Client<FhirR4B>

Switch the client to R4B mode.

pub fn r5(self) -> Client<FhirR5>

Switch the client to R5 mode.

pub async fn send_custom_request<F>( &self, make_request: F, ) -> Result<Response, Error>

where F: FnOnce(&Client) -> RequestBuilder + Send,

Send a custom HTTP request anywhere you want, but using this client’s internal HTTP machinery. The machinery includes automatic authentication if configured (auth_callback) and automatic retrying of requests on connection problems (as per request_settings).

Keep in mind that mismatching origins to the base URL are rejected if not explicitly allowed via the flag in the builder (ClientBuilder::allow_origin_mismatch). Similarly, if the server responds with a different major FHIR version than the client is configured for, the response is rejected if not explicitly allowed via the flag in the builder (ClientBuilder::allow_version_mismatch).

Trait Implementations

impl<V> Clone for Client<V>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<V> Debug for Client<V>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.