@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
package/dist/index.js CHANGED
@@ -286,6 +286,9 @@ var AppointmentsClient = class extends BaseServiceClient {
286
286
  /**
287
287
  * Book an appointment for a specific slot.
288
288
  * POST /appointments/book
289
+ * Pass one caller-created idempotency_key per confirmed attempt and reuse
290
+ * it unchanged on retries. Completed results are remembered for at least
291
+ * 24 hours. This method never generates a replacement key.
289
292
  *
290
293
  * On an Athena-integrated tenant the booking is made in Athena only — no
291
294
  * local FHIR Appointment is written — and `athena_appointment_id` is
@@ -3474,6 +3477,40 @@ var ProviderClient = class extends BaseServiceClient {
3474
3477
  getPhoto(fhirPractitionerId, query) {
3475
3478
  return this.send("GET", "/practitioners/{practitioner_id}/photo", { pathParams: { practitioner_id: fhirPractitionerId }, query });
3476
3479
  }
3480
+ // ─── Practice locations ────────────────────────────────────────────
3481
+ /** GET /practitioners/{practitioner_id}/locations */
3482
+ listPractitionerLocations(fhirPractitionerId) {
3483
+ return this.send("GET", "/practitioners/{practitioner_id}/locations", { pathParams: { practitioner_id: fhirPractitionerId } });
3484
+ }
3485
+ /** POST /practitioners/{practitioner_id}/locations. The TIN is write-only and never returned. */
3486
+ createPractitionerLocation(fhirPractitionerId, request) {
3487
+ return this.send("POST", "/practitioners/{practitioner_id}/locations", { pathParams: { practitioner_id: fhirPractitionerId }, body: request });
3488
+ }
3489
+ /** GET /practitioners/{practitioner_id}/locations/{location_id} */
3490
+ getPractitionerLocation(fhirPractitionerId, locationId) {
3491
+ return this.send("GET", "/practitioners/{practitioner_id}/locations/{location_id}", { pathParams: { practitioner_id: fhirPractitionerId, location_id: locationId } });
3492
+ }
3493
+ /** PATCH /practitioners/{practitioner_id}/locations/{location_id}. Omitted fields are unchanged. */
3494
+ updatePractitionerLocation(fhirPractitionerId, locationId, request) {
3495
+ return this.send("PATCH", "/practitioners/{practitioner_id}/locations/{location_id}", { pathParams: { practitioner_id: fhirPractitionerId, location_id: locationId }, body: request });
3496
+ }
3497
+ /** DELETE /practitioners/{practitioner_id}/locations/{location_id} */
3498
+ deletePractitionerLocation(fhirPractitionerId, locationId) {
3499
+ return this.send("DELETE", "/practitioners/{practitioner_id}/locations/{location_id}", { pathParams: { practitioner_id: fhirPractitionerId, location_id: locationId } });
3500
+ }
3501
+ // ─── Onboarding, NPI, and portal roles ─────────────────────────────
3502
+ /** POST /practitioners/{practitioner_id}/npi/verify. The server checks NPPES and records the result. */
3503
+ verifyPractitionerNpi(fhirPractitionerId) {
3504
+ return this.send("POST", "/practitioners/{practitioner_id}/npi/verify", { pathParams: { practitioner_id: fhirPractitionerId } });
3505
+ }
3506
+ /** POST /practitioners/{practitioner_id}/onboarding/complete. Virtual Practice completion grants practice_owner. */
3507
+ completePractitionerOnboarding(fhirPractitionerId) {
3508
+ return this.send("POST", "/practitioners/{practitioner_id}/onboarding/complete", { pathParams: { practitioner_id: fhirPractitionerId } });
3509
+ }
3510
+ /** PUT /practitioners/{practitioner_id}/portal-roles. Platform admin only. */
3511
+ setPractitionerPortalRoles(fhirPractitionerId, request) {
3512
+ return this.send("PUT", "/practitioners/{practitioner_id}/portal-roles", { pathParams: { practitioner_id: fhirPractitionerId }, body: request });
3513
+ }
3477
3514
  };
3478
3515
 
3479
3516
  // src/clients/RppgClient.ts
@@ -1,23 +1,31 @@
1
1
  # ProviderClient
2
2
 
3
+ - [`completePractitionerOnboarding`](../operations/provider.completePractitionerOnboarding.md) — Record onboarding completion for the practitioner's current flow
3
4
  - [`confirmPassword`](../operations/provider.confirmResetPassword.md) — Complete a password reset
4
5
  - [`connect`](../operations/provider.connect.md) — Health check
6
+ - [`createPractitionerLocation`](../operations/provider.createPractitionerLocation.md) — Add a practice location
7
+ - [`deletePractitionerLocation`](../operations/provider.deletePractitionerLocation.md) — Remove a practice location
5
8
  - [`getAppointment`](../operations/provider.getAppointment.md) — Get one appointment with patient demographics
6
9
  - [`getEncounter`](../operations/provider.getEncounter.md) — Get one encounter with patient demographics
7
10
  - [`getPatientRecord`](../operations/provider.getPatientRecord.md) — Get a patient's consolidated health record (provider tenant scope)
8
11
  - [`getPhoto`](../operations/provider.getPhoto.md) — Get a practitioner photo
9
12
  - [`getPhotoUploadUrl`](../operations/provider.getPhotoUploadUrl.md) — Get a presigned photo upload URL
10
13
  - [`get`](../operations/provider.getPractitioner.md) — Get a practitioner profile
14
+ - [`getPractitionerLocation`](../operations/provider.getPractitionerLocation.md) — Get one practice location
11
15
  - [`listAppointments`](../operations/provider.listAppointments.md) — List tenant appointments
12
16
  - [`listEncounters`](../operations/provider.listEncounters.md) — List tenant encounters
17
+ - [`listPractitionerLocations`](../operations/provider.listPractitionerLocations.md) — List the practitioner's practice locations
13
18
  - [`login`](../operations/provider.login.md) — Log in a practitioner
14
19
  - [`refreshToken`](../operations/provider.refreshToken.md) — Refresh practitioner access tokens
15
20
  - [`register`](../operations/provider.register.md) — Register a practitioner
16
21
  - [`resetPassword`](../operations/provider.resetPassword.md) — Start a password reset
22
+ - [`setPractitionerPortalRoles`](../operations/provider.setPractitionerPortalRoles.md) — Set a practitioner's provider-portal roles (platform admin only)
17
23
  - [`updateEncounterClinicalNote`](../operations/provider.updateEncounterClinicalNote.md) — Update encounter notes and assessment
18
24
  - [`updateEncounterStatus`](../operations/provider.updateEncounterStatus.md) — Update encounter status
19
25
  - [`updatePhone`](../operations/provider.updatePhone.md) — Update a practitioner's phone number
20
26
  - [`update`](../operations/provider.updatePractitioner.md) — Update a practitioner profile
27
+ - [`updatePractitionerLocation`](../operations/provider.updatePractitionerLocation.md) — Update a practice location. Omitted fields are unchanged.
21
28
  - [`uploadPhoto`](../operations/provider.uploadPhoto.md) — Upload a practitioner photo
22
29
  - [`verifyEmail`](../operations/provider.verifyEmail.md) — Verify a practitioner's email OTP
30
+ - [`verifyPractitionerNpi`](../operations/provider.verifyPractitionerNpi.md) — Check the practitioner's NPI against the NPPES registry and record the result
23
31
  - [`verifySms`](../operations/provider.verifySms.md) — Verify a practitioner's phone OTP
@@ -1,5 +1,5 @@
1
1
  {
2
- "docsDataContentDigest": "sha256:2ba44dd2c8b7bc55e158e775cdc5f5f05ef0958ffa56ebf972ceca92449f4db3",
2
+ "docsDataContentDigest": "sha256:38987b7e37278cf36ee18ff68c57c3010b9fa846db5c6cca4eabe774b79b8780",
3
3
  "generatedFiles": [
4
4
  "authentication.md",
5
5
  "clients/AmsClient.md",
@@ -64,10 +64,10 @@
64
64
  "models/AddPatientIntakeResponse.md",
65
65
  "models/Address.md",
66
66
  "models/AddressType.md",
67
- "models/AdvanceDirective.md",
68
67
  "models/AdvanceDirectiveType.md",
69
68
  "models/AgentDashboardResponse.md",
70
- "models/Allergy.md",
69
+ "models/AlcoholFrequency.md",
70
+ "models/AlcoholUse.md",
71
71
  "models/AllergyCategory.md",
72
72
  "models/AllergyCriticality.md",
73
73
  "models/AllergyStatus.md",
@@ -401,8 +401,11 @@
401
401
  "models/AthenaVitalFailedReading.md",
402
402
  "models/AthenaVitalsMirrorResult.md",
403
403
  "models/BloodPressureVital.md",
404
+ "models/BodyHeight.md",
404
405
  "models/BodyHeightVital.md",
406
+ "models/BodyTemperature.md",
405
407
  "models/BodyTemperatureVital.md",
408
+ "models/BodyWeight.md",
406
409
  "models/BodyWeightVital.md",
407
410
  "models/BookAppointmentRequest.md",
408
411
  "models/CMSCounty.md",
@@ -523,6 +526,7 @@
523
526
  "models/DependentResponse.md",
524
527
  "models/DiagnosticTest.md",
525
528
  "models/DiagnosticTestRelationship.md",
529
+ "models/DietCategory.md",
526
530
  "models/DirectiveScope.md",
527
531
  "models/DirectiveStatus.md",
528
532
  "models/DischargeDisposition.md",
@@ -531,6 +535,7 @@
531
535
  "models/DocumentSummarySearchResponse.md",
532
536
  "models/DriversLicense.md",
533
537
  "models/DriversLicenseSubmission.md",
538
+ "models/EducationLevel.md",
534
539
  "models/ElevenLabsAccessInfo.md",
535
540
  "models/ElevenLabsAgent.md",
536
541
  "models/ElevenLabsAgentSettings.md",
@@ -575,9 +580,9 @@
575
580
  "models/EncounterClass.md",
576
581
  "models/EncounterStatus.md",
577
582
  "models/Ethnicity.md",
583
+ "models/ExerciseFrequency.md",
578
584
  "models/FaceMatchRequest.md",
579
585
  "models/FaceMatchResponse.md",
580
- "models/FamilyHistoryEntry.md",
581
586
  "models/FamilyHistoryStatus.md",
582
587
  "models/FamilyRelationship.md",
583
588
  "models/FedexCreateShipmentRequest.md",
@@ -591,6 +596,8 @@
591
596
  "models/FieldAgentProfileResponse.md",
592
597
  "models/FlagOperationError.md",
593
598
  "models/FlagOperationReceipt.md",
599
+ "models/FunctionalLevel.md",
600
+ "models/FunctionalStatus.md",
594
601
  "models/GS1LookupResponse.md",
595
602
  "models/GS1ParsedData.md",
596
603
  "models/Gender.md",
@@ -1091,7 +1098,6 @@
1091
1098
  "models/HealthieUpdateUserRequest.md",
1092
1099
  "models/HealthieUpdateUserResponse.md",
1093
1100
  "models/HeartRateVital.md",
1094
- "models/Immunization.md",
1095
1101
  "models/ImmunizationRoute.md",
1096
1102
  "models/ImmunizationStatus.md",
1097
1103
  "models/ImpiloAddress.md",
@@ -1226,6 +1232,7 @@
1226
1232
  "models/KnowledgeCollection.md",
1227
1233
  "models/KnowledgeEntrySummary.md",
1228
1234
  "models/KnowledgeSearchResult.md",
1235
+ "models/LicenseVerification.md",
1229
1236
  "models/ListActionsResponse.md",
1230
1237
  "models/ListActivityResponse.md",
1231
1238
  "models/ListAllergiesResponse.md",
@@ -1253,6 +1260,9 @@
1253
1260
  "models/ListTestOrdersResponse.md",
1254
1261
  "models/ListVectorCollectionsResponse.md",
1255
1262
  "models/ListVitalsResponse.md",
1263
+ "models/LivingSituation.md",
1264
+ "models/LocationAddress.md",
1265
+ "models/LocationHours.md",
1256
1266
  "models/LocationStatus.md",
1257
1267
  "models/MaritalStatus.md",
1258
1268
  "models/McpFieldagentRequest.md",
@@ -1281,6 +1291,7 @@
1281
1291
  "models/NearestLocationsResponse.md",
1282
1292
  "models/NotificationResponse.md",
1283
1293
  "models/NotificationUpsertRequest.md",
1294
+ "models/NpiVerification.md",
1284
1295
  "models/NppesGetProviderRequest.md",
1285
1296
  "models/NppesSearchProvidersRequest.md",
1286
1297
  "models/NppesSearchProvidersResponse.md",
@@ -1303,6 +1314,7 @@
1303
1314
  "models/OnboardQuestionnaireStepResult.md",
1304
1315
  "models/OnboardVitalsPayload.md",
1305
1316
  "models/OnboardVitalsStepResult.md",
1317
+ "models/OnboardingProgressRequest.md",
1306
1318
  "models/OpenAIBuildResponseCreatePayloadRequest.md",
1307
1319
  "models/OpenAIBuildResponseCreatePayloadResponse.md",
1308
1320
  "models/OpenAIChatJsonRequest.md",
@@ -1386,17 +1398,16 @@
1386
1398
  "models/PlaidListIdentityVerificationsRequest.md",
1387
1399
  "models/PlaidListIdentityVerificationsResponse.md",
1388
1400
  "models/PolicyDocument.md",
1401
+ "models/PortalRole.md",
1389
1402
  "models/PositionCode.md",
1390
1403
  "models/Practitioner.md",
1391
1404
  "models/PreferredPharmacy.md",
1392
1405
  "models/PresenceRecord.md",
1393
1406
  "models/PresenceStatus.md",
1394
- "models/Problem.md",
1395
1407
  "models/ProblemCategory.md",
1396
1408
  "models/ProblemClinicalStatus.md",
1397
1409
  "models/ProblemSeverity.md",
1398
1410
  "models/ProblemVerificationStatus.md",
1399
- "models/Procedure.md",
1400
1411
  "models/ProcedureLaterality.md",
1401
1412
  "models/ProcedureStatus.md",
1402
1413
  "models/ProviderAcceptedInsurance.md",
@@ -1404,17 +1415,30 @@
1404
1415
  "models/ProviderAppointmentResponse.md",
1405
1416
  "models/ProviderAppointmentsResponse.md",
1406
1417
  "models/ProviderContactPoint.md",
1418
+ "models/ProviderCredential.md",
1407
1419
  "models/ProviderEducationCredential.md",
1408
1420
  "models/ProviderEncounterListResponse.md",
1421
+ "models/ProviderEncounterRecord.md",
1409
1422
  "models/ProviderEncounterResponse.md",
1410
1423
  "models/ProviderGender.md",
1411
1424
  "models/ProviderIdentifier.md",
1412
1425
  "models/ProviderIdentifierType.md",
1413
1426
  "models/ProviderLanguage.md",
1427
+ "models/ProviderLocation.md",
1428
+ "models/ProviderLocationAddressRequest.md",
1429
+ "models/ProviderLocationDeletedResponse.md",
1430
+ "models/ProviderLocationHoursRequest.md",
1431
+ "models/ProviderLocationListResponse.md",
1432
+ "models/ProviderLocationPatchRequest.md",
1433
+ "models/ProviderLocationRequest.md",
1434
+ "models/ProviderOnboardingStatus.md",
1414
1435
  "models/ProviderPatientAddress.md",
1415
1436
  "models/ProviderPatientPhone.md",
1437
+ "models/ProviderPatientRecordResources.md",
1416
1438
  "models/ProviderPatientRecordResponse.md",
1417
1439
  "models/ProviderPatientSummary.md",
1440
+ "models/ProviderPostgraduateTraining.md",
1441
+ "models/ProviderProfessionalLiability.md",
1418
1442
  "models/ProviderRole.md",
1419
1443
  "models/ProviderSearchRequest.md",
1420
1444
  "models/ProviderSearchResponse.md",
@@ -1467,7 +1491,6 @@
1467
1491
  "models/QuestSyncCompendiumsRequest.md",
1468
1492
  "models/QuestionItemType.md",
1469
1493
  "models/QuestionnaireItemInput.md",
1470
- "models/QuestionnaireResponse.md",
1471
1494
  "models/QuestionnaireResponseStatus.md",
1472
1495
  "models/Race.md",
1473
1496
  "models/RapidTestResult.md",
@@ -1478,8 +1501,6 @@
1478
1501
  "models/ReplaceInsuranceResponse.md",
1479
1502
  "models/RescheduleAppointmentRequest.md",
1480
1503
  "models/RespiratoryRate.md",
1481
- "models/ResponseAnswer.md",
1482
- "models/ResponseItem.md",
1483
1504
  "models/RetireInsuranceRequest.md",
1484
1505
  "models/RetireInsuranceResponse.md",
1485
1506
  "models/SalesforceAccount.md",
@@ -1668,11 +1689,15 @@
1668
1689
  "models/SendGridSendEmailRequest.md",
1669
1690
  "models/SendGridSendResult.md",
1670
1691
  "models/SendGridTemplate.md",
1692
+ "models/SetPortalRolesRequest.md",
1671
1693
  "models/SetPreferredPharmacyRequest.md",
1672
1694
  "models/SetPreferredPharmacyResponse.md",
1673
1695
  "models/SexAtBirth.md",
1696
+ "models/SexualOrientation.md",
1674
1697
  "models/Slot.md",
1675
1698
  "models/SlotStatus.md",
1699
+ "models/SmokingStatus.md",
1700
+ "models/SocialHistory.md",
1676
1701
  "models/Specimen.md",
1677
1702
  "models/SpecimenStatus.md",
1678
1703
  "models/SpecimenType.md",
@@ -1784,9 +1809,12 @@
1784
1809
  "models/SubmitCurrentSymptomsScreeningsCurrentSymptomsResponse.md",
1785
1810
  "models/SubmitSummaryRequest.md",
1786
1811
  "models/SubscriberRelationship.md",
1812
+ "models/SubstanceStatus.md",
1813
+ "models/SubstanceUse.md",
1787
1814
  "models/TelehealthToken.md",
1788
1815
  "models/TemperatureRoute.md",
1789
1816
  "models/TestOrder.md",
1817
+ "models/TobaccoUse.md",
1790
1818
  "models/TwilioGetMessageRequest.md",
1791
1819
  "models/TwilioListMessagesRequest.md",
1792
1820
  "models/TwilioListMessagesResponse.md",
@@ -1851,6 +1879,7 @@
1851
1879
  "models/VisionFaceCompareRequest.md",
1852
1880
  "models/VisionFaceCompareResponse.md",
1853
1881
  "models/VitalReading.md",
1882
+ "models/VitalsRecord.md",
1854
1883
  "models/VitalsRecordRequest.md",
1855
1884
  "models/VitalsStatus.md",
1856
1885
  "models/WhoopActivityIdMappingResponse.md",
@@ -1989,19 +2018,31 @@
1989
2018
  "models/appointments.ErrorResponse.md",
1990
2019
  "models/connectors.ImportVitalsRequest.md",
1991
2020
  "models/connectors.JsonValue.md",
2021
+ "models/diagnostics.Coding.md",
1992
2022
  "models/diagnostics.ConnectResponse.md",
1993
2023
  "models/diagnostics.ErrorResponse.md",
1994
2024
  "models/diagnostics.LabObservation.md",
1995
2025
  "models/diagnostics.ListDiagnosticsResponse.md",
1996
2026
  "models/diagnostics.ReferenceRange.md",
2027
+ "models/ehr.AdvanceDirective.md",
2028
+ "models/ehr.Allergy.md",
1997
2029
  "models/ehr.AllergyReaction.md",
1998
2030
  "models/ehr.CodedConcept.md",
2031
+ "models/ehr.Coding.md",
1999
2032
  "models/ehr.ConnectResponse.md",
2000
2033
  "models/ehr.FamilyCondition.md",
2034
+ "models/ehr.FamilyHistoryEntry.md",
2035
+ "models/ehr.Immunization.md",
2001
2036
  "models/ehr.ImmunizationReaction.md",
2002
2037
  "models/ehr.ListDiagnosticsResponse.md",
2003
2038
  "models/ehr.ListEncountersResponse.md",
2004
2039
  "models/ehr.ListMedicationsResponse.md",
2040
+ "models/ehr.Problem.md",
2041
+ "models/ehr.Procedure.md",
2042
+ "models/ehr.Quantity.md",
2043
+ "models/ehr.QuestionnaireResponse.md",
2044
+ "models/ehr.ResponseAnswer.md",
2045
+ "models/ehr.ResponseItem.md",
2005
2046
  "models/fieldagent.ConfirmResetPasswordRequest.md",
2006
2047
  "models/fieldagent.ConfirmResetPasswordResponse.md",
2007
2048
  "models/fieldagent.ConnectResponse.md",
@@ -2083,20 +2124,49 @@
2083
2124
  "models/person.VerifyEmailResponse.md",
2084
2125
  "models/person.VerifySmsRequest.md",
2085
2126
  "models/person.VerifySmsResponse.md",
2127
+ "models/provider.AdvanceDirective.md",
2128
+ "models/provider.Allergy.md",
2129
+ "models/provider.AllergyReaction.md",
2130
+ "models/provider.BloodPressure.md",
2131
+ "models/provider.CodedConcept.md",
2132
+ "models/provider.Coding.md",
2086
2133
  "models/provider.ConfirmResetPasswordRequest.md",
2087
2134
  "models/provider.ConfirmResetPasswordResponse.md",
2088
2135
  "models/provider.ConnectResponse.md",
2136
+ "models/provider.Dosage.md",
2137
+ "models/provider.Encounter.md",
2138
+ "models/provider.EncounterDiagnosis.md",
2139
+ "models/provider.EncounterHospitalization.md",
2140
+ "models/provider.EncounterLocation.md",
2141
+ "models/provider.EncounterParticipant.md",
2089
2142
  "models/provider.ErrorResponse.md",
2143
+ "models/provider.FamilyCondition.md",
2144
+ "models/provider.FamilyHistoryEntry.md",
2090
2145
  "models/provider.GetPhotoResponse.md",
2091
2146
  "models/provider.GetPhotoUploadUrlResponse.md",
2147
+ "models/provider.GynHistory.md",
2148
+ "models/provider.HeartRate.md",
2149
+ "models/provider.Immunization.md",
2150
+ "models/provider.ImmunizationReaction.md",
2151
+ "models/provider.LabObservation.md",
2092
2152
  "models/provider.LoginRequest.md",
2093
2153
  "models/provider.LoginResponse.md",
2154
+ "models/provider.Medication.md",
2155
+ "models/provider.PerinatalHistory.md",
2156
+ "models/provider.Problem.md",
2157
+ "models/provider.Procedure.md",
2158
+ "models/provider.PulseOximetry.md",
2159
+ "models/provider.Quantity.md",
2160
+ "models/provider.QuestionnaireResponse.md",
2161
+ "models/provider.ReferenceRange.md",
2094
2162
  "models/provider.RefreshTokenRequest.md",
2095
2163
  "models/provider.RefreshTokenResponse.md",
2096
2164
  "models/provider.RegisterRequest.md",
2097
2165
  "models/provider.RegisterResponse.md",
2098
2166
  "models/provider.ResetPasswordRequest.md",
2099
2167
  "models/provider.ResetPasswordResponse.md",
2168
+ "models/provider.ResponseAnswer.md",
2169
+ "models/provider.ResponseItem.md",
2100
2170
  "models/provider.UpdatePhoneRequest.md",
2101
2171
  "models/provider.UpdatePhoneResponse.md",
2102
2172
  "models/provider.UploadPhotoRequest.md",
@@ -3120,26 +3190,34 @@
3120
3190
  "operations/person.uploadPhoto.md",
3121
3191
  "operations/person.verifyEmail.md",
3122
3192
  "operations/person.verifySms.md",
3193
+ "operations/provider.completePractitionerOnboarding.md",
3123
3194
  "operations/provider.confirmResetPassword.md",
3124
3195
  "operations/provider.connect.md",
3196
+ "operations/provider.createPractitionerLocation.md",
3197
+ "operations/provider.deletePractitionerLocation.md",
3125
3198
  "operations/provider.getAppointment.md",
3126
3199
  "operations/provider.getEncounter.md",
3127
3200
  "operations/provider.getPatientRecord.md",
3128
3201
  "operations/provider.getPhoto.md",
3129
3202
  "operations/provider.getPhotoUploadUrl.md",
3130
3203
  "operations/provider.getPractitioner.md",
3204
+ "operations/provider.getPractitionerLocation.md",
3131
3205
  "operations/provider.listAppointments.md",
3132
3206
  "operations/provider.listEncounters.md",
3207
+ "operations/provider.listPractitionerLocations.md",
3133
3208
  "operations/provider.login.md",
3134
3209
  "operations/provider.refreshToken.md",
3135
3210
  "operations/provider.register.md",
3136
3211
  "operations/provider.resetPassword.md",
3212
+ "operations/provider.setPractitionerPortalRoles.md",
3137
3213
  "operations/provider.updateEncounterClinicalNote.md",
3138
3214
  "operations/provider.updateEncounterStatus.md",
3139
3215
  "operations/provider.updatePhone.md",
3140
3216
  "operations/provider.updatePractitioner.md",
3217
+ "operations/provider.updatePractitionerLocation.md",
3141
3218
  "operations/provider.uploadPhoto.md",
3142
3219
  "operations/provider.verifyEmail.md",
3220
+ "operations/provider.verifyPractitionerNpi.md",
3143
3221
  "operations/provider.verifySms.md",
3144
3222
  "operations/rppg.connect.md",
3145
3223
  "operations/session.connect.md",
@@ -3152,7 +3230,7 @@
3152
3230
  "operations/vitals.recordVitals.md"
3153
3231
  ],
3154
3232
  "language": "nodejs",
3155
- "modelCount": 2055,
3156
- "operationCount": 1040,
3233
+ "modelCount": 2125,
3234
+ "operationCount": 1048,
3157
3235
  "schemaVersion": 1
3158
3236
  }
@@ -1012,26 +1012,34 @@ Generated call examples use exact public surface signatures. Workflow examples r
1012
1012
  - [Upload a person photo](../operations/person.uploadPhoto.md)
1013
1013
  - [Verify a person's email OTP](../operations/person.verifyEmail.md)
1014
1014
  - [Verify a person's phone OTP](../operations/person.verifySms.md)
1015
+ - [Record onboarding completion for the practitioner's current flow](../operations/provider.completePractitionerOnboarding.md)
1015
1016
  - [Complete a password reset](../operations/provider.confirmResetPassword.md)
1016
1017
  - [Health check](../operations/provider.connect.md)
1018
+ - [Add a practice location](../operations/provider.createPractitionerLocation.md)
1019
+ - [Remove a practice location](../operations/provider.deletePractitionerLocation.md)
1017
1020
  - [Get one appointment with patient demographics](../operations/provider.getAppointment.md)
1018
1021
  - [Get one encounter with patient demographics](../operations/provider.getEncounter.md)
1019
1022
  - [Get a patient's consolidated health record (provider tenant scope)](../operations/provider.getPatientRecord.md)
1020
1023
  - [Get a practitioner photo](../operations/provider.getPhoto.md)
1021
1024
  - [Get a presigned photo upload URL](../operations/provider.getPhotoUploadUrl.md)
1022
1025
  - [Get a practitioner profile](../operations/provider.getPractitioner.md)
1026
+ - [Get one practice location](../operations/provider.getPractitionerLocation.md)
1023
1027
  - [List tenant appointments](../operations/provider.listAppointments.md)
1024
1028
  - [List tenant encounters](../operations/provider.listEncounters.md)
1029
+ - [List the practitioner's practice locations](../operations/provider.listPractitionerLocations.md)
1025
1030
  - [Log in a practitioner](../operations/provider.login.md)
1026
1031
  - [Refresh practitioner access tokens](../operations/provider.refreshToken.md)
1027
1032
  - [Register a practitioner](../operations/provider.register.md)
1028
1033
  - [Start a password reset](../operations/provider.resetPassword.md)
1034
+ - [Set a practitioner's provider-portal roles (platform admin only)](../operations/provider.setPractitionerPortalRoles.md)
1029
1035
  - [Update encounter notes and assessment](../operations/provider.updateEncounterClinicalNote.md)
1030
1036
  - [Update encounter status](../operations/provider.updateEncounterStatus.md)
1031
1037
  - [Update a practitioner's phone number](../operations/provider.updatePhone.md)
1032
1038
  - [Update a practitioner profile](../operations/provider.updatePractitioner.md)
1039
+ - [Update a practice location. Omitted fields are unchanged.](../operations/provider.updatePractitionerLocation.md)
1033
1040
  - [Upload a practitioner photo](../operations/provider.uploadPhoto.md)
1034
1041
  - [Verify a practitioner's email OTP](../operations/provider.verifyEmail.md)
1042
+ - [Check the practitioner's NPI against the NPPES registry and record the result](../operations/provider.verifyPractitionerNpi.md)
1035
1043
  - [Verify a practitioner's phone OTP](../operations/provider.verifySms.md)
1036
1044
  - [GET /connect](../operations/rppg.connect.md)
1037
1045
  - [GET /connect](../operations/session.connect.md)
package/docs/index.md CHANGED
@@ -1020,26 +1020,34 @@ This directory is generated from the shared structured docs data. Do not edit ge
1020
1020
  - [Upload a person photo](operations/person.uploadPhoto.md) (`person.uploadPhoto`)
1021
1021
  - [Verify a person's email OTP](operations/person.verifyEmail.md) (`person.verifyEmail`)
1022
1022
  - [Verify a person's phone OTP](operations/person.verifySms.md) (`person.verifySms`)
1023
+ - [Record onboarding completion for the practitioner's current flow](operations/provider.completePractitionerOnboarding.md) (`provider.completePractitionerOnboarding`)
1023
1024
  - [Complete a password reset](operations/provider.confirmResetPassword.md) (`provider.confirmResetPassword`)
1024
1025
  - [Health check](operations/provider.connect.md) (`provider.connect`)
1026
+ - [Add a practice location](operations/provider.createPractitionerLocation.md) (`provider.createPractitionerLocation`)
1027
+ - [Remove a practice location](operations/provider.deletePractitionerLocation.md) (`provider.deletePractitionerLocation`)
1025
1028
  - [Get one appointment with patient demographics](operations/provider.getAppointment.md) (`provider.getAppointment`)
1026
1029
  - [Get one encounter with patient demographics](operations/provider.getEncounter.md) (`provider.getEncounter`)
1027
1030
  - [Get a patient's consolidated health record (provider tenant scope)](operations/provider.getPatientRecord.md) (`provider.getPatientRecord`)
1028
1031
  - [Get a practitioner photo](operations/provider.getPhoto.md) (`provider.getPhoto`)
1029
1032
  - [Get a presigned photo upload URL](operations/provider.getPhotoUploadUrl.md) (`provider.getPhotoUploadUrl`)
1030
1033
  - [Get a practitioner profile](operations/provider.getPractitioner.md) (`provider.getPractitioner`)
1034
+ - [Get one practice location](operations/provider.getPractitionerLocation.md) (`provider.getPractitionerLocation`)
1031
1035
  - [List tenant appointments](operations/provider.listAppointments.md) (`provider.listAppointments`)
1032
1036
  - [List tenant encounters](operations/provider.listEncounters.md) (`provider.listEncounters`)
1037
+ - [List the practitioner's practice locations](operations/provider.listPractitionerLocations.md) (`provider.listPractitionerLocations`)
1033
1038
  - [Log in a practitioner](operations/provider.login.md) (`provider.login`)
1034
1039
  - [Refresh practitioner access tokens](operations/provider.refreshToken.md) (`provider.refreshToken`)
1035
1040
  - [Register a practitioner](operations/provider.register.md) (`provider.register`)
1036
1041
  - [Start a password reset](operations/provider.resetPassword.md) (`provider.resetPassword`)
1042
+ - [Set a practitioner's provider-portal roles (platform admin only)](operations/provider.setPractitionerPortalRoles.md) (`provider.setPractitionerPortalRoles`)
1037
1043
  - [Update encounter notes and assessment](operations/provider.updateEncounterClinicalNote.md) (`provider.updateEncounterClinicalNote`)
1038
1044
  - [Update encounter status](operations/provider.updateEncounterStatus.md) (`provider.updateEncounterStatus`)
1039
1045
  - [Update a practitioner's phone number](operations/provider.updatePhone.md) (`provider.updatePhone`)
1040
1046
  - [Update a practitioner profile](operations/provider.updatePractitioner.md) (`provider.updatePractitioner`)
1047
+ - [Update a practice location. Omitted fields are unchanged.](operations/provider.updatePractitionerLocation.md) (`provider.updatePractitionerLocation`)
1041
1048
  - [Upload a practitioner photo](operations/provider.uploadPhoto.md) (`provider.uploadPhoto`)
1042
1049
  - [Verify a practitioner's email OTP](operations/provider.verifyEmail.md) (`provider.verifyEmail`)
1050
+ - [Check the practitioner's NPI against the NPPES registry and record the result](operations/provider.verifyPractitionerNpi.md) (`provider.verifyPractitionerNpi`)
1043
1051
  - [Verify a practitioner's phone OTP](operations/provider.verifySms.md) (`provider.verifySms`)
1044
1052
  - [GET /connect](operations/rppg.connect.md) (`rppg.connect`)
1045
1053
  - [GET /connect](operations/session.connect.md) (`session.connect`)
@@ -0,0 +1,15 @@
1
+ # AlcoholFrequency
2
+
3
+ Model ID: `AlcoholFrequency`
4
+
5
+ No description.
6
+
7
+ Type: `string`
8
+
9
+ ## Fields
10
+
11
+ No fields.
12
+
13
+ ## Example
14
+
15
+ None declared in canonical OpenAPI.
@@ -0,0 +1,20 @@
1
+ # AlcoholUse
2
+
3
+ Model ID: `AlcoholUse`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `binge_drinking` | `boolean|null` | No | | | | Yes | |
14
+ | `drinks_per_week` | `number|null` | No | | | | Yes | |
15
+ | `frequency` | [`AlcoholFrequency`](./AlcoholFrequency.md) | No | | | `"unknown"` | No | |
16
+ | `notes` | `string|null` | No | | | | Yes | |
17
+
18
+ ## Example
19
+
20
+ None declared in canonical OpenAPI.
@@ -0,0 +1,17 @@
1
+ # BodyHeight
2
+
3
+ Model ID: `BodyHeight`
4
+
5
+ A body height/length reading.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `value` | `number` | Yes | | | | No | cm |
14
+
15
+ ## Example
16
+
17
+ None declared in canonical OpenAPI.
@@ -0,0 +1,18 @@
1
+ # BodyTemperature
2
+
3
+ Model ID: `BodyTemperature`
4
+
5
+ A body temperature reading.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `route` | [`TemperatureRoute`](./TemperatureRoute.md) | No | | | `"oral"` | No | Body site the temperature was measured at (oral, rectal, axillary, tympanic, temporal, other). |
14
+ | `value` | `number` | Yes | | | | No | Celsius |
15
+
16
+ ## Example
17
+
18
+ None declared in canonical OpenAPI.
@@ -0,0 +1,18 @@
1
+ # BodyWeight
2
+
3
+ Model ID: `BodyWeight`
4
+
5
+ A body weight reading.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `clothed` | `boolean` | No | | | `false` | No | True if the patient was weighed with clothes on. |
14
+ | `value` | `number` | Yes | | | | No | kg |
15
+
16
+ ## Example
17
+
18
+ None declared in canonical OpenAPI.
@@ -11,6 +11,8 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `athena_appointment_id` | `string|null` | No | | | | Yes | Athena Health appointment id of the slot being booked, taken from the `athena_appointment_id` of the chosen `appointments.listSlots` result. Required on an Athena-integrated tenant, where the booking is made in Athena against this id (the request is rejected without it); ignored on a FHIR-only tenant, which books against `slot_id`. |
14
+ | `idempotency_key` | `string|null` | No | | | | Yes | Caller-created UUID v4 for one confirmed booking attempt. Reuse it with identical data on retries. Terminal results are remembered for at least 24 hours; a changed intent needs a new key. Omitting this field preserves legacy behavior without a replay guarantee. |
15
+ | `note` | `string|null` | No | | | | Yes | Optional booking note; part of the idempotent intent. |
14
16
  | `patient_id` | `string` | Yes | | | | No | FHIR Patient resource ID for whom the appointment is booked. |
15
17
  | `slot_id` | `string` | Yes | | | | No | FHIR Slot resource ID returned by `appointments.listSlots`. |
16
18
  | `start` | `string|null` | No | | | | Yes | ISO 8601 start of the chosen slot, taken from the `start` of the chosen `appointments.listSlots` result. Required on an OpenLoop- or SteadyMD-integrated tenant, neither of which books by a pre-existing slot id; ignored on an Athena-integrated or FHIR-only tenant, which book by `athena_appointment_id`/`slot_id` respectively. |
@@ -0,0 +1,19 @@
1
+ # DietCategory
2
+
3
+ Model ID: `DietCategory`
4
+
5
+ Coarse diet category, structured alongside the free-text
6
+ diet_description. Only exists so a structured answer can be mirrored
7
+ to vendors whose social-history diet question is a fixed dropdown
8
+ rather than free text (e.g. Athena) — it never replaces the narrative
9
+ diet_description, which stays the complete, patient-worded record.
10
+
11
+ Type: `string`
12
+
13
+ ## Fields
14
+
15
+ No fields.
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,15 @@
1
+ # EducationLevel
2
+
3
+ Model ID: `EducationLevel`
4
+
5
+ No description.
6
+
7
+ Type: `string`
8
+
9
+ ## Fields
10
+
11
+ No fields.
12
+
13
+ ## Example
14
+
15
+ None declared in canonical OpenAPI.
@@ -0,0 +1,15 @@
1
+ # ExerciseFrequency
2
+
3
+ Model ID: `ExerciseFrequency`
4
+
5
+ No description.
6
+
7
+ Type: `string`
8
+
9
+ ## Fields
10
+
11
+ No fields.
12
+
13
+ ## Example
14
+
15
+ None declared in canonical OpenAPI.