@healthcloudai/hc-sdk 3.13.4 → 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.
Files changed (43) hide show
  1. package/dist/index.cjs +432 -0
  2. package/dist/index.d.cts +1875 -1007
  3. package/dist/index.d.ts +1875 -1007
  4. package/dist/index.js +432 -0
  5. package/docs/clients/PatientClient.md +8 -0
  6. package/docs/docs-manifest.json +28 -3
  7. package/docs/examples/index.md +8 -0
  8. package/docs/index.md +8 -0
  9. package/docs/models/CancelTestOrderResponse.md +19 -0
  10. package/docs/models/CreateDeliveryOrderRequest.md +21 -0
  11. package/docs/models/DeliveryContact.md +24 -0
  12. package/docs/models/DeliveryOrder.md +30 -0
  13. package/docs/models/DeliveryPharmacy.md +25 -0
  14. package/docs/models/GetPatientResponse.md +1 -0
  15. package/docs/models/GetTestOrderResponse.md +44 -0
  16. package/docs/models/ListDeliveryOrdersResponse.md +19 -0
  17. package/docs/models/ListOrderItemsResponse.md +18 -0
  18. package/docs/models/ListTestOrdersResponse.md +18 -0
  19. package/docs/models/OrderItem.md +19 -0
  20. package/docs/models/OrderPriority.md +15 -0
  21. package/docs/models/OrderStatus.md +15 -0
  22. package/docs/models/PatientDemographics.md +1 -0
  23. package/docs/models/PlaceTestOrderRequest.md +43 -0
  24. package/docs/models/PlaceTestOrderResponse.md +44 -0
  25. package/docs/models/Specimen.md +30 -0
  26. package/docs/models/SpecimenStatus.md +15 -0
  27. package/docs/models/TestOrder.md +44 -0
  28. package/docs/models/index.md +17 -0
  29. package/docs/operations/connectors.athenaGetInsurancePackages.md +1 -1
  30. package/docs/operations/fieldagent.listPatients.md +1 -0
  31. package/docs/operations/patient.addPatientIntake.md +12 -1
  32. package/docs/operations/patient.cancelTestOrder.md +152 -0
  33. package/docs/operations/patient.createDeliveryOrder.md +171 -0
  34. package/docs/operations/patient.getDeliveryOrder.md +156 -0
  35. package/docs/operations/patient.getPatient.md +1 -0
  36. package/docs/operations/patient.getPatientSidebarPatientSidebar.md +1 -0
  37. package/docs/operations/patient.getTestOrder.md +194 -0
  38. package/docs/operations/patient.listDeliveryOrders.md +156 -0
  39. package/docs/operations/patient.listOrderItems.md +129 -0
  40. package/docs/operations/patient.listTestOrders.md +201 -0
  41. package/docs/operations/patient.placeTestOrder.md +309 -0
  42. package/docs/operations/patient.submitPatientIntake.md +4 -2
  43. package/package.json +1 -1
@@ -899,6 +899,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
899
899
  - [Classify a voice command into an action code](../operations/patient.assistantClassify.md)
900
900
  - [OCR an identity document via vision LLM](../operations/patient.assistantOcr.md)
901
901
  - [OCR an insurance card via vision LLM](../operations/patient.assistantOcrInsurance.md)
902
+ - [Cancel a diagnostic test order](../operations/patient.cancelTestOrder.md)
902
903
  - [Find-or-create the patient's current open encounter; on an Athena-integrated tenant, also books a walk-in-now Athena appointment, attaches default insurance, and checks in](../operations/patient.checkEncounter.md)
903
904
  - [Check in an encounter via the tenant's connected EHR](../operations/patient.checkInEncounter.md)
904
905
  - [Check insurance eligibility and benefits](../operations/patient.checkPatientInsuranceEligibility.md)
@@ -917,6 +918,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
917
918
  - [Upsert presence](../operations/patient.commsUpsertPresence.md)
918
919
  - [Confirm a password reset](../operations/patient.confirmResetPassword.md)
919
920
  - [Health check](../operations/patient.connect.md)
921
+ - [Order a catalog item for delivery](../operations/patient.createDeliveryOrder.md)
920
922
  - [Create an encounter](../operations/patient.createEncounter.md)
921
923
  - [Create a medication order](../operations/patient.createMedication.md)
922
924
  - [Create a FHIR Questionnaire](../operations/patient.createQuestionnaire.md)
@@ -931,6 +933,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
931
933
  - [Get SMS/phone contact-preference consent](../operations/patient.getCommunicationConsent.md)
932
934
  - [Get the current care session](../operations/patient.getCurrentCareSessionCareSessionsCurrent.md)
933
935
  - [Get the tenant default provider](../operations/patient.getDefaultProvider.md)
936
+ - [Get delivery order and refresh vendor status](../operations/patient.getDeliveryOrder.md)
934
937
  - [Get an encounter](../operations/patient.getEncounter.md)
935
938
  - [List insurance coverage](../operations/patient.getInsurance.md)
936
939
  - [Get the patient's latest open encounter](../operations/patient.getLatestEncounter.md)
@@ -944,21 +947,26 @@ Generated call examples use exact public surface signatures. Workflow examples r
944
947
  - [Get the patient sidebar summary](../operations/patient.getPatientSidebarPatientSidebar.md)
945
948
  - [Get a patient photo](../operations/patient.getPhoto.md)
946
949
  - [Get preferred pharmacy](../operations/patient.getPreferredPharmacy.md)
950
+ - [Get a diagnostic test order](../operations/patient.getTestOrder.md)
947
951
  - [Import activity](../operations/patient.importActivity.md)
948
952
  - [Import a health record](../operations/patient.importHealthRecord.md)
949
953
  - [Import vitals](../operations/patient.importVitals.md)
950
954
  - [Check health-record import status](../operations/patient.initHealthRecordImport.md)
951
955
  - [List assistant actions](../operations/patient.listActions.md)
952
956
  - [List activity](../operations/patient.listActivity.md)
957
+ - [List the patient's delivery orders](../operations/patient.listDeliveryOrders.md)
953
958
  - [List dependents](../operations/patient.listDependents.md)
954
959
  - [List encounters](../operations/patient.listEncounters.md)
955
960
  - [List knowledge-base collections and entries](../operations/patient.listKnowledge.md)
956
961
  - [List medications](../operations/patient.listMedications.md)
957
962
  - [List notifications](../operations/patient.listNotifications.md)
963
+ - [List order items](../operations/patient.listOrderItems.md)
958
964
  - [List claims for the authenticated patient](../operations/patient.listPatientInsuranceClaims.md)
965
+ - [List diagnostic test orders](../operations/patient.listTestOrders.md)
959
966
  - [Log in a patient](../operations/patient.login.md)
960
967
  - [Find nearby healthcare locations](../operations/patient.nearestLocations.md)
961
968
  - [Get a photo upload URL](../operations/patient.photoUploadUrl.md)
969
+ - [Place a diagnostic test order](../operations/patient.placeTestOrder.md)
962
970
  - [Refresh patient access tokens](../operations/patient.refreshToken.md)
963
971
  - [Register a new patient](../operations/patient.register.md)
964
972
  - [Resend the email verification OTP](../operations/patient.resendVerificationCode.md)
package/docs/index.md CHANGED
@@ -907,6 +907,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
907
907
  - [Classify a voice command into an action code](operations/patient.assistantClassify.md) (`patient.assistantClassify`)
908
908
  - [OCR an identity document via vision LLM](operations/patient.assistantOcr.md) (`patient.assistantOcr`)
909
909
  - [OCR an insurance card via vision LLM](operations/patient.assistantOcrInsurance.md) (`patient.assistantOcrInsurance`)
910
+ - [Cancel a diagnostic test order](operations/patient.cancelTestOrder.md) (`patient.cancelTestOrder`)
910
911
  - [Find-or-create the patient's current open encounter; on an Athena-integrated tenant, also books a walk-in-now Athena appointment, attaches default insurance, and checks in](operations/patient.checkEncounter.md) (`patient.checkEncounter`)
911
912
  - [Check in an encounter via the tenant's connected EHR](operations/patient.checkInEncounter.md) (`patient.checkInEncounter`)
912
913
  - [Check insurance eligibility and benefits](operations/patient.checkPatientInsuranceEligibility.md) (`patient.checkPatientInsuranceEligibility`)
@@ -925,6 +926,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
925
926
  - [Upsert presence](operations/patient.commsUpsertPresence.md) (`patient.commsUpsertPresence`)
926
927
  - [Confirm a password reset](operations/patient.confirmResetPassword.md) (`patient.confirmResetPassword`)
927
928
  - [Health check](operations/patient.connect.md) (`patient.connect`)
929
+ - [Order a catalog item for delivery](operations/patient.createDeliveryOrder.md) (`patient.createDeliveryOrder`)
928
930
  - [Create an encounter](operations/patient.createEncounter.md) (`patient.createEncounter`)
929
931
  - [Create a medication order](operations/patient.createMedication.md) (`patient.createMedication`)
930
932
  - [Create a FHIR Questionnaire](operations/patient.createQuestionnaire.md) (`patient.createQuestionnaire`)
@@ -939,6 +941,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
939
941
  - [Get SMS/phone contact-preference consent](operations/patient.getCommunicationConsent.md) (`patient.getCommunicationConsent`)
940
942
  - [Get the current care session](operations/patient.getCurrentCareSessionCareSessionsCurrent.md) (`patient.getCurrentCareSessionCareSessionsCurrent`)
941
943
  - [Get the tenant default provider](operations/patient.getDefaultProvider.md) (`patient.getDefaultProvider`)
944
+ - [Get delivery order and refresh vendor status](operations/patient.getDeliveryOrder.md) (`patient.getDeliveryOrder`)
942
945
  - [Get an encounter](operations/patient.getEncounter.md) (`patient.getEncounter`)
943
946
  - [List insurance coverage](operations/patient.getInsurance.md) (`patient.getInsurance`)
944
947
  - [Get the patient's latest open encounter](operations/patient.getLatestEncounter.md) (`patient.getLatestEncounter`)
@@ -952,21 +955,26 @@ This directory is generated from the shared structured docs data. Do not edit ge
952
955
  - [Get the patient sidebar summary](operations/patient.getPatientSidebarPatientSidebar.md) (`patient.getPatientSidebarPatientSidebar`)
953
956
  - [Get a patient photo](operations/patient.getPhoto.md) (`patient.getPhoto`)
954
957
  - [Get preferred pharmacy](operations/patient.getPreferredPharmacy.md) (`patient.getPreferredPharmacy`)
958
+ - [Get a diagnostic test order](operations/patient.getTestOrder.md) (`patient.getTestOrder`)
955
959
  - [Import activity](operations/patient.importActivity.md) (`patient.importActivity`)
956
960
  - [Import a health record](operations/patient.importHealthRecord.md) (`patient.importHealthRecord`)
957
961
  - [Import vitals](operations/patient.importVitals.md) (`patient.importVitals`)
958
962
  - [Check health-record import status](operations/patient.initHealthRecordImport.md) (`patient.initHealthRecordImport`)
959
963
  - [List assistant actions](operations/patient.listActions.md) (`patient.listActions`)
960
964
  - [List activity](operations/patient.listActivity.md) (`patient.listActivity`)
965
+ - [List the patient's delivery orders](operations/patient.listDeliveryOrders.md) (`patient.listDeliveryOrders`)
961
966
  - [List dependents](operations/patient.listDependents.md) (`patient.listDependents`)
962
967
  - [List encounters](operations/patient.listEncounters.md) (`patient.listEncounters`)
963
968
  - [List knowledge-base collections and entries](operations/patient.listKnowledge.md) (`patient.listKnowledge`)
964
969
  - [List medications](operations/patient.listMedications.md) (`patient.listMedications`)
965
970
  - [List notifications](operations/patient.listNotifications.md) (`patient.listNotifications`)
971
+ - [List order items](operations/patient.listOrderItems.md) (`patient.listOrderItems`)
966
972
  - [List claims for the authenticated patient](operations/patient.listPatientInsuranceClaims.md) (`patient.listPatientInsuranceClaims`)
973
+ - [List diagnostic test orders](operations/patient.listTestOrders.md) (`patient.listTestOrders`)
967
974
  - [Log in a patient](operations/patient.login.md) (`patient.login`)
968
975
  - [Find nearby healthcare locations](operations/patient.nearestLocations.md) (`patient.nearestLocations`)
969
976
  - [Get a photo upload URL](operations/patient.photoUploadUrl.md) (`patient.photoUploadUrl`)
977
+ - [Place a diagnostic test order](operations/patient.placeTestOrder.md) (`patient.placeTestOrder`)
970
978
  - [Refresh patient access tokens](operations/patient.refreshToken.md) (`patient.refreshToken`)
971
979
  - [Register a new patient](operations/patient.register.md) (`patient.register`)
972
980
  - [Resend the email verification OTP](operations/patient.resendVerificationCode.md) (`patient.resendVerificationCode`)
@@ -0,0 +1,19 @@
1
+ # CancelTestOrderResponse
2
+
3
+ Model ID: `CancelTestOrderResponse`
4
+
5
+ Response for DELETE /patients/orders/{order_id}.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `cancelled` | `boolean` | Yes | | | | No | Always `true` when the order was cancelled. |
14
+ | `fhir_id` | `string` | Yes | | | | No | FHIR ServiceRequest ID of the cancelled order. |
15
+ | `status` | `string` | Yes | | | | No | Resulting order status; `revoked` once cancelled. |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,21 @@
1
+ # CreateDeliveryOrderRequest
2
+
3
+ Model ID: `CreateDeliveryOrderRequest`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `dropoff` | [`DeliveryContact`](./DeliveryContact.md) | Yes | | | | No | |
14
+ | `idempotency_key` | `string` | Yes | uuid | | | No | Reuse this UUID when retrying the same purchase. |
15
+ | `order_item_id` | `string` | Yes | uuid | | | No | |
16
+ | `pickup_pharmacy` | [`DeliveryPharmacy`](./DeliveryPharmacy.md) | Yes | | | | No | |
17
+ | `vendor` | `string` | No | | | `"uber"` | No | |
18
+
19
+ ## Example
20
+
21
+ None declared in canonical OpenAPI.
@@ -0,0 +1,24 @@
1
+ # DeliveryContact
2
+
3
+ Model ID: `DeliveryContact`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `city` | `string` | Yes | | | | No | |
14
+ | `country` | `string` | No | | | `"US"` | No | |
15
+ | `name` | `string` | Yes | | | | No | |
16
+ | `notes` | `string` | No | | | `""` | No | |
17
+ | `phone_number` | `string` | Yes | | | | No | |
18
+ | `state` | `string` | Yes | | | | No | |
19
+ | `street_address` | `string` | Yes | | | | No | |
20
+ | `zip_code` | `string` | Yes | | | | No | |
21
+
22
+ ## Example
23
+
24
+ None declared in canonical OpenAPI.
@@ -0,0 +1,30 @@
1
+ # DeliveryOrder
2
+
3
+ Model ID: `DeliveryOrder`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `created_at` | `string` | Yes | date-time | | | No | |
14
+ | `delivery_order_id` | `string` | Yes | uuid | | | No | |
15
+ | `fhir_status` | `string` | No | | draft, active, suspended, cancelled, completed, entered-in-error | `"draft"` | No | |
16
+ | `notification_status` | `string` | No | | pending, sending, sent, failed, unknown | `"pending"` | No | |
17
+ | `order_item_id` | `string` | Yes | uuid | | | No | |
18
+ | `order_reference` | `string` | Yes | | | | No | |
19
+ | `pickup_pharmacy` | [`DeliveryPharmacy`](./DeliveryPharmacy.md) | Yes | | | | No | |
20
+ | `resource_type` | `string` | No | | | `"SupplyRequest"` | No | |
21
+ | `status` | `string` | Yes | | processing, dispatching, submitted, failed, submission_unknown | | No | |
22
+ | `tracking_url` | `string|null` | No | | | | Yes | |
23
+ | `updated_at` | `string` | Yes | date-time | | | No | |
24
+ | `vendor` | `string` | Yes | | | | No | |
25
+ | `vendor_order_id` | `string|null` | No | | | | Yes | |
26
+ | `vendor_status` | `string|null` | No | | | | Yes | |
27
+
28
+ ## Example
29
+
30
+ None declared in canonical OpenAPI.
@@ -0,0 +1,25 @@
1
+ # DeliveryPharmacy
2
+
3
+ Model ID: `DeliveryPharmacy`
4
+
5
+ Caller-selected pharmacy pickup location and notification recipient.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `city` | `string` | Yes | | | | No | |
14
+ | `country` | `string` | No | | | `"US"` | No | |
15
+ | `email` | `string` | Yes | email | | | No | |
16
+ | `name` | `string` | Yes | | | | No | |
17
+ | `notes` | `string` | No | | | `""` | No | |
18
+ | `phone_number` | `string` | Yes | | | | No | |
19
+ | `state` | `string` | Yes | | | | No | |
20
+ | `street_address` | `string` | Yes | | | | No | |
21
+ | `zip_code` | `string` | Yes | | | | No | |
22
+
23
+ ## Example
24
+
25
+ None declared in canonical OpenAPI.
@@ -35,6 +35,7 @@ Type: `object`
35
35
  | `flags` | `object` | No | | | | No | Boolean feature/state flags for this patient |
36
36
  | `gender` | [`Gender`](./Gender.md) | Yes | | | | No | Administrative gender: male, female, other, or unknown. |
37
37
  | `gender_identity` | [`GenderIdentity`](./GenderIdentity.md) | No | | | | Yes | Gender identity (US Core Patient extension). |
38
+ | `impilo_patient_id` | `string|null` | No | | | | Yes | Impilo patient identifier when this patient is linked to Impilo RPM |
38
39
  | `insurance` | array of [`Insurance`](./Insurance.md) | No | | | | No | Patient's insurance coverages, in coordination-of-benefits order. |
39
40
  | `links` | array of [`PatientLink`](./PatientLink.md) | No | | | | No | Links to related or duplicate patient records. |
40
41
  | `managing_organization_id` | `string|null` | No | | | | Yes | FHIR Organization resource id |
@@ -0,0 +1,44 @@
1
+ # GetTestOrderResponse
2
+
3
+ Model ID: `GetTestOrderResponse`
4
+
5
+ Response for GET /patients/orders/{order_id}. 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,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
+ # 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.
@@ -0,0 +1,15 @@
1
+ # OrderPriority
2
+
3
+ Model ID: `OrderPriority`
4
+
5
+ No description.
6
+
7
+ Type: `string`
8
+
9
+ ## Fields
10
+
11
+ No fields.
12
+
13
+ ## Example
14
+
15
+ None declared in canonical OpenAPI.
@@ -0,0 +1,15 @@
1
+ # OrderStatus
2
+
3
+ Model ID: `OrderStatus`
4
+
5
+ No description.
6
+
7
+ Type: `string`
8
+
9
+ ## Fields
10
+
11
+ No fields.
12
+
13
+ ## Example
14
+
15
+ 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,15 @@
1
+ # SpecimenStatus
2
+
3
+ Model ID: `SpecimenStatus`
4
+
5
+ No description.
6
+
7
+ Type: `string`
8
+
9
+ ## Fields
10
+
11
+ No fields.
12
+
13
+ ## Example
14
+
15
+ 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.