ALMEDA Video Consultation

Overview

The Video Consultation feature allows users to book and conduct online doctor consultations through video calls. For aokplus this service is integrated with the Almeda platform, providing a seamless experience for users to receive medical advice remotely.

ALMEDA Integration Business Context

Actor	Description
Medical Doctor	Is the doctor who treats the registered patient (AOK insured person) in the OVC appointment.
Almeda	Is the entire OVC infrastructure that receives and responds to calls from the Navida app.
Navida App	Is the ios/android app of the AOK, which offers the OVC as a feature.
Insured Person	Person insured with the AOK who wishes to register for an online video consultation (OVC for short) and who wishes to attend a scheduled OVC appointment.
OVC WebView	The OVC Webview is hosted by almeda but rendered by the Navida app. It is used by the patient and the doctor to communicate at the agreed appointment in the form of an online video session.
TWA WebView	The TWA Webview is hosted by almeda but rendered by the Navida app. It does a symptom check and offers to make an appointment with an online doctor.

Technical Context

Data Flow Diagram

Flow from Navida App to Almeda Platform

Components

User Interface

• Navida Application: Allows users to schedule video consultations with available doctors.
• Video Call Interface (Almeda-webview): Provides a secure and user-friendly interface for conducting video calls.

Backend Services

• navida-pro-be-video-consultation-bff-service: Handles the scheduling, rescheduling, and cancellation of appointments.
• navida-pro-be-user-common-services: Supports navida-pro-be-video-consultation-bff-service as an intermediate layer.
• navida-pro-be-user-profile-bff-service: Helping in loading upcoming/past appointment information for the cards.
• navida-pro-be-cron-job-service: Helping in creating notifications to users about their upcoming appointments and pending activities and generating the xml for TEVE billing purpose.
• navida-pro-be-notification-service: Sends reminders and notifications to users about their upcoming appointments and pending activities.

Endpoints

Description	HTTP METHOD	Header	URL	Service Name	Caller	Payload	PATH-PARAM	Response SUCCESS	Response ERROR
Get TWA-URL (webview url). This api interacts with soe system and emi system to formulate TWA url	GET	USER JWT, TENANT_ID	/api/v1/ovc/almeda/register	navida-pro-be-video-consultation-bff-service	Navida App			200 OK - {"twaURL": "string"}
Übergabe Appointment an Navida-App	POST	X-API-KEY	/api/v1/ovc/almeda/appointment	navida-pro-be-video-consultation-bff-service	Almeda	{ "aok_plus_patient_id": "string", "appointment_date": "string", "appointment_begin": "string", "appointment_end": "string", "appointment_join_link": "string", "appointment_cancel_link": "string", "appointment_image_link": "string", "appointment_uuid": "string", "doctor_id": "string", "doctor_salutation": "string", "doctor_title": "string", "doctor_lastname": "string", "doctor_firstname": "string", "doctor_specialty": "string" }		201 CREATED - if the data is stored in the database
Update the amount of uploaded images for an appointment	POST	X-API-KEY	/api/v1/ovc/almeda/appointment/{appointmentUuid}/image/amount/{amount}	navida-pro-be-video-consultation-bff-service	Almeda		appointment-uuid and image count as path params	200 Success
Update the status of an appointment. This API will mark an appointment as deleted in the database	POST	X-API-KEY	/api/v1/protected/ovc/almeda/appointment/{appointmentUuid}/status/{targetStatus} /api/v1/ovc/almeda/appointment/{appointmentUuid}/status/{targetStatus}	navida-pro-be-video-consultation-bff-service	Almeda		appointment-uuid and targetstatus (always expected as cancelled)
Abholen Patientendaten für TWS	GET	USER JWT	/api/v1/ovc/almeda/patient	navida-pro-be-user-common-services	Navida App
Sign in the user into the TEVE billing	POST	USER JWT	/api/v1/private/ovc/teve/signin	navida-pro-be-user-profile-bff-service	navida-pro-be-consent-service (on agreeing video consultation consent)	{ "id": 0, "consent": { "id": 0, "consentType": "string", "consentDate": "string" }, "executionTp": "string", "agreementType": "string" }		201 CREATED - if the data is stored in the database	204 NO CONTENT - if the payload AgreementGet does not map of the conditions
Sign out the user from the TEVE billing	POST	USER JWT	/api/v1/private/ovc/teve/signout	navida-pro-be-user-profile-bff-service	navida-pro-be-consent-service (on revoking video consultation consent)	{ "id": 0, "consent": { "id": 0, "consentType": "string", "consentDate": "string" }, "executionTp": "string", "agreementType": "string" }		201 CREATED - if the sign out successful	204 NO CONTENT - if the payload AgreementGet does not map of the conditions
Cronjob to generate and deliver the TEVE XML file	GET	None	/api/v1/teve	navida-pro-be-cron-job-service	System			200 OK- if xml generated successfully	500 - if no records found or any error caused xml generation fail.
Cronjob to generate push for upcoming video consultation will notify the users about the upcoming consultation 20 mins prior	GET	None	/api/v1/pushnotification/video-consultation/upcoming-notify	navida-pro-be-cron-job-service	System			200 OK - if notification scheduled successfully	204 NO CONTENT - if no notifications are scheduled
Cronjob to generate push to remind user to upload photos for dermatology consultation will notify the users one day prior to their consultation	GET	None	/api/v1/pushnotification/video-consultation/pending-users	navida-pro-be-cron-job-service	System			200 OK - if notification scheduled successfully	204 NO CONTENT - if no notifications are scheduled
Get Profile API deliver all the active and past video consultation details.	GET	None	/userprofile/api/v1/profileData	navida-pro-be-user-profile-bff-service	Navida App			200 OK - in response health history section will contain past video consultation, and active section will contain upcoming consultations.

Data Flow - Sequence Diagram

Use case "Upload images"

Use case "Cancel appointment"

Billing (TEVE)