@healthcloudai/hc-sdk 3.31.2 → 3.33.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +106 -0
- package/dist/index.d.cts +2615 -17
- package/dist/index.d.ts +2615 -17
- package/dist/index.js +106 -0
- package/docs/clients/PatientClient.md +4 -0
- package/docs/clients/ProviderClient.md +9 -0
- package/docs/docs-manifest.json +42 -3
- package/docs/examples/index.md +13 -0
- package/docs/index.md +13 -0
- package/docs/models/CarePlan.md +28 -0
- package/docs/models/CarePlanActivity.md +20 -0
- package/docs/models/CarePlanGoal.md +23 -0
- package/docs/models/CarePlanProblem.md +23 -0
- package/docs/models/CarePlanRelated.md +19 -0
- package/docs/models/CareTeamLanguage.md +19 -0
- package/docs/models/CareTeamMember.md +27 -0
- package/docs/models/CareTeamResponse.md +18 -0
- package/docs/models/CareTeamSpecialty.md +19 -0
- package/docs/models/DeviceCatalogItem.md +24 -0
- package/docs/models/DeviceCatalogResponse.md +18 -0
- package/docs/models/EnsureAppointmentEncounterResponse.md +20 -0
- package/docs/models/ListPatientCarePlansResponse.md +18 -0
- package/docs/models/ListPatientDevicesResponse.md +18 -0
- package/docs/models/OrderPatientDeviceRequest.md +25 -0
- package/docs/models/PatientCarePlanResponse.md +18 -0
- package/docs/models/PatientDevice.md +38 -0
- package/docs/models/PatientEncounterSummary.md +23 -0
- package/docs/models/PatientVitals.md +20 -0
- package/docs/models/ProviderCarePlanResponse.md +18 -0
- package/docs/models/ProviderMyAppointment.md +26 -0
- package/docs/models/ProviderMyAppointmentsResponse.md +19 -0
- package/docs/models/ProviderMyPatientsVitalsResponse.md +21 -0
- package/docs/models/UpdateCarePlanRequest.md +22 -0
- package/docs/models/VitalsSeries.md +26 -0
- package/docs/models/VitalsWindow.md +19 -0
- package/docs/models/index.md +26 -0
- package/docs/operations/patient.getCareTeam.md +130 -0
- package/docs/operations/patient.getEncounterCarePlan.md +158 -0
- package/docs/operations/patient.listCarePlans.md +144 -0
- package/docs/operations/patient.listDevices.md +125 -0
- package/docs/operations/provider.cancelPatientDevice.md +135 -0
- package/docs/operations/provider.ensureAppointmentEncounter.md +150 -0
- package/docs/operations/provider.getEncounterCarePlan.md +162 -0
- package/docs/operations/provider.listDeviceCatalog.md +111 -0
- package/docs/operations/provider.listMyAppointments.md +165 -0
- package/docs/operations/provider.listMyPatientsVitals.md +178 -0
- package/docs/operations/provider.listPatientDevices.md +137 -0
- package/docs/operations/provider.orderPatientDevice.md +178 -0
- package/docs/operations/provider.updateEncounterCarePlan.md +207 -0
- package/package.json +1 -1
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# CarePlanProblem
|
|
2
|
+
|
|
3
|
+
Model ID: `CarePlanProblem`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `description` | `string` | Yes | | | | No | The identified problem, in words the patient can read. |
|
|
14
|
+
| `icd10_code` | `string|null` | No | | | | Yes | ICD-10-CM code from GET /icd10, when the problem has one. |
|
|
15
|
+
| `icd10_display` | `string|null` | No | | | | Yes | ICD-10-CM description of the code. Always set by the server. |
|
|
16
|
+
| `notes` | `string|null` | No | | | | Yes | Patient-visible notes about the problem. |
|
|
17
|
+
| `priority` | `string|null` | No | | | | Yes | high, medium or low, when set. |
|
|
18
|
+
| `problem_id` | `string` | Yes | | | | No | Stable id of the problem inside the plan. Send it back to keep the problem. |
|
|
19
|
+
| `status` | `string` | No | | active, resolved, inactive | `"active"` | No | active, resolved or inactive. |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# CarePlanRelated
|
|
2
|
+
|
|
3
|
+
Model ID: `CarePlanRelated`
|
|
4
|
+
|
|
5
|
+
The encounter's other records, so one call shows the whole picture.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `devices` | `array` | Yes | | | | No | Devices ordered or added for the encounter. |
|
|
14
|
+
| `diagnoses` | `array` | Yes | | | | No | The encounter's diagnoses. |
|
|
15
|
+
| `medications` | `array` | Yes | | | | No | The encounter's medications. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# CareTeamLanguage
|
|
2
|
+
|
|
3
|
+
Model ID: `CareTeamLanguage`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `code` | `string` | Yes | | | | No | BCP-47 language tag, e.g. en, es. |
|
|
14
|
+
| `display` | `string|null` | No | | | | Yes | Human-readable language name, when known. |
|
|
15
|
+
| `primary` | `boolean` | No | | | `false` | No | True for the provider's preferred language. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# CareTeamMember
|
|
2
|
+
|
|
3
|
+
Model ID: `CareTeamMember`
|
|
4
|
+
|
|
5
|
+
One provider the patient has had an encounter with. Contact details, identifiers and licences are never included.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `bio` | `string|null` | No | | | | Yes | Short biography written by the provider. Null until the provider has written one. |
|
|
14
|
+
| `credentials` | `array` | No | | | | No | Credential codes such as MD or NP, the primary credential first. |
|
|
15
|
+
| `display_name` | `string` | Yes | | | | No | Patient-facing name, e.g. 'Dr. Elena Chen'. |
|
|
16
|
+
| `encounter_count` | `integer` | Yes | | | | No | Number of the patient's encounters the provider took part in. |
|
|
17
|
+
| `first_encounter_date` | `string|null` | No | | | | Yes | ISO 8601 start of the earliest encounter with the patient. |
|
|
18
|
+
| `languages_spoken` | array of [`CareTeamLanguage`](./CareTeamLanguage.md) | No | | | | No | Languages the provider speaks, preferred language first. |
|
|
19
|
+
| `last_encounter_date` | `string|null` | No | | | | Yes | ISO 8601 start of the latest encounter with the patient. |
|
|
20
|
+
| `organization_name` | `string|null` | No | | | | Yes | Affiliated practice or organization, when known. |
|
|
21
|
+
| `practitioner_id` | `string` | Yes | | | | No | FHIR Practitioner resource id. |
|
|
22
|
+
| `roles` | `array` | No | | | | No | Care roles, such as physician or nurse practitioner. |
|
|
23
|
+
| `specialties` | array of [`CareTeamSpecialty`](./CareTeamSpecialty.md) | No | | | | No | Specialties, primary first. |
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# CareTeamResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `CareTeamResponse`
|
|
4
|
+
|
|
5
|
+
GET /patients/care-team: providers on the caller's encounters, most recent first.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `members` | array of [`CareTeamMember`](./CareTeamMember.md) | Yes | | | | No | Providers, most recent encounter first (at most 50). |
|
|
14
|
+
| `total` | `integer` | Yes | | | | No | Number of members returned. |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# CareTeamSpecialty
|
|
2
|
+
|
|
3
|
+
Model ID: `CareTeamSpecialty`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `code` | `string` | Yes | | | | No | Specialty code (NUCC taxonomy or SNOMED). |
|
|
14
|
+
| `display` | `string` | Yes | | | | No | Human-readable specialty name. |
|
|
15
|
+
| `primary` | `boolean` | No | | | `false` | No | True when this is the provider's primary specialty. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# DeviceCatalogItem
|
|
2
|
+
|
|
3
|
+
Model ID: `DeviceCatalogItem`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `id` | `integer|null` | No | | | | Yes | Impilo item id. Pass it as `catalog_item_id` to order the device. |
|
|
14
|
+
| `item_class` | `string|null` | No | | | | Yes | Device class, e.g. CELLULAR or BLUETOOTH. |
|
|
15
|
+
| `manufacturer` | `string|null` | No | | | | Yes | Manufacturer name. |
|
|
16
|
+
| `model` | `string|null` | No | | | | Yes | Device model. |
|
|
17
|
+
| `name` | `string|null` | No | | | | Yes | Device name. |
|
|
18
|
+
| `orderable` | `boolean|null` | No | | | | Yes | False when the item cannot be ordered. |
|
|
19
|
+
| `reading_type` | `string|null` | No | | | | Yes | Type of reading the device captures. |
|
|
20
|
+
| `sku` | `string|null` | No | | | | Yes | Stock keeping unit. |
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# DeviceCatalogResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `DeviceCatalogResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `devices` | array of [`DeviceCatalogItem`](./DeviceCatalogItem.md) | Yes | | | | No | Orderable device types. |
|
|
14
|
+
| `total` | `integer` | Yes | | | | No | Number of device types returned. |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# EnsureAppointmentEncounterResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `EnsureAppointmentEncounterResponse`
|
|
4
|
+
|
|
5
|
+
The encounter that belongs to a video visit on an appointment.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `created` | `boolean` | Yes | | | | No | True when this call created the encounter; false when it already existed. |
|
|
14
|
+
| `encounter_id` | `string` | Yes | | | | No | FHIR id of the encounter to open under the video call. |
|
|
15
|
+
| `patient_id` | `string` | Yes | | | | No | FHIR Patient id of the encounter's subject. |
|
|
16
|
+
| `status` | `string` | Yes | | | | No | Encounter status: planned, arrived, triaged, in-progress, onleave, finished, cancelled, entered-in-error or unknown. A finished (signed) encounter is read-only. |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# ListPatientCarePlansResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ListPatientCarePlansResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `care_plans` | array of [`CarePlan`](./CarePlan.md) | Yes | | | | No | The caller's active and completed plans, newest first. |
|
|
14
|
+
| `total` | `integer` | Yes | | | | No | Number of plans returned. |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# ListPatientDevicesResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ListPatientDevicesResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `devices` | array of [`PatientDevice`](./PatientDevice.md) | Yes | | | | No | Devices, newest first. |
|
|
14
|
+
| `total` | `integer` | Yes | | | | No | Number of devices returned. |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# OrderPatientDeviceRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `OrderPatientDeviceRequest`
|
|
4
|
+
|
|
5
|
+
Order a catalog device for a patient (`kind: order`), or record one the patient already has (`kind: add`).
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `catalog_item_id` | `integer|null` | No | | | | Yes | Impilo item id from the device catalog. Required to order; optional for add. |
|
|
14
|
+
| `encounter_id` | `string|null` | No | | | | Yes | Encounter the device relates to. It must belong to the patient. |
|
|
15
|
+
| `identifier` | `string|null` | No | | | | Yes | Serial number or device identifier, for an added device. |
|
|
16
|
+
| `instructions` | `string|null` | No | | | | Yes | Instructions for the patient. |
|
|
17
|
+
| `kind` | `string` | No | | order, add | `"order"` | No | `order` places an order; `add` records an existing device. |
|
|
18
|
+
| `manufacturer` | `string|null` | No | | | | Yes | Manufacturer name, for an added device. |
|
|
19
|
+
| `model` | `string|null` | No | | | | Yes | Device model, for an added device. |
|
|
20
|
+
| `name` | `string|null` | No | | | | Yes | Device name. Required to add a device without a catalog item. |
|
|
21
|
+
| `reason` | `string|null` | No | | | | Yes | Why the device is needed. |
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# PatientCarePlanResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `PatientCarePlanResponse`
|
|
4
|
+
|
|
5
|
+
GET /encounters/{id}/care-plan for the patient: the encounter and its active care plan.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `care_plan` | [`CarePlan`](./CarePlan.md) | Yes | | | | No | The care plan. |
|
|
14
|
+
| `encounter` | [`PatientEncounterSummary`](./PatientEncounterSummary.md) | Yes | | | | No | The encounter the plan belongs to. |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# PatientDevice
|
|
2
|
+
|
|
3
|
+
Model ID: `PatientDevice`
|
|
4
|
+
|
|
5
|
+
A device ordered or added by a provider.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `device_id` | `string` | Yes | | | | No | DeviceRequest resource id. |
|
|
14
|
+
| `device_identifier` | `string|null` | No | | | | Yes | Identifier of the physical device once it is assigned. |
|
|
15
|
+
| `encounter_id` | `string|null` | No | | | | Yes | Encounter the device relates to. |
|
|
16
|
+
| `fulfillment` | `string` | Yes | | ordered, added | | No | `ordered` through the catalog, or `added` by the provider. |
|
|
17
|
+
| `fulfillment_status` | `string|null` | No | | | | Yes | Live status from the device vendor, such as the order or device state. Null when unknown. |
|
|
18
|
+
| `identifier` | `string|null` | No | | | | Yes | Serial number or device identifier. |
|
|
19
|
+
| `impilo_item_id` | `integer|null` | No | | | | Yes | Impilo item id, for a catalog device. |
|
|
20
|
+
| `impilo_order_id` | `integer|null` | No | | | | Yes | Impilo order id, for an ordered device. |
|
|
21
|
+
| `instructions` | `string|null` | No | | | | Yes | Instructions for the patient. |
|
|
22
|
+
| `item_class` | `string|null` | No | | | | Yes | Device class. |
|
|
23
|
+
| `last_reading_at` | `string|null` | No | | | | Yes | Time of the device's last health check or reading, when known. |
|
|
24
|
+
| `manufacturer` | `string|null` | No | | | | Yes | Manufacturer name. |
|
|
25
|
+
| `model` | `string|null` | No | | | | Yes | Device model. |
|
|
26
|
+
| `name` | `string|null` | No | | | | Yes | Device name. |
|
|
27
|
+
| `patient_id` | `string` | Yes | | | | No | FHIR Patient resource id. |
|
|
28
|
+
| `reading_type` | `string|null` | No | | | | Yes | Type of reading the device captures. |
|
|
29
|
+
| `reason` | `string|null` | No | | | | Yes | Why the device is needed. |
|
|
30
|
+
| `requested_at` | `string|null` | No | | | | Yes | ISO 8601 time the request was made. |
|
|
31
|
+
| `requested_by` | `string|null` | No | | | | Yes | FHIR Practitioner id of the provider who ordered or added it. |
|
|
32
|
+
| `sku` | `string|null` | No | | | | Yes | Stock keeping unit. |
|
|
33
|
+
| `status` | `string` | Yes | | ordered, added, cancelled | | No | Request status. |
|
|
34
|
+
| `status_source` | `string` | No | | fhir, impilo, unavailable | `"fhir"` | No | Where `fulfillment_status` came from. `unavailable` when the vendor could not be reached. |
|
|
35
|
+
|
|
36
|
+
## Example
|
|
37
|
+
|
|
38
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# PatientEncounterSummary
|
|
2
|
+
|
|
3
|
+
Model ID: `PatientEncounterSummary`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `date` | `string|null` | No | | | | Yes | ISO 8601 start (or creation) time of the encounter. |
|
|
14
|
+
| `diagnoses` | `array` | Yes | | | | No | Diagnosis descriptions on the encounter. |
|
|
15
|
+
| `encounter_id` | `string` | Yes | | | | No | FHIR Encounter resource id. |
|
|
16
|
+
| `providers` | `array` | Yes | | | | No | Display names of the providers on the encounter. |
|
|
17
|
+
| `reason_display` | `string|null` | No | | | | Yes | Reason for the visit, when recorded. |
|
|
18
|
+
| `status` | `string` | Yes | | | | No | Encounter status. |
|
|
19
|
+
| `type_display` | `string|null` | No | | | | Yes | Encounter type, when recorded. |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PatientVitals
|
|
2
|
+
|
|
3
|
+
Model ID: `PatientVitals`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `last_reading_at` | `string|null` | No | | | | Yes | Time of the patient's most recent reading in the window. |
|
|
14
|
+
| `patient` | [`ProviderPatientSummary`](./ProviderPatientSummary.md) | No | | | | Yes | Demographic summary, when the patient is readable. |
|
|
15
|
+
| `patient_id` | `string` | Yes | | | | No | FHIR Patient resource ID. |
|
|
16
|
+
| `series` | array of [`VitalsSeries`](./VitalsSeries.md) | Yes | | | | No | One series per metric that has readings, in a fixed metric order. |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# ProviderCarePlanResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderCarePlanResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `care_plan` | [`CarePlan`](./CarePlan.md) | No | | | | Yes | The plan, or null when none has been saved yet. |
|
|
14
|
+
| `related` | [`CarePlanRelated`](./CarePlanRelated.md) | No | | | | Yes | Present with `?include=related`. |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# ProviderMyAppointment
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderMyAppointment`
|
|
4
|
+
|
|
5
|
+
One appointment of a patient the calling provider cares for, with what the Schedule needs to open a video visit.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `appointment_id` | `string` | Yes | | | | No | Stable appointment identifier; Athena-authoritative tenants return Athena's native appointment ID. |
|
|
14
|
+
| `encounter_id` | `string|null` | No | | | | Yes | The caller's most recent open encounter for this patient, when one exists. Opens the encounter from the Schedule. |
|
|
15
|
+
| `end` | `string|null` | No | | | | Yes | Appointment end in ISO 8601 date-time format. |
|
|
16
|
+
| `modality` | `string` | Yes | | telehealth, in_person | | No | `telehealth` when the appointment is a video visit (a HealthCloud video link exists, or Athena's telehealth appointment type), otherwise `in_person`. |
|
|
17
|
+
| `patient` | [`ProviderPatientSummary`](./ProviderPatientSummary.md) | No | | | | Yes | Demographic snapshot (first/last name, gender, DOB, address, phone) of the associated patient. On list responses, only the first 20 items carry a summary; by-ID responses always include it when readable. |
|
|
18
|
+
| `patient_id` | `string` | Yes | | | | No | FHIR Patient resource ID associated with the appointment. |
|
|
19
|
+
| `provider_id` | `string|null` | No | | | | Yes | FHIR Practitioner resource ID, when available. |
|
|
20
|
+
| `start` | `string|null` | No | | | | Yes | Appointment start in ISO 8601 date-time format. |
|
|
21
|
+
| `status` | `string` | Yes | | scheduled, confirmed, cancelled, completed, no_show | | No | Normalized appointment lifecycle status. |
|
|
22
|
+
| `telehealth_link` | `string|null` | No | | | | Yes | Video-visit link, when one has been created for this appointment. |
|
|
23
|
+
|
|
24
|
+
## Example
|
|
25
|
+
|
|
26
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ProviderMyAppointmentsResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderMyAppointmentsResponse`
|
|
4
|
+
|
|
5
|
+
GET /appointments/mine: upcoming appointments of the caller's own patients.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `appointments` | array of [`ProviderMyAppointment`](./ProviderMyAppointment.md) | Yes | | | | No | Scheduled and confirmed appointments in the window, in start order, each with a `patient` summary when the patient is readable. |
|
|
14
|
+
| `total` | `integer` | Yes | | | | No | Number of appointments returned. |
|
|
15
|
+
| `truncated` | `boolean` | No | | | `false` | No | True when the source returned its maximum number of appointments before they were narrowed to the caller's patients, so some may be missing. Narrow the window. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# ProviderMyPatientsVitalsResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderMyPatientsVitalsResponse`
|
|
4
|
+
|
|
5
|
+
GET /vitals/mine: vital-sign time series of the patients on the caller's encounters, grouped by patient.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `next_page_token` | `string|null` | No | | | | Yes | Pass as `page_token` for the next page of patients. |
|
|
14
|
+
| `patients` | array of [`PatientVitals`](./PatientVitals.md) | Yes | | | | No | Patients that have readings in the window, most recent reading first. Patients without readings are left out. |
|
|
15
|
+
| `total_patients` | `integer` | Yes | | | | No | Number of patients returned in this page. |
|
|
16
|
+
| `truncated` | `boolean` | No | | | `false` | No | True when the readings scan hit its safety limit; some readings may be missing. |
|
|
17
|
+
| `window` | [`VitalsWindow`](./VitalsWindow.md) | Yes | | | | No | The window the readings are from. |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# UpdateCarePlanRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `UpdateCarePlanRequest`
|
|
4
|
+
|
|
5
|
+
Create or replace the encounter's care plan. Problems, goals and activities not sent are removed.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `activities` | `array` | No | | | | No | Activities: {activity_id?, type, description, reference_id?}. At most 30. |
|
|
14
|
+
| `goals` | `array` | No | | | | No | Goals: {goal_id?, description, expected_outcome, target_date?, problem_ids?, status?, progress_note?}. At most 20. |
|
|
15
|
+
| `problems` | `array` | No | | | | No | Problems: {problem_id?, description, icd10_code?, status?, priority?, notes?}. At most 20. |
|
|
16
|
+
| `status` | `string` | No | | draft, active, completed | `"draft"` | No | draft keeps the plan from the patient; active or completed shows it. |
|
|
17
|
+
| `summary` | `string|null` | No | | | | Yes | Patient-readable summary. |
|
|
18
|
+
| `title` | `string|null` | No | | | | Yes | Plan title. |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# VitalsSeries
|
|
2
|
+
|
|
3
|
+
Model ID: `VitalsSeries`
|
|
4
|
+
|
|
5
|
+
One metric of one patient as a chart-ready time series.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `bucket` | `string` | Yes | | raw, hour, day | | No | `raw` is one point per reading. `hour` or `day` is one point per bucket: each field is the bucket average, with `<field>_min`, `<field>_max` and `count`. |
|
|
14
|
+
| `count` | `integer` | Yes | | | | No | Number of readings in the window. |
|
|
15
|
+
| `fields` | `array` | Yes | | | | No | The value fields of each point: [`value`], or [`systolic`, `diastolic`] for blood pressure. |
|
|
16
|
+
| `label` | `string` | Yes | | | | No | Display name of the metric. |
|
|
17
|
+
| `latest` | `object|null` | No | | | | Yes | The most recent reading in the window: `t` and the fields. |
|
|
18
|
+
| `metric` | `string` | Yes | | | | No | blood_pressure, heart_rate, respiratory_rate, spo2, temperature, weight, glucose, fev1, fvc, pef or fev1_fvc_ratio. |
|
|
19
|
+
| `points` | `array` | Yes | | | | No | Ascending by `t` (ISO 8601 UTC). Each point has `t` and one number per field, so it can be passed straight to a chart. |
|
|
20
|
+
| `points_truncated` | `boolean` | No | | | `false` | No | True when only the newest 500 points are returned. Narrow the window or use a bucket. |
|
|
21
|
+
| `summary` | `object` | Yes | | | | No | Per field `min`, `max` and `avg` over every reading in the window (not over buckets). |
|
|
22
|
+
| `unit` | `string` | Yes | | | | No | The unit every value of this metric is in (values are converted to it). |
|
|
23
|
+
|
|
24
|
+
## Example
|
|
25
|
+
|
|
26
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# VitalsWindow
|
|
2
|
+
|
|
3
|
+
Model ID: `VitalsWindow`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `end` | `string` | Yes | | | | No | Last day of the window, YYYY-MM-DD. |
|
|
14
|
+
| `start` | `string` | Yes | | | | No | First day of the window, YYYY-MM-DD. |
|
|
15
|
+
| `timezone` | `string` | No | | | `"UTC"` | No | All point times are UTC. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
package/docs/models/index.md
CHANGED
|
@@ -389,6 +389,11 @@
|
|
|
389
389
|
- [CancelAppointmentRequest](CancelAppointmentRequest.md)
|
|
390
390
|
- [CancelTestOrderResponse](CancelTestOrderResponse.md)
|
|
391
391
|
- [CapturedTestImageResponse](CapturedTestImageResponse.md)
|
|
392
|
+
- [CarePlan](CarePlan.md)
|
|
393
|
+
- [CarePlanActivity](CarePlanActivity.md)
|
|
394
|
+
- [CarePlanGoal](CarePlanGoal.md)
|
|
395
|
+
- [CarePlanProblem](CarePlanProblem.md)
|
|
396
|
+
- [CarePlanRelated](CarePlanRelated.md)
|
|
392
397
|
- [CarequalityDiscoverPatientRequest](CarequalityDiscoverPatientRequest.md)
|
|
393
398
|
- [CarequalityDiscoverPatientResponse](CarequalityDiscoverPatientResponse.md)
|
|
394
399
|
- [CarequalityImportPatientDocumentsRequest](CarequalityImportPatientDocumentsRequest.md)
|
|
@@ -398,6 +403,10 @@
|
|
|
398
403
|
- [CarequalityRetrieveDocumentsRequest](CarequalityRetrieveDocumentsRequest.md)
|
|
399
404
|
- [CarequalityRetrieveDocumentsResponse](CarequalityRetrieveDocumentsResponse.md)
|
|
400
405
|
- [CareSession](CareSession.md)
|
|
406
|
+
- [CareTeamLanguage](CareTeamLanguage.md)
|
|
407
|
+
- [CareTeamMember](CareTeamMember.md)
|
|
408
|
+
- [CareTeamResponse](CareTeamResponse.md)
|
|
409
|
+
- [CareTeamSpecialty](CareTeamSpecialty.md)
|
|
401
410
|
- [CatalogItemKind](CatalogItemKind.md)
|
|
402
411
|
- [CatalogVendor](CatalogVendor.md)
|
|
403
412
|
- [ChatMessageRecord](ChatMessageRecord.md)
|
|
@@ -490,6 +499,8 @@
|
|
|
490
499
|
- [Dependent](Dependent.md)
|
|
491
500
|
- [DependentRelationship](DependentRelationship.md)
|
|
492
501
|
- [DependentResponse](DependentResponse.md)
|
|
502
|
+
- [DeviceCatalogItem](DeviceCatalogItem.md)
|
|
503
|
+
- [DeviceCatalogResponse](DeviceCatalogResponse.md)
|
|
493
504
|
- [EncounterDiagnosisInput](DiagnosisInput.md)
|
|
494
505
|
- [Coding](diagnostics.Coding.md)
|
|
495
506
|
- [diagnostics.ConnectResponse](diagnostics.ConnectResponse.md)
|
|
@@ -578,6 +589,7 @@
|
|
|
578
589
|
- [EncounterOperationResponse](EncounterOperationResponse.md)
|
|
579
590
|
- [EncounterSections](EncounterSections.md)
|
|
580
591
|
- [EncounterStatus](EncounterStatus.md)
|
|
592
|
+
- [EnsureAppointmentEncounterResponse](EnsureAppointmentEncounterResponse.md)
|
|
581
593
|
- [Ethnicity](Ethnicity.md)
|
|
582
594
|
- [ExerciseFrequency](ExerciseFrequency.md)
|
|
583
595
|
- [FaceMatchRequest](FaceMatchRequest.md)
|
|
@@ -1290,6 +1302,8 @@
|
|
|
1290
1302
|
- [ObservationListResponse](ListObservationsResponse.md)
|
|
1291
1303
|
- [ListOrderItemsResponse](ListOrderItemsResponse.md)
|
|
1292
1304
|
- [ListPatientAppointmentsResponse](ListPatientAppointmentsResponse.md)
|
|
1305
|
+
- [ListPatientCarePlansResponse](ListPatientCarePlansResponse.md)
|
|
1306
|
+
- [ListPatientDevicesResponse](ListPatientDevicesResponse.md)
|
|
1293
1307
|
- [FieldAgentListPatientsResponse](ListPatientsResponse.md)
|
|
1294
1308
|
- [ListPolicyDocumentsResponse](ListPolicyDocumentsResponse.md)
|
|
1295
1309
|
- [ListProceduresResponse](ListProceduresResponse.md)
|
|
@@ -1377,6 +1391,7 @@
|
|
|
1377
1391
|
- [OpenAIUpdateAssistantResponse](OpenAIUpdateAssistantResponse.md)
|
|
1378
1392
|
- [OpenLoopVitalsMirrorResult](OpenLoopVitalsMirrorResult.md)
|
|
1379
1393
|
- [OrderItem](OrderItem.md)
|
|
1394
|
+
- [OrderPatientDeviceRequest](OrderPatientDeviceRequest.md)
|
|
1380
1395
|
- [OrderPriority](OrderPriority.md)
|
|
1381
1396
|
- [OrderStatus](OrderStatus.md)
|
|
1382
1397
|
- [OuraBuildAuthorizationUrlRequest](OuraBuildAuthorizationUrlRequest.md)
|
|
@@ -1456,13 +1471,17 @@
|
|
|
1456
1471
|
- [VerifySmsRequest](patient.VerifySmsRequest.md)
|
|
1457
1472
|
- [VerifySmsResponse](patient.VerifySmsResponse.md)
|
|
1458
1473
|
- [PatientAlertsResponse](PatientAlertsResponse.md)
|
|
1474
|
+
- [PatientCarePlanResponse](PatientCarePlanResponse.md)
|
|
1459
1475
|
- [PatientDemographics](PatientDemographics.md)
|
|
1476
|
+
- [PatientDevice](PatientDevice.md)
|
|
1477
|
+
- [PatientEncounterSummary](PatientEncounterSummary.md)
|
|
1460
1478
|
- [PatientIntakeRequest](PatientIntakeRequest.md)
|
|
1461
1479
|
- [PatientIntakeResponse](PatientIntakeResponse.md)
|
|
1462
1480
|
- [PatientLink](PatientLink.md)
|
|
1463
1481
|
- [PatientLinkType](PatientLinkType.md)
|
|
1464
1482
|
- [PatientName](PatientName.md)
|
|
1465
1483
|
- [PatientSidebar](PatientSidebar.md)
|
|
1484
|
+
- [PatientVitals](PatientVitals.md)
|
|
1466
1485
|
- [PaymentOperationResult](PaymentOperationResult.md)
|
|
1467
1486
|
- [PeakFlowReading](PeakFlowReading.md)
|
|
1468
1487
|
- [Person](Person.md)
|
|
@@ -1577,6 +1596,7 @@
|
|
|
1577
1596
|
- [ProviderAppointment](ProviderAppointment.md)
|
|
1578
1597
|
- [ProviderAppointmentResponse](ProviderAppointmentResponse.md)
|
|
1579
1598
|
- [ProviderAppointmentsResponse](ProviderAppointmentsResponse.md)
|
|
1599
|
+
- [ProviderCarePlanResponse](ProviderCarePlanResponse.md)
|
|
1580
1600
|
- [ProviderContactPoint](ProviderContactPoint.md)
|
|
1581
1601
|
- [ProviderCredential](ProviderCredential.md)
|
|
1582
1602
|
- [ProviderDriversLicenseSummary](ProviderDriversLicenseSummary.md)
|
|
@@ -1600,6 +1620,9 @@
|
|
|
1600
1620
|
- [ProviderLocationListResponse](ProviderLocationListResponse.md)
|
|
1601
1621
|
- [ProviderLocationPatchRequest](ProviderLocationPatchRequest.md)
|
|
1602
1622
|
- [ProviderLocationRequest](ProviderLocationRequest.md)
|
|
1623
|
+
- [ProviderMyAppointment](ProviderMyAppointment.md)
|
|
1624
|
+
- [ProviderMyAppointmentsResponse](ProviderMyAppointmentsResponse.md)
|
|
1625
|
+
- [ProviderMyPatientsVitalsResponse](ProviderMyPatientsVitalsResponse.md)
|
|
1603
1626
|
- [ProviderOnboardingStatus](ProviderOnboardingStatus.md)
|
|
1604
1627
|
- [ProviderPatientAddress](ProviderPatientAddress.md)
|
|
1605
1628
|
- [ProviderPatientInsuranceResponse](ProviderPatientInsuranceResponse.md)
|
|
@@ -2029,6 +2052,7 @@
|
|
|
2029
2052
|
- [UpdateAddressRequest](UpdateAddressRequest.md)
|
|
2030
2053
|
- [UpdateAddressResponse](UpdateAddressResponse.md)
|
|
2031
2054
|
- [UpdateAgentRequest](UpdateAgentRequest.md)
|
|
2055
|
+
- [UpdateCarePlanRequest](UpdateCarePlanRequest.md)
|
|
2032
2056
|
- [UpdateCommunicationConsentRequest](UpdateCommunicationConsentRequest.md)
|
|
2033
2057
|
- [UpdateDemographicsRequest](UpdateDemographicsRequest.md)
|
|
2034
2058
|
- [UpdateDemographicsResponse](UpdateDemographicsResponse.md)
|
|
@@ -2076,7 +2100,9 @@
|
|
|
2076
2100
|
- [vitals.ConnectResponse](vitals.ConnectResponse.md)
|
|
2077
2101
|
- [VitalsRecord](VitalsRecord.md)
|
|
2078
2102
|
- [VitalsRecordRequest](VitalsRecordRequest.md)
|
|
2103
|
+
- [VitalsSeries](VitalsSeries.md)
|
|
2079
2104
|
- [VitalsStatus](VitalsStatus.md)
|
|
2105
|
+
- [VitalsWindow](VitalsWindow.md)
|
|
2080
2106
|
- [WhoopActivityIdMappingResponse](WhoopActivityIdMappingResponse.md)
|
|
2081
2107
|
- [WhoopAddTestDataRequest](WhoopAddTestDataRequest.md)
|
|
2082
2108
|
- [WhoopAddTestDataResponse](WhoopAddTestDataResponse.md)
|