@healthcloudai/hc-sdk 2.12.0 → 2.13.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 +50 -70
- package/dist/index.d.cts +5902 -2086
- package/dist/index.d.ts +5902 -2086
- package/dist/index.js +50 -70
- package/docs/clients/AthenaHealthClient.md +3 -3
- package/docs/clients/HealthieClient.md +1 -1
- package/docs/clients/PatientClient.md +1 -0
- package/docs/docs-manifest.json +12 -4
- package/docs/examples/index.md +5 -4
- package/docs/index.md +5 -4
- package/docs/models/AddInsuranceRequest.md +0 -1
- package/docs/models/AddInsuranceResponse.md +4 -0
- package/docs/models/AnalyzeIdentityDocumentResponse.md +4 -1
- package/docs/models/Appointment.md +2 -0
- package/docs/models/AthenaAddPreferredPharmacyRequest.md +2 -1
- package/docs/models/AthenaCreatePatientRequest.md +2 -0
- package/docs/models/AthenaDeletePreferredPharmacyRequest.md +2 -1
- package/docs/models/AthenaGetInsurancePackagesRequest.md +3 -2
- package/docs/models/AthenaUpdateDriversLicenseRequest.md +1 -0
- package/docs/models/AthenaVitalsMirrorResult.md +20 -0
- package/docs/models/BookAppointmentRequest.md +2 -0
- package/docs/models/CancelAppointmentRequest.md +21 -0
- package/docs/models/DriversLicense.md +30 -0
- package/docs/models/DriversLicenseSubmission.md +21 -0
- package/docs/models/GetEncounterResponse.md +4 -0
- package/docs/models/GetPatientResponse.md +5 -0
- package/docs/models/HealthieAcceptInsurancePlansRequest.md +1 -0
- package/docs/models/HealthieAddDiagnosisRequest.md +1 -0
- package/docs/models/HealthieAddPharmacyRequest.md +1 -0
- package/docs/models/HealthieBulkApplyTagsRequest.md +1 -0
- package/docs/models/HealthieBulkUpdateClientsRequest.md +1 -0
- package/docs/models/HealthieBulkUpdateDiagnosesRequest.md +1 -0
- package/docs/models/HealthieCloseConversationRequest.md +1 -0
- package/docs/models/HealthieCompleteCcdaReconciliationRequest.md +1 -0
- package/docs/models/HealthieCompleteCheckoutRequest.md +1 -0
- package/docs/models/HealthieCopyFormRequest.md +1 -0
- package/docs/models/HealthieCopyOfferingRequest.md +1 -0
- package/docs/models/HealthieCreateApiKeyRequest.md +1 -0
- package/docs/models/HealthieCreateAppointmentRequest.md +1 -0
- package/docs/models/HealthieCreateAppointmentSettingRequest.md +1 -0
- package/docs/models/HealthieCreateAppointmentTypeRequest.md +1 -0
- package/docs/models/HealthieCreateAvailabilitiesBulkRequest.md +1 -0
- package/docs/models/HealthieCreateAvailabilityRequest.md +1 -0
- package/docs/models/HealthieCreateBillingItemRequest.md +1 -0
- package/docs/models/HealthieCreateCarePlanRequest.md +1 -0
- package/docs/models/HealthieCreateCms1500Request.md +1 -0
- package/docs/models/HealthieCreateCompletedOnboardingItemRequest.md +1 -0
- package/docs/models/HealthieCreateConversationRequest.md +1 -0
- package/docs/models/HealthieCreateEntryRequest.md +1 -0
- package/docs/models/HealthieCreateEpisodeOfCareRequest.md +1 -0
- package/docs/models/HealthieCreateFamilyHistoryRequest.md +1 -0
- package/docs/models/HealthieCreateFormAnswerGroupRequest.md +1 -0
- package/docs/models/HealthieCreateFormCompletionRequestRequest.md +1 -0
- package/docs/models/HealthieCreateFormRequest.md +1 -0
- package/docs/models/HealthieCreateGoalRequest.md +1 -0
- package/docs/models/HealthieCreateImmunizationRequest.md +1 -0
- package/docs/models/HealthieCreateInsurancePaymentRequest.md +1 -0
- package/docs/models/HealthieCreateInvoiceRequest.md +1 -0
- package/docs/models/HealthieCreateLabOrderRequest.md +1 -0
- package/docs/models/HealthieCreateLocationRequest.md +1 -0
- package/docs/models/HealthieCreateMedicationRequest.md +1 -0
- package/docs/models/HealthieCreateMetricEntryRequest.md +1 -0
- package/docs/models/HealthieCreateNoteRequest.md +1 -0
- package/docs/models/HealthieCreateOfferingRequest.md +1 -0
- package/docs/models/HealthieCreateOnboardingFlowRequest.md +1 -0
- package/docs/models/HealthieCreateOnboardingItemRequest.md +1 -0
- package/docs/models/HealthieCreateOpenLoopFormRequest.md +1 -0
- package/docs/models/HealthieCreateOrganizationMembershipRequest.md +1 -0
- package/docs/models/HealthieCreatePatientRequest.md +1 -0
- package/docs/models/HealthieCreatePersonalizationQuestionnaireRequest.md +1 -0
- package/docs/models/HealthieCreateProgramRequest.md +1 -0
- package/docs/models/HealthieCreateRupaOrderRequest.md +1 -0
- package/docs/models/HealthieCreateSuperBillRequest.md +1 -0
- package/docs/models/HealthieCreateTagRequest.md +1 -0
- package/docs/models/HealthieCreateTaskRequest.md +1 -0
- package/docs/models/HealthieCreateUserGroupRequest.md +1 -0
- package/docs/models/HealthieDeleteApiKeyRequest.md +1 -0
- package/docs/models/HealthieDeleteAppointmentRequest.md +1 -0
- package/docs/models/HealthieDeleteAppointmentTypeRequest.md +1 -0
- package/docs/models/HealthieDeleteAvailabilityRequest.md +1 -0
- package/docs/models/HealthieDeleteBillingItemRequest.md +1 -0
- package/docs/models/HealthieDeleteCarePlanRequest.md +1 -0
- package/docs/models/HealthieDeleteCms1500Request.md +1 -0
- package/docs/models/HealthieDeleteDocumentRequest.md +1 -0
- package/docs/models/HealthieDeleteEntryRequest.md +1 -0
- package/docs/models/HealthieDeleteEpisodeOfCareRequest.md +1 -0
- package/docs/models/HealthieDeleteFamilyHistoryRequest.md +1 -0
- package/docs/models/HealthieDeleteFormCompletionRequestRequest.md +1 -0
- package/docs/models/HealthieDeleteFormRequest.md +1 -0
- package/docs/models/HealthieDeleteGoalRequest.md +1 -0
- package/docs/models/HealthieDeleteInvoiceRequest.md +1 -0
- package/docs/models/HealthieDeleteManualInsurancePaymentRequest.md +1 -0
- package/docs/models/HealthieDeleteMedicationRequest.md +1 -0
- package/docs/models/HealthieDeleteOfferingRequest.md +1 -0
- package/docs/models/HealthieDeleteOnboardingFlowRequest.md +1 -0
- package/docs/models/HealthieDeleteOnboardingItemRequest.md +1 -0
- package/docs/models/HealthieDeleteOrganizationMembershipRequest.md +1 -0
- package/docs/models/HealthieDeleteProgramRequest.md +1 -0
- package/docs/models/HealthieDeleteSuperBillRequest.md +1 -0
- package/docs/models/HealthieDeleteTagRequest.md +1 -0
- package/docs/models/HealthieDeleteTaskRequest.md +1 -0
- package/docs/models/HealthieDeleteUserGroupRequest.md +1 -0
- package/docs/models/HealthieEditAvailabilityRequest.md +1 -0
- package/docs/models/HealthieFillLabResultReviewFormRequest.md +1 -0
- package/docs/models/HealthieFindAndBookFirstAvailableSlotRequest.md +1 -0
- package/docs/models/HealthieGetApiKeysRequest.md +1 -0
- package/docs/models/HealthieGetAppointmentBookingWarningsRequest.md +1 -0
- package/docs/models/HealthieGetAppointmentRequest.md +1 -0
- package/docs/models/HealthieGetAppointmentSettingRequest.md +1 -0
- package/docs/models/HealthieGetAppointmentTypeRequest.md +1 -0
- package/docs/models/HealthieGetAppointmentTypesRequest.md +1 -0
- package/docs/models/HealthieGetAppointmentsRequest.md +1 -0
- package/docs/models/HealthieGetAvailabilitiesRequest.md +1 -0
- package/docs/models/HealthieGetAvailabilityRequest.md +1 -0
- package/docs/models/HealthieGetAvailableItemTypesRequest.md +1 -0
- package/docs/models/HealthieGetAvailableSlotsForRangeRequest.md +1 -0
- package/docs/models/HealthieGetBillingItemRequest.md +1 -0
- package/docs/models/HealthieGetBillingItemsRequest.md +1 -0
- package/docs/models/HealthieGetCarePlanRequest.md +1 -0
- package/docs/models/HealthieGetCarePlansRequest.md +1 -0
- package/docs/models/HealthieGetCms1500Request.md +1 -0
- package/docs/models/HealthieGetCms1500sRequest.md +1 -0
- package/docs/models/HealthieGetConversationMembershipsRequest.md +1 -0
- package/docs/models/HealthieGetConversationRequest.md +1 -0
- package/docs/models/HealthieGetCurrentUserIdRequest.md +1 -0
- package/docs/models/HealthieGetCurrentUserRequest.md +1 -0
- package/docs/models/HealthieGetDaysAvailableForRangeRequest.md +1 -0
- package/docs/models/HealthieGetDietitianIdRequest.md +1 -0
- package/docs/models/HealthieGetDocumentRequest.md +1 -0
- package/docs/models/HealthieGetDocumentsRequest.md +1 -0
- package/docs/models/HealthieGetEntriesRequest.md +1 -0
- package/docs/models/HealthieGetEntryRequest.md +1 -0
- package/docs/models/HealthieGetEpisodesOfCareRequest.md +1 -0
- package/docs/models/HealthieGetFormAnswerGroupsRequest.md +1 -0
- package/docs/models/HealthieGetFormCompletionRequestsRequest.md +1 -0
- package/docs/models/HealthieGetFormRequest.md +1 -0
- package/docs/models/HealthieGetFormsRequest.md +1 -0
- package/docs/models/HealthieGetGoalHistoriesRequest.md +1 -0
- package/docs/models/HealthieGetGoalRequest.md +1 -0
- package/docs/models/HealthieGetGoalsRequest.md +1 -0
- package/docs/models/HealthieGetInsurancePaymentsRequest.md +1 -0
- package/docs/models/HealthieGetInsurancePlansRequest.md +1 -0
- package/docs/models/HealthieGetInvoiceRequest.md +1 -0
- package/docs/models/HealthieGetInvoicesRequest.md +1 -0
- package/docs/models/HealthieGetLabOrderRequest.md +1 -0
- package/docs/models/HealthieGetLabOrdersRequest.md +1 -0
- package/docs/models/HealthieGetLabResultRequest.md +1 -0
- package/docs/models/HealthieGetMedicationsRequest.md +1 -0
- package/docs/models/HealthieGetMetricEntriesRequest.md +1 -0
- package/docs/models/HealthieGetOfferingRequest.md +1 -0
- package/docs/models/HealthieGetOfferingsRequest.md +1 -0
- package/docs/models/HealthieGetOnboardingFlowRequest.md +1 -0
- package/docs/models/HealthieGetOnboardingFlowsRequest.md +1 -0
- package/docs/models/HealthieGetOnboardingItemRequest.md +1 -0
- package/docs/models/HealthieGetOrganizationDetailedRequest.md +1 -0
- package/docs/models/HealthieGetOrganizationMembersRequest.md +1 -0
- package/docs/models/HealthieGetOrganizationRequest.md +1 -0
- package/docs/models/HealthieGetPatientDefaultPharmacyRequest.md +1 -0
- package/docs/models/HealthieGetPatientDiagnosesRequest.md +1 -0
- package/docs/models/HealthieGetPatientDocumentsRequest.md +1 -0
- package/docs/models/HealthieGetPatientEncounterRequest.md +1 -0
- package/docs/models/HealthieGetPatientImmunizationsRequest.md +1 -0
- package/docs/models/HealthieGetPatientJsonRequest.md +1 -0
- package/docs/models/HealthieGetPatientNotesRequest.md +1 -0
- package/docs/models/HealthieGetPatientProblemsRequest.md +1 -0
- package/docs/models/HealthieGetPatientRequest.md +1 -0
- package/docs/models/HealthieGetPharmacyRequest.md +1 -0
- package/docs/models/HealthieGetProgramRequest.md +1 -0
- package/docs/models/HealthieGetProgramsRequest.md +1 -0
- package/docs/models/HealthieGetProviderRequest.md +1 -0
- package/docs/models/HealthieGetReceivedFaxRequest.md +1 -0
- package/docs/models/HealthieGetReceivedFaxesRequest.md +1 -0
- package/docs/models/HealthieGetSentFaxRequest.md +1 -0
- package/docs/models/HealthieGetSentFaxesRequest.md +1 -0
- package/docs/models/HealthieGetSuperBillRequest.md +1 -0
- package/docs/models/HealthieGetSuperBillsRequest.md +1 -0
- package/docs/models/HealthieGetTagsRequest.md +1 -0
- package/docs/models/HealthieGetTaskRequest.md +1 -0
- package/docs/models/HealthieGetTasksRequest.md +1 -0
- package/docs/models/HealthieGetUnassociatedCompletedOnboardingItemsRequest.md +1 -0
- package/docs/models/HealthieGetUserGroupRequest.md +1 -0
- package/docs/models/HealthieGetUserGroupsRequest.md +1 -0
- package/docs/models/HealthieLinkEncountersToEpisodeRequest.md +1 -0
- package/docs/models/HealthieListOrganizationMembersRequest.md +1 -0
- package/docs/models/HealthieListPatientsRequest.md +1 -0
- package/docs/models/HealthieMarkTasksAsSeenRequest.md +1 -0
- package/docs/models/HealthieParseCcdaDocumentRequest.md +1 -0
- package/docs/models/HealthieRemoveAcceptedInsurancePlanRequest.md +1 -0
- package/docs/models/HealthieRemoveAppliedTagRequest.md +1 -0
- package/docs/models/HealthieRemoveDiagnosisRequest.md +1 -0
- package/docs/models/HealthieSearchPatientsRequest.md +1 -0
- package/docs/models/HealthieSearchPharmaciesRequest.md +1 -0
- package/docs/models/HealthieSendChatMessageRequest.md +1 -0
- package/docs/models/HealthieSendFaxRequest.md +1 -0
- package/docs/models/HealthieShareFormRequest.md +1 -0
- package/docs/models/HealthieSignUpPatientRequest.md +1 -0
- package/docs/models/HealthieStorePaymentCardRequest.md +1 -0
- package/docs/models/HealthieUnlinkEncountersFromEpisodeRequest.md +1 -0
- package/docs/models/HealthieUpdateAppointmentRequest.md +1 -0
- package/docs/models/HealthieUpdateAppointmentSettingRequest.md +1 -0
- package/docs/models/HealthieUpdateAppointmentTypeRequest.md +1 -0
- package/docs/models/HealthieUpdateBillingItemRequest.md +1 -0
- package/docs/models/HealthieUpdateCarePlanRequest.md +1 -0
- package/docs/models/HealthieUpdateCms1500Request.md +1 -0
- package/docs/models/HealthieUpdateConversationRequest.md +1 -0
- package/docs/models/HealthieUpdateDiagnosisRequest.md +1 -0
- package/docs/models/HealthieUpdateDocumentRequest.md +1 -0
- package/docs/models/HealthieUpdateEntryRequest.md +1 -0
- package/docs/models/HealthieUpdateEpisodeOfCareRequest.md +1 -0
- package/docs/models/HealthieUpdateFamilyHistoryRequest.md +1 -0
- package/docs/models/HealthieUpdateFormRequest.md +1 -0
- package/docs/models/HealthieUpdateGoalRequest.md +1 -0
- package/docs/models/HealthieUpdateImmunizationRequest.md +1 -0
- package/docs/models/HealthieUpdateInsurancePaymentDepositStatusRequest.md +1 -0
- package/docs/models/HealthieUpdateInvoiceRequest.md +1 -0
- package/docs/models/HealthieUpdateLabOrderRequest.md +1 -0
- package/docs/models/HealthieUpdateLocationRequest.md +1 -0
- package/docs/models/HealthieUpdateManualInsurancePaymentRequest.md +1 -0
- package/docs/models/HealthieUpdateMedicationRequest.md +1 -0
- package/docs/models/HealthieUpdateOfferingRequest.md +1 -0
- package/docs/models/HealthieUpdateOnboardingFlowRequest.md +1 -0
- package/docs/models/HealthieUpdateOnboardingItemRequest.md +1 -0
- package/docs/models/HealthieUpdateOrganizationMembershipRequest.md +1 -0
- package/docs/models/HealthieUpdatePatientInsuranceBillingRequest.md +2 -1
- package/docs/models/HealthieUpdatePatientRequest.md +1 -0
- package/docs/models/HealthieUpdateProgramRequest.md +1 -0
- package/docs/models/HealthieUpdateSuperBillRequest.md +1 -0
- package/docs/models/HealthieUpdateTagRequest.md +1 -0
- package/docs/models/HealthieUpdateTaskRequest.md +1 -0
- package/docs/models/HealthieUpdateUserGroupRequest.md +1 -0
- package/docs/models/HealthieUpdateUserRequest.md +1 -0
- package/docs/models/ImportVitalsResponse.md +3 -0
- package/docs/models/OpenLoopVitalsMirrorResult.md +21 -0
- package/docs/models/PatientDemographics.md +5 -0
- package/docs/models/RecordVitalsResponse.md +1 -0
- package/docs/models/RescheduleAppointmentRequest.md +10 -1
- package/docs/models/SetPreferredPharmacyRequest.md +2 -0
- package/docs/models/SetPreferredPharmacyResponse.md +7 -3
- package/docs/models/Slot.md +2 -0
- package/docs/models/SteadyMDVitalsMirrorResult.md +21 -0
- package/docs/models/UpdateDriversLicenseRequest.md +20 -0
- package/docs/models/UpdateDriversLicenseResponse.md +20 -0
- package/docs/models/fieldagent.Encounter.md +4 -0
- package/docs/models/index.md +8 -1
- package/docs/models/patient.Encounter.md +4 -0
- package/docs/models/patient.LoginResponse.md +2 -0
- package/docs/models/patient.RegisterRequest.md +1 -0
- package/docs/models/patient.RegisterResponse.md +4 -0
- package/docs/models/patient.UploadPhotoResponse.md +3 -0
- package/docs/operations/appointments.book.md +9 -3
- package/docs/operations/appointments.cancel.md +49 -5
- package/docs/operations/appointments.createSlot.md +3 -1
- package/docs/operations/appointments.listPatientAppointments.md +2 -0
- package/docs/operations/appointments.listSlots.md +3 -1
- package/docs/operations/appointments.reschedule.md +41 -6
- package/docs/operations/connectors.athenaAddPreferredPharmacy.md +2 -2
- package/docs/operations/connectors.athenaGetInsurancePackages.md +2 -6
- package/docs/operations/connectors.athenaUpdateDriversLicense.md +11 -12
- package/docs/operations/connectors.athenaUploadPatientPhoto.md +2 -2
- package/docs/operations/connectors.healthieAcceptInsurancePlans.md +3 -1
- package/docs/operations/connectors.healthieAddDiagnosis.md +3 -1
- package/docs/operations/connectors.healthieAddPharmacy.md +3 -1
- package/docs/operations/connectors.healthieBulkApplyTags.md +3 -1
- package/docs/operations/connectors.healthieBulkUpdateClients.md +3 -1
- package/docs/operations/connectors.healthieBulkUpdateDiagnoses.md +3 -1
- package/docs/operations/connectors.healthieCloseConversation.md +3 -1
- package/docs/operations/connectors.healthieCompleteCcdaReconciliation.md +3 -1
- package/docs/operations/connectors.healthieCompleteCheckout.md +3 -1
- package/docs/operations/connectors.healthieCopyForm.md +3 -3
- package/docs/operations/connectors.healthieCopyOffering.md +3 -1
- package/docs/operations/connectors.healthieCreateApiKey.md +3 -7
- package/docs/operations/connectors.healthieCreateAppointment.md +3 -1
- package/docs/operations/connectors.healthieCreateAppointmentSetting.md +3 -1
- package/docs/operations/connectors.healthieCreateAppointmentType.md +3 -1
- package/docs/operations/connectors.healthieCreateAvailabilitiesBulk.md +3 -1
- package/docs/operations/connectors.healthieCreateAvailability.md +3 -1
- package/docs/operations/connectors.healthieCreateBillingItem.md +3 -1
- package/docs/operations/connectors.healthieCreateCarePlan.md +3 -1
- package/docs/operations/connectors.healthieCreateCms1500.md +3 -1
- package/docs/operations/connectors.healthieCreateCompletedOnboardingItem.md +3 -7
- package/docs/operations/connectors.healthieCreateConversation.md +3 -1
- package/docs/operations/connectors.healthieCreateEntry.md +3 -1
- package/docs/operations/connectors.healthieCreateEpisodeOfCare.md +3 -1
- package/docs/operations/connectors.healthieCreateFamilyHistory.md +3 -1
- package/docs/operations/connectors.healthieCreateForm.md +5 -5
- package/docs/operations/connectors.healthieCreateFormAnswerGroup.md +3 -1
- package/docs/operations/connectors.healthieCreateFormCompletionRequest.md +3 -3
- package/docs/operations/connectors.healthieCreateGoal.md +3 -1
- package/docs/operations/connectors.healthieCreateImmunization.md +3 -1
- package/docs/operations/connectors.healthieCreateInsurancePayment.md +3 -1
- package/docs/operations/connectors.healthieCreateInvoice.md +3 -1
- package/docs/operations/connectors.healthieCreateLabOrder.md +3 -1
- package/docs/operations/connectors.healthieCreateLocation.md +3 -1
- package/docs/operations/connectors.healthieCreateMedication.md +3 -1
- package/docs/operations/connectors.healthieCreateMetricEntry.md +3 -7
- package/docs/operations/connectors.healthieCreateNote.md +3 -1
- package/docs/operations/connectors.healthieCreateOffering.md +3 -1
- package/docs/operations/connectors.healthieCreateOnboardingFlow.md +3 -7
- package/docs/operations/connectors.healthieCreateOnboardingItem.md +3 -1
- package/docs/operations/connectors.healthieCreateOpenLoopForm.md +3 -1
- package/docs/operations/connectors.healthieCreateOrganizationMembership.md +3 -1
- package/docs/operations/connectors.healthieCreatePatient.md +3 -1
- package/docs/operations/connectors.healthieCreatePersonalizationQuestionnaire.md +3 -1
- package/docs/operations/connectors.healthieCreateProgram.md +3 -1
- package/docs/operations/connectors.healthieCreateRupaOrder.md +3 -1
- package/docs/operations/connectors.healthieCreateSuperBill.md +3 -1
- package/docs/operations/connectors.healthieCreateTag.md +3 -7
- package/docs/operations/connectors.healthieCreateTask.md +3 -1
- package/docs/operations/connectors.healthieCreateUserGroup.md +3 -1
- package/docs/operations/connectors.healthieDeleteApiKey.md +3 -1
- package/docs/operations/connectors.healthieDeleteAppointment.md +3 -7
- package/docs/operations/connectors.healthieDeleteAppointmentType.md +3 -1
- package/docs/operations/connectors.healthieDeleteAvailability.md +3 -1
- package/docs/operations/connectors.healthieDeleteBillingItem.md +3 -1
- package/docs/operations/connectors.healthieDeleteCarePlan.md +3 -1
- package/docs/operations/connectors.healthieDeleteCms1500.md +3 -1
- package/docs/operations/connectors.healthieDeleteDocument.md +3 -1
- package/docs/operations/connectors.healthieDeleteEntry.md +3 -1
- package/docs/operations/connectors.healthieDeleteEpisodeOfCare.md +3 -1
- package/docs/operations/connectors.healthieDeleteFamilyHistory.md +3 -1
- package/docs/operations/connectors.healthieDeleteForm.md +3 -1
- package/docs/operations/connectors.healthieDeleteFormCompletionRequest.md +3 -7
- package/docs/operations/connectors.healthieDeleteGoal.md +3 -1
- package/docs/operations/connectors.healthieDeleteInvoice.md +3 -1
- package/docs/operations/connectors.healthieDeleteManualInsurancePayment.md +3 -1
- package/docs/operations/connectors.healthieDeleteMedication.md +3 -1
- package/docs/operations/connectors.healthieDeleteOffering.md +3 -1
- package/docs/operations/connectors.healthieDeleteOnboardingFlow.md +3 -7
- package/docs/operations/connectors.healthieDeleteOnboardingItem.md +3 -1
- package/docs/operations/connectors.healthieDeleteOrganizationMembership.md +3 -1
- package/docs/operations/connectors.healthieDeleteProgram.md +3 -1
- package/docs/operations/connectors.healthieDeleteSuperBill.md +3 -1
- package/docs/operations/connectors.healthieDeleteTag.md +3 -1
- package/docs/operations/connectors.healthieDeleteTask.md +3 -1
- package/docs/operations/connectors.healthieDeleteUserGroup.md +3 -7
- package/docs/operations/connectors.healthieEditAvailability.md +3 -1
- package/docs/operations/connectors.healthieFillLabResultReviewForm.md +3 -1
- package/docs/operations/connectors.healthieFindAndBookFirstAvailableSlot.md +4 -4
- package/docs/operations/connectors.healthieGetApiKeys.md +3 -1
- package/docs/operations/connectors.healthieGetAppointment.md +3 -7
- package/docs/operations/connectors.healthieGetAppointmentBookingWarnings.md +3 -3
- package/docs/operations/connectors.healthieGetAppointmentSetting.md +3 -3
- package/docs/operations/connectors.healthieGetAppointmentType.md +3 -1
- package/docs/operations/connectors.healthieGetAppointmentTypes.md +3 -3
- package/docs/operations/connectors.healthieGetAppointments.md +3 -3
- package/docs/operations/connectors.healthieGetAvailabilities.md +3 -3
- package/docs/operations/connectors.healthieGetAvailability.md +3 -1
- package/docs/operations/connectors.healthieGetAvailableItemTypes.md +3 -7
- package/docs/operations/connectors.healthieGetAvailableSlotsForRange.md +4 -4
- package/docs/operations/connectors.healthieGetBillingItem.md +3 -1
- package/docs/operations/connectors.healthieGetBillingItems.md +3 -1
- package/docs/operations/connectors.healthieGetCarePlan.md +3 -1
- package/docs/operations/connectors.healthieGetCarePlans.md +3 -3
- package/docs/operations/connectors.healthieGetCms1500.md +3 -1
- package/docs/operations/connectors.healthieGetCms1500s.md +5 -5
- package/docs/operations/connectors.healthieGetConversation.md +3 -1
- package/docs/operations/connectors.healthieGetConversationMemberships.md +3 -1
- package/docs/operations/connectors.healthieGetCurrentUser.md +3 -1
- package/docs/operations/connectors.healthieGetCurrentUserId.md +3 -1
- package/docs/operations/connectors.healthieGetDaysAvailableForRange.md +5 -5
- package/docs/operations/connectors.healthieGetDietitianId.md +3 -1
- package/docs/operations/connectors.healthieGetDocument.md +3 -3
- package/docs/operations/connectors.healthieGetDocuments.md +3 -1
- package/docs/operations/connectors.healthieGetEntries.md +3 -1
- package/docs/operations/connectors.healthieGetEntry.md +5 -5
- package/docs/operations/connectors.healthieGetEpisodesOfCare.md +3 -3
- package/docs/operations/connectors.healthieGetForm.md +3 -1
- package/docs/operations/connectors.healthieGetFormAnswerGroups.md +3 -3
- package/docs/operations/connectors.healthieGetFormCompletionRequests.md +3 -1
- package/docs/operations/connectors.healthieGetForms.md +3 -1
- package/docs/operations/connectors.healthieGetGoal.md +3 -3
- package/docs/operations/connectors.healthieGetGoalHistories.md +3 -3
- package/docs/operations/connectors.healthieGetGoals.md +3 -3
- package/docs/operations/connectors.healthieGetInsurancePayments.md +3 -3
- package/docs/operations/connectors.healthieGetInsurancePlans.md +3 -1
- package/docs/operations/connectors.healthieGetInvoice.md +3 -3
- package/docs/operations/connectors.healthieGetInvoices.md +3 -1
- package/docs/operations/connectors.healthieGetLabOrder.md +3 -1
- package/docs/operations/connectors.healthieGetLabOrders.md +3 -3
- package/docs/operations/connectors.healthieGetLabResult.md +3 -1
- package/docs/operations/connectors.healthieGetMedications.md +3 -3
- package/docs/operations/connectors.healthieGetMetricEntries.md +3 -3
- package/docs/operations/connectors.healthieGetOffering.md +3 -1
- package/docs/operations/connectors.healthieGetOfferings.md +5 -5
- package/docs/operations/connectors.healthieGetOnboardingFlow.md +5 -5
- package/docs/operations/connectors.healthieGetOnboardingFlows.md +5 -5
- package/docs/operations/connectors.healthieGetOnboardingItem.md +3 -1
- package/docs/operations/connectors.healthieGetOrganization.md +3 -1
- package/docs/operations/connectors.healthieGetOrganizationDetailed.md +3 -7
- package/docs/operations/connectors.healthieGetOrganizationMembers.md +3 -1
- package/docs/operations/connectors.healthieGetPatient.md +3 -1
- package/docs/operations/connectors.healthieGetPatientDefaultPharmacy.md +3 -1
- package/docs/operations/connectors.healthieGetPatientDiagnoses.md +3 -1
- package/docs/operations/connectors.healthieGetPatientDocuments.md +3 -7
- package/docs/operations/connectors.healthieGetPatientEncounter.md +3 -3
- package/docs/operations/connectors.healthieGetPatientImmunizations.md +3 -1
- package/docs/operations/connectors.healthieGetPatientJson.md +3 -1
- package/docs/operations/connectors.healthieGetPatientNotes.md +3 -1
- package/docs/operations/connectors.healthieGetPatientProblems.md +3 -1
- package/docs/operations/connectors.healthieGetPharmacy.md +3 -1
- package/docs/operations/connectors.healthieGetProgram.md +3 -1
- package/docs/operations/connectors.healthieGetPrograms.md +3 -3
- package/docs/operations/connectors.healthieGetProvider.md +3 -1
- package/docs/operations/connectors.healthieGetReceivedFax.md +3 -1
- package/docs/operations/connectors.healthieGetReceivedFaxes.md +3 -1
- package/docs/operations/connectors.healthieGetSentFax.md +3 -1
- package/docs/operations/connectors.healthieGetSentFaxes.md +3 -3
- package/docs/operations/connectors.healthieGetSuperBill.md +3 -1
- package/docs/operations/connectors.healthieGetSuperBills.md +5 -5
- package/docs/operations/connectors.healthieGetTags.md +3 -1
- package/docs/operations/connectors.healthieGetTask.md +3 -1
- package/docs/operations/connectors.healthieGetTasks.md +5 -5
- package/docs/operations/connectors.healthieGetUnassociatedCompletedOnboardingItems.md +3 -7
- package/docs/operations/connectors.healthieGetUserGroup.md +3 -1
- package/docs/operations/connectors.healthieGetUserGroups.md +5 -5
- package/docs/operations/connectors.healthieLinkEncountersToEpisode.md +3 -1
- package/docs/operations/connectors.healthieListOrganizationMembers.md +5 -5
- package/docs/operations/connectors.healthieListPatients.md +5 -5
- package/docs/operations/connectors.healthieMarkTasksAsSeen.md +3 -7
- package/docs/operations/connectors.healthieParseCcdaDocument.md +3 -1
- package/docs/operations/connectors.healthieRemoveAcceptedInsurancePlan.md +3 -1
- package/docs/operations/connectors.healthieRemoveAppliedTag.md +3 -1
- package/docs/operations/connectors.healthieRemoveDiagnosis.md +3 -1
- package/docs/operations/connectors.healthieSearchPatients.md +3 -1
- package/docs/operations/connectors.healthieSearchPharmacies.md +3 -3
- package/docs/operations/connectors.healthieSendChatMessage.md +3 -1
- package/docs/operations/connectors.healthieSendFax.md +3 -3
- package/docs/operations/connectors.healthieShareForm.md +3 -1
- package/docs/operations/connectors.healthieSignUpPatient.md +3 -1
- package/docs/operations/connectors.healthieStorePaymentCard.md +3 -1
- package/docs/operations/connectors.healthieUnlinkEncountersFromEpisode.md +3 -1
- package/docs/operations/connectors.healthieUpdateAppointment.md +3 -1
- package/docs/operations/connectors.healthieUpdateAppointmentSetting.md +3 -1
- package/docs/operations/connectors.healthieUpdateAppointmentType.md +3 -1
- package/docs/operations/connectors.healthieUpdateBillingItem.md +3 -1
- package/docs/operations/connectors.healthieUpdateCarePlan.md +3 -1
- package/docs/operations/connectors.healthieUpdateCms1500.md +3 -1
- package/docs/operations/connectors.healthieUpdateConversation.md +3 -1
- package/docs/operations/connectors.healthieUpdateDiagnosis.md +3 -1
- package/docs/operations/connectors.healthieUpdateDocument.md +3 -1
- package/docs/operations/connectors.healthieUpdateEntry.md +3 -1
- package/docs/operations/connectors.healthieUpdateEpisodeOfCare.md +3 -1
- package/docs/operations/connectors.healthieUpdateFamilyHistory.md +3 -1
- package/docs/operations/connectors.healthieUpdateForm.md +3 -3
- package/docs/operations/connectors.healthieUpdateGoal.md +3 -1
- package/docs/operations/connectors.healthieUpdateImmunization.md +3 -1
- package/docs/operations/connectors.healthieUpdateInsurancePaymentDepositStatus.md +3 -1
- package/docs/operations/connectors.healthieUpdateInvoice.md +3 -1
- package/docs/operations/connectors.healthieUpdateLabOrder.md +3 -1
- package/docs/operations/connectors.healthieUpdateLocation.md +3 -1
- package/docs/operations/connectors.healthieUpdateManualInsurancePayment.md +3 -1
- package/docs/operations/connectors.healthieUpdateMedication.md +3 -1
- package/docs/operations/connectors.healthieUpdateOffering.md +3 -1
- package/docs/operations/connectors.healthieUpdateOnboardingFlow.md +3 -3
- package/docs/operations/connectors.healthieUpdateOnboardingItem.md +3 -3
- package/docs/operations/connectors.healthieUpdateOrganizationMembership.md +3 -1
- package/docs/operations/connectors.healthieUpdatePatient.md +3 -1
- package/docs/operations/connectors.healthieUpdatePatientInsuranceBilling.md +7 -5
- package/docs/operations/connectors.healthieUpdateProgram.md +3 -1
- package/docs/operations/connectors.healthieUpdateSuperBill.md +3 -1
- package/docs/operations/connectors.healthieUpdateTag.md +3 -1
- package/docs/operations/connectors.healthieUpdateTask.md +3 -1
- package/docs/operations/connectors.healthieUpdateUser.md +3 -1
- package/docs/operations/connectors.healthieUpdateUserGroup.md +3 -1
- package/docs/operations/fieldagent.listEncounters.md +4 -0
- package/docs/operations/fieldagent.listPatients.md +10 -1
- package/docs/operations/patient.addInsurance.md +11 -9
- package/docs/operations/patient.analyzeIdentityDocument.md +1 -1
- package/docs/operations/patient.checkInEncounter.md +1 -1
- package/docs/operations/patient.createEncounter.md +4 -0
- package/docs/operations/patient.getCheckinCheckin.md +4 -0
- package/docs/operations/patient.getCurrentCareSessionCareSessionsCurrent.md +4 -0
- package/docs/operations/patient.getEncounter.md +4 -0
- package/docs/operations/patient.getLatestEncounter.md +4 -0
- package/docs/operations/patient.getPatient.md +9 -0
- package/docs/operations/patient.getPatientSidebarPatientSidebar.md +14 -1
- package/docs/operations/patient.importVitals.md +21 -1
- package/docs/operations/patient.listEncounters.md +4 -0
- package/docs/operations/patient.login.md +2 -0
- package/docs/operations/patient.register.md +52 -44
- package/docs/operations/patient.setPreferredPharmacy.md +14 -9
- package/docs/operations/patient.updateDriversLicense.md +127 -0
- package/docs/operations/patient.uploadPhoto.md +5 -2
- package/docs/operations/vitals.recordVitals.md +9 -3
- package/package.json +1 -1
- package/docs/models/AthenaUpdateDriversLicenseResponse.md +0 -15
package/dist/index.js
CHANGED
|
@@ -868,99 +868,74 @@ function CreateMedicationRequestToJSONTyped(value, ignoreDiscriminator = false)
|
|
|
868
868
|
};
|
|
869
869
|
}
|
|
870
870
|
|
|
871
|
-
// src/models/openapi-generated/patient/models/
|
|
872
|
-
function
|
|
873
|
-
return
|
|
874
|
-
}
|
|
875
|
-
|
|
876
|
-
// src/models/openapi-generated/patient/models/EncounterHospitalization.ts
|
|
877
|
-
function EncounterHospitalizationToJSON(json) {
|
|
878
|
-
return EncounterHospitalizationToJSONTyped(json, false);
|
|
871
|
+
// src/models/openapi-generated/patient/models/CreateEncounterLocationRequest.ts
|
|
872
|
+
function CreateEncounterLocationRequestToJSON(json) {
|
|
873
|
+
return CreateEncounterLocationRequestToJSONTyped(json, false);
|
|
879
874
|
}
|
|
880
|
-
function
|
|
875
|
+
function CreateEncounterLocationRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
881
876
|
if (value == null) {
|
|
882
877
|
return value;
|
|
883
878
|
}
|
|
884
879
|
return {
|
|
885
|
-
"
|
|
886
|
-
"
|
|
887
|
-
"
|
|
888
|
-
"
|
|
889
|
-
"
|
|
890
|
-
"re_admission_code": value["re_admission_code"]
|
|
880
|
+
"location_display": value["location_display"],
|
|
881
|
+
"location_id": value["location_id"],
|
|
882
|
+
"period_end": value["period_end"],
|
|
883
|
+
"period_start": value["period_start"],
|
|
884
|
+
"status": value["status"]
|
|
891
885
|
};
|
|
892
886
|
}
|
|
893
887
|
|
|
894
|
-
// src/models/openapi-generated/patient/models/
|
|
895
|
-
function
|
|
896
|
-
return
|
|
888
|
+
// src/models/openapi-generated/patient/models/CreateEncounterParticipantRequest.ts
|
|
889
|
+
function CreateEncounterParticipantRequestToJSON(json) {
|
|
890
|
+
return CreateEncounterParticipantRequestToJSONTyped(json, false);
|
|
897
891
|
}
|
|
898
|
-
function
|
|
892
|
+
function CreateEncounterParticipantRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
899
893
|
if (value == null) {
|
|
900
894
|
return value;
|
|
901
895
|
}
|
|
902
896
|
return {
|
|
903
|
-
"
|
|
904
|
-
"
|
|
905
|
-
"
|
|
906
|
-
"
|
|
897
|
+
"participant_type": value["participant_type"],
|
|
898
|
+
"period_end": value["period_end"],
|
|
899
|
+
"period_start": value["period_start"],
|
|
900
|
+
"practitioner_display": value["practitioner_display"],
|
|
901
|
+
"practitioner_id": value["practitioner_id"]
|
|
907
902
|
};
|
|
908
903
|
}
|
|
909
904
|
|
|
910
|
-
// src/models/openapi-generated/patient/models/
|
|
911
|
-
function
|
|
912
|
-
return
|
|
913
|
-
}
|
|
914
|
-
|
|
915
|
-
// src/models/openapi-generated/patient/models/LocationStatus.ts
|
|
916
|
-
function LocationStatusToJSON(value) {
|
|
917
|
-
return value;
|
|
918
|
-
}
|
|
919
|
-
|
|
920
|
-
// src/models/openapi-generated/patient/models/EncounterLocation.ts
|
|
921
|
-
function EncounterLocationToJSON(json) {
|
|
922
|
-
return EncounterLocationToJSONTyped(json, false);
|
|
905
|
+
// src/models/openapi-generated/patient/models/CreateEncounterDiagnosisRequest.ts
|
|
906
|
+
function CreateEncounterDiagnosisRequestToJSON(json) {
|
|
907
|
+
return CreateEncounterDiagnosisRequestToJSONTyped(json, false);
|
|
923
908
|
}
|
|
924
|
-
function
|
|
909
|
+
function CreateEncounterDiagnosisRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
925
910
|
if (value == null) {
|
|
926
911
|
return value;
|
|
927
912
|
}
|
|
928
913
|
return {
|
|
929
|
-
"
|
|
930
|
-
"
|
|
931
|
-
"
|
|
932
|
-
"
|
|
933
|
-
"status": LocationStatusToJSON(value["status"])
|
|
914
|
+
"condition_display": value["condition_display"],
|
|
915
|
+
"condition_id": value["condition_id"],
|
|
916
|
+
"rank": value["rank"],
|
|
917
|
+
"use_code": value["use_code"]
|
|
934
918
|
};
|
|
935
919
|
}
|
|
936
920
|
|
|
937
|
-
// src/models/openapi-generated/patient/models/
|
|
938
|
-
function
|
|
939
|
-
return
|
|
940
|
-
}
|
|
941
|
-
|
|
942
|
-
// src/models/openapi-generated/patient/models/EncounterParticipant.ts
|
|
943
|
-
function EncounterParticipantToJSON(json) {
|
|
944
|
-
return EncounterParticipantToJSONTyped(json, false);
|
|
921
|
+
// src/models/openapi-generated/patient/models/CreateEncounterHospitalizationRequest.ts
|
|
922
|
+
function CreateEncounterHospitalizationRequestToJSON(json) {
|
|
923
|
+
return CreateEncounterHospitalizationRequestToJSONTyped(json, false);
|
|
945
924
|
}
|
|
946
|
-
function
|
|
925
|
+
function CreateEncounterHospitalizationRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
947
926
|
if (value == null) {
|
|
948
927
|
return value;
|
|
949
928
|
}
|
|
950
929
|
return {
|
|
951
|
-
"
|
|
952
|
-
"
|
|
953
|
-
"
|
|
954
|
-
"
|
|
955
|
-
"
|
|
930
|
+
"admit_source_code": value["admit_source_code"],
|
|
931
|
+
"destination_id": value["destination_id"],
|
|
932
|
+
"discharge_disposition": value["discharge_disposition"],
|
|
933
|
+
"origin_id": value["origin_id"],
|
|
934
|
+
"pre_admission_id": value["pre_admission_id"],
|
|
935
|
+
"re_admission_code": value["re_admission_code"]
|
|
956
936
|
};
|
|
957
937
|
}
|
|
958
938
|
|
|
959
|
-
// src/models/openapi-generated/patient/models/EncounterStatus.ts
|
|
960
|
-
function EncounterStatusToJSON(value) {
|
|
961
|
-
return value;
|
|
962
|
-
}
|
|
963
|
-
|
|
964
939
|
// src/models/openapi-generated/patient/models/CreateEncounterRequest.ts
|
|
965
940
|
function CreateEncounterRequestToJSON(json) {
|
|
966
941
|
return CreateEncounterRequestToJSONTyped(json, false);
|
|
@@ -972,18 +947,18 @@ function CreateEncounterRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
972
947
|
return {
|
|
973
948
|
"appointment_id": value["appointment_id"],
|
|
974
949
|
"created_by": value["created_by"],
|
|
975
|
-
"created_date": value["created_date"]
|
|
976
|
-
"diagnoses": value["diagnoses"] == null ? void 0 : value["diagnoses"].map(
|
|
977
|
-
"encounter_class":
|
|
950
|
+
"created_date": value["created_date"],
|
|
951
|
+
"diagnoses": value["diagnoses"] == null ? void 0 : value["diagnoses"].map(CreateEncounterDiagnosisRequestToJSON),
|
|
952
|
+
"encounter_class": value["encounter_class"],
|
|
978
953
|
"encounter_id": value["encounter_id"],
|
|
979
954
|
"fhir_id": value["fhir_id"],
|
|
980
|
-
"hospitalization":
|
|
955
|
+
"hospitalization": CreateEncounterHospitalizationRequestToJSON(value["hospitalization"]),
|
|
981
956
|
"length_minutes": value["length_minutes"],
|
|
982
|
-
"locations": value["locations"] == null ? void 0 : value["locations"].map(
|
|
983
|
-
"participants": value["participants"] == null ? void 0 : value["participants"].map(
|
|
957
|
+
"locations": value["locations"] == null ? void 0 : value["locations"].map(CreateEncounterLocationRequestToJSON),
|
|
958
|
+
"participants": value["participants"] == null ? void 0 : value["participants"].map(CreateEncounterParticipantRequestToJSON),
|
|
984
959
|
"patient_id": value["patient_id"],
|
|
985
|
-
"period_end": value["period_end"]
|
|
986
|
-
"period_start": value["period_start"]
|
|
960
|
+
"period_end": value["period_end"],
|
|
961
|
+
"period_start": value["period_start"],
|
|
987
962
|
"priority_code": value["priority_code"],
|
|
988
963
|
"priority_display": value["priority_display"],
|
|
989
964
|
"reason_code": value["reason_code"],
|
|
@@ -992,7 +967,7 @@ function CreateEncounterRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
992
967
|
"service_provider_id": value["service_provider_id"],
|
|
993
968
|
"service_type_code": value["service_type_code"],
|
|
994
969
|
"service_type_display": value["service_type_display"],
|
|
995
|
-
"status":
|
|
970
|
+
"status": value["status"],
|
|
996
971
|
"type_code": value["type_code"],
|
|
997
972
|
"type_display": value["type_display"]
|
|
998
973
|
};
|
|
@@ -1118,6 +1093,11 @@ var PatientClient = class extends BaseServiceClient {
|
|
|
1118
1093
|
body: request
|
|
1119
1094
|
});
|
|
1120
1095
|
}
|
|
1096
|
+
updateDriversLicense(request) {
|
|
1097
|
+
return this.send("PUT", "/patients/drivers-license", {
|
|
1098
|
+
body: request
|
|
1099
|
+
});
|
|
1100
|
+
}
|
|
1121
1101
|
updateDemographics(request) {
|
|
1122
1102
|
return this.send("PUT", "/patients/demographics", {
|
|
1123
1103
|
body: request
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
- [`addEncounterReason`](../operations/connectors.athenaAddEncounterReason.md) — Add encounter reason (athenahealth)
|
|
4
4
|
- [`addLabResultDocument`](../operations/connectors.athenaAddLabResultDocument.md) — Add lab result document (athenahealth)
|
|
5
|
-
- [`addPreferredPharmacy`](../operations/connectors.athenaAddPreferredPharmacy.md) — Athena's PUT /chart/{id}/pharmacies/preferred 400s without clinicalproviderid in the body — there's no way to add "a" preferred pharmacy without saying which one
|
|
5
|
+
- [`addPreferredPharmacy`](../operations/connectors.athenaAddPreferredPharmacy.md) — Athena's PUT /chart/{id}/pharmacies/preferred 400s without either clinicalproviderid or ncpdpid in the body — there's no way to add "a" preferred pharmacy without saying which one
|
|
6
6
|
- [`answerHealthQuestion`](../operations/connectors.athenaAnswerHealthQuestion.md) — Answer health question (athenahealth)
|
|
7
7
|
- [`bookAppointment`](../operations/connectors.athenaBookAppointment.md) — Book an open appointment slot (without the telehealth deep link step)
|
|
8
8
|
- [`cancelAppointment`](../operations/connectors.athenaCancelAppointment.md) — Cancel appointment (athenahealth)
|
|
@@ -168,7 +168,7 @@
|
|
|
168
168
|
- [`unsubscribeMedicationChanges`](../operations/connectors.athenaUnsubscribeMedicationChanges.md) — Unsubscribe medication changes (athenahealth)
|
|
169
169
|
- [`updateAllergies`](../operations/connectors.athenaUpdateAllergies.md) — Replace the patient's full allergy list (Athena PUT semantics)
|
|
170
170
|
- [`updateAppointmentCustomField`](../operations/connectors.athenaUpdateAppointmentCustomField.md) — Set a single TEXT custom field on an appointment
|
|
171
|
-
- [`updateDriversLicense`](../operations/connectors.athenaUpdateDriversLicense.md) —
|
|
171
|
+
- [`updateDriversLicense`](../operations/connectors.athenaUpdateDriversLicense.md) — Create or replace the patient's Athena driver's-license image
|
|
172
172
|
- [`updateEncounterAssessment`](../operations/connectors.athenaUpdateEncounterAssessment.md) — Update encounter assessment (athenahealth)
|
|
173
173
|
- [`updateEncounterDiagnosis`](../operations/connectors.athenaUpdateEncounterDiagnosis.md) — Update encounter diagnosis (athenahealth)
|
|
174
174
|
- [`updateEncounterHpi`](../operations/connectors.athenaUpdateEncounterHpi.md) — Populate an encounter's HPI by adding templates (`template_ids`, a list of ids from `get_hpi_templates`) and/or a free-text `section_note`
|
|
@@ -185,5 +185,5 @@
|
|
|
185
185
|
- [`uploadDocument`](../operations/connectors.athenaUploadDocument.md) — `file_bytes` is base64-encoded content (OpenAPI `format: byte` — the same JSON-over-the-wire contract as upload_patient_photo, since JSON has no binary type)
|
|
186
186
|
- [`uploadImagingResultDocument`](../operations/connectors.athenaUploadImagingResultDocument.md) — Upload an imaging result document
|
|
187
187
|
- [`uploadInsuranceCard`](../operations/connectors.athenaUploadInsuranceCard.md) — Upload an insurance card image
|
|
188
|
-
- [`uploadPatientPhoto`](../operations/connectors.athenaUploadPatientPhoto.md) —
|
|
188
|
+
- [`uploadPatientPhoto`](../operations/connectors.athenaUploadPatientPhoto.md) — Create or replace a patient photo
|
|
189
189
|
- [`uploadPrescriptionCardImage`](../operations/connectors.athenaUploadPrescriptionCardImage.md) — Upload a prescription card image
|
|
@@ -198,7 +198,7 @@
|
|
|
198
198
|
- [`updateOnboardingItem`](../operations/connectors.healthieUpdateOnboardingItem.md) — Update an onboarding item
|
|
199
199
|
- [`updateOrganizationMembership`](../operations/connectors.healthieUpdateOrganizationMembership.md) — Update an organization membership (permissions, role, status)
|
|
200
200
|
- [`updatePatient`](../operations/connectors.healthieUpdatePatient.md) — Update an existing patient/client; returns the updated user
|
|
201
|
-
- [`updatePatientInsuranceBilling`](../operations/connectors.healthieUpdatePatientInsuranceBilling.md) —
|
|
201
|
+
- [`updatePatientInsuranceBilling`](../operations/connectors.healthieUpdatePatientInsuranceBilling.md) — Create/update patient insurance policies via updateClient
|
|
202
202
|
- [`updateProgram`](../operations/connectors.healthieUpdateProgram.md) — Update a program
|
|
203
203
|
- [`updateSuperBill`](../operations/connectors.healthieUpdateSuperBill.md) — Update a superbill
|
|
204
204
|
- [`updateTag`](../operations/connectors.healthieUpdateTag.md) — Update a tag name
|
|
@@ -67,6 +67,7 @@
|
|
|
67
67
|
- [`createCurrentScreeningSymptoms`](../operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md) — Submit current symptoms
|
|
68
68
|
- [`updateAddress`](../operations/patient.updateAddress.md) — Update home address
|
|
69
69
|
- [`updateDemographics`](../operations/patient.updateDemographics.md) — Update demographics
|
|
70
|
+
- [`updateDriversLicense`](../operations/patient.updateDriversLicense.md) — Update the patient's driver's license
|
|
70
71
|
- [`updateMedicationStatus`](../operations/patient.updateMedication.md) — Update a medication
|
|
71
72
|
- [`updateAttributes`](../operations/patient.updatePatientAttributes.md) — Update patient attributes
|
|
72
73
|
- [`updateFlags`](../operations/patient.updatePatientFlags.md) — Update patient flags
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:6d74c15aaed7ef44dea79f89e4d08dbafee7f1d4f1b556b166a5697b89d30a64",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AnthropicClient.md",
|
|
@@ -356,7 +356,6 @@
|
|
|
356
356
|
"models/AthenaUpdateAppointmentCustomFieldRequest.md",
|
|
357
357
|
"models/AthenaUpdateAppointmentCustomFieldResponse.md",
|
|
358
358
|
"models/AthenaUpdateDriversLicenseRequest.md",
|
|
359
|
-
"models/AthenaUpdateDriversLicenseResponse.md",
|
|
360
359
|
"models/AthenaUpdateEncounterAssessmentRequest.md",
|
|
361
360
|
"models/AthenaUpdateEncounterAssessmentResponse.md",
|
|
362
361
|
"models/AthenaUpdateEncounterDiagnosisRequest.md",
|
|
@@ -392,6 +391,7 @@
|
|
|
392
391
|
"models/AthenaUploadPatientPhotoResponse.md",
|
|
393
392
|
"models/AthenaUploadPrescriptionCardImageRequest.md",
|
|
394
393
|
"models/AthenaUploadPrescriptionCardImageResponse.md",
|
|
394
|
+
"models/AthenaVitalsMirrorResult.md",
|
|
395
395
|
"models/BloodPressureVital.md",
|
|
396
396
|
"models/BodyHeightVital.md",
|
|
397
397
|
"models/BodyTemperatureVital.md",
|
|
@@ -423,6 +423,7 @@
|
|
|
423
423
|
"models/CalUpdateAvailabilityFromAthenaSlotsResponse.md",
|
|
424
424
|
"models/CalUpdateScheduleRequest.md",
|
|
425
425
|
"models/CalUpdateScheduleResponse.md",
|
|
426
|
+
"models/CancelAppointmentRequest.md",
|
|
426
427
|
"models/CareSession.md",
|
|
427
428
|
"models/CarequalityDiscoverPatientRequest.md",
|
|
428
429
|
"models/CarequalityDiscoverPatientResponse.md",
|
|
@@ -506,6 +507,8 @@
|
|
|
506
507
|
"models/DocumentSummary.md",
|
|
507
508
|
"models/DocumentSummarySearchRequest.md",
|
|
508
509
|
"models/DocumentSummarySearchResponse.md",
|
|
510
|
+
"models/DriversLicense.md",
|
|
511
|
+
"models/DriversLicenseSubmission.md",
|
|
509
512
|
"models/ElevenLabsAccessInfo.md",
|
|
510
513
|
"models/ElevenLabsAgent.md",
|
|
511
514
|
"models/ElevenLabsAgentSettings.md",
|
|
@@ -1278,6 +1281,7 @@
|
|
|
1278
1281
|
"models/OpenAIModerateRequest.md",
|
|
1279
1282
|
"models/OpenAIUpdateAssistantRequest.md",
|
|
1280
1283
|
"models/OpenAIUpdateAssistantResponse.md",
|
|
1284
|
+
"models/OpenLoopVitalsMirrorResult.md",
|
|
1281
1285
|
"models/OuraBuildAuthorizationUrlRequest.md",
|
|
1282
1286
|
"models/OuraBuildAuthorizationUrlResponse.md",
|
|
1283
1287
|
"models/OuraDailyActivity.md",
|
|
@@ -1684,6 +1688,7 @@
|
|
|
1684
1688
|
"models/SteadyMDUpdateConsultStatusRequest.md",
|
|
1685
1689
|
"models/SteadyMDUpdateEpisodeRequest.md",
|
|
1686
1690
|
"models/SteadyMDUpdateIntakeRequest.md",
|
|
1691
|
+
"models/SteadyMDVitalsMirrorResult.md",
|
|
1687
1692
|
"models/StediCheckClaimStatusRequest.md",
|
|
1688
1693
|
"models/StediCheckCoordinationOfBenefitsRequest.md",
|
|
1689
1694
|
"models/StediCheckEligibilityRequest.md",
|
|
@@ -1742,6 +1747,8 @@
|
|
|
1742
1747
|
"models/UpdateAgentRequest.md",
|
|
1743
1748
|
"models/UpdateDemographicsRequest.md",
|
|
1744
1749
|
"models/UpdateDemographicsResponse.md",
|
|
1750
|
+
"models/UpdateDriversLicenseRequest.md",
|
|
1751
|
+
"models/UpdateDriversLicenseResponse.md",
|
|
1745
1752
|
"models/UpdateMedicationRequest.md",
|
|
1746
1753
|
"models/UpdateMedicationResponse.md",
|
|
1747
1754
|
"models/UpdatePatientAttributesRequest.md",
|
|
@@ -2976,6 +2983,7 @@
|
|
|
2976
2983
|
"operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md",
|
|
2977
2984
|
"operations/patient.updateAddress.md",
|
|
2978
2985
|
"operations/patient.updateDemographics.md",
|
|
2986
|
+
"operations/patient.updateDriversLicense.md",
|
|
2979
2987
|
"operations/patient.updateMedication.md",
|
|
2980
2988
|
"operations/patient.updatePatientAttributes.md",
|
|
2981
2989
|
"operations/patient.updatePatientFlags.md",
|
|
@@ -3024,7 +3032,7 @@
|
|
|
3024
3032
|
"operations/vitals.recordVitals.md"
|
|
3025
3033
|
],
|
|
3026
3034
|
"language": "nodejs",
|
|
3027
|
-
"modelCount":
|
|
3028
|
-
"operationCount":
|
|
3035
|
+
"modelCount": 1974,
|
|
3036
|
+
"operationCount": 1002,
|
|
3029
3037
|
"schemaVersion": 1
|
|
3030
3038
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -15,7 +15,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
15
15
|
- [Generate client secret (Apple)](../operations/connectors.appleAuthGenerateClientSecret.md)
|
|
16
16
|
- [Add encounter reason (athenahealth)](../operations/connectors.athenaAddEncounterReason.md)
|
|
17
17
|
- [Add lab result document (athenahealth)](../operations/connectors.athenaAddLabResultDocument.md)
|
|
18
|
-
- [Athena's PUT /chart/{id}/pharmacies/preferred 400s without clinicalproviderid in the body — there's no way to add "a" preferred pharmacy without saying which one
|
|
18
|
+
- [Athena's PUT /chart/{id}/pharmacies/preferred 400s without either clinicalproviderid or ncpdpid in the body — there's no way to add "a" preferred pharmacy without saying which one](../operations/connectors.athenaAddPreferredPharmacy.md)
|
|
19
19
|
- [Answer health question (athenahealth)](../operations/connectors.athenaAnswerHealthQuestion.md)
|
|
20
20
|
- [Book an open appointment slot (without the telehealth deep link step)](../operations/connectors.athenaBookAppointment.md)
|
|
21
21
|
- [Cancel appointment (athenahealth)](../operations/connectors.athenaCancelAppointment.md)
|
|
@@ -181,7 +181,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
181
181
|
- [Unsubscribe medication changes (athenahealth)](../operations/connectors.athenaUnsubscribeMedicationChanges.md)
|
|
182
182
|
- [Replace the patient's full allergy list (Athena PUT semantics)](../operations/connectors.athenaUpdateAllergies.md)
|
|
183
183
|
- [Set a single TEXT custom field on an appointment](../operations/connectors.athenaUpdateAppointmentCustomField.md)
|
|
184
|
-
- [
|
|
184
|
+
- [Create or replace the patient's Athena driver's-license image](../operations/connectors.athenaUpdateDriversLicense.md)
|
|
185
185
|
- [Update encounter assessment (athenahealth)](../operations/connectors.athenaUpdateEncounterAssessment.md)
|
|
186
186
|
- [Update encounter diagnosis (athenahealth)](../operations/connectors.athenaUpdateEncounterDiagnosis.md)
|
|
187
187
|
- [Populate an encounter's HPI by adding templates (`template_ids`, a list of ids from `get_hpi_templates`) and/or a free-text `section_note`](../operations/connectors.athenaUpdateEncounterHpi.md)
|
|
@@ -198,7 +198,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
198
198
|
- [`file_bytes` is base64-encoded content (OpenAPI `format: byte` — the same JSON-over-the-wire contract as upload_patient_photo, since JSON has no binary type)](../operations/connectors.athenaUploadDocument.md)
|
|
199
199
|
- [Upload an imaging result document](../operations/connectors.athenaUploadImagingResultDocument.md)
|
|
200
200
|
- [Upload an insurance card image](../operations/connectors.athenaUploadInsuranceCard.md)
|
|
201
|
-
- [
|
|
201
|
+
- [Create or replace a patient photo](../operations/connectors.athenaUploadPatientPhoto.md)
|
|
202
202
|
- [Upload a prescription card image](../operations/connectors.athenaUploadPrescriptionCardImage.md)
|
|
203
203
|
- [Assign schedule to event type (Cal.com)](../operations/connectors.calAssignScheduleToEventType.md)
|
|
204
204
|
- [Create booking (Cal.com)](../operations/connectors.calCreateBooking.md)
|
|
@@ -463,7 +463,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
463
463
|
- [Update an onboarding item](../operations/connectors.healthieUpdateOnboardingItem.md)
|
|
464
464
|
- [Update an organization membership (permissions, role, status)](../operations/connectors.healthieUpdateOrganizationMembership.md)
|
|
465
465
|
- [Update an existing patient/client; returns the updated user](../operations/connectors.healthieUpdatePatient.md)
|
|
466
|
-
- [
|
|
466
|
+
- [Create/update patient insurance policies via updateClient](../operations/connectors.healthieUpdatePatientInsuranceBilling.md)
|
|
467
467
|
- [Update a program](../operations/connectors.healthieUpdateProgram.md)
|
|
468
468
|
- [Update a superbill](../operations/connectors.healthieUpdateSuperBill.md)
|
|
469
469
|
- [Update a tag name](../operations/connectors.healthieUpdateTag.md)
|
|
@@ -957,6 +957,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
957
957
|
- [Submit current symptoms](../operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md)
|
|
958
958
|
- [Update home address](../operations/patient.updateAddress.md)
|
|
959
959
|
- [Update demographics](../operations/patient.updateDemographics.md)
|
|
960
|
+
- [Update the patient's driver's license](../operations/patient.updateDriversLicense.md)
|
|
960
961
|
- [Update a medication](../operations/patient.updateMedication.md)
|
|
961
962
|
- [Update patient attributes](../operations/patient.updatePatientAttributes.md)
|
|
962
963
|
- [Update patient flags](../operations/patient.updatePatientFlags.md)
|
package/docs/index.md
CHANGED
|
@@ -23,7 +23,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
23
23
|
- [Generate client secret (Apple)](operations/connectors.appleAuthGenerateClientSecret.md) (`connectors.appleAuthGenerateClientSecret`)
|
|
24
24
|
- [Add encounter reason (athenahealth)](operations/connectors.athenaAddEncounterReason.md) (`connectors.athenaAddEncounterReason`)
|
|
25
25
|
- [Add lab result document (athenahealth)](operations/connectors.athenaAddLabResultDocument.md) (`connectors.athenaAddLabResultDocument`)
|
|
26
|
-
- [Athena's PUT /chart/{id}/pharmacies/preferred 400s without clinicalproviderid in the body — there's no way to add "a" preferred pharmacy without saying which one
|
|
26
|
+
- [Athena's PUT /chart/{id}/pharmacies/preferred 400s without either clinicalproviderid or ncpdpid in the body — there's no way to add "a" preferred pharmacy without saying which one](operations/connectors.athenaAddPreferredPharmacy.md) (`connectors.athenaAddPreferredPharmacy`)
|
|
27
27
|
- [Answer health question (athenahealth)](operations/connectors.athenaAnswerHealthQuestion.md) (`connectors.athenaAnswerHealthQuestion`)
|
|
28
28
|
- [Book an open appointment slot (without the telehealth deep link step)](operations/connectors.athenaBookAppointment.md) (`connectors.athenaBookAppointment`)
|
|
29
29
|
- [Cancel appointment (athenahealth)](operations/connectors.athenaCancelAppointment.md) (`connectors.athenaCancelAppointment`)
|
|
@@ -189,7 +189,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
189
189
|
- [Unsubscribe medication changes (athenahealth)](operations/connectors.athenaUnsubscribeMedicationChanges.md) (`connectors.athenaUnsubscribeMedicationChanges`)
|
|
190
190
|
- [Replace the patient's full allergy list (Athena PUT semantics)](operations/connectors.athenaUpdateAllergies.md) (`connectors.athenaUpdateAllergies`)
|
|
191
191
|
- [Set a single TEXT custom field on an appointment](operations/connectors.athenaUpdateAppointmentCustomField.md) (`connectors.athenaUpdateAppointmentCustomField`)
|
|
192
|
-
- [
|
|
192
|
+
- [Create or replace the patient's Athena driver's-license image](operations/connectors.athenaUpdateDriversLicense.md) (`connectors.athenaUpdateDriversLicense`)
|
|
193
193
|
- [Update encounter assessment (athenahealth)](operations/connectors.athenaUpdateEncounterAssessment.md) (`connectors.athenaUpdateEncounterAssessment`)
|
|
194
194
|
- [Update encounter diagnosis (athenahealth)](operations/connectors.athenaUpdateEncounterDiagnosis.md) (`connectors.athenaUpdateEncounterDiagnosis`)
|
|
195
195
|
- [Populate an encounter's HPI by adding templates (`template_ids`, a list of ids from `get_hpi_templates`) and/or a free-text `section_note`](operations/connectors.athenaUpdateEncounterHpi.md) (`connectors.athenaUpdateEncounterHpi`)
|
|
@@ -206,7 +206,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
206
206
|
- [`file_bytes` is base64-encoded content (OpenAPI `format: byte` — the same JSON-over-the-wire contract as upload_patient_photo, since JSON has no binary type)](operations/connectors.athenaUploadDocument.md) (`connectors.athenaUploadDocument`)
|
|
207
207
|
- [Upload an imaging result document](operations/connectors.athenaUploadImagingResultDocument.md) (`connectors.athenaUploadImagingResultDocument`)
|
|
208
208
|
- [Upload an insurance card image](operations/connectors.athenaUploadInsuranceCard.md) (`connectors.athenaUploadInsuranceCard`)
|
|
209
|
-
- [
|
|
209
|
+
- [Create or replace a patient photo](operations/connectors.athenaUploadPatientPhoto.md) (`connectors.athenaUploadPatientPhoto`)
|
|
210
210
|
- [Upload a prescription card image](operations/connectors.athenaUploadPrescriptionCardImage.md) (`connectors.athenaUploadPrescriptionCardImage`)
|
|
211
211
|
- [Assign schedule to event type (Cal.com)](operations/connectors.calAssignScheduleToEventType.md) (`connectors.calAssignScheduleToEventType`)
|
|
212
212
|
- [Create booking (Cal.com)](operations/connectors.calCreateBooking.md) (`connectors.calCreateBooking`)
|
|
@@ -471,7 +471,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
471
471
|
- [Update an onboarding item](operations/connectors.healthieUpdateOnboardingItem.md) (`connectors.healthieUpdateOnboardingItem`)
|
|
472
472
|
- [Update an organization membership (permissions, role, status)](operations/connectors.healthieUpdateOrganizationMembership.md) (`connectors.healthieUpdateOrganizationMembership`)
|
|
473
473
|
- [Update an existing patient/client; returns the updated user](operations/connectors.healthieUpdatePatient.md) (`connectors.healthieUpdatePatient`)
|
|
474
|
-
- [
|
|
474
|
+
- [Create/update patient insurance policies via updateClient](operations/connectors.healthieUpdatePatientInsuranceBilling.md) (`connectors.healthieUpdatePatientInsuranceBilling`)
|
|
475
475
|
- [Update a program](operations/connectors.healthieUpdateProgram.md) (`connectors.healthieUpdateProgram`)
|
|
476
476
|
- [Update a superbill](operations/connectors.healthieUpdateSuperBill.md) (`connectors.healthieUpdateSuperBill`)
|
|
477
477
|
- [Update a tag name](operations/connectors.healthieUpdateTag.md) (`connectors.healthieUpdateTag`)
|
|
@@ -965,6 +965,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
965
965
|
- [Submit current symptoms](operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md) (`patient.submitCurrentSymptomsScreeningsCurrentSymptoms`)
|
|
966
966
|
- [Update home address](operations/patient.updateAddress.md) (`patient.updateAddress`)
|
|
967
967
|
- [Update demographics](operations/patient.updateDemographics.md) (`patient.updateDemographics`)
|
|
968
|
+
- [Update the patient's driver's license](operations/patient.updateDriversLicense.md) (`patient.updateDriversLicense`)
|
|
968
969
|
- [Update a medication](operations/patient.updateMedication.md) (`patient.updateMedication`)
|
|
969
970
|
- [Update patient attributes](operations/patient.updatePatientAttributes.md) (`patient.updatePatientAttributes`)
|
|
970
971
|
- [Update patient flags](operations/patient.updatePatientFlags.md) (`patient.updatePatientFlags`)
|
|
@@ -11,7 +11,6 @@ Type: `object`
|
|
|
11
11
|
|
|
12
12
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
13
13
|
|---|---|---:|---|---|---|---:|---|
|
|
14
|
-
| `insurance_package_id` | `string|null` | No | | | | Yes | Athena Health insurance package id from Athena's own catalogue. Only used for tenants with the ATHENA integration enabled, where it identifies which Athena package to attach to the mirrored patient. When omitted, a best-effort lookup by payer_name/member_id is attempted. |
|
|
15
14
|
| `member_id` | `string` | Yes | | | | No | Subscriber's member/policy ID with the payer. |
|
|
16
15
|
| `payer_id` | `string|null` | No | | | | Yes | NAIC or payer identifier. |
|
|
17
16
|
| `payer_name` | `string` | Yes | | | | No | Display name of the insurance payer/carrier. |
|
|
@@ -10,10 +10,14 @@ Type: `object`
|
|
|
10
10
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `athena_best_match` | `object|null` | No | | | | Yes | The Athena insurance package the AI match service picked and submitted, for transparency. null when no package matched or Athena did not run. |
|
|
13
14
|
| `athena_insurance_error` | `string|null` | No | | | | Yes | Human-readable reason the Athena mirror failed, when athena_insurance_status is 'failed'. |
|
|
14
15
|
| `athena_insurance_status` | `string|null` | No | | | | Yes | 'linked' if the insurance was also mirrored into Athena, 'failed' otherwise, null if this tenant has no Athena integration configured. |
|
|
15
16
|
| `coverages_created` | `integer` | Yes | | | | No | Number of FHIR Coverage resources created by this request. |
|
|
16
17
|
| `fhir_patient_id` | `string|null` | Yes | | | | Yes | Deprecated alias of `patient_id`, kept for one release as a compatibility grace window. |
|
|
18
|
+
| `openloop_best_match` | `object|null` | No | | | | Yes | The Healthie insurance plan the AI match service picked and submitted, for transparency. null when no plan matched or OpenLoop did not run. |
|
|
19
|
+
| `openloop_insurance_error` | `string|null` | No | | | | Yes | Human-readable reason the OpenLoop mirror failed, when openloop_insurance_status is 'failed'. |
|
|
20
|
+
| `openloop_insurance_status` | `string|null` | No | | | | Yes | 'linked' if the insurance was also mirrored into Healthie (OpenLoop), 'failed' otherwise, null if this tenant has no OpenLoop integration configured. |
|
|
17
21
|
| `patient_id` | `string|null` | Yes | | | | Yes | FHIR Patient resource ID the coverage was added to. |
|
|
18
22
|
|
|
19
23
|
## Example
|
|
@@ -2,7 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
Model ID: `AnalyzeIdentityDocumentResponse`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
OCR-only response — the authenticated identity-document route no longer
|
|
6
|
+
mirrors the image anywhere. Persistence happens via the optional
|
|
7
|
+
``drivers_license`` block on POST /auth/register or via
|
|
8
|
+
PUT /patients/drivers-license.
|
|
6
9
|
|
|
7
10
|
Type: `object`
|
|
8
11
|
|
|
@@ -14,6 +14,7 @@ Type: `object`
|
|
|
14
14
|
| `athena_appointment_id` | `string|null` | No | | | | Yes | Athena Health appointment id this appointment is linked to, when booked via Athena. |
|
|
15
15
|
| `created_at` | `string|null` | No | date-time | | | Yes | Creation timestamp in ISO 8601 date-time format, when available. |
|
|
16
16
|
| `end` | `string|null` | No | date-time | | | Yes | Appointment end in ISO 8601 date-time format, when scheduled. |
|
|
17
|
+
| `openloop_appointment_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) appointment id this appointment is linked to, when booked via OpenLoop. |
|
|
17
18
|
| `patient_id` | `string` | Yes | | | | No | FHIR Patient resource ID associated with the appointment. |
|
|
18
19
|
| `provider_id` | `string|null` | No | | | | Yes | FHIR Practitioner resource ID, when one is assigned. |
|
|
19
20
|
| `slot_id` | `string` | Yes | | | | No | Primary FHIR Slot resource ID associated with the appointment. |
|
|
@@ -21,6 +22,7 @@ Type: `object`
|
|
|
21
22
|
| `specialty_code` | `string|null` | No | | | | Yes | SNOMED CT specialty code, when available. |
|
|
22
23
|
| `start` | `string|null` | No | date-time | | | Yes | Appointment start in ISO 8601 date-time format, when scheduled. |
|
|
23
24
|
| `status` | [`AppointmentStatus`](./AppointmentStatus.md) | No | | | `"scheduled"` | No | Current lifecycle status of the appointment. |
|
|
25
|
+
| `steadymd_consult_guid` | `string|null` | No | | | | Yes | SteadyMD consult guid this appointment is linked to, when booked via SteadyMD. |
|
|
24
26
|
| `updated_at` | `string|null` | No | date-time | | | Yes | Most recent update timestamp in ISO 8601 date-time format, when available. |
|
|
25
27
|
|
|
26
28
|
## Example
|
|
@@ -10,9 +10,10 @@ Type: `object`
|
|
|
10
10
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `clinical_provider_id` | `string` |
|
|
13
|
+
| `clinical_provider_id` | `string` | No | | | | Yes | |
|
|
14
14
|
| `department_id` | `string` | No | | | | No | |
|
|
15
15
|
| `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
|
|
16
|
+
| `ncpdp_id` | `string` | No | | | | Yes | |
|
|
16
17
|
| `patient_id` | `string` | Yes | | | | No | |
|
|
17
18
|
| `practice_id` | `string` | No | | | | No | |
|
|
18
19
|
| `provider_id` | `string` | No | | | | No | |
|
|
@@ -15,12 +15,14 @@ Type: `object`
|
|
|
15
15
|
| `department_id` | `string` | No | | | | No | |
|
|
16
16
|
| `email` | `string` | No | | | | Yes | |
|
|
17
17
|
| `first_name` | `string` | Yes | | | | No | |
|
|
18
|
+
| `gender_identity` | `string` | No | | | | Yes | |
|
|
18
19
|
| `home_phone` | `string` | No | | | | Yes | |
|
|
19
20
|
| `last_name` | `string` | Yes | | | | No | |
|
|
20
21
|
| `mobile_phone` | `string` | No | | | | Yes | |
|
|
21
22
|
| `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
|
|
22
23
|
| `practice_id` | `string` | No | | | | No | |
|
|
23
24
|
| `provider_id` | `string` | No | | | | No | |
|
|
25
|
+
| `race` | `array` | No | | | | Yes | |
|
|
24
26
|
| `secret_key` | `string` | Yes | | | | No | Vendor credential. Sent with the request and never returned. |
|
|
25
27
|
| `sex_at_birth` | `string` | Yes | | | | No | |
|
|
26
28
|
| `ssn` | `string` | No | | | | Yes | |
|
|
@@ -10,9 +10,10 @@ Type: `object`
|
|
|
10
10
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `clinical_provider_id` | `string` |
|
|
13
|
+
| `clinical_provider_id` | `string` | No | | | | Yes | |
|
|
14
14
|
| `department_id` | `string` | No | | | | No | |
|
|
15
15
|
| `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
|
|
16
|
+
| `ncpdp_id` | `string` | No | | | | Yes | |
|
|
16
17
|
| `patient_id` | `string` | Yes | | | | No | |
|
|
17
18
|
| `practice_id` | `string` | No | | | | No | |
|
|
18
19
|
| `provider_id` | `string` | No | | | | No | |
|
|
@@ -12,12 +12,13 @@ Type: `object`
|
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
13
|
| `department_id` | `string` | No | | | | No | |
|
|
14
14
|
| `max_pages` | `integer` | No | | | | Yes | |
|
|
15
|
-
| `member_id` | `string` |
|
|
15
|
+
| `member_id` | `string` | No | | | | No | |
|
|
16
16
|
| `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
|
|
17
|
-
| `plan_name` | `string` |
|
|
17
|
+
| `plan_name` | `string` | No | | | | No | |
|
|
18
18
|
| `practice_id` | `string` | No | | | | No | |
|
|
19
19
|
| `provider_id` | `string` | No | | | | No | |
|
|
20
20
|
| `secret_key` | `string` | Yes | | | | No | Vendor credential. Sent with the request and never returned. |
|
|
21
|
+
| `state` | `string` | No | | | | No | |
|
|
21
22
|
|
|
22
23
|
## Example
|
|
23
24
|
|
|
@@ -12,6 +12,7 @@ Type: `object`
|
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
13
|
| `department_id` | `string` | No | | | | No | |
|
|
14
14
|
| `image_base64` | `string` | Yes | | | | No | |
|
|
15
|
+
| `license_fields` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | Yes | |
|
|
15
16
|
| `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
|
|
16
17
|
| `patient_id` | `string` | Yes | | | | No | |
|
|
17
18
|
| `practice_id` | `string` | No | | | | No | |
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# AthenaVitalsMirrorResult
|
|
2
|
+
|
|
3
|
+
Model ID: `AthenaVitalsMirrorResult`
|
|
4
|
+
|
|
5
|
+
Outcome of attempting to mirror newly stored HC vital observations.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `created` | `integer` | No | | | `0` | No | Number of individual vital readings submitted to Athena. |
|
|
14
|
+
| `error` | `string|null` | No | | | | Yes | Sanitized mirror failure detail, present only when status is `failed`. |
|
|
15
|
+
| `skipped` | `integer` | No | | | `0` | No | Number of readings already present in Athena and therefore not submitted again. |
|
|
16
|
+
| `status` | `string` | Yes | | synced, skipped_no_athena, skipped_unlinked_patient, failed | | No | Whether Athena accepted the readings, was not applicable, or could not be reached. |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
None declared in canonical OpenAPI.
|
|
@@ -13,6 +13,8 @@ Type: `object`
|
|
|
13
13
|
| `athena_appointment_id` | `string|null` | No | | | | Yes | Athena Health appointment id of the slot being booked, taken from the `athena_appointment_id` of the chosen `appointments.listSlots` result. Required on an Athena-integrated tenant, where the booking is made in Athena against this id (the request is rejected without it); ignored on a FHIR-only tenant, which books against `slot_id`. |
|
|
14
14
|
| `patient_id` | `string` | Yes | | | | No | FHIR Patient resource ID for whom the appointment is booked. |
|
|
15
15
|
| `slot_id` | `string` | Yes | | | | No | FHIR Slot resource ID returned by `appointments.listSlots`. |
|
|
16
|
+
| `start` | `string|null` | No | | | | Yes | ISO 8601 start of the chosen slot, taken from the `start` of the chosen `appointments.listSlots` result. Required on an OpenLoop- or SteadyMD-integrated tenant, neither of which books by a pre-existing slot id; ignored on an Athena-integrated or FHIR-only tenant, which book by `athena_appointment_id`/`slot_id` respectively. |
|
|
17
|
+
| `steadymd_clinician_guid` | `string|null` | No | | | | Yes | SteadyMD clinician guid of the slot being booked, taken from the `steadymd_clinician_guid` of the chosen `appointments.listSlots` result. Required on a SteadyMD-integrated tenant, where SteadyMD's own availability has no per-slot id, only a clinician + timestamp. |
|
|
16
18
|
|
|
17
19
|
## Example
|
|
18
20
|
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# CancelAppointmentRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `CancelAppointmentRequest`
|
|
4
|
+
|
|
5
|
+
Request body for POST /appointments/{appointment_id}/cancel.
|
|
6
|
+
|
|
7
|
+
The body is entirely optional — a request with no body keeps the
|
|
8
|
+
pre-existing behaviour (each vendor applies its own default cancel
|
|
9
|
+
reason; the FHIR-only path never used a reason at all).
|
|
10
|
+
|
|
11
|
+
Type: `object`
|
|
12
|
+
|
|
13
|
+
## Fields
|
|
14
|
+
|
|
15
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
16
|
+
|---|---|---:|---|---|---|---:|---|
|
|
17
|
+
| `reason` | `string|null` | No | | | | Yes | Optional free-text reason for the cancellation, forwarded to the vendor where its API accepts one (e.g. Athena's cancel reason). |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# DriversLicense
|
|
2
|
+
|
|
3
|
+
Model ID: `DriversLicense`
|
|
4
|
+
|
|
5
|
+
Patient's driver's license information.
|
|
6
|
+
|
|
7
|
+
Stored on the FHIR Patient resource as a standard ``Patient.identifier``
|
|
8
|
+
with v2-0203 type ``DL`` (the HL7 code for "Driver's license number"),
|
|
9
|
+
the per-state OID as ``system``, the license number as ``value``, and the
|
|
10
|
+
expiration as ``period.end``. This is the idiomatic FHIR R4 way to carry
|
|
11
|
+
a DL — searchable via ``_identifier`` and consistent with how MRN and the
|
|
12
|
+
vendor patient ids (Athena/OpenLoop/SteadyMD) are already stored.
|
|
13
|
+
|
|
14
|
+
The DL *image* is a separate ``DocumentReference`` (LOINC 71230-7) linked
|
|
15
|
+
back to the patient via ``subject``; these text fields are NOT on the
|
|
16
|
+
DocumentReference and NOT as an HC custom extension.
|
|
17
|
+
|
|
18
|
+
Type: `object`
|
|
19
|
+
|
|
20
|
+
## Fields
|
|
21
|
+
|
|
22
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
23
|
+
|---|---|---:|---|---|---|---:|---|
|
|
24
|
+
| `expiration_date` | `string|null` | No | | | | Yes | License expiration date, when known. |
|
|
25
|
+
| `number` | `string|null` | No | | | | Yes | Driver's license number, when known. |
|
|
26
|
+
| `state` | `string|null` | No | | | | Yes | 2-letter US state code, e.g. 'NY', 'CA'. |
|
|
27
|
+
|
|
28
|
+
## Example
|
|
29
|
+
|
|
30
|
+
None declared in canonical OpenAPI.
|