@healthcloudai/hc-sdk 3.17.0 → 3.18.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 (108) hide show
  1. package/dist/index.cjs +3 -0
  2. package/dist/index.d.cts +21 -0
  3. package/dist/index.d.ts +21 -0
  4. package/dist/index.js +3 -0
  5. package/docs/docs-manifest.json +71 -11
  6. package/docs/models/AlcoholFrequency.md +15 -0
  7. package/docs/models/AlcoholUse.md +20 -0
  8. package/docs/models/BodyHeight.md +17 -0
  9. package/docs/models/BodyTemperature.md +18 -0
  10. package/docs/models/BodyWeight.md +18 -0
  11. package/docs/models/BookAppointmentRequest.md +2 -0
  12. package/docs/models/DietCategory.md +19 -0
  13. package/docs/models/EducationLevel.md +15 -0
  14. package/docs/models/ExerciseFrequency.md +15 -0
  15. package/docs/models/FunctionalLevel.md +15 -0
  16. package/docs/models/FunctionalStatus.md +40 -0
  17. package/docs/models/GetPractitionerResponse.md +8 -2
  18. package/docs/models/LicenseVerification.md +19 -0
  19. package/docs/models/ListAllergiesResponse.md +1 -1
  20. package/docs/models/ListConditionsResponse.md +1 -1
  21. package/docs/models/ListDirectivesResponse.md +1 -1
  22. package/docs/models/ListFamilyHistoryResponse.md +1 -1
  23. package/docs/models/ListImmunizationsResponse.md +1 -1
  24. package/docs/models/ListProceduresResponse.md +1 -1
  25. package/docs/models/ListQuestionnaireResponsesResponse.md +1 -1
  26. package/docs/models/LivingSituation.md +15 -0
  27. package/docs/models/NpiVerification.md +21 -0
  28. package/docs/models/OnboardingProgressRequest.md +18 -0
  29. package/docs/models/PortalRole.md +18 -0
  30. package/docs/models/Practitioner.md +9 -2
  31. package/docs/models/ProviderCredential.md +19 -0
  32. package/docs/models/ProviderEducationCredential.md +6 -2
  33. package/docs/models/ProviderEncounterListResponse.md +1 -1
  34. package/docs/models/ProviderEncounterRecord.md +49 -0
  35. package/docs/models/ProviderEncounterResponse.md +1 -1
  36. package/docs/models/ProviderLanguage.md +3 -2
  37. package/docs/models/ProviderOnboardingStatus.md +19 -0
  38. package/docs/models/ProviderPatientRecordResources.md +32 -0
  39. package/docs/models/ProviderPatientRecordResponse.md +1 -1
  40. package/docs/models/ProviderPostgraduateTraining.md +22 -0
  41. package/docs/models/ProviderProfessionalLiability.md +19 -0
  42. package/docs/models/ProviderSpecialty.md +1 -1
  43. package/docs/models/ProviderStateLicense.md +9 -2
  44. package/docs/models/SexualOrientation.md +15 -0
  45. package/docs/models/SmokingStatus.md +15 -0
  46. package/docs/models/SocialHistory.md +35 -0
  47. package/docs/models/SubstanceStatus.md +15 -0
  48. package/docs/models/SubstanceUse.md +23 -0
  49. package/docs/models/TobaccoUse.md +22 -0
  50. package/docs/models/UpdateEncounterClinicalNoteResponse.md +1 -1
  51. package/docs/models/UpdateEncounterStatusResponse.md +1 -1
  52. package/docs/models/UpdatePractitionerRequest.md +5 -0
  53. package/docs/models/UpdatePractitionerResponse.md +8 -2
  54. package/docs/models/VitalsRecord.md +41 -0
  55. package/docs/models/appointments.ErrorResponse.md +1 -0
  56. package/docs/models/diagnostics.Coding.md +19 -0
  57. package/docs/models/diagnostics.LabObservation.md +1 -1
  58. package/docs/models/{AdvanceDirective.md → ehr.AdvanceDirective.md} +1 -1
  59. package/docs/models/{Allergy.md → ehr.Allergy.md} +1 -1
  60. package/docs/models/ehr.Coding.md +19 -0
  61. package/docs/models/{FamilyHistoryEntry.md → ehr.FamilyHistoryEntry.md} +1 -1
  62. package/docs/models/{Immunization.md → ehr.Immunization.md} +1 -1
  63. package/docs/models/{Problem.md → ehr.Problem.md} +1 -1
  64. package/docs/models/{Procedure.md → ehr.Procedure.md} +1 -1
  65. package/docs/models/ehr.Quantity.md +20 -0
  66. package/docs/models/{QuestionnaireResponse.md → ehr.QuestionnaireResponse.md} +2 -2
  67. package/docs/models/{ResponseAnswer.md → ehr.ResponseAnswer.md} +4 -4
  68. package/docs/models/{ResponseItem.md → ehr.ResponseItem.md} +3 -3
  69. package/docs/models/index.md +69 -9
  70. package/docs/models/provider.AdvanceDirective.md +31 -0
  71. package/docs/models/provider.Allergy.md +31 -0
  72. package/docs/models/provider.AllergyReaction.md +21 -0
  73. package/docs/models/provider.BloodPressure.md +20 -0
  74. package/docs/models/provider.CodedConcept.md +19 -0
  75. package/docs/models/provider.Coding.md +19 -0
  76. package/docs/models/provider.Dosage.md +24 -0
  77. package/docs/models/provider.Encounter.md +48 -0
  78. package/docs/models/provider.EncounterDiagnosis.md +20 -0
  79. package/docs/models/provider.EncounterHospitalization.md +22 -0
  80. package/docs/models/provider.EncounterLocation.md +21 -0
  81. package/docs/models/provider.EncounterParticipant.md +21 -0
  82. package/docs/models/provider.FamilyCondition.md +22 -0
  83. package/docs/models/provider.FamilyHistoryEntry.md +30 -0
  84. package/docs/models/provider.GynHistory.md +25 -0
  85. package/docs/models/provider.HeartRate.md +18 -0
  86. package/docs/models/provider.Immunization.md +40 -0
  87. package/docs/models/provider.ImmunizationReaction.md +20 -0
  88. package/docs/models/provider.LabObservation.md +29 -0
  89. package/docs/models/provider.Medication.md +41 -0
  90. package/docs/models/provider.PerinatalHistory.md +25 -0
  91. package/docs/models/provider.Problem.md +37 -0
  92. package/docs/models/provider.Procedure.md +37 -0
  93. package/docs/models/provider.PulseOximetry.md +20 -0
  94. package/docs/models/provider.Quantity.md +20 -0
  95. package/docs/models/provider.QuestionnaireResponse.md +27 -0
  96. package/docs/models/provider.ReferenceRange.md +20 -0
  97. package/docs/models/provider.ResponseAnswer.md +27 -0
  98. package/docs/models/provider.ResponseItem.md +21 -0
  99. package/docs/operations/appointments.book.md +34 -1
  100. package/docs/operations/provider.getEncounter.md +84 -1
  101. package/docs/operations/provider.getPatientRecord.md +516 -1
  102. package/docs/operations/provider.getPractitioner.md +92 -53
  103. package/docs/operations/provider.listEncounters.md +84 -1
  104. package/docs/operations/provider.register.md +25 -3
  105. package/docs/operations/provider.updateEncounterClinicalNote.md +84 -1
  106. package/docs/operations/provider.updateEncounterStatus.md +84 -1
  107. package/docs/operations/provider.updatePractitioner.md +256 -150
  108. package/package.json +1 -1
package/dist/index.cjs CHANGED
@@ -361,6 +361,9 @@ var AppointmentsClient = class extends BaseServiceClient {
361
361
  /**
362
362
  * Book an appointment for a specific slot.
363
363
  * POST /appointments/book
364
+ * Pass one caller-created idempotency_key per confirmed attempt and reuse
365
+ * it unchanged on retries. Completed results are remembered for at least
366
+ * 24 hours. This method never generates a replacement key.
364
367
  *
365
368
  * On an Athena-integrated tenant the booking is made in Athena only — no
366
369
  * local FHIR Appointment is written — and `athena_appointment_id` is
package/dist/index.d.cts CHANGED
@@ -1917,6 +1917,18 @@ interface BookAppointmentRequest {
1917
1917
  * @memberof BookAppointmentRequest
1918
1918
  */
1919
1919
  athena_appointment_id?: string | null;
1920
+ /**
1921
+ * 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.
1922
+ * @type {string}
1923
+ * @memberof BookAppointmentRequest
1924
+ */
1925
+ idempotency_key?: string | null;
1926
+ /**
1927
+ * Optional booking note; part of the idempotent intent.
1928
+ * @type {string}
1929
+ * @memberof BookAppointmentRequest
1930
+ */
1931
+ note?: string | null;
1920
1932
  /**
1921
1933
  * FHIR Patient resource ID for whom the appointment is booked.
1922
1934
  * @type {string}
@@ -36946,6 +36958,9 @@ declare class AppointmentsClient extends BaseServiceClient {
36946
36958
  /**
36947
36959
  * Book an appointment for a specific slot.
36948
36960
  * POST /appointments/book
36961
+ * Pass one caller-created idempotency_key per confirmed attempt and reuse
36962
+ * it unchanged on retries. Completed results are remembered for at least
36963
+ * 24 hours. This method never generates a replacement key.
36949
36964
  *
36950
36965
  * On an Athena-integrated tenant the booking is made in Athena only — no
36951
36966
  * local FHIR Appointment is written — and `athena_appointment_id` is
@@ -45396,6 +45411,12 @@ declare function CreateScheduleRequestToJSONTyped(value?: CreateScheduleRequest
45396
45411
  * @interface ErrorResponse
45397
45412
  */
45398
45413
  interface ErrorResponse$6 {
45414
+ /**
45415
+ * Machine-readable booking coordination error code, when applicable.
45416
+ * @type {string}
45417
+ * @memberof ErrorResponse
45418
+ */
45419
+ code?: string | null;
45399
45420
  /**
45400
45421
  * Human-readable explanation of why the request failed.
45401
45422
  * @type {string}
package/dist/index.d.ts CHANGED
@@ -1917,6 +1917,18 @@ interface BookAppointmentRequest {
1917
1917
  * @memberof BookAppointmentRequest
1918
1918
  */
1919
1919
  athena_appointment_id?: string | null;
1920
+ /**
1921
+ * 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.
1922
+ * @type {string}
1923
+ * @memberof BookAppointmentRequest
1924
+ */
1925
+ idempotency_key?: string | null;
1926
+ /**
1927
+ * Optional booking note; part of the idempotent intent.
1928
+ * @type {string}
1929
+ * @memberof BookAppointmentRequest
1930
+ */
1931
+ note?: string | null;
1920
1932
  /**
1921
1933
  * FHIR Patient resource ID for whom the appointment is booked.
1922
1934
  * @type {string}
@@ -36946,6 +36958,9 @@ declare class AppointmentsClient extends BaseServiceClient {
36946
36958
  /**
36947
36959
  * Book an appointment for a specific slot.
36948
36960
  * POST /appointments/book
36961
+ * Pass one caller-created idempotency_key per confirmed attempt and reuse
36962
+ * it unchanged on retries. Completed results are remembered for at least
36963
+ * 24 hours. This method never generates a replacement key.
36949
36964
  *
36950
36965
  * On an Athena-integrated tenant the booking is made in Athena only — no
36951
36966
  * local FHIR Appointment is written — and `athena_appointment_id` is
@@ -45396,6 +45411,12 @@ declare function CreateScheduleRequestToJSONTyped(value?: CreateScheduleRequest
45396
45411
  * @interface ErrorResponse
45397
45412
  */
45398
45413
  interface ErrorResponse$6 {
45414
+ /**
45415
+ * Machine-readable booking coordination error code, when applicable.
45416
+ * @type {string}
45417
+ * @memberof ErrorResponse
45418
+ */
45419
+ code?: string | null;
45399
45420
  /**
45400
45421
  * Human-readable explanation of why the request failed.
45401
45422
  * @type {string}
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
@@ -1,5 +1,5 @@
1
1
  {
2
- "docsDataContentDigest": "sha256:2ba44dd2c8b7bc55e158e775cdc5f5f05ef0958ffa56ebf972ceca92449f4db3",
2
+ "docsDataContentDigest": "sha256:269502c48f63e46dd73a8a70df150352b262718fc42a4f79362be6ba182b7170",
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,7 @@
1253
1260
  "models/ListTestOrdersResponse.md",
1254
1261
  "models/ListVectorCollectionsResponse.md",
1255
1262
  "models/ListVitalsResponse.md",
1263
+ "models/LivingSituation.md",
1256
1264
  "models/LocationStatus.md",
1257
1265
  "models/MaritalStatus.md",
1258
1266
  "models/McpFieldagentRequest.md",
@@ -1281,6 +1289,7 @@
1281
1289
  "models/NearestLocationsResponse.md",
1282
1290
  "models/NotificationResponse.md",
1283
1291
  "models/NotificationUpsertRequest.md",
1292
+ "models/NpiVerification.md",
1284
1293
  "models/NppesGetProviderRequest.md",
1285
1294
  "models/NppesSearchProvidersRequest.md",
1286
1295
  "models/NppesSearchProvidersResponse.md",
@@ -1303,6 +1312,7 @@
1303
1312
  "models/OnboardQuestionnaireStepResult.md",
1304
1313
  "models/OnboardVitalsPayload.md",
1305
1314
  "models/OnboardVitalsStepResult.md",
1315
+ "models/OnboardingProgressRequest.md",
1306
1316
  "models/OpenAIBuildResponseCreatePayloadRequest.md",
1307
1317
  "models/OpenAIBuildResponseCreatePayloadResponse.md",
1308
1318
  "models/OpenAIChatJsonRequest.md",
@@ -1386,17 +1396,16 @@
1386
1396
  "models/PlaidListIdentityVerificationsRequest.md",
1387
1397
  "models/PlaidListIdentityVerificationsResponse.md",
1388
1398
  "models/PolicyDocument.md",
1399
+ "models/PortalRole.md",
1389
1400
  "models/PositionCode.md",
1390
1401
  "models/Practitioner.md",
1391
1402
  "models/PreferredPharmacy.md",
1392
1403
  "models/PresenceRecord.md",
1393
1404
  "models/PresenceStatus.md",
1394
- "models/Problem.md",
1395
1405
  "models/ProblemCategory.md",
1396
1406
  "models/ProblemClinicalStatus.md",
1397
1407
  "models/ProblemSeverity.md",
1398
1408
  "models/ProblemVerificationStatus.md",
1399
- "models/Procedure.md",
1400
1409
  "models/ProcedureLaterality.md",
1401
1410
  "models/ProcedureStatus.md",
1402
1411
  "models/ProviderAcceptedInsurance.md",
@@ -1404,17 +1413,23 @@
1404
1413
  "models/ProviderAppointmentResponse.md",
1405
1414
  "models/ProviderAppointmentsResponse.md",
1406
1415
  "models/ProviderContactPoint.md",
1416
+ "models/ProviderCredential.md",
1407
1417
  "models/ProviderEducationCredential.md",
1408
1418
  "models/ProviderEncounterListResponse.md",
1419
+ "models/ProviderEncounterRecord.md",
1409
1420
  "models/ProviderEncounterResponse.md",
1410
1421
  "models/ProviderGender.md",
1411
1422
  "models/ProviderIdentifier.md",
1412
1423
  "models/ProviderIdentifierType.md",
1413
1424
  "models/ProviderLanguage.md",
1425
+ "models/ProviderOnboardingStatus.md",
1414
1426
  "models/ProviderPatientAddress.md",
1415
1427
  "models/ProviderPatientPhone.md",
1428
+ "models/ProviderPatientRecordResources.md",
1416
1429
  "models/ProviderPatientRecordResponse.md",
1417
1430
  "models/ProviderPatientSummary.md",
1431
+ "models/ProviderPostgraduateTraining.md",
1432
+ "models/ProviderProfessionalLiability.md",
1418
1433
  "models/ProviderRole.md",
1419
1434
  "models/ProviderSearchRequest.md",
1420
1435
  "models/ProviderSearchResponse.md",
@@ -1467,7 +1482,6 @@
1467
1482
  "models/QuestSyncCompendiumsRequest.md",
1468
1483
  "models/QuestionItemType.md",
1469
1484
  "models/QuestionnaireItemInput.md",
1470
- "models/QuestionnaireResponse.md",
1471
1485
  "models/QuestionnaireResponseStatus.md",
1472
1486
  "models/Race.md",
1473
1487
  "models/RapidTestResult.md",
@@ -1478,8 +1492,6 @@
1478
1492
  "models/ReplaceInsuranceResponse.md",
1479
1493
  "models/RescheduleAppointmentRequest.md",
1480
1494
  "models/RespiratoryRate.md",
1481
- "models/ResponseAnswer.md",
1482
- "models/ResponseItem.md",
1483
1495
  "models/RetireInsuranceRequest.md",
1484
1496
  "models/RetireInsuranceResponse.md",
1485
1497
  "models/SalesforceAccount.md",
@@ -1671,8 +1683,11 @@
1671
1683
  "models/SetPreferredPharmacyRequest.md",
1672
1684
  "models/SetPreferredPharmacyResponse.md",
1673
1685
  "models/SexAtBirth.md",
1686
+ "models/SexualOrientation.md",
1674
1687
  "models/Slot.md",
1675
1688
  "models/SlotStatus.md",
1689
+ "models/SmokingStatus.md",
1690
+ "models/SocialHistory.md",
1676
1691
  "models/Specimen.md",
1677
1692
  "models/SpecimenStatus.md",
1678
1693
  "models/SpecimenType.md",
@@ -1784,9 +1799,12 @@
1784
1799
  "models/SubmitCurrentSymptomsScreeningsCurrentSymptomsResponse.md",
1785
1800
  "models/SubmitSummaryRequest.md",
1786
1801
  "models/SubscriberRelationship.md",
1802
+ "models/SubstanceStatus.md",
1803
+ "models/SubstanceUse.md",
1787
1804
  "models/TelehealthToken.md",
1788
1805
  "models/TemperatureRoute.md",
1789
1806
  "models/TestOrder.md",
1807
+ "models/TobaccoUse.md",
1790
1808
  "models/TwilioGetMessageRequest.md",
1791
1809
  "models/TwilioListMessagesRequest.md",
1792
1810
  "models/TwilioListMessagesResponse.md",
@@ -1851,6 +1869,7 @@
1851
1869
  "models/VisionFaceCompareRequest.md",
1852
1870
  "models/VisionFaceCompareResponse.md",
1853
1871
  "models/VitalReading.md",
1872
+ "models/VitalsRecord.md",
1854
1873
  "models/VitalsRecordRequest.md",
1855
1874
  "models/VitalsStatus.md",
1856
1875
  "models/WhoopActivityIdMappingResponse.md",
@@ -1989,19 +2008,31 @@
1989
2008
  "models/appointments.ErrorResponse.md",
1990
2009
  "models/connectors.ImportVitalsRequest.md",
1991
2010
  "models/connectors.JsonValue.md",
2011
+ "models/diagnostics.Coding.md",
1992
2012
  "models/diagnostics.ConnectResponse.md",
1993
2013
  "models/diagnostics.ErrorResponse.md",
1994
2014
  "models/diagnostics.LabObservation.md",
1995
2015
  "models/diagnostics.ListDiagnosticsResponse.md",
1996
2016
  "models/diagnostics.ReferenceRange.md",
2017
+ "models/ehr.AdvanceDirective.md",
2018
+ "models/ehr.Allergy.md",
1997
2019
  "models/ehr.AllergyReaction.md",
1998
2020
  "models/ehr.CodedConcept.md",
2021
+ "models/ehr.Coding.md",
1999
2022
  "models/ehr.ConnectResponse.md",
2000
2023
  "models/ehr.FamilyCondition.md",
2024
+ "models/ehr.FamilyHistoryEntry.md",
2025
+ "models/ehr.Immunization.md",
2001
2026
  "models/ehr.ImmunizationReaction.md",
2002
2027
  "models/ehr.ListDiagnosticsResponse.md",
2003
2028
  "models/ehr.ListEncountersResponse.md",
2004
2029
  "models/ehr.ListMedicationsResponse.md",
2030
+ "models/ehr.Problem.md",
2031
+ "models/ehr.Procedure.md",
2032
+ "models/ehr.Quantity.md",
2033
+ "models/ehr.QuestionnaireResponse.md",
2034
+ "models/ehr.ResponseAnswer.md",
2035
+ "models/ehr.ResponseItem.md",
2005
2036
  "models/fieldagent.ConfirmResetPasswordRequest.md",
2006
2037
  "models/fieldagent.ConfirmResetPasswordResponse.md",
2007
2038
  "models/fieldagent.ConnectResponse.md",
@@ -2083,20 +2114,49 @@
2083
2114
  "models/person.VerifyEmailResponse.md",
2084
2115
  "models/person.VerifySmsRequest.md",
2085
2116
  "models/person.VerifySmsResponse.md",
2117
+ "models/provider.AdvanceDirective.md",
2118
+ "models/provider.Allergy.md",
2119
+ "models/provider.AllergyReaction.md",
2120
+ "models/provider.BloodPressure.md",
2121
+ "models/provider.CodedConcept.md",
2122
+ "models/provider.Coding.md",
2086
2123
  "models/provider.ConfirmResetPasswordRequest.md",
2087
2124
  "models/provider.ConfirmResetPasswordResponse.md",
2088
2125
  "models/provider.ConnectResponse.md",
2126
+ "models/provider.Dosage.md",
2127
+ "models/provider.Encounter.md",
2128
+ "models/provider.EncounterDiagnosis.md",
2129
+ "models/provider.EncounterHospitalization.md",
2130
+ "models/provider.EncounterLocation.md",
2131
+ "models/provider.EncounterParticipant.md",
2089
2132
  "models/provider.ErrorResponse.md",
2133
+ "models/provider.FamilyCondition.md",
2134
+ "models/provider.FamilyHistoryEntry.md",
2090
2135
  "models/provider.GetPhotoResponse.md",
2091
2136
  "models/provider.GetPhotoUploadUrlResponse.md",
2137
+ "models/provider.GynHistory.md",
2138
+ "models/provider.HeartRate.md",
2139
+ "models/provider.Immunization.md",
2140
+ "models/provider.ImmunizationReaction.md",
2141
+ "models/provider.LabObservation.md",
2092
2142
  "models/provider.LoginRequest.md",
2093
2143
  "models/provider.LoginResponse.md",
2144
+ "models/provider.Medication.md",
2145
+ "models/provider.PerinatalHistory.md",
2146
+ "models/provider.Problem.md",
2147
+ "models/provider.Procedure.md",
2148
+ "models/provider.PulseOximetry.md",
2149
+ "models/provider.Quantity.md",
2150
+ "models/provider.QuestionnaireResponse.md",
2151
+ "models/provider.ReferenceRange.md",
2094
2152
  "models/provider.RefreshTokenRequest.md",
2095
2153
  "models/provider.RefreshTokenResponse.md",
2096
2154
  "models/provider.RegisterRequest.md",
2097
2155
  "models/provider.RegisterResponse.md",
2098
2156
  "models/provider.ResetPasswordRequest.md",
2099
2157
  "models/provider.ResetPasswordResponse.md",
2158
+ "models/provider.ResponseAnswer.md",
2159
+ "models/provider.ResponseItem.md",
2100
2160
  "models/provider.UpdatePhoneRequest.md",
2101
2161
  "models/provider.UpdatePhoneResponse.md",
2102
2162
  "models/provider.UploadPhotoRequest.md",
@@ -3152,7 +3212,7 @@
3152
3212
  "operations/vitals.recordVitals.md"
3153
3213
  ],
3154
3214
  "language": "nodejs",
3155
- "modelCount": 2055,
3215
+ "modelCount": 2115,
3156
3216
  "operationCount": 1040,
3157
3217
  "schemaVersion": 1
3158
3218
  }
@@ -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.
@@ -0,0 +1,15 @@
1
+ # FunctionalLevel
2
+
3
+ Model ID: `FunctionalLevel`
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,40 @@
1
+ # FunctionalStatus
2
+
3
+ Model ID: `FunctionalStatus`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `ambulation` | `string|null` | No | | | | Yes | |
14
+ | `assessed_by` | `string|null` | No | | | | Yes | |
15
+ | `assessed_date` | `string|null` | No | | | | Yes | |
16
+ | `assistive_devices` | `array` | No | | | | No | |
17
+ | `bathing` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
18
+ | `cognitive_status` | `string|null` | No | | | | Yes | |
19
+ | `continence` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
20
+ | `dressing` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
21
+ | `fall_count_past_year` | `integer|null` | No | | | | Yes | |
22
+ | `fall_risk` | `string|null` | No | | | | Yes | |
23
+ | `feeding` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
24
+ | `financial_management` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
25
+ | `housekeeping` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
26
+ | `laundry` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
27
+ | `meal_preparation` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
28
+ | `medication_management` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
29
+ | `mmse_score` | `integer|null` | No | | | | Yes | |
30
+ | `moca_score` | `integer|null` | No | | | | Yes | |
31
+ | `notes` | `string|null` | No | | | | Yes | |
32
+ | `shopping` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
33
+ | `telephone_use` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
34
+ | `toileting` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
35
+ | `transferring` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
36
+ | `transportation` | [`FunctionalLevel`](./FunctionalLevel.md) | No | | | `"not_assessed"` | No | |
37
+
38
+ ## Example
39
+
40
+ None declared in canonical OpenAPI.
@@ -16,10 +16,10 @@ Type: `object`
16
16
  | `birth_date` | `string|null` | No | | | | Yes | ISO 8601 date of birth, optional. |
17
17
  | `board_certifications` | `array` | No | | | | No | Board certification names, optional. |
18
18
  | `credential` | `string|null` | No | | | | Yes | MD, DO, NP, PA, RN, etc. |
19
+ | `credentials` | array of [`ProviderCredential`](./ProviderCredential.md) | No | | | | No | Professional credentials. At most one primary. |
19
20
  | `department` | `string|null` | No | | | | Yes | Department within the organization, optional. |
20
21
  | `education_credentials` | array of [`ProviderEducationCredential`](./ProviderEducationCredential.md) | No | | | | No | Degrees and education credentials held by this practitioner. |
21
22
  | `email` | `string|null` | No | | | | Yes | Email address, optional. |
22
- | `fhir_id` | `string|null` | No | | | | Yes | FHIR Practitioner resource ID; set once the record has been persisted. |
23
23
  | `first_name` | `string` | Yes | | | | No | Given name. |
24
24
  | `gender` | [`ProviderGender`](./ProviderGender.md) | No | | | `"unknown"` | No | Administrative gender. |
25
25
  | `graduation_year` | `integer|null` | No | | | | Yes | Graduation year, optional. |
@@ -31,11 +31,17 @@ Type: `object`
31
31
  | `middle_name` | `string|null` | No | | | | Yes | Middle name, optional. |
32
32
  | `notes` | `string|null` | No | | | | Yes | Free-text internal notes, optional. |
33
33
  | `npi` | `string|null` | No | | | | Yes | 10-digit NPI |
34
+ | `npi_verification` | [`NpiVerification`](./NpiVerification.md) | No | | | | No | NPI registry check. Server-written. |
35
+ | `onboarding` | [`ProviderOnboardingStatus`](./ProviderOnboardingStatus.md) | No | | | | No | Onboarding progress. |
34
36
  | `organization_id` | `string|null` | No | | | | Yes | Identifier of the affiliated organization, optional. |
35
37
  | `organization_name` | `string|null` | No | | | | Yes | Display name of the affiliated organization, optional. |
36
38
  | `photo_binary_id` | `string|null` | No | | | | Yes | FHIR Binary resource ID of this practitioner's stored photo, when one has been uploaded via provider.uploadPhoto. Pass to provider.getPhoto as ?binary_id=, or omit it there — it is auto-discovered. |
37
- | `practitioner_id` | `string` | No | uuid | | | No | Internal identifier generated at construction time; the FHIR resource id (fhir_id) is the one used on the wire as {practitioner_id}. |
39
+ | `portal_roles` | array of [`PortalRole`](./PortalRole.md) | No | | | | No | Provider-portal access roles, assigned by the platform. Not writable through profile updates. |
40
+ | `postgraduate_training` | array of [`ProviderPostgraduateTraining`](./ProviderPostgraduateTraining.md) | No | | | | No | Residency and fellowship training. |
41
+ | `practitioner_id` | `string` | No | | | | No | Practitioner identifier used in API paths. Equals the stored resource id once persisted. |
38
42
  | `prefix` | `string|null` | No | | | | Yes | Name prefix, e.g. 'Dr.'. |
43
+ | `professional_display_name` | `string|null` | No | | | | Yes | Patient-facing name, e.g. 'Dr. Elena Chen'. |
44
+ | `professional_liability` | [`ProviderProfessionalLiability`](./ProviderProfessionalLiability.md) | No | | | | Yes | Professional liability coverage. |
39
45
  | `race` | array of [`Race`](./Race.md) | No | | | | No | One or more race values, optional. |
40
46
  | `roles` | array of [`ProviderRole`](./ProviderRole.md) | No | | | | No | NUCC provider taxonomy high-level categories this practitioner practices under. |
41
47
  | `specialty` | array of [`ProviderSpecialty`](./ProviderSpecialty.md) | No | | | | No | Clinical specialties, coded to a taxonomy system (NUCC by default). Sent/received on the wire as 'specialty'. |
@@ -0,0 +1,19 @@
1
+ # LicenseVerification
2
+
3
+ Model ID: `LicenseVerification`
4
+
5
+ How a license was verified. Stays self-attested until a state-board check records otherwise.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `source` | `string|null` | No | | | | Yes | Verification source, e.g. a state board. |
14
+ | `status` | `string` | No | | self-attested, verified, failed | `"self-attested"` | No | Verification state. |
15
+ | `verified_at` | `string|null` | No | | | | Yes | When the verification was recorded. |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.