@healthcloudai/hc-sdk 3.25.0 → 3.27.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 (41) hide show
  1. package/dist/index.cjs +117 -1
  2. package/dist/index.d.cts +2470 -276
  3. package/dist/index.d.ts +2470 -276
  4. package/dist/index.js +117 -1
  5. package/docs/clients/PatientClient.md +1 -0
  6. package/docs/clients/ProviderClient.md +6 -0
  7. package/docs/docs-manifest.json +28 -3
  8. package/docs/examples/index.md +7 -0
  9. package/docs/index.md +7 -0
  10. package/docs/models/CheckInsuranceBenefitsRequest.md +19 -0
  11. package/docs/models/CheckInsuranceBenefitsResponse.md +28 -0
  12. package/docs/models/CommunicationConsent.md +24 -0
  13. package/docs/models/Dependent.md +21 -0
  14. package/docs/models/DependentRelationship.md +15 -0
  15. package/docs/models/EncounterMedicationInput.md +29 -0
  16. package/docs/models/EncounterMedicationsResponse.md +19 -0
  17. package/docs/models/InsuranceBenefit.md +27 -0
  18. package/docs/models/LabCatalogItem.md +24 -0
  19. package/docs/models/LabCatalogResponse.md +18 -0
  20. package/docs/models/LabOrder.md +1 -0
  21. package/docs/models/ProviderDriversLicenseSummary.md +19 -0
  22. package/docs/models/ProviderPatientInsuranceResponse.md +19 -0
  23. package/docs/models/ProviderPatientProfile.md +42 -0
  24. package/docs/models/ProviderPatientProfileResponse.md +21 -0
  25. package/docs/models/TelehealthRequest.md +22 -0
  26. package/docs/models/TelehealthRequestInput.md +17 -0
  27. package/docs/models/TelehealthRequestResponse.md +19 -0
  28. package/docs/models/UpdateEncounterMedicationsRequest.md +17 -0
  29. package/docs/models/index.md +18 -0
  30. package/docs/operations/patient.checkPatientInsuranceBenefits.md +209 -0
  31. package/docs/operations/patient.listPatientInsuranceClaims.md +3 -1
  32. package/docs/operations/provider.getLabOrder.md +21 -25
  33. package/docs/operations/provider.getPatientInsurance.md +134 -0
  34. package/docs/operations/provider.getPatientProfile.md +188 -0
  35. package/docs/operations/provider.listEncounterMedications.md +142 -0
  36. package/docs/operations/provider.listLabCatalog.md +215 -0
  37. package/docs/operations/provider.listLabOrders.md +24 -27
  38. package/docs/operations/provider.placeLabOrder.md +26 -28
  39. package/docs/operations/provider.requestTelehealthVisit.md +124 -0
  40. package/docs/operations/provider.updateEncounterMedications.md +186 -0
  41. package/package.json +1 -1
@@ -37,6 +37,7 @@ None documented.
37
37
  | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
38
38
  |---|---|---:|---|---|---|---:|---|
39
39
  | `status` | `string|null` | No | | | | Yes | submitting, accepted or rejected |
40
+ | `encounter_id` | `string|null` | No | | | | Yes | Only the orders placed from this encounter |
40
41
 
41
42
  ## Body parameters
42
43
 
@@ -62,44 +63,40 @@ None declared in canonical OpenAPI.
62
63
  {
63
64
  "orders": [
64
65
  {
65
- "abn_required": false,
66
- "ack_code": "AA",
67
- "authored_at": "2026-10-28T09:15:00-04:00",
66
+ "abn_required": true,
67
+ "ack_code": "string",
68
+ "authored_at": "string",
68
69
  "collection_modality": "psc",
69
- "diagnoses": [
70
- {
71
- "code": "R53.83",
72
- "description": "Other fatigue"
73
- }
74
- ],
75
- "expected_collection_at": "2026-10-29T08:00:00-04:00",
76
- "fhir_status": "active",
77
- "lab": "MET",
78
- "order_group_id": "00000000-0000-4000-8000-000000000030",
79
- "order_id": "00000000-0000-4000-8000-000000000040",
70
+ "diagnoses": [],
71
+ "encounter_id": "string",
72
+ "expected_collection_at": "string",
73
+ "fhir_status": "string",
74
+ "lab": "string",
75
+ "order_group_id": "string",
76
+ "order_id": "string",
80
77
  "ordering_provider": {
81
- "first_name": "Alex",
82
- "last_name": "Smith",
83
- "npi": "1234567893",
78
+ "first_name": "string",
79
+ "last_name": "string",
80
+ "npi": "string",
84
81
  "source": "roster"
85
82
  },
86
- "patient_id": "patient-example-001",
87
- "placer_order_number": "HC0123456789ABCDEF01",
88
- "quest_http_status": null,
89
- "requester": "Practitioner/practitioner-example-001",
83
+ "patient_id": "string",
84
+ "placer_order_number": "string",
85
+ "quest_http_status": 0,
86
+ "requester": "string",
90
87
  "requisition_available": true,
91
88
  "source": "provider_app",
92
- "status": "accepted",
89
+ "status": "submitting",
93
90
  "tests": [
94
91
  {
95
- "catalog_item_id": "00000000-0000-4000-8000-000000000020",
96
- "description": "URINALYSIS, COMPLETE",
97
- "quest_code": "5463"
92
+ "catalog_item_id": "string",
93
+ "description": "string",
94
+ "quest_code": "string"
98
95
  }
99
96
  ]
100
97
  }
101
98
  ],
102
- "total": 1
99
+ "total": 0
103
100
  }
104
101
  ```
105
102
 
@@ -182,7 +179,7 @@ const result = await provider.listLabOrders(patientId, filters);
182
179
  ```bash
183
180
  curl -X GET \
184
181
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
185
- 'https://dev-api-provider.health.cloud/patients/%3CPATIENT_ID%3E/lab-orders?status=%3CSTATUS%3E'
182
+ 'https://dev-api-provider.health.cloud/patients/%3CPATIENT_ID%3E/lab-orders?status=%3CSTATUS%3E&encounter_id=%3CENCOUNTER_ID%3E'
186
183
  ```
187
184
 
188
185
  ## Notes
@@ -88,42 +88,38 @@ Request model: [`PlaceLabOrderRequest`](../models/PlaceLabOrderRequest.md)
88
88
 
89
89
  ```json
90
90
  {
91
- "order_group_id": "00000000-0000-4000-8000-000000000030",
91
+ "order_group_id": "string",
92
92
  "orders": [
93
93
  {
94
- "abn_required": false,
95
- "ack_code": "AA",
96
- "authored_at": "2026-10-28T09:15:00-04:00",
94
+ "abn_required": true,
95
+ "ack_code": "string",
96
+ "authored_at": "string",
97
97
  "collection_modality": "psc",
98
- "diagnoses": [
99
- {
100
- "code": "R53.83",
101
- "description": "Other fatigue"
102
- }
103
- ],
104
- "expected_collection_at": "2026-10-29T08:00:00-04:00",
105
- "fhir_status": "active",
106
- "lab": "MET",
107
- "order_group_id": "00000000-0000-4000-8000-000000000030",
108
- "order_id": "00000000-0000-4000-8000-000000000040",
98
+ "diagnoses": [],
99
+ "encounter_id": "string",
100
+ "expected_collection_at": "string",
101
+ "fhir_status": "string",
102
+ "lab": "string",
103
+ "order_group_id": "string",
104
+ "order_id": "string",
109
105
  "ordering_provider": {
110
- "first_name": "Alex",
111
- "last_name": "Smith",
112
- "npi": "1234567893",
106
+ "first_name": "string",
107
+ "last_name": "string",
108
+ "npi": "string",
113
109
  "source": "roster"
114
110
  },
115
- "patient_id": "patient-example-001",
116
- "placer_order_number": "HC0123456789ABCDEF01",
117
- "quest_http_status": null,
118
- "requester": "Practitioner/practitioner-example-001",
111
+ "patient_id": "string",
112
+ "placer_order_number": "string",
113
+ "quest_http_status": 0,
114
+ "requester": "string",
119
115
  "requisition_available": true,
120
116
  "source": "provider_app",
121
- "status": "accepted",
117
+ "status": "submitting",
122
118
  "tests": [
123
119
  {
124
- "catalog_item_id": "00000000-0000-4000-8000-000000000020",
125
- "description": "URINALYSIS, COMPLETE",
126
- "quest_code": "5463"
120
+ "catalog_item_id": "string",
121
+ "description": "string",
122
+ "quest_code": "string"
127
123
  }
128
124
  ]
129
125
  }
@@ -131,8 +127,8 @@ Request model: [`PlaceLabOrderRequest`](../models/PlaceLabOrderRequest.md)
131
127
  "replayed": true,
132
128
  "unsent_items": [
133
129
  {
134
- "catalog_item_id": "00000000-0000-4000-8000-000000000060",
135
- "name": "Visby CT/NG/TV",
130
+ "catalog_item_id": "string",
131
+ "name": "string",
136
132
  "reason": "rapid_kit_flow"
137
133
  }
138
134
  ]
@@ -151,6 +147,7 @@ Request model: [`PlaceLabOrderRequest`](../models/PlaceLabOrderRequest.md)
151
147
  "authored_at": "string",
152
148
  "collection_modality": "psc",
153
149
  "diagnoses": [],
150
+ "encounter_id": "string",
154
151
  "expected_collection_at": "string",
155
152
  "fhir_status": "string",
156
153
  "lab": "string",
@@ -201,6 +198,7 @@ Request model: [`PlaceLabOrderRequest`](../models/PlaceLabOrderRequest.md)
201
198
  "authored_at": "string",
202
199
  "collection_modality": "psc",
203
200
  "diagnoses": [],
201
+ "encounter_id": "string",
204
202
  "expected_collection_at": "string",
205
203
  "fhir_status": "string",
206
204
  "lab": "string",
@@ -0,0 +1,124 @@
1
+ # Ask the patient to schedule a telehealth appointment
2
+
3
+ Operation ID: `provider.requestTelehealthVisit`
4
+
5
+ Records a proposed telehealth appointment for the patient (no time yet) linked to this encounter and tells the patient, in fixed generic wording, that their provider has requested a telehealth visit and to schedule one in the app. At most one request per encounter per hour: a repeat inside the hour returns the existing request with created=false and sends nothing. `preferred_window` is stored for the care team and never sent to the patient. Only the assigned provider may do this (403); a signed encounter answers 409.
6
+
7
+ ## Public method
8
+
9
+ `requestTelehealthVisit`
10
+
11
+ Signature: `provider.requestTelehealthVisit(encounterId, request)`
12
+
13
+ Return type: `Promise<TelehealthRequestResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `POST /encounters/{encounter_id}/telehealth-request`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `encounter_id` | `string` | Yes | | | | No | |
34
+
35
+ ## Query parameters
36
+
37
+ None.
38
+
39
+ ## Body parameters
40
+
41
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
42
+ |---|---|---:|---|---|---|---:|---|
43
+ | `body` | [`TelehealthRequestInput`](../models/TelehealthRequestInput.md) | No | | | | Yes | |
44
+
45
+ Request model: [`TelehealthRequestInput`](../models/TelehealthRequestInput.md)
46
+
47
+ ## Request example
48
+
49
+ ```json
50
+ {
51
+ "preferred_window": "string"
52
+ }
53
+ ```
54
+
55
+ ## Success responses
56
+
57
+ | Status | Shape | Content type | Description |
58
+ |---|---|---|---|
59
+ | `200` | [`TelehealthRequestResponse`](../models/TelehealthRequestResponse.md) | application/json | Request recorded (or already made within the hour) |
60
+
61
+ ## Success response examples
62
+
63
+ ### 200
64
+
65
+ ```json
66
+ {
67
+ "created": true,
68
+ "patient_notified": true,
69
+ "request": {
70
+ "encounter_id": "string",
71
+ "patient_id": "string",
72
+ "preferred_window": "string",
73
+ "request_id": "string",
74
+ "requested_at": "string",
75
+ "status": "string"
76
+ }
77
+ }
78
+ ```
79
+
80
+ ## Common errors
81
+
82
+ None declared in canonical OpenAPI.
83
+
84
+ ## Error examples
85
+
86
+ None declared in canonical OpenAPI.
87
+
88
+ ## NodeJS / TypeScript implementation
89
+
90
+ ```ts
91
+ import { HCSDK } from "@healthcloudai/hc-sdk";
92
+ ```
93
+
94
+ ```ts
95
+ const encounterId = "<ENCOUNTER_ID>";
96
+
97
+ const request = {
98
+ "preferred_window": "string"
99
+ };
100
+
101
+ const result = await provider.requestTelehealthVisit(encounterId, request);
102
+ ```
103
+
104
+ ## cURL
105
+
106
+ ```bash
107
+ curl -X POST \
108
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
109
+ -H 'Content-Type: application/json' \
110
+ -d '{"preferred_window":"string"}' \
111
+ 'https://dev-api-provider.health.cloud/encounters/%3CENCOUNTER_ID%3E/telehealth-request'
112
+ ```
113
+
114
+ ## Notes
115
+
116
+ None.
117
+
118
+ ## Prepared Test Console scenario
119
+
120
+ No canonical scenario is currently associated.
121
+
122
+ ## Real response
123
+
124
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -0,0 +1,186 @@
1
+ # Add, change or remove an encounter's medications
2
+
3
+ Operation ID: `provider.updateEncounterMedications`
4
+
5
+ Replaces the encounter's medication list with the one sent (up to 25): medications not listed are removed (kept for audit, marked entered-in-error), new ones are added and changed ones updated. Sending the same list again changes nothing. This records the medication plan in the chart; it does not e-prescribe or contact a pharmacy. Only the assigned provider may do this (403); a signed encounter answers 409. The patient is told the visit was updated (at most once per 15 minutes).
6
+
7
+ ## Public method
8
+
9
+ `updateEncounterMedications`
10
+
11
+ Signature: `provider.updateEncounterMedications(encounterId, request)`
12
+
13
+ Return type: `Promise<EncounterMedicationsResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `PUT /encounters/{encounter_id}/medications`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `encounter_id` | `string` | Yes | | | | No | |
34
+
35
+ ## Query parameters
36
+
37
+ None.
38
+
39
+ ## Body parameters
40
+
41
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
42
+ |---|---|---:|---|---|---|---:|---|
43
+ | `body` | [`UpdateEncounterMedicationsRequest`](../models/UpdateEncounterMedicationsRequest.md) | No | | | | Yes | |
44
+
45
+ Request model: [`UpdateEncounterMedicationsRequest`](../models/UpdateEncounterMedicationsRequest.md)
46
+
47
+ ## Request example
48
+
49
+ ```json
50
+ {
51
+ "medications": [
52
+ {
53
+ "dose_unit": "string",
54
+ "dose_value": 1,
55
+ "end_date": "2026-01-01",
56
+ "frequency": "once",
57
+ "frequency_details": "string",
58
+ "indication": "string",
59
+ "instructions": "string",
60
+ "name": "string",
61
+ "notes": "string",
62
+ "route": "string",
63
+ "rxnorm_code": "string",
64
+ "start_date": "2026-01-01",
65
+ "status": "active"
66
+ }
67
+ ]
68
+ }
69
+ ```
70
+
71
+ ## Success responses
72
+
73
+ | Status | Shape | Content type | Description |
74
+ |---|---|---|---|
75
+ | `200` | [`EncounterMedicationsResponse`](../models/EncounterMedicationsResponse.md) | application/json | Medications saved |
76
+
77
+ ## Success response examples
78
+
79
+ ### 200
80
+
81
+ ```json
82
+ {
83
+ "encounter_id": "string",
84
+ "medications": [
85
+ {
86
+ "authored_on": "2026-01-01",
87
+ "brand_name": "string",
88
+ "discontinued_reason": "string",
89
+ "dosage": {
90
+ "duration_days": 1,
91
+ "frequency": "once",
92
+ "frequency_details": "string",
93
+ "instructions": "string",
94
+ "max_daily_dose": 0,
95
+ "max_daily_dose_unit": "string",
96
+ "unit": "string",
97
+ "value": 1
98
+ },
99
+ "encounter_id": "string",
100
+ "end_date": "2026-01-01",
101
+ "fhir_id": "string",
102
+ "generic_name": "string",
103
+ "indication": "string",
104
+ "intent": "order",
105
+ "medication_id": "00000000-0000-0000-0000-000000000000",
106
+ "name": "string",
107
+ "ndc_code": "string",
108
+ "notes": "string",
109
+ "pharmacy": "string",
110
+ "prescriber_id": "string",
111
+ "prescriber_name": "string",
112
+ "problem_reference": "00000000-0000-0000-0000-000000000000",
113
+ "refills_authorized": 0,
114
+ "refills_remaining": 0,
115
+ "resource_type": "MedicationRequest",
116
+ "route": "oral",
117
+ "rxnorm_code": "string",
118
+ "start_date": "2026-01-01",
119
+ "status": "active"
120
+ }
121
+ ],
122
+ "total": 0
123
+ }
124
+ ```
125
+
126
+ ## Common errors
127
+
128
+ None declared in canonical OpenAPI.
129
+
130
+ ## Error examples
131
+
132
+ None declared in canonical OpenAPI.
133
+
134
+ ## NodeJS / TypeScript implementation
135
+
136
+ ```ts
137
+ import { HCSDK } from "@healthcloudai/hc-sdk";
138
+ ```
139
+
140
+ ```ts
141
+ const encounterId = "<ENCOUNTER_ID>";
142
+
143
+ const request = {
144
+ "medications": [
145
+ {
146
+ "dose_unit": "string",
147
+ "dose_value": 1,
148
+ "end_date": "2026-01-01",
149
+ "frequency": "once",
150
+ "frequency_details": "string",
151
+ "indication": "string",
152
+ "instructions": "string",
153
+ "name": "string",
154
+ "notes": "string",
155
+ "route": "string",
156
+ "rxnorm_code": "string",
157
+ "start_date": "2026-01-01",
158
+ "status": "active"
159
+ }
160
+ ]
161
+ };
162
+
163
+ const result = await provider.updateEncounterMedications(encounterId, request);
164
+ ```
165
+
166
+ ## cURL
167
+
168
+ ```bash
169
+ curl -X PUT \
170
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
171
+ -H 'Content-Type: application/json' \
172
+ -d '{"medications":[{"dose_unit":"string","dose_value":1,"end_date":"2026-01-01","frequency":"once","frequency_details":"string","indication":"string","instructions":"string","name":"string","notes":"string","route":"string","rxnorm_code":"string","start_date":"2026-01-01","status":"active"}]}' \
173
+ 'https://dev-api-provider.health.cloud/encounters/%3CENCOUNTER_ID%3E/medications'
174
+ ```
175
+
176
+ ## Notes
177
+
178
+ None.
179
+
180
+ ## Prepared Test Console scenario
181
+
182
+ No canonical scenario is currently associated.
183
+
184
+ ## Real response
185
+
186
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@healthcloudai/hc-sdk",
3
- "version": "3.25.0",
3
+ "version": "3.27.0",
4
4
  "description": "All-in-one HealthCloud SDK with typed platform APIs and secure connector clients.",
5
5
  "author": "Healthcheck Systems Inc",
6
6
  "license": "MIT",