Partners Blog Contact Us

Configuring TytoCare Integration

Follow

This article contains the following sections:

TytoCare is a cloud-based telehealth solution that simulates a comprehensive physical examination using a portable WiFi-enabled diagnostic device. The Tyto device allows medical professionals to examine a patient at the Point of Care (POC) and broadcast the exam data to a remote clinician.

When the Tyto device is used in conjunction with the VidyoConnect™ desktop application, the remote clinician can virtually meet with the POC users via secure and reliable video conferencing. The integration enables the TytoCare solution to act as a robust extension of the remote clinicians’ diagnostic capabilities by allowing them to see and speak with patients while conducting virtual stethoscope, otoscope, skin, and other basic medical exams. Combined, the TytoCare Professional (TytoPro/TytoClinic) solution and the Vidyo telehealth solution provide a single cohesive workflow for telehealth providers.

The TytoCare integration requires VidyoPortal and VidyoRouter version 18.4.0 or later as well as version 19.1.0 or later of the VidyoConnect desktop application.

In addition, if you want to use TytoCare integration, you must first enable it in the Super Admin portal. Then, you must configure it in each Tenant Admin portal as described in the Configuring TytoCare Integration in the Tenant Admin Portal section of this article.

 

Configuring TytoCare Integration in the Super Admin Portal

To configure TytoCare integration in the Super Admin portal:

  1. Log in to the Super Admin portal using your Super Admin account.
    For more information, see Logging in to the Super Admin Portal.
    The Components page displays by default.
  2. Click the Settings tab.
    The Upload System License page displays by default.
  3. Click VP_PLUS_2.png to the left of Feature Settings on the left menu.
  4. Click TytoCare Integration from the submenu.
    The TytoCare Integration page displays.

    TytoIntegrationSuper.png
  5. Select the Enable TytoCare Integration checkbox.
  6. Click Save.

 

Configuring TytoCare Integration in the Tenant Admin Portal

If you are an on-premises customer and want to use TytoCare integration, you must first ensure that the Super Admin has enabled TytoCare as described in the Configuring TytoCare Integration in the Super Admin Portal section of this article. Next, you can configure TytoCare in each Tenant Admin portal.

Important: Before enabling the TytoCare integration for your Tenant, you must:

  • Contact your TytoCare representative in order to obtain your TytoCare URL, username, and password.
  • Provide your VidyoPortal public IP address to TytoCare so they can whitelist your system.

 

To enable the TytoCare integration in the Tenant Admin portal:

  1. Log in to the Admin portal using your Admin account.
    For more information, see Logging in to the Tenant Admin Portal.
    The Users page displays by default.
  2. Click the Settings tab.
    The License page displays by default.
  3. Click  to the left of Feature Settings on the left menu.
  4. Click TytoCare Integration from the submenu.
    The TytoCare Integration page displays.

    TytoIntegrationTenant.png
  5. Select the Enable TytoCare Integration checkbox.
  6. Enter the Tyto URL.
    In most cases, the URL is  https://app-cloud. tytocare.com ; however, you should verify this with the TytoCare team for your organization.

    Note: If your organization’s firewall blocks outbound requests to the Internet from your VidyoPortal, you will need to whitelist requests to the Tyto URL. Please check with your IT team.

  7. Enter your TytoCare username.
  8. Enter your TytoCare password.
  9. Click Connection test to confirm that your Tenant can access TytoCare using the information you provided.
    If the test is successful, this pop-up will display:

    TytoTenantPopup.jpg

  10. Click Save.

 

TytoCare Integration Troubleshooting

Starting with VidyoPortal and VidyoRouter version 19.1.0, the TytoCare integration includes:

  • More informative error messages. For example, we display the relevant error codes when the Connection Test is run.
  • More details in the TytoCare Audit and App logs. For example, we log the HTTP status codes for all Tyto REST API calls.

For more information about the tools, techniques, and APIs that you can use to determine whether the TytoCare integration feature is working properly and to troubleshoot it as needed, see below.

 

Tenant Admin Portal

From the Tenant Admin portal, you can perform a connection test to confirm that the Tyto server is reachable using the URL and credentials provided.


To perform a connection test via the Tenant Admin portal:

  1. Log in to the Tenant Admin portal using your Admin account.
    For more information, see Logging in to the Tenant Admin Portal.
    The Users page displays by default.
  2. Click the Settings tab.
    The License page displays by default.
  3. Click  to the left of Feature Settings on the left menu.
  4. Click TytoCare Integration from the submenu.
    The TytoCare Integration page displays.

    TytoIntegrationTenant.png

     

  5. Ensure that the Enable TytoCare Integration checkbox has been selected and that the Tyto url, Username, and Password fields have been filled out.

    Note: In most cases, the URL is  https://app-cloud. tytocare.com ; however, you should verify this with the TytoCare team for your organization. If your organization’s firewall blocks outbound requests to the Internet from your VidyoPortal, you will need to whitelist requests to the Tyto URL. Please check with your IT team.

  6. Click Connection test to confirm that your Tenant can access the TytoCare server using the information you provided: 
    • If the connection test is successful, this pop-up message displays:

      TytoTenantPopup.png

       

    • If the connection test fails, one of the following failure pop-up messages displays with the appropriate HTTP status code, and the details are logged in admin-app.log:
      • HTTP 401 - The username and/or password are incorrect or the portal's IP address is not whitelisted on the Tyto server.

        ConnectionFail401.png

         

      • HTTP 408 - The portal cannot resolve the Tyto server address or the address is unreachable.

        ConnectionFail408.png

         

      • Corresponding admin-app.log messages:
        • 2019-02-14 15:57:58,045 ERROR [catalina-exec-61](com.vidyo.service.SystemServiceImpl.restTytoCareAuthentication:2135) - TytoCare Server https://app1-stage1.tytocare.com/api/v1/integration/stations Test call failed due to an exception - Unknown Host/Not Reachable.
        • 2019-02-14 16:00:17,870 ERROR [catalina-exec-8](com.vidyo.service.SystemServiceImpl.restTytoCareAuthentication:2135) - TytoCare Server https://app1-stage1.tytocare.com/api/v1/integration/stations Test call failed due to an exception - Unknown Host/Not Reachable.
        • 2019-02-14 16:00:33,198 ERROR [catalina-exec-7](com.vidyo.service.SystemServiceImpl.restTytoCareAuthentication:2131) - TytoCare Serverhttps://app-stage1.tytocare.com/api/v1/integration/stations Test call failed due to an exception. HTTP code - 401

 

User Application APIs


This section includes the TytoCare integration APIs and their error scenarios. Each API section lists the HTTP error codes possible for each specific API as well as the sample log message for the scenario.

 

Station APIs

  • CREATE STATION: POST - https://{portal-FQDN}/api/extintegration/tyto/v1/stations/

    Possible Error Messages:
    • HTTP 409 - Station Already Exists

      Corresponding user-app.log messages:

      2019-02-14 23:22:06,413 ERROR [catalina-exec-72](com.vidyo.services.TytoRemoteAPIService.performCommunication:353) - Received an error from tyto services
      :, URI: https://app-stage1.tytocare.com/api/v1/integration/stations
      , method: POST
      , requestBody: StationSaveRequest{identifier='AFSGHD37474bggdgd', description='description'}
      , received response status: , http code: 409
      , responseBody: {
      "code" : "ERROR_STATION_ALREADY_EXISTS"
      }
      2019-02-14 23:22:06,413 ERROR [catalina-exec-72](com.vidyo.rest.controllers.tyto.TytoErrorHandlerController.handleProcessingException:41) - processed tyto communication exception, returning status: 409 and error body to client STATION_ALREADY_EXISTS

       

    • HTTP 400 - Invalid Format of Station Identifier [Unsupported special characters]

      Corresponding user-app.log messages:

      2019-04-08 17:35:12,030 ERROR [catalina-exec-57](com.vidyo.utils.LogUtils.logValidationError:12) - validation error - id: AFSGH$#%$&&*$^%#%D37474 is invalid
      , URI: https://tyto-vvp7.vidyoqa.com/api/extintegration/tyto/v1/stations/
      , method: POST
      , entity: StationSaveRequest{identifier='AFSGH$#%$&&*$^%#%D37474', description='description'}

       

    • HTTP 422 - Invalid Format of Station Identifier [Empty Identifier]

      Corresponding user-app.log messages:

      2019-04-08 17:36:42,530 ERROR [catalina-exec-68](com.vidyo.services.TytoRemoteAPIService.performCommunication:353) - Received an error from tyto services
      :, URI: https://app-stage1.tytocare.com/api/v1/integration/stations
      , method: POST
      , requestBody: StationSaveRequest{identifier='', description='description'}
      , received response status: , http code: 422
      , responseBody: {
      "code" : "REQUEST_IS_NOT_VALID",
      "message" : "station - may not be null\n"
      }
      2019-04-08 17:36:42,530 ERROR [catalina-exec-68](com.vidyo.rest.controllers.tyto.TytoErrorHandlerController.handleProcessingException:41) - processed tyto communication exception, returning status: 422 and error body to client REQUEST_IS_NOT_VALID

       

  • RETRIEVE STATION: GET - https://{portal-FQDN}/api/extintegration/tyto/v1/stations/{identifier}

    Possible Error Messages:
    • HTTP 404 - Station does not exist 

      Corresponding user-app.log messages:

      2019-02-14 23:25:00,158 ERROR [catalina-exec-71](com.vidyo.services.TytoRemoteAPIService.getStationStatus:131) - Unexpected Error - Station Endpoint Data for EndpointGUID AFSGHD37474bggdgd3 is not available in Portal
      2019-02-14 23:25:00,374 ERROR [catalina-exec-71](com.vidyo.services.TytoRemoteAPIService.performCommunication:353) - Received an error from tyto services
      :, URI: https://app-stage1.tytocare.com/api/v1/integration/stations/AFSGHD37474bggdgd3
      , method: GET
      , requestBody: None ,
      , received response status: , http code: 404
      , responseBody: {
      "code" : "ERROR_STATION_DOES_NOT_EXIST"
      }
      2019-02-14 23:25:00,375 ERROR [catalina-exec-71](com.vidyo.rest.controllers.tyto.TytoErrorHandlerController.handleProcessingException:41) - processed tyto communication exception, returning status: 404 and error body to client STATION_DOES_NOT_EXIST

       

    • HTTP 400 - Invalid Station Id format [Unsupported characters in the Identifier]

       

    • HTTP 405 - Invalid Station Id format [Empty Station Identifier]

       

  • PAIR TYTO DEVICE WITH STATION: POST - https://{portal-FQDN}/api/extintegration/tyto/v1/stations/{identifier}/pairingRequests

    Possible Error Messages:
    • POST - HTTP 404 - Station does not exist

      Corresponding user-app.log messages:

      2019-04-08 17:44:01,831 ERROR [catalina-exec-25](com.vidyo.services.TytoRemoteAPIService.performCommunication:353) - Received an error from tyto services
      :, URI: https://app-stage1.tytocare.com/api/v1/integration/stations/AFSGHD37474bgrrrgdgd/pairingRequests
      , method: POST
      , requestBody: None ,
      , received response status: , http code: 404
      , responseBody: {
      "code" : "ERROR_STATION_DOES_NOT_EXIST"
      }
      2019-04-08 17:44:01,832 ERROR [catalina-exec-25](com.vidyo.rest.controllers.tyto.TytoErrorHandlerController.handleProcessingException:41) - processed tyto communication exception, returning status: 404 and error body to client STATION_DOES_NOT_EXIST
      2019-04-08 17:44:01,833 WARN [catalina-exec-25](org.springframework.web.servlet.handler.AbstractHandlerExceptionResolver.resolveException:140) - Resolved [com.vidyo.exceptions.tyto.TytoCommunicationException: 404 ]

       

    • POST - HTTP 400 - Invalid Station Id format [Unsupported characters in the Identifier]

       

    • POST - HTTP 500 - Invalid Station Id format [Empty Identifier]

       

  • CREATE or UPDATE Clinician: PUT - https://{portal-FQDN}/api/extintegration/tyto/v1/stations/clinicians/{endpointGUID}

    Possible Error Messages:
    • PUT - HTTP 404 - Clinician does not exist [Empty Identifier]

       

    • PUT - HTTP 404 - Clinician does not exist [Invalid Identifier]

       

    • PUT - HTTP 400 - Clinician Identifier format invalid [unsupported special characters]

       

Visit APIs

  • CREATE VISIT: POST https://{portal-FQDN}/api/extintegration/tyto/v1/visits

    Possible Error Messages:
    • HTTP 422 - Invalid Format of Visit Identifier [Empty Identifier]

      Sample Request:

      {
      "identifier": "",
      "clinicianIdentifier": "908F9B554A5A-4135948213",
      "stationIdentifier": "88938957485C-176289082"
      }

      Response:

      HTTP 422 - Unprocessable Entity ["VISIT_IDENTIFIER_NOT_PROVIDED"]

       

    • HTTP- 400 - Invalid Visit Identifier [Unsupported characers/exceeding max length of 140 characters]

      Response:

      ["INVALID_IDENTIFIER"]

       

    • HTTP 404 - Invalid Clinician Identifier/Empty Clinician Identifier

      Response:

      ["CLINICIAN_ENDPOINT_NOT_FOUND"]

       

    • HTTP 404 - Invalid Station Identifier/Empty Station Identifier

      Response:

      ["STATION_ENDPOINT_NOT_FOUND"]

       

  • GET VISIT STATUS: GET https://{portal-FQDN}/api/extintegration/tyto/v1/visits/ {visitId - got from create visit}

    Possible Error Messages:
    • HTTP 405 - Empty Visit Identifier

      Response:

      405 - Method not allowed

       

    • HTTP 404 - Invalid Visit Identifier

      Response:

      [
      "VISIT_NOT_FOUND"
      ]

       

  • CREATE REVIEWER: PUT https://{portal-FQDN}/api/extintegration/tyto/v1/visits/{visitId - got from create visit}/reviews

    Possible Error Messages:
    • HTTP 404 - Invalid Visit Identifier

       

    • HTTP 500 - Empty Visit Identifier in URL

       

    • HTTP 404 - Invalid Reviewer Identifier/ Empty Reviewer Identifier

      Response:

      [
      "ENDPOINT_GUID_NOT_FOUND"
      ]

       

  • UPDATE VISIT STATUS - updating the visit as completed.
    PUT https://tyto-vvp7.vidyoqa.com/api/extintegration/tyto/v1/visits/7c1a8b76534c47baa504601d9bb5e253/status

    Possible Error Messages:
    • HTTP 400 - Bad Request

      Response:

      [
      "INVALID_VISIT_STATUS"
      ]
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.