@healthcloudai/hc-sdk 3.13.3 → 3.14.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 +432 -0
- package/dist/index.d.cts +1875 -1007
- package/dist/index.d.ts +1875 -1007
- package/dist/index.js +432 -0
- package/docs/clients/AthenaHealthClient.md +1 -1
- package/docs/clients/PatientClient.md +8 -0
- package/docs/docs-manifest.json +28 -3
- package/docs/examples/index.md +9 -1
- package/docs/index.md +9 -1
- 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/GetPatientResponse.md +1 -0
- package/docs/models/GetTestOrderResponse.md +44 -0
- package/docs/models/ListDeliveryOrdersResponse.md +19 -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/index.md +17 -0
- package/docs/operations/connectors.athenaCreateInsurancePackage.md +2 -2
- package/docs/operations/connectors.athenaGetInsurancePackages.md +1 -1
- package/docs/operations/connectors.athenaUpdateDriversLicense.md +1 -1
- package/docs/operations/fieldagent.listPatients.md +1 -0
- package/docs/operations/patient.addPatientIntake.md +12 -1
- package/docs/operations/patient.assistantOcrInsurance.md +2 -2
- package/docs/operations/patient.cancelTestOrder.md +152 -0
- package/docs/operations/patient.createDeliveryOrder.md +171 -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.listDeliveryOrders.md +156 -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 +4 -2
- package/package.json +2 -2
|
@@ -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.
|
package/docs/models/index.md
CHANGED
|
@@ -379,6 +379,7 @@
|
|
|
379
379
|
- [CalUpdateScheduleRequest](CalUpdateScheduleRequest.md)
|
|
380
380
|
- [CalUpdateScheduleResponse](CalUpdateScheduleResponse.md)
|
|
381
381
|
- [CancelAppointmentRequest](CancelAppointmentRequest.md)
|
|
382
|
+
- [CancelTestOrderResponse](CancelTestOrderResponse.md)
|
|
382
383
|
- [CapturedTestImageResponse](CapturedTestImageResponse.md)
|
|
383
384
|
- [CarequalityDiscoverPatientRequest](CarequalityDiscoverPatientRequest.md)
|
|
384
385
|
- [CarequalityDiscoverPatientResponse](CarequalityDiscoverPatientResponse.md)
|
|
@@ -446,6 +447,7 @@
|
|
|
446
447
|
- [ConversationKind](ConversationKind.md)
|
|
447
448
|
- [ConversationRecord](ConversationRecord.md)
|
|
448
449
|
- [CreateChannelResponse](CreateChannelResponse.md)
|
|
450
|
+
- [CreateDeliveryOrderRequest](CreateDeliveryOrderRequest.md)
|
|
449
451
|
- [CreateEncounterRequest](CreateEncounterRequest.md)
|
|
450
452
|
- [CreateMedicationRequest](CreateMedicationRequest.md)
|
|
451
453
|
- [CreateMedicationResponse](CreateMedicationResponse.md)
|
|
@@ -464,6 +466,9 @@
|
|
|
464
466
|
- [DeleteActivityResponse](DeleteActivityResponse.md)
|
|
465
467
|
- [DeleteDependentResponse](DeleteDependentResponse.md)
|
|
466
468
|
- [DeleteNotificationResponse](DeleteNotificationResponse.md)
|
|
469
|
+
- [DeliveryContact](DeliveryContact.md)
|
|
470
|
+
- [DeliveryOrder](DeliveryOrder.md)
|
|
471
|
+
- [DeliveryPharmacy](DeliveryPharmacy.md)
|
|
467
472
|
- [DemographicsMatch](DemographicsMatch.md)
|
|
468
473
|
- [DependentResponse](DependentResponse.md)
|
|
469
474
|
- [diagnostics.ConnectResponse](diagnostics.ConnectResponse.md)
|
|
@@ -604,6 +609,7 @@
|
|
|
604
609
|
- [Practitioner](GetPractitionerResponse.md)
|
|
605
610
|
- [GetPreferredPharmacyResponse](GetPreferredPharmacyResponse.md)
|
|
606
611
|
- [ScanUploadUrlRequest](GetScanUploadUrlRequest.md)
|
|
612
|
+
- [GetTestOrderResponse](GetTestOrderResponse.md)
|
|
607
613
|
- [GetTestResultResponse](GetTestResultResponse.md)
|
|
608
614
|
- [GetVectorDocumentChunksResponse](GetVectorDocumentChunksResponse.md)
|
|
609
615
|
- [GetVitalsResponse](GetVitalsResponse.md)
|
|
@@ -1208,6 +1214,7 @@
|
|
|
1208
1214
|
- [ListActivityResponse](ListActivityResponse.md)
|
|
1209
1215
|
- [ListAllergiesResponse](ListAllergiesResponse.md)
|
|
1210
1216
|
- [ListConditionsResponse](ListConditionsResponse.md)
|
|
1217
|
+
- [ListDeliveryOrdersResponse](ListDeliveryOrdersResponse.md)
|
|
1211
1218
|
- [ListDependentsResponse](ListDependentsResponse.md)
|
|
1212
1219
|
- [ListDiagnosticTestsResponse](ListDiagnosticTestsResponse.md)
|
|
1213
1220
|
- [ListDirectivesResponse](ListDirectivesResponse.md)
|
|
@@ -1218,6 +1225,7 @@
|
|
|
1218
1225
|
- [ListMedicalConceptsGetResponse](ListMedicalConceptsGetResponse.md)
|
|
1219
1226
|
- [ListNotificationsResponse](ListNotificationsResponse.md)
|
|
1220
1227
|
- [ObservationListResponse](ListObservationsResponse.md)
|
|
1228
|
+
- [ListOrderItemsResponse](ListOrderItemsResponse.md)
|
|
1221
1229
|
- [ListPatientAppointmentsResponse](ListPatientAppointmentsResponse.md)
|
|
1222
1230
|
- [FieldAgentListPatientsResponse](ListPatientsResponse.md)
|
|
1223
1231
|
- [ListPolicyDocumentsResponse](ListPolicyDocumentsResponse.md)
|
|
@@ -1225,6 +1233,7 @@
|
|
|
1225
1233
|
- [ListQuestionnaireResponsesResponse](ListQuestionnaireResponsesResponse.md)
|
|
1226
1234
|
- [ListSlotsResponse](ListSlotsResponse.md)
|
|
1227
1235
|
- [ListSocialHistoryResponse](ListSocialHistoryResponse.md)
|
|
1236
|
+
- [ListTestOrdersResponse](ListTestOrdersResponse.md)
|
|
1228
1237
|
- [ListVectorCollectionsResponse](ListVectorCollectionsResponse.md)
|
|
1229
1238
|
- [ListVitalsResponse](ListVitalsResponse.md)
|
|
1230
1239
|
- [LocationStatus](LocationStatus.md)
|
|
@@ -1294,6 +1303,9 @@
|
|
|
1294
1303
|
- [OpenAIUpdateAssistantRequest](OpenAIUpdateAssistantRequest.md)
|
|
1295
1304
|
- [OpenAIUpdateAssistantResponse](OpenAIUpdateAssistantResponse.md)
|
|
1296
1305
|
- [OpenLoopVitalsMirrorResult](OpenLoopVitalsMirrorResult.md)
|
|
1306
|
+
- [OrderItem](OrderItem.md)
|
|
1307
|
+
- [OrderPriority](OrderPriority.md)
|
|
1308
|
+
- [OrderStatus](OrderStatus.md)
|
|
1297
1309
|
- [OuraBuildAuthorizationUrlRequest](OuraBuildAuthorizationUrlRequest.md)
|
|
1298
1310
|
- [OuraBuildAuthorizationUrlResponse](OuraBuildAuthorizationUrlResponse.md)
|
|
1299
1311
|
- [OuraDailyActivity](OuraDailyActivity.md)
|
|
@@ -1405,6 +1417,8 @@
|
|
|
1405
1417
|
- [PersonRelationship](PersonRelationship.md)
|
|
1406
1418
|
- [Phone](Phone.md)
|
|
1407
1419
|
- [PhoneType](PhoneType.md)
|
|
1420
|
+
- [PlaceTestOrderRequest](PlaceTestOrderRequest.md)
|
|
1421
|
+
- [PlaceTestOrderResponse](PlaceTestOrderResponse.md)
|
|
1408
1422
|
- [PlaidCreateIdentityVerificationRequest](PlaidCreateIdentityVerificationRequest.md)
|
|
1409
1423
|
- [PlaidGetIdentityVerificationRequest](PlaidGetIdentityVerificationRequest.md)
|
|
1410
1424
|
- [PlaidIdentityVerification](PlaidIdentityVerification.md)
|
|
@@ -1718,6 +1732,8 @@
|
|
|
1718
1732
|
- [SexAtBirth](SexAtBirth.md)
|
|
1719
1733
|
- [Slot](Slot.md)
|
|
1720
1734
|
- [SlotStatus](SlotStatus.md)
|
|
1735
|
+
- [Specimen](Specimen.md)
|
|
1736
|
+
- [SpecimenStatus](SpecimenStatus.md)
|
|
1721
1737
|
- [SpecimenType](SpecimenType.md)
|
|
1722
1738
|
- [StandardErrorResponse](StandardErrorResponse.md)
|
|
1723
1739
|
- [SteadyMDAddAllergyIntoleranceRequest](SteadyMDAddAllergyIntoleranceRequest.md)
|
|
@@ -1831,6 +1847,7 @@
|
|
|
1831
1847
|
- [ErrorResponse](telehealth.ErrorResponse.md)
|
|
1832
1848
|
- [TelehealthToken](TelehealthToken.md)
|
|
1833
1849
|
- [TemperatureRoute](TemperatureRoute.md)
|
|
1850
|
+
- [TestOrder](TestOrder.md)
|
|
1834
1851
|
- [TwilioGetMessageRequest](TwilioGetMessageRequest.md)
|
|
1835
1852
|
- [TwilioListMessagesRequest](TwilioListMessagesRequest.md)
|
|
1836
1853
|
- [TwilioListMessagesResponse](TwilioListMessagesResponse.md)
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
# Create an insurance record
|
|
1
|
+
# Create an insurance record or update the same existing package
|
|
2
2
|
|
|
3
3
|
Operation ID: `connectors.athenaCreateInsurancePackage`
|
|
4
4
|
|
|
5
|
-
Create an insurance record
|
|
5
|
+
Create an insurance record or update the same existing package. Repeated submissions must update the matching patient's policy rather than POST a duplicate. Never replace/deactivate an unrelated package. Verify updated member details by reading the policy back from Athena. Tries sequence numbers 1 → 2 → 3 (Athena's primary/secondary/tertiary insurance slots) since an occupied slot rejects the write. Raises the last error (e.g. an invalid ``package_id``) if none of the three slots accept it, rather than swallowing it — silently returning None here left callers unable to tell "no free slot" apart from "Athena rejected this package outright", both by AthenaInsuranceSync and by direct API/MCP callers of this connector method.
|
|
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
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `connectors.athenaUpdateDriversLicense`
|
|
4
4
|
|
|
5
|
-
Create or replace the patient's Athena driver's-license image. POST is required when the singleton image is absent and PUT when it already exists. Only Athena's 404 response is treated as absent. ``license_fields`` optionally carries the Athena-native text fields (``driverslicensenumber``, ``driverslicensestateid``, ``driverslicenseexpirationdate``, ``driverslicenseyn``) which are written to the patient *record* via ``PUT /patients/{id}
|
|
5
|
+
Create or replace the patient's Athena driver's-license image. POST is required when the singleton image is absent and PUT when it already exists. Only Athena's 404 response is treated as absent. ``license_fields`` optionally carries the Athena-native text fields (``driverslicensenumber``, ``driverslicensestateid``, ``driverslicenseexpirationdate``, ``driverslicenseyn``) which are written to the patient *record* via ``PUT /patients/{id}``. Omitted images must not trigger an empty image upload. If either requested write fails, propagate the error so the caller cannot report both image and text as linked. A successful earlier write is not undone.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -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
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `patient.assistantOcrInsurance`
|
|
4
4
|
|
|
5
|
-
Extract insurance-card fields (member id, group number, plan, RxBIN/PCN/GRP, etc.) from a photo of the card's front using a vision-capable LLM. Mirrors the request/error shape of `patient.assistantOcr`. No authentication is required.
|
|
5
|
+
Extract insurance-card fields (member id, group number, plan, RxBIN/PCN/GRP, etc.) from a photo of the card's front using a vision-capable LLM. Mirrors the request/error shape of `patient.assistantOcr`. Masked member IDs are verified against high-confidence, explicitly labelled document text; unverifiable IDs return an OCR error rather than a guessed value. No authentication is required.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -82,7 +82,7 @@ Request model: [`AssistantOcrInsuranceRequest`](../models/AssistantOcrInsuranceR
|
|
|
82
82
|
| Status | Shape | Content type | Description |
|
|
83
83
|
|---|---|---|---|
|
|
84
84
|
| `400` | `object` | application/json | The image is missing, too large, not a valid data URI, or an unsupported MIME type |
|
|
85
|
-
| `422` | `object` | application/json | The LLM is not configured, the call failed,
|
|
85
|
+
| `422` | `object` | application/json | The LLM is not configured, the call failed, the card was not legible, or a masked member ID could not be verified |
|
|
86
86
|
|
|
87
87
|
## Error examples
|
|
88
88
|
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
# Cancel a diagnostic test order
|
|
2
|
+
|
|
3
|
+
Operation ID: `patient.cancelTestOrder`
|
|
4
|
+
|
|
5
|
+
Cancel a diagnostic test order
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`cancelTestOrder`
|
|
10
|
+
|
|
11
|
+
Signature: `patient.cancelTestOrder(orderId)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<CancelTestOrderResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
None documented.
|
|
24
|
+
|
|
25
|
+
## HTTP
|
|
26
|
+
|
|
27
|
+
`DELETE /patients/orders/{order_id}`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
32
|
+
|---|---|---:|---|---|---|---:|---|
|
|
33
|
+
| `order_id` | `string` | Yes | | | | No | |
|
|
34
|
+
|
|
35
|
+
## Query parameters
|
|
36
|
+
|
|
37
|
+
None.
|
|
38
|
+
|
|
39
|
+
## Body parameters
|
|
40
|
+
|
|
41
|
+
None.
|
|
42
|
+
|
|
43
|
+
Request model: None.
|
|
44
|
+
|
|
45
|
+
## Request example
|
|
46
|
+
|
|
47
|
+
None declared in canonical OpenAPI.
|
|
48
|
+
|
|
49
|
+
## Success responses
|
|
50
|
+
|
|
51
|
+
| Status | Shape | Content type | Description |
|
|
52
|
+
|---|---|---|---|
|
|
53
|
+
| `200` | [`CancelTestOrderResponse`](../models/CancelTestOrderResponse.md) | application/json | Test order cancelled |
|
|
54
|
+
|
|
55
|
+
## Success response examples
|
|
56
|
+
|
|
57
|
+
### 200
|
|
58
|
+
|
|
59
|
+
```json
|
|
60
|
+
{
|
|
61
|
+
"cancelled": true,
|
|
62
|
+
"fhir_id": "string",
|
|
63
|
+
"status": "string"
|
|
64
|
+
}
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Common errors
|
|
68
|
+
|
|
69
|
+
| Status | Shape | Content type | Description |
|
|
70
|
+
|---|---|---|---|
|
|
71
|
+
| `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
72
|
+
| `404` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
|
|
73
|
+
| `409` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
|
|
74
|
+
| `502` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
|
|
75
|
+
|
|
76
|
+
## Error examples
|
|
77
|
+
|
|
78
|
+
### 401
|
|
79
|
+
|
|
80
|
+
```json
|
|
81
|
+
{
|
|
82
|
+
"details": [
|
|
83
|
+
{}
|
|
84
|
+
],
|
|
85
|
+
"error": "string"
|
|
86
|
+
}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### 404
|
|
90
|
+
|
|
91
|
+
```json
|
|
92
|
+
{
|
|
93
|
+
"details": [
|
|
94
|
+
{}
|
|
95
|
+
],
|
|
96
|
+
"error": "string"
|
|
97
|
+
}
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### 409
|
|
101
|
+
|
|
102
|
+
```json
|
|
103
|
+
{
|
|
104
|
+
"details": [
|
|
105
|
+
{}
|
|
106
|
+
],
|
|
107
|
+
"error": "string"
|
|
108
|
+
}
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### 502
|
|
112
|
+
|
|
113
|
+
```json
|
|
114
|
+
{
|
|
115
|
+
"details": [
|
|
116
|
+
{}
|
|
117
|
+
],
|
|
118
|
+
"error": "string"
|
|
119
|
+
}
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
## NodeJS / TypeScript implementation
|
|
123
|
+
|
|
124
|
+
```ts
|
|
125
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
```ts
|
|
129
|
+
const orderId = "<ORDER_ID>";
|
|
130
|
+
|
|
131
|
+
const result = await patient.cancelTestOrder(orderId);
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
## cURL
|
|
135
|
+
|
|
136
|
+
```bash
|
|
137
|
+
curl -X DELETE \
|
|
138
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
139
|
+
'https://dev-api-patient.health.cloud/patients/orders/%3CORDER_ID%3E'
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
## Notes
|
|
143
|
+
|
|
144
|
+
None.
|
|
145
|
+
|
|
146
|
+
## Prepared Test Console scenario
|
|
147
|
+
|
|
148
|
+
No canonical scenario is currently associated.
|
|
149
|
+
|
|
150
|
+
## Real response
|
|
151
|
+
|
|
152
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -0,0 +1,171 @@
|
|
|
1
|
+
# Order a catalog item for delivery
|
|
2
|
+
|
|
3
|
+
Operation ID: `patient.createDeliveryOrder`
|
|
4
|
+
|
|
5
|
+
Order a catalog item for delivery
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`createDeliveryOrder`
|
|
10
|
+
|
|
11
|
+
Signature: `patient.createDeliveryOrder(request)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<DeliveryOrder>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
None documented.
|
|
24
|
+
|
|
25
|
+
## HTTP
|
|
26
|
+
|
|
27
|
+
`POST /patients/delivery-orders`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
None.
|
|
32
|
+
|
|
33
|
+
## Query parameters
|
|
34
|
+
|
|
35
|
+
None.
|
|
36
|
+
|
|
37
|
+
## Body parameters
|
|
38
|
+
|
|
39
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
40
|
+
|---|---|---:|---|---|---|---:|---|
|
|
41
|
+
| `body` | [`CreateDeliveryOrderRequest`](../models/CreateDeliveryOrderRequest.md) | Yes | | | | No | |
|
|
42
|
+
|
|
43
|
+
Request model: [`CreateDeliveryOrderRequest`](../models/CreateDeliveryOrderRequest.md)
|
|
44
|
+
|
|
45
|
+
## Request example
|
|
46
|
+
|
|
47
|
+
None declared in canonical OpenAPI.
|
|
48
|
+
|
|
49
|
+
## Success responses
|
|
50
|
+
|
|
51
|
+
| Status | Shape | Content type | Description |
|
|
52
|
+
|---|---|---|---|
|
|
53
|
+
| `200` | [`DeliveryOrder`](../models/DeliveryOrder.md) | application/json | Previously submitted order for the same idempotency key |
|
|
54
|
+
| `201` | [`DeliveryOrder`](../models/DeliveryOrder.md) | application/json | Delivery submitted to the vendor |
|
|
55
|
+
|
|
56
|
+
## Success response examples
|
|
57
|
+
|
|
58
|
+
None declared in canonical OpenAPI.
|
|
59
|
+
|
|
60
|
+
## Common errors
|
|
61
|
+
|
|
62
|
+
| Status | Shape | Content type | Description |
|
|
63
|
+
|---|---|---|---|
|
|
64
|
+
| `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
65
|
+
| `404` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
|
|
66
|
+
| `409` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
|
|
67
|
+
| `422` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
|
|
68
|
+
| `502` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
|
|
69
|
+
| `503` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
|
|
70
|
+
|
|
71
|
+
## Error examples
|
|
72
|
+
|
|
73
|
+
### 401
|
|
74
|
+
|
|
75
|
+
```json
|
|
76
|
+
{
|
|
77
|
+
"details": [
|
|
78
|
+
{}
|
|
79
|
+
],
|
|
80
|
+
"error": "string"
|
|
81
|
+
}
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
### 404
|
|
85
|
+
|
|
86
|
+
```json
|
|
87
|
+
{
|
|
88
|
+
"details": [
|
|
89
|
+
{}
|
|
90
|
+
],
|
|
91
|
+
"error": "string"
|
|
92
|
+
}
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### 409
|
|
96
|
+
|
|
97
|
+
```json
|
|
98
|
+
{
|
|
99
|
+
"details": [
|
|
100
|
+
{}
|
|
101
|
+
],
|
|
102
|
+
"error": "string"
|
|
103
|
+
}
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### 422
|
|
107
|
+
|
|
108
|
+
```json
|
|
109
|
+
{
|
|
110
|
+
"details": [
|
|
111
|
+
{}
|
|
112
|
+
],
|
|
113
|
+
"error": "string"
|
|
114
|
+
}
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
### 502
|
|
118
|
+
|
|
119
|
+
```json
|
|
120
|
+
{
|
|
121
|
+
"details": [
|
|
122
|
+
{}
|
|
123
|
+
],
|
|
124
|
+
"error": "string"
|
|
125
|
+
}
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### 503
|
|
129
|
+
|
|
130
|
+
```json
|
|
131
|
+
{
|
|
132
|
+
"details": [
|
|
133
|
+
{}
|
|
134
|
+
],
|
|
135
|
+
"error": "string"
|
|
136
|
+
}
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
## NodeJS / TypeScript implementation
|
|
140
|
+
|
|
141
|
+
```ts
|
|
142
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
```ts
|
|
146
|
+
const request = "<REQUEST>";
|
|
147
|
+
|
|
148
|
+
const result = await patient.createDeliveryOrder(request);
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
## cURL
|
|
152
|
+
|
|
153
|
+
```bash
|
|
154
|
+
curl -X POST \
|
|
155
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
156
|
+
-H 'Content-Type: application/json' \
|
|
157
|
+
-d '<REQUEST_BODY_JSON>' \
|
|
158
|
+
'https://dev-api-patient.health.cloud/patients/delivery-orders'
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
## Notes
|
|
162
|
+
|
|
163
|
+
None.
|
|
164
|
+
|
|
165
|
+
## Prepared Test Console scenario
|
|
166
|
+
|
|
167
|
+
No canonical scenario is currently associated.
|
|
168
|
+
|
|
169
|
+
## Real response
|
|
170
|
+
|
|
171
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|