Patient resource

Generated reference for ovok_sdk: patient resource.

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

AppointmentsResource

class AppointmentsResource extends FhirRecordsResource

Appointment resources. Reached through ovok.patient.appointments.

Constructors

AppointmentsResource.new

AppointmentsResource(FhirResource fhir)

Built by PatientResource; use ovok.patient.appointments instead.

ParameterTypeKindDefault
fhirFhirResourcepositional

Methods

AppointmentsResource.create

Future<JsonMap> create(JsonMap appointment)

Creates appointment. Calls POST {fhirPath}/Appointment.

ParameterTypeKindDefault
appointmentJsonMappositional

Returns Future<Map<String, dynamic>>.

AppointmentsResource.update

Future<JsonMap> update(String id, JsonMap appointment)

Replaces the appointment id with appointment.

Calls PUT {fhirPath}/Appointment/{id}.

ParameterTypeKindDefault
idStringpositional
appointmentJsonMappositional

Returns Future<Map<String, dynamic>>.

FhirListResource

class FhirListResource

A listable FHIR resource type. Reached through ovok.patient, e.g. ovok.patient.slots.

Constructors

FhirListResource.new

FhirListResource(FhirResource _fhir, String _type)

Built by PatientResource; use its fields instead.

ParameterTypeKindDefault
_fhirFhirResourcepositional
_typeStringpositional

Methods

FhirListResource.list

Future<List<JsonMap>> list([QueryParams params = const {}])

Searches the type with params and returns the first page's resources.

ParameterTypeKindDefault
paramsQueryParamsoptional positionalconst {}

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

FhirRecordsResource

class FhirRecordsResource extends FhirListResource

A FHIR resource type that can also be read by id. Reached through ovok.patient.

Constructors

FhirRecordsResource.new

FhirRecordsResource(FhirResource _fhir, String _type)

Built by PatientResource; use its fields instead.

ParameterTypeKindDefault
_fhirFhirResourcepositional
_typeStringpositional

Methods

FhirRecordsResource.retrieve

Future<JsonMap> retrieve(String id)

Reads one resource by id.

ParameterTypeKindDefault
idStringpositional

Returns Future<Map<String, dynamic>>.

PatientResource

class PatientResource

FHIR reads for patient apps, plus a one-call dashboard.

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

Constructors

PatientResource.new

PatientResource(HttpClient http, FhirResource fhir)

Built by Ovok; use ovok.patient instead.

ParameterTypeKindDefault
httpHttpClientpositional
fhirFhirResourcepositional

Properties

PatientResource.appointments

final AppointmentsResource appointments

Appointment resources.

PatientResource.schedules

final FhirListResource schedules

Schedule resources.

PatientResource.slots

final FhirListResource slots

Slot resources.

PatientResource.measurements

final FhirRecordsResource measurements

Observation resources.

PatientResource.carePlans

final FhirRecordsResource carePlans

CarePlan resources.

PatientResource.questionnaires

final FhirRecordsResource questionnaires

Questionnaire resources.

PatientResource.questionnaireResponses

final FhirRecordsResource questionnaireResponses

QuestionnaireResponse resources.

PatientResource.devices

final FhirRecordsResource devices

Device resources.

PatientResource.notifications

final FhirRecordsResource notifications

CommunicationRequest resources.

Methods

PatientResource.latestObservations

Future<JsonMap> latestObservations([QueryParams params = const {}])

Fetches the latest observations per code. Calls GET fhir/Observation/$lastn.

Only the patient, max and code entries of params are sent.

ParameterTypeKindDefault
paramsQueryParamsoptional positionalconst {}

Returns Future<Map<String, dynamic>>.

PatientResource.dashboard

Future<JsonMap> dashboard([JsonMap params = const {}])

Fetches the signed-in user's profile, latest observations, measurement history and care plans in one call.

Calls GET auth/me, then the three searches in parallel. params may hold latestObservations, measurementHistory and carePlans maps; each defaults its patient to the signed-in user's.

ParameterTypeKindDefault
paramsJsonMapoptional positionalconst {}

Returns Future<Map<String, dynamic>>.

Last updated on

On this page