@healthcloudai/hc-sdk 3.23.0 → 3.24.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.
Files changed (34) hide show
  1. package/dist/index.cjs +101 -5
  2. package/dist/index.d.cts +1107 -3
  3. package/dist/index.d.ts +1107 -3
  4. package/dist/index.js +98 -5
  5. package/docs/clients/ProviderClient.md +7 -0
  6. package/docs/configuration.md +2 -2
  7. package/docs/docs-manifest.json +26 -3
  8. package/docs/examples/index.md +7 -0
  9. package/docs/index.md +7 -0
  10. package/docs/models/CreateProviderPatientRequest.md +22 -0
  11. package/docs/models/LabOrder.md +35 -0
  12. package/docs/models/LabOrderDiagnosis.md +18 -0
  13. package/docs/models/LabOrderErrorResponse.md +21 -0
  14. package/docs/models/LabOrderItemRequest.md +17 -0
  15. package/docs/models/LabOrderProvider.md +20 -0
  16. package/docs/models/LabOrderRequisitionResponse.md +20 -0
  17. package/docs/models/LabOrderTest.md +19 -0
  18. package/docs/models/LabOrderUnsentItem.md +19 -0
  19. package/docs/models/ListLabOrdersResponse.md +18 -0
  20. package/docs/models/PlaceLabOrderRequest.md +27 -0
  21. package/docs/models/PlaceLabOrderResponse.md +20 -0
  22. package/docs/models/ProviderEncounterStatusCounts.md +21 -0
  23. package/docs/models/ProviderHomeSummaryResponse.md +19 -0
  24. package/docs/models/ProviderPatientListResponse.md +19 -0
  25. package/docs/models/ProviderPatientResponse.md +17 -0
  26. package/docs/models/index.md +16 -0
  27. package/docs/operations/provider.createPatient.md +155 -0
  28. package/docs/operations/provider.getHomeSummary.md +115 -0
  29. package/docs/operations/provider.getLabOrder.md +179 -0
  30. package/docs/operations/provider.getLabOrderRequisition.md +148 -0
  31. package/docs/operations/provider.listLabOrders.md +198 -0
  32. package/docs/operations/provider.listPatients.md +154 -0
  33. package/docs/operations/provider.placeLabOrder.md +384 -0
  34. package/package.json +1 -1
@@ -0,0 +1,21 @@
1
+ # ProviderEncounterStatusCounts
2
+
3
+ Model ID: `ProviderEncounterStatusCounts`
4
+
5
+ Encounters the calling practitioner takes part in, by HealthCloud encounter status.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `arrived` | `integer` | Yes | | | | No | Patients who have arrived. |
14
+ | `finished` | `integer` | Yes | | | | No | Completed encounters. |
15
+ | `in_progress` | `integer` | Yes | | | | No | Encounters in progress. |
16
+ | `planned` | `integer` | Yes | | | | No | Encounters not yet started. |
17
+ | `triaged` | `integer` | Yes | | | | No | Patients triaged and waiting for the provider. |
18
+
19
+ ## Example
20
+
21
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # ProviderHomeSummaryResponse
2
+
3
+ Model ID: `ProviderHomeSummaryResponse`
4
+
5
+ Counts for the provider's home screen, scoped to the calling practitioner.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `as_of` | `string` | Yes | | | | No | UTC time the counts were read, ISO 8601 with offset (e.g. 2026-11-05T12:00:00+00:00). |
14
+ | `encounters` | [`ProviderEncounterStatusCounts`](./ProviderEncounterStatusCounts.md) | Yes | | | | No | Encounter counts by status. |
15
+ | `patients_total` | `integer` | Yes | | | | No | Patients on the calling practitioner's care team. |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # ProviderPatientListResponse
2
+
3
+ Model ID: `ProviderPatientListResponse`
4
+
5
+ One page of the calling practitioner's patients, as demographic summaries.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `next_page_token` | `string|null` | No | | | | Yes | Pass as page_token to read the next page. Absent on the last page. |
14
+ | `patients` | array of [`ProviderPatientSummary`](./ProviderPatientSummary.md) | Yes | | | | No | Patients on this page, in the FHIR store's order. |
15
+ | `total` | `integer` | Yes | | | | No | Number of patients on this page. |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,17 @@
1
+ # ProviderPatientResponse
2
+
3
+ Model ID: `ProviderPatientResponse`
4
+
5
+ One patient, as a demographic summary.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `patient` | [`ProviderPatientSummary`](./ProviderPatientSummary.md) | Yes | | | | No | The patient's demographic summary. |
14
+
15
+ ## Example
16
+
17
+ None declared in canonical OpenAPI.
@@ -461,6 +461,7 @@
461
461
  - [CreateMedicationRequest](CreateMedicationRequest.md)
462
462
  - [CreateMedicationResponse](CreateMedicationResponse.md)
463
463
  - [CreateTelehealthTokenRequest](CreatePatientTokenRequest.md)
464
+ - [CreateProviderPatientRequest](CreateProviderPatientRequest.md)
464
465
  - [CreateTelehealthTokenRequest](CreateProviderTokenRequest.md)
465
466
  - [CreateQuestionnaireRequest](CreateQuestionnaireRequest.md)
466
467
  - [CreateQuestionnaireResponse](CreateQuestionnaireResponse.md)
@@ -1244,6 +1245,14 @@
1244
1245
  - [KnowledgeCollection](KnowledgeCollection.md)
1245
1246
  - [KnowledgeEntrySummary](KnowledgeEntrySummary.md)
1246
1247
  - [KnowledgeSearchResult](KnowledgeSearchResult.md)
1248
+ - [LabOrder](LabOrder.md)
1249
+ - [LabOrderDiagnosis](LabOrderDiagnosis.md)
1250
+ - [LabOrderErrorResponse](LabOrderErrorResponse.md)
1251
+ - [LabOrderItemRequest](LabOrderItemRequest.md)
1252
+ - [LabOrderProvider](LabOrderProvider.md)
1253
+ - [LabOrderRequisitionResponse](LabOrderRequisitionResponse.md)
1254
+ - [LabOrderTest](LabOrderTest.md)
1255
+ - [LabOrderUnsentItem](LabOrderUnsentItem.md)
1247
1256
  - [LicenseVerification](LicenseVerification.md)
1248
1257
  - [ListActionsResponse](ListActionsResponse.md)
1249
1258
  - [ListActivityResponse](ListActivityResponse.md)
@@ -1258,6 +1267,7 @@
1258
1267
  - [ListImmunizationsResponse](ListImmunizationsResponse.md)
1259
1268
  - [ListImpiloDevicesResponse](ListImpiloDevicesResponse.md)
1260
1269
  - [ListKnowledgeResponse](ListKnowledgeResponse.md)
1270
+ - [ListLabOrdersResponse](ListLabOrdersResponse.md)
1261
1271
  - [ListMedicalConceptsGetResponse](ListMedicalConceptsGetResponse.md)
1262
1272
  - [ListNotificationsResponse](ListNotificationsResponse.md)
1263
1273
  - [ObservationListResponse](ListObservationsResponse.md)
@@ -1461,6 +1471,8 @@
1461
1471
  - [PersonRelationship](PersonRelationship.md)
1462
1472
  - [Phone](Phone.md)
1463
1473
  - [PhoneType](PhoneType.md)
1474
+ - [PlaceLabOrderRequest](PlaceLabOrderRequest.md)
1475
+ - [PlaceLabOrderResponse](PlaceLabOrderResponse.md)
1464
1476
  - [PlaceTestOrderRequest](PlaceTestOrderRequest.md)
1465
1477
  - [PlaceTestOrderResponse](PlaceTestOrderResponse.md)
1466
1478
  - [PlaidCreateIdentityVerificationRequest](PlaidCreateIdentityVerificationRequest.md)
@@ -1544,7 +1556,9 @@
1544
1556
  - [ProviderEncounterListResponse](ProviderEncounterListResponse.md)
1545
1557
  - [ProviderEncounterRecord](ProviderEncounterRecord.md)
1546
1558
  - [ProviderEncounterResponse](ProviderEncounterResponse.md)
1559
+ - [ProviderEncounterStatusCounts](ProviderEncounterStatusCounts.md)
1547
1560
  - [ProviderGender](ProviderGender.md)
1561
+ - [ProviderHomeSummaryResponse](ProviderHomeSummaryResponse.md)
1548
1562
  - [ProviderIdentifier](ProviderIdentifier.md)
1549
1563
  - [ProviderIdentifierType](ProviderIdentifierType.md)
1550
1564
  - [ProviderLanguage](ProviderLanguage.md)
@@ -1557,9 +1571,11 @@
1557
1571
  - [ProviderLocationRequest](ProviderLocationRequest.md)
1558
1572
  - [ProviderOnboardingStatus](ProviderOnboardingStatus.md)
1559
1573
  - [ProviderPatientAddress](ProviderPatientAddress.md)
1574
+ - [ProviderPatientListResponse](ProviderPatientListResponse.md)
1560
1575
  - [ProviderPatientPhone](ProviderPatientPhone.md)
1561
1576
  - [ProviderPatientRecordResources](ProviderPatientRecordResources.md)
1562
1577
  - [ProviderPatientRecordResponse](ProviderPatientRecordResponse.md)
1578
+ - [ProviderPatientResponse](ProviderPatientResponse.md)
1563
1579
  - [ProviderPatientSummary](ProviderPatientSummary.md)
1564
1580
  - [ProviderPostgraduateTraining](ProviderPostgraduateTraining.md)
1565
1581
  - [ProviderProfessionalLiability](ProviderProfessionalLiability.md)
@@ -0,0 +1,155 @@
1
+ # Create a patient on the calling practitioner's care team
2
+
3
+ Operation ID: `provider.createPatient`
4
+
5
+ Creates a FHIR Patient in the provider's own tenant, assigned to the calling practitioner, and returns its demographic summary.
6
+
7
+ ## Public method
8
+
9
+ `createPatient`
10
+
11
+ Signature: `provider.createPatient(request)`
12
+
13
+ Return type: `Promise<ProviderPatientResponse>`
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`
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` | [`CreateProviderPatientRequest`](../models/CreateProviderPatientRequest.md) | No | | | | Yes | |
42
+
43
+ Request model: [`CreateProviderPatientRequest`](../models/CreateProviderPatientRequest.md)
44
+
45
+ ## Request example
46
+
47
+ ```json
48
+ {
49
+ "date_of_birth": "2026-01-01",
50
+ "email": "user@example.com",
51
+ "first_name": "string",
52
+ "gender": "male",
53
+ "last_name": "string"
54
+ }
55
+ ```
56
+
57
+ ## Success responses
58
+
59
+ | Status | Shape | Content type | Description |
60
+ |---|---|---|---|
61
+ | `201` | [`ProviderPatientResponse`](../models/ProviderPatientResponse.md) | application/json | Patient created |
62
+
63
+ ## Success response examples
64
+
65
+ ### 201
66
+
67
+ ```json
68
+ {
69
+ "patient": {
70
+ "address": {
71
+ "city": "string",
72
+ "country": "string",
73
+ "state": "string",
74
+ "street1": "string",
75
+ "street2": "string",
76
+ "zip_code": "string"
77
+ },
78
+ "date_of_birth": "string",
79
+ "first_name": "string",
80
+ "gender": "string",
81
+ "last_name": "string",
82
+ "patient_id": "string",
83
+ "phone": {
84
+ "extension": "string",
85
+ "number": "string",
86
+ "type": "string"
87
+ }
88
+ }
89
+ }
90
+ ```
91
+
92
+ ## Common errors
93
+
94
+ | Status | Shape | Content type | Description |
95
+ |---|---|---|---|
96
+ | `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Invalid patient details |
97
+ | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider authorization required |
98
+
99
+ ## Error examples
100
+
101
+ ### 400
102
+
103
+ ```json
104
+ {
105
+ "error": "string"
106
+ }
107
+ ```
108
+
109
+ ### 401
110
+
111
+ ```json
112
+ {
113
+ "error": "string"
114
+ }
115
+ ```
116
+
117
+ ## NodeJS / TypeScript implementation
118
+
119
+ ```ts
120
+ import { HCSDK } from "@healthcloudai/hc-sdk";
121
+ ```
122
+
123
+ ```ts
124
+ const request = {
125
+ "date_of_birth": "2026-01-01",
126
+ "email": "user@example.com",
127
+ "first_name": "string",
128
+ "gender": "male",
129
+ "last_name": "string"
130
+ };
131
+
132
+ const result = await provider.createPatient(request);
133
+ ```
134
+
135
+ ## cURL
136
+
137
+ ```bash
138
+ curl -X POST \
139
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
140
+ -H 'Content-Type: application/json' \
141
+ -d '{"date_of_birth":"2026-01-01","email":"user@example.com","first_name":"string","gender":"male","last_name":"string"}' \
142
+ 'https://dev-api-provider.health.cloud/patients'
143
+ ```
144
+
145
+ ## Notes
146
+
147
+ None.
148
+
149
+ ## Prepared Test Console scenario
150
+
151
+ No canonical scenario is currently associated.
152
+
153
+ ## Real response
154
+
155
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -0,0 +1,115 @@
1
+ # Counts for the provider's home screen
2
+
3
+ Operation ID: `provider.getHomeSummary`
4
+
5
+ The calling practitioner's own patients and encounters-by-status (never tenant-wide), counted by the FHIR store.
6
+
7
+ ## Public method
8
+
9
+ `getHomeSummary`
10
+
11
+ Signature: `provider.getHomeSummary()`
12
+
13
+ Return type: `Promise<ProviderHomeSummaryResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `GET /dashboard/summary`
28
+
29
+ ## Path parameters
30
+
31
+ None.
32
+
33
+ ## Query parameters
34
+
35
+ None.
36
+
37
+ ## Body parameters
38
+
39
+ None.
40
+
41
+ Request model: None.
42
+
43
+ ## Request example
44
+
45
+ None declared in canonical OpenAPI.
46
+
47
+ ## Success responses
48
+
49
+ | Status | Shape | Content type | Description |
50
+ |---|---|---|---|
51
+ | `200` | [`ProviderHomeSummaryResponse`](../models/ProviderHomeSummaryResponse.md) | application/json | Home screen counts |
52
+
53
+ ## Success response examples
54
+
55
+ ### 200
56
+
57
+ ```json
58
+ {
59
+ "as_of": "string",
60
+ "encounters": {
61
+ "arrived": 0,
62
+ "finished": 0,
63
+ "in_progress": 0,
64
+ "planned": 0,
65
+ "triaged": 0
66
+ },
67
+ "patients_total": 0
68
+ }
69
+ ```
70
+
71
+ ## Common errors
72
+
73
+ | Status | Shape | Content type | Description |
74
+ |---|---|---|---|
75
+ | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider authorization required |
76
+
77
+ ## Error examples
78
+
79
+ ### 401
80
+
81
+ ```json
82
+ {
83
+ "error": "string"
84
+ }
85
+ ```
86
+
87
+ ## NodeJS / TypeScript implementation
88
+
89
+ ```ts
90
+ import { HCSDK } from "@healthcloudai/hc-sdk";
91
+ ```
92
+
93
+ ```ts
94
+ const result = await provider.getHomeSummary();
95
+ ```
96
+
97
+ ## cURL
98
+
99
+ ```bash
100
+ curl -X GET \
101
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
102
+ 'https://dev-api-provider.health.cloud/dashboard/summary'
103
+ ```
104
+
105
+ ## Notes
106
+
107
+ None.
108
+
109
+ ## Prepared Test Console scenario
110
+
111
+ No canonical scenario is currently associated.
112
+
113
+ ## Real response
114
+
115
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -0,0 +1,179 @@
1
+ # Get one Quest lab order requisition
2
+
3
+ Operation ID: `provider.getLabOrder`
4
+
5
+ Get one Quest requisition of a patient in the authenticated provider's tenant: status, Quest placer number, tests, diagnoses, ordering provider and whether a requisition PDF is stored.
6
+
7
+ ## Public method
8
+
9
+ `getLabOrder`
10
+
11
+ Signature: `provider.getLabOrder(patientId, orderId)`
12
+
13
+ Return type: `Promise<LabOrder>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `GET /patients/{patient_id}/lab-orders/{order_id}`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `patient_id` | `string` | Yes | | | | No | |
34
+ | `order_id` | `string` | Yes | | | | No | |
35
+
36
+ ## Query parameters
37
+
38
+ None.
39
+
40
+ ## Body parameters
41
+
42
+ None.
43
+
44
+ Request model: None.
45
+
46
+ ## Request example
47
+
48
+ None declared in canonical OpenAPI.
49
+
50
+ ## Success responses
51
+
52
+ | Status | Shape | Content type | Description |
53
+ |---|---|---|---|
54
+ | `200` | [`LabOrder`](../models/LabOrder.md) | application/json | The Quest requisition |
55
+
56
+ ## Success response examples
57
+
58
+ ### 200
59
+
60
+ ```json
61
+ {
62
+ "abn_required": false,
63
+ "ack_code": "AA",
64
+ "authored_at": "2026-10-28T09:15:00-04:00",
65
+ "collection_modality": "psc",
66
+ "diagnoses": [
67
+ {
68
+ "code": "R53.83",
69
+ "description": "Other fatigue"
70
+ }
71
+ ],
72
+ "expected_collection_at": "2026-10-29T08:00:00-04:00",
73
+ "fhir_status": "active",
74
+ "lab": "MET",
75
+ "order_group_id": "00000000-0000-4000-8000-000000000030",
76
+ "order_id": "00000000-0000-4000-8000-000000000040",
77
+ "ordering_provider": {
78
+ "first_name": "Alex",
79
+ "last_name": "Smith",
80
+ "npi": "1234567893",
81
+ "source": "roster"
82
+ },
83
+ "patient_id": "patient-example-001",
84
+ "placer_order_number": "HC0123456789ABCDEF01",
85
+ "quest_http_status": null,
86
+ "requester": "Practitioner/practitioner-example-001",
87
+ "requisition_available": true,
88
+ "source": "provider_app",
89
+ "status": "accepted",
90
+ "tests": [
91
+ {
92
+ "catalog_item_id": "00000000-0000-4000-8000-000000000020",
93
+ "description": "URINALYSIS, COMPLETE",
94
+ "quest_code": "5463"
95
+ }
96
+ ]
97
+ }
98
+ ```
99
+
100
+ ## Common errors
101
+
102
+ | Status | Shape | Content type | Description |
103
+ |---|---|---|---|
104
+ | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider Bearer authentication is required |
105
+ | `403` | [`LabOrderErrorResponse`](../models/LabOrderErrorResponse.md) | application/json | Only Provider-pool tokens are accepted |
106
+ | `404` | [`LabOrderErrorResponse`](../models/LabOrderErrorResponse.md) | application/json | No Quest lab order with this id exists for the patient in the caller's tenant |
107
+ | `500` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Unexpected failure |
108
+
109
+ ## Error examples
110
+
111
+ ### 401 — No provider JWT
112
+
113
+ ```json
114
+ {
115
+ "error": "Provider authorization required"
116
+ }
117
+ ```
118
+
119
+ ### 403 — Other pool
120
+
121
+ ```json
122
+ {
123
+ "code": "provider_pool_required",
124
+ "error": "Provider authorization required",
125
+ "fields": []
126
+ }
127
+ ```
128
+
129
+ ### 404 — Unknown order
130
+
131
+ ```json
132
+ {
133
+ "code": "lab_order_not_found",
134
+ "error": "Lab order not found",
135
+ "fields": []
136
+ }
137
+ ```
138
+
139
+ ### 500 — Unexpected failure
140
+
141
+ ```json
142
+ {
143
+ "error": "Lab order service failed; retry the request"
144
+ }
145
+ ```
146
+
147
+ ## NodeJS / TypeScript implementation
148
+
149
+ ```ts
150
+ import { HCSDK } from "@healthcloudai/hc-sdk";
151
+ ```
152
+
153
+ ```ts
154
+ const patientId = "<PATIENT_ID>";
155
+
156
+ const orderId = "<ORDER_ID>";
157
+
158
+ const result = await provider.getLabOrder(patientId, orderId);
159
+ ```
160
+
161
+ ## cURL
162
+
163
+ ```bash
164
+ curl -X GET \
165
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
166
+ 'https://dev-api-provider.health.cloud/patients/%3CPATIENT_ID%3E/lab-orders/%3CORDER_ID%3E'
167
+ ```
168
+
169
+ ## Notes
170
+
171
+ None.
172
+
173
+ ## Prepared Test Console scenario
174
+
175
+ No canonical scenario is currently associated.
176
+
177
+ ## Real response
178
+
179
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.