@healthcloudai/hc-sdk 3.27.0 → 3.29.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 (61) hide show
  1. package/dist/index.cjs +75 -3
  2. package/dist/index.d.cts +1234 -341
  3. package/dist/index.d.ts +1234 -341
  4. package/dist/index.js +75 -3
  5. package/docs/clients/PatientClient.md +5 -0
  6. package/docs/clients/ProviderClient.md +3 -0
  7. package/docs/docs-manifest.json +25 -3
  8. package/docs/examples/index.md +8 -0
  9. package/docs/index.md +8 -0
  10. package/docs/models/AvailabilityWindow.md +19 -0
  11. package/docs/models/BookPracticeAppointmentRequest.md +18 -0
  12. package/docs/models/CheckInEncounterResponse.md +1 -1
  13. package/docs/models/CreatePracticeInviteRequest.md +17 -0
  14. package/docs/models/GetEncounterResponse.md +1 -1
  15. package/docs/models/GetPatientResponse.md +1 -0
  16. package/docs/models/PatientDemographics.md +1 -0
  17. package/docs/models/PracticeAppointment.md +26 -0
  18. package/docs/models/PracticeAppointmentResponse.md +17 -0
  19. package/docs/models/PracticeAppointmentsResponse.md +19 -0
  20. package/docs/models/PracticeAvailability.md +22 -0
  21. package/docs/models/PracticeAvailabilityResponse.md +18 -0
  22. package/docs/models/PracticeInviteResponse.md +20 -0
  23. package/docs/models/PracticeSlot.md +19 -0
  24. package/docs/models/PracticeSlotsResponse.md +21 -0
  25. package/docs/models/ProviderEncounterRecord.md +3 -1
  26. package/docs/models/ProviderIntakeContent.md +25 -0
  27. package/docs/models/ProviderIntakeSubmission.md +29 -0
  28. package/docs/models/ProviderPatientProfile.md +1 -0
  29. package/docs/models/ProviderPatientRecordResources.md +1 -1
  30. package/docs/models/ProviderQueueEncounter.md +1 -0
  31. package/docs/models/ReschedulePracticeAppointmentRequest.md +17 -0
  32. package/docs/models/UpdateEncounterClinicalNoteRequest.md +2 -1
  33. package/docs/models/fieldagent.Encounter.md +1 -1
  34. package/docs/models/index.md +14 -0
  35. package/docs/models/patient.Encounter.md +1 -1
  36. package/docs/models/patient.RegisterRequest.md +1 -0
  37. package/docs/models/patient.RegisterResponse.md +1 -0
  38. package/docs/models/provider.Encounter.md +1 -1
  39. package/docs/operations/fieldagent.listPatients.md +1 -0
  40. package/docs/operations/patient.bookPracticeAppointment.md +180 -0
  41. package/docs/operations/patient.cancelPracticeAppointment.md +158 -0
  42. package/docs/operations/patient.getPatient.md +1 -0
  43. package/docs/operations/patient.getPatientSidebarPatientSidebar.md +1 -0
  44. package/docs/operations/patient.listPracticeAppointmentSlots.md +149 -0
  45. package/docs/operations/patient.listPracticeAppointments.md +156 -0
  46. package/docs/operations/patient.register.md +4 -1
  47. package/docs/operations/patient.reschedulePracticeAppointment.md +182 -0
  48. package/docs/operations/provider.claimEncounter.md +2 -0
  49. package/docs/operations/provider.createPracticeInvite.md +140 -0
  50. package/docs/operations/provider.getEncounter.md +2 -0
  51. package/docs/operations/provider.getEncounterQueue.md +1 -0
  52. package/docs/operations/provider.getPatientProfile.md +1 -0
  53. package/docs/operations/provider.getPatientRecord.md +54 -0
  54. package/docs/operations/provider.getPracticeAvailability.md +136 -0
  55. package/docs/operations/provider.listEncounters.md +2 -0
  56. package/docs/operations/provider.setPracticeAvailability.md +168 -0
  57. package/docs/operations/provider.signEncounter.md +2 -0
  58. package/docs/operations/provider.updateEncounterClinicalNote.md +2 -0
  59. package/docs/operations/provider.updateEncounterDiagnoses.md +2 -0
  60. package/docs/operations/provider.updateEncounterStatus.md +2 -0
  61. package/package.json +1 -1
@@ -339,8 +339,62 @@ None declared in canonical OpenAPI.
339
339
  ],
340
340
  "intake_submissions": [
341
341
  {
342
+ "content": {
343
+ "allergies": [],
344
+ "conditions": [
345
+ {
346
+ "categories": [],
347
+ "clinical_status": "active",
348
+ "description": "string",
349
+ "problem_id": "00000000-0000-0000-0000-000000000000",
350
+ "verification_status": "confirmed"
351
+ }
352
+ ],
353
+ "family_history": [],
354
+ "gyn_history": [
355
+ {
356
+ "history_id": "00000000-0000-0000-0000-000000000000"
357
+ }
358
+ ],
359
+ "immunizations": [
360
+ {
361
+ "immunization_id": "00000000-0000-0000-0000-000000000000",
362
+ "reactions": [],
363
+ "reason_codes": [],
364
+ "status": "completed",
365
+ "vaccine_name": "string"
366
+ }
367
+ ],
368
+ "medications": [],
369
+ "perinatal_history": [
370
+ {
371
+ "history_id": "00000000-0000-0000-0000-000000000000"
372
+ }
373
+ ],
374
+ "procedures": [
375
+ {
376
+ "body_sites": [],
377
+ "complications": [],
378
+ "description": "string",
379
+ "procedure_id": "00000000-0000-0000-0000-000000000000",
380
+ "reported": false,
381
+ "status": "completed"
382
+ }
383
+ ],
384
+ "social_history": [
385
+ {
386
+ "occupational_exposures": [],
387
+ "substances": [],
388
+ "travel_history": []
389
+ }
390
+ ]
391
+ },
392
+ "content_complete": true,
342
393
  "created_at": "2026-01-01T09:00:00Z",
343
394
  "invalid_entries": {},
395
+ "sections": [
396
+ "string"
397
+ ],
344
398
  "storage_status": "pending",
345
399
  "submission_id": "00000000-0000-0000-0000-000000000000",
346
400
  "unknown_fields": [
@@ -0,0 +1,136 @@
1
+ # Get the practice's telehealth booking rules
2
+
3
+ Operation ID: `provider.getPracticeAvailability`
4
+
5
+ The weekly windows, time zone, visit length, lead time, booking horizon and closed dates the practice's telehealth slots are computed from. Practice owner, own record only. `availability` is null until it is set.
6
+
7
+ ## Public method
8
+
9
+ `getPracticeAvailability`
10
+
11
+ Signature: `provider.getPracticeAvailability(practitionerId)`
12
+
13
+ Return type: `Promise<PracticeAvailabilityResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `GET /practitioners/{practitioner_id}/availability`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `practitioner_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` | [`PracticeAvailabilityResponse`](../models/PracticeAvailabilityResponse.md) | application/json | The booking rules |
54
+
55
+ ## Success response examples
56
+
57
+ ### 200
58
+
59
+ ```json
60
+ {
61
+ "availability": {
62
+ "horizon_days": 14,
63
+ "min_lead_hours": 2,
64
+ "slot_minutes": 30,
65
+ "timezone": "string",
66
+ "unavailable_dates": [
67
+ "2026-01-01"
68
+ ],
69
+ "windows": [
70
+ {
71
+ "day": "mon",
72
+ "end": "string",
73
+ "start": "string"
74
+ }
75
+ ]
76
+ },
77
+ "practitioner_id": "string"
78
+ }
79
+ ```
80
+
81
+ ## Common errors
82
+
83
+ | Status | Shape | Content type | Description |
84
+ |---|---|---|---|
85
+ | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider authorization required |
86
+ | `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Not a practice owner, or not your own record |
87
+
88
+ ## Error examples
89
+
90
+ ### 401
91
+
92
+ ```json
93
+ {
94
+ "error": "string"
95
+ }
96
+ ```
97
+
98
+ ### 403
99
+
100
+ ```json
101
+ {
102
+ "error": "string"
103
+ }
104
+ ```
105
+
106
+ ## NodeJS / TypeScript implementation
107
+
108
+ ```ts
109
+ import { HCSDK } from "@healthcloudai/hc-sdk";
110
+ ```
111
+
112
+ ```ts
113
+ const practitionerId = "<PRACTITIONER_ID>";
114
+
115
+ const result = await provider.getPracticeAvailability(practitionerId);
116
+ ```
117
+
118
+ ## cURL
119
+
120
+ ```bash
121
+ curl -X GET \
122
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
123
+ 'https://dev-api-provider.health.cloud/practitioners/%3CPRACTITIONER_ID%3E/availability'
124
+ ```
125
+
126
+ ## Notes
127
+
128
+ None.
129
+
130
+ ## Prepared Test Console scenario
131
+
132
+ No canonical scenario is currently associated.
133
+
134
+ ## Real response
135
+
136
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -132,8 +132,10 @@ None declared in canonical OpenAPI.
132
132
  "period_start": "2026-01-01T09:00:00Z",
133
133
  "priority_code": "string",
134
134
  "priority_display": "string",
135
+ "provider_notes": "string",
135
136
  "reason_code": "string",
136
137
  "reason_display": "string",
138
+ "reported_symptoms": "string",
137
139
  "service_provider_display": "string",
138
140
  "service_provider_id": "string",
139
141
  "service_type_code": "string",
@@ -0,0 +1,168 @@
1
+ # Set the practice's telehealth booking rules
2
+
3
+ Operation ID: `provider.setPracticeAvailability`
4
+
5
+ Replaces the practice's booking rules. Windows are `{day, start, end}` in the practice's IANA `timezone` and may not overlap; `slot_minutes` is 15, 20, 30, 45 or 60. Patients see slots computed from these rules. Practice owner, own record only.
6
+
7
+ ## Public method
8
+
9
+ `setPracticeAvailability`
10
+
11
+ Signature: `provider.setPracticeAvailability(practitionerId, availability)`
12
+
13
+ Return type: `Promise<PracticeAvailabilityResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `PUT /practitioners/{practitioner_id}/availability`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `practitioner_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` | [`PracticeAvailability`](../models/PracticeAvailability.md) | No | | | | Yes | |
44
+
45
+ Request model: [`PracticeAvailability`](../models/PracticeAvailability.md)
46
+
47
+ ## Request example
48
+
49
+ ```json
50
+ {
51
+ "horizon_days": 14,
52
+ "min_lead_hours": 2,
53
+ "slot_minutes": 30,
54
+ "timezone": "string",
55
+ "unavailable_dates": [
56
+ "2026-01-01"
57
+ ],
58
+ "windows": [
59
+ {
60
+ "day": "mon",
61
+ "end": "string",
62
+ "start": "string"
63
+ }
64
+ ]
65
+ }
66
+ ```
67
+
68
+ ## Success responses
69
+
70
+ | Status | Shape | Content type | Description |
71
+ |---|---|---|---|
72
+ | `200` | [`PracticeAvailabilityResponse`](../models/PracticeAvailabilityResponse.md) | application/json | The saved booking rules |
73
+
74
+ ## Success response examples
75
+
76
+ ### 200
77
+
78
+ ```json
79
+ {
80
+ "availability": {
81
+ "horizon_days": 14,
82
+ "min_lead_hours": 2,
83
+ "slot_minutes": 30,
84
+ "timezone": "string",
85
+ "unavailable_dates": [
86
+ "2026-01-01"
87
+ ],
88
+ "windows": [
89
+ {
90
+ "day": "mon",
91
+ "end": "string",
92
+ "start": "string"
93
+ }
94
+ ]
95
+ },
96
+ "practitioner_id": "string"
97
+ }
98
+ ```
99
+
100
+ ## Common errors
101
+
102
+ | Status | Shape | Content type | Description |
103
+ |---|---|---|---|
104
+ | `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Invalid booking rules |
105
+ | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider authorization required |
106
+ | `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Not a practice owner, or not your own record |
107
+
108
+ ## Error examples
109
+
110
+ ### 400
111
+
112
+ ```json
113
+ {
114
+ "error": "string"
115
+ }
116
+ ```
117
+
118
+ ### 401
119
+
120
+ ```json
121
+ {
122
+ "error": "string"
123
+ }
124
+ ```
125
+
126
+ ### 403
127
+
128
+ ```json
129
+ {
130
+ "error": "string"
131
+ }
132
+ ```
133
+
134
+ ## NodeJS / TypeScript implementation
135
+
136
+ ```ts
137
+ import { HCSDK } from "@healthcloudai/hc-sdk";
138
+ ```
139
+
140
+ ```ts
141
+ const practitionerId = "<PRACTITIONER_ID>";
142
+
143
+ const availability = "<AVAILABILITY>";
144
+
145
+ const result = await provider.setPracticeAvailability(practitionerId, availability);
146
+ ```
147
+
148
+ ## cURL
149
+
150
+ ```bash
151
+ curl -X PUT \
152
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
153
+ -H 'Content-Type: application/json' \
154
+ -d '{"horizon_days":14,"min_lead_hours":2,"slot_minutes":30,"timezone":"string","unavailable_dates":["2026-01-01"],"windows":[{"day":"mon","end":"string","start":"string"}]}' \
155
+ 'https://dev-api-provider.health.cloud/practitioners/%3CPRACTITIONER_ID%3E/availability'
156
+ ```
157
+
158
+ ## Notes
159
+
160
+ None.
161
+
162
+ ## Prepared Test Console scenario
163
+
164
+ No canonical scenario is currently associated.
165
+
166
+ ## Real response
167
+
168
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -131,8 +131,10 @@ None declared in canonical OpenAPI.
131
131
  "period_start": "2026-01-01T09:00:00Z",
132
132
  "priority_code": "string",
133
133
  "priority_display": "string",
134
+ "provider_notes": "string",
134
135
  "reason_code": "string",
135
136
  "reason_display": "string",
137
+ "reported_symptoms": "string",
136
138
  "service_provider_display": "string",
137
139
  "service_provider_id": "string",
138
140
  "service_type_code": "string",
@@ -138,8 +138,10 @@ Request model: [`UpdateEncounterClinicalNoteRequest`](../models/UpdateEncounterC
138
138
  "period_start": "2026-01-01T09:00:00Z",
139
139
  "priority_code": "string",
140
140
  "priority_display": "string",
141
+ "provider_notes": "string",
141
142
  "reason_code": "string",
142
143
  "reason_display": "string",
144
+ "reported_symptoms": "string",
143
145
  "service_provider_display": "string",
144
146
  "service_provider_id": "string",
145
147
  "service_type_code": "string",
@@ -143,8 +143,10 @@ Request model: [`UpdateEncounterDiagnosesRequest`](../models/UpdateEncounterDiag
143
143
  "period_start": "2026-01-01T09:00:00Z",
144
144
  "priority_code": "string",
145
145
  "priority_display": "string",
146
+ "provider_notes": "string",
146
147
  "reason_code": "string",
147
148
  "reason_display": "string",
149
+ "reported_symptoms": "string",
148
150
  "service_provider_display": "string",
149
151
  "service_provider_id": "string",
150
152
  "service_type_code": "string",
@@ -137,8 +137,10 @@ Request model: [`UpdateEncounterStatusRequest`](../models/UpdateEncounterStatusR
137
137
  "period_start": "2026-01-01T09:00:00Z",
138
138
  "priority_code": "string",
139
139
  "priority_display": "string",
140
+ "provider_notes": "string",
140
141
  "reason_code": "string",
141
142
  "reason_display": "string",
143
+ "reported_symptoms": "string",
142
144
  "service_provider_display": "string",
143
145
  "service_provider_id": "string",
144
146
  "service_type_code": "string",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@healthcloudai/hc-sdk",
3
- "version": "3.27.0",
3
+ "version": "3.29.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",