@healthcloudai/hc-sdk 3.17.0 → 3.19.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 (129) hide show
  1. package/dist/index.cjs +37 -0
  2. package/dist/index.d.cts +9261 -2031
  3. package/dist/index.d.ts +9261 -2031
  4. package/dist/index.js +37 -0
  5. package/docs/clients/ProviderClient.md +8 -0
  6. package/docs/docs-manifest.json +90 -12
  7. package/docs/examples/index.md +8 -0
  8. package/docs/index.md +8 -0
  9. package/docs/models/AlcoholFrequency.md +15 -0
  10. package/docs/models/AlcoholUse.md +20 -0
  11. package/docs/models/BodyHeight.md +17 -0
  12. package/docs/models/BodyTemperature.md +18 -0
  13. package/docs/models/BodyWeight.md +18 -0
  14. package/docs/models/BookAppointmentRequest.md +2 -0
  15. package/docs/models/DietCategory.md +19 -0
  16. package/docs/models/EducationLevel.md +15 -0
  17. package/docs/models/ExerciseFrequency.md +15 -0
  18. package/docs/models/FunctionalLevel.md +15 -0
  19. package/docs/models/FunctionalStatus.md +40 -0
  20. package/docs/models/GetPractitionerResponse.md +8 -2
  21. package/docs/models/LicenseVerification.md +19 -0
  22. package/docs/models/ListAllergiesResponse.md +1 -1
  23. package/docs/models/ListConditionsResponse.md +1 -1
  24. package/docs/models/ListDirectivesResponse.md +1 -1
  25. package/docs/models/ListFamilyHistoryResponse.md +1 -1
  26. package/docs/models/ListImmunizationsResponse.md +1 -1
  27. package/docs/models/ListProceduresResponse.md +1 -1
  28. package/docs/models/ListQuestionnaireResponsesResponse.md +1 -1
  29. package/docs/models/LivingSituation.md +15 -0
  30. package/docs/models/LocationAddress.md +21 -0
  31. package/docs/models/LocationHours.md +19 -0
  32. package/docs/models/NpiVerification.md +21 -0
  33. package/docs/models/OnboardingProgressRequest.md +18 -0
  34. package/docs/models/PortalRole.md +18 -0
  35. package/docs/models/Practitioner.md +9 -2
  36. package/docs/models/ProviderCredential.md +19 -0
  37. package/docs/models/ProviderEducationCredential.md +6 -2
  38. package/docs/models/ProviderEncounterListResponse.md +1 -1
  39. package/docs/models/ProviderEncounterRecord.md +49 -0
  40. package/docs/models/ProviderEncounterResponse.md +1 -1
  41. package/docs/models/ProviderLanguage.md +3 -2
  42. package/docs/models/ProviderLocation.md +63 -0
  43. package/docs/models/ProviderLocationAddressRequest.md +21 -0
  44. package/docs/models/ProviderLocationDeletedResponse.md +18 -0
  45. package/docs/models/ProviderLocationHoursRequest.md +19 -0
  46. package/docs/models/ProviderLocationListResponse.md +18 -0
  47. package/docs/models/ProviderLocationPatchRequest.md +28 -0
  48. package/docs/models/ProviderLocationRequest.md +57 -0
  49. package/docs/models/ProviderOnboardingStatus.md +19 -0
  50. package/docs/models/ProviderPatientRecordResources.md +32 -0
  51. package/docs/models/ProviderPatientRecordResponse.md +1 -1
  52. package/docs/models/ProviderPostgraduateTraining.md +22 -0
  53. package/docs/models/ProviderProfessionalLiability.md +19 -0
  54. package/docs/models/ProviderSpecialty.md +1 -1
  55. package/docs/models/ProviderStateLicense.md +9 -2
  56. package/docs/models/SetPortalRolesRequest.md +17 -0
  57. package/docs/models/SexualOrientation.md +15 -0
  58. package/docs/models/SmokingStatus.md +15 -0
  59. package/docs/models/SocialHistory.md +35 -0
  60. package/docs/models/SubstanceStatus.md +15 -0
  61. package/docs/models/SubstanceUse.md +23 -0
  62. package/docs/models/TobaccoUse.md +22 -0
  63. package/docs/models/UpdateEncounterClinicalNoteResponse.md +1 -1
  64. package/docs/models/UpdateEncounterStatusResponse.md +1 -1
  65. package/docs/models/UpdatePractitionerRequest.md +5 -0
  66. package/docs/models/UpdatePractitionerResponse.md +8 -2
  67. package/docs/models/VitalsRecord.md +41 -0
  68. package/docs/models/appointments.ErrorResponse.md +1 -0
  69. package/docs/models/diagnostics.Coding.md +19 -0
  70. package/docs/models/diagnostics.LabObservation.md +1 -1
  71. package/docs/models/{AdvanceDirective.md → ehr.AdvanceDirective.md} +1 -1
  72. package/docs/models/{Allergy.md → ehr.Allergy.md} +1 -1
  73. package/docs/models/ehr.Coding.md +19 -0
  74. package/docs/models/{FamilyHistoryEntry.md → ehr.FamilyHistoryEntry.md} +1 -1
  75. package/docs/models/{Immunization.md → ehr.Immunization.md} +1 -1
  76. package/docs/models/{Problem.md → ehr.Problem.md} +1 -1
  77. package/docs/models/{Procedure.md → ehr.Procedure.md} +1 -1
  78. package/docs/models/ehr.Quantity.md +20 -0
  79. package/docs/models/{QuestionnaireResponse.md → ehr.QuestionnaireResponse.md} +2 -2
  80. package/docs/models/{ResponseAnswer.md → ehr.ResponseAnswer.md} +4 -4
  81. package/docs/models/{ResponseItem.md → ehr.ResponseItem.md} +3 -3
  82. package/docs/models/index.md +79 -9
  83. package/docs/models/provider.AdvanceDirective.md +31 -0
  84. package/docs/models/provider.Allergy.md +31 -0
  85. package/docs/models/provider.AllergyReaction.md +21 -0
  86. package/docs/models/provider.BloodPressure.md +20 -0
  87. package/docs/models/provider.CodedConcept.md +19 -0
  88. package/docs/models/provider.Coding.md +19 -0
  89. package/docs/models/provider.Dosage.md +24 -0
  90. package/docs/models/provider.Encounter.md +48 -0
  91. package/docs/models/provider.EncounterDiagnosis.md +20 -0
  92. package/docs/models/provider.EncounterHospitalization.md +22 -0
  93. package/docs/models/provider.EncounterLocation.md +21 -0
  94. package/docs/models/provider.EncounterParticipant.md +21 -0
  95. package/docs/models/provider.FamilyCondition.md +22 -0
  96. package/docs/models/provider.FamilyHistoryEntry.md +30 -0
  97. package/docs/models/provider.GynHistory.md +25 -0
  98. package/docs/models/provider.HeartRate.md +18 -0
  99. package/docs/models/provider.Immunization.md +40 -0
  100. package/docs/models/provider.ImmunizationReaction.md +20 -0
  101. package/docs/models/provider.LabObservation.md +29 -0
  102. package/docs/models/provider.Medication.md +41 -0
  103. package/docs/models/provider.PerinatalHistory.md +25 -0
  104. package/docs/models/provider.Problem.md +37 -0
  105. package/docs/models/provider.Procedure.md +37 -0
  106. package/docs/models/provider.PulseOximetry.md +20 -0
  107. package/docs/models/provider.Quantity.md +20 -0
  108. package/docs/models/provider.QuestionnaireResponse.md +27 -0
  109. package/docs/models/provider.ReferenceRange.md +20 -0
  110. package/docs/models/provider.ResponseAnswer.md +27 -0
  111. package/docs/models/provider.ResponseItem.md +21 -0
  112. package/docs/operations/appointments.book.md +34 -1
  113. package/docs/operations/provider.completePractitionerOnboarding.md +264 -0
  114. package/docs/operations/provider.createPractitionerLocation.md +221 -0
  115. package/docs/operations/provider.deletePractitionerLocation.md +133 -0
  116. package/docs/operations/provider.getEncounter.md +84 -1
  117. package/docs/operations/provider.getPatientRecord.md +516 -1
  118. package/docs/operations/provider.getPractitioner.md +92 -53
  119. package/docs/operations/provider.getPractitionerLocation.md +162 -0
  120. package/docs/operations/provider.listEncounters.md +84 -1
  121. package/docs/operations/provider.listPractitionerLocations.md +130 -0
  122. package/docs/operations/provider.register.md +25 -3
  123. package/docs/operations/provider.setPractitionerPortalRoles.md +271 -0
  124. package/docs/operations/provider.updateEncounterClinicalNote.md +84 -1
  125. package/docs/operations/provider.updateEncounterStatus.md +84 -1
  126. package/docs/operations/provider.updatePractitioner.md +256 -150
  127. package/docs/operations/provider.updatePractitionerLocation.md +233 -0
  128. package/docs/operations/provider.verifyPractitionerNpi.md +273 -0
  129. package/package.json +1 -1
@@ -0,0 +1,271 @@
1
+ # Set a practitioner's provider-portal roles (platform admin only)
2
+
3
+ Operation ID: `provider.setPractitionerPortalRoles`
4
+
5
+ Set a practitioner's provider-portal roles (platform admin only)
6
+
7
+ ## Public method
8
+
9
+ `setPractitionerPortalRoles`
10
+
11
+ Signature: `provider.setPractitionerPortalRoles(fhirPractitionerId, request)`
12
+
13
+ Return type: `Promise<UpdatePractitionerResponse>`
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}/portal-roles`
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` | [`SetPortalRolesRequest`](../models/SetPortalRolesRequest.md) | No | | | | Yes | |
44
+
45
+ Request model: [`SetPortalRolesRequest`](../models/SetPortalRolesRequest.md)
46
+
47
+ ## Request example
48
+
49
+ ```json
50
+ {
51
+ "portal_roles": [
52
+ "provider_applicant"
53
+ ]
54
+ }
55
+ ```
56
+
57
+ ## Success responses
58
+
59
+ | Status | Shape | Content type | Description |
60
+ |---|---|---|---|
61
+ | `200` | [`UpdatePractitionerResponse`](../models/UpdatePractitionerResponse.md) | application/json | Updated practitioner profile |
62
+
63
+ ## Success response examples
64
+
65
+ ### 200
66
+
67
+ ```json
68
+ {
69
+ "active": true,
70
+ "birth_date": "string",
71
+ "board_certifications": [
72
+ "string"
73
+ ],
74
+ "credential": "string",
75
+ "credentials": [
76
+ {
77
+ "code": "string",
78
+ "primary": false,
79
+ "system": "http://terminology.hl7.org/CodeSystem/v2-0360"
80
+ }
81
+ ],
82
+ "department": "string",
83
+ "education_credentials": [
84
+ {
85
+ "credential": "string",
86
+ "graduation_year": 1900,
87
+ "id": "string",
88
+ "institution": "string",
89
+ "level": "undergraduate",
90
+ "program": "string",
91
+ "start_year": 1900
92
+ }
93
+ ],
94
+ "email": "user@example.com",
95
+ "first_name": "string",
96
+ "gender": "unknown",
97
+ "graduation_year": 0,
98
+ "identifiers": [
99
+ {
100
+ "expiration_date": "string",
101
+ "state": "string",
102
+ "type": "NPI",
103
+ "value": "string"
104
+ }
105
+ ],
106
+ "insurances_accepted": [
107
+ {
108
+ "payer_id": "string",
109
+ "payer_name": "string"
110
+ }
111
+ ],
112
+ "languages_spoken": [],
113
+ "last_name": "string",
114
+ "medical_school": "string",
115
+ "middle_name": "string",
116
+ "notes": "string",
117
+ "npi": "string",
118
+ "npi_verification": {
119
+ "registry_first_name": "string",
120
+ "registry_last_name": "string",
121
+ "source": "string",
122
+ "status": "unverified",
123
+ "verified_at": "2026-01-01T09:00:00Z"
124
+ },
125
+ "onboarding": {
126
+ "completed_at": "2026-01-01T09:00:00Z",
127
+ "completed_steps": [
128
+ "string"
129
+ ],
130
+ "flow": "virtual-practice"
131
+ },
132
+ "organization_id": "string",
133
+ "organization_name": "string",
134
+ "portal_roles": [
135
+ "provider_applicant"
136
+ ],
137
+ "postgraduate_training": [
138
+ {
139
+ "end_year": 1900,
140
+ "id": "string",
141
+ "institution": "string",
142
+ "specialty": "string",
143
+ "start_year": 1900,
144
+ "type": "residency"
145
+ }
146
+ ],
147
+ "practitioner_id": "string",
148
+ "prefix": "string",
149
+ "professional_display_name": "string",
150
+ "professional_liability": {
151
+ "carrier": "string",
152
+ "coverage_expiration": "string",
153
+ "policy_number": "string"
154
+ },
155
+ "race": [
156
+ "american_indian_or_alaska_native"
157
+ ],
158
+ "roles": [
159
+ "physician"
160
+ ],
161
+ "specialty": [
162
+ {
163
+ "board_certified": false,
164
+ "code": "string",
165
+ "display": "string",
166
+ "primary": false,
167
+ "system": "http://nucc.org/provider-taxonomy"
168
+ }
169
+ ],
170
+ "state_licenses": [
171
+ {
172
+ "compact": false,
173
+ "expiration_date": "string",
174
+ "id": "string",
175
+ "issued_date": "string",
176
+ "license_number": "string",
177
+ "license_type": "string",
178
+ "primary": false,
179
+ "state": "st",
180
+ "status": "active",
181
+ "verification": {
182
+ "source": "string",
183
+ "status": "self-attested",
184
+ "verified_at": "2026-01-01T09:00:00Z"
185
+ }
186
+ }
187
+ ],
188
+ "suffix": "string",
189
+ "telecom": [
190
+ {
191
+ "system": "string",
192
+ "use": "work",
193
+ "value": "string"
194
+ }
195
+ ]
196
+ }
197
+ ```
198
+
199
+ ## Common errors
200
+
201
+ | Status | Shape | Content type | Description |
202
+ |---|---|---|---|
203
+ | `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
204
+ | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
205
+ | `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
206
+
207
+ ## Error examples
208
+
209
+ ### 400
210
+
211
+ ```json
212
+ {
213
+ "error": "string"
214
+ }
215
+ ```
216
+
217
+ ### 401
218
+
219
+ ```json
220
+ {
221
+ "error": "string"
222
+ }
223
+ ```
224
+
225
+ ### 403
226
+
227
+ ```json
228
+ {
229
+ "error": "string"
230
+ }
231
+ ```
232
+
233
+ ## NodeJS / TypeScript implementation
234
+
235
+ ```ts
236
+ import { HCSDK } from "@healthcloudai/hc-sdk";
237
+ ```
238
+
239
+ ```ts
240
+ const fhirPractitionerId = "<FHIR_PRACTITIONER_ID>";
241
+
242
+ const request = {
243
+ "portal_roles": [
244
+ "provider_applicant"
245
+ ]
246
+ };
247
+
248
+ const result = await provider.setPractitionerPortalRoles(fhirPractitionerId, request);
249
+ ```
250
+
251
+ ## cURL
252
+
253
+ ```bash
254
+ curl -X PUT \
255
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
256
+ -H 'Content-Type: application/json' \
257
+ -d '{"portal_roles":["provider_applicant"]}' \
258
+ 'https://dev-api-provider.health.cloud/practitioners/%3CPRACTITIONER_ID%3E/portal-roles'
259
+ ```
260
+
261
+ ## Notes
262
+
263
+ None.
264
+
265
+ ## Prepared Test Console scenario
266
+
267
+ No canonical scenario is currently associated.
268
+
269
+ ## Real response
270
+
271
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -66,7 +66,90 @@ Request model: [`UpdateEncounterClinicalNoteRequest`](../models/UpdateEncounterC
66
66
  ```json
67
67
  {
68
68
  "ehr_status": "updated",
69
- "encounter": {},
69
+ "encounter": {
70
+ "appointment_id": "string",
71
+ "athena_appointment_id": "string",
72
+ "athena_encounter_id": "string",
73
+ "created_by": "self",
74
+ "created_date": "2026-01-01T09:00:00Z",
75
+ "diagnoses": [
76
+ {
77
+ "condition_display": "string",
78
+ "condition_id": "string",
79
+ "rank": 1,
80
+ "use_code": "CC"
81
+ }
82
+ ],
83
+ "encounter_class": "AMB",
84
+ "encounter_id": "00000000-0000-0000-0000-000000000000",
85
+ "fhir_id": "string",
86
+ "hospitalization": {
87
+ "admit_source_code": "string",
88
+ "destination_id": "string",
89
+ "discharge_disposition": "home",
90
+ "origin_id": "string",
91
+ "pre_admission_id": "string",
92
+ "re_admission_code": "string"
93
+ },
94
+ "length_minutes": 0,
95
+ "locations": [
96
+ {
97
+ "location_display": "string",
98
+ "location_id": "string",
99
+ "period_end": "2026-01-01T09:00:00Z",
100
+ "period_start": "2026-01-01T09:00:00Z",
101
+ "status": "active"
102
+ }
103
+ ],
104
+ "notes": "string",
105
+ "openloop_appointment_id": "string",
106
+ "openloop_encounter_id": "string",
107
+ "participants": [
108
+ {
109
+ "participant_type": "PPRF",
110
+ "period_end": "2026-01-01T09:00:00Z",
111
+ "period_start": "2026-01-01T09:00:00Z",
112
+ "practitioner_display": "string",
113
+ "practitioner_id": "string"
114
+ }
115
+ ],
116
+ "patient": {
117
+ "address": {
118
+ "city": "string",
119
+ "country": "string",
120
+ "state": "string",
121
+ "street1": "string",
122
+ "street2": "string",
123
+ "zip_code": "string"
124
+ },
125
+ "date_of_birth": "string",
126
+ "first_name": "string",
127
+ "gender": "string",
128
+ "last_name": "string",
129
+ "patient_id": "string",
130
+ "phone": {
131
+ "extension": "string",
132
+ "number": "string",
133
+ "type": "string"
134
+ }
135
+ },
136
+ "patient_id": "string",
137
+ "period_end": "2026-01-01T09:00:00Z",
138
+ "period_start": "2026-01-01T09:00:00Z",
139
+ "priority_code": "string",
140
+ "priority_display": "string",
141
+ "reason_code": "string",
142
+ "reason_display": "string",
143
+ "service_provider_display": "string",
144
+ "service_provider_id": "string",
145
+ "service_type_code": "string",
146
+ "service_type_display": "string",
147
+ "status": "planned",
148
+ "steadymd_consult_guid": "string",
149
+ "steadymd_episode_guid": "string",
150
+ "type_code": "string",
151
+ "type_display": "string"
152
+ },
70
153
  "fhir_status": "updated"
71
154
  }
72
155
  ```
@@ -65,7 +65,90 @@ Request model: [`UpdateEncounterStatusRequest`](../models/UpdateEncounterStatusR
65
65
  ```json
66
66
  {
67
67
  "ehr_status": "updated",
68
- "encounter": {},
68
+ "encounter": {
69
+ "appointment_id": "string",
70
+ "athena_appointment_id": "string",
71
+ "athena_encounter_id": "string",
72
+ "created_by": "self",
73
+ "created_date": "2026-01-01T09:00:00Z",
74
+ "diagnoses": [
75
+ {
76
+ "condition_display": "string",
77
+ "condition_id": "string",
78
+ "rank": 1,
79
+ "use_code": "CC"
80
+ }
81
+ ],
82
+ "encounter_class": "AMB",
83
+ "encounter_id": "00000000-0000-0000-0000-000000000000",
84
+ "fhir_id": "string",
85
+ "hospitalization": {
86
+ "admit_source_code": "string",
87
+ "destination_id": "string",
88
+ "discharge_disposition": "home",
89
+ "origin_id": "string",
90
+ "pre_admission_id": "string",
91
+ "re_admission_code": "string"
92
+ },
93
+ "length_minutes": 0,
94
+ "locations": [
95
+ {
96
+ "location_display": "string",
97
+ "location_id": "string",
98
+ "period_end": "2026-01-01T09:00:00Z",
99
+ "period_start": "2026-01-01T09:00:00Z",
100
+ "status": "active"
101
+ }
102
+ ],
103
+ "notes": "string",
104
+ "openloop_appointment_id": "string",
105
+ "openloop_encounter_id": "string",
106
+ "participants": [
107
+ {
108
+ "participant_type": "PPRF",
109
+ "period_end": "2026-01-01T09:00:00Z",
110
+ "period_start": "2026-01-01T09:00:00Z",
111
+ "practitioner_display": "string",
112
+ "practitioner_id": "string"
113
+ }
114
+ ],
115
+ "patient": {
116
+ "address": {
117
+ "city": "string",
118
+ "country": "string",
119
+ "state": "string",
120
+ "street1": "string",
121
+ "street2": "string",
122
+ "zip_code": "string"
123
+ },
124
+ "date_of_birth": "string",
125
+ "first_name": "string",
126
+ "gender": "string",
127
+ "last_name": "string",
128
+ "patient_id": "string",
129
+ "phone": {
130
+ "extension": "string",
131
+ "number": "string",
132
+ "type": "string"
133
+ }
134
+ },
135
+ "patient_id": "string",
136
+ "period_end": "2026-01-01T09:00:00Z",
137
+ "period_start": "2026-01-01T09:00:00Z",
138
+ "priority_code": "string",
139
+ "priority_display": "string",
140
+ "reason_code": "string",
141
+ "reason_display": "string",
142
+ "service_provider_display": "string",
143
+ "service_provider_id": "string",
144
+ "service_type_code": "string",
145
+ "service_type_display": "string",
146
+ "status": "planned",
147
+ "steadymd_consult_guid": "string",
148
+ "steadymd_episode_guid": "string",
149
+ "type_code": "string",
150
+ "type_display": "string"
151
+ },
69
152
  "fhir_status": "updated"
70
153
  }
71
154
  ```