@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.
- package/dist/index.cjs +28 -0
- package/dist/index.d.cts +2805 -2184
- package/dist/index.d.ts +2805 -2184
- package/dist/index.js +28 -0
- package/docs/clients/AuthClient.md +1 -0
- package/docs/clients/DiagnosticsClient.md +6 -6
- package/docs/clients/EhrClient.md +1 -1
- package/docs/clients/FieldAgentClient.md +19 -18
- package/docs/clients/GraphClient.md +26 -26
- package/docs/clients/ProviderClient.md +13 -13
- package/docs/clients/TelehealthClient.md +3 -3
- package/docs/clients/VitalsClient.md +3 -3
- package/docs/docs-manifest.json +22 -22
- package/docs/examples/index.md +72 -70
- package/docs/index.md +72 -70
- package/docs/models/ActivitySummary.md +5 -5
- package/docs/models/AddDependentRequest.md +1 -8
- package/docs/models/AddDependentResponse.md +1 -9
- package/docs/models/AddInsuranceRequest.md +1 -9
- package/docs/models/AddInsuranceResponse.md +1 -7
- package/docs/models/AgentDashboardResponse.md +46 -0
- package/docs/models/Appointment.md +1 -17
- package/docs/models/AssistantClassifyRequest.md +1 -5
- package/docs/models/AssistantClassifyResponse.md +1 -5
- package/docs/models/BloodPressureVital.md +1 -1
- package/docs/models/BodyWeightVital.md +1 -1
- package/docs/models/BookAppointmentRequest.md +1 -6
- package/docs/models/CheckEligibilityRequest.md +1 -11
- package/docs/models/CreateChannelResponse.md +4 -4
- package/docs/models/CreatePatientTokenRequest.md +3 -3
- package/docs/models/CreateProviderTokenRequest.md +3 -3
- package/docs/models/CreateQuestionnaireRequest.md +1 -8
- package/docs/models/CreateRapidTestRequest.md +10 -10
- package/docs/models/CreateSlotRequest.md +1 -14
- package/docs/models/CypherQueryResponse.md +3 -3
- package/docs/models/DashboardCounts.md +6 -4
- package/docs/models/DeleteActivityResponse.md +1 -5
- package/docs/models/DeleteDependentResponse.md +1 -5
- package/docs/models/DeleteNotificationResponse.md +1 -5
- package/docs/models/DependentResponse.md +1 -9
- package/docs/models/DiagnosticTestRelationship.md +5 -5
- package/docs/models/DocumentSummary.md +6 -6
- package/docs/models/DocumentSummarySearchRequest.md +2 -2
- package/docs/models/DocumentSummarySearchResponse.md +3 -3
- package/docs/models/FieldAgentProfileResponse.md +7 -2
- package/docs/models/GS1LookupResponse.md +4 -4
- package/docs/models/GS1ParsedData.md +4 -4
- package/docs/models/GetAgentPhotoResponse.md +3 -3
- package/docs/models/GetDiagnosticAnalyteResponse.md +3 -3
- package/docs/models/GetDiagnosticTestResponse.md +2 -2
- package/docs/models/GetDiagnosticTestSystemResponse.md +3 -3
- package/docs/models/GetInsuranceResponse.md +1 -1
- package/docs/models/GetPatientPhotoResponse.md +3 -3
- package/docs/models/GetPatientResponse.md +1 -1
- package/docs/models/GetPractitionerResponse.md +32 -31
- package/docs/models/GetScanUploadUrlRequest.md +4 -4
- package/docs/models/GetVitalsResponse.md +27 -23
- package/docs/models/GlucoseReading.md +2 -2
- package/docs/models/HeadCircumference.md +1 -1
- package/docs/models/HealthPlanSearchRequest.md +2 -2
- package/docs/models/HealthPlanSearchResponse.md +3 -3
- package/docs/models/HealthPlanSummary.md +6 -6
- package/docs/models/{patient.Insurance.md → Insurance.md} +1 -1
- package/docs/models/IntraocularPressure.md +1 -1
- package/docs/models/ListPatientsResponse.md +8 -6
- package/docs/models/MeasurementDevice.md +1 -1
- package/docs/models/MedicalConceptSearchRequest.md +2 -2
- package/docs/models/MedicalConceptSearchResponse.md +3 -3
- package/docs/models/OnboardEncounterPayload.md +19 -19
- package/docs/models/OnboardEncounterStepResult.md +4 -3
- package/docs/models/OnboardPatientPayload.md +6 -6
- package/docs/models/OnboardPatientResponse.md +6 -4
- package/docs/models/OnboardPatientStepResult.md +14 -8
- package/docs/models/OnboardQuestionnaireAnswer.md +4 -4
- package/docs/models/OnboardQuestionnaireDefinition.md +4 -4
- package/docs/models/OnboardQuestionnairePayload.md +3 -3
- package/docs/models/OnboardQuestionnaireResponseItem.md +2 -2
- package/docs/models/OnboardQuestionnaireStepResult.md +1 -1
- package/docs/models/OnboardVitalsPayload.md +2 -2
- package/docs/models/OnboardVitalsStepResult.md +4 -3
- package/docs/models/PainScale.md +1 -1
- package/docs/models/PainScore.md +4 -4
- package/docs/models/PanelResult.md +8 -8
- package/docs/models/PeakFlowReading.md +2 -2
- package/docs/models/PositionCode.md +1 -1
- package/docs/models/Practitioner.md +29 -29
- package/docs/models/ProviderAcceptedInsurance.md +2 -2
- package/docs/models/ProviderContactPoint.md +3 -3
- package/docs/models/ProviderEducationCredential.md +3 -3
- package/docs/models/ProviderGender.md +1 -1
- package/docs/models/ProviderIdentifier.md +4 -4
- package/docs/models/ProviderLanguage.md +2 -2
- package/docs/models/ProviderSearchRequest.md +2 -2
- package/docs/models/ProviderSearchResponse.md +3 -3
- package/docs/models/ProviderSpecialty.md +5 -5
- package/docs/models/ProviderStateLicense.md +3 -3
- package/docs/models/ProviderSummary.md +7 -7
- package/docs/models/PulseOximetryVital.md +1 -1
- package/docs/models/RapidTest.md +17 -16
- package/docs/models/RecordVitalsResponse.md +3 -3
- package/docs/models/RescheduleAppointmentRequest.md +1 -5
- package/docs/models/RespiratoryRate.md +1 -1
- package/docs/models/ScanUploadResponse.md +5 -5
- package/docs/models/SearchDiagnosticTestsResponse.md +5 -5
- package/docs/models/SearchDocumentSummariesCypherRequest.md +3 -3
- package/docs/models/SearchDocumentSummariesRequest.md +2 -2
- package/docs/models/SearchHealthPlansCypherRequest.md +3 -3
- package/docs/models/SearchHealthPlansRequest.md +2 -2
- package/docs/models/SearchMedicalConceptsCypherRequest.md +3 -3
- package/docs/models/SearchMedicalConceptsGetResponse.md +3 -3
- package/docs/models/SearchMedicalConceptsRequest.md +2 -2
- package/docs/models/SearchProvidersCypherRequest.md +3 -3
- package/docs/models/SearchProvidersRequest.md +2 -2
- package/docs/models/SingleTestResultResponse.md +13 -12
- package/docs/models/Slot.md +1 -12
- package/docs/models/StandardErrorResponse.md +18 -0
- package/docs/models/TelehealthToken.md +23 -0
- package/docs/models/TemperatureRoute.md +1 -1
- package/docs/models/UpdateAddressResponse.md +1 -5
- package/docs/models/UpdateAgentRequest.md +11 -10
- package/docs/models/UpdateDemographicsResponse.md +1 -5
- package/docs/models/UpdatePersonRequest.md +1 -6
- package/docs/models/UpdatePractitionerRequest.md +40 -28
- package/docs/models/UpdatePractitionerResponse.md +36 -3
- package/docs/models/UpdateRaceResponse.md +1 -5
- package/docs/models/UploadAgentPhotoRequest.md +3 -3
- package/docs/models/UploadAgentPhotoResponse.md +2 -2
- package/docs/models/UploadPatientPhotoRequest.md +3 -3
- package/docs/models/UploadPatientPhotoResponse.md +2 -2
- package/docs/models/VerifyOtpResponse.md +17 -0
- package/docs/models/VitalsRecordRequest.md +22 -16
- package/docs/models/VitalsStatus.md +1 -1
- package/docs/models/diagnostics.ErrorResponse.md +17 -0
- package/docs/models/diagnostics.LabObservation.md +29 -0
- package/docs/models/diagnostics.ListDiagnosticsResponse.md +5 -4
- package/docs/models/diagnostics.ReferenceRange.md +20 -0
- package/docs/models/fieldagent.ConfirmResetPasswordRequest.md +7 -6
- package/docs/models/fieldagent.ConfirmResetPasswordResponse.md +3 -3
- package/docs/models/fieldagent.ErrorResponse.md +2 -2
- package/docs/models/fieldagent.ListEncountersResponse.md +8 -6
- package/docs/models/fieldagent.LoginRequest.md +5 -5
- package/docs/models/fieldagent.LoginResponse.md +12 -7
- package/docs/models/fieldagent.PatientDemographics.md +2 -1
- package/docs/models/fieldagent.PhotoUploadUrlResponse.md +19 -0
- package/docs/models/fieldagent.RefreshTokenRequest.md +18 -0
- package/docs/models/fieldagent.RefreshTokenResponse.md +21 -0
- package/docs/models/fieldagent.RegisterRequest.md +19 -17
- package/docs/models/fieldagent.RegisterResponse.md +13 -9
- package/docs/models/fieldagent.ResetPasswordRequest.md +6 -4
- package/docs/models/fieldagent.ResetPasswordResponse.md +4 -4
- package/docs/models/fieldagent.VerifyEmailRequest.md +5 -5
- package/docs/models/fieldagent.VerifySmsRequest.md +5 -3
- package/docs/models/graph.ErrorResponse.md +17 -0
- package/docs/models/graph.JsonValue.md +1 -1
- package/docs/models/index.md +39 -41
- package/docs/models/patient.ConfirmResetPasswordResponse.md +1 -5
- package/docs/models/patient.ErrorResponse.md +1 -5
- package/docs/models/patient.LoginResponse.md +3 -10
- package/docs/models/patient.PatientDemographics.md +1 -1
- package/docs/models/{PhotoUploadUrlResponse.md → patient.PhotoUploadUrlResponse.md} +1 -1
- package/docs/models/patient.RefreshTokenRequest.md +18 -0
- package/docs/models/patient.RefreshTokenResponse.md +21 -0
- package/docs/models/patient.RegisterResponse.md +1 -9
- package/docs/models/patient.ResendVerificationCodeResponse.md +1 -5
- package/docs/models/patient.ResetPasswordResponse.md +1 -5
- package/docs/models/patient.UpdatePhoneResponse.md +1 -5
- package/docs/models/patient.VerifyEmailResponse.md +1 -5
- package/docs/models/patient.VerifySmsResponse.md +1 -5
- package/docs/models/person.ConfirmResetPasswordRequest.md +1 -8
- package/docs/models/person.ConfirmResetPasswordResponse.md +1 -5
- package/docs/models/person.ErrorResponse.md +1 -5
- package/docs/models/person.GetPhotoResponse.md +1 -7
- package/docs/models/person.GetPhotoUploadUrlResponse.md +1 -7
- package/docs/models/person.LoginRequest.md +1 -7
- package/docs/models/person.LoginResponse.md +1 -10
- package/docs/models/person.RegisterRequest.md +1 -11
- package/docs/models/person.RegisterResponse.md +1 -9
- package/docs/models/person.ResetPasswordRequest.md +1 -6
- package/docs/models/person.ResetPasswordResponse.md +1 -5
- package/docs/models/person.UpdatePhoneRequest.md +1 -5
- package/docs/models/person.UpdatePhoneResponse.md +1 -5
- package/docs/models/person.UploadPhotoRequest.md +1 -6
- package/docs/models/person.UploadPhotoResponse.md +1 -6
- package/docs/models/person.VerifyEmailRequest.md +1 -7
- package/docs/models/person.VerifyEmailResponse.md +1 -5
- package/docs/models/person.VerifySmsRequest.md +1 -5
- package/docs/models/person.VerifySmsResponse.md +1 -5
- package/docs/models/provider.ConfirmResetPasswordRequest.md +7 -6
- package/docs/models/provider.ConfirmResetPasswordResponse.md +3 -3
- package/docs/models/provider.ErrorResponse.md +17 -0
- package/docs/models/provider.GetPhotoResponse.md +8 -4
- package/docs/models/provider.GetPhotoUploadUrlResponse.md +4 -4
- package/docs/models/provider.LoginRequest.md +6 -5
- package/docs/models/provider.LoginResponse.md +12 -7
- package/docs/models/provider.RegisterResponse.md +12 -8
- package/docs/models/provider.ResetPasswordRequest.md +6 -4
- package/docs/models/provider.ResetPasswordResponse.md +3 -3
- package/docs/models/provider.UpdatePhoneRequest.md +3 -3
- package/docs/models/provider.UpdatePhoneResponse.md +6 -3
- package/docs/models/provider.UploadPhotoRequest.md +2 -2
- package/docs/models/provider.UploadPhotoResponse.md +3 -3
- package/docs/models/provider.VerifyEmailRequest.md +5 -5
- package/docs/models/provider.VerifyEmailResponse.md +3 -3
- package/docs/models/provider.VerifySmsRequest.md +4 -2
- package/docs/models/provider.VerifySmsResponse.md +3 -3
- package/docs/models/{PatientPhotoUploadUrlResponse.md → telehealth.ErrorResponse.md} +4 -5
- package/docs/operations/appointments.cancel.md +1 -1
- package/docs/operations/appointments.connect.md +4 -4
- package/docs/operations/appointments.listPatientAppointments.md +12 -12
- package/docs/operations/appointments.listSlots.md +8 -8
- package/docs/operations/connectors.anthropicMessage.md +10 -2
- package/docs/operations/connectors.appleAuthDecodeIdToken.md +10 -2
- package/docs/operations/connectors.appleAuthExchangeCode.md +10 -2
- package/docs/operations/connectors.appleAuthGenerateClientSecret.md +10 -2
- package/docs/operations/connectors.athenaAddEncounterReason.md +10 -2
- package/docs/operations/connectors.athenaAddLabResultDocument.md +10 -2
- package/docs/operations/connectors.athenaAddPreferredPharmacy.md +10 -2
- package/docs/operations/connectors.athenaAnswerHealthQuestion.md +10 -2
- package/docs/operations/connectors.athenaBookAppointment.md +10 -2
- package/docs/operations/connectors.athenaCancelAppointment.md +10 -2
- package/docs/operations/connectors.athenaCheckInPatient.md +10 -2
- package/docs/operations/connectors.athenaCreateAllergy.md +10 -2
- package/docs/operations/connectors.athenaCreateAppointment.md +10 -2
- package/docs/operations/connectors.athenaCreateAppointmentNote.md +10 -2
- package/docs/operations/connectors.athenaCreateConsent.md +10 -2
- package/docs/operations/connectors.athenaCreateEligibilityBenefitDetails.md +10 -2
- package/docs/operations/connectors.athenaCreateEncounterDiagnosis.md +10 -2
- package/docs/operations/connectors.athenaCreateEncounterDocument.md +10 -2
- package/docs/operations/connectors.athenaCreateFamilyHistory.md +10 -2
- package/docs/operations/connectors.athenaCreateImmunization.md +10 -2
- package/docs/operations/connectors.athenaCreateInsurance.md +10 -2
- package/docs/operations/connectors.athenaCreateInsurancePackage.md +10 -2
- package/docs/operations/connectors.athenaCreateLabOrder.md +10 -2
- package/docs/operations/connectors.athenaCreateMedication.md +10 -2
- package/docs/operations/connectors.athenaCreateOpenAppointmentSlot.md +10 -2
- package/docs/operations/connectors.athenaCreatePatient.md +10 -2
- package/docs/operations/connectors.athenaCreateProblem.md +10 -2
- package/docs/operations/connectors.athenaCreateProcedure.md +10 -2
- package/docs/operations/connectors.athenaCreateSocialHistory.md +10 -2
- package/docs/operations/connectors.athenaCreateTelehealthDeeplink.md +10 -2
- package/docs/operations/connectors.athenaCreateVital.md +10 -2
- package/docs/operations/connectors.athenaDeleteEncounterDiagnosis.md +10 -2
- package/docs/operations/connectors.athenaDeleteEncounterDocument.md +10 -2
- package/docs/operations/connectors.athenaDeleteImagingResultDocument.md +10 -2
- package/docs/operations/connectors.athenaDeleteInsuranceCard.md +10 -2
- package/docs/operations/connectors.athenaDeleteInsurancePackage.md +10 -2
- package/docs/operations/connectors.athenaDeleteMedication.md +10 -2
- package/docs/operations/connectors.athenaDeletePreferredPharmacy.md +10 -2
- package/docs/operations/connectors.athenaDeleteVaccine.md +10 -2
- package/docs/operations/connectors.athenaEnhancedBestMatchPatients.md +10 -2
- package/docs/operations/connectors.athenaEnhancedBestMatchPatientsByEmail.md +10 -2
- package/docs/operations/connectors.athenaExportCertifiedCcda.md +10 -2
- package/docs/operations/connectors.athenaGetAppointmentDetails.md +10 -2
- package/docs/operations/connectors.athenaGetAppointmentEncounterSummary.md +10 -2
- package/docs/operations/connectors.athenaGetAppointmentSlotSubscription.md +10 -2
- package/docs/operations/connectors.athenaGetAssessPlanCarePlan.md +10 -2
- package/docs/operations/connectors.athenaGetAvailableMessageTypes.md +10 -2
- package/docs/operations/connectors.athenaGetBookedAppointments.md +10 -2
- package/docs/operations/connectors.athenaGetCareTeam.md +10 -2
- package/docs/operations/connectors.athenaGetCareTeamCarePlan.md +10 -2
- package/docs/operations/connectors.athenaGetClaim.md +10 -2
- package/docs/operations/connectors.athenaGetClinicalDocumentXml.md +10 -2
- package/docs/operations/connectors.athenaGetClinicalProvider.md +10 -2
- package/docs/operations/connectors.athenaGetDefaultPharmacy.md +10 -2
- package/docs/operations/connectors.athenaGetDepartment.md +10 -2
- package/docs/operations/connectors.athenaGetDriversLicense.md +10 -2
- package/docs/operations/connectors.athenaGetEligibilityBenefitDetails.md +10 -2
- package/docs/operations/connectors.athenaGetEncounter.md +10 -2
- package/docs/operations/connectors.athenaGetEncounterAssessment.md +10 -2
- package/docs/operations/connectors.athenaGetEncounterHpi.md +10 -2
- package/docs/operations/connectors.athenaGetEncounterSummary.md +10 -2
- package/docs/operations/connectors.athenaGetFhirResource.md +10 -2
- package/docs/operations/connectors.athenaGetFhirResourceBinary.md +10 -2
- package/docs/operations/connectors.athenaGetGenderIdentityFields.md +10 -2
- package/docs/operations/connectors.athenaGetGpal.md +10 -2
- package/docs/operations/connectors.athenaGetGynHistory.md +10 -2
- package/docs/operations/connectors.athenaGetGynHistoryQuestionConfiguration.md +10 -2
- package/docs/operations/connectors.athenaGetHpiTemplates.md +10 -2
- package/docs/operations/connectors.athenaGetImagingResultDocument.md +10 -2
- package/docs/operations/connectors.athenaGetImagingResultOriginalDocument.md +10 -2
- package/docs/operations/connectors.athenaGetInsuranceCard.md +10 -2
- package/docs/operations/connectors.athenaGetInsurancePackages.md +10 -2
- package/docs/operations/connectors.athenaGetLabResult.md +10 -2
- package/docs/operations/connectors.athenaGetLabResultOriginalDocument.md +10 -2
- package/docs/operations/connectors.athenaGetMedicationChangeEvents.md +10 -2
- package/docs/operations/connectors.athenaGetMedicationChangeSubscription.md +10 -2
- package/docs/operations/connectors.athenaGetPatient.md +10 -2
- package/docs/operations/connectors.athenaGetPatientCcda.md +10 -2
- package/docs/operations/connectors.athenaGetPatientChangeEvents.md +10 -2
- package/docs/operations/connectors.athenaGetPatientChangeSubscription.md +10 -2
- package/docs/operations/connectors.athenaGetPatientPhoto.md +10 -2
- package/docs/operations/connectors.athenaGetPatientSearchTypes.md +10 -2
- package/docs/operations/connectors.athenaGetPerinatalHistory.md +10 -2
- package/docs/operations/connectors.athenaGetPortalAccess.md +10 -2
- package/docs/operations/connectors.athenaGetPracticeInfo.md +10 -2
- package/docs/operations/connectors.athenaGetPreferredPharmacy.md +10 -2
- package/docs/operations/connectors.athenaGetPrescriptionCardImage.md +10 -2
- package/docs/operations/connectors.athenaGetProblemChangeEvents.md +10 -2
- package/docs/operations/connectors.athenaGetProblemChangeSubscription.md +10 -2
- package/docs/operations/connectors.athenaGetProvider.md +10 -2
- package/docs/operations/connectors.athenaGetQuestionnaireScreeners.md +10 -2
- package/docs/operations/connectors.athenaGetQuestionnaireScreenersEncounter.md +10 -2
- package/docs/operations/connectors.athenaGetRecipientClasses.md +10 -2
- package/docs/operations/connectors.athenaGetReviewOfSystems.md +10 -2
- package/docs/operations/connectors.athenaGetSoapNotes.md +10 -2
- package/docs/operations/connectors.athenaGetSocialHistoryTemplates.md +10 -2
- package/docs/operations/connectors.athenaGetTopInsurancePackages.md +10 -2
- package/docs/operations/connectors.athenaGetVitalsConfiguration.md +10 -2
- package/docs/operations/connectors.athenaListAdministeredQuestionnaireScreeners.md +10 -2
- package/docs/operations/connectors.athenaListAllergies.md +10 -2
- package/docs/operations/connectors.athenaListAllergyReactions.md +10 -2
- package/docs/operations/connectors.athenaListAppointmentConfirmationStatuses.md +10 -2
- package/docs/operations/connectors.athenaListAppointmentTypes.md +10 -2
- package/docs/operations/connectors.athenaListAppointments.md +10 -2
- package/docs/operations/connectors.athenaListCancerCases.md +10 -2
- package/docs/operations/connectors.athenaListCarePlans.md +10 -2
- package/docs/operations/connectors.athenaListChangedPatients.md +10 -2
- package/docs/operations/connectors.athenaListClosedClaims.md +10 -2
- package/docs/operations/connectors.athenaListConfiguredEncounterReasons.md +10 -2
- package/docs/operations/connectors.athenaListConsents.md +10 -2
- package/docs/operations/connectors.athenaListDepartments.md +10 -2
- package/docs/operations/connectors.athenaListDocuments.md +10 -2
- package/docs/operations/connectors.athenaListEncounterDiagnoses.md +10 -2
- package/docs/operations/connectors.athenaListEncounterDocuments.md +10 -2
- package/docs/operations/connectors.athenaListEncounterOrders.md +10 -2
- package/docs/operations/connectors.athenaListEncounterReasons.md +10 -2
- package/docs/operations/connectors.athenaListEncountersForPatient.md +10 -2
- package/docs/operations/connectors.athenaListEthnicities.md +10 -2
- package/docs/operations/connectors.athenaListExistingPatientAppointmentReasons.md +10 -2
- package/docs/operations/connectors.athenaListFamilyHistory.md +10 -2
- package/docs/operations/connectors.athenaListHealthHistory.md +10 -2
- package/docs/operations/connectors.athenaListImagingResultDocuments.md +10 -2
- package/docs/operations/connectors.athenaListImmunizations.md +10 -2
- package/docs/operations/connectors.athenaListImmunizationsFhir.md +10 -2
- package/docs/operations/connectors.athenaListInboxMessages.md +10 -2
- package/docs/operations/connectors.athenaListInsurance.md +10 -2
- package/docs/operations/connectors.athenaListLabAnalytes.md +10 -2
- package/docs/operations/connectors.athenaListLabResultDocuments.md +10 -2
- package/docs/operations/connectors.athenaListLabResults.md +10 -2
- package/docs/operations/connectors.athenaListMedicalHistoryQuestions.md +10 -2
- package/docs/operations/connectors.athenaListMedicationChanges.md +10 -2
- package/docs/operations/connectors.athenaListMedications.md +10 -2
- package/docs/operations/connectors.athenaListNewPatientAppointmentReasons.md +10 -2
- package/docs/operations/connectors.athenaListOpenClaims.md +10 -2
- package/docs/operations/connectors.athenaListOpenClaimsDetailed.md +10 -2
- package/docs/operations/connectors.athenaListPatientAppointmentReasons.md +10 -2
- package/docs/operations/connectors.athenaListPatientAppointments.md +10 -2
- package/docs/operations/connectors.athenaListPatients.md +10 -2
- package/docs/operations/connectors.athenaListPatientsByCustomField.md +10 -2
- package/docs/operations/connectors.athenaListPatientsByDepartment.md +10 -2
- package/docs/operations/connectors.athenaListPatientsByLastUpdatedRange.md +10 -2
- package/docs/operations/connectors.athenaListPhysicalTherapyEpisodes.md +10 -2
- package/docs/operations/connectors.athenaListPrescriptions.md +10 -2
- package/docs/operations/connectors.athenaListProblemChanges.md +10 -2
- package/docs/operations/connectors.athenaListProblems.md +10 -2
- package/docs/operations/connectors.athenaListProcedures.md +10 -2
- package/docs/operations/connectors.athenaListProviders.md +10 -2
- package/docs/operations/connectors.athenaListQuestionnaireScreeners.md +10 -2
- package/docs/operations/connectors.athenaListRaces.md +10 -2
- package/docs/operations/connectors.athenaListReferrals.md +10 -2
- package/docs/operations/connectors.athenaListSentMessages.md +10 -2
- package/docs/operations/connectors.athenaListSocialHistory.md +10 -2
- package/docs/operations/connectors.athenaListSocialHistoryQuestions.md +10 -2
- package/docs/operations/connectors.athenaListSurgicalHistory.md +10 -2
- package/docs/operations/connectors.athenaListVitals.md +10 -2
- package/docs/operations/connectors.athenaListVitalsCcda.md +10 -2
- package/docs/operations/connectors.athenaRetrieveAvailableAppointmentSlots.md +10 -2
- package/docs/operations/connectors.athenaSearchAllergens.md +10 -2
- package/docs/operations/connectors.athenaSearchClinicalProviders.md +10 -2
- package/docs/operations/connectors.athenaSearchMedications.md +10 -2
- package/docs/operations/connectors.athenaSearchPatients.md +10 -2
- package/docs/operations/connectors.athenaSendSecureMessage.md +10 -2
- package/docs/operations/connectors.athenaSetDefaultPharmacy.md +10 -2
- package/docs/operations/connectors.athenaSetEncounterReasonNote.md +10 -2
- package/docs/operations/connectors.athenaSubmitOrder.md +10 -2
- package/docs/operations/connectors.athenaSubmitQuestionnaireScreener.md +10 -2
- package/docs/operations/connectors.athenaSubmitScreenerQuestionnaireEncounter.md +10 -2
- package/docs/operations/connectors.athenaSubscribeAppointmentSlots.md +10 -2
- package/docs/operations/connectors.athenaSubscribeMedicationChanges.md +10 -2
- package/docs/operations/connectors.athenaUnsubscribeMedicationChanges.md +10 -2
- package/docs/operations/connectors.athenaUpdateAllergies.md +10 -2
- package/docs/operations/connectors.athenaUpdateAppointmentCustomField.md +10 -2
- package/docs/operations/connectors.athenaUpdateDriversLicense.md +10 -2
- package/docs/operations/connectors.athenaUpdateEncounterAssessment.md +10 -2
- package/docs/operations/connectors.athenaUpdateEncounterDiagnosis.md +10 -2
- package/docs/operations/connectors.athenaUpdateEncounterHpi.md +10 -2
- package/docs/operations/connectors.athenaUpdateInsuranceCard.md +10 -2
- package/docs/operations/connectors.athenaUpdateMedication.md +10 -2
- package/docs/operations/connectors.athenaUpdateMedicationsSection.md +10 -2
- package/docs/operations/connectors.athenaUpdatePatient.md +10 -2
- package/docs/operations/connectors.athenaUpdatePatientCcda.md +10 -2
- package/docs/operations/connectors.athenaUpdateProblemsSection.md +10 -2
- package/docs/operations/connectors.athenaUpdateReviewOfSystems.md +10 -2
- package/docs/operations/connectors.athenaUpdateSoapNote.md +10 -2
- package/docs/operations/connectors.athenaUpdateVaccine.md +10 -2
- package/docs/operations/connectors.athenaUpdateVital.md +10 -2
- package/docs/operations/connectors.athenaUploadDocument.md +10 -2
- package/docs/operations/connectors.athenaUploadImagingResultDocument.md +10 -2
- package/docs/operations/connectors.athenaUploadInsuranceCard.md +10 -2
- package/docs/operations/connectors.athenaUploadPatientPhoto.md +10 -2
- package/docs/operations/connectors.athenaUploadPrescriptionCardImage.md +10 -2
- package/docs/operations/connectors.calAssignScheduleToEventType.md +10 -2
- package/docs/operations/connectors.calCreateBooking.md +10 -2
- package/docs/operations/connectors.calCreateSchedule.md +10 -2
- package/docs/operations/connectors.calGetAllBookings.md +10 -2
- package/docs/operations/connectors.calGetAvailableSlots.md +10 -2
- package/docs/operations/connectors.calGetEventTypes.md +10 -2
- package/docs/operations/connectors.calGetScheduleById.md +10 -2
- package/docs/operations/connectors.calGetScheduleForEventType.md +10 -2
- package/docs/operations/connectors.calSyncWithAthena.md +10 -2
- package/docs/operations/connectors.calUpdateAvailabilityFromAthenaSlots.md +10 -2
- package/docs/operations/connectors.calUpdateSchedule.md +10 -2
- package/docs/operations/connectors.carequalityDiscoverPatient.md +10 -2
- package/docs/operations/connectors.carequalityImportPatientDocuments.md +10 -2
- package/docs/operations/connectors.carequalityQueryDocuments.md +10 -2
- package/docs/operations/connectors.carequalityRetrieveDocuments.md +10 -2
- package/docs/operations/connectors.cmsGetCountyFips.md +10 -2
- package/docs/operations/connectors.cmsSearchHealthPlans.md +10 -2
- package/docs/operations/connectors.connectureCheckEligibility.md +10 -2
- package/docs/operations/connectors.connectureCreateSession.md +10 -2
- package/docs/operations/connectors.connectureEnroll.md +10 -2
- package/docs/operations/connectors.connectureGetAccessToken.md +10 -2
- package/docs/operations/connectors.connectureGetSession.md +10 -2
- package/docs/operations/connectors.connectureLookupPlans.md +10 -2
- package/docs/operations/connectors.connecturePlanCount.md +10 -2
- package/docs/operations/connectors.connectureSessionPlanById.md +10 -2
- package/docs/operations/connectors.connectureSessionPlans.md +10 -2
- package/docs/operations/connectors.connectureUpdateSession.md +10 -2
- package/docs/operations/connectors.elevenlabsCreateAgent.md +10 -2
- package/docs/operations/connectors.elevenlabsCreateTool.md +10 -2
- package/docs/operations/connectors.elevenlabsDeleteAgent.md +10 -2
- package/docs/operations/connectors.elevenlabsDeleteTool.md +10 -2
- package/docs/operations/connectors.elevenlabsDuplicateAgent.md +10 -2
- package/docs/operations/connectors.elevenlabsGetAgent.md +10 -2
- package/docs/operations/connectors.elevenlabsGetAllAgents.md +10 -2
- package/docs/operations/connectors.elevenlabsGetAllConversations.md +10 -2
- package/docs/operations/connectors.elevenlabsGetAllTools.md +10 -2
- package/docs/operations/connectors.elevenlabsGetConversation.md +10 -2
- package/docs/operations/connectors.elevenlabsGetTool.md +10 -2
- package/docs/operations/connectors.elevenlabsGetToolDependentAgents.md +10 -2
- package/docs/operations/connectors.elevenlabsGetUser.md +10 -2
- package/docs/operations/connectors.elevenlabsGetVoice.md +10 -2
- package/docs/operations/connectors.elevenlabsListVoices.md +10 -2
- package/docs/operations/connectors.elevenlabsSynthesize.md +10 -2
- package/docs/operations/connectors.elevenlabsUpdateAgent.md +10 -2
- package/docs/operations/connectors.elevenlabsUpdateTool.md +10 -2
- package/docs/operations/connectors.fedexCreateShipment.md +10 -2
- package/docs/operations/connectors.fedexTrackShipment.md +10 -2
- package/docs/operations/connectors.googleAiEmbed.md +10 -2
- package/docs/operations/connectors.googleAiGenerate.md +10 -2
- package/docs/operations/connectors.googleAiInvokeA1cVisionCapture.md +10 -2
- package/docs/operations/connectors.googlePlacesDetails.md +10 -2
- package/docs/operations/connectors.googlePlacesNearby.md +10 -2
- package/docs/operations/connectors.googlePlacesText.md +10 -2
- package/docs/operations/connectors.grokChooseEncounterReasonsFromList.md +10 -2
- package/docs/operations/connectors.grokChooseHealthServiceFromList.md +10 -2
- package/docs/operations/connectors.grokChooseTemplatesFromList.md +10 -2
- package/docs/operations/connectors.grokConvertCcdaToFhir.md +10 -2
- package/docs/operations/connectors.grokConvertFhirToCcda.md +10 -2
- package/docs/operations/connectors.grokConvertFhirToCcdaWithChunking.md +10 -2
- package/docs/operations/connectors.grokCreateClinicalNotes.md +10 -2
- package/docs/operations/connectors.grokCreateEhrSummary.md +10 -2
- package/docs/operations/connectors.grokCreateHpiSummary.md +10 -2
- package/docs/operations/connectors.grokCreateScreeningSummary.md +10 -2
- package/docs/operations/connectors.grokGeneralGrokRequest.md +10 -2
- package/docs/operations/connectors.grokGetUmlsCodes.md +10 -2
- package/docs/operations/connectors.healthieAcceptInsurancePlans.md +10 -2
- package/docs/operations/connectors.healthieAddDiagnosis.md +10 -2
- package/docs/operations/connectors.healthieAddPharmacy.md +10 -2
- package/docs/operations/connectors.healthieBulkApplyTags.md +10 -2
- package/docs/operations/connectors.healthieBulkUpdateClients.md +10 -2
- package/docs/operations/connectors.healthieBulkUpdateDiagnoses.md +10 -2
- package/docs/operations/connectors.healthieCloseConversation.md +10 -2
- package/docs/operations/connectors.healthieCompleteCcdaReconciliation.md +10 -2
- package/docs/operations/connectors.healthieCompleteCheckout.md +10 -2
- package/docs/operations/connectors.healthieCopyForm.md +10 -2
- package/docs/operations/connectors.healthieCopyOffering.md +10 -2
- package/docs/operations/connectors.healthieCreateApiKey.md +10 -2
- package/docs/operations/connectors.healthieCreateAppointment.md +10 -2
- package/docs/operations/connectors.healthieCreateAppointmentSetting.md +10 -2
- package/docs/operations/connectors.healthieCreateAppointmentType.md +10 -2
- package/docs/operations/connectors.healthieCreateAvailabilitiesBulk.md +10 -2
- package/docs/operations/connectors.healthieCreateAvailability.md +10 -2
- package/docs/operations/connectors.healthieCreateBillingItem.md +10 -2
- package/docs/operations/connectors.healthieCreateCarePlan.md +10 -2
- package/docs/operations/connectors.healthieCreateCms1500.md +10 -2
- package/docs/operations/connectors.healthieCreateCompletedOnboardingItem.md +10 -2
- package/docs/operations/connectors.healthieCreateConversation.md +10 -2
- package/docs/operations/connectors.healthieCreateEntry.md +10 -2
- package/docs/operations/connectors.healthieCreateEpisodeOfCare.md +10 -2
- package/docs/operations/connectors.healthieCreateFamilyHistory.md +10 -2
- package/docs/operations/connectors.healthieCreateForm.md +10 -2
- package/docs/operations/connectors.healthieCreateFormAnswerGroup.md +10 -2
- package/docs/operations/connectors.healthieCreateFormCompletionRequest.md +10 -2
- package/docs/operations/connectors.healthieCreateGoal.md +10 -2
- package/docs/operations/connectors.healthieCreateImmunization.md +10 -2
- package/docs/operations/connectors.healthieCreateInsurancePayment.md +10 -2
- package/docs/operations/connectors.healthieCreateInvoice.md +10 -2
- package/docs/operations/connectors.healthieCreateLabOrder.md +10 -2
- package/docs/operations/connectors.healthieCreateLocation.md +10 -2
- package/docs/operations/connectors.healthieCreateMedication.md +10 -2
- package/docs/operations/connectors.healthieCreateMetricEntry.md +10 -2
- package/docs/operations/connectors.healthieCreateNote.md +10 -2
- package/docs/operations/connectors.healthieCreateOffering.md +10 -2
- package/docs/operations/connectors.healthieCreateOnboardingFlow.md +10 -2
- package/docs/operations/connectors.healthieCreateOnboardingItem.md +10 -2
- package/docs/operations/connectors.healthieCreateOpenLoopForm.md +10 -2
- package/docs/operations/connectors.healthieCreateOrganizationMembership.md +10 -2
- package/docs/operations/connectors.healthieCreatePatient.md +10 -2
- package/docs/operations/connectors.healthieCreatePersonalizationQuestionnaire.md +10 -2
- package/docs/operations/connectors.healthieCreateProgram.md +10 -2
- package/docs/operations/connectors.healthieCreateRupaOrder.md +10 -2
- package/docs/operations/connectors.healthieCreateSuperBill.md +10 -2
- package/docs/operations/connectors.healthieCreateTag.md +10 -2
- package/docs/operations/connectors.healthieCreateTask.md +10 -2
- package/docs/operations/connectors.healthieCreateUserGroup.md +10 -2
- package/docs/operations/connectors.healthieDeleteApiKey.md +10 -2
- package/docs/operations/connectors.healthieDeleteAppointment.md +10 -2
- package/docs/operations/connectors.healthieDeleteAppointmentType.md +10 -2
- package/docs/operations/connectors.healthieDeleteAvailability.md +10 -2
- package/docs/operations/connectors.healthieDeleteBillingItem.md +10 -2
- package/docs/operations/connectors.healthieDeleteCarePlan.md +10 -2
- package/docs/operations/connectors.healthieDeleteCms1500.md +10 -2
- package/docs/operations/connectors.healthieDeleteDocument.md +10 -2
- package/docs/operations/connectors.healthieDeleteEntry.md +10 -2
- package/docs/operations/connectors.healthieDeleteEpisodeOfCare.md +10 -2
- package/docs/operations/connectors.healthieDeleteFamilyHistory.md +10 -2
- package/docs/operations/connectors.healthieDeleteForm.md +10 -2
- package/docs/operations/connectors.healthieDeleteFormCompletionRequest.md +10 -2
- package/docs/operations/connectors.healthieDeleteGoal.md +10 -2
- package/docs/operations/connectors.healthieDeleteInvoice.md +10 -2
- package/docs/operations/connectors.healthieDeleteManualInsurancePayment.md +10 -2
- package/docs/operations/connectors.healthieDeleteMedication.md +10 -2
- package/docs/operations/connectors.healthieDeleteOffering.md +10 -2
- package/docs/operations/connectors.healthieDeleteOnboardingFlow.md +10 -2
- package/docs/operations/connectors.healthieDeleteOnboardingItem.md +10 -2
- package/docs/operations/connectors.healthieDeleteOrganizationMembership.md +10 -2
- package/docs/operations/connectors.healthieDeleteProgram.md +10 -2
- package/docs/operations/connectors.healthieDeleteSuperBill.md +10 -2
- package/docs/operations/connectors.healthieDeleteTag.md +10 -2
- package/docs/operations/connectors.healthieDeleteTask.md +10 -2
- package/docs/operations/connectors.healthieDeleteUserGroup.md +10 -2
- package/docs/operations/connectors.healthieEditAvailability.md +10 -2
- package/docs/operations/connectors.healthieFillLabResultReviewForm.md +10 -2
- package/docs/operations/connectors.healthieFindAndBookFirstAvailableSlot.md +10 -2
- package/docs/operations/connectors.healthieGetApiKeys.md +10 -2
- package/docs/operations/connectors.healthieGetAppointment.md +10 -2
- package/docs/operations/connectors.healthieGetAppointmentBookingWarnings.md +10 -2
- package/docs/operations/connectors.healthieGetAppointmentSetting.md +10 -2
- package/docs/operations/connectors.healthieGetAppointmentType.md +10 -2
- package/docs/operations/connectors.healthieGetAppointmentTypes.md +10 -2
- package/docs/operations/connectors.healthieGetAppointments.md +10 -2
- package/docs/operations/connectors.healthieGetAvailabilities.md +10 -2
- package/docs/operations/connectors.healthieGetAvailability.md +10 -2
- package/docs/operations/connectors.healthieGetAvailableItemTypes.md +10 -2
- package/docs/operations/connectors.healthieGetAvailableSlotsForRange.md +10 -2
- package/docs/operations/connectors.healthieGetBillingItem.md +10 -2
- package/docs/operations/connectors.healthieGetBillingItems.md +10 -2
- package/docs/operations/connectors.healthieGetCarePlan.md +10 -2
- package/docs/operations/connectors.healthieGetCarePlans.md +10 -2
- package/docs/operations/connectors.healthieGetCms1500.md +10 -2
- package/docs/operations/connectors.healthieGetCms1500s.md +10 -2
- package/docs/operations/connectors.healthieGetConversation.md +10 -2
- package/docs/operations/connectors.healthieGetConversationMemberships.md +10 -2
- package/docs/operations/connectors.healthieGetCurrentUser.md +10 -2
- package/docs/operations/connectors.healthieGetCurrentUserId.md +10 -2
- package/docs/operations/connectors.healthieGetDaysAvailableForRange.md +10 -2
- package/docs/operations/connectors.healthieGetDietitianId.md +10 -2
- package/docs/operations/connectors.healthieGetDocument.md +10 -2
- package/docs/operations/connectors.healthieGetDocuments.md +10 -2
- package/docs/operations/connectors.healthieGetEntries.md +10 -2
- package/docs/operations/connectors.healthieGetEntry.md +10 -2
- package/docs/operations/connectors.healthieGetEpisodesOfCare.md +10 -2
- package/docs/operations/connectors.healthieGetForm.md +10 -2
- package/docs/operations/connectors.healthieGetFormAnswerGroups.md +10 -2
- package/docs/operations/connectors.healthieGetFormCompletionRequests.md +10 -2
- package/docs/operations/connectors.healthieGetForms.md +10 -2
- package/docs/operations/connectors.healthieGetGoal.md +10 -2
- package/docs/operations/connectors.healthieGetGoalHistories.md +10 -2
- package/docs/operations/connectors.healthieGetGoals.md +10 -2
- package/docs/operations/connectors.healthieGetInsurancePayments.md +10 -2
- package/docs/operations/connectors.healthieGetInsurancePlans.md +10 -2
- package/docs/operations/connectors.healthieGetInvoice.md +10 -2
- package/docs/operations/connectors.healthieGetInvoices.md +10 -2
- package/docs/operations/connectors.healthieGetLabOrder.md +10 -2
- package/docs/operations/connectors.healthieGetLabOrders.md +10 -2
- package/docs/operations/connectors.healthieGetLabResult.md +10 -2
- package/docs/operations/connectors.healthieGetMedications.md +10 -2
- package/docs/operations/connectors.healthieGetMetricEntries.md +10 -2
- package/docs/operations/connectors.healthieGetOffering.md +10 -2
- package/docs/operations/connectors.healthieGetOfferings.md +10 -2
- package/docs/operations/connectors.healthieGetOnboardingFlow.md +10 -2
- package/docs/operations/connectors.healthieGetOnboardingFlows.md +10 -2
- package/docs/operations/connectors.healthieGetOnboardingItem.md +10 -2
- package/docs/operations/connectors.healthieGetOrganization.md +10 -2
- package/docs/operations/connectors.healthieGetOrganizationDetailed.md +10 -2
- package/docs/operations/connectors.healthieGetOrganizationMembers.md +10 -2
- package/docs/operations/connectors.healthieGetPatient.md +10 -2
- package/docs/operations/connectors.healthieGetPatientDefaultPharmacy.md +10 -2
- package/docs/operations/connectors.healthieGetPatientDiagnoses.md +10 -2
- package/docs/operations/connectors.healthieGetPatientDocuments.md +10 -2
- package/docs/operations/connectors.healthieGetPatientEncounter.md +10 -2
- package/docs/operations/connectors.healthieGetPatientImmunizations.md +10 -2
- package/docs/operations/connectors.healthieGetPatientJson.md +10 -2
- package/docs/operations/connectors.healthieGetPatientNotes.md +10 -2
- package/docs/operations/connectors.healthieGetPatientProblems.md +10 -2
- package/docs/operations/connectors.healthieGetPharmacy.md +10 -2
- package/docs/operations/connectors.healthieGetProgram.md +10 -2
- package/docs/operations/connectors.healthieGetPrograms.md +10 -2
- package/docs/operations/connectors.healthieGetProvider.md +10 -2
- package/docs/operations/connectors.healthieGetReceivedFax.md +10 -2
- package/docs/operations/connectors.healthieGetReceivedFaxes.md +10 -2
- package/docs/operations/connectors.healthieGetSentFax.md +10 -2
- package/docs/operations/connectors.healthieGetSentFaxes.md +10 -2
- package/docs/operations/connectors.healthieGetSuperBill.md +10 -2
- package/docs/operations/connectors.healthieGetSuperBills.md +10 -2
- package/docs/operations/connectors.healthieGetTags.md +10 -2
- package/docs/operations/connectors.healthieGetTask.md +10 -2
- package/docs/operations/connectors.healthieGetTasks.md +10 -2
- package/docs/operations/connectors.healthieGetUnassociatedCompletedOnboardingItems.md +10 -2
- package/docs/operations/connectors.healthieGetUserGroup.md +10 -2
- package/docs/operations/connectors.healthieGetUserGroups.md +10 -2
- package/docs/operations/connectors.healthieLinkEncountersToEpisode.md +10 -2
- package/docs/operations/connectors.healthieListOrganizationMembers.md +10 -2
- package/docs/operations/connectors.healthieListPatients.md +10 -2
- package/docs/operations/connectors.healthieMarkTasksAsSeen.md +10 -2
- package/docs/operations/connectors.healthieParseCcdaDocument.md +10 -2
- package/docs/operations/connectors.healthieRemoveAcceptedInsurancePlan.md +10 -2
- package/docs/operations/connectors.healthieRemoveAppliedTag.md +10 -2
- package/docs/operations/connectors.healthieRemoveDiagnosis.md +10 -2
- package/docs/operations/connectors.healthieSearchPatients.md +10 -2
- package/docs/operations/connectors.healthieSearchPharmacies.md +10 -2
- package/docs/operations/connectors.healthieSendChatMessage.md +10 -2
- package/docs/operations/connectors.healthieSendFax.md +10 -2
- package/docs/operations/connectors.healthieShareForm.md +10 -2
- package/docs/operations/connectors.healthieSignUpPatient.md +10 -2
- package/docs/operations/connectors.healthieStorePaymentCard.md +10 -2
- package/docs/operations/connectors.healthieUnlinkEncountersFromEpisode.md +10 -2
- package/docs/operations/connectors.healthieUpdateAppointment.md +10 -2
- package/docs/operations/connectors.healthieUpdateAppointmentSetting.md +10 -2
- package/docs/operations/connectors.healthieUpdateAppointmentType.md +10 -2
- package/docs/operations/connectors.healthieUpdateBillingItem.md +10 -2
- package/docs/operations/connectors.healthieUpdateCarePlan.md +10 -2
- package/docs/operations/connectors.healthieUpdateCms1500.md +10 -2
- package/docs/operations/connectors.healthieUpdateConversation.md +10 -2
- package/docs/operations/connectors.healthieUpdateDiagnosis.md +10 -2
- package/docs/operations/connectors.healthieUpdateDocument.md +10 -2
- package/docs/operations/connectors.healthieUpdateEntry.md +10 -2
- package/docs/operations/connectors.healthieUpdateEpisodeOfCare.md +10 -2
- package/docs/operations/connectors.healthieUpdateFamilyHistory.md +10 -2
- package/docs/operations/connectors.healthieUpdateForm.md +10 -2
- package/docs/operations/connectors.healthieUpdateGoal.md +10 -2
- package/docs/operations/connectors.healthieUpdateImmunization.md +10 -2
- package/docs/operations/connectors.healthieUpdateInsurancePaymentDepositStatus.md +10 -2
- package/docs/operations/connectors.healthieUpdateInvoice.md +10 -2
- package/docs/operations/connectors.healthieUpdateLabOrder.md +10 -2
- package/docs/operations/connectors.healthieUpdateLocation.md +10 -2
- package/docs/operations/connectors.healthieUpdateManualInsurancePayment.md +10 -2
- package/docs/operations/connectors.healthieUpdateMedication.md +10 -2
- package/docs/operations/connectors.healthieUpdateOffering.md +10 -2
- package/docs/operations/connectors.healthieUpdateOnboardingFlow.md +10 -2
- package/docs/operations/connectors.healthieUpdateOnboardingItem.md +10 -2
- package/docs/operations/connectors.healthieUpdateOrganizationMembership.md +10 -2
- package/docs/operations/connectors.healthieUpdatePatient.md +10 -2
- package/docs/operations/connectors.healthieUpdatePatientInsuranceBilling.md +10 -2
- package/docs/operations/connectors.healthieUpdateProgram.md +10 -2
- package/docs/operations/connectors.healthieUpdateSuperBill.md +10 -2
- package/docs/operations/connectors.healthieUpdateTag.md +10 -2
- package/docs/operations/connectors.healthieUpdateTask.md +10 -2
- package/docs/operations/connectors.healthieUpdateUser.md +10 -2
- package/docs/operations/connectors.healthieUpdateUserGroup.md +10 -2
- package/docs/operations/connectors.impiloAssociateDevice.md +10 -2
- package/docs/operations/connectors.impiloCreateItem.md +10 -2
- package/docs/operations/connectors.impiloCreateOrder.md +10 -2
- package/docs/operations/connectors.impiloCreatePatient.md +10 -2
- package/docs/operations/connectors.impiloCreateProcurement.md +10 -2
- package/docs/operations/connectors.impiloDisableReadings.md +10 -2
- package/docs/operations/connectors.impiloDisassociateDevice.md +10 -2
- package/docs/operations/connectors.impiloEnableReadings.md +10 -2
- package/docs/operations/connectors.impiloFetchProcurementDocument.md +10 -2
- package/docs/operations/connectors.impiloGetBloodGlucoseReading.md +10 -2
- package/docs/operations/connectors.impiloGetBloodOxygenReading.md +10 -2
- package/docs/operations/connectors.impiloGetBloodPressureReading.md +10 -2
- package/docs/operations/connectors.impiloGetClinicalNote.md +10 -2
- package/docs/operations/connectors.impiloGetDevice.md +10 -2
- package/docs/operations/connectors.impiloGetGlobalAlertConfig.md +10 -2
- package/docs/operations/connectors.impiloGetHeartRateReading.md +10 -2
- package/docs/operations/connectors.impiloGetItem.md +10 -2
- package/docs/operations/connectors.impiloGetKit.md +10 -2
- package/docs/operations/connectors.impiloGetOrder.md +10 -2
- package/docs/operations/connectors.impiloGetOrderSummary.md +10 -2
- package/docs/operations/connectors.impiloGetPatient.md +10 -2
- package/docs/operations/connectors.impiloGetPatientAlertConfig.md +10 -2
- package/docs/operations/connectors.impiloGetSiteAlertConfig.md +10 -2
- package/docs/operations/connectors.impiloGetTemperatureReading.md +10 -2
- package/docs/operations/connectors.impiloGetWeightReading.md +10 -2
- package/docs/operations/connectors.impiloLinkKitToPatient.md +10 -2
- package/docs/operations/connectors.impiloListBloodGlucoseReadings.md +10 -2
- package/docs/operations/connectors.impiloListBloodOxygenReadings.md +10 -2
- package/docs/operations/connectors.impiloListBloodPressureReadings.md +10 -2
- package/docs/operations/connectors.impiloListClinicalNotes.md +10 -2
- package/docs/operations/connectors.impiloListDevices.md +10 -2
- package/docs/operations/connectors.impiloListHeartRateReadings.md +10 -2
- package/docs/operations/connectors.impiloListItems.md +10 -2
- package/docs/operations/connectors.impiloListKitInventory.md +10 -2
- package/docs/operations/connectors.impiloListKits.md +10 -2
- package/docs/operations/connectors.impiloListOrders.md +10 -2
- package/docs/operations/connectors.impiloListPatients.md +10 -2
- package/docs/operations/connectors.impiloListProcurements.md +10 -2
- package/docs/operations/connectors.impiloListSiteInventory.md +10 -2
- package/docs/operations/connectors.impiloListSpirometryReadings.md +10 -2
- package/docs/operations/connectors.impiloListTemperatureReadings.md +10 -2
- package/docs/operations/connectors.impiloListWeightReadings.md +10 -2
- package/docs/operations/connectors.impiloRecordBloodGlucoseReading.md +10 -2
- package/docs/operations/connectors.impiloRecordBloodOxygenReading.md +10 -2
- package/docs/operations/connectors.impiloRecordBloodPressureReading.md +10 -2
- package/docs/operations/connectors.impiloRecordHeartRateReading.md +10 -2
- package/docs/operations/connectors.impiloRecordTemperatureReading.md +10 -2
- package/docs/operations/connectors.impiloRecordWeightReading.md +10 -2
- package/docs/operations/connectors.impiloRegisterWebhooks.md +10 -2
- package/docs/operations/connectors.impiloSetGlobalAlertConfig.md +10 -2
- package/docs/operations/connectors.impiloSetPatientAlertConfig.md +10 -2
- package/docs/operations/connectors.impiloSetSiteAlertConfig.md +10 -2
- package/docs/operations/connectors.impiloUnlinkKitFromPatient.md +10 -2
- package/docs/operations/connectors.impiloUpdatePatient.md +10 -2
- package/docs/operations/connectors.impiloValidateDevice.md +10 -2
- package/docs/operations/connectors.junctionGetOrders.md +10 -2
- package/docs/operations/connectors.junctionGetTests.md +10 -2
- package/docs/operations/connectors.junctionOrderTestkit.md +10 -2
- package/docs/operations/connectors.junctionRegisterTestkit.md +10 -2
- package/docs/operations/connectors.nppesGetProvider.md +10 -2
- package/docs/operations/connectors.nppesSearchProviders.md +10 -2
- package/docs/operations/connectors.nppesVerifyProvider.md +10 -2
- package/docs/operations/connectors.openaiBuildResponseCreatePayload.md +10 -2
- package/docs/operations/connectors.openaiChat.md +10 -2
- package/docs/operations/connectors.openaiChatJson.md +10 -2
- package/docs/operations/connectors.openaiCreateAssistant.md +10 -2
- package/docs/operations/connectors.openaiDeleteAssistant.md +10 -2
- package/docs/operations/connectors.openaiEmbed.md +10 -2
- package/docs/operations/connectors.openaiGetAssistant.md +10 -2
- package/docs/operations/connectors.openaiModerate.md +10 -2
- package/docs/operations/connectors.openaiUpdateAssistant.md +10 -2
- package/docs/operations/connectors.ouraBuildAuthorizationUrl.md +10 -2
- package/docs/operations/connectors.ouraExchangeAuthorizationCode.md +10 -2
- package/docs/operations/connectors.ouraGetAllSleeps.md +10 -2
- package/docs/operations/connectors.ouraGetDailyActivities.md +10 -2
- package/docs/operations/connectors.ouraGetDailyActivity.md +10 -2
- package/docs/operations/connectors.ouraGetDailyCardiovascularAge.md +10 -2
- package/docs/operations/connectors.ouraGetDailyReadiness.md +10 -2
- package/docs/operations/connectors.ouraGetDailyReadinessById.md +10 -2
- package/docs/operations/connectors.ouraGetDailyResilience.md +10 -2
- package/docs/operations/connectors.ouraGetDailySleep.md +10 -2
- package/docs/operations/connectors.ouraGetDailySleeps.md +10 -2
- package/docs/operations/connectors.ouraGetDailySpo2.md +10 -2
- package/docs/operations/connectors.ouraGetDailyStress.md +10 -2
- package/docs/operations/connectors.ouraGetEnhancedTags.md +10 -2
- package/docs/operations/connectors.ouraGetHeartRates.md +10 -2
- package/docs/operations/connectors.ouraGetPersonalInfo.md +10 -2
- package/docs/operations/connectors.ouraGetRestModePeriods.md +10 -2
- package/docs/operations/connectors.ouraGetRingConfigurations.md +10 -2
- package/docs/operations/connectors.ouraGetSessions.md +10 -2
- package/docs/operations/connectors.ouraGetSleep.md +10 -2
- package/docs/operations/connectors.ouraGetSleepTimes.md +10 -2
- package/docs/operations/connectors.ouraGetSleeps.md +10 -2
- package/docs/operations/connectors.ouraGetTags.md +10 -2
- package/docs/operations/connectors.ouraGetVo2Max.md +10 -2
- package/docs/operations/connectors.ouraGetWorkout.md +10 -2
- package/docs/operations/connectors.ouraGetWorkouts.md +10 -2
- package/docs/operations/connectors.ouraRefreshAccessToken.md +10 -2
- package/docs/operations/connectors.plaidCreateIdentityVerification.md +10 -2
- package/docs/operations/connectors.plaidGetIdentityVerification.md +10 -2
- package/docs/operations/connectors.plaidListIdentityVerifications.md +10 -2
- package/docs/operations/connectors.questAcknowledgeCompendium.md +10 -2
- package/docs/operations/connectors.questAcknowledgeHl7Results.md +10 -2
- package/docs/operations/connectors.questAcknowledgeObservationResults.md +10 -2
- package/docs/operations/connectors.questAcknowledgePrintableResults.md +10 -2
- package/docs/operations/connectors.questBuildResultsAck.md +10 -2
- package/docs/operations/connectors.questClearTokenCache.md +10 -2
- package/docs/operations/connectors.questCreateOrder.md +10 -2
- package/docs/operations/connectors.questEvaluateAbn.md +10 -2
- package/docs/operations/connectors.questEvaluateAoe.md +10 -2
- package/docs/operations/connectors.questGetAccessToken.md +10 -2
- package/docs/operations/connectors.questGetHl7Results.md +10 -2
- package/docs/operations/connectors.questGetObservationResults.md +10 -2
- package/docs/operations/connectors.questGetOrderDocuments.md +10 -2
- package/docs/operations/connectors.questGetPrintableResults.md +10 -2
- package/docs/operations/connectors.questGetRequisition.md +10 -2
- package/docs/operations/connectors.questGetResults.md +10 -2
- package/docs/operations/connectors.questListTests.md +10 -2
- package/docs/operations/connectors.questProcessPushedResult.md +10 -2
- package/docs/operations/connectors.questRequestCompendiums.md +10 -2
- package/docs/operations/connectors.questRequestCompendiumsOnDemand.md +10 -2
- package/docs/operations/connectors.questRetrieveAndExtractCompendium.md +10 -2
- package/docs/operations/connectors.questRetrieveCompendium.md +10 -2
- package/docs/operations/connectors.questSubmitFullOrder.md +10 -2
- package/docs/operations/connectors.questSubmitOrder.md +10 -2
- package/docs/operations/connectors.questSyncCompendiums.md +10 -2
- package/docs/operations/connectors.salesforceBuildCaseDescription.md +10 -2
- package/docs/operations/connectors.salesforceCreate.md +10 -2
- package/docs/operations/connectors.salesforceCreateAccount.md +10 -2
- package/docs/operations/connectors.salesforceCreateCallLog.md +10 -2
- package/docs/operations/connectors.salesforceCreateCampaign.md +10 -2
- package/docs/operations/connectors.salesforceCreateCase.md +10 -2
- package/docs/operations/connectors.salesforceCreateContact.md +10 -2
- package/docs/operations/connectors.salesforceCreateEvent.md +10 -2
- package/docs/operations/connectors.salesforceCreatePatient.md +10 -2
- package/docs/operations/connectors.salesforceCreateSegment.md +10 -2
- package/docs/operations/connectors.salesforceDeleteAccount.md +10 -2
- package/docs/operations/connectors.salesforceDeleteCallLog.md +10 -2
- package/docs/operations/connectors.salesforceDeleteCampaign.md +10 -2
- package/docs/operations/connectors.salesforceDeleteCase.md +10 -2
- package/docs/operations/connectors.salesforceDeleteEvent.md +10 -2
- package/docs/operations/connectors.salesforceDeletePatient.md +10 -2
- package/docs/operations/connectors.salesforceDeleteSegment.md +10 -2
- package/docs/operations/connectors.salesforceDescribe.md +10 -2
- package/docs/operations/connectors.salesforceGet.md +10 -2
- package/docs/operations/connectors.salesforceGetAccount.md +10 -2
- package/docs/operations/connectors.salesforceGetAccountByTenant.md +10 -2
- package/docs/operations/connectors.salesforceGetAvailableSlots.md +10 -2
- package/docs/operations/connectors.salesforceGetCallLog.md +10 -2
- package/docs/operations/connectors.salesforceGetCampaign.md +10 -2
- package/docs/operations/connectors.salesforceGetCase.md +10 -2
- package/docs/operations/connectors.salesforceGetConfiguration.md +10 -2
- package/docs/operations/connectors.salesforceGetContact.md +10 -2
- package/docs/operations/connectors.salesforceGetEvent.md +10 -2
- package/docs/operations/connectors.salesforceGetHealthcareOrgIdByTenant.md +10 -2
- package/docs/operations/connectors.salesforceGetNotScheduledEvents.md +10 -2
- package/docs/operations/connectors.salesforceGetPatient.md +10 -2
- package/docs/operations/connectors.salesforceGetPatientByEmail.md +10 -2
- package/docs/operations/connectors.salesforceGetPatientByPhone.md +10 -2
- package/docs/operations/connectors.salesforceGetSegment.md +10 -2
- package/docs/operations/connectors.salesforceListAccounts.md +10 -2
- package/docs/operations/connectors.salesforceListCallLogs.md +10 -2
- package/docs/operations/connectors.salesforceListCampaigns.md +10 -2
- package/docs/operations/connectors.salesforceListCases.md +10 -2
- package/docs/operations/connectors.salesforceListEvents.md +10 -2
- package/docs/operations/connectors.salesforceListPatients.md +10 -2
- package/docs/operations/connectors.salesforceListSegments.md +10 -2
- package/docs/operations/connectors.salesforceQuery.md +10 -2
- package/docs/operations/connectors.salesforceScheduleEvent.md +10 -2
- package/docs/operations/connectors.salesforceSetAccountSenaiteId.md +10 -2
- package/docs/operations/connectors.salesforceUpdate.md +10 -2
- package/docs/operations/connectors.salesforceUpdateAccount.md +10 -2
- package/docs/operations/connectors.salesforceUpdateAccountAssets.md +10 -2
- package/docs/operations/connectors.salesforceUpdateCallLog.md +10 -2
- package/docs/operations/connectors.salesforceUpdateCampaign.md +10 -2
- package/docs/operations/connectors.salesforceUpdatePatient.md +10 -2
- package/docs/operations/connectors.salesforceUpdateSegment.md +10 -2
- package/docs/operations/connectors.scrapflyGetDocumentLinks.md +10 -2
- package/docs/operations/connectors.scrapflyScrape.md +10 -2
- package/docs/operations/connectors.senaiteCancelSample.md +10 -2
- package/docs/operations/connectors.senaiteCreateAnalysisCategory.md +10 -2
- package/docs/operations/connectors.senaiteCreateAnalysisService.md +10 -2
- package/docs/operations/connectors.senaiteCreateClient.md +10 -2
- package/docs/operations/connectors.senaiteCreateContact.md +10 -2
- package/docs/operations/connectors.senaiteCreateDepartment.md +10 -2
- package/docs/operations/connectors.senaiteCreateSample.md +10 -2
- package/docs/operations/connectors.senaiteCreateSampleType.md +10 -2
- package/docs/operations/connectors.senaiteDeactivateClient.md +10 -2
- package/docs/operations/connectors.senaiteEnsureSenaiteClientForTenant.md +10 -2
- package/docs/operations/connectors.senaiteGetAllClients.md +10 -2
- package/docs/operations/connectors.senaiteGetAllSamples.md +10 -2
- package/docs/operations/connectors.senaiteGetAnalysisServices.md +10 -2
- package/docs/operations/connectors.senaiteGetCatalogs.md +10 -2
- package/docs/operations/connectors.senaiteGetClientById.md +10 -2
- package/docs/operations/connectors.senaiteGetClientByUid.md +10 -2
- package/docs/operations/connectors.senaiteGetContactsForClient.md +10 -2
- package/docs/operations/connectors.senaiteGetCurrentUser.md +10 -2
- package/docs/operations/connectors.senaiteGetSampleById.md +10 -2
- package/docs/operations/connectors.senaiteGetSampleByUid.md +10 -2
- package/docs/operations/connectors.senaiteGetSampleTypes.md +10 -2
- package/docs/operations/connectors.senaiteGetSamplesByClientId.md +10 -2
- package/docs/operations/connectors.senaiteLogin.md +10 -2
- package/docs/operations/connectors.senaiteLogout.md +10 -2
- package/docs/operations/connectors.senaiteSearch.md +10 -2
- package/docs/operations/connectors.senaiteUpdateClient.md +10 -2
- package/docs/operations/connectors.senaiteUpdateSample.md +10 -2
- package/docs/operations/connectors.sendgridListTemplates.md +10 -2
- package/docs/operations/connectors.sendgridSend.md +10 -2
- package/docs/operations/connectors.steadymdAddAllergyIntolerance.md +10 -2
- package/docs/operations/connectors.steadymdClaimIdentityVerification.md +10 -2
- package/docs/operations/connectors.steadymdCreateConsult.md +10 -2
- package/docs/operations/connectors.steadymdCreateConsultIssue.md +10 -2
- package/docs/operations/connectors.steadymdCreateEpisode.md +10 -2
- package/docs/operations/connectors.steadymdCreateEpisodeLabRequisition.md +10 -2
- package/docs/operations/connectors.steadymdCreateIntake.md +10 -2
- package/docs/operations/connectors.steadymdCreateLabOrder.md +10 -2
- package/docs/operations/connectors.steadymdCreateLabOrderResult.md +10 -2
- package/docs/operations/connectors.steadymdCreateMessage.md +10 -2
- package/docs/operations/connectors.steadymdCreatePatient.md +10 -2
- package/docs/operations/connectors.steadymdGetClinician.md +10 -2
- package/docs/operations/connectors.steadymdGetConsult.md +10 -2
- package/docs/operations/connectors.steadymdGetConsultAvailability.md +10 -2
- package/docs/operations/connectors.steadymdGetConsultPatientUi.md +10 -2
- package/docs/operations/connectors.steadymdGetEpisode.md +10 -2
- package/docs/operations/connectors.steadymdGetEpisodeLabRequisition.md +10 -2
- package/docs/operations/connectors.steadymdGetEpisodeSignedDocuments.md +10 -2
- package/docs/operations/connectors.steadymdGetIntake.md +10 -2
- package/docs/operations/connectors.steadymdGetLabOrder.md +10 -2
- package/docs/operations/connectors.steadymdGetLabOrderPdf.md +10 -2
- package/docs/operations/connectors.steadymdGetLabOrderResult.md +10 -2
- package/docs/operations/connectors.steadymdGetLabResultPdf.md +10 -2
- package/docs/operations/connectors.steadymdGetMessage.md +10 -2
- package/docs/operations/connectors.steadymdGetPatient.md +10 -2
- package/docs/operations/connectors.steadymdGetProgram.md +10 -2
- package/docs/operations/connectors.steadymdGetProgramAppointments.md +10 -2
- package/docs/operations/connectors.steadymdGetProgramConsultOptions.md +10 -2
- package/docs/operations/connectors.steadymdGetProgramLabs.md +10 -2
- package/docs/operations/connectors.steadymdListConsults.md +10 -2
- package/docs/operations/connectors.steadymdListIntakes.md +10 -2
- package/docs/operations/connectors.steadymdListLabOrderResults.md +10 -2
- package/docs/operations/connectors.steadymdListLabOrders.md +10 -2
- package/docs/operations/connectors.steadymdListMessages.md +10 -2
- package/docs/operations/connectors.steadymdListPharmacies.md +10 -2
- package/docs/operations/connectors.steadymdListProgramClinicians.md +10 -2
- package/docs/operations/connectors.steadymdListPrograms.md +10 -2
- package/docs/operations/connectors.steadymdPatchEpisode.md +10 -2
- package/docs/operations/connectors.steadymdScheduleConsultAppointment.md +10 -2
- package/docs/operations/connectors.steadymdSendConsultMessage.md +10 -2
- package/docs/operations/connectors.steadymdUpdateConsultStatus.md +10 -2
- package/docs/operations/connectors.steadymdUpdateEpisode.md +10 -2
- package/docs/operations/connectors.steadymdUpdateIntake.md +10 -2
- package/docs/operations/connectors.stediCheckClaimStatus.md +10 -2
- package/docs/operations/connectors.stediCheckCoordinationOfBenefits.md +10 -2
- package/docs/operations/connectors.stediDiscoverInsurance.md +10 -2
- package/docs/operations/connectors.stediEligibility.md +10 -2
- package/docs/operations/connectors.stediGet835EraReport.md +10 -2
- package/docs/operations/connectors.stediGetInsuranceDiscoveryResults.md +10 -2
- package/docs/operations/connectors.stediSubmitClaim.md +10 -2
- package/docs/operations/connectors.stediSubmitInstitutionalClaim.md +10 -2
- package/docs/operations/connectors.stediSubmitProfessionalClaim.md +10 -2
- package/docs/operations/connectors.stediVerifyProvider.md +10 -2
- package/docs/operations/connectors.stripeChargePaymentSession.md +10 -2
- package/docs/operations/connectors.stripeCreateCopayPrice.md +10 -2
- package/docs/operations/connectors.stripeCreateCustomer.md +10 -2
- package/docs/operations/connectors.stripeCreatePaymentIntent.md +10 -2
- package/docs/operations/connectors.stripeCreateSession.md +10 -2
- package/docs/operations/connectors.stripeCreateSubscription.md +10 -2
- package/docs/operations/connectors.stripeGetPaymentIntentStatus.md +10 -2
- package/docs/operations/connectors.stripeListProducts.md +10 -2
- package/docs/operations/connectors.stripeValidateAndTokenizeCard.md +10 -2
- package/docs/operations/connectors.stripeVerifyConnection.md +10 -2
- package/docs/operations/connectors.twilioGetMessage.md +10 -2
- package/docs/operations/connectors.twilioListMessages.md +10 -2
- package/docs/operations/connectors.twilioSendSms.md +10 -2
- package/docs/operations/connectors.uberCancelDelivery.md +10 -2
- package/docs/operations/connectors.uberCreateDelivery.md +10 -2
- package/docs/operations/connectors.uberCreateQuote.md +10 -2
- package/docs/operations/connectors.uberFindStores.md +10 -2
- package/docs/operations/connectors.uberGetDeliveries.md +10 -2
- package/docs/operations/connectors.uberGetDelivery.md +10 -2
- package/docs/operations/connectors.uberGetUndeliveredOrders.md +10 -2
- package/docs/operations/connectors.uberUpdateDelivery.md +10 -2
- package/docs/operations/connectors.whoopAddTestData.md +10 -2
- package/docs/operations/connectors.whoopBuildAuthorizationUrl.md +10 -2
- package/docs/operations/connectors.whoopExchangeAuthorizationCode.md +10 -2
- package/docs/operations/connectors.whoopGetActivityMapping.md +10 -2
- package/docs/operations/connectors.whoopGetAllCycles.md +10 -2
- package/docs/operations/connectors.whoopGetAllRecoveries.md +10 -2
- package/docs/operations/connectors.whoopGetAllSleeps.md +10 -2
- package/docs/operations/connectors.whoopGetAllWorkouts.md +10 -2
- package/docs/operations/connectors.whoopGetCycle.md +10 -2
- package/docs/operations/connectors.whoopGetCycles.md +10 -2
- package/docs/operations/connectors.whoopGetLabRequisition.md +10 -2
- package/docs/operations/connectors.whoopGetPartnerToken.md +10 -2
- package/docs/operations/connectors.whoopGetRecoveries.md +10 -2
- package/docs/operations/connectors.whoopGetRecoveryForCycle.md +10 -2
- package/docs/operations/connectors.whoopGetServiceRequest.md +10 -2
- package/docs/operations/connectors.whoopGetSleep.md +10 -2
- package/docs/operations/connectors.whoopGetSleepForCycle.md +10 -2
- package/docs/operations/connectors.whoopGetSleeps.md +10 -2
- package/docs/operations/connectors.whoopGetUserBodyMeasurement.md +10 -2
- package/docs/operations/connectors.whoopGetUserProfile.md +10 -2
- package/docs/operations/connectors.whoopGetWorkout.md +10 -2
- package/docs/operations/connectors.whoopGetWorkouts.md +10 -2
- package/docs/operations/connectors.whoopRefreshAccessToken.md +10 -2
- package/docs/operations/connectors.whoopRevokeUserOauthAccess.md +10 -2
- package/docs/operations/connectors.whoopSubmitVitalsFromDevice.md +10 -2
- package/docs/operations/connectors.whoopUpdateServiceRequestStatus.md +10 -2
- package/docs/operations/connectors.whoopUploadDiagnosticReportResults.md +10 -2
- package/docs/operations/connectors.zocdocBookAndConfirmAppointment.md +10 -2
- package/docs/operations/connectors.zocdocCancelAppointment.md +10 -2
- package/docs/operations/connectors.zocdocConfirmAppointment.md +10 -2
- package/docs/operations/connectors.zocdocCreateAppointment.md +10 -2
- package/docs/operations/connectors.zocdocCreateAppointmentAttachment.md +10 -2
- package/docs/operations/connectors.zocdocGetAppointmentById.md +10 -2
- package/docs/operations/connectors.zocdocGetAppointmentParticipants.md +10 -2
- package/docs/operations/connectors.zocdocGetDirectoryNpis.md +10 -2
- package/docs/operations/connectors.zocdocGetFacilityById.md +10 -2
- package/docs/operations/connectors.zocdocGetInsurancePlanById.md +10 -2
- package/docs/operations/connectors.zocdocGetInsurancePlans.md +10 -2
- package/docs/operations/connectors.zocdocGetMultipleLocationsAvailability.md +10 -2
- package/docs/operations/connectors.zocdocGetProviderByNpi.md +10 -2
- package/docs/operations/connectors.zocdocGetProviderCalendarTimeslots.md +10 -2
- package/docs/operations/connectors.zocdocGetProviderLocationById.md +10 -2
- package/docs/operations/connectors.zocdocGetProviderLocationInsuranceMappings.md +10 -2
- package/docs/operations/connectors.zocdocGetProvidersByNpis.md +10 -2
- package/docs/operations/connectors.zocdocGetSchedulableEntities.md +10 -2
- package/docs/operations/connectors.zocdocListAppointments.md +10 -2
- package/docs/operations/connectors.zocdocRescheduleAppointment.md +10 -2
- package/docs/operations/connectors.zocdocSearchFacilities.md +10 -2
- package/docs/operations/connectors.zocdocSearchProviderLocations.md +10 -2
- package/docs/operations/connectors.zocdocSetProviderCalendarTimeslots.md +10 -2
- package/docs/operations/connectors.zocdocUpdateAppointmentStatus.md +10 -2
- package/docs/operations/connectors.zocdocUpdateProviderLocationInsuranceMappings.md +10 -2
- package/docs/operations/connectors.zusBuildAthenaIdentifierSystem.md +10 -2
- package/docs/operations/connectors.zusCreatePatient.md +10 -2
- package/docs/operations/connectors.zusGetAccessAndRefreshTokens.md +10 -2
- package/docs/operations/connectors.zusGetGeneralAccessAndRefreshTokens.md +10 -2
- package/docs/operations/connectors.zusPatientExists.md +10 -2
- package/docs/operations/connectors.zusSearchPatient.md +10 -2
- package/docs/operations/connectors.zusSearchPatientByAthenaId.md +10 -2
- package/docs/operations/connectors.zusUploadCcd.md +10 -2
- package/docs/operations/diagnostics.connect.md +2 -2
- package/docs/operations/diagnostics.createRapidTest.md +91 -39
- package/docs/operations/diagnostics.getScanUploadUrl.md +57 -13
- package/docs/operations/diagnostics.getTestResult.md +57 -22
- package/docs/operations/diagnostics.listDiagnostics.md +54 -19
- package/docs/operations/diagnostics.lookupTestByGs1.md +54 -65
- package/docs/operations/ehr.connect.md +2 -2
- package/docs/operations/fieldagent.agentPhotoUploadUrl.md +51 -7
- package/docs/operations/fieldagent.confirmResetPassword.md +40 -16
- package/docs/operations/fieldagent.connect.md +2 -2
- package/docs/operations/fieldagent.getAgent.md +41 -5
- package/docs/operations/fieldagent.getAgentDashboard.md +62 -22
- package/docs/operations/fieldagent.getAgentPhoto.md +50 -7
- package/docs/operations/fieldagent.getPatientPhoto.md +33 -7
- package/docs/operations/fieldagent.listEncounters.md +60 -43
- package/docs/operations/fieldagent.listPatients.md +117 -62
- package/docs/operations/fieldagent.login.md +54 -18
- package/docs/operations/fieldagent.onboardPatient.md +218 -179
- package/docs/operations/fieldagent.patientPhotoUploadUrl.md +33 -7
- package/docs/operations/fieldagent.refreshToken.md +131 -0
- package/docs/operations/fieldagent.register.md +76 -42
- package/docs/operations/fieldagent.resetPassword.md +20 -12
- package/docs/operations/fieldagent.updateAgent.md +96 -22
- package/docs/operations/fieldagent.uploadAgentPhoto.md +53 -9
- package/docs/operations/fieldagent.uploadPatientPhoto.md +35 -9
- package/docs/operations/fieldagent.verifyEmail.md +47 -13
- package/docs/operations/fieldagent.verifySms.md +32 -16
- package/docs/operations/graph.connect.md +2 -2
- package/docs/operations/graph.getDiagnosticAnalyte.md +44 -18
- package/docs/operations/graph.getDiagnosticSpecialties.md +3 -5
- package/docs/operations/graph.getDiagnosticTest.md +43 -17
- package/docs/operations/graph.getDiagnosticTestRelationships.md +35 -9
- package/docs/operations/graph.getDiagnosticTestSystem.md +44 -18
- package/docs/operations/graph.getMedicalConcept.md +3 -3
- package/docs/operations/graph.getMedicalConceptAncestors.md +3 -5
- package/docs/operations/graph.getMedicalConceptDescendants.md +3 -5
- package/docs/operations/graph.getMedicalConceptRelationships.md +3 -5
- package/docs/operations/graph.getMedicalConceptVocabularies.md +3 -5
- package/docs/operations/graph.getPolicyDocument.md +26 -26
- package/docs/operations/graph.listDiagnosticTests.md +15 -15
- package/docs/operations/graph.listMedicalConceptsGet.md +17 -14
- package/docs/operations/graph.listPolicyDocuments.md +26 -26
- package/docs/operations/graph.searchDiagnosticTests.md +22 -7
- package/docs/operations/graph.searchDocumentSummaries.md +39 -22
- package/docs/operations/graph.searchDocumentSummariesCypher.md +37 -13
- package/docs/operations/graph.searchHealthPlans.md +43 -26
- package/docs/operations/graph.searchHealthPlansCypher.md +37 -13
- package/docs/operations/graph.searchMedicalConcepts.md +65 -45
- package/docs/operations/graph.searchMedicalConceptsCypher.md +37 -13
- package/docs/operations/graph.searchMedicalConceptsGet.md +26 -23
- package/docs/operations/graph.searchPolicyDocuments.md +26 -26
- package/docs/operations/graph.searchProviders.md +43 -26
- package/docs/operations/graph.searchProvidersCypher.md +38 -14
- package/docs/operations/mcp.mcpFieldagent.md +10 -2
- package/docs/operations/mcp.mcpPatient.md +10 -2
- package/docs/operations/mcp.mcpPerson.md +10 -2
- package/docs/operations/patient.addNotification.md +13 -13
- package/docs/operations/patient.analyzeIdentityDocument.md +10 -10
- package/docs/operations/patient.assistantChat.md +9 -11
- package/docs/operations/patient.assistantClassify.md +19 -1
- package/docs/operations/patient.assistantOcr.md +20 -20
- package/docs/operations/patient.assistantOcrInsurance.md +14 -14
- package/docs/operations/patient.commsGetState.md +33 -33
- package/docs/operations/patient.commsGetUnreadCount.md +1 -1
- package/docs/operations/patient.commsListConversations.md +9 -9
- package/docs/operations/patient.commsListConversationsByParticipant.md +9 -9
- package/docs/operations/patient.commsListGroups.md +9 -9
- package/docs/operations/patient.commsListInvites.md +9 -9
- package/docs/operations/patient.commsListMessages.md +7 -7
- package/docs/operations/patient.commsListPresence.md +4 -4
- package/docs/operations/patient.commsUpsertConversation.md +25 -25
- package/docs/operations/patient.commsUpsertGroup.md +23 -23
- package/docs/operations/patient.commsUpsertInvite.md +23 -23
- package/docs/operations/patient.commsUpsertMessage.md +19 -19
- package/docs/operations/patient.commsUpsertPresence.md +8 -8
- package/docs/operations/patient.confirmResetPassword.md +10 -10
- package/docs/operations/patient.createEncounter.md +112 -112
- package/docs/operations/patient.createMedication.md +78 -78
- package/docs/operations/patient.createQuestionnaire.md +20 -8
- package/docs/operations/patient.createQuestionnaireResponse.md +10 -14
- package/docs/operations/patient.faceMatch.md +7 -7
- package/docs/operations/patient.getAgentAgent.md +1 -1
- package/docs/operations/patient.getAgentConfigurationAgentconfiguration.md +5 -5
- package/docs/operations/patient.getCheckinCheckin.md +38 -38
- package/docs/operations/patient.getCurrentCareSessionCareSessionsCurrent.md +40 -40
- package/docs/operations/patient.getEncounter.md +37 -37
- package/docs/operations/patient.getInsurance.md +15 -15
- package/docs/operations/patient.getMedication.md +27 -27
- package/docs/operations/patient.getPatient.md +92 -55
- package/docs/operations/patient.getPatientAlerts.md +1 -3
- package/docs/operations/patient.getPatientDashboard.md +8 -16
- package/docs/operations/patient.getPatientSidebarPatientSidebar.md +129 -92
- package/docs/operations/patient.getPhoto.md +3 -3
- package/docs/operations/patient.getPreferredPharmacy.md +2 -2
- package/docs/operations/patient.importActivity.md +8 -18
- package/docs/operations/patient.importHealthRecord.md +5 -9
- package/docs/operations/patient.importVitals.md +8 -18
- package/docs/operations/patient.initHealthRecordImport.md +1 -1
- package/docs/operations/patient.listActions.md +3 -3
- package/docs/operations/patient.listActivity.md +2 -4
- package/docs/operations/patient.listDependents.md +6 -6
- package/docs/operations/patient.listEncounters.md +38 -38
- package/docs/operations/patient.listKnowledge.md +7 -7
- package/docs/operations/patient.listMedications.md +28 -28
- package/docs/operations/patient.listNotifications.md +7 -7
- package/docs/operations/patient.login.md +15 -13
- package/docs/operations/patient.nearestLocations.md +13 -13
- package/docs/operations/patient.photoUploadUrl.md +3 -3
- package/docs/operations/patient.refreshToken.md +131 -0
- package/docs/operations/patient.resendVerificationCode.md +5 -5
- package/docs/operations/patient.resetPassword.md +6 -6
- package/docs/operations/patient.searchKnowledge.md +7 -7
- package/docs/operations/patient.setPreferredPharmacy.md +9 -9
- package/docs/operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md +5 -5
- package/docs/operations/patient.updateAddress.md +9 -9
- package/docs/operations/patient.updateDemographics.md +15 -15
- package/docs/operations/patient.updateMedication.md +8 -8
- package/docs/operations/patient.updatePhone.md +3 -3
- package/docs/operations/patient.updateRace.md +3 -3
- package/docs/operations/patient.uploadPhoto.md +4 -4
- package/docs/operations/patient.verifyEmail.md +7 -7
- package/docs/operations/patient.verifySms.md +3 -3
- package/docs/operations/patient.visionFaceCompare.md +7 -7
- package/docs/operations/person.confirmResetPassword.md +10 -10
- package/docs/operations/person.getPerson.md +30 -20
- package/docs/operations/person.getPhoto.md +3 -3
- package/docs/operations/person.getPhotoUploadUrl.md +3 -3
- package/docs/operations/person.login.md +13 -13
- package/docs/operations/person.register.md +28 -28
- package/docs/operations/person.resetPassword.md +6 -6
- package/docs/operations/person.updatePerson.md +90 -22
- package/docs/operations/person.updatePhone.md +3 -3
- package/docs/operations/person.uploadPhoto.md +7 -7
- package/docs/operations/person.verifyEmail.md +7 -7
- package/docs/operations/person.verifySms.md +3 -3
- package/docs/operations/provider.confirmResetPassword.md +40 -16
- package/docs/operations/provider.connect.md +2 -2
- package/docs/operations/provider.getPhoto.md +45 -6
- package/docs/operations/provider.getPhotoUploadUrl.md +25 -8
- package/docs/operations/provider.getPractitioner.md +72 -45
- package/docs/operations/provider.login.md +52 -18
- package/docs/operations/provider.register.md +77 -47
- package/docs/operations/provider.resetPassword.md +20 -12
- package/docs/operations/provider.updatePhone.md +26 -9
- package/docs/operations/provider.updatePractitioner.md +176 -120
- package/docs/operations/provider.uploadPhoto.md +38 -12
- package/docs/operations/provider.verifyEmail.md +47 -13
- package/docs/operations/provider.verifySms.md +33 -8
- package/docs/operations/telehealth.createChannel.md +14 -6
- package/docs/operations/telehealth.createPatientToken.md +51 -17
- package/docs/operations/telehealth.createProviderToken.md +51 -17
- package/docs/operations/vitals.connect.md +2 -2
- package/docs/operations/vitals.listVitals.md +47 -39
- package/docs/operations/vitals.recordVitals.md +55 -38
- package/package.json +1 -1
- package/docs/models/AgentDashboardPayload.md +0 -24
- package/docs/models/AgentPhotoUploadUrlResponse.md +0 -18
- package/docs/models/CreatePatientTokenResponse.md +0 -23
- package/docs/models/CreateProviderTokenResponse.md +0 -23
- package/docs/models/LabObservation.md +0 -29
- package/docs/models/ReferenceRange.md +0 -20
- package/docs/models/TestProfile.md +0 -32
- package/docs/models/TestProfileAnalyte.md +0 -21
- package/docs/models/TestProfileGS1.md +0 -21
- package/docs/models/TestProfileImage.md +0 -18
- package/docs/models/TestProfileInstructionStep.md +0 -20
- package/docs/models/TestProfileMetadata.md +0 -21
- package/docs/models/TestProfilePossibleResult.md +0 -19
- package/docs/models/fieldagent.Insurance.md +0 -32
- package/docs/models/fieldagent.VerifyEmailResponse.md +0 -17
- package/docs/models/fieldagent.VerifySmsResponse.md +0 -17
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Model ID: `UploadPatientPhotoRequest`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Request body for POST /patients/{patient_id}/photo.
|
|
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
|
-
| `content_type` | `string` | No | | | `"image/png"` |
|
|
14
|
-
| `data` | `string` |
|
|
13
|
+
| `content_type` | `string|null` | No | | | `"image/png"` | Yes | MIME type of the uploaded image. Defaults to image/png if omitted. |
|
|
14
|
+
| `data` | `string` | Yes | | | | No | Base64-encoded image bytes. |
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Model ID: `UploadPatientPhotoResponse`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Response for POST /patients/{patient_id}/photo (201).
|
|
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
|
-
| `binary_id` | `string` | Yes | | | | No |
|
|
13
|
+
| `binary_id` | `string` | Yes | | | | No | FHIR Binary resource ID the photo was stored under; pass as ?binary_id= on a later GET, or omit it — it is auto-discovered from the patient's stored extension. |
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# VerifyOtpResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `VerifyOtpResponse`
|
|
4
|
+
|
|
5
|
+
Response for POST /auth/verify-email and POST /auth/verify-sms.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `verified` | `boolean` | Yes | | | | No | Always true when the response status is 200 — the OTP matched and the corresponding Cognito attribute (email_verified or phone_number_verified) was updated. |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
|
@@ -2,7 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
Model ID: `VitalsRecordRequest`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Request body for POST /patients/{patient_id}/vitals. All fields are
|
|
6
|
+
optional; only the vitals actually supplied are recorded, each as its
|
|
7
|
+
own FHIR Observation. systolic/diastolic must be supplied together or
|
|
8
|
+
neither is recorded. Note: systolic_bp/diastolic_bp/spo2/weight/height/
|
|
9
|
+
respiratory_rate/blood_glucose are accepted by this schema but are not
|
|
10
|
+
currently read by the handler — use systolic/diastolic/oxygen_saturation/
|
|
11
|
+
weight_kg/height_cm instead.
|
|
6
12
|
|
|
7
13
|
Type: `object`
|
|
8
14
|
|
|
@@ -10,21 +16,21 @@ Type: `object`
|
|
|
10
16
|
|
|
11
17
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
18
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `blood_glucose` | `number|null` | No | | | | Yes |
|
|
14
|
-
| `diastolic` | `number|null` | No | | | | Yes |
|
|
15
|
-
| `diastolic_bp` | `number|null` | No | | | | Yes |
|
|
16
|
-
| `encounter_id` | `string|null` | No | | | | Yes |
|
|
17
|
-
| `heart_rate` | `number|null` | No | | | | Yes |
|
|
18
|
-
| `height` | `number|null` | No | | | | Yes |
|
|
19
|
-
| `height_cm` | `number|null` | No | | | | Yes |
|
|
20
|
-
| `oxygen_saturation` | `number|null` | No | | | | Yes |
|
|
21
|
-
| `respiratory_rate` | `number|null` | No | | | | Yes |
|
|
22
|
-
| `spo2` | `number|null` | No | | | | Yes |
|
|
23
|
-
| `systolic` | `number|null` | No | | | | Yes |
|
|
24
|
-
| `systolic_bp` | `number|null` | No | | | | Yes |
|
|
25
|
-
| `temperature` | `number|null` | No | | | | Yes |
|
|
26
|
-
| `weight` | `number|null` | No | | | | Yes |
|
|
27
|
-
| `weight_kg` | `number|null` | No | | | | Yes |
|
|
19
|
+
| `blood_glucose` | `number|null` | No | | | | Yes | Not read by the handler. |
|
|
20
|
+
| `diastolic` | `number|null` | No | | | | Yes | Diastolic blood pressure in mmHg; requires systolic to be recorded. |
|
|
21
|
+
| `diastolic_bp` | `number|null` | No | | | | Yes | Not read by the handler; use diastolic. |
|
|
22
|
+
| `encounter_id` | `string|null` | No | | | | Yes | FHIR Encounter ID these vitals were captured during, optional. |
|
|
23
|
+
| `heart_rate` | `number|null` | No | | | | Yes | Heart rate in beats/min, optional. |
|
|
24
|
+
| `height` | `number|null` | No | | | | Yes | Not read by the handler; use height_cm. |
|
|
25
|
+
| `height_cm` | `number|null` | No | | | | Yes | Body height in centimeters, optional. |
|
|
26
|
+
| `oxygen_saturation` | `number|null` | No | | | | Yes | SpO2 percentage, optional. |
|
|
27
|
+
| `respiratory_rate` | `number|null` | No | | | | Yes | Not read by the handler. |
|
|
28
|
+
| `spo2` | `number|null` | No | | | | Yes | Not read by the handler; use oxygen_saturation. |
|
|
29
|
+
| `systolic` | `number|null` | No | | | | Yes | Systolic blood pressure in mmHg; requires diastolic to be recorded. |
|
|
30
|
+
| `systolic_bp` | `number|null` | No | | | | Yes | Not read by the handler; use systolic. |
|
|
31
|
+
| `temperature` | `number|null` | No | | | | Yes | Body temperature in Celsius, optional. |
|
|
32
|
+
| `weight` | `number|null` | No | | | | Yes | Not read by the handler; use weight_kg. |
|
|
33
|
+
| `weight_kg` | `number|null` | No | | | | Yes | Body weight in kilograms, optional. |
|
|
28
34
|
|
|
29
35
|
## Example
|
|
30
36
|
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# ErrorResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `diagnostics.ErrorResponse`
|
|
4
|
+
|
|
5
|
+
Standard error response body shared by every Diagnostics operation.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `error` | `string` | Yes | | | | No | Human-readable explanation of why the request failed. |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# LabObservation
|
|
2
|
+
|
|
3
|
+
Model ID: `diagnostics.LabObservation`
|
|
4
|
+
|
|
5
|
+
A single lab result line item, mapped to/from a FHIR Observation.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `display` | `string` | Yes | | | | No | Human-readable name of the measured analyte. |
|
|
14
|
+
| `effective_datetime` | `string|null` | No | | | | Yes | ISO 8601 datetime the observation was effective, optional. |
|
|
15
|
+
| `interpretation` | [`InterpretationCode`](./InterpretationCode.md) | No | | | | Yes | Clinical interpretation flag, e.g. high/low/critical/positive/negative. |
|
|
16
|
+
| `loinc_code` | `string` | Yes | | | | No | LOINC code identifying the measured analyte. |
|
|
17
|
+
| `notes` | `string|null` | No | | | | Yes | Free-text notes, optional. |
|
|
18
|
+
| `observation_id` | `string|null` | No | | | | Yes | FHIR Observation resource ID; auto-generated if omitted. |
|
|
19
|
+
| `reference_range` | [`diagnostics.ReferenceRange`](./diagnostics.ReferenceRange.md) | No | | | | Yes | The normal/expected range for this result, optional. |
|
|
20
|
+
| `status` | [`ObservationStatus`](./ObservationStatus.md) | No | | | `"final"` | No | Observation lifecycle status. |
|
|
21
|
+
| `value_boolean` | `boolean|null` | No | | | | Yes | Boolean result value, when applicable. |
|
|
22
|
+
| `value_coding` | `object|null` | No | | | | Yes | Coded result value (raw FHIR CodeableConcept), when applicable. |
|
|
23
|
+
| `value_quantity` | `number|null` | No | | | | Yes | Numeric result value, when the result is quantitative. Requires value_unit. |
|
|
24
|
+
| `value_string` | `string|null` | No | | | | Yes | Free-text result value, when the result is not quantitative. |
|
|
25
|
+
| `value_unit` | `string|null` | No | | | | Yes | Unit of measure for value_quantity, optional. |
|
|
26
|
+
|
|
27
|
+
## Example
|
|
28
|
+
|
|
29
|
+
None declared in canonical OpenAPI.
|
|
@@ -1,8 +1,9 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ListDiagnosticsResponse
|
|
2
2
|
|
|
3
3
|
Model ID: `diagnostics.ListDiagnosticsResponse`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Response for GET /patients/{patient_id}/diagnostics. Scoped to the
|
|
6
|
+
tenant resolved from the Bearer JWT.
|
|
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
|
-
| `observations` | array of [`LabObservation`](./LabObservation.md) | Yes | | | | No |
|
|
14
|
-
| `total` | `integer` | Yes | | | | No |
|
|
14
|
+
| `observations` | array of [`diagnostics.LabObservation`](./diagnostics.LabObservation.md) | Yes | | | | No | Lab Observations for this patient. |
|
|
15
|
+
| `total` | `integer` | Yes | | | | No | Number of observations in this response. |
|
|
15
16
|
|
|
16
17
|
## Example
|
|
17
18
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ReferenceRange
|
|
2
|
+
|
|
3
|
+
Model ID: `diagnostics.ReferenceRange`
|
|
4
|
+
|
|
5
|
+
The normal/expected range for a lab observation's value.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `high` | `number|null` | No | | | | Yes | Upper bound of the normal range, optional. |
|
|
14
|
+
| `low` | `number|null` | No | | | | Yes | Lower bound of the normal range, optional. |
|
|
15
|
+
| `text` | `string|null` | No | | | | Yes | Free-text range description, e.g. 'Negative', optional. |
|
|
16
|
+
| `unit` | `string|null` | No | | | | Yes | Unit of measure for low/high, optional. |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
None declared in canonical OpenAPI.
|
|
@@ -1,8 +1,9 @@
|
|
|
1
|
-
#
|
|
1
|
+
# FieldAgentConfirmResetPasswordRequest
|
|
2
2
|
|
|
3
3
|
Model ID: `fieldagent.ConfirmResetPasswordRequest`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Request body for POST /auth/confirm-reset-password, completing the
|
|
6
|
+
ForgotPassword flow started by fieldagent.resetPassword.
|
|
6
7
|
|
|
7
8
|
Type: `object`
|
|
8
9
|
|
|
@@ -10,10 +11,10 @@ Type: `object`
|
|
|
10
11
|
|
|
11
12
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
13
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `confirmation_code` | `string` |
|
|
14
|
-
| `email` | `string` |
|
|
15
|
-
| `new_password` | `string` |
|
|
16
|
-
| `tenant_id` | `string` |
|
|
14
|
+
| `confirmation_code` | `string` | Yes | | | | No | Code Cognito emailed after fieldagent.resetPassword. |
|
|
15
|
+
| `email` | `string` | Yes | | | | No | Account email the reset code was sent to. |
|
|
16
|
+
| `new_password` | `string` | Yes | | | | No | New password, minimum 8 characters. |
|
|
17
|
+
| `tenant_id` | `string` | Yes | | | | No | Tenant the agent belongs to. |
|
|
17
18
|
|
|
18
19
|
## Example
|
|
19
20
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ConfirmResetPasswordResponse
|
|
2
2
|
|
|
3
3
|
Model ID: `fieldagent.ConfirmResetPasswordResponse`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Response for POST /auth/confirm-reset-password.
|
|
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
|
-
| `message` | `string` | Yes | | | | No |
|
|
13
|
+
| `message` | `string` | Yes | | | | No | Human-readable confirmation shown to the agent. |
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Model ID: `fieldagent.ErrorResponse`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Standard error response body shared by every FieldAgent operation.
|
|
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
|
-
| `error` | `string` | Yes | | | | No |
|
|
13
|
+
| `error` | `string` | Yes | | | | No | Human-readable explanation of why the request failed. |
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -1,8 +1,10 @@
|
|
|
1
|
-
#
|
|
1
|
+
# FieldAgentListEncountersResponse
|
|
2
2
|
|
|
3
3
|
Model ID: `fieldagent.ListEncountersResponse`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Response for GET /encounters. Scoped to the caller's tenant, not to the
|
|
6
|
+
calling agent — pass ``created_by`` to further restrict results to
|
|
7
|
+
encounters that agent created.
|
|
6
8
|
|
|
7
9
|
Type: `object`
|
|
8
10
|
|
|
@@ -10,10 +12,10 @@ Type: `object`
|
|
|
10
12
|
|
|
11
13
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
14
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `created_by` | `string` | No | | | | No |
|
|
14
|
-
| `encounters` | array of [`fieldagent.Encounter`](./fieldagent.Encounter.md) | Yes | | | | No |
|
|
15
|
-
| `patient_id` | `string|null` | Yes | | | | Yes |
|
|
16
|
-
| `total` | `integer` | Yes | | | | No |
|
|
15
|
+
| `created_by` | `string` | No | | | | No | Echoed back only when the request supplied ?created_by=; the FHIR Person ID of the field agent the results were filtered to. |
|
|
16
|
+
| `encounters` | array of [`fieldagent.Encounter`](./fieldagent.Encounter.md) | Yes | | | | No | Encounters matching the supplied filters, in domain-model format. |
|
|
17
|
+
| `patient_id` | `string|null` | Yes | | | | Yes | Echoed back only when the request supplied ?patient_id=; the FHIR Patient ID results were scoped to. |
|
|
18
|
+
| `total` | `integer` | Yes | | | | No | Number of encounters in this response (post-filter, post-pagination page size). |
|
|
17
19
|
|
|
18
20
|
## Example
|
|
19
21
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
#
|
|
1
|
+
# FieldAgentLoginRequest
|
|
2
2
|
|
|
3
3
|
Model ID: `fieldagent.LoginRequest`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Request body for POST /auth/login. All three fields are required.
|
|
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
|
-
| `email` | `string` |
|
|
14
|
-
| `password` | `string` |
|
|
15
|
-
| `tenant_id` | `string` |
|
|
13
|
+
| `email` | `string` | Yes | | | | No | Agent's registered email. |
|
|
14
|
+
| `password` | `string` | Yes | | | | No | Agent's password. |
|
|
15
|
+
| `tenant_id` | `string` | Yes | | | | No | Tenant the agent belongs to; must match the tenant on the agent's Cognito account or the login is rejected. |
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
|
@@ -2,7 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
Model ID: `fieldagent.LoginResponse`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Response for POST /auth/login. ``fhir_person_id`` and ``person_type``
|
|
6
|
+
are resolved best-effort from a Redis cache and, on a cache miss, a FHIR
|
|
7
|
+
Person search by cognito_sub — both may be null if neither lookup
|
|
8
|
+
succeeds, even though the login itself was successful.
|
|
6
9
|
|
|
7
10
|
Type: `object`
|
|
8
11
|
|
|
@@ -10,12 +13,14 @@ Type: `object`
|
|
|
10
13
|
|
|
11
14
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
15
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `access_token` | `string` | Yes | | | | No |
|
|
14
|
-
| `cognito_sub` | `string|null` | No | | | | Yes |
|
|
15
|
-
| `expires_in` | `integer` | Yes | | | | No |
|
|
16
|
-
| `fhir_person_id` | `string|null` | No | | | | Yes |
|
|
17
|
-
| `id_token` | `string|null` | No | | | | Yes |
|
|
18
|
-
| `person_type` | `string|null` | No | | | | Yes |
|
|
16
|
+
| `access_token` | `string` | Yes | | | | No | Cognito access token; send as `Authorization: Bearer <access_token>` on subsequent requests. |
|
|
17
|
+
| `cognito_sub` | `string|null` | No | | | | Yes | Cognito subject (user id) decoded from the issued id_token. |
|
|
18
|
+
| `expires_in` | `integer` | Yes | | | | No | Access token lifetime in seconds from issuance. |
|
|
19
|
+
| `fhir_person_id` | `string|null` | No | | | | Yes | FHIR Person ID for this agent, used as {agent_id} on every other route. Null if it could not be resolved. |
|
|
20
|
+
| `id_token` | `string|null` | No | | | | Yes | Cognito ID token, carrying the tenant_id/roles claims used by other HealthCloud services. |
|
|
21
|
+
| `person_type` | `string|null` | No | | | | Yes | Person type recorded for this identity, e.g. 'field_agent'. Null if it could not be resolved. |
|
|
22
|
+
| `refresh_token` | `string|null` | No | | | | Yes | Cognito refresh token used to obtain a new access token without signing in again. |
|
|
23
|
+
| `token_type` | `string` | No | | | `"Bearer"` | No | OAuth token type returned by Cognito. |
|
|
19
24
|
|
|
20
25
|
## Example
|
|
21
26
|
|
|
@@ -12,6 +12,7 @@ Type: `object`
|
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
13
|
| `active` | `boolean` | No | | | `true` | No | |
|
|
14
14
|
| `addresses` | array of [`Address`](./Address.md) | No | | | | No | |
|
|
15
|
+
| `attributes` | `object` | No | | | | No | Arbitrary JSON-compatible metadata for this patient |
|
|
15
16
|
| `communications` | array of [`Communication`](./Communication.md) | No | | | | No | |
|
|
16
17
|
| `created_by` | `string` | No | | | `"self"` | No | Person FHIR resource ID of the creating field agent, or 'self' |
|
|
17
18
|
| `created_date` | `string|null` | No | | | | Yes | UTC datetime when the record was created |
|
|
@@ -26,7 +27,7 @@ Type: `object`
|
|
|
26
27
|
| `flags` | `object` | No | | | | No | Boolean feature/state flags for this patient |
|
|
27
28
|
| `gender` | [`Gender`](./Gender.md) | Yes | | | | No | |
|
|
28
29
|
| `gender_identity` | [`GenderIdentity`](./GenderIdentity.md) | No | | | | Yes | |
|
|
29
|
-
| `insurance` | array of [`
|
|
30
|
+
| `insurance` | array of [`Insurance`](./Insurance.md) | No | | | | No | |
|
|
30
31
|
| `links` | array of [`PatientLink`](./PatientLink.md) | No | | | | No | |
|
|
31
32
|
| `managing_organization_id` | `string|null` | No | | | | Yes | FHIR Organization resource id |
|
|
32
33
|
| `marital_status` | [`MaritalStatus`](./MaritalStatus.md) | No | | | | Yes | |
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# PhotoUploadUrlResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `fieldagent.PhotoUploadUrlResponse`
|
|
4
|
+
|
|
5
|
+
Response for GET /agents/{agent_id}/photo/upload-url and
|
|
6
|
+
GET /patients/{patient_id}/photo/upload-url.
|
|
7
|
+
|
|
8
|
+
Type: `object`
|
|
9
|
+
|
|
10
|
+
## Fields
|
|
11
|
+
|
|
12
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
13
|
+
|---|---|---:|---|---|---|---:|---|
|
|
14
|
+
| `key` | `string` | Yes | | | | No | Object key the photo will be stored under in the Wasabi bucket. |
|
|
15
|
+
| `url` | `string` | Yes | | | | No | Presigned Wasabi PUT URL, valid for 10 minutes. Upload the raw image bytes directly to this URL with an HTTP PUT. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# FieldAgentRefreshTokenRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `fieldagent.RefreshTokenRequest`
|
|
4
|
+
|
|
5
|
+
Request body for POST /auth/refresh. Both fields are required.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `refresh_token` | `string` | Yes | | | | No | Refresh token previously returned by fieldagent.login. |
|
|
14
|
+
| `tenant_id` | `string` | Yes | | | | No | Tenant whose field-agent Cognito pool issued the refresh token. |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# FieldAgentRefreshTokenResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `fieldagent.RefreshTokenResponse`
|
|
4
|
+
|
|
5
|
+
Response for POST /auth/refresh.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `access_token` | `string` | Yes | | | | No | New Cognito access token. |
|
|
14
|
+
| `expires_in` | `integer` | Yes | | | | No | Access token lifetime in seconds. |
|
|
15
|
+
| `id_token` | `string|null` | No | | | | Yes | New Cognito ID token, when issued. |
|
|
16
|
+
| `refresh_token` | `string|null` | No | | | | Yes | Rotated refresh token, when Cognito returns one. |
|
|
17
|
+
| `token_type` | `string` | No | | | `"Bearer"` | No | OAuth token type returned by Cognito. |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
None declared in canonical OpenAPI.
|
|
@@ -1,8 +1,10 @@
|
|
|
1
|
-
#
|
|
1
|
+
# FieldAgentRegisterRequest
|
|
2
2
|
|
|
3
3
|
Model ID: `fieldagent.RegisterRequest`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Request body for POST /auth/register. Same required/optional field set
|
|
6
|
+
FieldAgentRegistrationService.register() reads from the payload
|
|
7
|
+
(hc/services/fieldagent/registration_service.py).
|
|
6
8
|
|
|
7
9
|
Type: `object`
|
|
8
10
|
|
|
@@ -10,21 +12,21 @@ Type: `object`
|
|
|
10
12
|
|
|
11
13
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
14
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `address` | `
|
|
14
|
-
| `badge_number` | `string` | No | | | |
|
|
15
|
-
| `date_of_birth` | `string` | No |
|
|
16
|
-
| `department` | `string` | No | | | |
|
|
17
|
-
| `email` | `string` | Yes |
|
|
18
|
-
| `first_name` | `string` | Yes | | | | No |
|
|
19
|
-
| `gender` | `string` | No | | | |
|
|
20
|
-
| `last_name` | `string` | Yes | | | | No |
|
|
21
|
-
| `license_number` | `string` | No | | | |
|
|
22
|
-
| `organization` | `string` | No | | | |
|
|
23
|
-
| `password` | `string` | Yes | | | | No |
|
|
24
|
-
| `phone` | `string` | No | | | |
|
|
25
|
-
| `race` | `string|array` | No | | | |
|
|
26
|
-
| `tenant_id` | `string` |
|
|
27
|
-
| `title` | `string` | No | | | |
|
|
15
|
+
| `address` | [`Address`](./Address.md) | No | | | | Yes | Single postal address. This endpoint does not accept the plural 'addresses' form. |
|
|
16
|
+
| `badge_number` | `string|null` | No | | | | Yes | Agency-issued badge number, optional. |
|
|
17
|
+
| `date_of_birth` | `string|null` | No | | | | Yes | ISO 8601 date (YYYY-MM-DD). |
|
|
18
|
+
| `department` | `string|null` | No | | | | Yes | Department the agent is assigned to, optional. |
|
|
19
|
+
| `email` | `string` | Yes | | | | No | Agent's email; used as the Cognito login username and OTP delivery address. |
|
|
20
|
+
| `first_name` | `string` | Yes | | | | No | Agent's given name. |
|
|
21
|
+
| `gender` | `string|null` | No | | | | Yes | Free-text gender, optional. |
|
|
22
|
+
| `last_name` | `string` | Yes | | | | No | Agent's family name. |
|
|
23
|
+
| `license_number` | `string|null` | No | | | | Yes | Professional license number, optional. |
|
|
24
|
+
| `organization` | `string|null` | No | | | | Yes | Employing organization, optional. |
|
|
25
|
+
| `password` | `string` | Yes | | | | No | Initial password, minimum 8 characters. |
|
|
26
|
+
| `phone` | `string|null` | No | | | | Yes | E.164 phone number, optional. |
|
|
27
|
+
| `race` | `string|array|null` | No | | | | Yes | One race value, or a list of them. |
|
|
28
|
+
| `tenant_id` | `string` | Yes | | | | No | Tenant to register the agent into; resolves which Cognito pool the account is created in. |
|
|
29
|
+
| `title` | `string|null` | No | | | | Yes | Job title, e.g. 'Senior Agent'. |
|
|
28
30
|
|
|
29
31
|
## Example
|
|
30
32
|
|
|
@@ -2,7 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
Model ID: `fieldagent.RegisterResponse`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Response for POST /auth/register (201). ``access_token``/``id_token``/
|
|
6
|
+
``expires_in`` are present only when the deployment sets
|
|
7
|
+
``AUTO_VERIFY_EMAIL=true`` *and* the immediate post-registration login
|
|
8
|
+
succeeds; otherwise they are omitted and the agent must call
|
|
9
|
+
``fieldagent.login`` after verifying their email OTP.
|
|
6
10
|
|
|
7
11
|
Type: `object`
|
|
8
12
|
|
|
@@ -10,14 +14,14 @@ Type: `object`
|
|
|
10
14
|
|
|
11
15
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
16
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `access_token` | `string` | No | | | | No |
|
|
14
|
-
| `cognito_sub` | `string` | Yes | | | | No |
|
|
15
|
-
| `email_otp_sent` | `boolean` | Yes | | | | No |
|
|
16
|
-
| `email_verified` | `boolean` | Yes | | | | No |
|
|
17
|
-
| `expires_in` | `integer` | No | | | | No |
|
|
18
|
-
| `fhir_person_id` | `string|null` | No | | | | Yes |
|
|
19
|
-
| `id_token` | `string|null` | No | | | | Yes |
|
|
20
|
-
| `person_type` | `string` | Yes | | | | No |
|
|
17
|
+
| `access_token` | `string` | No | | | | No | Present only when AUTO_VERIFY_EMAIL=true and the immediate post-registration login succeeded. |
|
|
18
|
+
| `cognito_sub` | `string` | Yes | | | | No | Cognito subject (user id) for the newly created agent account. |
|
|
19
|
+
| `email_otp_sent` | `boolean` | Yes | | | | No | 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. |
|
|
20
|
+
| `email_verified` | `boolean` | Yes | | | | No | True only when the deployment auto-verifies email (AUTO_VERIFY_EMAIL=true); otherwise false until the agent completes fieldagent.verifyEmail. |
|
|
21
|
+
| `expires_in` | `integer` | No | | | | No | Present only under the same AUTO_VERIFY_EMAIL condition as access_token. |
|
|
22
|
+
| `fhir_person_id` | `string|null` | No | | | | Yes | FHIR Person ID created for the agent; use as {agent_id} on other routes. |
|
|
23
|
+
| `id_token` | `string|null` | No | | | | Yes | Present only under the same AUTO_VERIFY_EMAIL condition as access_token. |
|
|
24
|
+
| `person_type` | `string` | Yes | | | | No | Always 'field_agent' for this endpoint. |
|
|
21
25
|
|
|
22
26
|
## Example
|
|
23
27
|
|
|
@@ -1,8 +1,10 @@
|
|
|
1
|
-
#
|
|
1
|
+
# FieldAgentResetPasswordRequest
|
|
2
2
|
|
|
3
3
|
Model ID: `fieldagent.ResetPasswordRequest`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Request body for POST /auth/reset-password — starts Cognito's
|
|
6
|
+
ForgotPassword flow. Cognito emails a confirmation code directly; the
|
|
7
|
+
client then calls fieldagent.confirmResetPassword with that code.
|
|
6
8
|
|
|
7
9
|
Type: `object`
|
|
8
10
|
|
|
@@ -10,8 +12,8 @@ Type: `object`
|
|
|
10
12
|
|
|
11
13
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
14
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `email` | `string` |
|
|
14
|
-
| `tenant_id` | `string` |
|
|
15
|
+
| `email` | `string` | Yes | | | | No | Account email to send the reset code to. |
|
|
16
|
+
| `tenant_id` | `string` | Yes | | | | No | Tenant the agent belongs to; used to resolve the Cognito pool. |
|
|
15
17
|
|
|
16
18
|
## Example
|
|
17
19
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ResetPasswordResponse
|
|
2
2
|
|
|
3
3
|
Model ID: `fieldagent.ResetPasswordResponse`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Response for POST /auth/reset-password.
|
|
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
|
-
| `message` | `string` | Yes | | | | No |
|
|
14
|
-
| `reset_initiated` | `boolean` | Yes | | | | No |
|
|
13
|
+
| `message` | `string` | Yes | | | | No | Human-readable confirmation shown to the agent. |
|
|
14
|
+
| `reset_initiated` | `boolean` | Yes | | | | No | Always true when the response status is 200 — Cognito accepted the ForgotPassword request. |
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
#
|
|
1
|
+
# FieldAgentVerifyEmailRequest
|
|
2
2
|
|
|
3
3
|
Model ID: `fieldagent.VerifyEmailRequest`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Request body for POST /auth/verify-email.
|
|
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
|
-
| `email` | `string` |
|
|
14
|
-
| `otp` | `string` |
|
|
15
|
-
| `tenant_id` | `string` |
|
|
13
|
+
| `email` | `string` | Yes | | | | No | Email the OTP was sent to; used to look up the Cognito account. |
|
|
14
|
+
| `otp` | `string` | Yes | | | | No | One-time verification code delivered by email. |
|
|
15
|
+
| `tenant_id` | `string` | Yes | | | | No | Tenant the agent belongs to. |
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
|
@@ -2,7 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
Model ID: `fieldagent.VerifySmsRequest`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Request body for POST /auth/verify-sms. Exactly one of cognito_id,
|
|
6
|
+
user_id or cognito_sub must identify the account — they are aliases for
|
|
7
|
+
the same Cognito subject, accepted for client compatibility.
|
|
6
8
|
|
|
7
9
|
Type: `object`
|
|
8
10
|
|
|
@@ -12,8 +14,8 @@ Type: `object`
|
|
|
12
14
|
|---|---|---:|---|---|---|---:|---|
|
|
13
15
|
| `cognito_id` | `string` | No | | | | No | Alias for user_id/cognito_sub. |
|
|
14
16
|
| `cognito_sub` | `string` | No | | | | No | Alias for cognito_id/user_id. |
|
|
15
|
-
| `otp` | `string` | Yes | | | | No |
|
|
16
|
-
| `tenant_id` | `string` | Yes | | | | No |
|
|
17
|
+
| `otp` | `string` | Yes | | | | No | One-time verification code delivered by SMS. |
|
|
18
|
+
| `tenant_id` | `string` | Yes | | | | No | Tenant the agent belongs to. |
|
|
17
19
|
| `user_id` | `string` | No | | | | No | Alias for cognito_id/cognito_sub. |
|
|
18
20
|
|
|
19
21
|
## Example
|