@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.
- package/dist/index.cjs +37 -0
- package/dist/index.d.cts +9261 -2031
- package/dist/index.d.ts +9261 -2031
- package/dist/index.js +37 -0
- package/docs/clients/ProviderClient.md +8 -0
- package/docs/docs-manifest.json +90 -12
- package/docs/examples/index.md +8 -0
- package/docs/index.md +8 -0
- package/docs/models/AlcoholFrequency.md +15 -0
- package/docs/models/AlcoholUse.md +20 -0
- package/docs/models/BodyHeight.md +17 -0
- package/docs/models/BodyTemperature.md +18 -0
- package/docs/models/BodyWeight.md +18 -0
- package/docs/models/BookAppointmentRequest.md +2 -0
- package/docs/models/DietCategory.md +19 -0
- package/docs/models/EducationLevel.md +15 -0
- package/docs/models/ExerciseFrequency.md +15 -0
- package/docs/models/FunctionalLevel.md +15 -0
- package/docs/models/FunctionalStatus.md +40 -0
- package/docs/models/GetPractitionerResponse.md +8 -2
- package/docs/models/LicenseVerification.md +19 -0
- package/docs/models/ListAllergiesResponse.md +1 -1
- package/docs/models/ListConditionsResponse.md +1 -1
- package/docs/models/ListDirectivesResponse.md +1 -1
- package/docs/models/ListFamilyHistoryResponse.md +1 -1
- package/docs/models/ListImmunizationsResponse.md +1 -1
- package/docs/models/ListProceduresResponse.md +1 -1
- package/docs/models/ListQuestionnaireResponsesResponse.md +1 -1
- package/docs/models/LivingSituation.md +15 -0
- package/docs/models/LocationAddress.md +21 -0
- package/docs/models/LocationHours.md +19 -0
- package/docs/models/NpiVerification.md +21 -0
- package/docs/models/OnboardingProgressRequest.md +18 -0
- package/docs/models/PortalRole.md +18 -0
- package/docs/models/Practitioner.md +9 -2
- package/docs/models/ProviderCredential.md +19 -0
- package/docs/models/ProviderEducationCredential.md +6 -2
- package/docs/models/ProviderEncounterListResponse.md +1 -1
- package/docs/models/ProviderEncounterRecord.md +49 -0
- package/docs/models/ProviderEncounterResponse.md +1 -1
- package/docs/models/ProviderLanguage.md +3 -2
- package/docs/models/ProviderLocation.md +63 -0
- package/docs/models/ProviderLocationAddressRequest.md +21 -0
- package/docs/models/ProviderLocationDeletedResponse.md +18 -0
- package/docs/models/ProviderLocationHoursRequest.md +19 -0
- package/docs/models/ProviderLocationListResponse.md +18 -0
- package/docs/models/ProviderLocationPatchRequest.md +28 -0
- package/docs/models/ProviderLocationRequest.md +57 -0
- package/docs/models/ProviderOnboardingStatus.md +19 -0
- package/docs/models/ProviderPatientRecordResources.md +32 -0
- package/docs/models/ProviderPatientRecordResponse.md +1 -1
- package/docs/models/ProviderPostgraduateTraining.md +22 -0
- package/docs/models/ProviderProfessionalLiability.md +19 -0
- package/docs/models/ProviderSpecialty.md +1 -1
- package/docs/models/ProviderStateLicense.md +9 -2
- package/docs/models/SetPortalRolesRequest.md +17 -0
- package/docs/models/SexualOrientation.md +15 -0
- package/docs/models/SmokingStatus.md +15 -0
- package/docs/models/SocialHistory.md +35 -0
- package/docs/models/SubstanceStatus.md +15 -0
- package/docs/models/SubstanceUse.md +23 -0
- package/docs/models/TobaccoUse.md +22 -0
- package/docs/models/UpdateEncounterClinicalNoteResponse.md +1 -1
- package/docs/models/UpdateEncounterStatusResponse.md +1 -1
- package/docs/models/UpdatePractitionerRequest.md +5 -0
- package/docs/models/UpdatePractitionerResponse.md +8 -2
- package/docs/models/VitalsRecord.md +41 -0
- package/docs/models/appointments.ErrorResponse.md +1 -0
- package/docs/models/diagnostics.Coding.md +19 -0
- package/docs/models/diagnostics.LabObservation.md +1 -1
- package/docs/models/{AdvanceDirective.md → ehr.AdvanceDirective.md} +1 -1
- package/docs/models/{Allergy.md → ehr.Allergy.md} +1 -1
- package/docs/models/ehr.Coding.md +19 -0
- package/docs/models/{FamilyHistoryEntry.md → ehr.FamilyHistoryEntry.md} +1 -1
- package/docs/models/{Immunization.md → ehr.Immunization.md} +1 -1
- package/docs/models/{Problem.md → ehr.Problem.md} +1 -1
- package/docs/models/{Procedure.md → ehr.Procedure.md} +1 -1
- package/docs/models/ehr.Quantity.md +20 -0
- package/docs/models/{QuestionnaireResponse.md → ehr.QuestionnaireResponse.md} +2 -2
- package/docs/models/{ResponseAnswer.md → ehr.ResponseAnswer.md} +4 -4
- package/docs/models/{ResponseItem.md → ehr.ResponseItem.md} +3 -3
- package/docs/models/index.md +79 -9
- package/docs/models/provider.AdvanceDirective.md +31 -0
- package/docs/models/provider.Allergy.md +31 -0
- package/docs/models/provider.AllergyReaction.md +21 -0
- package/docs/models/provider.BloodPressure.md +20 -0
- package/docs/models/provider.CodedConcept.md +19 -0
- package/docs/models/provider.Coding.md +19 -0
- package/docs/models/provider.Dosage.md +24 -0
- package/docs/models/provider.Encounter.md +48 -0
- package/docs/models/provider.EncounterDiagnosis.md +20 -0
- package/docs/models/provider.EncounterHospitalization.md +22 -0
- package/docs/models/provider.EncounterLocation.md +21 -0
- package/docs/models/provider.EncounterParticipant.md +21 -0
- package/docs/models/provider.FamilyCondition.md +22 -0
- package/docs/models/provider.FamilyHistoryEntry.md +30 -0
- package/docs/models/provider.GynHistory.md +25 -0
- package/docs/models/provider.HeartRate.md +18 -0
- package/docs/models/provider.Immunization.md +40 -0
- package/docs/models/provider.ImmunizationReaction.md +20 -0
- package/docs/models/provider.LabObservation.md +29 -0
- package/docs/models/provider.Medication.md +41 -0
- package/docs/models/provider.PerinatalHistory.md +25 -0
- package/docs/models/provider.Problem.md +37 -0
- package/docs/models/provider.Procedure.md +37 -0
- package/docs/models/provider.PulseOximetry.md +20 -0
- package/docs/models/provider.Quantity.md +20 -0
- package/docs/models/provider.QuestionnaireResponse.md +27 -0
- package/docs/models/provider.ReferenceRange.md +20 -0
- package/docs/models/provider.ResponseAnswer.md +27 -0
- package/docs/models/provider.ResponseItem.md +21 -0
- package/docs/operations/appointments.book.md +34 -1
- package/docs/operations/provider.completePractitionerOnboarding.md +264 -0
- package/docs/operations/provider.createPractitionerLocation.md +221 -0
- package/docs/operations/provider.deletePractitionerLocation.md +133 -0
- package/docs/operations/provider.getEncounter.md +84 -1
- package/docs/operations/provider.getPatientRecord.md +516 -1
- package/docs/operations/provider.getPractitioner.md +92 -53
- package/docs/operations/provider.getPractitionerLocation.md +162 -0
- package/docs/operations/provider.listEncounters.md +84 -1
- package/docs/operations/provider.listPractitionerLocations.md +130 -0
- package/docs/operations/provider.register.md +25 -3
- package/docs/operations/provider.setPractitionerPortalRoles.md +271 -0
- package/docs/operations/provider.updateEncounterClinicalNote.md +84 -1
- package/docs/operations/provider.updateEncounterStatus.md +84 -1
- package/docs/operations/provider.updatePractitioner.md +256 -150
- package/docs/operations/provider.updatePractitionerLocation.md +233 -0
- package/docs/operations/provider.verifyPractitionerNpi.md +273 -0
- package/package.json +1 -1
|
@@ -49,89 +49,118 @@ Request model: [`UpdatePractitionerRequest`](../models/UpdatePractitionerRequest
|
|
|
49
49
|
```json
|
|
50
50
|
{
|
|
51
51
|
"active": true,
|
|
52
|
-
"
|
|
53
|
-
"city": "Boston",
|
|
54
|
-
"country": "US",
|
|
55
|
-
"is_primary": true,
|
|
56
|
-
"state": "MA",
|
|
57
|
-
"street1": "200 Medical Plaza",
|
|
58
|
-
"street2": "Suite 300",
|
|
59
|
-
"type": "work",
|
|
60
|
-
"zip_code": "02108"
|
|
61
|
-
},
|
|
62
|
-
"birth_date": "1980-05-12",
|
|
52
|
+
"birth_date": "string",
|
|
63
53
|
"board_certifications": [
|
|
64
|
-
"
|
|
54
|
+
"string"
|
|
55
|
+
],
|
|
56
|
+
"credential": "string",
|
|
57
|
+
"credentials": [
|
|
58
|
+
{
|
|
59
|
+
"code": "string",
|
|
60
|
+
"primary": false,
|
|
61
|
+
"system": "http://terminology.hl7.org/CodeSystem/v2-0360"
|
|
62
|
+
}
|
|
65
63
|
],
|
|
66
|
-
"
|
|
67
|
-
"department": "Cardiology",
|
|
64
|
+
"department": "string",
|
|
68
65
|
"education_credentials": [
|
|
69
66
|
{
|
|
70
|
-
"credential": "
|
|
71
|
-
"graduation_year":
|
|
72
|
-
"
|
|
67
|
+
"credential": "string",
|
|
68
|
+
"graduation_year": 1900,
|
|
69
|
+
"id": "string",
|
|
70
|
+
"institution": "string",
|
|
71
|
+
"level": "undergraduate",
|
|
72
|
+
"program": "string",
|
|
73
|
+
"start_year": 1900
|
|
73
74
|
}
|
|
74
75
|
],
|
|
75
|
-
"email": "
|
|
76
|
-
"first_name": "
|
|
77
|
-
"gender": "
|
|
78
|
-
"graduation_year":
|
|
76
|
+
"email": "string",
|
|
77
|
+
"first_name": "string",
|
|
78
|
+
"gender": "male",
|
|
79
|
+
"graduation_year": 0,
|
|
79
80
|
"identifiers": [
|
|
80
81
|
{
|
|
81
|
-
"expiration_date": "
|
|
82
|
-
"state": "
|
|
83
|
-
"type": "
|
|
84
|
-
"value": "
|
|
82
|
+
"expiration_date": "string",
|
|
83
|
+
"state": "string",
|
|
84
|
+
"type": "NPI",
|
|
85
|
+
"value": "string"
|
|
85
86
|
}
|
|
86
87
|
],
|
|
87
88
|
"insurances_accepted": [
|
|
88
89
|
{
|
|
89
|
-
"payer_id": "
|
|
90
|
-
"payer_name": "
|
|
90
|
+
"payer_id": "string",
|
|
91
|
+
"payer_name": "string"
|
|
91
92
|
}
|
|
92
93
|
],
|
|
93
|
-
"languages_spoken": [
|
|
94
|
+
"languages_spoken": [],
|
|
95
|
+
"last_name": "string",
|
|
96
|
+
"medical_school": "string",
|
|
97
|
+
"middle_name": "string",
|
|
98
|
+
"notes": "string",
|
|
99
|
+
"npi": "string",
|
|
100
|
+
"onboarding": {
|
|
101
|
+
"completed_steps": [
|
|
102
|
+
"string"
|
|
103
|
+
],
|
|
104
|
+
"flow": "virtual-practice"
|
|
105
|
+
},
|
|
106
|
+
"organization_id": "string",
|
|
107
|
+
"organization_name": "string",
|
|
108
|
+
"postgraduate_training": [
|
|
94
109
|
{
|
|
95
|
-
"
|
|
96
|
-
"
|
|
110
|
+
"end_year": 1900,
|
|
111
|
+
"id": "string",
|
|
112
|
+
"institution": "string",
|
|
113
|
+
"specialty": "string",
|
|
114
|
+
"start_year": 1900,
|
|
115
|
+
"type": "residency"
|
|
97
116
|
}
|
|
98
117
|
],
|
|
99
|
-
"
|
|
100
|
-
"
|
|
101
|
-
"
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
"prefix": "Dr.",
|
|
118
|
+
"prefix": "string",
|
|
119
|
+
"professional_display_name": "string",
|
|
120
|
+
"professional_liability": {
|
|
121
|
+
"carrier": "string",
|
|
122
|
+
"coverage_expiration": "string",
|
|
123
|
+
"policy_number": "string"
|
|
124
|
+
},
|
|
107
125
|
"race": [
|
|
108
|
-
"
|
|
126
|
+
"american_indian_or_alaska_native"
|
|
109
127
|
],
|
|
110
128
|
"roles": [
|
|
111
129
|
"physician"
|
|
112
130
|
],
|
|
113
131
|
"specialty": [
|
|
114
132
|
{
|
|
115
|
-
"board_certified":
|
|
116
|
-
"code": "
|
|
117
|
-
"display": "
|
|
118
|
-
"primary":
|
|
133
|
+
"board_certified": false,
|
|
134
|
+
"code": "string",
|
|
135
|
+
"display": "string",
|
|
136
|
+
"primary": false,
|
|
119
137
|
"system": "http://nucc.org/provider-taxonomy"
|
|
120
138
|
}
|
|
121
139
|
],
|
|
122
140
|
"state_licenses": [
|
|
123
141
|
{
|
|
124
|
-
"
|
|
125
|
-
"
|
|
126
|
-
"
|
|
142
|
+
"compact": false,
|
|
143
|
+
"expiration_date": "string",
|
|
144
|
+
"id": "string",
|
|
145
|
+
"issued_date": "string",
|
|
146
|
+
"license_number": "string",
|
|
147
|
+
"license_type": "string",
|
|
148
|
+
"primary": false,
|
|
149
|
+
"state": "st",
|
|
150
|
+
"status": "active",
|
|
151
|
+
"verification": {
|
|
152
|
+
"source": "string",
|
|
153
|
+
"status": "self-attested",
|
|
154
|
+
"verified_at": "2026-01-01T09:00:00Z"
|
|
155
|
+
}
|
|
127
156
|
}
|
|
128
157
|
],
|
|
129
|
-
"suffix": "
|
|
158
|
+
"suffix": "string",
|
|
130
159
|
"telecom": [
|
|
131
160
|
{
|
|
132
|
-
"system": "
|
|
161
|
+
"system": "string",
|
|
133
162
|
"use": "work",
|
|
134
|
-
"value": "
|
|
163
|
+
"value": "string"
|
|
135
164
|
}
|
|
136
165
|
]
|
|
137
166
|
}
|
|
@@ -150,91 +179,130 @@ Request model: [`UpdatePractitionerRequest`](../models/UpdatePractitionerRequest
|
|
|
150
179
|
```json
|
|
151
180
|
{
|
|
152
181
|
"active": true,
|
|
153
|
-
"
|
|
154
|
-
"city": "Boston",
|
|
155
|
-
"country": "US",
|
|
156
|
-
"is_primary": true,
|
|
157
|
-
"state": "MA",
|
|
158
|
-
"street1": "200 Medical Plaza",
|
|
159
|
-
"street2": "Suite 300",
|
|
160
|
-
"type": "work",
|
|
161
|
-
"zip_code": "02108"
|
|
162
|
-
},
|
|
163
|
-
"birth_date": "1980-05-12",
|
|
182
|
+
"birth_date": "string",
|
|
164
183
|
"board_certifications": [
|
|
165
|
-
"
|
|
184
|
+
"string"
|
|
166
185
|
],
|
|
167
|
-
"credential": "
|
|
168
|
-
"
|
|
186
|
+
"credential": "string",
|
|
187
|
+
"credentials": [
|
|
188
|
+
{
|
|
189
|
+
"code": "string",
|
|
190
|
+
"primary": false,
|
|
191
|
+
"system": "http://terminology.hl7.org/CodeSystem/v2-0360"
|
|
192
|
+
}
|
|
193
|
+
],
|
|
194
|
+
"department": "string",
|
|
169
195
|
"education_credentials": [
|
|
170
196
|
{
|
|
171
|
-
"credential": "
|
|
172
|
-
"graduation_year":
|
|
173
|
-
"
|
|
197
|
+
"credential": "string",
|
|
198
|
+
"graduation_year": 1900,
|
|
199
|
+
"id": "string",
|
|
200
|
+
"institution": "string",
|
|
201
|
+
"level": "undergraduate",
|
|
202
|
+
"program": "string",
|
|
203
|
+
"start_year": 1900
|
|
174
204
|
}
|
|
175
205
|
],
|
|
176
|
-
"email": "
|
|
177
|
-
"
|
|
178
|
-
"
|
|
179
|
-
"
|
|
180
|
-
"graduation_year": 2006,
|
|
206
|
+
"email": "user@example.com",
|
|
207
|
+
"first_name": "string",
|
|
208
|
+
"gender": "unknown",
|
|
209
|
+
"graduation_year": 0,
|
|
181
210
|
"identifiers": [
|
|
182
211
|
{
|
|
183
|
-
"expiration_date": "
|
|
184
|
-
"state": "
|
|
185
|
-
"type": "
|
|
186
|
-
"value": "
|
|
212
|
+
"expiration_date": "string",
|
|
213
|
+
"state": "string",
|
|
214
|
+
"type": "NPI",
|
|
215
|
+
"value": "string"
|
|
187
216
|
}
|
|
188
217
|
],
|
|
189
218
|
"insurances_accepted": [
|
|
190
219
|
{
|
|
191
|
-
"payer_id": "
|
|
192
|
-
"payer_name": "
|
|
220
|
+
"payer_id": "string",
|
|
221
|
+
"payer_name": "string"
|
|
193
222
|
}
|
|
194
223
|
],
|
|
195
|
-
"languages_spoken": [
|
|
224
|
+
"languages_spoken": [],
|
|
225
|
+
"last_name": "string",
|
|
226
|
+
"medical_school": "string",
|
|
227
|
+
"middle_name": "string",
|
|
228
|
+
"notes": "string",
|
|
229
|
+
"npi": "string",
|
|
230
|
+
"npi_verification": {
|
|
231
|
+
"registry_first_name": "string",
|
|
232
|
+
"registry_last_name": "string",
|
|
233
|
+
"source": "string",
|
|
234
|
+
"status": "unverified",
|
|
235
|
+
"verified_at": "2026-01-01T09:00:00Z"
|
|
236
|
+
},
|
|
237
|
+
"onboarding": {
|
|
238
|
+
"completed_at": "2026-01-01T09:00:00Z",
|
|
239
|
+
"completed_steps": [
|
|
240
|
+
"string"
|
|
241
|
+
],
|
|
242
|
+
"flow": "virtual-practice"
|
|
243
|
+
},
|
|
244
|
+
"organization_id": "string",
|
|
245
|
+
"organization_name": "string",
|
|
246
|
+
"portal_roles": [
|
|
247
|
+
"provider_applicant"
|
|
248
|
+
],
|
|
249
|
+
"postgraduate_training": [
|
|
196
250
|
{
|
|
197
|
-
"
|
|
198
|
-
"
|
|
251
|
+
"end_year": 1900,
|
|
252
|
+
"id": "string",
|
|
253
|
+
"institution": "string",
|
|
254
|
+
"specialty": "string",
|
|
255
|
+
"start_year": 1900,
|
|
256
|
+
"type": "residency"
|
|
199
257
|
}
|
|
200
258
|
],
|
|
201
|
-
"
|
|
202
|
-
"
|
|
203
|
-
"
|
|
204
|
-
"
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
"prefix": "Dr.",
|
|
259
|
+
"practitioner_id": "string",
|
|
260
|
+
"prefix": "string",
|
|
261
|
+
"professional_display_name": "string",
|
|
262
|
+
"professional_liability": {
|
|
263
|
+
"carrier": "string",
|
|
264
|
+
"coverage_expiration": "string",
|
|
265
|
+
"policy_number": "string"
|
|
266
|
+
},
|
|
210
267
|
"race": [
|
|
211
|
-
"
|
|
268
|
+
"american_indian_or_alaska_native"
|
|
212
269
|
],
|
|
213
270
|
"roles": [
|
|
214
271
|
"physician"
|
|
215
272
|
],
|
|
216
273
|
"specialty": [
|
|
217
274
|
{
|
|
218
|
-
"board_certified":
|
|
219
|
-
"code": "
|
|
220
|
-
"display": "
|
|
221
|
-
"primary":
|
|
275
|
+
"board_certified": false,
|
|
276
|
+
"code": "string",
|
|
277
|
+
"display": "string",
|
|
278
|
+
"primary": false,
|
|
222
279
|
"system": "http://nucc.org/provider-taxonomy"
|
|
223
280
|
}
|
|
224
281
|
],
|
|
225
282
|
"state_licenses": [
|
|
226
283
|
{
|
|
227
|
-
"
|
|
228
|
-
"
|
|
229
|
-
"
|
|
284
|
+
"compact": false,
|
|
285
|
+
"expiration_date": "string",
|
|
286
|
+
"id": "string",
|
|
287
|
+
"issued_date": "string",
|
|
288
|
+
"license_number": "string",
|
|
289
|
+
"license_type": "string",
|
|
290
|
+
"primary": false,
|
|
291
|
+
"state": "st",
|
|
292
|
+
"status": "active",
|
|
293
|
+
"verification": {
|
|
294
|
+
"source": "string",
|
|
295
|
+
"status": "self-attested",
|
|
296
|
+
"verified_at": "2026-01-01T09:00:00Z"
|
|
297
|
+
}
|
|
230
298
|
}
|
|
231
299
|
],
|
|
232
|
-
"suffix": "
|
|
300
|
+
"suffix": "string",
|
|
233
301
|
"telecom": [
|
|
234
302
|
{
|
|
235
|
-
"system": "
|
|
303
|
+
"system": "string",
|
|
236
304
|
"use": "work",
|
|
237
|
-
"value": "
|
|
305
|
+
"value": "string"
|
|
238
306
|
}
|
|
239
307
|
]
|
|
240
308
|
}
|
|
@@ -246,6 +314,7 @@ Request model: [`UpdatePractitionerRequest`](../models/UpdatePractitionerRequest
|
|
|
246
314
|
|---|---|---|---|
|
|
247
315
|
| `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | The body used the unsupported 'specialties' key, or the update failed |
|
|
248
316
|
| `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
317
|
+
| `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
|
|
249
318
|
| `404` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | No Practitioner resource exists for practitioner_id |
|
|
250
319
|
|
|
251
320
|
## Error examples
|
|
@@ -266,6 +335,14 @@ Request model: [`UpdatePractitionerRequest`](../models/UpdatePractitionerRequest
|
|
|
266
335
|
}
|
|
267
336
|
```
|
|
268
337
|
|
|
338
|
+
### 403
|
|
339
|
+
|
|
340
|
+
```json
|
|
341
|
+
{
|
|
342
|
+
"error": "string"
|
|
343
|
+
}
|
|
344
|
+
```
|
|
345
|
+
|
|
269
346
|
### 404 — No Practitioner resource matches practitioner_id
|
|
270
347
|
|
|
271
348
|
```json
|
|
@@ -286,89 +363,118 @@ const fhirPractitionerId = "<FHIR_PRACTITIONER_ID>";
|
|
|
286
363
|
|
|
287
364
|
const request = {
|
|
288
365
|
"active": true,
|
|
289
|
-
"
|
|
290
|
-
"city": "Boston",
|
|
291
|
-
"country": "US",
|
|
292
|
-
"is_primary": true,
|
|
293
|
-
"state": "MA",
|
|
294
|
-
"street1": "200 Medical Plaza",
|
|
295
|
-
"street2": "Suite 300",
|
|
296
|
-
"type": "work",
|
|
297
|
-
"zip_code": "02108"
|
|
298
|
-
},
|
|
299
|
-
"birth_date": "1980-05-12",
|
|
366
|
+
"birth_date": "string",
|
|
300
367
|
"board_certifications": [
|
|
301
|
-
"
|
|
368
|
+
"string"
|
|
369
|
+
],
|
|
370
|
+
"credential": "string",
|
|
371
|
+
"credentials": [
|
|
372
|
+
{
|
|
373
|
+
"code": "string",
|
|
374
|
+
"primary": false,
|
|
375
|
+
"system": "http://terminology.hl7.org/CodeSystem/v2-0360"
|
|
376
|
+
}
|
|
302
377
|
],
|
|
303
|
-
"
|
|
304
|
-
"department": "Cardiology",
|
|
378
|
+
"department": "string",
|
|
305
379
|
"education_credentials": [
|
|
306
380
|
{
|
|
307
|
-
"credential": "
|
|
308
|
-
"graduation_year":
|
|
309
|
-
"
|
|
381
|
+
"credential": "string",
|
|
382
|
+
"graduation_year": 1900,
|
|
383
|
+
"id": "string",
|
|
384
|
+
"institution": "string",
|
|
385
|
+
"level": "undergraduate",
|
|
386
|
+
"program": "string",
|
|
387
|
+
"start_year": 1900
|
|
310
388
|
}
|
|
311
389
|
],
|
|
312
|
-
"email": "
|
|
313
|
-
"first_name": "
|
|
314
|
-
"gender": "
|
|
315
|
-
"graduation_year":
|
|
390
|
+
"email": "string",
|
|
391
|
+
"first_name": "string",
|
|
392
|
+
"gender": "male",
|
|
393
|
+
"graduation_year": 0,
|
|
316
394
|
"identifiers": [
|
|
317
395
|
{
|
|
318
|
-
"expiration_date": "
|
|
319
|
-
"state": "
|
|
320
|
-
"type": "
|
|
321
|
-
"value": "
|
|
396
|
+
"expiration_date": "string",
|
|
397
|
+
"state": "string",
|
|
398
|
+
"type": "NPI",
|
|
399
|
+
"value": "string"
|
|
322
400
|
}
|
|
323
401
|
],
|
|
324
402
|
"insurances_accepted": [
|
|
325
403
|
{
|
|
326
|
-
"payer_id": "
|
|
327
|
-
"payer_name": "
|
|
404
|
+
"payer_id": "string",
|
|
405
|
+
"payer_name": "string"
|
|
328
406
|
}
|
|
329
407
|
],
|
|
330
|
-
"languages_spoken": [
|
|
408
|
+
"languages_spoken": [],
|
|
409
|
+
"last_name": "string",
|
|
410
|
+
"medical_school": "string",
|
|
411
|
+
"middle_name": "string",
|
|
412
|
+
"notes": "string",
|
|
413
|
+
"npi": "string",
|
|
414
|
+
"onboarding": {
|
|
415
|
+
"completed_steps": [
|
|
416
|
+
"string"
|
|
417
|
+
],
|
|
418
|
+
"flow": "virtual-practice"
|
|
419
|
+
},
|
|
420
|
+
"organization_id": "string",
|
|
421
|
+
"organization_name": "string",
|
|
422
|
+
"postgraduate_training": [
|
|
331
423
|
{
|
|
332
|
-
"
|
|
333
|
-
"
|
|
424
|
+
"end_year": 1900,
|
|
425
|
+
"id": "string",
|
|
426
|
+
"institution": "string",
|
|
427
|
+
"specialty": "string",
|
|
428
|
+
"start_year": 1900,
|
|
429
|
+
"type": "residency"
|
|
334
430
|
}
|
|
335
431
|
],
|
|
336
|
-
"
|
|
337
|
-
"
|
|
338
|
-
"
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
"prefix": "Dr.",
|
|
432
|
+
"prefix": "string",
|
|
433
|
+
"professional_display_name": "string",
|
|
434
|
+
"professional_liability": {
|
|
435
|
+
"carrier": "string",
|
|
436
|
+
"coverage_expiration": "string",
|
|
437
|
+
"policy_number": "string"
|
|
438
|
+
},
|
|
344
439
|
"race": [
|
|
345
|
-
"
|
|
440
|
+
"american_indian_or_alaska_native"
|
|
346
441
|
],
|
|
347
442
|
"roles": [
|
|
348
443
|
"physician"
|
|
349
444
|
],
|
|
350
445
|
"specialty": [
|
|
351
446
|
{
|
|
352
|
-
"board_certified":
|
|
353
|
-
"code": "
|
|
354
|
-
"display": "
|
|
355
|
-
"primary":
|
|
447
|
+
"board_certified": false,
|
|
448
|
+
"code": "string",
|
|
449
|
+
"display": "string",
|
|
450
|
+
"primary": false,
|
|
356
451
|
"system": "http://nucc.org/provider-taxonomy"
|
|
357
452
|
}
|
|
358
453
|
],
|
|
359
454
|
"state_licenses": [
|
|
360
455
|
{
|
|
361
|
-
"
|
|
362
|
-
"
|
|
363
|
-
"
|
|
456
|
+
"compact": false,
|
|
457
|
+
"expiration_date": "string",
|
|
458
|
+
"id": "string",
|
|
459
|
+
"issued_date": "string",
|
|
460
|
+
"license_number": "string",
|
|
461
|
+
"license_type": "string",
|
|
462
|
+
"primary": false,
|
|
463
|
+
"state": "st",
|
|
464
|
+
"status": "active",
|
|
465
|
+
"verification": {
|
|
466
|
+
"source": "string",
|
|
467
|
+
"status": "self-attested",
|
|
468
|
+
"verified_at": "2026-01-01T09:00:00Z"
|
|
469
|
+
}
|
|
364
470
|
}
|
|
365
471
|
],
|
|
366
|
-
"suffix": "
|
|
472
|
+
"suffix": "string",
|
|
367
473
|
"telecom": [
|
|
368
474
|
{
|
|
369
|
-
"system": "
|
|
475
|
+
"system": "string",
|
|
370
476
|
"use": "work",
|
|
371
|
-
"value": "
|
|
477
|
+
"value": "string"
|
|
372
478
|
}
|
|
373
479
|
]
|
|
374
480
|
};
|
|
@@ -382,7 +488,7 @@ const result = await provider.update(fhirPractitionerId, request);
|
|
|
382
488
|
curl -X PATCH \
|
|
383
489
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
384
490
|
-H 'Content-Type: application/json' \
|
|
385
|
-
-d '{"active":true,"
|
|
491
|
+
-d '{"active":true,"birth_date":"string","board_certifications":["string"],"credential":"string","credentials":[{"code":"string","primary":false,"system":"http://terminology.hl7.org/CodeSystem/v2-0360"}],"department":"string","education_credentials":[{"credential":"string","graduation_year":1900,"id":"string","institution":"string","level":"undergraduate","program":"string","start_year":1900}],"email":"string","first_name":"string","gender":"male","graduation_year":0,"identifiers":[{"expiration_date":"string","state":"string","type":"NPI","value":"string"}],"insurances_accepted":[{"payer_id":"string","payer_name":"string"}],"languages_spoken":[],"last_name":"string","medical_school":"string","middle_name":"string","notes":"string","npi":"string","onboarding":{"completed_steps":["string"],"flow":"virtual-practice"},"organization_id":"string","organization_name":"string","postgraduate_training":[{"end_year":1900,"id":"string","institution":"string","specialty":"string","start_year":1900,"type":"residency"}],"prefix":"string","professional_display_name":"string","professional_liability":{"carrier":"string","coverage_expiration":"string","policy_number":"string"},"race":["american_indian_or_alaska_native"],"roles":["physician"],"specialty":[{"board_certified":false,"code":"string","display":"string","primary":false,"system":"http://nucc.org/provider-taxonomy"}],"state_licenses":[{"compact":false,"expiration_date":"string","id":"string","issued_date":"string","license_number":"string","license_type":"string","primary":false,"state":"st","status":"active","verification":{"source":"string","status":"self-attested","verified_at":"2026-01-01T09:00:00Z"}}],"suffix":"string","telecom":[{"system":"string","use":"work","value":"string"}]}' \
|
|
386
492
|
'https://dev-api-provider.health.cloud/practitioners/%3CPRACTITIONER_ID%3E'
|
|
387
493
|
```
|
|
388
494
|
|