@healthcloudai/hc-sdk 3.13.4 → 3.15.1
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 +495 -72
- package/dist/index.d.cts +2342 -1390
- package/dist/index.d.ts +2342 -1390
- package/dist/index.js +495 -72
- package/docs/clients/AthenaHealthClient.md +1 -1
- package/docs/clients/PatientClient.md +11 -0
- package/docs/docs-manifest.json +35 -3
- package/docs/examples/index.md +12 -1
- package/docs/index.md +12 -1
- package/docs/models/AssignImpiloDeviceRequest.md +17 -0
- package/docs/models/AssignImpiloDeviceResponse.md +20 -0
- package/docs/models/AthenaLabResult.md +2 -0
- package/docs/models/CancelTestOrderResponse.md +19 -0
- package/docs/models/CreateDeliveryOrderRequest.md +21 -0
- package/docs/models/DeliveryContact.md +24 -0
- package/docs/models/DeliveryOrder.md +30 -0
- package/docs/models/DeliveryPharmacy.md +25 -0
- package/docs/models/GetDefaultProviderResponse.md +2 -0
- package/docs/models/GetPatientResponse.md +1 -0
- package/docs/models/GetTestOrderResponse.md +44 -0
- package/docs/models/ImpiloDeviceItem.md +23 -0
- package/docs/models/ListDeliveryOrdersResponse.md +19 -0
- package/docs/models/ListImpiloDevicesResponse.md +18 -0
- package/docs/models/ListOrderItemsResponse.md +18 -0
- package/docs/models/ListTestOrdersResponse.md +18 -0
- package/docs/models/OrderItem.md +19 -0
- package/docs/models/OrderPriority.md +15 -0
- package/docs/models/OrderStatus.md +15 -0
- package/docs/models/PatientDemographics.md +1 -0
- package/docs/models/PlaceTestOrderRequest.md +43 -0
- package/docs/models/PlaceTestOrderResponse.md +44 -0
- package/docs/models/Specimen.md +30 -0
- package/docs/models/SpecimenStatus.md +15 -0
- package/docs/models/TestOrder.md +44 -0
- package/docs/models/_InsuranceOcrResult.md +1 -0
- package/docs/models/index.md +21 -0
- package/docs/operations/connectors.athenaAddLabResultDocument.md +2 -2
- package/docs/operations/connectors.athenaGetInsurancePackages.md +1 -1
- package/docs/operations/connectors.athenaGetLabResult.md +2 -0
- package/docs/operations/connectors.athenaListLabResults.md +2 -0
- package/docs/operations/fieldagent.listPatients.md +1 -0
- package/docs/operations/patient.addInsurance.md +48 -16
- package/docs/operations/patient.addPatientIntake.md +12 -1
- package/docs/operations/patient.assignImpiloDevice.md +112 -0
- package/docs/operations/patient.assistantOcrInsurance.md +64 -13
- package/docs/operations/patient.cancelTestOrder.md +152 -0
- package/docs/operations/patient.checkPatientInsuranceEligibility.md +133 -38
- package/docs/operations/patient.createDeliveryOrder.md +171 -0
- package/docs/operations/patient.getDefaultProvider.md +2 -0
- package/docs/operations/patient.getDeliveryOrder.md +156 -0
- package/docs/operations/patient.getPatient.md +1 -0
- package/docs/operations/patient.getPatientSidebarPatientSidebar.md +1 -0
- package/docs/operations/patient.getTestOrder.md +194 -0
- package/docs/operations/patient.importImpiloVitals.md +129 -0
- package/docs/operations/patient.listDeliveryOrders.md +156 -0
- package/docs/operations/patient.listImpiloDevices.md +100 -0
- package/docs/operations/patient.listOrderItems.md +129 -0
- package/docs/operations/patient.listTestOrders.md +201 -0
- package/docs/operations/patient.placeTestOrder.md +309 -0
- package/docs/operations/patient.submitPatientIntake.md +17 -3
- package/package.json +1 -1
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ListDeliveryOrdersResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ListDeliveryOrdersResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `limit` | `integer` | Yes | | | | No | |
|
|
14
|
+
| `offset` | `integer` | Yes | | | | No | |
|
|
15
|
+
| `orders` | array of [`DeliveryOrder`](./DeliveryOrder.md) | Yes | | | | No | |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# ListImpiloDevicesResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ListImpiloDevicesResponse`
|
|
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 [`ImpiloDeviceItem`](./ImpiloDeviceItem.md) | Yes | | | | No | Available Impilo device types. |
|
|
14
|
+
| `total` | `integer` | Yes | | | | No | Total number of device types. |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# ListOrderItemsResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ListOrderItemsResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `items` | array of [`OrderItem`](./OrderItem.md) | Yes | | | | No | |
|
|
14
|
+
| `total` | `integer` | Yes | | | | No | |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# ListTestOrdersResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ListTestOrdersResponse`
|
|
4
|
+
|
|
5
|
+
Response for GET /patients/orders.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `orders` | array of [`TestOrder`](./TestOrder.md) | Yes | | | | No | The patient's test orders, optionally filtered by `status`. |
|
|
14
|
+
| `total` | `integer` | Yes | | | | No | Number of orders in this response. |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# OrderItem
|
|
2
|
+
|
|
3
|
+
Model ID: `OrderItem`
|
|
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` | `string` | Yes | uuid | | | No | |
|
|
14
|
+
| `image` | `string|null` | No | | | | Yes | |
|
|
15
|
+
| `name` | `string` | Yes | | | | No | |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -30,6 +30,7 @@ Type: `object`
|
|
|
30
30
|
| `flags` | `object` | No | | | | No | Boolean feature/state flags for this patient |
|
|
31
31
|
| `gender` | [`Gender`](./Gender.md) | Yes | | | | No | Administrative gender: male, female, other, or unknown. |
|
|
32
32
|
| `gender_identity` | [`GenderIdentity`](./GenderIdentity.md) | No | | | | Yes | Gender identity (US Core Patient extension). |
|
|
33
|
+
| `impilo_patient_id` | `string|null` | No | | | | Yes | Impilo patient identifier when this patient is linked to Impilo RPM |
|
|
33
34
|
| `insurance` | array of [`Insurance`](./Insurance.md) | No | | | | No | Patient's insurance coverages, in coordination-of-benefits order. |
|
|
34
35
|
| `links` | array of [`PatientLink`](./PatientLink.md) | No | | | | No | Links to related or duplicate patient records. |
|
|
35
36
|
| `managing_organization_id` | `string|null` | No | | | | Yes | FHIR Organization resource id |
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# PlaceTestOrderRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `PlaceTestOrderRequest`
|
|
4
|
+
|
|
5
|
+
Request body for POST /patients/orders.
|
|
6
|
+
|
|
7
|
+
Places a diagnostic test/test-kit order for the authenticated patient. The
|
|
8
|
+
order is stored as a FHIR ServiceRequest. Athena-integrated tenants also
|
|
9
|
+
require idempotency_key, an owned linked encounter_id, loinc_code and an
|
|
10
|
+
existing clinical diagnosis_snomed_code. Creation does not submit an order
|
|
11
|
+
to an external laboratory. Other tenants retain the FHIR-only behavior.
|
|
12
|
+
|
|
13
|
+
Type: `object`
|
|
14
|
+
|
|
15
|
+
## Fields
|
|
16
|
+
|
|
17
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
18
|
+
|---|---|---:|---|---|---|---:|---|
|
|
19
|
+
| `cpt_code` | `string|null` | No | | | | Yes | CPT code identifying the ordered test, optional. |
|
|
20
|
+
| `diagnosis_codes` | `array` | No | | | | No | ICD-10-CM diagnosis codes supporting the order, optional. |
|
|
21
|
+
| `diagnosis_snomed_code` | `string|null` | No | | | | Yes | SNOMED diagnosis already recorded by a clinician on the linked Athena encounter; required for Athena lab orders. This is distinct from the test's snomed_code. |
|
|
22
|
+
| `display` | `string|null` | No | | | | Yes | Legacy raw-handler compatibility field. Generated clients must still send the canonical required `test_name`. |
|
|
23
|
+
| `encounter_id` | `string|null` | No | | | | Yes | FHIR Encounter resource ID this order was placed during, optional. |
|
|
24
|
+
| `fasting_required` | `boolean` | No | | | `false` | No | Whether the patient must fast before the test. Defaults to `false`. |
|
|
25
|
+
| `idempotency_key` | `string|null` | No | | | | Yes | Required for Athena tenants. Reuse the same UUID when retrying the same clinical order. |
|
|
26
|
+
| `lab_name` | `string|null` | No | | | | Yes | Name of the lab the order is routed to, optional. |
|
|
27
|
+
| `loinc_code` | `string|null` | No | | | | Yes | LOINC code identifying the ordered test, optional. |
|
|
28
|
+
| `notes` | `string|null` | No | | | | Yes | Free-text notes for the order, optional. |
|
|
29
|
+
| `occurrence_date` | `string|null` | No | | | | Yes | Requested date the test should occur, optional. |
|
|
30
|
+
| `occurrence_datetime` | `string|null` | No | | | | Yes | Requested date-time the test should occur, optional. |
|
|
31
|
+
| `performer_name` | `string|null` | No | | | | Yes | Display name of the performer/lab fulfilling the order, optional. |
|
|
32
|
+
| `priority` | [`OrderPriority`](./OrderPriority.md) | No | | | `"routine"` | No | Order priority. Defaults to `routine` when omitted. |
|
|
33
|
+
| `reason` | `string|null` | No | | | | Yes | Free-text clinical reason for the order, optional. |
|
|
34
|
+
| `requester_name` | `string|null` | No | | | | Yes | Display name of the ordering practitioner, optional. |
|
|
35
|
+
| `requester_npi` | `string|null` | No | | | | Yes | NPI of the ordering practitioner, optional. |
|
|
36
|
+
| `requisition_number` | `string|null` | No | | | | Yes | External requisition/order number, optional. |
|
|
37
|
+
| `snomed_code` | `string|null` | No | | | | Yes | SNOMED CT code identifying the ordered test, optional. |
|
|
38
|
+
| `standing_order` | `boolean` | No | | | `false` | No | Whether this is a recurring/standing order. Defaults to `false`. |
|
|
39
|
+
| `test_name` | `string` | Yes | | | | No | Human-readable name of the test/test-kit being ordered, e.g. 'OraQuick In-Home HIV Test' or 'CBC with Differential'. |
|
|
40
|
+
|
|
41
|
+
## Example
|
|
42
|
+
|
|
43
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# PlaceTestOrderResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `PlaceTestOrderResponse`
|
|
4
|
+
|
|
5
|
+
Response for POST /patients/orders. Same shape as `TestOrder`.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `athena_encounter_id` | `string|null` | No | | | | Yes | Athena encounter used to create the lab order. |
|
|
14
|
+
| `athena_order_id` | `string|null` | No | | | | Yes | Confirmed Athena lab order identifier, separate from the FHIR ServiceRequest ID. |
|
|
15
|
+
| `athena_order_status` | `string|null` | No | | | | Yes | Athena order state returned on refresh, or created before the first refresh. Creation does not imply submission to an external laboratory. |
|
|
16
|
+
| `authored_on` | `string|null` | No | | | | Yes | |
|
|
17
|
+
| `cpt_code` | `string|null` | No | | | | Yes | |
|
|
18
|
+
| `diagnosis_codes` | `array` | No | | | | No | ICD-10 codes |
|
|
19
|
+
| `display` | `string` | Yes | | | | No | Test name, e.g. CBC with Differential |
|
|
20
|
+
| `encounter_id` | `string|null` | No | | | | Yes | |
|
|
21
|
+
| `fasting_required` | `boolean` | No | | | `false` | No | |
|
|
22
|
+
| `fhir_id` | `string|null` | No | | | | Yes | |
|
|
23
|
+
| `intent` | `string` | No | | | `"order"` | No | |
|
|
24
|
+
| `lab_name` | `string|null` | No | | | | Yes | |
|
|
25
|
+
| `loinc_code` | `string|null` | No | | | | Yes | |
|
|
26
|
+
| `notes` | `string|null` | No | | | | Yes | |
|
|
27
|
+
| `occurrence_date` | `string|null` | No | | | | Yes | |
|
|
28
|
+
| `occurrence_datetime` | `string|null` | No | | | | Yes | |
|
|
29
|
+
| `order_id` | `string` | No | | | | No | |
|
|
30
|
+
| `patient_fhir_id` | `string|null` | No | | | | Yes | |
|
|
31
|
+
| `performer_name` | `string|null` | No | | | | Yes | |
|
|
32
|
+
| `priority` | [`OrderPriority`](./OrderPriority.md) | No | | | `"routine"` | No | |
|
|
33
|
+
| `reason` | `string|null` | No | | | | Yes | |
|
|
34
|
+
| `requester_name` | `string|null` | No | | | | Yes | |
|
|
35
|
+
| `requester_npi` | `string|null` | No | | | | Yes | |
|
|
36
|
+
| `requisition_number` | `string|null` | No | | | | Yes | |
|
|
37
|
+
| `snomed_code` | `string|null` | No | | | | Yes | |
|
|
38
|
+
| `specimen` | [`Specimen`](./Specimen.md) | No | | | | Yes | |
|
|
39
|
+
| `standing_order` | `boolean` | No | | | `false` | No | |
|
|
40
|
+
| `status` | [`OrderStatus`](./OrderStatus.md) | No | | | `"active"` | No | |
|
|
41
|
+
|
|
42
|
+
## Example
|
|
43
|
+
|
|
44
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Specimen
|
|
2
|
+
|
|
3
|
+
Model ID: `Specimen`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `accession_number` | `string|null` | No | | | | Yes | |
|
|
14
|
+
| `body_site` | `string|null` | No | | | | Yes | |
|
|
15
|
+
| `collected_by` | `string|null` | No | | | | Yes | |
|
|
16
|
+
| `collection_date` | `string|null` | No | | | | Yes | |
|
|
17
|
+
| `collection_datetime` | `string|null` | No | | | | Yes | |
|
|
18
|
+
| `condition` | `string|null` | No | | | | Yes | |
|
|
19
|
+
| `container` | `string|null` | No | | | | Yes | Tube type, e.g. Red, Purple, SST |
|
|
20
|
+
| `fhir_id` | `string|null` | No | | | | Yes | |
|
|
21
|
+
| `notes` | `string|null` | No | | | | Yes | |
|
|
22
|
+
| `received_datetime` | `string|null` | No | | | | Yes | |
|
|
23
|
+
| `specimen_id` | `string` | No | uuid | | | No | |
|
|
24
|
+
| `status` | [`SpecimenStatus`](./SpecimenStatus.md) | No | | | `"available"` | No | |
|
|
25
|
+
| `type` | [`SpecimenType`](./SpecimenType.md) | Yes | | | | No | |
|
|
26
|
+
| `volume_ml` | `number|null` | No | | | | Yes | |
|
|
27
|
+
|
|
28
|
+
## Example
|
|
29
|
+
|
|
30
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# TestOrder
|
|
2
|
+
|
|
3
|
+
Model ID: `TestOrder`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `athena_encounter_id` | `string|null` | No | | | | Yes | Athena encounter used to create the lab order. |
|
|
14
|
+
| `athena_order_id` | `string|null` | No | | | | Yes | Confirmed Athena lab order identifier, separate from the FHIR ServiceRequest ID. |
|
|
15
|
+
| `athena_order_status` | `string|null` | No | | | | Yes | Athena order state returned on refresh, or created before the first refresh. Creation does not imply submission to an external laboratory. |
|
|
16
|
+
| `authored_on` | `string|null` | No | | | | Yes | |
|
|
17
|
+
| `cpt_code` | `string|null` | No | | | | Yes | |
|
|
18
|
+
| `diagnosis_codes` | `array` | No | | | | No | ICD-10 codes |
|
|
19
|
+
| `display` | `string` | Yes | | | | No | Test name, e.g. CBC with Differential |
|
|
20
|
+
| `encounter_id` | `string|null` | No | | | | Yes | |
|
|
21
|
+
| `fasting_required` | `boolean` | No | | | `false` | No | |
|
|
22
|
+
| `fhir_id` | `string|null` | No | | | | Yes | |
|
|
23
|
+
| `intent` | `string` | No | | | `"order"` | No | |
|
|
24
|
+
| `lab_name` | `string|null` | No | | | | Yes | |
|
|
25
|
+
| `loinc_code` | `string|null` | No | | | | Yes | |
|
|
26
|
+
| `notes` | `string|null` | No | | | | Yes | |
|
|
27
|
+
| `occurrence_date` | `string|null` | No | | | | Yes | |
|
|
28
|
+
| `occurrence_datetime` | `string|null` | No | | | | Yes | |
|
|
29
|
+
| `order_id` | `string` | No | | | | No | |
|
|
30
|
+
| `patient_fhir_id` | `string|null` | No | | | | Yes | |
|
|
31
|
+
| `performer_name` | `string|null` | No | | | | Yes | |
|
|
32
|
+
| `priority` | [`OrderPriority`](./OrderPriority.md) | No | | | `"routine"` | No | |
|
|
33
|
+
| `reason` | `string|null` | No | | | | Yes | |
|
|
34
|
+
| `requester_name` | `string|null` | No | | | | Yes | |
|
|
35
|
+
| `requester_npi` | `string|null` | No | | | | Yes | |
|
|
36
|
+
| `requisition_number` | `string|null` | No | | | | Yes | |
|
|
37
|
+
| `snomed_code` | `string|null` | No | | | | Yes | |
|
|
38
|
+
| `specimen` | [`Specimen`](./Specimen.md) | No | | | | Yes | |
|
|
39
|
+
| `standing_order` | `boolean` | No | | | `false` | No | |
|
|
40
|
+
| `status` | [`OrderStatus`](./OrderStatus.md) | No | | | `"active"` | No | |
|
|
41
|
+
|
|
42
|
+
## Example
|
|
43
|
+
|
|
44
|
+
None declared in canonical OpenAPI.
|
|
@@ -16,6 +16,7 @@ Type: `object`
|
|
|
16
16
|
| `InsurerName` | `string` | Yes | | | | No | Issuing carrier name, or empty string if not legible. |
|
|
17
17
|
| `LastName` | `string` | Yes | | | | No | Cardholder's last name, or empty string if not legible. |
|
|
18
18
|
| `MemberID` | `string` | Yes | | | | No | Member/subscriber ID, or empty string if not legible. |
|
|
19
|
+
| `PayerID` | `string` | Yes | | | | No | Stedi payer id (primary Payer ID, Stedi payer ID or alias) as printed on the card, or AI-matched from the carrier name against the bundled Stedi payers catalogue; empty string when neither yields a usable id. |
|
|
19
20
|
| `PlanName` | `string` | Yes | | | | No | Plan or product name, or empty string if not present. |
|
|
20
21
|
| `RxBIN` | `string` | Yes | | | | No | 6-digit Rx BIN, or empty string if not present. |
|
|
21
22
|
| `RxGRP` | `string` | Yes | | | | No | Rx group, or empty string if not present. |
|
package/docs/models/index.md
CHANGED
|
@@ -36,6 +36,8 @@
|
|
|
36
36
|
- [Appointment](Appointment.md)
|
|
37
37
|
- [ErrorResponse](appointments.ErrorResponse.md)
|
|
38
38
|
- [AppointmentStatus](AppointmentStatus.md)
|
|
39
|
+
- [AssignImpiloDeviceRequest](AssignImpiloDeviceRequest.md)
|
|
40
|
+
- [AssignImpiloDeviceResponse](AssignImpiloDeviceResponse.md)
|
|
39
41
|
- [AssistantAction](AssistantAction.md)
|
|
40
42
|
- [AssistantChatRequest](AssistantChatRequest.md)
|
|
41
43
|
- [AssistantChatResponse](AssistantChatResponse.md)
|
|
@@ -379,6 +381,7 @@
|
|
|
379
381
|
- [CalUpdateScheduleRequest](CalUpdateScheduleRequest.md)
|
|
380
382
|
- [CalUpdateScheduleResponse](CalUpdateScheduleResponse.md)
|
|
381
383
|
- [CancelAppointmentRequest](CancelAppointmentRequest.md)
|
|
384
|
+
- [CancelTestOrderResponse](CancelTestOrderResponse.md)
|
|
382
385
|
- [CapturedTestImageResponse](CapturedTestImageResponse.md)
|
|
383
386
|
- [CarequalityDiscoverPatientRequest](CarequalityDiscoverPatientRequest.md)
|
|
384
387
|
- [CarequalityDiscoverPatientResponse](CarequalityDiscoverPatientResponse.md)
|
|
@@ -446,6 +449,7 @@
|
|
|
446
449
|
- [ConversationKind](ConversationKind.md)
|
|
447
450
|
- [ConversationRecord](ConversationRecord.md)
|
|
448
451
|
- [CreateChannelResponse](CreateChannelResponse.md)
|
|
452
|
+
- [CreateDeliveryOrderRequest](CreateDeliveryOrderRequest.md)
|
|
449
453
|
- [CreateEncounterRequest](CreateEncounterRequest.md)
|
|
450
454
|
- [CreateMedicationRequest](CreateMedicationRequest.md)
|
|
451
455
|
- [CreateMedicationResponse](CreateMedicationResponse.md)
|
|
@@ -464,6 +468,9 @@
|
|
|
464
468
|
- [DeleteActivityResponse](DeleteActivityResponse.md)
|
|
465
469
|
- [DeleteDependentResponse](DeleteDependentResponse.md)
|
|
466
470
|
- [DeleteNotificationResponse](DeleteNotificationResponse.md)
|
|
471
|
+
- [DeliveryContact](DeliveryContact.md)
|
|
472
|
+
- [DeliveryOrder](DeliveryOrder.md)
|
|
473
|
+
- [DeliveryPharmacy](DeliveryPharmacy.md)
|
|
467
474
|
- [DemographicsMatch](DemographicsMatch.md)
|
|
468
475
|
- [DependentResponse](DependentResponse.md)
|
|
469
476
|
- [diagnostics.ConnectResponse](diagnostics.ConnectResponse.md)
|
|
@@ -604,6 +611,7 @@
|
|
|
604
611
|
- [Practitioner](GetPractitionerResponse.md)
|
|
605
612
|
- [GetPreferredPharmacyResponse](GetPreferredPharmacyResponse.md)
|
|
606
613
|
- [ScanUploadUrlRequest](GetScanUploadUrlRequest.md)
|
|
614
|
+
- [GetTestOrderResponse](GetTestOrderResponse.md)
|
|
607
615
|
- [GetTestResultResponse](GetTestResultResponse.md)
|
|
608
616
|
- [GetVectorDocumentChunksResponse](GetVectorDocumentChunksResponse.md)
|
|
609
617
|
- [GetVitalsResponse](GetVitalsResponse.md)
|
|
@@ -1092,6 +1100,7 @@
|
|
|
1092
1100
|
- [ImpiloCreatePatientRequest](ImpiloCreatePatientRequest.md)
|
|
1093
1101
|
- [ImpiloCreateProcurementRequest](ImpiloCreateProcurementRequest.md)
|
|
1094
1102
|
- [ImpiloDevice](ImpiloDevice.md)
|
|
1103
|
+
- [ImpiloDeviceItem](ImpiloDeviceItem.md)
|
|
1095
1104
|
- [ImpiloDeviceListResponse](ImpiloDeviceListResponse.md)
|
|
1096
1105
|
- [ImpiloDeviceValidationResponse](ImpiloDeviceValidationResponse.md)
|
|
1097
1106
|
- [ImpiloDisableReadingsRequest](ImpiloDisableReadingsRequest.md)
|
|
@@ -1208,16 +1217,19 @@
|
|
|
1208
1217
|
- [ListActivityResponse](ListActivityResponse.md)
|
|
1209
1218
|
- [ListAllergiesResponse](ListAllergiesResponse.md)
|
|
1210
1219
|
- [ListConditionsResponse](ListConditionsResponse.md)
|
|
1220
|
+
- [ListDeliveryOrdersResponse](ListDeliveryOrdersResponse.md)
|
|
1211
1221
|
- [ListDependentsResponse](ListDependentsResponse.md)
|
|
1212
1222
|
- [ListDiagnosticTestsResponse](ListDiagnosticTestsResponse.md)
|
|
1213
1223
|
- [ListDirectivesResponse](ListDirectivesResponse.md)
|
|
1214
1224
|
- [ListFamilyHistoryResponse](ListFamilyHistoryResponse.md)
|
|
1215
1225
|
- [FunctionalStatusListResponse](ListFunctionalStatusResponse.md)
|
|
1216
1226
|
- [ListImmunizationsResponse](ListImmunizationsResponse.md)
|
|
1227
|
+
- [ListImpiloDevicesResponse](ListImpiloDevicesResponse.md)
|
|
1217
1228
|
- [ListKnowledgeResponse](ListKnowledgeResponse.md)
|
|
1218
1229
|
- [ListMedicalConceptsGetResponse](ListMedicalConceptsGetResponse.md)
|
|
1219
1230
|
- [ListNotificationsResponse](ListNotificationsResponse.md)
|
|
1220
1231
|
- [ObservationListResponse](ListObservationsResponse.md)
|
|
1232
|
+
- [ListOrderItemsResponse](ListOrderItemsResponse.md)
|
|
1221
1233
|
- [ListPatientAppointmentsResponse](ListPatientAppointmentsResponse.md)
|
|
1222
1234
|
- [FieldAgentListPatientsResponse](ListPatientsResponse.md)
|
|
1223
1235
|
- [ListPolicyDocumentsResponse](ListPolicyDocumentsResponse.md)
|
|
@@ -1225,6 +1237,7 @@
|
|
|
1225
1237
|
- [ListQuestionnaireResponsesResponse](ListQuestionnaireResponsesResponse.md)
|
|
1226
1238
|
- [ListSlotsResponse](ListSlotsResponse.md)
|
|
1227
1239
|
- [ListSocialHistoryResponse](ListSocialHistoryResponse.md)
|
|
1240
|
+
- [ListTestOrdersResponse](ListTestOrdersResponse.md)
|
|
1228
1241
|
- [ListVectorCollectionsResponse](ListVectorCollectionsResponse.md)
|
|
1229
1242
|
- [ListVitalsResponse](ListVitalsResponse.md)
|
|
1230
1243
|
- [LocationStatus](LocationStatus.md)
|
|
@@ -1294,6 +1307,9 @@
|
|
|
1294
1307
|
- [OpenAIUpdateAssistantRequest](OpenAIUpdateAssistantRequest.md)
|
|
1295
1308
|
- [OpenAIUpdateAssistantResponse](OpenAIUpdateAssistantResponse.md)
|
|
1296
1309
|
- [OpenLoopVitalsMirrorResult](OpenLoopVitalsMirrorResult.md)
|
|
1310
|
+
- [OrderItem](OrderItem.md)
|
|
1311
|
+
- [OrderPriority](OrderPriority.md)
|
|
1312
|
+
- [OrderStatus](OrderStatus.md)
|
|
1297
1313
|
- [OuraBuildAuthorizationUrlRequest](OuraBuildAuthorizationUrlRequest.md)
|
|
1298
1314
|
- [OuraBuildAuthorizationUrlResponse](OuraBuildAuthorizationUrlResponse.md)
|
|
1299
1315
|
- [OuraDailyActivity](OuraDailyActivity.md)
|
|
@@ -1405,6 +1421,8 @@
|
|
|
1405
1421
|
- [PersonRelationship](PersonRelationship.md)
|
|
1406
1422
|
- [Phone](Phone.md)
|
|
1407
1423
|
- [PhoneType](PhoneType.md)
|
|
1424
|
+
- [PlaceTestOrderRequest](PlaceTestOrderRequest.md)
|
|
1425
|
+
- [PlaceTestOrderResponse](PlaceTestOrderResponse.md)
|
|
1408
1426
|
- [PlaidCreateIdentityVerificationRequest](PlaidCreateIdentityVerificationRequest.md)
|
|
1409
1427
|
- [PlaidGetIdentityVerificationRequest](PlaidGetIdentityVerificationRequest.md)
|
|
1410
1428
|
- [PlaidIdentityVerification](PlaidIdentityVerification.md)
|
|
@@ -1718,6 +1736,8 @@
|
|
|
1718
1736
|
- [SexAtBirth](SexAtBirth.md)
|
|
1719
1737
|
- [Slot](Slot.md)
|
|
1720
1738
|
- [SlotStatus](SlotStatus.md)
|
|
1739
|
+
- [Specimen](Specimen.md)
|
|
1740
|
+
- [SpecimenStatus](SpecimenStatus.md)
|
|
1721
1741
|
- [SpecimenType](SpecimenType.md)
|
|
1722
1742
|
- [StandardErrorResponse](StandardErrorResponse.md)
|
|
1723
1743
|
- [SteadyMDAddAllergyIntoleranceRequest](SteadyMDAddAllergyIntoleranceRequest.md)
|
|
@@ -1831,6 +1851,7 @@
|
|
|
1831
1851
|
- [ErrorResponse](telehealth.ErrorResponse.md)
|
|
1832
1852
|
- [TelehealthToken](TelehealthToken.md)
|
|
1833
1853
|
- [TemperatureRoute](TemperatureRoute.md)
|
|
1854
|
+
- [TestOrder](TestOrder.md)
|
|
1834
1855
|
- [TwilioGetMessageRequest](TwilioGetMessageRequest.md)
|
|
1835
1856
|
- [TwilioListMessagesRequest](TwilioListMessagesRequest.md)
|
|
1836
1857
|
- [TwilioListMessagesResponse](TwilioListMessagesResponse.md)
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Create a result document, defaulting routing to the tenant provider
|
|
2
2
|
|
|
3
3
|
Operation ID: `connectors.athenaAddLabResultDocument`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Create a result document, defaulting routing to the tenant provider. Provider IDs are Athena-local identifiers, never NPIs. If neither an explicit nor configured provider exists, preserve Athena's default routing. Legacy analyte resultflag/status codes are translated to Athena's abnormalflag/resultstatus text enums, including critical flags HH/LL/AA.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `connectors.athenaGetInsurancePackages`
|
|
4
4
|
|
|
5
|
-
Search insurance packages, following pagination.
|
|
5
|
+
Search insurance packages, following pagination. Athena requires ``memberid`` and ``insuranceplanname`` for this search. Only non-empty filters are sent; missing required filters may be rejected with HTTP 400. ``max_pages`` optionally caps pagination (None = follow every ``next`` link). Standard search returns its list as ``insurances``; the separate top-packages endpoint uses ``insurancepackages``.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -78,6 +78,8 @@ Request model: [`AthenaGetLabResultRequest`](../models/AthenaGetLabResultRequest
|
|
|
78
78
|
"loinc": "example-loinc",
|
|
79
79
|
"observations": [],
|
|
80
80
|
"order_type": "example-order-type",
|
|
81
|
+
"provider_id": "12345",
|
|
82
|
+
"provider_username": "example-provider-username",
|
|
81
83
|
"result_category": "example-result-category",
|
|
82
84
|
"status": "example-status"
|
|
83
85
|
}
|
|
@@ -78,6 +78,8 @@ Request model: [`AthenaListLabResultsRequest`](../models/AthenaListLabResultsReq
|
|
|
78
78
|
"loinc": "example-loinc",
|
|
79
79
|
"observations": [],
|
|
80
80
|
"order_type": "example-order-type",
|
|
81
|
+
"provider_id": "12345",
|
|
82
|
+
"provider_username": "example-provider-username",
|
|
81
83
|
"result_category": "example-result-category",
|
|
82
84
|
"status": "example-status"
|
|
83
85
|
}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `patient.addInsurance`
|
|
4
4
|
|
|
5
|
-
Create a new FHIR Coverage resource for the authenticated patient. Requires a patient Bearer JWT.
|
|
5
|
+
Create a new FHIR Coverage resource for the authenticated patient. Requires a patient Bearer JWT. Supply payer_name and member_id; priority defaults to primary and relationship defaults to self. state is an optional vendor/payer matching hint. A plausible payer_id is used unchanged; a missing or implausible ID is resolved from payer_name against the Stedi catalogue. If neither path yields an ID, return 422 before writing Coverage. HTTP 201 confirms HealthCloud storage, not active eligibility or successful vendor synchronization. Call patient.checkPatientInsuranceEligibility separately. A 400 can occur after Coverage was written; read saved insurance before retrying to avoid duplicate submissions. Error text is descriptive and may vary; branch on HTTP status and structured outcome fields.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -60,25 +60,48 @@ Request model: [`AddInsuranceRequest`](../models/AddInsuranceRequest.md)
|
|
|
60
60
|
|
|
61
61
|
| Status | Shape | Content type | Description |
|
|
62
62
|
|---|---|---|---|
|
|
63
|
-
| `201` | [`AddInsuranceResponse`](../models/AddInsuranceResponse.md) | application/json | Coverage created |
|
|
63
|
+
| `201` | [`AddInsuranceResponse`](../models/AddInsuranceResponse.md) | application/json | Coverage saved. coverages_created is the number created; patient_id is the patient identifier and fhir_patient_id is its deprecated alias. Only the vendor that ran has non-null athena_* or openloop_* fields. The corresponding *_insurance_status is linked (synchronized), failed (see *_insurance_error), skipped_no_match (no catalogue match), or skipped_not_linked (integration unavailable/misconfigured). Both vendor statuses are null when no vendor link applies; the internal skipped_no_vendor status is not emitted. *_best_match contains the selected plan or null. These secondary failures still return 201; do not automatically resubmit Coverage. When image is supplied, fhir_document_reference_id identifies the saved card or is null if saving it failed. athena_insurance_card_status is linked, failed, skipped_no_insurance_id, or skipped_insurance_not_linked. With no image both card fields are null. Card failures do not undo the saved Coverage. |
|
|
64
64
|
|
|
65
65
|
## Success response examples
|
|
66
66
|
|
|
67
|
-
### 201
|
|
67
|
+
### 201 — Coverage saved even though vendor synchronization failed
|
|
68
68
|
|
|
69
69
|
```json
|
|
70
70
|
{
|
|
71
|
-
"athena_best_match": {
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
"
|
|
78
|
-
"
|
|
79
|
-
"
|
|
80
|
-
"
|
|
81
|
-
"
|
|
71
|
+
"athena_best_match": {
|
|
72
|
+
"insurance_package_id": "1352",
|
|
73
|
+
"insurance_type": null,
|
|
74
|
+
"name": "Example Plan",
|
|
75
|
+
"state": null
|
|
76
|
+
},
|
|
77
|
+
"athena_insurance_card_status": "skipped_insurance_not_linked",
|
|
78
|
+
"athena_insurance_error": "unexpected error — see server logs",
|
|
79
|
+
"athena_insurance_status": "failed",
|
|
80
|
+
"coverages_created": 1,
|
|
81
|
+
"fhir_document_reference_id": "card-example-001",
|
|
82
|
+
"fhir_patient_id": "patient-example-001",
|
|
83
|
+
"openloop_best_match": null,
|
|
84
|
+
"openloop_insurance_error": null,
|
|
85
|
+
"openloop_insurance_status": null,
|
|
86
|
+
"patient_id": "patient-example-001"
|
|
87
|
+
}
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### 201 — Coverage saved without an Athena/OpenLoop mirror
|
|
91
|
+
|
|
92
|
+
```json
|
|
93
|
+
{
|
|
94
|
+
"athena_best_match": null,
|
|
95
|
+
"athena_insurance_card_status": null,
|
|
96
|
+
"athena_insurance_error": null,
|
|
97
|
+
"athena_insurance_status": null,
|
|
98
|
+
"coverages_created": 1,
|
|
99
|
+
"fhir_document_reference_id": null,
|
|
100
|
+
"fhir_patient_id": "patient-example-001",
|
|
101
|
+
"openloop_best_match": null,
|
|
102
|
+
"openloop_insurance_error": null,
|
|
103
|
+
"openloop_insurance_status": null,
|
|
104
|
+
"patient_id": "patient-example-001"
|
|
82
105
|
}
|
|
83
106
|
```
|
|
84
107
|
|
|
@@ -89,14 +112,15 @@ Request model: [`AddInsuranceRequest`](../models/AddInsuranceRequest.md)
|
|
|
89
112
|
| `400` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Bad request — required fields missing or FHIR rejected the coverage |
|
|
90
113
|
| `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing, invalid, expired, or non-patient Bearer JWT |
|
|
91
114
|
| `404` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The authenticated patient has no FHIR Patient record |
|
|
115
|
+
| `422` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | No usable payer ID was supplied or resolved; no Coverage is written |
|
|
92
116
|
|
|
93
117
|
## Error examples
|
|
94
118
|
|
|
95
|
-
### 400 —
|
|
119
|
+
### 400 — Member ID missing after payer resolution succeeded
|
|
96
120
|
|
|
97
121
|
```json
|
|
98
122
|
{
|
|
99
|
-
"error": "'
|
|
123
|
+
"error": "'member_id'"
|
|
100
124
|
}
|
|
101
125
|
```
|
|
102
126
|
|
|
@@ -116,6 +140,14 @@ Request model: [`AddInsuranceRequest`](../models/AddInsuranceRequest.md)
|
|
|
116
140
|
}
|
|
117
141
|
```
|
|
118
142
|
|
|
143
|
+
### 422 — Provide a payer ID or a recognizable payer name
|
|
144
|
+
|
|
145
|
+
```json
|
|
146
|
+
{
|
|
147
|
+
"error": "An insurance payer id is required: send the PayerID returned by /assistant/ocr-insurance, a payer_id as printed on the card, or a payer_name that matches a Stedi payer."
|
|
148
|
+
}
|
|
149
|
+
```
|
|
150
|
+
|
|
119
151
|
## NodeJS / TypeScript implementation
|
|
120
152
|
|
|
121
153
|
```ts
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `patient.addPatientIntake`
|
|
4
4
|
|
|
5
|
-
Adds exactly one agent-collected intake section to FHIR and Athena. Returns an empty error_messages list only after both FHIR storage and Athena chart read-back succeed.
|
|
5
|
+
Adds exactly one agent-collected intake section to FHIR and Athena, linked to the patient's existing current open FHIR encounter. Returns 409 before writes when no valid open encounter exists. Returns an empty error_messages list only after both FHIR storage and Athena chart read-back succeed.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -74,11 +74,22 @@ Request model: [`AddPatientIntakeRequest`](../models/AddPatientIntakeRequest.md)
|
|
|
74
74
|
|
|
75
75
|
| Status | Shape | Content type | Description |
|
|
76
76
|
|---|---|---|---|
|
|
77
|
+
| `409` | [`AddPatientIntakeResponse`](../models/AddPatientIntakeResponse.md) | application/json | An existing open encounter belonging to the patient is required |
|
|
77
78
|
| `422` | [`AddPatientIntakeResponse`](../models/AddPatientIntakeResponse.md) | application/json | The submitted section needs correction |
|
|
78
79
|
| `502` | [`AddPatientIntakeResponse`](../models/AddPatientIntakeResponse.md) | application/json | FHIR or EHR completion could not be confirmed |
|
|
79
80
|
|
|
80
81
|
## Error examples
|
|
81
82
|
|
|
83
|
+
### 409
|
|
84
|
+
|
|
85
|
+
```json
|
|
86
|
+
{
|
|
87
|
+
"error_messages": [
|
|
88
|
+
"string"
|
|
89
|
+
]
|
|
90
|
+
}
|
|
91
|
+
```
|
|
92
|
+
|
|
82
93
|
### 422
|
|
83
94
|
|
|
84
95
|
```json
|