Patientus.OVS.SDK 1.4.0

Description

This client library is developed by the Docplanner Telemedicine team. The library is created in .NET Standard 2.0, so we are supporting <strong>.NET Framework 4.6.1+</strong> and <strong>.NET Core 2.0+</strong>. Library packages are published to the Patientus Package Manager can be installed here.

This client library is the backend part of the Patientus Video Frontend Library, which is a wrapper for the Patientus Telemedicine API. It provides OVS session creation functionality for the Patientus Video Frontend Library.

How it works

Each client gets their client ID and secret from the Docplanner Telemedicine team. The client application must implement this client library. By providing the client ID and the secret, the backend part of the client can get an OVS session ID based on a unique identifier (room/appointment/event/conference/...) using this client library. The Patientus Video Frontend Library will use this OVS session ID to establish an online video consultation.

Features

• Get an authentication token
• Get an OVS session ID for a doctor.
• Get an OVS session ID for a patient.

Requirements

This package doesn't have special requirements. Within the package, we just bundle Newtonsoft.Json <strong>13.0.0+</strong>.

Installation

Add the Patientus Package Manager to you project

https://packages.patientus.de/repository/de.patientus.nuget/

• Note: Get the credential for the package manager from Docplanner Telemedicine team.

Install the latest version of the library package via .NET CLI

dotnet add package Patientus.OVS.SDK

Install a specific version of the library package via .NET CLI

dotnet add package Patientus.OVS.SDK --version [version number]

Usage

There are a handful of setup steps to go through. Generally, the steps are:

• Add the Patientus Package Manager to the project.
• Add the client library to the project.
• Specify the required configuration in the application settings.
• Register Patientus infrastructure service.
• Get an authentication token
• Get an OVS session.

Add the Patientus Package Manager to the project

https://packages.patientus.de/repository/de.patientus.nuget/

• Note: Get the credential for the package manager from Docplanner Telemedicine team.

Add the client library to the project

dotnet add package Patientus.OVS.SDK

Specify the required configuration in the application settings

{
    ...
    "VideoConsultationProvider": {
        "BaseAddress": "https://security.patientus.de"
    },
    ...
}

• BaseAddress: The URL of the Patientus Telemedicine API.

Register Patientus infrastructure service

.ConfigureServices((hostContext, services) =>
{
    ...
    services.AddVideoConsultation();
    ...
}

Get an authentication token

// IAuthHandler authHandler (via dependency injection)
var authToken = await authHandler.GetAuthTokenAsync("client_id", "client_secret");

• client_id: Given client ID.
• client_secret: Given client secret.

Get an OVS session

Set the authentication token for the OvsSessionHandler object:

// IOvsSessionHandler ovsSessionHandler (via dependency injection)
ovsSessionHandler.SetAuthToken(authToken);

Fot a doctor (moderator role):

// IOvsSessionHandler ovsSessionHandler (via dependency injection)
var moderator = await ovsSessionHandler.GetAsync("unique_id", ParticipantType.Moderator);

Fot a patient (publisher role):

// IOvsSessionHandler ovsSessionHandler (via dependency injection)
var publisher = await ovsSessionHandler.GetAsync("unique_id", ParticipantType.Publisher);

Known Issues

There are no known issues at the time of creating this document.

Further Help

To get more help and for any kind of information please send an email to ovs-sdk-support@docplanner.com.