O3 Framework API Reference
This page provides a reference for the APIs provided by the O3 framework. Its content is generated from comments in the source code.
Table of contents
API Functions
Breadcrumb Functions
Config Functions
Config Validation Functions
Context Functions
Date and Time Functions
Dynamic Loading Functions
Error Handling Functions
Extension Functions
Feature Flags Functions
Framework Functions
Navigation Functions
Offline Functions
Other Functions
Store Functions
Translation Functions
UI Functions
Utility Functions
Workspace Functions
API Type Aliases
CurrentPatient
Ƭ CurrentPatient: fhir.Patient | FetchResponse<fhir.Patient>
Defined in
packages/framework/esm-api/src/shared-api-objects/current-patient.ts:7
LoadedSessionStore
Ƭ LoadedSessionStore: Object
Type declaration
Name | Type |
|---|---|
|
|
|
|
Defined in
packages/framework/esm-api/src/shared-api-objects/current-user.ts:11
NullablePatient
Ƭ NullablePatient: fhir.Patient | null
Defined in
packages/framework/esm-react-utils/src/usePatient.ts:6
PatientUuid
Ƭ PatientUuid: string | null
Defined in
packages/framework/esm-api/src/shared-api-objects/current-patient.ts:20
SessionStore
Ƭ SessionStore: LoadedSessionStore | UnloadedSessionStore
Defined in
packages/framework/esm-api/src/shared-api-objects/current-user.ts:9
UnloadedSessionStore
Ƭ UnloadedSessionStore: Object
Type declaration
Name | Type |
|---|---|
|
|
|
|
Defined in
packages/framework/esm-api/src/shared-api-objects/current-user.ts:16
Context Type Aliases
ContextCallback
Ƭ ContextCallback<T>: (state: Readonly<T> | null | undefined) => void
Type parameters
Name | Type |
|---|---|
| extends |
Type declaration
▸ (state): void
Parameters
Name | Type |
|---|---|
|
|
Returns
void
Defined in
packages/framework/esm-context/src/context.ts:90
Date and Time Type Aliases
DateInput
Ƭ DateInput: string | number | Date
Defined in
packages/framework/esm-utils/src/omrs-dates.ts:26
FormatDateMode
Ƭ FormatDateMode: "standard" | "wide"
Defined in
packages/framework/esm-utils/src/omrs-dates.ts:140
FormatDateOptions
Ƭ FormatDateOptions: Object
Type declaration
Name | Type | Description |
|---|---|---|
|
| The calendar to use when formatting this date. |
|
| Whether to include the day number |
|
| The locale to use when formatting this date |
|
|
|
|
| Whether to include the month number |
|
| Disables the special handling of dates that are today. If false (the default), then dates that are today will be formatted as "Today" in the locale language. If true, then dates that are today will be formatted the same as all other dates. |
|
| The unicode numbering system to use |
|
| Whether the time should be included in the output always ( |
|
| Whether to include the year |
Defined in
packages/framework/esm-utils/src/omrs-dates.ts:142