Measurement types

Generated reference for ovok_sdk: measurement types.

  • Stable unknown
  • Release candidate since 0.1.0-rc.4
  • Development since 0.1.0-dev.23+d339d81

BuildObservationsParams

class BuildObservationsParams

One measurement to turn into FHIR Observations.

Constructors

BuildObservationsParams.new

BuildObservationsParams({
  required JsonMap measurement,
  String? patientId,
  String? sourceId,
  DateTime? effectiveDateTime,
  JsonMap? device,
})

Describes measurement; the patient defaults to the signed-in one.

ParameterTypeKindDefault
measurementJsonMaprequired named
patientIdString?named
sourceIdString?named
effectiveDateTimeDateTime?named
deviceJsonMap?named

Properties

BuildObservationsParams.measurement

final JsonMap measurement

The measurement; measurementTypeKey names its type.

BuildObservationsParams.patientId

final String? patientId

The patient the observations are about; null for the signed-in patient.

BuildObservationsParams.sourceId

final String? sourceId

The id of the measurement's source.

BuildObservationsParams.effectiveDateTime

final DateTime? effectiveDateTime

When the measurement was taken; null for now.

BuildObservationsParams.device

final JsonMap? device

Metadata for the device that took the measurement.

SaveObservationsOptions

class SaveObservationsOptions

How observations are saved.

Constructors

SaveObservationsOptions.new

SaveObservationsOptions({List<String> identifierSystems = const [], bool replace = false})

Options; the defaults create each reading once.

ParameterTypeKindDefault
identifierSystemsList<String>namedconst []
replaceboolnamedfalse

Properties

SaveObservationsOptions.identifierSystems

final List<String> identifierSystems

Identifier systems that name a reading for good; the SDK's device-reading id always counts.

SaveObservationsOptions.replace

final bool replace

Write over the observation saved under the same reading identifiers, for a value that changes.

SaveObservationsResult

class SaveObservationsResult

What a save did: saved now, or queued to retry offline.

Constructors

SaveObservationsResult.saved

SaveObservationsResult.saved(JsonMap? response)

The observations were saved; response is the server's bundle.

ParameterTypeKindDefault
responseJsonMap?positional

SaveObservationsResult.queued

SaveObservationsResult.queued(String? queueId)

The save failed in a way worth retrying and waits in the offline queue.

ParameterTypeKindDefault
queueIdString?positional

Properties

SaveObservationsResult.status

final String status

saved or queued.

SaveObservationsResult.response

final JsonMap? response

The server's response bundle; null when queued.

SaveObservationsResult.queueId

final String? queueId

The offline queue entry's id; null when saved.

Last updated on

On this page