@healthcloudai/hc-sdk 3.31.1 → 3.32.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 +97 -0
- package/dist/index.d.cts +2716 -180
- package/dist/index.d.ts +2716 -180
- package/dist/index.js +97 -0
- package/docs/clients/AthenaHealthClient.md +1 -1
- package/docs/clients/PatientClient.md +4 -0
- package/docs/clients/ProviderClient.md +8 -0
- package/docs/docs-manifest.json +40 -3
- package/docs/examples/index.md +13 -1
- package/docs/index.md +13 -1
- package/docs/models/Appointment.md +3 -2
- package/docs/models/AthenaBookAppointmentRequest.md +1 -0
- package/docs/models/AthenaRetrieveAvailableAppointmentSlotsRequest.md +1 -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/CheckEligibilityResponse.md +1 -1
- package/docs/models/DeviceCatalogItem.md +24 -0
- package/docs/models/DeviceCatalogResponse.md +18 -0
- package/docs/models/HealthPlanSummary.md +1 -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/ProviderEncounterRecord.md +1 -1
- package/docs/models/ProviderMyAppointment.md +26 -0
- package/docs/models/ProviderMyAppointmentsResponse.md +19 -0
- package/docs/models/ProviderMyPatientsVitalsResponse.md +21 -0
- package/docs/models/ProviderQueueEncounter.md +1 -1
- package/docs/models/Slot.md +3 -2
- 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 +25 -0
- package/docs/operations/appointments.book.md +1 -0
- package/docs/operations/appointments.cancel.md +1 -0
- package/docs/operations/appointments.createSlot.md +4 -3
- package/docs/operations/appointments.listPatientAppointments.md +1 -0
- package/docs/operations/appointments.listSlots.md +14 -4
- package/docs/operations/appointments.reschedule.md +1 -0
- package/docs/operations/connectors.athenaBookAppointment.md +5 -3
- package/docs/operations/connectors.athenaRetrieveAvailableAppointmentSlots.md +1 -1
- package/docs/operations/graph.searchDocumentSummariesCypher.md +9 -0
- package/docs/operations/graph.searchHealthPlans.md +14 -13
- package/docs/operations/graph.searchHealthPlansCypher.md +9 -0
- package/docs/operations/graph.searchMedicalConceptsCypher.md +9 -0
- package/docs/operations/graph.searchProvidersCypher.md +9 -0
- package/docs/operations/patient.assistantOcr.md +12 -1
- package/docs/operations/patient.assistantOcrInsurance.md +12 -1
- package/docs/operations/patient.checkPatientInsuranceEligibility.md +15 -2
- 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.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
|
+
# CarePlanGoal
|
|
2
|
+
|
|
3
|
+
Model ID: `CarePlanGoal`
|
|
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 goal. |
|
|
14
|
+
| `expected_outcome` | `string` | Yes | | | | No | What success looks like. |
|
|
15
|
+
| `goal_id` | `string` | Yes | | | | No | Stable id of the goal inside the plan. Send it back to keep the goal. |
|
|
16
|
+
| `problem_ids` | `array` | No | | | | No | Problems in this plan the goal addresses. |
|
|
17
|
+
| `progress_note` | `string|null` | No | | | | Yes | Patient-visible note on progress toward the goal. |
|
|
18
|
+
| `status` | `string` | No | | proposed, active, achieved, not_achieved, cancelled | `"active"` | No | proposed, active, achieved, not_achieved or cancelled. |
|
|
19
|
+
| `target_date` | `string|null` | No | | | | Yes | YYYY-MM-DD the outcome is expected by. |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
None declared in canonical OpenAPI.
|
|
@@ -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.
|
|
@@ -12,7 +12,7 @@ Type: `object`
|
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
13
|
| `checked_at` | `string` | Yes | date-time | | | No | |
|
|
14
14
|
| `endpoint_version` | `string` | No | | | `"2026-06-01"` | No | |
|
|
15
|
-
| `reason` | `string` | Yes | | active_coverage, inactive_coverage, conflicting_or_missing_status, missing_profile, missing_coverage, ambiguous_coverage, missing_configuration, storage_unavailable, timeout, transport_error, http_error, invalid_response | | No | |
|
|
15
|
+
| `reason` | `string` | Yes | | active_coverage, inactive_coverage, conflicting_or_missing_status, missing_profile, missing_coverage, ambiguous_coverage, missing_configuration, storage_unavailable, timeout, transport_error, http_error, invalid_response, subscriber_details_mismatch | | No | |
|
|
16
16
|
| `reference_id` | `string|null` | No | | | | Yes | |
|
|
17
17
|
| `service_type_code` | `string` | No | | | `"30"` | No | |
|
|
18
18
|
| `source` | `string` | No | | | `"stedi"` | No | |
|
|
@@ -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.
|
|
@@ -10,6 +10,7 @@ Type: `object`
|
|
|
10
10
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `id` | `string|null` | No | | | | Yes | The plan's id in the payer graph (`<state>:<plan year>:<plan_id>`), for `GET /graph/health-plans/{id}`; null for an Algolia result. |
|
|
13
14
|
| `issuer` | `string|null` | No | | | | Yes | Insurance issuer name, optional. |
|
|
14
15
|
| `name` | `string` | Yes | | | | No | Plan display name. |
|
|
15
16
|
| `network` | `string|null` | No | | | | Yes | Network display name, optional. |
|
|
@@ -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.
|
|
@@ -35,7 +35,7 @@ Type: `object`
|
|
|
35
35
|
| `provider_notes` | `string|null` | No | | | | Yes | The provider's own clinical note, written with PATCH /encounters/{id}/clinical-note. Kept apart from the patient-reported text and not shown by the patient, EHR or field-agent APIs. Notes a provider wrote before this field existed are in `notes`, not here. |
|
|
36
36
|
| `reason_code` | `string|null` | No | | | | Yes | SNOMED CT code for the reason for the encounter, when coded. |
|
|
37
37
|
| `reason_display` | `string|null` | No | | | | Yes | Display text for the reason for the encounter, when available. |
|
|
38
|
-
| `reported_symptoms` | `string|null` | No | | | | Yes |
|
|
38
|
+
| `reported_symptoms` | `string|null` | No | | | | Yes | The explicitly labelled Symptoms block in the encounter notes. Excludes patient intake and unclassified legacy narrative, which remain available in notes. Null when no explicit symptom content is available. Never changed by a provider's clinical note. |
|
|
39
39
|
| `service_provider_display` | `string|null` | No | | | | Yes | Display name of the service provider organization, when available. |
|
|
40
40
|
| `service_provider_id` | `string|null` | No | | | | Yes | FHIR Organization id of the service provider, when linked. |
|
|
41
41
|
| `service_type_code` | `string|null` | No | | | | Yes | SNOMED CT code for the service type, when coded. |
|
|
@@ -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.
|
|
@@ -19,7 +19,7 @@ Type: `object`
|
|
|
19
19
|
| `priority_display` | `string|null` | No | | | | Yes | Priority text, when available. |
|
|
20
20
|
| `reason_code` | `string|null` | No | | | | Yes | Reason-for-visit code, when coded. |
|
|
21
21
|
| `reason_display` | `string|null` | No | | | | Yes | Reason-for-visit text, when available. |
|
|
22
|
-
| `reported_symptoms` | `string|null` | No | | | | Yes |
|
|
22
|
+
| `reported_symptoms` | `string|null` | No | | | | Yes | The explicitly labelled Symptoms block, excluding intake and unclassified legacy narrative, cut to at most 300 characters with an ellipsis when longer. Null when no explicit symptom content is available. The full patient notes come with the encounter once taken. |
|
|
23
23
|
| `status` | `string` | Yes | | | | No | Encounter status, for example planned, arrived or triaged. |
|
|
24
24
|
| `type_code` | `string|null` | No | | | | Yes | SNOMED CT encounter type code, when coded. |
|
|
25
25
|
| `type_display` | `string|null` | No | | | | Yes | Encounter type text, when available. |
|
package/docs/models/Slot.md
CHANGED
|
@@ -11,7 +11,7 @@ Type: `object`
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
13
|
| `athena_appointment_id` | `string|null` | No | | | | Yes | Athena Health appointment id backing this slot. Always present for slots sourced from Athena, where it — not `slot_id` — is what `appointments.book` must be given as `athena_appointment_id`. |
|
|
14
|
-
| `end` | `string` | Yes |
|
|
14
|
+
| `end` | `string` | Yes | | | | No | Exclusive slot end. ISO 8601 date-time. An offset or Z identifies a known instant. A value without an offset preserves unresolved vendor wall time: do not interpret it as UTC or device time, use it for chronological eligibility, or export it to a calendar. Missing/invalid department zones and ambiguous/nonexistent DST start times remain unresolved. Resolved end times use duration as elapsed minutes. |
|
|
15
15
|
| `fhir_id` | `string|null` | No | | | | Yes | FHIR Slot resource ID returned by FHIR-only appointments.listSlots. Send this value as slot_id to appointments.book or appointments.reschedule. It is not populated on vendor calendars (null or omitted), and may be omitted by appointments.createSlot, which returns the resource ID in slot_id. |
|
|
16
16
|
| `location` | `string|null` | No | | | | Yes | Human-readable appointment location, when available. |
|
|
17
17
|
| `openloop_appointment_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) appointment id backing this slot. Always present for slots sourced from OpenLoop, where it — not `slot_id` — is what `appointments.book` must be given as `openloop_appointment_id`. |
|
|
@@ -19,9 +19,10 @@ Type: `object`
|
|
|
19
19
|
| `provider_name` | `string|null` | No | | | | Yes | Provider display name, when available. |
|
|
20
20
|
| `slot_id` | `string` | Yes | | | | No | Slot identifier. appointments.createSlot returns the FHIR resource ID here. On a FHIR-only appointments.listSlots response this is an internal identifier; use fhir_id for booking or rescheduling instead. Vendor-integrated callers echo slot_id together with the required vendor fields. |
|
|
21
21
|
| `specialty_code` | `string|null` | No | | | | Yes | SNOMED CT specialty code, when supplied by the schedule. |
|
|
22
|
-
| `start` | `string` | Yes |
|
|
22
|
+
| `start` | `string` | Yes | | | | No | Inclusive slot start. ISO 8601 date-time. An offset or Z identifies a known instant. A value without an offset preserves unresolved vendor wall time: do not interpret it as UTC or device time, use it for chronological eligibility, or export it to a calendar. Missing/invalid department zones and ambiguous/nonexistent DST start times remain unresolved. Resolved end times use duration as elapsed minutes. |
|
|
23
23
|
| `status` | [`SlotStatus`](./SlotStatus.md) | Yes | | | | No | Current availability state of the slot. |
|
|
24
24
|
| `steadymd_clinician_guid` | `string|null` | No | | | | Yes | SteadyMD clinician guid this availability block belongs to. Always present for slots sourced from SteadyMD, which has no per-slot vendor id — booking instead echoes back this clinician guid together with `start`. |
|
|
25
|
+
| `time_zone` | `string|null` | No | | | | Yes | IANA department timezone, when validated. Metadata alone does not resolve an ambiguous/nonexistent wall time; start/end must contain an offset to identify an instant. |
|
|
25
26
|
|
|
26
27
|
## Example
|
|
27
28
|
|
|
@@ -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.
|