FHIR resource

FhirResourceCopy Anchor Link

class FhirResource

Generic FHIR R4 on {baseUrl}/{fhirPath}; resources are decoded JSON.

Reached through ovok.fhir. Every request throws an OvokException subclass when it fails.

ConstructorsCopy Anchor Link

FhirResource.newCopy Anchor Link

FhirResource(HttpClient _http)

Built by Ovok; use ovok.fhir instead.

MethodsCopy Anchor Link

FhirResource.readCopy Anchor Link

Future<Map<String, dynamic>> read(String type, String id)

Reads one resource. Calls GET {fhirPath}/{type}/{id}.

Returns Future<Map<String, dynamic>>.

FhirResource.searchCopy Anchor Link

Future<Page<Map<String, dynamic>>> search(String type, [QueryParams params = const {}])

Searches type and returns the first page of matches.

Calls GET {fhirPath}/{type}?{params}. A list value repeats its parameter, which FHIR reads as AND; write 'a,b' for OR.

Returns Future<Page<Map<String, dynamic>>>.

FhirResource.searchOneCopy Anchor Link

Future<Map<String, dynamic>?> searchOne(String type, [QueryParams params = const {}])

Returns the first match of a search with _count=1, or null when none matches.

Returns Future<Map<String, dynamic>?>.

FhirResource.createCopy Anchor Link

Future<Map<String, dynamic>> create(Map<String, dynamic> resource, {String? ifNoneExist})

Creates resource. Calls POST {fhirPath}/{resourceType}.

ifNoneExist is sent as the If-None-Exist header. With ifNoneExist, a retry cannot create a duplicate, so the request is safe to repeat.

Returns Future<Map<String, dynamic>>.

FhirResource.updateCopy Anchor Link

Future<Map<String, dynamic>> update(Map<String, dynamic> resource)

Replaces resource. Calls PUT {fhirPath}/{resourceType}/{id}.

Throws OvokValidationException when resource has no id.

Returns Future<Map<String, dynamic>>.

FhirResource.patchCopy Anchor Link

Future<Map<String, dynamic>> patch(
  String type,
  String id,
  List<PatchOperation> operations,
)

Applies JSON Patch operations to one resource.

Calls PATCH {fhirPath}/{type}/{id}.

Returns Future<Map<String, dynamic>>.

FhirResource.deleteCopy Anchor Link

Future<void> delete(String type, String id)

Deletes one resource. Calls DELETE {fhirPath}/{type}/{id}.

Returns Future<void>.

FhirResource.batchCopy Anchor Link

Future<Map<String, dynamic>> batch(Map<String, dynamic> bundle)

Posts a batch or transaction bundle. Calls POST {fhirPath}.

Returns Future<Map<String, dynamic>>.