@healthcloudai/hc-sdk 2.12.0 → 2.15.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 +1020 -77
- package/dist/index.d.cts +14115 -6021
- package/dist/index.d.ts +14115 -6021
- package/dist/index.js +1020 -77
- package/docs/clients/AthenaHealthClient.md +3 -3
- package/docs/clients/HealthieClient.md +1 -1
- package/docs/clients/PatientClient.md +3 -0
- package/docs/docs-manifest.json +19 -7
- package/docs/examples/index.md +7 -4
- package/docs/index.md +7 -4
- package/docs/models/AddInsuranceRequest.md +0 -1
- package/docs/models/AddInsuranceResponse.md +4 -0
- package/docs/models/Allergy.md +2 -2
- 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/FamilyHistoryEntry.md +1 -1
- package/docs/models/GetEncounterResponse.md +4 -0
- package/docs/models/GetHealthRecordResponse.md +1 -1
- 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/PatientIntakeRequest.md +26 -0
- package/docs/models/PatientIntakeResponse.md +20 -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/{AllergyReaction.md → ehr.AllergyReaction.md} +2 -2
- package/docs/models/{CodedConcept.md → ehr.CodedConcept.md} +1 -1
- package/docs/models/{FamilyCondition.md → ehr.FamilyCondition.md} +2 -1
- package/docs/models/fieldagent.Encounter.md +4 -0
- package/docs/models/index.md +13 -4
- 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.athenaListMedications.md +1 -0
- 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/ehr.listFamilyHistory.md +18 -17
- 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.getPatientIntake.md +137 -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.submitPatientIntake.md +703 -0
- 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
|
@@ -60,32 +60,33 @@ None declared in canonical OpenAPI.
|
|
|
60
60
|
{
|
|
61
61
|
"family_history": [
|
|
62
62
|
{
|
|
63
|
-
"age_at_death":
|
|
63
|
+
"age_at_death": 0,
|
|
64
64
|
"biological": true,
|
|
65
|
-
"born_date": "
|
|
66
|
-
"cause_of_death": "
|
|
65
|
+
"born_date": "2026-01-01",
|
|
66
|
+
"cause_of_death": "string",
|
|
67
67
|
"conditions": [
|
|
68
68
|
{
|
|
69
|
-
"age_at_death":
|
|
70
|
-
"age_at_onset":
|
|
71
|
-
"condition": "
|
|
72
|
-
"icd10_code": "
|
|
73
|
-
"notes": "
|
|
69
|
+
"age_at_death": 0,
|
|
70
|
+
"age_at_onset": 0,
|
|
71
|
+
"condition": "string",
|
|
72
|
+
"icd10_code": "string",
|
|
73
|
+
"notes": "string",
|
|
74
|
+
"snomed_code": "string"
|
|
74
75
|
}
|
|
75
76
|
],
|
|
76
77
|
"deceased": true,
|
|
77
|
-
"entry_id": "00000000-0000-
|
|
78
|
-
"fhir_id": "
|
|
79
|
-
"member_name": "
|
|
80
|
-
"notes": "
|
|
81
|
-
"recorded_date": "2026-01-
|
|
82
|
-
"relationship": "
|
|
83
|
-
"sex": "
|
|
78
|
+
"entry_id": "00000000-0000-0000-0000-000000000000",
|
|
79
|
+
"fhir_id": "string",
|
|
80
|
+
"member_name": "string",
|
|
81
|
+
"notes": "string",
|
|
82
|
+
"recorded_date": "2026-01-01",
|
|
83
|
+
"relationship": "mother",
|
|
84
|
+
"sex": "string",
|
|
84
85
|
"status": "completed"
|
|
85
86
|
}
|
|
86
87
|
],
|
|
87
|
-
"patient_id": "
|
|
88
|
-
"total":
|
|
88
|
+
"patient_id": "string",
|
|
89
|
+
"total": 0
|
|
89
90
|
}
|
|
90
91
|
```
|
|
91
92
|
|
|
@@ -99,6 +99,8 @@ None declared in canonical OpenAPI.
|
|
|
99
99
|
}
|
|
100
100
|
],
|
|
101
101
|
"notes": "string",
|
|
102
|
+
"openloop_appointment_id": "string",
|
|
103
|
+
"openloop_encounter_id": "string",
|
|
102
104
|
"participants": [
|
|
103
105
|
{
|
|
104
106
|
"participant_type": "PPRF",
|
|
@@ -120,6 +122,8 @@ None declared in canonical OpenAPI.
|
|
|
120
122
|
"service_type_code": "string",
|
|
121
123
|
"service_type_display": "string",
|
|
122
124
|
"status": "planned",
|
|
125
|
+
"steadymd_consult_guid": "string",
|
|
126
|
+
"steadymd_episode_guid": "string",
|
|
123
127
|
"type_code": "string",
|
|
124
128
|
"type_display": "string"
|
|
125
129
|
}
|
|
@@ -83,6 +83,11 @@ None declared in canonical OpenAPI.
|
|
|
83
83
|
"deceased": false,
|
|
84
84
|
"deceased_cause": "string",
|
|
85
85
|
"deceased_date": "2026-01-01",
|
|
86
|
+
"drivers_license": {
|
|
87
|
+
"expiration_date": "2026-01-01",
|
|
88
|
+
"number": "string",
|
|
89
|
+
"state": "st"
|
|
90
|
+
},
|
|
86
91
|
"email": "user@example.com",
|
|
87
92
|
"emergency_contacts": [],
|
|
88
93
|
"ethnicity": "hispanic_or_latino",
|
|
@@ -129,6 +134,8 @@ None declared in canonical OpenAPI.
|
|
|
129
134
|
"use": "official"
|
|
130
135
|
},
|
|
131
136
|
"nationality": "st",
|
|
137
|
+
"openloop_dietitian_id": "string",
|
|
138
|
+
"openloop_patient_id": "string",
|
|
132
139
|
"patient_id": "00000000-0000-0000-0000-000000000000",
|
|
133
140
|
"phones": [],
|
|
134
141
|
"photo_binary_id": "string",
|
|
@@ -151,7 +158,9 @@ None declared in canonical OpenAPI.
|
|
|
151
158
|
"race": [
|
|
152
159
|
"american_indian_or_alaska_native"
|
|
153
160
|
],
|
|
154
|
-
"sex_at_birth": "male"
|
|
161
|
+
"sex_at_birth": "male",
|
|
162
|
+
"steadymd_patient_guid": "string",
|
|
163
|
+
"steadymd_program_guid": "string"
|
|
155
164
|
}
|
|
156
165
|
],
|
|
157
166
|
"total": 0
|
|
@@ -46,10 +46,9 @@ Request model: [`AddInsuranceRequest`](../models/AddInsuranceRequest.md)
|
|
|
46
46
|
|
|
47
47
|
```json
|
|
48
48
|
{
|
|
49
|
-
"
|
|
50
|
-
"
|
|
51
|
-
"
|
|
52
|
-
"payer_name": "string",
|
|
49
|
+
"member_id": "MEM-example-001",
|
|
50
|
+
"payer_id": "60054",
|
|
51
|
+
"payer_name": "Example Health Plan",
|
|
53
52
|
"priority": "primary",
|
|
54
53
|
"relationship": "self"
|
|
55
54
|
}
|
|
@@ -67,10 +66,14 @@ Request model: [`AddInsuranceRequest`](../models/AddInsuranceRequest.md)
|
|
|
67
66
|
|
|
68
67
|
```json
|
|
69
68
|
{
|
|
69
|
+
"athena_best_match": {},
|
|
70
70
|
"athena_insurance_error": "string",
|
|
71
71
|
"athena_insurance_status": "string",
|
|
72
72
|
"coverages_created": 0,
|
|
73
73
|
"fhir_patient_id": "string",
|
|
74
|
+
"openloop_best_match": {},
|
|
75
|
+
"openloop_insurance_error": "string",
|
|
76
|
+
"openloop_insurance_status": "string",
|
|
74
77
|
"patient_id": "string"
|
|
75
78
|
}
|
|
76
79
|
```
|
|
@@ -118,10 +121,9 @@ import type { CreateInsuranceRequest } from "@healthcloudai/hc-sdk";
|
|
|
118
121
|
|
|
119
122
|
```ts
|
|
120
123
|
const request = {
|
|
121
|
-
"
|
|
122
|
-
"
|
|
123
|
-
"
|
|
124
|
-
"payer_name": "string",
|
|
124
|
+
"member_id": "MEM-example-001",
|
|
125
|
+
"payer_id": "60054",
|
|
126
|
+
"payer_name": "Example Health Plan",
|
|
125
127
|
"priority": "primary",
|
|
126
128
|
"relationship": "self"
|
|
127
129
|
};
|
|
@@ -135,7 +137,7 @@ const result = await patient.createInsurance(request);
|
|
|
135
137
|
curl -X POST \
|
|
136
138
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
137
139
|
-H 'Content-Type: application/json' \
|
|
138
|
-
-d '{"
|
|
140
|
+
-d '{"member_id":"MEM-example-001","payer_id":"60054","payer_name":"Example Health Plan","priority":"primary","relationship":"self"}' \
|
|
139
141
|
'https://dev-api-patient.health.cloud/patients/insurance'
|
|
140
142
|
```
|
|
141
143
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `patient.analyzeIdentityDocument`
|
|
4
4
|
|
|
5
|
-
Extract identity-document fields via AWS Textract AnalyzeID for the authenticated patient. When `verify_against_demographics` is true, the extracted name/DOB are compared against the caller's own FHIR patient record. Requires a patient Bearer JWT.
|
|
5
|
+
Extract identity-document fields via AWS Textract AnalyzeID for the authenticated patient. When `verify_against_demographics` is true, the extracted name/DOB are compared against the caller's own FHIR patient record. The submitted image is also mirrored best-effort to the linked Athena driver's-license image; Athena receives no extracted licence fields. Requires a patient Bearer JWT.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -121,6 +121,8 @@ Request model: [`CreateEncounterRequest`](../models/CreateEncounterRequest.md)
|
|
|
121
121
|
}
|
|
122
122
|
],
|
|
123
123
|
"notes": "string",
|
|
124
|
+
"openloop_appointment_id": "string",
|
|
125
|
+
"openloop_encounter_id": "string",
|
|
124
126
|
"participants": [
|
|
125
127
|
{
|
|
126
128
|
"participant_type": "PPRF",
|
|
@@ -142,6 +144,8 @@ Request model: [`CreateEncounterRequest`](../models/CreateEncounterRequest.md)
|
|
|
142
144
|
"service_type_code": "string",
|
|
143
145
|
"service_type_display": "string",
|
|
144
146
|
"status": "planned",
|
|
147
|
+
"steadymd_consult_guid": "string",
|
|
148
|
+
"steadymd_episode_guid": "string",
|
|
145
149
|
"type_code": "string",
|
|
146
150
|
"type_display": "string"
|
|
147
151
|
}
|
|
@@ -94,6 +94,8 @@ None declared in canonical OpenAPI.
|
|
|
94
94
|
}
|
|
95
95
|
],
|
|
96
96
|
"notes": "string",
|
|
97
|
+
"openloop_appointment_id": "string",
|
|
98
|
+
"openloop_encounter_id": "string",
|
|
97
99
|
"participants": [
|
|
98
100
|
{
|
|
99
101
|
"participant_type": "PPRF",
|
|
@@ -115,6 +117,8 @@ None declared in canonical OpenAPI.
|
|
|
115
117
|
"service_type_code": "string",
|
|
116
118
|
"service_type_display": "string",
|
|
117
119
|
"status": "planned",
|
|
120
|
+
"steadymd_consult_guid": "string",
|
|
121
|
+
"steadymd_episode_guid": "string",
|
|
118
122
|
"type_code": "string",
|
|
119
123
|
"type_display": "string"
|
|
120
124
|
}
|
|
@@ -95,6 +95,8 @@ None declared in canonical OpenAPI.
|
|
|
95
95
|
}
|
|
96
96
|
],
|
|
97
97
|
"notes": "string",
|
|
98
|
+
"openloop_appointment_id": "string",
|
|
99
|
+
"openloop_encounter_id": "string",
|
|
98
100
|
"participants": [
|
|
99
101
|
{
|
|
100
102
|
"participant_type": "PPRF",
|
|
@@ -116,6 +118,8 @@ None declared in canonical OpenAPI.
|
|
|
116
118
|
"service_type_code": "string",
|
|
117
119
|
"service_type_display": "string",
|
|
118
120
|
"status": "planned",
|
|
121
|
+
"steadymd_consult_guid": "string",
|
|
122
|
+
"steadymd_episode_guid": "string",
|
|
119
123
|
"type_code": "string",
|
|
120
124
|
"type_display": "string"
|
|
121
125
|
}
|
|
@@ -93,6 +93,8 @@ None declared in canonical OpenAPI.
|
|
|
93
93
|
}
|
|
94
94
|
],
|
|
95
95
|
"notes": "string",
|
|
96
|
+
"openloop_appointment_id": "string",
|
|
97
|
+
"openloop_encounter_id": "string",
|
|
96
98
|
"participants": [
|
|
97
99
|
{
|
|
98
100
|
"participant_type": "PPRF",
|
|
@@ -114,6 +116,8 @@ None declared in canonical OpenAPI.
|
|
|
114
116
|
"service_type_code": "string",
|
|
115
117
|
"service_type_display": "string",
|
|
116
118
|
"status": "planned",
|
|
119
|
+
"steadymd_consult_guid": "string",
|
|
120
|
+
"steadymd_episode_guid": "string",
|
|
117
121
|
"type_code": "string",
|
|
118
122
|
"type_display": "string"
|
|
119
123
|
}
|
|
@@ -94,6 +94,8 @@ None declared in canonical OpenAPI.
|
|
|
94
94
|
}
|
|
95
95
|
],
|
|
96
96
|
"notes": "string",
|
|
97
|
+
"openloop_appointment_id": "string",
|
|
98
|
+
"openloop_encounter_id": "string",
|
|
97
99
|
"participants": [
|
|
98
100
|
{
|
|
99
101
|
"participant_type": "PPRF",
|
|
@@ -115,6 +117,8 @@ None declared in canonical OpenAPI.
|
|
|
115
117
|
"service_type_code": "string",
|
|
116
118
|
"service_type_display": "string",
|
|
117
119
|
"status": "planned",
|
|
120
|
+
"steadymd_consult_guid": "string",
|
|
121
|
+
"steadymd_episode_guid": "string",
|
|
118
122
|
"type_code": "string",
|
|
119
123
|
"type_display": "string"
|
|
120
124
|
}
|
|
@@ -73,6 +73,11 @@ None declared in canonical OpenAPI.
|
|
|
73
73
|
"deceased": false,
|
|
74
74
|
"deceased_cause": "string",
|
|
75
75
|
"deceased_date": "2026-01-01",
|
|
76
|
+
"drivers_license": {
|
|
77
|
+
"expiration_date": "2026-01-01",
|
|
78
|
+
"number": "string",
|
|
79
|
+
"state": "st"
|
|
80
|
+
},
|
|
76
81
|
"email": "user@example.com",
|
|
77
82
|
"emergency_contacts": [],
|
|
78
83
|
"ethnicity": "hispanic_or_latino",
|
|
@@ -119,6 +124,8 @@ None declared in canonical OpenAPI.
|
|
|
119
124
|
"use": "official"
|
|
120
125
|
},
|
|
121
126
|
"nationality": "st",
|
|
127
|
+
"openloop_dietitian_id": "string",
|
|
128
|
+
"openloop_patient_id": "string",
|
|
122
129
|
"patient_id": "00000000-0000-0000-0000-000000000000",
|
|
123
130
|
"phones": [],
|
|
124
131
|
"photo_binary_id": "string",
|
|
@@ -142,6 +149,8 @@ None declared in canonical OpenAPI.
|
|
|
142
149
|
"american_indian_or_alaska_native"
|
|
143
150
|
],
|
|
144
151
|
"sex_at_birth": "male",
|
|
152
|
+
"steadymd_patient_guid": "string",
|
|
153
|
+
"steadymd_program_guid": "string",
|
|
145
154
|
"telehealth_id": 0
|
|
146
155
|
}
|
|
147
156
|
```
|
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
# Get own patient intake submission and delivery status
|
|
2
|
+
|
|
3
|
+
Operation ID: `patient.getPatientIntake`
|
|
4
|
+
|
|
5
|
+
Get own patient intake submission and delivery status
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`getPatientIntake`
|
|
10
|
+
|
|
11
|
+
Signature: `patient.getPatientIntake(submissionId)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<PatientIntakeResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
None documented.
|
|
24
|
+
|
|
25
|
+
## HTTP
|
|
26
|
+
|
|
27
|
+
`GET /patients/health-record/intake/{submission_id}`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
32
|
+
|---|---|---:|---|---|---|---:|---|
|
|
33
|
+
| `submission_id` | `string` | Yes | | | | No | |
|
|
34
|
+
|
|
35
|
+
## Query parameters
|
|
36
|
+
|
|
37
|
+
None.
|
|
38
|
+
|
|
39
|
+
## Body parameters
|
|
40
|
+
|
|
41
|
+
None.
|
|
42
|
+
|
|
43
|
+
Request model: None.
|
|
44
|
+
|
|
45
|
+
## Request example
|
|
46
|
+
|
|
47
|
+
None declared in canonical OpenAPI.
|
|
48
|
+
|
|
49
|
+
## Success responses
|
|
50
|
+
|
|
51
|
+
| Status | Shape | Content type | Description |
|
|
52
|
+
|---|---|---|---|
|
|
53
|
+
| `200` | [`PatientIntakeResponse`](../models/PatientIntakeResponse.md) | application/json | Intake submission metadata and delivery status |
|
|
54
|
+
|
|
55
|
+
## Success response examples
|
|
56
|
+
|
|
57
|
+
### 200
|
|
58
|
+
|
|
59
|
+
```json
|
|
60
|
+
{
|
|
61
|
+
"created_at": "2026-09-08T00:00:00Z",
|
|
62
|
+
"storage_status": "saved",
|
|
63
|
+
"submission_id": "9c9aa3d0-fc18-4bc8-9bbf-2f465f310e5e",
|
|
64
|
+
"vendors": {
|
|
65
|
+
"athena": {
|
|
66
|
+
"mode": "unsupported",
|
|
67
|
+
"reason": "Vendor is not enabled for this tenant",
|
|
68
|
+
"reference": null,
|
|
69
|
+
"section_results": {},
|
|
70
|
+
"sections": [
|
|
71
|
+
"allergies"
|
|
72
|
+
],
|
|
73
|
+
"status": "not_configured"
|
|
74
|
+
},
|
|
75
|
+
"openloop": {
|
|
76
|
+
"mode": "unsupported",
|
|
77
|
+
"reason": "Vendor is not enabled for this tenant",
|
|
78
|
+
"reference": null,
|
|
79
|
+
"section_results": {},
|
|
80
|
+
"sections": [
|
|
81
|
+
"allergies"
|
|
82
|
+
],
|
|
83
|
+
"status": "not_configured"
|
|
84
|
+
},
|
|
85
|
+
"steadymd": {
|
|
86
|
+
"mode": "unsupported",
|
|
87
|
+
"reason": "Vendor is not enabled for this tenant",
|
|
88
|
+
"reference": null,
|
|
89
|
+
"section_results": {},
|
|
90
|
+
"sections": [
|
|
91
|
+
"allergies"
|
|
92
|
+
],
|
|
93
|
+
"status": "not_configured"
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## Common errors
|
|
100
|
+
|
|
101
|
+
None declared in canonical OpenAPI.
|
|
102
|
+
|
|
103
|
+
## Error examples
|
|
104
|
+
|
|
105
|
+
None declared in canonical OpenAPI.
|
|
106
|
+
|
|
107
|
+
## NodeJS / TypeScript implementation
|
|
108
|
+
|
|
109
|
+
```ts
|
|
110
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
```ts
|
|
114
|
+
const submissionId = "<SUBMISSION_ID>";
|
|
115
|
+
|
|
116
|
+
const result = await patient.getPatientIntake(submissionId);
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
## cURL
|
|
120
|
+
|
|
121
|
+
```bash
|
|
122
|
+
curl -X GET \
|
|
123
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
124
|
+
'https://dev-api-patient.health.cloud/patients/health-record/intake/%3CSUBMISSION_ID%3E'
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
## Notes
|
|
128
|
+
|
|
129
|
+
None.
|
|
130
|
+
|
|
131
|
+
## Prepared Test Console scenario
|
|
132
|
+
|
|
133
|
+
No canonical scenario is currently associated.
|
|
134
|
+
|
|
135
|
+
## Real response
|
|
136
|
+
|
|
137
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -77,6 +77,11 @@ None declared in canonical OpenAPI.
|
|
|
77
77
|
"deceased": false,
|
|
78
78
|
"deceased_cause": "string",
|
|
79
79
|
"deceased_date": "2026-01-01",
|
|
80
|
+
"drivers_license": {
|
|
81
|
+
"expiration_date": "2026-01-01",
|
|
82
|
+
"number": "string",
|
|
83
|
+
"state": "st"
|
|
84
|
+
},
|
|
80
85
|
"email": "user@example.com",
|
|
81
86
|
"emergency_contacts": [],
|
|
82
87
|
"ethnicity": "hispanic_or_latino",
|
|
@@ -123,6 +128,8 @@ None declared in canonical OpenAPI.
|
|
|
123
128
|
"use": "official"
|
|
124
129
|
},
|
|
125
130
|
"nationality": "st",
|
|
131
|
+
"openloop_dietitian_id": "string",
|
|
132
|
+
"openloop_patient_id": "string",
|
|
126
133
|
"patient_id": "00000000-0000-0000-0000-000000000000",
|
|
127
134
|
"phones": [],
|
|
128
135
|
"photo_binary_id": "string",
|
|
@@ -145,7 +152,9 @@ None declared in canonical OpenAPI.
|
|
|
145
152
|
"race": [
|
|
146
153
|
"american_indian_or_alaska_native"
|
|
147
154
|
],
|
|
148
|
-
"sex_at_birth": "male"
|
|
155
|
+
"sex_at_birth": "male",
|
|
156
|
+
"steadymd_patient_guid": "string",
|
|
157
|
+
"steadymd_program_guid": "string"
|
|
149
158
|
},
|
|
150
159
|
"recent_encounters": [
|
|
151
160
|
{
|
|
@@ -184,6 +193,8 @@ None declared in canonical OpenAPI.
|
|
|
184
193
|
}
|
|
185
194
|
],
|
|
186
195
|
"notes": "string",
|
|
196
|
+
"openloop_appointment_id": "string",
|
|
197
|
+
"openloop_encounter_id": "string",
|
|
187
198
|
"participants": [
|
|
188
199
|
{
|
|
189
200
|
"participant_type": "PPRF",
|
|
@@ -205,6 +216,8 @@ None declared in canonical OpenAPI.
|
|
|
205
216
|
"service_type_code": "string",
|
|
206
217
|
"service_type_display": "string",
|
|
207
218
|
"status": "planned",
|
|
219
|
+
"steadymd_consult_guid": "string",
|
|
220
|
+
"steadymd_episode_guid": "string",
|
|
208
221
|
"type_code": "string",
|
|
209
222
|
"type_display": "string"
|
|
210
223
|
}
|
|
@@ -65,8 +65,28 @@ Request model: [`patient.ImportVitalsRequest`](../models/patient.ImportVitalsReq
|
|
|
65
65
|
|
|
66
66
|
```json
|
|
67
67
|
{
|
|
68
|
+
"athena_vitals": {
|
|
69
|
+
"created": 0,
|
|
70
|
+
"error": "string",
|
|
71
|
+
"skipped": 0,
|
|
72
|
+
"status": "synced"
|
|
73
|
+
},
|
|
68
74
|
"imported": 0,
|
|
69
|
-
"
|
|
75
|
+
"openloop_vitals": {
|
|
76
|
+
"created": 0,
|
|
77
|
+
"error": "string",
|
|
78
|
+
"skipped": 0,
|
|
79
|
+
"status": "synced"
|
|
80
|
+
},
|
|
81
|
+
"resource_ids": [
|
|
82
|
+
{}
|
|
83
|
+
],
|
|
84
|
+
"steadymd_vitals": {
|
|
85
|
+
"created": 0,
|
|
86
|
+
"error": "string",
|
|
87
|
+
"skipped": 0,
|
|
88
|
+
"status": "synced"
|
|
89
|
+
}
|
|
70
90
|
}
|
|
71
91
|
```
|
|
72
92
|
|
|
@@ -97,6 +97,8 @@ None declared in canonical OpenAPI.
|
|
|
97
97
|
}
|
|
98
98
|
],
|
|
99
99
|
"notes": "string",
|
|
100
|
+
"openloop_appointment_id": "string",
|
|
101
|
+
"openloop_encounter_id": "string",
|
|
100
102
|
"participants": [
|
|
101
103
|
{
|
|
102
104
|
"participant_type": "PPRF",
|
|
@@ -118,6 +120,8 @@ None declared in canonical OpenAPI.
|
|
|
118
120
|
"service_type_code": "string",
|
|
119
121
|
"service_type_display": "string",
|
|
120
122
|
"status": "planned",
|
|
123
|
+
"steadymd_consult_guid": "string",
|
|
124
|
+
"steadymd_episode_guid": "string",
|
|
121
125
|
"type_code": "string",
|
|
122
126
|
"type_display": "string"
|
|
123
127
|
}
|
|
@@ -68,7 +68,9 @@ Request model: [`patient.LoginRequest`](../models/patient.LoginRequest.md)
|
|
|
68
68
|
"expires_in": 0,
|
|
69
69
|
"fhir_patient_id": "string",
|
|
70
70
|
"id_token": "string",
|
|
71
|
+
"openloop_patient_id": "string",
|
|
71
72
|
"refresh_token": "string",
|
|
73
|
+
"steadymd_patient_guid": "string",
|
|
72
74
|
"telehealth_id": 0,
|
|
73
75
|
"token_type": "Bearer"
|
|
74
76
|
}
|