@healthcloudai/hc-sdk 2.4.1 → 2.5.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 (1184) hide show
  1. package/dist/index.cjs +28 -0
  2. package/dist/index.d.cts +2805 -2184
  3. package/dist/index.d.ts +2805 -2184
  4. package/dist/index.js +28 -0
  5. package/docs/clients/AuthClient.md +1 -0
  6. package/docs/clients/DiagnosticsClient.md +6 -6
  7. package/docs/clients/EhrClient.md +1 -1
  8. package/docs/clients/FieldAgentClient.md +19 -18
  9. package/docs/clients/GraphClient.md +26 -26
  10. package/docs/clients/ProviderClient.md +13 -13
  11. package/docs/clients/TelehealthClient.md +3 -3
  12. package/docs/clients/VitalsClient.md +3 -3
  13. package/docs/docs-manifest.json +22 -22
  14. package/docs/examples/index.md +72 -70
  15. package/docs/index.md +72 -70
  16. package/docs/models/ActivitySummary.md +5 -5
  17. package/docs/models/AddDependentRequest.md +1 -8
  18. package/docs/models/AddDependentResponse.md +1 -9
  19. package/docs/models/AddInsuranceRequest.md +1 -9
  20. package/docs/models/AddInsuranceResponse.md +1 -7
  21. package/docs/models/AgentDashboardResponse.md +46 -0
  22. package/docs/models/Appointment.md +1 -17
  23. package/docs/models/AssistantClassifyRequest.md +1 -5
  24. package/docs/models/AssistantClassifyResponse.md +1 -5
  25. package/docs/models/BloodPressureVital.md +1 -1
  26. package/docs/models/BodyWeightVital.md +1 -1
  27. package/docs/models/BookAppointmentRequest.md +1 -6
  28. package/docs/models/CheckEligibilityRequest.md +1 -11
  29. package/docs/models/CreateChannelResponse.md +4 -4
  30. package/docs/models/CreatePatientTokenRequest.md +3 -3
  31. package/docs/models/CreateProviderTokenRequest.md +3 -3
  32. package/docs/models/CreateQuestionnaireRequest.md +1 -8
  33. package/docs/models/CreateRapidTestRequest.md +10 -10
  34. package/docs/models/CreateSlotRequest.md +1 -14
  35. package/docs/models/CypherQueryResponse.md +3 -3
  36. package/docs/models/DashboardCounts.md +6 -4
  37. package/docs/models/DeleteActivityResponse.md +1 -5
  38. package/docs/models/DeleteDependentResponse.md +1 -5
  39. package/docs/models/DeleteNotificationResponse.md +1 -5
  40. package/docs/models/DependentResponse.md +1 -9
  41. package/docs/models/DiagnosticTestRelationship.md +5 -5
  42. package/docs/models/DocumentSummary.md +6 -6
  43. package/docs/models/DocumentSummarySearchRequest.md +2 -2
  44. package/docs/models/DocumentSummarySearchResponse.md +3 -3
  45. package/docs/models/FieldAgentProfileResponse.md +7 -2
  46. package/docs/models/GS1LookupResponse.md +4 -4
  47. package/docs/models/GS1ParsedData.md +4 -4
  48. package/docs/models/GetAgentPhotoResponse.md +3 -3
  49. package/docs/models/GetDiagnosticAnalyteResponse.md +3 -3
  50. package/docs/models/GetDiagnosticTestResponse.md +2 -2
  51. package/docs/models/GetDiagnosticTestSystemResponse.md +3 -3
  52. package/docs/models/GetInsuranceResponse.md +1 -1
  53. package/docs/models/GetPatientPhotoResponse.md +3 -3
  54. package/docs/models/GetPatientResponse.md +1 -1
  55. package/docs/models/GetPractitionerResponse.md +32 -31
  56. package/docs/models/GetScanUploadUrlRequest.md +4 -4
  57. package/docs/models/GetVitalsResponse.md +27 -23
  58. package/docs/models/GlucoseReading.md +2 -2
  59. package/docs/models/HeadCircumference.md +1 -1
  60. package/docs/models/HealthPlanSearchRequest.md +2 -2
  61. package/docs/models/HealthPlanSearchResponse.md +3 -3
  62. package/docs/models/HealthPlanSummary.md +6 -6
  63. package/docs/models/{patient.Insurance.md → Insurance.md} +1 -1
  64. package/docs/models/IntraocularPressure.md +1 -1
  65. package/docs/models/ListPatientsResponse.md +8 -6
  66. package/docs/models/MeasurementDevice.md +1 -1
  67. package/docs/models/MedicalConceptSearchRequest.md +2 -2
  68. package/docs/models/MedicalConceptSearchResponse.md +3 -3
  69. package/docs/models/OnboardEncounterPayload.md +19 -19
  70. package/docs/models/OnboardEncounterStepResult.md +4 -3
  71. package/docs/models/OnboardPatientPayload.md +6 -6
  72. package/docs/models/OnboardPatientResponse.md +6 -4
  73. package/docs/models/OnboardPatientStepResult.md +14 -8
  74. package/docs/models/OnboardQuestionnaireAnswer.md +4 -4
  75. package/docs/models/OnboardQuestionnaireDefinition.md +4 -4
  76. package/docs/models/OnboardQuestionnairePayload.md +3 -3
  77. package/docs/models/OnboardQuestionnaireResponseItem.md +2 -2
  78. package/docs/models/OnboardQuestionnaireStepResult.md +1 -1
  79. package/docs/models/OnboardVitalsPayload.md +2 -2
  80. package/docs/models/OnboardVitalsStepResult.md +4 -3
  81. package/docs/models/PainScale.md +1 -1
  82. package/docs/models/PainScore.md +4 -4
  83. package/docs/models/PanelResult.md +8 -8
  84. package/docs/models/PeakFlowReading.md +2 -2
  85. package/docs/models/PositionCode.md +1 -1
  86. package/docs/models/Practitioner.md +29 -29
  87. package/docs/models/ProviderAcceptedInsurance.md +2 -2
  88. package/docs/models/ProviderContactPoint.md +3 -3
  89. package/docs/models/ProviderEducationCredential.md +3 -3
  90. package/docs/models/ProviderGender.md +1 -1
  91. package/docs/models/ProviderIdentifier.md +4 -4
  92. package/docs/models/ProviderLanguage.md +2 -2
  93. package/docs/models/ProviderSearchRequest.md +2 -2
  94. package/docs/models/ProviderSearchResponse.md +3 -3
  95. package/docs/models/ProviderSpecialty.md +5 -5
  96. package/docs/models/ProviderStateLicense.md +3 -3
  97. package/docs/models/ProviderSummary.md +7 -7
  98. package/docs/models/PulseOximetryVital.md +1 -1
  99. package/docs/models/RapidTest.md +17 -16
  100. package/docs/models/RecordVitalsResponse.md +3 -3
  101. package/docs/models/RescheduleAppointmentRequest.md +1 -5
  102. package/docs/models/RespiratoryRate.md +1 -1
  103. package/docs/models/ScanUploadResponse.md +5 -5
  104. package/docs/models/SearchDiagnosticTestsResponse.md +5 -5
  105. package/docs/models/SearchDocumentSummariesCypherRequest.md +3 -3
  106. package/docs/models/SearchDocumentSummariesRequest.md +2 -2
  107. package/docs/models/SearchHealthPlansCypherRequest.md +3 -3
  108. package/docs/models/SearchHealthPlansRequest.md +2 -2
  109. package/docs/models/SearchMedicalConceptsCypherRequest.md +3 -3
  110. package/docs/models/SearchMedicalConceptsGetResponse.md +3 -3
  111. package/docs/models/SearchMedicalConceptsRequest.md +2 -2
  112. package/docs/models/SearchProvidersCypherRequest.md +3 -3
  113. package/docs/models/SearchProvidersRequest.md +2 -2
  114. package/docs/models/SingleTestResultResponse.md +13 -12
  115. package/docs/models/Slot.md +1 -12
  116. package/docs/models/StandardErrorResponse.md +18 -0
  117. package/docs/models/TelehealthToken.md +23 -0
  118. package/docs/models/TemperatureRoute.md +1 -1
  119. package/docs/models/UpdateAddressResponse.md +1 -5
  120. package/docs/models/UpdateAgentRequest.md +11 -10
  121. package/docs/models/UpdateDemographicsResponse.md +1 -5
  122. package/docs/models/UpdatePersonRequest.md +1 -6
  123. package/docs/models/UpdatePractitionerRequest.md +40 -28
  124. package/docs/models/UpdatePractitionerResponse.md +36 -3
  125. package/docs/models/UpdateRaceResponse.md +1 -5
  126. package/docs/models/UploadAgentPhotoRequest.md +3 -3
  127. package/docs/models/UploadAgentPhotoResponse.md +2 -2
  128. package/docs/models/UploadPatientPhotoRequest.md +3 -3
  129. package/docs/models/UploadPatientPhotoResponse.md +2 -2
  130. package/docs/models/VerifyOtpResponse.md +17 -0
  131. package/docs/models/VitalsRecordRequest.md +22 -16
  132. package/docs/models/VitalsStatus.md +1 -1
  133. package/docs/models/diagnostics.ErrorResponse.md +17 -0
  134. package/docs/models/diagnostics.LabObservation.md +29 -0
  135. package/docs/models/diagnostics.ListDiagnosticsResponse.md +5 -4
  136. package/docs/models/diagnostics.ReferenceRange.md +20 -0
  137. package/docs/models/fieldagent.ConfirmResetPasswordRequest.md +7 -6
  138. package/docs/models/fieldagent.ConfirmResetPasswordResponse.md +3 -3
  139. package/docs/models/fieldagent.ErrorResponse.md +2 -2
  140. package/docs/models/fieldagent.ListEncountersResponse.md +8 -6
  141. package/docs/models/fieldagent.LoginRequest.md +5 -5
  142. package/docs/models/fieldagent.LoginResponse.md +12 -7
  143. package/docs/models/fieldagent.PatientDemographics.md +2 -1
  144. package/docs/models/fieldagent.PhotoUploadUrlResponse.md +19 -0
  145. package/docs/models/fieldagent.RefreshTokenRequest.md +18 -0
  146. package/docs/models/fieldagent.RefreshTokenResponse.md +21 -0
  147. package/docs/models/fieldagent.RegisterRequest.md +19 -17
  148. package/docs/models/fieldagent.RegisterResponse.md +13 -9
  149. package/docs/models/fieldagent.ResetPasswordRequest.md +6 -4
  150. package/docs/models/fieldagent.ResetPasswordResponse.md +4 -4
  151. package/docs/models/fieldagent.VerifyEmailRequest.md +5 -5
  152. package/docs/models/fieldagent.VerifySmsRequest.md +5 -3
  153. package/docs/models/graph.ErrorResponse.md +17 -0
  154. package/docs/models/graph.JsonValue.md +1 -1
  155. package/docs/models/index.md +39 -41
  156. package/docs/models/patient.ConfirmResetPasswordResponse.md +1 -5
  157. package/docs/models/patient.ErrorResponse.md +1 -5
  158. package/docs/models/patient.LoginResponse.md +3 -10
  159. package/docs/models/patient.PatientDemographics.md +1 -1
  160. package/docs/models/{PhotoUploadUrlResponse.md → patient.PhotoUploadUrlResponse.md} +1 -1
  161. package/docs/models/patient.RefreshTokenRequest.md +18 -0
  162. package/docs/models/patient.RefreshTokenResponse.md +21 -0
  163. package/docs/models/patient.RegisterResponse.md +1 -9
  164. package/docs/models/patient.ResendVerificationCodeResponse.md +1 -5
  165. package/docs/models/patient.ResetPasswordResponse.md +1 -5
  166. package/docs/models/patient.UpdatePhoneResponse.md +1 -5
  167. package/docs/models/patient.VerifyEmailResponse.md +1 -5
  168. package/docs/models/patient.VerifySmsResponse.md +1 -5
  169. package/docs/models/person.ConfirmResetPasswordRequest.md +1 -8
  170. package/docs/models/person.ConfirmResetPasswordResponse.md +1 -5
  171. package/docs/models/person.ErrorResponse.md +1 -5
  172. package/docs/models/person.GetPhotoResponse.md +1 -7
  173. package/docs/models/person.GetPhotoUploadUrlResponse.md +1 -7
  174. package/docs/models/person.LoginRequest.md +1 -7
  175. package/docs/models/person.LoginResponse.md +1 -10
  176. package/docs/models/person.RegisterRequest.md +1 -11
  177. package/docs/models/person.RegisterResponse.md +1 -9
  178. package/docs/models/person.ResetPasswordRequest.md +1 -6
  179. package/docs/models/person.ResetPasswordResponse.md +1 -5
  180. package/docs/models/person.UpdatePhoneRequest.md +1 -5
  181. package/docs/models/person.UpdatePhoneResponse.md +1 -5
  182. package/docs/models/person.UploadPhotoRequest.md +1 -6
  183. package/docs/models/person.UploadPhotoResponse.md +1 -6
  184. package/docs/models/person.VerifyEmailRequest.md +1 -7
  185. package/docs/models/person.VerifyEmailResponse.md +1 -5
  186. package/docs/models/person.VerifySmsRequest.md +1 -5
  187. package/docs/models/person.VerifySmsResponse.md +1 -5
  188. package/docs/models/provider.ConfirmResetPasswordRequest.md +7 -6
  189. package/docs/models/provider.ConfirmResetPasswordResponse.md +3 -3
  190. package/docs/models/provider.ErrorResponse.md +17 -0
  191. package/docs/models/provider.GetPhotoResponse.md +8 -4
  192. package/docs/models/provider.GetPhotoUploadUrlResponse.md +4 -4
  193. package/docs/models/provider.LoginRequest.md +6 -5
  194. package/docs/models/provider.LoginResponse.md +12 -7
  195. package/docs/models/provider.RegisterResponse.md +12 -8
  196. package/docs/models/provider.ResetPasswordRequest.md +6 -4
  197. package/docs/models/provider.ResetPasswordResponse.md +3 -3
  198. package/docs/models/provider.UpdatePhoneRequest.md +3 -3
  199. package/docs/models/provider.UpdatePhoneResponse.md +6 -3
  200. package/docs/models/provider.UploadPhotoRequest.md +2 -2
  201. package/docs/models/provider.UploadPhotoResponse.md +3 -3
  202. package/docs/models/provider.VerifyEmailRequest.md +5 -5
  203. package/docs/models/provider.VerifyEmailResponse.md +3 -3
  204. package/docs/models/provider.VerifySmsRequest.md +4 -2
  205. package/docs/models/provider.VerifySmsResponse.md +3 -3
  206. package/docs/models/{PatientPhotoUploadUrlResponse.md → telehealth.ErrorResponse.md} +4 -5
  207. package/docs/operations/appointments.cancel.md +1 -1
  208. package/docs/operations/appointments.connect.md +4 -4
  209. package/docs/operations/appointments.listPatientAppointments.md +12 -12
  210. package/docs/operations/appointments.listSlots.md +8 -8
  211. package/docs/operations/connectors.anthropicMessage.md +10 -2
  212. package/docs/operations/connectors.appleAuthDecodeIdToken.md +10 -2
  213. package/docs/operations/connectors.appleAuthExchangeCode.md +10 -2
  214. package/docs/operations/connectors.appleAuthGenerateClientSecret.md +10 -2
  215. package/docs/operations/connectors.athenaAddEncounterReason.md +10 -2
  216. package/docs/operations/connectors.athenaAddLabResultDocument.md +10 -2
  217. package/docs/operations/connectors.athenaAddPreferredPharmacy.md +10 -2
  218. package/docs/operations/connectors.athenaAnswerHealthQuestion.md +10 -2
  219. package/docs/operations/connectors.athenaBookAppointment.md +10 -2
  220. package/docs/operations/connectors.athenaCancelAppointment.md +10 -2
  221. package/docs/operations/connectors.athenaCheckInPatient.md +10 -2
  222. package/docs/operations/connectors.athenaCreateAllergy.md +10 -2
  223. package/docs/operations/connectors.athenaCreateAppointment.md +10 -2
  224. package/docs/operations/connectors.athenaCreateAppointmentNote.md +10 -2
  225. package/docs/operations/connectors.athenaCreateConsent.md +10 -2
  226. package/docs/operations/connectors.athenaCreateEligibilityBenefitDetails.md +10 -2
  227. package/docs/operations/connectors.athenaCreateEncounterDiagnosis.md +10 -2
  228. package/docs/operations/connectors.athenaCreateEncounterDocument.md +10 -2
  229. package/docs/operations/connectors.athenaCreateFamilyHistory.md +10 -2
  230. package/docs/operations/connectors.athenaCreateImmunization.md +10 -2
  231. package/docs/operations/connectors.athenaCreateInsurance.md +10 -2
  232. package/docs/operations/connectors.athenaCreateInsurancePackage.md +10 -2
  233. package/docs/operations/connectors.athenaCreateLabOrder.md +10 -2
  234. package/docs/operations/connectors.athenaCreateMedication.md +10 -2
  235. package/docs/operations/connectors.athenaCreateOpenAppointmentSlot.md +10 -2
  236. package/docs/operations/connectors.athenaCreatePatient.md +10 -2
  237. package/docs/operations/connectors.athenaCreateProblem.md +10 -2
  238. package/docs/operations/connectors.athenaCreateProcedure.md +10 -2
  239. package/docs/operations/connectors.athenaCreateSocialHistory.md +10 -2
  240. package/docs/operations/connectors.athenaCreateTelehealthDeeplink.md +10 -2
  241. package/docs/operations/connectors.athenaCreateVital.md +10 -2
  242. package/docs/operations/connectors.athenaDeleteEncounterDiagnosis.md +10 -2
  243. package/docs/operations/connectors.athenaDeleteEncounterDocument.md +10 -2
  244. package/docs/operations/connectors.athenaDeleteImagingResultDocument.md +10 -2
  245. package/docs/operations/connectors.athenaDeleteInsuranceCard.md +10 -2
  246. package/docs/operations/connectors.athenaDeleteInsurancePackage.md +10 -2
  247. package/docs/operations/connectors.athenaDeleteMedication.md +10 -2
  248. package/docs/operations/connectors.athenaDeletePreferredPharmacy.md +10 -2
  249. package/docs/operations/connectors.athenaDeleteVaccine.md +10 -2
  250. package/docs/operations/connectors.athenaEnhancedBestMatchPatients.md +10 -2
  251. package/docs/operations/connectors.athenaEnhancedBestMatchPatientsByEmail.md +10 -2
  252. package/docs/operations/connectors.athenaExportCertifiedCcda.md +10 -2
  253. package/docs/operations/connectors.athenaGetAppointmentDetails.md +10 -2
  254. package/docs/operations/connectors.athenaGetAppointmentEncounterSummary.md +10 -2
  255. package/docs/operations/connectors.athenaGetAppointmentSlotSubscription.md +10 -2
  256. package/docs/operations/connectors.athenaGetAssessPlanCarePlan.md +10 -2
  257. package/docs/operations/connectors.athenaGetAvailableMessageTypes.md +10 -2
  258. package/docs/operations/connectors.athenaGetBookedAppointments.md +10 -2
  259. package/docs/operations/connectors.athenaGetCareTeam.md +10 -2
  260. package/docs/operations/connectors.athenaGetCareTeamCarePlan.md +10 -2
  261. package/docs/operations/connectors.athenaGetClaim.md +10 -2
  262. package/docs/operations/connectors.athenaGetClinicalDocumentXml.md +10 -2
  263. package/docs/operations/connectors.athenaGetClinicalProvider.md +10 -2
  264. package/docs/operations/connectors.athenaGetDefaultPharmacy.md +10 -2
  265. package/docs/operations/connectors.athenaGetDepartment.md +10 -2
  266. package/docs/operations/connectors.athenaGetDriversLicense.md +10 -2
  267. package/docs/operations/connectors.athenaGetEligibilityBenefitDetails.md +10 -2
  268. package/docs/operations/connectors.athenaGetEncounter.md +10 -2
  269. package/docs/operations/connectors.athenaGetEncounterAssessment.md +10 -2
  270. package/docs/operations/connectors.athenaGetEncounterHpi.md +10 -2
  271. package/docs/operations/connectors.athenaGetEncounterSummary.md +10 -2
  272. package/docs/operations/connectors.athenaGetFhirResource.md +10 -2
  273. package/docs/operations/connectors.athenaGetFhirResourceBinary.md +10 -2
  274. package/docs/operations/connectors.athenaGetGenderIdentityFields.md +10 -2
  275. package/docs/operations/connectors.athenaGetGpal.md +10 -2
  276. package/docs/operations/connectors.athenaGetGynHistory.md +10 -2
  277. package/docs/operations/connectors.athenaGetGynHistoryQuestionConfiguration.md +10 -2
  278. package/docs/operations/connectors.athenaGetHpiTemplates.md +10 -2
  279. package/docs/operations/connectors.athenaGetImagingResultDocument.md +10 -2
  280. package/docs/operations/connectors.athenaGetImagingResultOriginalDocument.md +10 -2
  281. package/docs/operations/connectors.athenaGetInsuranceCard.md +10 -2
  282. package/docs/operations/connectors.athenaGetInsurancePackages.md +10 -2
  283. package/docs/operations/connectors.athenaGetLabResult.md +10 -2
  284. package/docs/operations/connectors.athenaGetLabResultOriginalDocument.md +10 -2
  285. package/docs/operations/connectors.athenaGetMedicationChangeEvents.md +10 -2
  286. package/docs/operations/connectors.athenaGetMedicationChangeSubscription.md +10 -2
  287. package/docs/operations/connectors.athenaGetPatient.md +10 -2
  288. package/docs/operations/connectors.athenaGetPatientCcda.md +10 -2
  289. package/docs/operations/connectors.athenaGetPatientChangeEvents.md +10 -2
  290. package/docs/operations/connectors.athenaGetPatientChangeSubscription.md +10 -2
  291. package/docs/operations/connectors.athenaGetPatientPhoto.md +10 -2
  292. package/docs/operations/connectors.athenaGetPatientSearchTypes.md +10 -2
  293. package/docs/operations/connectors.athenaGetPerinatalHistory.md +10 -2
  294. package/docs/operations/connectors.athenaGetPortalAccess.md +10 -2
  295. package/docs/operations/connectors.athenaGetPracticeInfo.md +10 -2
  296. package/docs/operations/connectors.athenaGetPreferredPharmacy.md +10 -2
  297. package/docs/operations/connectors.athenaGetPrescriptionCardImage.md +10 -2
  298. package/docs/operations/connectors.athenaGetProblemChangeEvents.md +10 -2
  299. package/docs/operations/connectors.athenaGetProblemChangeSubscription.md +10 -2
  300. package/docs/operations/connectors.athenaGetProvider.md +10 -2
  301. package/docs/operations/connectors.athenaGetQuestionnaireScreeners.md +10 -2
  302. package/docs/operations/connectors.athenaGetQuestionnaireScreenersEncounter.md +10 -2
  303. package/docs/operations/connectors.athenaGetRecipientClasses.md +10 -2
  304. package/docs/operations/connectors.athenaGetReviewOfSystems.md +10 -2
  305. package/docs/operations/connectors.athenaGetSoapNotes.md +10 -2
  306. package/docs/operations/connectors.athenaGetSocialHistoryTemplates.md +10 -2
  307. package/docs/operations/connectors.athenaGetTopInsurancePackages.md +10 -2
  308. package/docs/operations/connectors.athenaGetVitalsConfiguration.md +10 -2
  309. package/docs/operations/connectors.athenaListAdministeredQuestionnaireScreeners.md +10 -2
  310. package/docs/operations/connectors.athenaListAllergies.md +10 -2
  311. package/docs/operations/connectors.athenaListAllergyReactions.md +10 -2
  312. package/docs/operations/connectors.athenaListAppointmentConfirmationStatuses.md +10 -2
  313. package/docs/operations/connectors.athenaListAppointmentTypes.md +10 -2
  314. package/docs/operations/connectors.athenaListAppointments.md +10 -2
  315. package/docs/operations/connectors.athenaListCancerCases.md +10 -2
  316. package/docs/operations/connectors.athenaListCarePlans.md +10 -2
  317. package/docs/operations/connectors.athenaListChangedPatients.md +10 -2
  318. package/docs/operations/connectors.athenaListClosedClaims.md +10 -2
  319. package/docs/operations/connectors.athenaListConfiguredEncounterReasons.md +10 -2
  320. package/docs/operations/connectors.athenaListConsents.md +10 -2
  321. package/docs/operations/connectors.athenaListDepartments.md +10 -2
  322. package/docs/operations/connectors.athenaListDocuments.md +10 -2
  323. package/docs/operations/connectors.athenaListEncounterDiagnoses.md +10 -2
  324. package/docs/operations/connectors.athenaListEncounterDocuments.md +10 -2
  325. package/docs/operations/connectors.athenaListEncounterOrders.md +10 -2
  326. package/docs/operations/connectors.athenaListEncounterReasons.md +10 -2
  327. package/docs/operations/connectors.athenaListEncountersForPatient.md +10 -2
  328. package/docs/operations/connectors.athenaListEthnicities.md +10 -2
  329. package/docs/operations/connectors.athenaListExistingPatientAppointmentReasons.md +10 -2
  330. package/docs/operations/connectors.athenaListFamilyHistory.md +10 -2
  331. package/docs/operations/connectors.athenaListHealthHistory.md +10 -2
  332. package/docs/operations/connectors.athenaListImagingResultDocuments.md +10 -2
  333. package/docs/operations/connectors.athenaListImmunizations.md +10 -2
  334. package/docs/operations/connectors.athenaListImmunizationsFhir.md +10 -2
  335. package/docs/operations/connectors.athenaListInboxMessages.md +10 -2
  336. package/docs/operations/connectors.athenaListInsurance.md +10 -2
  337. package/docs/operations/connectors.athenaListLabAnalytes.md +10 -2
  338. package/docs/operations/connectors.athenaListLabResultDocuments.md +10 -2
  339. package/docs/operations/connectors.athenaListLabResults.md +10 -2
  340. package/docs/operations/connectors.athenaListMedicalHistoryQuestions.md +10 -2
  341. package/docs/operations/connectors.athenaListMedicationChanges.md +10 -2
  342. package/docs/operations/connectors.athenaListMedications.md +10 -2
  343. package/docs/operations/connectors.athenaListNewPatientAppointmentReasons.md +10 -2
  344. package/docs/operations/connectors.athenaListOpenClaims.md +10 -2
  345. package/docs/operations/connectors.athenaListOpenClaimsDetailed.md +10 -2
  346. package/docs/operations/connectors.athenaListPatientAppointmentReasons.md +10 -2
  347. package/docs/operations/connectors.athenaListPatientAppointments.md +10 -2
  348. package/docs/operations/connectors.athenaListPatients.md +10 -2
  349. package/docs/operations/connectors.athenaListPatientsByCustomField.md +10 -2
  350. package/docs/operations/connectors.athenaListPatientsByDepartment.md +10 -2
  351. package/docs/operations/connectors.athenaListPatientsByLastUpdatedRange.md +10 -2
  352. package/docs/operations/connectors.athenaListPhysicalTherapyEpisodes.md +10 -2
  353. package/docs/operations/connectors.athenaListPrescriptions.md +10 -2
  354. package/docs/operations/connectors.athenaListProblemChanges.md +10 -2
  355. package/docs/operations/connectors.athenaListProblems.md +10 -2
  356. package/docs/operations/connectors.athenaListProcedures.md +10 -2
  357. package/docs/operations/connectors.athenaListProviders.md +10 -2
  358. package/docs/operations/connectors.athenaListQuestionnaireScreeners.md +10 -2
  359. package/docs/operations/connectors.athenaListRaces.md +10 -2
  360. package/docs/operations/connectors.athenaListReferrals.md +10 -2
  361. package/docs/operations/connectors.athenaListSentMessages.md +10 -2
  362. package/docs/operations/connectors.athenaListSocialHistory.md +10 -2
  363. package/docs/operations/connectors.athenaListSocialHistoryQuestions.md +10 -2
  364. package/docs/operations/connectors.athenaListSurgicalHistory.md +10 -2
  365. package/docs/operations/connectors.athenaListVitals.md +10 -2
  366. package/docs/operations/connectors.athenaListVitalsCcda.md +10 -2
  367. package/docs/operations/connectors.athenaRetrieveAvailableAppointmentSlots.md +10 -2
  368. package/docs/operations/connectors.athenaSearchAllergens.md +10 -2
  369. package/docs/operations/connectors.athenaSearchClinicalProviders.md +10 -2
  370. package/docs/operations/connectors.athenaSearchMedications.md +10 -2
  371. package/docs/operations/connectors.athenaSearchPatients.md +10 -2
  372. package/docs/operations/connectors.athenaSendSecureMessage.md +10 -2
  373. package/docs/operations/connectors.athenaSetDefaultPharmacy.md +10 -2
  374. package/docs/operations/connectors.athenaSetEncounterReasonNote.md +10 -2
  375. package/docs/operations/connectors.athenaSubmitOrder.md +10 -2
  376. package/docs/operations/connectors.athenaSubmitQuestionnaireScreener.md +10 -2
  377. package/docs/operations/connectors.athenaSubmitScreenerQuestionnaireEncounter.md +10 -2
  378. package/docs/operations/connectors.athenaSubscribeAppointmentSlots.md +10 -2
  379. package/docs/operations/connectors.athenaSubscribeMedicationChanges.md +10 -2
  380. package/docs/operations/connectors.athenaUnsubscribeMedicationChanges.md +10 -2
  381. package/docs/operations/connectors.athenaUpdateAllergies.md +10 -2
  382. package/docs/operations/connectors.athenaUpdateAppointmentCustomField.md +10 -2
  383. package/docs/operations/connectors.athenaUpdateDriversLicense.md +10 -2
  384. package/docs/operations/connectors.athenaUpdateEncounterAssessment.md +10 -2
  385. package/docs/operations/connectors.athenaUpdateEncounterDiagnosis.md +10 -2
  386. package/docs/operations/connectors.athenaUpdateEncounterHpi.md +10 -2
  387. package/docs/operations/connectors.athenaUpdateInsuranceCard.md +10 -2
  388. package/docs/operations/connectors.athenaUpdateMedication.md +10 -2
  389. package/docs/operations/connectors.athenaUpdateMedicationsSection.md +10 -2
  390. package/docs/operations/connectors.athenaUpdatePatient.md +10 -2
  391. package/docs/operations/connectors.athenaUpdatePatientCcda.md +10 -2
  392. package/docs/operations/connectors.athenaUpdateProblemsSection.md +10 -2
  393. package/docs/operations/connectors.athenaUpdateReviewOfSystems.md +10 -2
  394. package/docs/operations/connectors.athenaUpdateSoapNote.md +10 -2
  395. package/docs/operations/connectors.athenaUpdateVaccine.md +10 -2
  396. package/docs/operations/connectors.athenaUpdateVital.md +10 -2
  397. package/docs/operations/connectors.athenaUploadDocument.md +10 -2
  398. package/docs/operations/connectors.athenaUploadImagingResultDocument.md +10 -2
  399. package/docs/operations/connectors.athenaUploadInsuranceCard.md +10 -2
  400. package/docs/operations/connectors.athenaUploadPatientPhoto.md +10 -2
  401. package/docs/operations/connectors.athenaUploadPrescriptionCardImage.md +10 -2
  402. package/docs/operations/connectors.calAssignScheduleToEventType.md +10 -2
  403. package/docs/operations/connectors.calCreateBooking.md +10 -2
  404. package/docs/operations/connectors.calCreateSchedule.md +10 -2
  405. package/docs/operations/connectors.calGetAllBookings.md +10 -2
  406. package/docs/operations/connectors.calGetAvailableSlots.md +10 -2
  407. package/docs/operations/connectors.calGetEventTypes.md +10 -2
  408. package/docs/operations/connectors.calGetScheduleById.md +10 -2
  409. package/docs/operations/connectors.calGetScheduleForEventType.md +10 -2
  410. package/docs/operations/connectors.calSyncWithAthena.md +10 -2
  411. package/docs/operations/connectors.calUpdateAvailabilityFromAthenaSlots.md +10 -2
  412. package/docs/operations/connectors.calUpdateSchedule.md +10 -2
  413. package/docs/operations/connectors.carequalityDiscoverPatient.md +10 -2
  414. package/docs/operations/connectors.carequalityImportPatientDocuments.md +10 -2
  415. package/docs/operations/connectors.carequalityQueryDocuments.md +10 -2
  416. package/docs/operations/connectors.carequalityRetrieveDocuments.md +10 -2
  417. package/docs/operations/connectors.cmsGetCountyFips.md +10 -2
  418. package/docs/operations/connectors.cmsSearchHealthPlans.md +10 -2
  419. package/docs/operations/connectors.connectureCheckEligibility.md +10 -2
  420. package/docs/operations/connectors.connectureCreateSession.md +10 -2
  421. package/docs/operations/connectors.connectureEnroll.md +10 -2
  422. package/docs/operations/connectors.connectureGetAccessToken.md +10 -2
  423. package/docs/operations/connectors.connectureGetSession.md +10 -2
  424. package/docs/operations/connectors.connectureLookupPlans.md +10 -2
  425. package/docs/operations/connectors.connecturePlanCount.md +10 -2
  426. package/docs/operations/connectors.connectureSessionPlanById.md +10 -2
  427. package/docs/operations/connectors.connectureSessionPlans.md +10 -2
  428. package/docs/operations/connectors.connectureUpdateSession.md +10 -2
  429. package/docs/operations/connectors.elevenlabsCreateAgent.md +10 -2
  430. package/docs/operations/connectors.elevenlabsCreateTool.md +10 -2
  431. package/docs/operations/connectors.elevenlabsDeleteAgent.md +10 -2
  432. package/docs/operations/connectors.elevenlabsDeleteTool.md +10 -2
  433. package/docs/operations/connectors.elevenlabsDuplicateAgent.md +10 -2
  434. package/docs/operations/connectors.elevenlabsGetAgent.md +10 -2
  435. package/docs/operations/connectors.elevenlabsGetAllAgents.md +10 -2
  436. package/docs/operations/connectors.elevenlabsGetAllConversations.md +10 -2
  437. package/docs/operations/connectors.elevenlabsGetAllTools.md +10 -2
  438. package/docs/operations/connectors.elevenlabsGetConversation.md +10 -2
  439. package/docs/operations/connectors.elevenlabsGetTool.md +10 -2
  440. package/docs/operations/connectors.elevenlabsGetToolDependentAgents.md +10 -2
  441. package/docs/operations/connectors.elevenlabsGetUser.md +10 -2
  442. package/docs/operations/connectors.elevenlabsGetVoice.md +10 -2
  443. package/docs/operations/connectors.elevenlabsListVoices.md +10 -2
  444. package/docs/operations/connectors.elevenlabsSynthesize.md +10 -2
  445. package/docs/operations/connectors.elevenlabsUpdateAgent.md +10 -2
  446. package/docs/operations/connectors.elevenlabsUpdateTool.md +10 -2
  447. package/docs/operations/connectors.fedexCreateShipment.md +10 -2
  448. package/docs/operations/connectors.fedexTrackShipment.md +10 -2
  449. package/docs/operations/connectors.googleAiEmbed.md +10 -2
  450. package/docs/operations/connectors.googleAiGenerate.md +10 -2
  451. package/docs/operations/connectors.googleAiInvokeA1cVisionCapture.md +10 -2
  452. package/docs/operations/connectors.googlePlacesDetails.md +10 -2
  453. package/docs/operations/connectors.googlePlacesNearby.md +10 -2
  454. package/docs/operations/connectors.googlePlacesText.md +10 -2
  455. package/docs/operations/connectors.grokChooseEncounterReasonsFromList.md +10 -2
  456. package/docs/operations/connectors.grokChooseHealthServiceFromList.md +10 -2
  457. package/docs/operations/connectors.grokChooseTemplatesFromList.md +10 -2
  458. package/docs/operations/connectors.grokConvertCcdaToFhir.md +10 -2
  459. package/docs/operations/connectors.grokConvertFhirToCcda.md +10 -2
  460. package/docs/operations/connectors.grokConvertFhirToCcdaWithChunking.md +10 -2
  461. package/docs/operations/connectors.grokCreateClinicalNotes.md +10 -2
  462. package/docs/operations/connectors.grokCreateEhrSummary.md +10 -2
  463. package/docs/operations/connectors.grokCreateHpiSummary.md +10 -2
  464. package/docs/operations/connectors.grokCreateScreeningSummary.md +10 -2
  465. package/docs/operations/connectors.grokGeneralGrokRequest.md +10 -2
  466. package/docs/operations/connectors.grokGetUmlsCodes.md +10 -2
  467. package/docs/operations/connectors.healthieAcceptInsurancePlans.md +10 -2
  468. package/docs/operations/connectors.healthieAddDiagnosis.md +10 -2
  469. package/docs/operations/connectors.healthieAddPharmacy.md +10 -2
  470. package/docs/operations/connectors.healthieBulkApplyTags.md +10 -2
  471. package/docs/operations/connectors.healthieBulkUpdateClients.md +10 -2
  472. package/docs/operations/connectors.healthieBulkUpdateDiagnoses.md +10 -2
  473. package/docs/operations/connectors.healthieCloseConversation.md +10 -2
  474. package/docs/operations/connectors.healthieCompleteCcdaReconciliation.md +10 -2
  475. package/docs/operations/connectors.healthieCompleteCheckout.md +10 -2
  476. package/docs/operations/connectors.healthieCopyForm.md +10 -2
  477. package/docs/operations/connectors.healthieCopyOffering.md +10 -2
  478. package/docs/operations/connectors.healthieCreateApiKey.md +10 -2
  479. package/docs/operations/connectors.healthieCreateAppointment.md +10 -2
  480. package/docs/operations/connectors.healthieCreateAppointmentSetting.md +10 -2
  481. package/docs/operations/connectors.healthieCreateAppointmentType.md +10 -2
  482. package/docs/operations/connectors.healthieCreateAvailabilitiesBulk.md +10 -2
  483. package/docs/operations/connectors.healthieCreateAvailability.md +10 -2
  484. package/docs/operations/connectors.healthieCreateBillingItem.md +10 -2
  485. package/docs/operations/connectors.healthieCreateCarePlan.md +10 -2
  486. package/docs/operations/connectors.healthieCreateCms1500.md +10 -2
  487. package/docs/operations/connectors.healthieCreateCompletedOnboardingItem.md +10 -2
  488. package/docs/operations/connectors.healthieCreateConversation.md +10 -2
  489. package/docs/operations/connectors.healthieCreateEntry.md +10 -2
  490. package/docs/operations/connectors.healthieCreateEpisodeOfCare.md +10 -2
  491. package/docs/operations/connectors.healthieCreateFamilyHistory.md +10 -2
  492. package/docs/operations/connectors.healthieCreateForm.md +10 -2
  493. package/docs/operations/connectors.healthieCreateFormAnswerGroup.md +10 -2
  494. package/docs/operations/connectors.healthieCreateFormCompletionRequest.md +10 -2
  495. package/docs/operations/connectors.healthieCreateGoal.md +10 -2
  496. package/docs/operations/connectors.healthieCreateImmunization.md +10 -2
  497. package/docs/operations/connectors.healthieCreateInsurancePayment.md +10 -2
  498. package/docs/operations/connectors.healthieCreateInvoice.md +10 -2
  499. package/docs/operations/connectors.healthieCreateLabOrder.md +10 -2
  500. package/docs/operations/connectors.healthieCreateLocation.md +10 -2
  501. package/docs/operations/connectors.healthieCreateMedication.md +10 -2
  502. package/docs/operations/connectors.healthieCreateMetricEntry.md +10 -2
  503. package/docs/operations/connectors.healthieCreateNote.md +10 -2
  504. package/docs/operations/connectors.healthieCreateOffering.md +10 -2
  505. package/docs/operations/connectors.healthieCreateOnboardingFlow.md +10 -2
  506. package/docs/operations/connectors.healthieCreateOnboardingItem.md +10 -2
  507. package/docs/operations/connectors.healthieCreateOpenLoopForm.md +10 -2
  508. package/docs/operations/connectors.healthieCreateOrganizationMembership.md +10 -2
  509. package/docs/operations/connectors.healthieCreatePatient.md +10 -2
  510. package/docs/operations/connectors.healthieCreatePersonalizationQuestionnaire.md +10 -2
  511. package/docs/operations/connectors.healthieCreateProgram.md +10 -2
  512. package/docs/operations/connectors.healthieCreateRupaOrder.md +10 -2
  513. package/docs/operations/connectors.healthieCreateSuperBill.md +10 -2
  514. package/docs/operations/connectors.healthieCreateTag.md +10 -2
  515. package/docs/operations/connectors.healthieCreateTask.md +10 -2
  516. package/docs/operations/connectors.healthieCreateUserGroup.md +10 -2
  517. package/docs/operations/connectors.healthieDeleteApiKey.md +10 -2
  518. package/docs/operations/connectors.healthieDeleteAppointment.md +10 -2
  519. package/docs/operations/connectors.healthieDeleteAppointmentType.md +10 -2
  520. package/docs/operations/connectors.healthieDeleteAvailability.md +10 -2
  521. package/docs/operations/connectors.healthieDeleteBillingItem.md +10 -2
  522. package/docs/operations/connectors.healthieDeleteCarePlan.md +10 -2
  523. package/docs/operations/connectors.healthieDeleteCms1500.md +10 -2
  524. package/docs/operations/connectors.healthieDeleteDocument.md +10 -2
  525. package/docs/operations/connectors.healthieDeleteEntry.md +10 -2
  526. package/docs/operations/connectors.healthieDeleteEpisodeOfCare.md +10 -2
  527. package/docs/operations/connectors.healthieDeleteFamilyHistory.md +10 -2
  528. package/docs/operations/connectors.healthieDeleteForm.md +10 -2
  529. package/docs/operations/connectors.healthieDeleteFormCompletionRequest.md +10 -2
  530. package/docs/operations/connectors.healthieDeleteGoal.md +10 -2
  531. package/docs/operations/connectors.healthieDeleteInvoice.md +10 -2
  532. package/docs/operations/connectors.healthieDeleteManualInsurancePayment.md +10 -2
  533. package/docs/operations/connectors.healthieDeleteMedication.md +10 -2
  534. package/docs/operations/connectors.healthieDeleteOffering.md +10 -2
  535. package/docs/operations/connectors.healthieDeleteOnboardingFlow.md +10 -2
  536. package/docs/operations/connectors.healthieDeleteOnboardingItem.md +10 -2
  537. package/docs/operations/connectors.healthieDeleteOrganizationMembership.md +10 -2
  538. package/docs/operations/connectors.healthieDeleteProgram.md +10 -2
  539. package/docs/operations/connectors.healthieDeleteSuperBill.md +10 -2
  540. package/docs/operations/connectors.healthieDeleteTag.md +10 -2
  541. package/docs/operations/connectors.healthieDeleteTask.md +10 -2
  542. package/docs/operations/connectors.healthieDeleteUserGroup.md +10 -2
  543. package/docs/operations/connectors.healthieEditAvailability.md +10 -2
  544. package/docs/operations/connectors.healthieFillLabResultReviewForm.md +10 -2
  545. package/docs/operations/connectors.healthieFindAndBookFirstAvailableSlot.md +10 -2
  546. package/docs/operations/connectors.healthieGetApiKeys.md +10 -2
  547. package/docs/operations/connectors.healthieGetAppointment.md +10 -2
  548. package/docs/operations/connectors.healthieGetAppointmentBookingWarnings.md +10 -2
  549. package/docs/operations/connectors.healthieGetAppointmentSetting.md +10 -2
  550. package/docs/operations/connectors.healthieGetAppointmentType.md +10 -2
  551. package/docs/operations/connectors.healthieGetAppointmentTypes.md +10 -2
  552. package/docs/operations/connectors.healthieGetAppointments.md +10 -2
  553. package/docs/operations/connectors.healthieGetAvailabilities.md +10 -2
  554. package/docs/operations/connectors.healthieGetAvailability.md +10 -2
  555. package/docs/operations/connectors.healthieGetAvailableItemTypes.md +10 -2
  556. package/docs/operations/connectors.healthieGetAvailableSlotsForRange.md +10 -2
  557. package/docs/operations/connectors.healthieGetBillingItem.md +10 -2
  558. package/docs/operations/connectors.healthieGetBillingItems.md +10 -2
  559. package/docs/operations/connectors.healthieGetCarePlan.md +10 -2
  560. package/docs/operations/connectors.healthieGetCarePlans.md +10 -2
  561. package/docs/operations/connectors.healthieGetCms1500.md +10 -2
  562. package/docs/operations/connectors.healthieGetCms1500s.md +10 -2
  563. package/docs/operations/connectors.healthieGetConversation.md +10 -2
  564. package/docs/operations/connectors.healthieGetConversationMemberships.md +10 -2
  565. package/docs/operations/connectors.healthieGetCurrentUser.md +10 -2
  566. package/docs/operations/connectors.healthieGetCurrentUserId.md +10 -2
  567. package/docs/operations/connectors.healthieGetDaysAvailableForRange.md +10 -2
  568. package/docs/operations/connectors.healthieGetDietitianId.md +10 -2
  569. package/docs/operations/connectors.healthieGetDocument.md +10 -2
  570. package/docs/operations/connectors.healthieGetDocuments.md +10 -2
  571. package/docs/operations/connectors.healthieGetEntries.md +10 -2
  572. package/docs/operations/connectors.healthieGetEntry.md +10 -2
  573. package/docs/operations/connectors.healthieGetEpisodesOfCare.md +10 -2
  574. package/docs/operations/connectors.healthieGetForm.md +10 -2
  575. package/docs/operations/connectors.healthieGetFormAnswerGroups.md +10 -2
  576. package/docs/operations/connectors.healthieGetFormCompletionRequests.md +10 -2
  577. package/docs/operations/connectors.healthieGetForms.md +10 -2
  578. package/docs/operations/connectors.healthieGetGoal.md +10 -2
  579. package/docs/operations/connectors.healthieGetGoalHistories.md +10 -2
  580. package/docs/operations/connectors.healthieGetGoals.md +10 -2
  581. package/docs/operations/connectors.healthieGetInsurancePayments.md +10 -2
  582. package/docs/operations/connectors.healthieGetInsurancePlans.md +10 -2
  583. package/docs/operations/connectors.healthieGetInvoice.md +10 -2
  584. package/docs/operations/connectors.healthieGetInvoices.md +10 -2
  585. package/docs/operations/connectors.healthieGetLabOrder.md +10 -2
  586. package/docs/operations/connectors.healthieGetLabOrders.md +10 -2
  587. package/docs/operations/connectors.healthieGetLabResult.md +10 -2
  588. package/docs/operations/connectors.healthieGetMedications.md +10 -2
  589. package/docs/operations/connectors.healthieGetMetricEntries.md +10 -2
  590. package/docs/operations/connectors.healthieGetOffering.md +10 -2
  591. package/docs/operations/connectors.healthieGetOfferings.md +10 -2
  592. package/docs/operations/connectors.healthieGetOnboardingFlow.md +10 -2
  593. package/docs/operations/connectors.healthieGetOnboardingFlows.md +10 -2
  594. package/docs/operations/connectors.healthieGetOnboardingItem.md +10 -2
  595. package/docs/operations/connectors.healthieGetOrganization.md +10 -2
  596. package/docs/operations/connectors.healthieGetOrganizationDetailed.md +10 -2
  597. package/docs/operations/connectors.healthieGetOrganizationMembers.md +10 -2
  598. package/docs/operations/connectors.healthieGetPatient.md +10 -2
  599. package/docs/operations/connectors.healthieGetPatientDefaultPharmacy.md +10 -2
  600. package/docs/operations/connectors.healthieGetPatientDiagnoses.md +10 -2
  601. package/docs/operations/connectors.healthieGetPatientDocuments.md +10 -2
  602. package/docs/operations/connectors.healthieGetPatientEncounter.md +10 -2
  603. package/docs/operations/connectors.healthieGetPatientImmunizations.md +10 -2
  604. package/docs/operations/connectors.healthieGetPatientJson.md +10 -2
  605. package/docs/operations/connectors.healthieGetPatientNotes.md +10 -2
  606. package/docs/operations/connectors.healthieGetPatientProblems.md +10 -2
  607. package/docs/operations/connectors.healthieGetPharmacy.md +10 -2
  608. package/docs/operations/connectors.healthieGetProgram.md +10 -2
  609. package/docs/operations/connectors.healthieGetPrograms.md +10 -2
  610. package/docs/operations/connectors.healthieGetProvider.md +10 -2
  611. package/docs/operations/connectors.healthieGetReceivedFax.md +10 -2
  612. package/docs/operations/connectors.healthieGetReceivedFaxes.md +10 -2
  613. package/docs/operations/connectors.healthieGetSentFax.md +10 -2
  614. package/docs/operations/connectors.healthieGetSentFaxes.md +10 -2
  615. package/docs/operations/connectors.healthieGetSuperBill.md +10 -2
  616. package/docs/operations/connectors.healthieGetSuperBills.md +10 -2
  617. package/docs/operations/connectors.healthieGetTags.md +10 -2
  618. package/docs/operations/connectors.healthieGetTask.md +10 -2
  619. package/docs/operations/connectors.healthieGetTasks.md +10 -2
  620. package/docs/operations/connectors.healthieGetUnassociatedCompletedOnboardingItems.md +10 -2
  621. package/docs/operations/connectors.healthieGetUserGroup.md +10 -2
  622. package/docs/operations/connectors.healthieGetUserGroups.md +10 -2
  623. package/docs/operations/connectors.healthieLinkEncountersToEpisode.md +10 -2
  624. package/docs/operations/connectors.healthieListOrganizationMembers.md +10 -2
  625. package/docs/operations/connectors.healthieListPatients.md +10 -2
  626. package/docs/operations/connectors.healthieMarkTasksAsSeen.md +10 -2
  627. package/docs/operations/connectors.healthieParseCcdaDocument.md +10 -2
  628. package/docs/operations/connectors.healthieRemoveAcceptedInsurancePlan.md +10 -2
  629. package/docs/operations/connectors.healthieRemoveAppliedTag.md +10 -2
  630. package/docs/operations/connectors.healthieRemoveDiagnosis.md +10 -2
  631. package/docs/operations/connectors.healthieSearchPatients.md +10 -2
  632. package/docs/operations/connectors.healthieSearchPharmacies.md +10 -2
  633. package/docs/operations/connectors.healthieSendChatMessage.md +10 -2
  634. package/docs/operations/connectors.healthieSendFax.md +10 -2
  635. package/docs/operations/connectors.healthieShareForm.md +10 -2
  636. package/docs/operations/connectors.healthieSignUpPatient.md +10 -2
  637. package/docs/operations/connectors.healthieStorePaymentCard.md +10 -2
  638. package/docs/operations/connectors.healthieUnlinkEncountersFromEpisode.md +10 -2
  639. package/docs/operations/connectors.healthieUpdateAppointment.md +10 -2
  640. package/docs/operations/connectors.healthieUpdateAppointmentSetting.md +10 -2
  641. package/docs/operations/connectors.healthieUpdateAppointmentType.md +10 -2
  642. package/docs/operations/connectors.healthieUpdateBillingItem.md +10 -2
  643. package/docs/operations/connectors.healthieUpdateCarePlan.md +10 -2
  644. package/docs/operations/connectors.healthieUpdateCms1500.md +10 -2
  645. package/docs/operations/connectors.healthieUpdateConversation.md +10 -2
  646. package/docs/operations/connectors.healthieUpdateDiagnosis.md +10 -2
  647. package/docs/operations/connectors.healthieUpdateDocument.md +10 -2
  648. package/docs/operations/connectors.healthieUpdateEntry.md +10 -2
  649. package/docs/operations/connectors.healthieUpdateEpisodeOfCare.md +10 -2
  650. package/docs/operations/connectors.healthieUpdateFamilyHistory.md +10 -2
  651. package/docs/operations/connectors.healthieUpdateForm.md +10 -2
  652. package/docs/operations/connectors.healthieUpdateGoal.md +10 -2
  653. package/docs/operations/connectors.healthieUpdateImmunization.md +10 -2
  654. package/docs/operations/connectors.healthieUpdateInsurancePaymentDepositStatus.md +10 -2
  655. package/docs/operations/connectors.healthieUpdateInvoice.md +10 -2
  656. package/docs/operations/connectors.healthieUpdateLabOrder.md +10 -2
  657. package/docs/operations/connectors.healthieUpdateLocation.md +10 -2
  658. package/docs/operations/connectors.healthieUpdateManualInsurancePayment.md +10 -2
  659. package/docs/operations/connectors.healthieUpdateMedication.md +10 -2
  660. package/docs/operations/connectors.healthieUpdateOffering.md +10 -2
  661. package/docs/operations/connectors.healthieUpdateOnboardingFlow.md +10 -2
  662. package/docs/operations/connectors.healthieUpdateOnboardingItem.md +10 -2
  663. package/docs/operations/connectors.healthieUpdateOrganizationMembership.md +10 -2
  664. package/docs/operations/connectors.healthieUpdatePatient.md +10 -2
  665. package/docs/operations/connectors.healthieUpdatePatientInsuranceBilling.md +10 -2
  666. package/docs/operations/connectors.healthieUpdateProgram.md +10 -2
  667. package/docs/operations/connectors.healthieUpdateSuperBill.md +10 -2
  668. package/docs/operations/connectors.healthieUpdateTag.md +10 -2
  669. package/docs/operations/connectors.healthieUpdateTask.md +10 -2
  670. package/docs/operations/connectors.healthieUpdateUser.md +10 -2
  671. package/docs/operations/connectors.healthieUpdateUserGroup.md +10 -2
  672. package/docs/operations/connectors.impiloAssociateDevice.md +10 -2
  673. package/docs/operations/connectors.impiloCreateItem.md +10 -2
  674. package/docs/operations/connectors.impiloCreateOrder.md +10 -2
  675. package/docs/operations/connectors.impiloCreatePatient.md +10 -2
  676. package/docs/operations/connectors.impiloCreateProcurement.md +10 -2
  677. package/docs/operations/connectors.impiloDisableReadings.md +10 -2
  678. package/docs/operations/connectors.impiloDisassociateDevice.md +10 -2
  679. package/docs/operations/connectors.impiloEnableReadings.md +10 -2
  680. package/docs/operations/connectors.impiloFetchProcurementDocument.md +10 -2
  681. package/docs/operations/connectors.impiloGetBloodGlucoseReading.md +10 -2
  682. package/docs/operations/connectors.impiloGetBloodOxygenReading.md +10 -2
  683. package/docs/operations/connectors.impiloGetBloodPressureReading.md +10 -2
  684. package/docs/operations/connectors.impiloGetClinicalNote.md +10 -2
  685. package/docs/operations/connectors.impiloGetDevice.md +10 -2
  686. package/docs/operations/connectors.impiloGetGlobalAlertConfig.md +10 -2
  687. package/docs/operations/connectors.impiloGetHeartRateReading.md +10 -2
  688. package/docs/operations/connectors.impiloGetItem.md +10 -2
  689. package/docs/operations/connectors.impiloGetKit.md +10 -2
  690. package/docs/operations/connectors.impiloGetOrder.md +10 -2
  691. package/docs/operations/connectors.impiloGetOrderSummary.md +10 -2
  692. package/docs/operations/connectors.impiloGetPatient.md +10 -2
  693. package/docs/operations/connectors.impiloGetPatientAlertConfig.md +10 -2
  694. package/docs/operations/connectors.impiloGetSiteAlertConfig.md +10 -2
  695. package/docs/operations/connectors.impiloGetTemperatureReading.md +10 -2
  696. package/docs/operations/connectors.impiloGetWeightReading.md +10 -2
  697. package/docs/operations/connectors.impiloLinkKitToPatient.md +10 -2
  698. package/docs/operations/connectors.impiloListBloodGlucoseReadings.md +10 -2
  699. package/docs/operations/connectors.impiloListBloodOxygenReadings.md +10 -2
  700. package/docs/operations/connectors.impiloListBloodPressureReadings.md +10 -2
  701. package/docs/operations/connectors.impiloListClinicalNotes.md +10 -2
  702. package/docs/operations/connectors.impiloListDevices.md +10 -2
  703. package/docs/operations/connectors.impiloListHeartRateReadings.md +10 -2
  704. package/docs/operations/connectors.impiloListItems.md +10 -2
  705. package/docs/operations/connectors.impiloListKitInventory.md +10 -2
  706. package/docs/operations/connectors.impiloListKits.md +10 -2
  707. package/docs/operations/connectors.impiloListOrders.md +10 -2
  708. package/docs/operations/connectors.impiloListPatients.md +10 -2
  709. package/docs/operations/connectors.impiloListProcurements.md +10 -2
  710. package/docs/operations/connectors.impiloListSiteInventory.md +10 -2
  711. package/docs/operations/connectors.impiloListSpirometryReadings.md +10 -2
  712. package/docs/operations/connectors.impiloListTemperatureReadings.md +10 -2
  713. package/docs/operations/connectors.impiloListWeightReadings.md +10 -2
  714. package/docs/operations/connectors.impiloRecordBloodGlucoseReading.md +10 -2
  715. package/docs/operations/connectors.impiloRecordBloodOxygenReading.md +10 -2
  716. package/docs/operations/connectors.impiloRecordBloodPressureReading.md +10 -2
  717. package/docs/operations/connectors.impiloRecordHeartRateReading.md +10 -2
  718. package/docs/operations/connectors.impiloRecordTemperatureReading.md +10 -2
  719. package/docs/operations/connectors.impiloRecordWeightReading.md +10 -2
  720. package/docs/operations/connectors.impiloRegisterWebhooks.md +10 -2
  721. package/docs/operations/connectors.impiloSetGlobalAlertConfig.md +10 -2
  722. package/docs/operations/connectors.impiloSetPatientAlertConfig.md +10 -2
  723. package/docs/operations/connectors.impiloSetSiteAlertConfig.md +10 -2
  724. package/docs/operations/connectors.impiloUnlinkKitFromPatient.md +10 -2
  725. package/docs/operations/connectors.impiloUpdatePatient.md +10 -2
  726. package/docs/operations/connectors.impiloValidateDevice.md +10 -2
  727. package/docs/operations/connectors.junctionGetOrders.md +10 -2
  728. package/docs/operations/connectors.junctionGetTests.md +10 -2
  729. package/docs/operations/connectors.junctionOrderTestkit.md +10 -2
  730. package/docs/operations/connectors.junctionRegisterTestkit.md +10 -2
  731. package/docs/operations/connectors.nppesGetProvider.md +10 -2
  732. package/docs/operations/connectors.nppesSearchProviders.md +10 -2
  733. package/docs/operations/connectors.nppesVerifyProvider.md +10 -2
  734. package/docs/operations/connectors.openaiBuildResponseCreatePayload.md +10 -2
  735. package/docs/operations/connectors.openaiChat.md +10 -2
  736. package/docs/operations/connectors.openaiChatJson.md +10 -2
  737. package/docs/operations/connectors.openaiCreateAssistant.md +10 -2
  738. package/docs/operations/connectors.openaiDeleteAssistant.md +10 -2
  739. package/docs/operations/connectors.openaiEmbed.md +10 -2
  740. package/docs/operations/connectors.openaiGetAssistant.md +10 -2
  741. package/docs/operations/connectors.openaiModerate.md +10 -2
  742. package/docs/operations/connectors.openaiUpdateAssistant.md +10 -2
  743. package/docs/operations/connectors.ouraBuildAuthorizationUrl.md +10 -2
  744. package/docs/operations/connectors.ouraExchangeAuthorizationCode.md +10 -2
  745. package/docs/operations/connectors.ouraGetAllSleeps.md +10 -2
  746. package/docs/operations/connectors.ouraGetDailyActivities.md +10 -2
  747. package/docs/operations/connectors.ouraGetDailyActivity.md +10 -2
  748. package/docs/operations/connectors.ouraGetDailyCardiovascularAge.md +10 -2
  749. package/docs/operations/connectors.ouraGetDailyReadiness.md +10 -2
  750. package/docs/operations/connectors.ouraGetDailyReadinessById.md +10 -2
  751. package/docs/operations/connectors.ouraGetDailyResilience.md +10 -2
  752. package/docs/operations/connectors.ouraGetDailySleep.md +10 -2
  753. package/docs/operations/connectors.ouraGetDailySleeps.md +10 -2
  754. package/docs/operations/connectors.ouraGetDailySpo2.md +10 -2
  755. package/docs/operations/connectors.ouraGetDailyStress.md +10 -2
  756. package/docs/operations/connectors.ouraGetEnhancedTags.md +10 -2
  757. package/docs/operations/connectors.ouraGetHeartRates.md +10 -2
  758. package/docs/operations/connectors.ouraGetPersonalInfo.md +10 -2
  759. package/docs/operations/connectors.ouraGetRestModePeriods.md +10 -2
  760. package/docs/operations/connectors.ouraGetRingConfigurations.md +10 -2
  761. package/docs/operations/connectors.ouraGetSessions.md +10 -2
  762. package/docs/operations/connectors.ouraGetSleep.md +10 -2
  763. package/docs/operations/connectors.ouraGetSleepTimes.md +10 -2
  764. package/docs/operations/connectors.ouraGetSleeps.md +10 -2
  765. package/docs/operations/connectors.ouraGetTags.md +10 -2
  766. package/docs/operations/connectors.ouraGetVo2Max.md +10 -2
  767. package/docs/operations/connectors.ouraGetWorkout.md +10 -2
  768. package/docs/operations/connectors.ouraGetWorkouts.md +10 -2
  769. package/docs/operations/connectors.ouraRefreshAccessToken.md +10 -2
  770. package/docs/operations/connectors.plaidCreateIdentityVerification.md +10 -2
  771. package/docs/operations/connectors.plaidGetIdentityVerification.md +10 -2
  772. package/docs/operations/connectors.plaidListIdentityVerifications.md +10 -2
  773. package/docs/operations/connectors.questAcknowledgeCompendium.md +10 -2
  774. package/docs/operations/connectors.questAcknowledgeHl7Results.md +10 -2
  775. package/docs/operations/connectors.questAcknowledgeObservationResults.md +10 -2
  776. package/docs/operations/connectors.questAcknowledgePrintableResults.md +10 -2
  777. package/docs/operations/connectors.questBuildResultsAck.md +10 -2
  778. package/docs/operations/connectors.questClearTokenCache.md +10 -2
  779. package/docs/operations/connectors.questCreateOrder.md +10 -2
  780. package/docs/operations/connectors.questEvaluateAbn.md +10 -2
  781. package/docs/operations/connectors.questEvaluateAoe.md +10 -2
  782. package/docs/operations/connectors.questGetAccessToken.md +10 -2
  783. package/docs/operations/connectors.questGetHl7Results.md +10 -2
  784. package/docs/operations/connectors.questGetObservationResults.md +10 -2
  785. package/docs/operations/connectors.questGetOrderDocuments.md +10 -2
  786. package/docs/operations/connectors.questGetPrintableResults.md +10 -2
  787. package/docs/operations/connectors.questGetRequisition.md +10 -2
  788. package/docs/operations/connectors.questGetResults.md +10 -2
  789. package/docs/operations/connectors.questListTests.md +10 -2
  790. package/docs/operations/connectors.questProcessPushedResult.md +10 -2
  791. package/docs/operations/connectors.questRequestCompendiums.md +10 -2
  792. package/docs/operations/connectors.questRequestCompendiumsOnDemand.md +10 -2
  793. package/docs/operations/connectors.questRetrieveAndExtractCompendium.md +10 -2
  794. package/docs/operations/connectors.questRetrieveCompendium.md +10 -2
  795. package/docs/operations/connectors.questSubmitFullOrder.md +10 -2
  796. package/docs/operations/connectors.questSubmitOrder.md +10 -2
  797. package/docs/operations/connectors.questSyncCompendiums.md +10 -2
  798. package/docs/operations/connectors.salesforceBuildCaseDescription.md +10 -2
  799. package/docs/operations/connectors.salesforceCreate.md +10 -2
  800. package/docs/operations/connectors.salesforceCreateAccount.md +10 -2
  801. package/docs/operations/connectors.salesforceCreateCallLog.md +10 -2
  802. package/docs/operations/connectors.salesforceCreateCampaign.md +10 -2
  803. package/docs/operations/connectors.salesforceCreateCase.md +10 -2
  804. package/docs/operations/connectors.salesforceCreateContact.md +10 -2
  805. package/docs/operations/connectors.salesforceCreateEvent.md +10 -2
  806. package/docs/operations/connectors.salesforceCreatePatient.md +10 -2
  807. package/docs/operations/connectors.salesforceCreateSegment.md +10 -2
  808. package/docs/operations/connectors.salesforceDeleteAccount.md +10 -2
  809. package/docs/operations/connectors.salesforceDeleteCallLog.md +10 -2
  810. package/docs/operations/connectors.salesforceDeleteCampaign.md +10 -2
  811. package/docs/operations/connectors.salesforceDeleteCase.md +10 -2
  812. package/docs/operations/connectors.salesforceDeleteEvent.md +10 -2
  813. package/docs/operations/connectors.salesforceDeletePatient.md +10 -2
  814. package/docs/operations/connectors.salesforceDeleteSegment.md +10 -2
  815. package/docs/operations/connectors.salesforceDescribe.md +10 -2
  816. package/docs/operations/connectors.salesforceGet.md +10 -2
  817. package/docs/operations/connectors.salesforceGetAccount.md +10 -2
  818. package/docs/operations/connectors.salesforceGetAccountByTenant.md +10 -2
  819. package/docs/operations/connectors.salesforceGetAvailableSlots.md +10 -2
  820. package/docs/operations/connectors.salesforceGetCallLog.md +10 -2
  821. package/docs/operations/connectors.salesforceGetCampaign.md +10 -2
  822. package/docs/operations/connectors.salesforceGetCase.md +10 -2
  823. package/docs/operations/connectors.salesforceGetConfiguration.md +10 -2
  824. package/docs/operations/connectors.salesforceGetContact.md +10 -2
  825. package/docs/operations/connectors.salesforceGetEvent.md +10 -2
  826. package/docs/operations/connectors.salesforceGetHealthcareOrgIdByTenant.md +10 -2
  827. package/docs/operations/connectors.salesforceGetNotScheduledEvents.md +10 -2
  828. package/docs/operations/connectors.salesforceGetPatient.md +10 -2
  829. package/docs/operations/connectors.salesforceGetPatientByEmail.md +10 -2
  830. package/docs/operations/connectors.salesforceGetPatientByPhone.md +10 -2
  831. package/docs/operations/connectors.salesforceGetSegment.md +10 -2
  832. package/docs/operations/connectors.salesforceListAccounts.md +10 -2
  833. package/docs/operations/connectors.salesforceListCallLogs.md +10 -2
  834. package/docs/operations/connectors.salesforceListCampaigns.md +10 -2
  835. package/docs/operations/connectors.salesforceListCases.md +10 -2
  836. package/docs/operations/connectors.salesforceListEvents.md +10 -2
  837. package/docs/operations/connectors.salesforceListPatients.md +10 -2
  838. package/docs/operations/connectors.salesforceListSegments.md +10 -2
  839. package/docs/operations/connectors.salesforceQuery.md +10 -2
  840. package/docs/operations/connectors.salesforceScheduleEvent.md +10 -2
  841. package/docs/operations/connectors.salesforceSetAccountSenaiteId.md +10 -2
  842. package/docs/operations/connectors.salesforceUpdate.md +10 -2
  843. package/docs/operations/connectors.salesforceUpdateAccount.md +10 -2
  844. package/docs/operations/connectors.salesforceUpdateAccountAssets.md +10 -2
  845. package/docs/operations/connectors.salesforceUpdateCallLog.md +10 -2
  846. package/docs/operations/connectors.salesforceUpdateCampaign.md +10 -2
  847. package/docs/operations/connectors.salesforceUpdatePatient.md +10 -2
  848. package/docs/operations/connectors.salesforceUpdateSegment.md +10 -2
  849. package/docs/operations/connectors.scrapflyGetDocumentLinks.md +10 -2
  850. package/docs/operations/connectors.scrapflyScrape.md +10 -2
  851. package/docs/operations/connectors.senaiteCancelSample.md +10 -2
  852. package/docs/operations/connectors.senaiteCreateAnalysisCategory.md +10 -2
  853. package/docs/operations/connectors.senaiteCreateAnalysisService.md +10 -2
  854. package/docs/operations/connectors.senaiteCreateClient.md +10 -2
  855. package/docs/operations/connectors.senaiteCreateContact.md +10 -2
  856. package/docs/operations/connectors.senaiteCreateDepartment.md +10 -2
  857. package/docs/operations/connectors.senaiteCreateSample.md +10 -2
  858. package/docs/operations/connectors.senaiteCreateSampleType.md +10 -2
  859. package/docs/operations/connectors.senaiteDeactivateClient.md +10 -2
  860. package/docs/operations/connectors.senaiteEnsureSenaiteClientForTenant.md +10 -2
  861. package/docs/operations/connectors.senaiteGetAllClients.md +10 -2
  862. package/docs/operations/connectors.senaiteGetAllSamples.md +10 -2
  863. package/docs/operations/connectors.senaiteGetAnalysisServices.md +10 -2
  864. package/docs/operations/connectors.senaiteGetCatalogs.md +10 -2
  865. package/docs/operations/connectors.senaiteGetClientById.md +10 -2
  866. package/docs/operations/connectors.senaiteGetClientByUid.md +10 -2
  867. package/docs/operations/connectors.senaiteGetContactsForClient.md +10 -2
  868. package/docs/operations/connectors.senaiteGetCurrentUser.md +10 -2
  869. package/docs/operations/connectors.senaiteGetSampleById.md +10 -2
  870. package/docs/operations/connectors.senaiteGetSampleByUid.md +10 -2
  871. package/docs/operations/connectors.senaiteGetSampleTypes.md +10 -2
  872. package/docs/operations/connectors.senaiteGetSamplesByClientId.md +10 -2
  873. package/docs/operations/connectors.senaiteLogin.md +10 -2
  874. package/docs/operations/connectors.senaiteLogout.md +10 -2
  875. package/docs/operations/connectors.senaiteSearch.md +10 -2
  876. package/docs/operations/connectors.senaiteUpdateClient.md +10 -2
  877. package/docs/operations/connectors.senaiteUpdateSample.md +10 -2
  878. package/docs/operations/connectors.sendgridListTemplates.md +10 -2
  879. package/docs/operations/connectors.sendgridSend.md +10 -2
  880. package/docs/operations/connectors.steadymdAddAllergyIntolerance.md +10 -2
  881. package/docs/operations/connectors.steadymdClaimIdentityVerification.md +10 -2
  882. package/docs/operations/connectors.steadymdCreateConsult.md +10 -2
  883. package/docs/operations/connectors.steadymdCreateConsultIssue.md +10 -2
  884. package/docs/operations/connectors.steadymdCreateEpisode.md +10 -2
  885. package/docs/operations/connectors.steadymdCreateEpisodeLabRequisition.md +10 -2
  886. package/docs/operations/connectors.steadymdCreateIntake.md +10 -2
  887. package/docs/operations/connectors.steadymdCreateLabOrder.md +10 -2
  888. package/docs/operations/connectors.steadymdCreateLabOrderResult.md +10 -2
  889. package/docs/operations/connectors.steadymdCreateMessage.md +10 -2
  890. package/docs/operations/connectors.steadymdCreatePatient.md +10 -2
  891. package/docs/operations/connectors.steadymdGetClinician.md +10 -2
  892. package/docs/operations/connectors.steadymdGetConsult.md +10 -2
  893. package/docs/operations/connectors.steadymdGetConsultAvailability.md +10 -2
  894. package/docs/operations/connectors.steadymdGetConsultPatientUi.md +10 -2
  895. package/docs/operations/connectors.steadymdGetEpisode.md +10 -2
  896. package/docs/operations/connectors.steadymdGetEpisodeLabRequisition.md +10 -2
  897. package/docs/operations/connectors.steadymdGetEpisodeSignedDocuments.md +10 -2
  898. package/docs/operations/connectors.steadymdGetIntake.md +10 -2
  899. package/docs/operations/connectors.steadymdGetLabOrder.md +10 -2
  900. package/docs/operations/connectors.steadymdGetLabOrderPdf.md +10 -2
  901. package/docs/operations/connectors.steadymdGetLabOrderResult.md +10 -2
  902. package/docs/operations/connectors.steadymdGetLabResultPdf.md +10 -2
  903. package/docs/operations/connectors.steadymdGetMessage.md +10 -2
  904. package/docs/operations/connectors.steadymdGetPatient.md +10 -2
  905. package/docs/operations/connectors.steadymdGetProgram.md +10 -2
  906. package/docs/operations/connectors.steadymdGetProgramAppointments.md +10 -2
  907. package/docs/operations/connectors.steadymdGetProgramConsultOptions.md +10 -2
  908. package/docs/operations/connectors.steadymdGetProgramLabs.md +10 -2
  909. package/docs/operations/connectors.steadymdListConsults.md +10 -2
  910. package/docs/operations/connectors.steadymdListIntakes.md +10 -2
  911. package/docs/operations/connectors.steadymdListLabOrderResults.md +10 -2
  912. package/docs/operations/connectors.steadymdListLabOrders.md +10 -2
  913. package/docs/operations/connectors.steadymdListMessages.md +10 -2
  914. package/docs/operations/connectors.steadymdListPharmacies.md +10 -2
  915. package/docs/operations/connectors.steadymdListProgramClinicians.md +10 -2
  916. package/docs/operations/connectors.steadymdListPrograms.md +10 -2
  917. package/docs/operations/connectors.steadymdPatchEpisode.md +10 -2
  918. package/docs/operations/connectors.steadymdScheduleConsultAppointment.md +10 -2
  919. package/docs/operations/connectors.steadymdSendConsultMessage.md +10 -2
  920. package/docs/operations/connectors.steadymdUpdateConsultStatus.md +10 -2
  921. package/docs/operations/connectors.steadymdUpdateEpisode.md +10 -2
  922. package/docs/operations/connectors.steadymdUpdateIntake.md +10 -2
  923. package/docs/operations/connectors.stediCheckClaimStatus.md +10 -2
  924. package/docs/operations/connectors.stediCheckCoordinationOfBenefits.md +10 -2
  925. package/docs/operations/connectors.stediDiscoverInsurance.md +10 -2
  926. package/docs/operations/connectors.stediEligibility.md +10 -2
  927. package/docs/operations/connectors.stediGet835EraReport.md +10 -2
  928. package/docs/operations/connectors.stediGetInsuranceDiscoveryResults.md +10 -2
  929. package/docs/operations/connectors.stediSubmitClaim.md +10 -2
  930. package/docs/operations/connectors.stediSubmitInstitutionalClaim.md +10 -2
  931. package/docs/operations/connectors.stediSubmitProfessionalClaim.md +10 -2
  932. package/docs/operations/connectors.stediVerifyProvider.md +10 -2
  933. package/docs/operations/connectors.stripeChargePaymentSession.md +10 -2
  934. package/docs/operations/connectors.stripeCreateCopayPrice.md +10 -2
  935. package/docs/operations/connectors.stripeCreateCustomer.md +10 -2
  936. package/docs/operations/connectors.stripeCreatePaymentIntent.md +10 -2
  937. package/docs/operations/connectors.stripeCreateSession.md +10 -2
  938. package/docs/operations/connectors.stripeCreateSubscription.md +10 -2
  939. package/docs/operations/connectors.stripeGetPaymentIntentStatus.md +10 -2
  940. package/docs/operations/connectors.stripeListProducts.md +10 -2
  941. package/docs/operations/connectors.stripeValidateAndTokenizeCard.md +10 -2
  942. package/docs/operations/connectors.stripeVerifyConnection.md +10 -2
  943. package/docs/operations/connectors.twilioGetMessage.md +10 -2
  944. package/docs/operations/connectors.twilioListMessages.md +10 -2
  945. package/docs/operations/connectors.twilioSendSms.md +10 -2
  946. package/docs/operations/connectors.uberCancelDelivery.md +10 -2
  947. package/docs/operations/connectors.uberCreateDelivery.md +10 -2
  948. package/docs/operations/connectors.uberCreateQuote.md +10 -2
  949. package/docs/operations/connectors.uberFindStores.md +10 -2
  950. package/docs/operations/connectors.uberGetDeliveries.md +10 -2
  951. package/docs/operations/connectors.uberGetDelivery.md +10 -2
  952. package/docs/operations/connectors.uberGetUndeliveredOrders.md +10 -2
  953. package/docs/operations/connectors.uberUpdateDelivery.md +10 -2
  954. package/docs/operations/connectors.whoopAddTestData.md +10 -2
  955. package/docs/operations/connectors.whoopBuildAuthorizationUrl.md +10 -2
  956. package/docs/operations/connectors.whoopExchangeAuthorizationCode.md +10 -2
  957. package/docs/operations/connectors.whoopGetActivityMapping.md +10 -2
  958. package/docs/operations/connectors.whoopGetAllCycles.md +10 -2
  959. package/docs/operations/connectors.whoopGetAllRecoveries.md +10 -2
  960. package/docs/operations/connectors.whoopGetAllSleeps.md +10 -2
  961. package/docs/operations/connectors.whoopGetAllWorkouts.md +10 -2
  962. package/docs/operations/connectors.whoopGetCycle.md +10 -2
  963. package/docs/operations/connectors.whoopGetCycles.md +10 -2
  964. package/docs/operations/connectors.whoopGetLabRequisition.md +10 -2
  965. package/docs/operations/connectors.whoopGetPartnerToken.md +10 -2
  966. package/docs/operations/connectors.whoopGetRecoveries.md +10 -2
  967. package/docs/operations/connectors.whoopGetRecoveryForCycle.md +10 -2
  968. package/docs/operations/connectors.whoopGetServiceRequest.md +10 -2
  969. package/docs/operations/connectors.whoopGetSleep.md +10 -2
  970. package/docs/operations/connectors.whoopGetSleepForCycle.md +10 -2
  971. package/docs/operations/connectors.whoopGetSleeps.md +10 -2
  972. package/docs/operations/connectors.whoopGetUserBodyMeasurement.md +10 -2
  973. package/docs/operations/connectors.whoopGetUserProfile.md +10 -2
  974. package/docs/operations/connectors.whoopGetWorkout.md +10 -2
  975. package/docs/operations/connectors.whoopGetWorkouts.md +10 -2
  976. package/docs/operations/connectors.whoopRefreshAccessToken.md +10 -2
  977. package/docs/operations/connectors.whoopRevokeUserOauthAccess.md +10 -2
  978. package/docs/operations/connectors.whoopSubmitVitalsFromDevice.md +10 -2
  979. package/docs/operations/connectors.whoopUpdateServiceRequestStatus.md +10 -2
  980. package/docs/operations/connectors.whoopUploadDiagnosticReportResults.md +10 -2
  981. package/docs/operations/connectors.zocdocBookAndConfirmAppointment.md +10 -2
  982. package/docs/operations/connectors.zocdocCancelAppointment.md +10 -2
  983. package/docs/operations/connectors.zocdocConfirmAppointment.md +10 -2
  984. package/docs/operations/connectors.zocdocCreateAppointment.md +10 -2
  985. package/docs/operations/connectors.zocdocCreateAppointmentAttachment.md +10 -2
  986. package/docs/operations/connectors.zocdocGetAppointmentById.md +10 -2
  987. package/docs/operations/connectors.zocdocGetAppointmentParticipants.md +10 -2
  988. package/docs/operations/connectors.zocdocGetDirectoryNpis.md +10 -2
  989. package/docs/operations/connectors.zocdocGetFacilityById.md +10 -2
  990. package/docs/operations/connectors.zocdocGetInsurancePlanById.md +10 -2
  991. package/docs/operations/connectors.zocdocGetInsurancePlans.md +10 -2
  992. package/docs/operations/connectors.zocdocGetMultipleLocationsAvailability.md +10 -2
  993. package/docs/operations/connectors.zocdocGetProviderByNpi.md +10 -2
  994. package/docs/operations/connectors.zocdocGetProviderCalendarTimeslots.md +10 -2
  995. package/docs/operations/connectors.zocdocGetProviderLocationById.md +10 -2
  996. package/docs/operations/connectors.zocdocGetProviderLocationInsuranceMappings.md +10 -2
  997. package/docs/operations/connectors.zocdocGetProvidersByNpis.md +10 -2
  998. package/docs/operations/connectors.zocdocGetSchedulableEntities.md +10 -2
  999. package/docs/operations/connectors.zocdocListAppointments.md +10 -2
  1000. package/docs/operations/connectors.zocdocRescheduleAppointment.md +10 -2
  1001. package/docs/operations/connectors.zocdocSearchFacilities.md +10 -2
  1002. package/docs/operations/connectors.zocdocSearchProviderLocations.md +10 -2
  1003. package/docs/operations/connectors.zocdocSetProviderCalendarTimeslots.md +10 -2
  1004. package/docs/operations/connectors.zocdocUpdateAppointmentStatus.md +10 -2
  1005. package/docs/operations/connectors.zocdocUpdateProviderLocationInsuranceMappings.md +10 -2
  1006. package/docs/operations/connectors.zusBuildAthenaIdentifierSystem.md +10 -2
  1007. package/docs/operations/connectors.zusCreatePatient.md +10 -2
  1008. package/docs/operations/connectors.zusGetAccessAndRefreshTokens.md +10 -2
  1009. package/docs/operations/connectors.zusGetGeneralAccessAndRefreshTokens.md +10 -2
  1010. package/docs/operations/connectors.zusPatientExists.md +10 -2
  1011. package/docs/operations/connectors.zusSearchPatient.md +10 -2
  1012. package/docs/operations/connectors.zusSearchPatientByAthenaId.md +10 -2
  1013. package/docs/operations/connectors.zusUploadCcd.md +10 -2
  1014. package/docs/operations/diagnostics.connect.md +2 -2
  1015. package/docs/operations/diagnostics.createRapidTest.md +91 -39
  1016. package/docs/operations/diagnostics.getScanUploadUrl.md +57 -13
  1017. package/docs/operations/diagnostics.getTestResult.md +57 -22
  1018. package/docs/operations/diagnostics.listDiagnostics.md +54 -19
  1019. package/docs/operations/diagnostics.lookupTestByGs1.md +54 -65
  1020. package/docs/operations/ehr.connect.md +2 -2
  1021. package/docs/operations/fieldagent.agentPhotoUploadUrl.md +51 -7
  1022. package/docs/operations/fieldagent.confirmResetPassword.md +40 -16
  1023. package/docs/operations/fieldagent.connect.md +2 -2
  1024. package/docs/operations/fieldagent.getAgent.md +41 -5
  1025. package/docs/operations/fieldagent.getAgentDashboard.md +62 -22
  1026. package/docs/operations/fieldagent.getAgentPhoto.md +50 -7
  1027. package/docs/operations/fieldagent.getPatientPhoto.md +33 -7
  1028. package/docs/operations/fieldagent.listEncounters.md +60 -43
  1029. package/docs/operations/fieldagent.listPatients.md +117 -62
  1030. package/docs/operations/fieldagent.login.md +54 -18
  1031. package/docs/operations/fieldagent.onboardPatient.md +218 -179
  1032. package/docs/operations/fieldagent.patientPhotoUploadUrl.md +33 -7
  1033. package/docs/operations/fieldagent.refreshToken.md +131 -0
  1034. package/docs/operations/fieldagent.register.md +76 -42
  1035. package/docs/operations/fieldagent.resetPassword.md +20 -12
  1036. package/docs/operations/fieldagent.updateAgent.md +96 -22
  1037. package/docs/operations/fieldagent.uploadAgentPhoto.md +53 -9
  1038. package/docs/operations/fieldagent.uploadPatientPhoto.md +35 -9
  1039. package/docs/operations/fieldagent.verifyEmail.md +47 -13
  1040. package/docs/operations/fieldagent.verifySms.md +32 -16
  1041. package/docs/operations/graph.connect.md +2 -2
  1042. package/docs/operations/graph.getDiagnosticAnalyte.md +44 -18
  1043. package/docs/operations/graph.getDiagnosticSpecialties.md +3 -5
  1044. package/docs/operations/graph.getDiagnosticTest.md +43 -17
  1045. package/docs/operations/graph.getDiagnosticTestRelationships.md +35 -9
  1046. package/docs/operations/graph.getDiagnosticTestSystem.md +44 -18
  1047. package/docs/operations/graph.getMedicalConcept.md +3 -3
  1048. package/docs/operations/graph.getMedicalConceptAncestors.md +3 -5
  1049. package/docs/operations/graph.getMedicalConceptDescendants.md +3 -5
  1050. package/docs/operations/graph.getMedicalConceptRelationships.md +3 -5
  1051. package/docs/operations/graph.getMedicalConceptVocabularies.md +3 -5
  1052. package/docs/operations/graph.getPolicyDocument.md +26 -26
  1053. package/docs/operations/graph.listDiagnosticTests.md +15 -15
  1054. package/docs/operations/graph.listMedicalConceptsGet.md +17 -14
  1055. package/docs/operations/graph.listPolicyDocuments.md +26 -26
  1056. package/docs/operations/graph.searchDiagnosticTests.md +22 -7
  1057. package/docs/operations/graph.searchDocumentSummaries.md +39 -22
  1058. package/docs/operations/graph.searchDocumentSummariesCypher.md +37 -13
  1059. package/docs/operations/graph.searchHealthPlans.md +43 -26
  1060. package/docs/operations/graph.searchHealthPlansCypher.md +37 -13
  1061. package/docs/operations/graph.searchMedicalConcepts.md +65 -45
  1062. package/docs/operations/graph.searchMedicalConceptsCypher.md +37 -13
  1063. package/docs/operations/graph.searchMedicalConceptsGet.md +26 -23
  1064. package/docs/operations/graph.searchPolicyDocuments.md +26 -26
  1065. package/docs/operations/graph.searchProviders.md +43 -26
  1066. package/docs/operations/graph.searchProvidersCypher.md +38 -14
  1067. package/docs/operations/mcp.mcpFieldagent.md +10 -2
  1068. package/docs/operations/mcp.mcpPatient.md +10 -2
  1069. package/docs/operations/mcp.mcpPerson.md +10 -2
  1070. package/docs/operations/patient.addNotification.md +13 -13
  1071. package/docs/operations/patient.analyzeIdentityDocument.md +10 -10
  1072. package/docs/operations/patient.assistantChat.md +9 -11
  1073. package/docs/operations/patient.assistantClassify.md +19 -1
  1074. package/docs/operations/patient.assistantOcr.md +20 -20
  1075. package/docs/operations/patient.assistantOcrInsurance.md +14 -14
  1076. package/docs/operations/patient.commsGetState.md +33 -33
  1077. package/docs/operations/patient.commsGetUnreadCount.md +1 -1
  1078. package/docs/operations/patient.commsListConversations.md +9 -9
  1079. package/docs/operations/patient.commsListConversationsByParticipant.md +9 -9
  1080. package/docs/operations/patient.commsListGroups.md +9 -9
  1081. package/docs/operations/patient.commsListInvites.md +9 -9
  1082. package/docs/operations/patient.commsListMessages.md +7 -7
  1083. package/docs/operations/patient.commsListPresence.md +4 -4
  1084. package/docs/operations/patient.commsUpsertConversation.md +25 -25
  1085. package/docs/operations/patient.commsUpsertGroup.md +23 -23
  1086. package/docs/operations/patient.commsUpsertInvite.md +23 -23
  1087. package/docs/operations/patient.commsUpsertMessage.md +19 -19
  1088. package/docs/operations/patient.commsUpsertPresence.md +8 -8
  1089. package/docs/operations/patient.confirmResetPassword.md +10 -10
  1090. package/docs/operations/patient.createEncounter.md +112 -112
  1091. package/docs/operations/patient.createMedication.md +78 -78
  1092. package/docs/operations/patient.createQuestionnaire.md +20 -8
  1093. package/docs/operations/patient.createQuestionnaireResponse.md +10 -14
  1094. package/docs/operations/patient.faceMatch.md +7 -7
  1095. package/docs/operations/patient.getAgentAgent.md +1 -1
  1096. package/docs/operations/patient.getAgentConfigurationAgentconfiguration.md +5 -5
  1097. package/docs/operations/patient.getCheckinCheckin.md +38 -38
  1098. package/docs/operations/patient.getCurrentCareSessionCareSessionsCurrent.md +40 -40
  1099. package/docs/operations/patient.getEncounter.md +37 -37
  1100. package/docs/operations/patient.getInsurance.md +15 -15
  1101. package/docs/operations/patient.getMedication.md +27 -27
  1102. package/docs/operations/patient.getPatient.md +92 -55
  1103. package/docs/operations/patient.getPatientAlerts.md +1 -3
  1104. package/docs/operations/patient.getPatientDashboard.md +8 -16
  1105. package/docs/operations/patient.getPatientSidebarPatientSidebar.md +129 -92
  1106. package/docs/operations/patient.getPhoto.md +3 -3
  1107. package/docs/operations/patient.getPreferredPharmacy.md +2 -2
  1108. package/docs/operations/patient.importActivity.md +8 -18
  1109. package/docs/operations/patient.importHealthRecord.md +5 -9
  1110. package/docs/operations/patient.importVitals.md +8 -18
  1111. package/docs/operations/patient.initHealthRecordImport.md +1 -1
  1112. package/docs/operations/patient.listActions.md +3 -3
  1113. package/docs/operations/patient.listActivity.md +2 -4
  1114. package/docs/operations/patient.listDependents.md +6 -6
  1115. package/docs/operations/patient.listEncounters.md +38 -38
  1116. package/docs/operations/patient.listKnowledge.md +7 -7
  1117. package/docs/operations/patient.listMedications.md +28 -28
  1118. package/docs/operations/patient.listNotifications.md +7 -7
  1119. package/docs/operations/patient.login.md +15 -13
  1120. package/docs/operations/patient.nearestLocations.md +13 -13
  1121. package/docs/operations/patient.photoUploadUrl.md +3 -3
  1122. package/docs/operations/patient.refreshToken.md +131 -0
  1123. package/docs/operations/patient.resendVerificationCode.md +5 -5
  1124. package/docs/operations/patient.resetPassword.md +6 -6
  1125. package/docs/operations/patient.searchKnowledge.md +7 -7
  1126. package/docs/operations/patient.setPreferredPharmacy.md +9 -9
  1127. package/docs/operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md +5 -5
  1128. package/docs/operations/patient.updateAddress.md +9 -9
  1129. package/docs/operations/patient.updateDemographics.md +15 -15
  1130. package/docs/operations/patient.updateMedication.md +8 -8
  1131. package/docs/operations/patient.updatePhone.md +3 -3
  1132. package/docs/operations/patient.updateRace.md +3 -3
  1133. package/docs/operations/patient.uploadPhoto.md +4 -4
  1134. package/docs/operations/patient.verifyEmail.md +7 -7
  1135. package/docs/operations/patient.verifySms.md +3 -3
  1136. package/docs/operations/patient.visionFaceCompare.md +7 -7
  1137. package/docs/operations/person.confirmResetPassword.md +10 -10
  1138. package/docs/operations/person.getPerson.md +30 -20
  1139. package/docs/operations/person.getPhoto.md +3 -3
  1140. package/docs/operations/person.getPhotoUploadUrl.md +3 -3
  1141. package/docs/operations/person.login.md +13 -13
  1142. package/docs/operations/person.register.md +28 -28
  1143. package/docs/operations/person.resetPassword.md +6 -6
  1144. package/docs/operations/person.updatePerson.md +90 -22
  1145. package/docs/operations/person.updatePhone.md +3 -3
  1146. package/docs/operations/person.uploadPhoto.md +7 -7
  1147. package/docs/operations/person.verifyEmail.md +7 -7
  1148. package/docs/operations/person.verifySms.md +3 -3
  1149. package/docs/operations/provider.confirmResetPassword.md +40 -16
  1150. package/docs/operations/provider.connect.md +2 -2
  1151. package/docs/operations/provider.getPhoto.md +45 -6
  1152. package/docs/operations/provider.getPhotoUploadUrl.md +25 -8
  1153. package/docs/operations/provider.getPractitioner.md +72 -45
  1154. package/docs/operations/provider.login.md +52 -18
  1155. package/docs/operations/provider.register.md +77 -47
  1156. package/docs/operations/provider.resetPassword.md +20 -12
  1157. package/docs/operations/provider.updatePhone.md +26 -9
  1158. package/docs/operations/provider.updatePractitioner.md +176 -120
  1159. package/docs/operations/provider.uploadPhoto.md +38 -12
  1160. package/docs/operations/provider.verifyEmail.md +47 -13
  1161. package/docs/operations/provider.verifySms.md +33 -8
  1162. package/docs/operations/telehealth.createChannel.md +14 -6
  1163. package/docs/operations/telehealth.createPatientToken.md +51 -17
  1164. package/docs/operations/telehealth.createProviderToken.md +51 -17
  1165. package/docs/operations/vitals.connect.md +2 -2
  1166. package/docs/operations/vitals.listVitals.md +47 -39
  1167. package/docs/operations/vitals.recordVitals.md +55 -38
  1168. package/package.json +1 -1
  1169. package/docs/models/AgentDashboardPayload.md +0 -24
  1170. package/docs/models/AgentPhotoUploadUrlResponse.md +0 -18
  1171. package/docs/models/CreatePatientTokenResponse.md +0 -23
  1172. package/docs/models/CreateProviderTokenResponse.md +0 -23
  1173. package/docs/models/LabObservation.md +0 -29
  1174. package/docs/models/ReferenceRange.md +0 -20
  1175. package/docs/models/TestProfile.md +0 -32
  1176. package/docs/models/TestProfileAnalyte.md +0 -21
  1177. package/docs/models/TestProfileGS1.md +0 -21
  1178. package/docs/models/TestProfileImage.md +0 -18
  1179. package/docs/models/TestProfileInstructionStep.md +0 -20
  1180. package/docs/models/TestProfileMetadata.md +0 -21
  1181. package/docs/models/TestProfilePossibleResult.md +0 -19
  1182. package/docs/models/fieldagent.Insurance.md +0 -32
  1183. package/docs/models/fieldagent.VerifyEmailResponse.md +0 -17
  1184. package/docs/models/fieldagent.VerifySmsResponse.md +0 -17
@@ -2,7 +2,8 @@
2
2
 
3
3
  Model ID: `OnboardEncounterStepResult`
4
4
 
5
- No description.
5
+ Result of the optional encounter-creation step. 'skipped' means the
6
+ request omitted the encounter section entirely — it was never attempted.
6
7
 
7
8
  Type: `object`
8
9
 
@@ -10,8 +11,8 @@ Type: `object`
10
11
 
11
12
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
13
  |---|---|---:|---|---|---|---:|---|
13
- | `error` | `string|null` | No | | | | Yes | |
14
- | `fhir_id` | `string|null` | No | | | | Yes | |
14
+ | `error` | `string|null` | No | | | | Yes | Failure detail; present only when status is 'failed'. |
15
+ | `fhir_id` | `string|null` | No | | | | Yes | FHIR Encounter id created. Present only on success. |
15
16
  | `status` | `string` | Yes | | | | No | 'success', 'failed', or 'skipped' |
16
17
 
17
18
  ## Example
@@ -13,13 +13,13 @@ Type: `object`
13
13
  | `address` | [`Address`](./Address.md) | No | | | | Yes | Mutually exclusive with addresses. |
14
14
  | `addresses` | `array|null` | No | | | | Yes | Mutually exclusive with address. |
15
15
  | `date_of_birth` | `string` | Yes | | | | No | ISO 8601 date (YYYY-MM-DD) |
16
- | `email` | `string` | Yes | | | | No | |
17
- | `first_name` | `string` | Yes | | | | No | |
18
- | `last_name` | `string` | Yes | | | | No | |
16
+ | `email` | `string` | Yes | | | | No | Patient's email; used as the Cognito login username. |
17
+ | `first_name` | `string` | Yes | | | | No | Patient's given name. |
18
+ | `last_name` | `string` | Yes | | | | No | Patient's family name. |
19
19
  | `password` | `string|null` | No | | | | Yes | Auto-generated server-side and not returned if omitted. |
20
- | `phone` | `string|null` | No | | | | Yes | |
21
- | `race` | [`Race`](./Race.md) | No | | | | Yes | |
22
- | `sex_at_birth` | [`SexAtBirth`](./SexAtBirth.md) | No | | | | Yes | |
20
+ | `phone` | `string|null` | No | | | | Yes | E.164 phone number, optional. |
21
+ | `race` | [`Race`](./Race.md) | No | | | | Yes | One race value, or a list of them. |
22
+ | `sex_at_birth` | [`SexAtBirth`](./SexAtBirth.md) | No | | | | Yes | Sex assigned at birth, optional. |
23
23
 
24
24
  ## Example
25
25
 
@@ -5,6 +5,8 @@ Model ID: `OnboardPatientResponse`
5
5
  Per-step result. No cross-service transaction exists across these FHIR/
6
6
  Cognito writes, so each step's outcome — and the id it produced, if any —
7
7
  is reported independently rather than claiming all-or-nothing success.
8
+ This is the 'completed' shape (HTTP 201) — every requested step
9
+ succeeded. See the 207 response for the 'partial' shape.
8
10
 
9
11
  Type: `object`
10
12
 
@@ -12,11 +14,11 @@ Type: `object`
12
14
 
13
15
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
14
16
  |---|---|---:|---|---|---|---:|---|
15
- | `encounter` | [`OnboardEncounterStepResult`](./OnboardEncounterStepResult.md) | Yes | | | | No | |
17
+ | `encounter` | [`OnboardEncounterStepResult`](./OnboardEncounterStepResult.md) | Yes | | | | No | Result of the optional encounter-creation step. |
16
18
  | `overall_status` | `string` | Yes | | | | No | 'completed', 'partial', or 'failed' |
17
- | `patient` | [`OnboardPatientStepResult`](./OnboardPatientStepResult.md) | Yes | | | | No | |
18
- | `questionnaire_response` | [`OnboardQuestionnaireStepResult`](./OnboardQuestionnaireStepResult.md) | Yes | | | | No | |
19
- | `vitals` | [`OnboardVitalsStepResult`](./OnboardVitalsStepResult.md) | Yes | | | | No | |
19
+ | `patient` | [`OnboardPatientStepResult`](./OnboardPatientStepResult.md) | Yes | | | | No | Result of the patient-registration step. Always attempted; never 'skipped'. |
20
+ | `questionnaire_response` | [`OnboardQuestionnaireStepResult`](./OnboardQuestionnaireStepResult.md) | Yes | | | | No | Result of the optional questionnaire-response step. |
21
+ | `vitals` | [`OnboardVitalsStepResult`](./OnboardVitalsStepResult.md) | Yes | | | | No | Result of the optional vitals-submission step. |
20
22
 
21
23
  ## Example
22
24
 
@@ -2,7 +2,10 @@
2
2
 
3
3
  Model ID: `OnboardPatientStepResult`
4
4
 
5
- No description.
5
+ Result of the patient-registration step. Never 'skipped' — the patient
6
+ section is required, so this step always runs and is the only step whose
7
+ failure aborts the whole request (HTTP 400) rather than being reported
8
+ alongside a 'partial' overall_status.
6
9
 
7
10
  Type: `object`
8
11
 
@@ -10,14 +13,17 @@ Type: `object`
10
13
 
11
14
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
15
  |---|---|---:|---|---|---|---:|---|
13
- | `cognito_sub` | `string|null` | No | | | | Yes | |
14
- | `email_otp_sent` | `boolean|null` | No | | | | Yes | |
15
- | `email_verified` | `boolean|null` | No | | | | Yes | |
16
- | `error` | `string|null` | No | | | | Yes | |
17
- | `fhir_patient_id` | `string|null` | No | | | | Yes | |
16
+ | `access_token` | `string|null` | No | | | | Yes | Cognito access token for the newly registered patient. Present only when patient.flags.AUTO_VERIFY_EMAIL=true on the request produced an immediate auto-verified login; lets the caller use the patient's bearer directly for follow-up writes without a separate login. |
17
+ | `cognito_sub` | `string|null` | No | | | | Yes | Cognito subject (user id) for the newly created patient account. Present only on success. |
18
+ | `email_otp_sent` | `boolean|null` | No | | | | Yes | True if an email verification OTP was generated and handed to SendGrid for delivery. False when AUTO_VERIFY_EMAIL is set (no OTP is sent) or delivery could not be attempted. |
19
+ | `email_verified` | `boolean|null` | No | | | | Yes | True only when the deployment auto-verifies email (AUTO_VERIFY_EMAIL=true); otherwise false until the patient verifies their email OTP separately. |
20
+ | `error` | `string|null` | No | | | | Yes | Failure detail; present only when status is 'failed'. |
21
+ | `expires_in` | `integer|null` | No | | | | Yes | access_token/id_token lifetime in seconds. Present under the same AUTO_VERIFY_EMAIL condition as access_token. |
22
+ | `fhir_patient_id` | `string|null` | No | | | | Yes | FHIR Patient id created for the patient; used as patient_id by the encounter/vitals/questionnaire steps. Present only on success. |
23
+ | `id_token` | `string|null` | No | | | | Yes | Cognito ID token for the newly registered patient. Present under the same AUTO_VERIFY_EMAIL condition as access_token. |
18
24
  | `status` | `string` | Yes | | | | No | 'success' or 'failed' |
19
- | `telehealth_id` | `integer|null` | No | | | | Yes | |
20
- | `temp_password_generated` | `boolean|null` | No | | | | Yes | |
25
+ | `telehealth_id` | `integer|null` | No | | | | Yes | Telehealth service identifier issued for the patient, when the telehealth integration is enabled. Present only on success. |
26
+ | `temp_password_generated` | `boolean|null` | No | | | | Yes | True when patient.password was omitted and a temporary password was generated server-side; the patient must reset it via the Patient API's reset-password flow. |
21
27
 
22
28
  ## Example
23
29
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  Model ID: `OnboardQuestionnaireAnswer`
4
4
 
5
- No description.
5
+ Exactly one of value_boolean/value_string/value_integer is expected per answer.
6
6
 
7
7
  Type: `object`
8
8
 
@@ -10,9 +10,9 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `value_boolean` | `boolean|null` | No | | | | Yes | |
14
- | `value_integer` | `integer|null` | No | | | | Yes | |
15
- | `value_string` | `string|null` | No | | | | Yes | |
13
+ | `value_boolean` | `boolean|null` | No | | | | Yes | Boolean answer value. |
14
+ | `value_integer` | `integer|null` | No | | | | Yes | Integer answer value. |
15
+ | `value_string` | `string|null` | No | | | | Yes | String answer value. |
16
16
 
17
17
  ## Example
18
18
 
@@ -13,10 +13,10 @@ Type: `object`
13
13
 
14
14
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
15
15
  |---|---|---:|---|---|---|---:|---|
16
- | `items` | array of [`QuestionnaireItemInput`](./QuestionnaireItemInput.md) | No | | | | No | |
17
- | `name` | `string` | Yes | | | | No | |
18
- | `status` | `string` | No | | | `"active"` | No | |
19
- | `title` | `string|null` | No | | | | Yes | |
16
+ | `items` | array of [`QuestionnaireItemInput`](./QuestionnaireItemInput.md) | No | | | | No | Question definitions for the new Questionnaire. |
17
+ | `name` | `string` | Yes | | | | No | Internal name for the new Questionnaire. |
18
+ | `status` | `string` | No | | | `"active"` | No | Questionnaire lifecycle status. |
19
+ | `title` | `string|null` | No | | | | Yes | Display title; defaults to name if omitted. |
20
20
 
21
21
  ## Example
22
22
 
@@ -13,10 +13,10 @@ Type: `object`
13
13
 
14
14
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
15
15
  |---|---|---:|---|---|---|---:|---|
16
- | `definition` | [`OnboardQuestionnaireDefinition`](./OnboardQuestionnaireDefinition.md) | No | | | | Yes | |
17
- | `items` | array of [`OnboardQuestionnaireResponseItem`](./OnboardQuestionnaireResponseItem.md) | No | | | | No | |
16
+ | `definition` | [`OnboardQuestionnaireDefinition`](./OnboardQuestionnaireDefinition.md) | No | | | | Yes | Inline Questionnaire definition; used to create a new Questionnaire when questionnaire_id is omitted. |
17
+ | `items` | array of [`OnboardQuestionnaireResponseItem`](./OnboardQuestionnaireResponseItem.md) | No | | | | No | Per-question answers. |
18
18
  | `questionnaire_id` | `string|null` | No | | | | Yes | FHIR id of an existing Questionnaire. Omit to create one inline via definition. |
19
- | `status` | `string` | No | | | `"completed"` | No | |
19
+ | `status` | `string` | No | | | `"completed"` | No | QuestionnaireResponse status. |
20
20
 
21
21
  ## Example
22
22
 
@@ -10,8 +10,8 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `answers` | array of [`OnboardQuestionnaireAnswer`](./OnboardQuestionnaireAnswer.md) | No | | | | No | |
14
- | `link_id` | `string` | Yes | | | | No | |
13
+ | `answers` | array of [`OnboardQuestionnaireAnswer`](./OnboardQuestionnaireAnswer.md) | No | | | | No | Answer(s) for this question. |
14
+ | `link_id` | `string` | Yes | | | | No | Question link_id this item answers, matching a linkId on the target Questionnaire. |
15
15
 
16
16
  ## Example
17
17
 
@@ -10,7 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `error` | `string|null` | No | | | | Yes | |
13
+ | `error` | `string|null` | No | | | | Yes | Failure detail; present only when status is 'failed'. |
14
14
  | `fhir_id` | `string|null` | No | | | | Yes | FHIR id of the created QuestionnaireResponse. |
15
15
  | `questionnaire_fhir_id` | `string|null` | No | | | | Yes | FHIR id of the Questionnaire used — either the supplied questionnaire_id, or the one just created from definition. |
16
16
  | `status` | `string` | Yes | | | | No | 'success', 'failed', or 'skipped' |
@@ -12,11 +12,11 @@ Type: `object`
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `diastolic` | `number|null` | No | | | | Yes | mmHg; requires systolic to be applied |
14
14
  | `heart_rate` | `number|null` | No | | | | Yes | beats/min |
15
- | `height_cm` | `number|null` | No | | | | Yes | |
15
+ | `height_cm` | `number|null` | No | | | | Yes | Centimeters |
16
16
  | `oxygen_saturation` | `number|null` | No | | | | Yes | SpO2 percentage |
17
17
  | `systolic` | `number|null` | No | | | | Yes | mmHg; requires diastolic to be applied |
18
18
  | `temperature` | `number|null` | No | | | | Yes | Celsius |
19
- | `weight_kg` | `number|null` | No | | | | Yes | |
19
+ | `weight_kg` | `number|null` | No | | | | Yes | Kilograms |
20
20
 
21
21
  ## Example
22
22
 
@@ -2,7 +2,8 @@
2
2
 
3
3
  Model ID: `OnboardVitalsStepResult`
4
4
 
5
- No description.
5
+ Result of the optional vitals-submission step. 'skipped' means the
6
+ request omitted the vitals section entirely — it was never attempted.
6
7
 
7
8
  Type: `object`
8
9
 
@@ -10,8 +11,8 @@ Type: `object`
10
11
 
11
12
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
13
  |---|---|---:|---|---|---|---:|---|
13
- | `error` | `string|null` | No | | | | Yes | |
14
- | `observation_count` | `integer|null` | No | | | | Yes | |
14
+ | `error` | `string|null` | No | | | | Yes | Failure detail; present only when status is 'failed'. |
15
+ | `observation_count` | `integer|null` | No | | | | Yes | Number of FHIR Observation resources created from the supplied vitals. Present only on success. |
15
16
  | `status` | `string` | Yes | | | | No | 'success', 'failed', or 'skipped' |
16
17
 
17
18
  ## Example
@@ -2,7 +2,7 @@
2
2
 
3
3
  Model ID: `PainScale`
4
4
 
5
- No description.
5
+ Which pain assessment scale was used.
6
6
 
7
7
  Type: `string`
8
8
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  Model ID: `PainScore`
4
4
 
5
- No description.
5
+ A pain assessment.
6
6
 
7
7
  Type: `object`
8
8
 
@@ -10,10 +10,10 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `location` | `string|null` | No | | | | Yes | |
14
- | `notes` | `string|null` | No | | | | Yes | |
13
+ | `location` | `string|null` | No | | | | Yes | Body location of the pain, optional. |
14
+ | `notes` | `string|null` | No | | | | Yes | Free-text notes, optional. |
15
15
  | `scale` | [`PainScale`](./PainScale.md) | No | | | `"numeric"` | No | |
16
- | `score` | `number` | Yes | | | | No | |
16
+ | `score` | `number` | Yes | | | | No | Pain intensity on the given scale (0-10). |
17
17
 
18
18
  ## Example
19
19
 
@@ -10,14 +10,14 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `interpretation` | `string|null` | No | | | | Yes | |
14
- | `loinc_code` | `string` | Yes | | | | No | |
15
- | `loinc_display` | `string` | Yes | | | | No | |
16
- | `panel_name` | `string` | Yes | | | | No | |
17
- | `quantitative_unit` | `string|null` | No | | | | Yes | |
18
- | `quantitative_value` | `number|null` | No | | | | Yes | |
19
- | `result` | `string` | Yes | | | | No | |
20
- | `result_type` | `string` | No | | | `"qualitative"` | No | |
13
+ | `interpretation` | `string|null` | No | | | | Yes | Clinical interpretation flag, optional. |
14
+ | `loinc_code` | `string` | Yes | | | | No | LOINC code for this panel/analyte. |
15
+ | `loinc_display` | `string` | Yes | | | | No | Display text for loinc_code. |
16
+ | `panel_name` | `string` | Yes | | | | No | Name of this panel/analyte. |
17
+ | `quantitative_unit` | `string|null` | No | | | | Yes | Unit of measure for quantitative_value, optional. |
18
+ | `quantitative_value` | `number|null` | No | | | | Yes | Numeric result value, for quantitative panels. Requires quantitative_unit. |
19
+ | `result` | `string` | Yes | | | | No | The result value for this panel. |
20
+ | `result_type` | `string` | No | | | `"qualitative"` | No | 'qualitative' or 'quantitative'. Defaults to qualitative. |
21
21
 
22
22
  ## Example
23
23
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  Model ID: `PeakFlowReading`
4
4
 
5
- No description.
5
+ A peak expiratory flow reading.
6
6
 
7
7
  Type: `object`
8
8
 
@@ -10,7 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `personal_best` | `number|null` | No | | | | Yes | |
13
+ | `personal_best` | `number|null` | No | | | | Yes | Patient's personal-best peak flow value, optional; used to compute percent_personal_best. |
14
14
  | `value` | `number` | Yes | | | | No | L/min |
15
15
 
16
16
  ## Example
@@ -2,7 +2,7 @@
2
2
 
3
3
  Model ID: `PositionCode`
4
4
 
5
- No description.
5
+ Patient position during a blood pressure reading.
6
6
 
7
7
  Type: `string`
8
8
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  Model ID: `Practitioner`
4
4
 
5
- No description.
5
+ FHIR Practitioner resource, bidirectionally mapped via to_fhir()/from_fhir().
6
6
 
7
7
  Type: `object`
8
8
 
@@ -10,36 +10,36 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `active` | `boolean` | No | | | `true` | No | |
14
- | `address` | [`Address`](./Address.md) | No | | | `null` | Yes | |
15
- | `birth_date` | `string|null` | No | | | `null` | Yes | |
16
- | `board_certifications` | `array` | No | | | | No | |
13
+ | `active` | `boolean` | No | | | `true` | No | False marks the record inactive without deleting it. |
14
+ | `address` | [`Address`](./Address.md) | No | | | `null` | Yes | Practice or mailing address, optional. |
15
+ | `birth_date` | `string|null` | No | | | `null` | Yes | ISO 8601 date of birth, optional. |
16
+ | `board_certifications` | `array` | No | | | | No | Board certification names, optional. |
17
17
  | `credential` | `string|null` | No | | | `null` | Yes | MD, DO, NP, PA, RN, etc. |
18
- | `department` | `string|null` | No | | | `null` | Yes | |
19
- | `education_credentials` | array of [`ProviderEducationCredential`](./ProviderEducationCredential.md) | No | | | | No | |
20
- | `email` | `string|null` | No | | | `null` | Yes | |
21
- | `fhir_id` | `string|null` | No | | | `null` | Yes | |
22
- | `first_name` | `string` | Yes | | | | No | |
23
- | `gender` | [`ProviderGender`](./ProviderGender.md) | No | | | `"unknown"` | No | |
24
- | `graduation_year` | `integer|null` | No | | | `null` | Yes | |
25
- | `identifiers` | array of [`ProviderIdentifier`](./ProviderIdentifier.md) | No | | | | No | |
26
- | `insurances_accepted` | array of [`ProviderAcceptedInsurance`](./ProviderAcceptedInsurance.md) | No | | | | No | |
27
- | `languages_spoken` | array of [`ProviderLanguage`](./ProviderLanguage.md) | No | | | | No | |
28
- | `last_name` | `string` | Yes | | | | No | |
29
- | `medical_school` | `string|null` | No | | | `null` | Yes | |
30
- | `middle_name` | `string|null` | No | | | `null` | Yes | |
31
- | `notes` | `string|null` | No | | | `null` | Yes | |
18
+ | `department` | `string|null` | No | | | `null` | Yes | Department within the organization, optional. |
19
+ | `education_credentials` | array of [`ProviderEducationCredential`](./ProviderEducationCredential.md) | No | | | | No | Degrees and education credentials held by this practitioner. |
20
+ | `email` | `string|null` | No | | | `null` | Yes | Email address, optional. |
21
+ | `fhir_id` | `string|null` | No | | | `null` | Yes | FHIR Practitioner resource ID; set once the record has been persisted. |
22
+ | `first_name` | `string` | Yes | | | | No | Given name. |
23
+ | `gender` | [`ProviderGender`](./ProviderGender.md) | No | | | `"unknown"` | No | Administrative gender. |
24
+ | `graduation_year` | `integer|null` | No | | | `null` | Yes | Graduation year, optional. |
25
+ | `identifiers` | array of [`ProviderIdentifier`](./ProviderIdentifier.md) | No | | | | No | Additional external identifiers (DEA, tax ID, provider number, etc.) beyond NPI and state licenses. |
26
+ | `insurances_accepted` | array of [`ProviderAcceptedInsurance`](./ProviderAcceptedInsurance.md) | No | | | | No | Insurance payers this practitioner accepts. |
27
+ | `languages_spoken` | array of [`ProviderLanguage`](./ProviderLanguage.md) | No | | | | No | Languages this practitioner can communicate with patients in. |
28
+ | `last_name` | `string` | Yes | | | | No | Family name. |
29
+ | `medical_school` | `string|null` | No | | | `null` | Yes | Medical school attended, optional. |
30
+ | `middle_name` | `string|null` | No | | | `null` | Yes | Middle name, optional. |
31
+ | `notes` | `string|null` | No | | | `null` | Yes | Free-text internal notes, optional. |
32
32
  | `npi` | `string|null` | No | | | `null` | Yes | 10-digit NPI |
33
- | `organization_id` | `string|null` | No | | | `null` | Yes | |
34
- | `organization_name` | `string|null` | No | | | `null` | Yes | |
35
- | `practitioner_id` | `string` | No | uuid | | | No | |
36
- | `prefix` | `string|null` | No | | | `null` | Yes | |
37
- | `race` | array of [`Race`](./Race.md) | No | | | | No | |
38
- | `roles` | array of [`ProviderRole`](./ProviderRole.md) | No | | | | No | |
39
- | `specialties` | array of [`ProviderSpecialty`](./ProviderSpecialty.md) | No | | | | No | |
40
- | `state_licenses` | array of [`ProviderStateLicense`](./ProviderStateLicense.md) | No | | | | No | |
41
- | `suffix` | `string|null` | No | | | `null` | Yes | |
42
- | `telecom` | array of [`ProviderContactPoint`](./ProviderContactPoint.md) | No | | | | No | |
33
+ | `organization_id` | `string|null` | No | | | `null` | Yes | Identifier of the affiliated organization, optional. |
34
+ | `organization_name` | `string|null` | No | | | `null` | Yes | Display name of the affiliated organization, optional. |
35
+ | `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}. |
36
+ | `prefix` | `string|null` | No | | | `null` | Yes | Name prefix, e.g. 'Dr.'. |
37
+ | `race` | array of [`Race`](./Race.md) | No | | | | No | One or more race values, optional. |
38
+ | `roles` | array of [`ProviderRole`](./ProviderRole.md) | No | | | | No | NUCC provider taxonomy high-level categories this practitioner practices under. |
39
+ | `specialties` | array of [`ProviderSpecialty`](./ProviderSpecialty.md) | No | | | | No | Clinical specialties, coded to a taxonomy system (NUCC by default). Sent/received on the wire as 'specialty'. |
40
+ | `state_licenses` | array of [`ProviderStateLicense`](./ProviderStateLicense.md) | No | | | | No | State medical licenses held by this practitioner. |
41
+ | `suffix` | `string|null` | No | | | `null` | Yes | Name suffix, e.g. 'Jr.'. |
42
+ | `telecom` | array of [`ProviderContactPoint`](./ProviderContactPoint.md) | No | | | | No | Additional contact points (phone, fax, pager) beyond email. |
43
43
 
44
44
  ## Example
45
45
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  Model ID: `ProviderAcceptedInsurance`
4
4
 
5
- No description.
5
+ An insurance payer this practitioner accepts.
6
6
 
7
7
  Type: `object`
8
8
 
@@ -11,7 +11,7 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `payer_id` | `string` | Yes | | | | No | Stedi payer identifier |
14
- | `payer_name` | `string` | Yes | | | | No | |
14
+ | `payer_name` | `string` | Yes | | | | No | Display name of the insurance payer. |
15
15
 
16
16
  ## Example
17
17
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  Model ID: `ProviderContactPoint`
4
4
 
5
- No description.
5
+ A contact point beyond the practitioner's primary email.
6
6
 
7
7
  Type: `object`
8
8
 
@@ -11,8 +11,8 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `system` | `string` | Yes | | | | No | phone \| fax \| email \| pager |
14
- | `use` | `string` | No | | | `"work"` | No | |
15
- | `value` | `string` | Yes | | | | No | |
14
+ | `use` | `string` | No | | | `"work"` | No | Context this contact point is used in, e.g. 'work', 'mobile'. |
15
+ | `value` | `string` | Yes | | | | No | The contact value, e.g. a phone number. |
16
16
 
17
17
  ## Example
18
18
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  Model ID: `ProviderEducationCredential`
4
4
 
5
- No description.
5
+ A degree or education credential held by this practitioner.
6
6
 
7
7
  Type: `object`
8
8
 
@@ -11,8 +11,8 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `credential` | `string` | Yes | | | | No | Degree or education credential, e.g. MD, DO, MSN |
14
- | `graduation_year` | `integer|null` | No | | | | Yes | |
15
- | `institution` | `string|null` | No | | | | Yes | |
14
+ | `graduation_year` | `integer|null` | No | | | | Yes | Year the credential was earned, optional. |
15
+ | `institution` | `string|null` | No | | | | Yes | Institution that issued the credential, optional. |
16
16
 
17
17
  ## Example
18
18
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  Model ID: `ProviderGender`
4
4
 
5
- No description.
5
+ Administrative gender, mirroring the FHIR Practitioner.gender value set.
6
6
 
7
7
  Type: `string`
8
8
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  Model ID: `ProviderIdentifier`
4
4
 
5
- No description.
5
+ An external identifier beyond NPI and state licenses (DEA, tax ID, provider number, etc.).
6
6
 
7
7
  Type: `object`
8
8
 
@@ -10,10 +10,10 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `expiration_date` | `string|null` | No | | | | Yes | |
13
+ | `expiration_date` | `string|null` | No | | | | Yes | ISO 8601 expiration date, optional. |
14
14
  | `state` | `string|null` | No | | | | Yes | For state license — two-letter state code |
15
- | `type` | [`ProviderIdentifierType`](./ProviderIdentifierType.md) | Yes | | | | No | |
16
- | `value` | `string` | Yes | | | | No | |
15
+ | `type` | [`ProviderIdentifierType`](./ProviderIdentifierType.md) | Yes | | | | No | Identifier system: NPI, DEA, SL (state license), TAX or PRN (provider number). |
16
+ | `value` | `string` | Yes | | | | No | The identifier value. |
17
17
 
18
18
  ## Example
19
19
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  Model ID: `ProviderLanguage`
4
4
 
5
- No description.
5
+ A language this practitioner can communicate with patients in.
6
6
 
7
7
  Type: `object`
8
8
 
@@ -11,7 +11,7 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `code` | `string` | Yes | | | | No | BCP-47 language tag, e.g. en, es, sr |
14
- | `display` | `string|null` | No | | | | Yes | |
14
+ | `display` | `string|null` | No | | | | Yes | Human-readable language name, optional. |
15
15
 
16
16
  ## Example
17
17
 
@@ -10,8 +10,8 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `limit` | `integer` | No | | | `20` | No | |
14
- | `offset` | `integer` | No | | | `0` | No | |
13
+ | `limit` | `integer` | No | | | `20` | No | Maximum results returned. |
14
+ | `offset` | `integer` | No | | | `0` | No | Number of results to skip, for pagination. |
15
15
  | `phrase` | `string|null` | No | | | | Yes | Free-text search across name, specialty, organization |
16
16
  | `rag` | `boolean` | No | | | `false` | No | When true, runs retrieval-augmented generation via Anthropic |
17
17
  | `specialty_code` | `string|null` | No | | | | Yes | Taxonomy / specialty code (e.g. 207R00000X) |
@@ -10,9 +10,9 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `providers` | array of [`ProviderSummary`](./ProviderSummary.md) | Yes | | | | No | |
14
- | `request` | [`ProviderSearchRequest`](./ProviderSearchRequest.md) | Yes | | | | No | |
15
- | `total` | `integer` | Yes | | | | No | |
13
+ | `providers` | array of [`ProviderSummary`](./ProviderSummary.md) | Yes | | | | No | Matching providers. |
14
+ | `request` | [`ProviderSearchRequest`](./ProviderSearchRequest.md) | Yes | | | | No | Echoes the request that produced this result set. |
15
+ | `total` | `integer` | Yes | | | | No | Number of providers in this response. |
16
16
 
17
17
  ## Example
18
18
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  Model ID: `ProviderSpecialty`
4
4
 
5
- No description.
5
+ A clinical specialty this practitioner practices, coded to a taxonomy system.
6
6
 
7
7
  Type: `object`
8
8
 
@@ -10,11 +10,11 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `board_certified` | `boolean` | No | | | `false` | No | |
13
+ | `board_certified` | `boolean` | No | | | `false` | No | True if the practitioner is board-certified in this specialty. |
14
14
  | `code` | `string` | Yes | | | | No | NUCC taxonomy code or SNOMED code |
15
- | `display` | `string` | Yes | | | | No | |
16
- | `primary` | `boolean` | No | | | `true` | No | |
17
- | `system` | `string` | No | | | `"http://nucc.org/provider-taxonomy"` | No | |
15
+ | `display` | `string` | Yes | | | | No | Human-readable specialty name. |
16
+ | `primary` | `boolean` | No | | | `true` | No | True if this is the practitioner's primary specialty. |
17
+ | `system` | `string` | No | | | `"http://nucc.org/provider-taxonomy"` | No | Coding system the code belongs to. Defaults to the NUCC provider taxonomy. |
18
18
 
19
19
  ## Example
20
20
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  Model ID: `ProviderStateLicense`
4
4
 
5
- No description.
5
+ A state medical license held by this practitioner.
6
6
 
7
7
  Type: `object`
8
8
 
@@ -10,8 +10,8 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `expiration_date` | `string|null` | No | | | | Yes | |
14
- | `license_number` | `string` | Yes | | | | No | |
13
+ | `expiration_date` | `string|null` | No | | | | Yes | ISO 8601 expiration date, optional. |
14
+ | `license_number` | `string` | Yes | | | | No | The license number. |
15
15
  | `state` | `string` | Yes | | | | No | Two-letter US state code |
16
16
 
17
17
  ## Example
@@ -10,14 +10,14 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `city` | `string|null` | No | | | | Yes | |
14
- | `name` | `string` | Yes | | | | No | |
15
- | `npi` | `string` | Yes | | | | No | |
16
- | `phone` | `string|null` | No | | | | Yes | |
13
+ | `city` | `string|null` | No | | | | Yes | Practice city, optional. |
14
+ | `name` | `string` | Yes | | | | No | Provider display name. |
15
+ | `npi` | `string` | Yes | | | | No | Provider's National Provider Identifier. |
16
+ | `phone` | `string|null` | No | | | | Yes | Practice phone number, optional. |
17
17
  | `score` | `number|null` | No | | | | Yes | Search relevance score |
18
- | `specialty` | `string|null` | No | | | | Yes | |
19
- | `specialty_code` | `string|null` | No | | | | Yes | |
20
- | `state` | `string|null` | No | | | | Yes | |
18
+ | `specialty` | `string|null` | No | | | | Yes | Specialty display name, optional. |
19
+ | `specialty_code` | `string|null` | No | | | | Yes | Taxonomy / specialty code, optional. |
20
+ | `state` | `string|null` | No | | | | Yes | Practice state, optional. |
21
21
 
22
22
  ## Example
23
23
 
@@ -12,7 +12,7 @@ Type: `object`
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `fio2` | `number|null` | No | | | | Yes | FiO2 % |
14
14
  | `flow_rate` | `number|null` | No | | | | Yes | O2 flow rate L/min |
15
- | `on_supplemental_oxygen` | `boolean` | No | | | `false` | No | |
15
+ | `on_supplemental_oxygen` | `boolean` | No | | | `false` | No | True if the patient was on supplemental oxygen during the reading. |
16
16
  | `spo2` | `number` | Yes | | | | No | SpO2 percentage |
17
17
 
18
18
  ## Example