Overview - Other/Hyland-Clinician-Window/23.3/Hyland-Clinician-Window/Overview - 2024-04-16

Hyland Clinician Window

Platform: Other
Product: Hyland Clinician Window
Release: 23.3
License

Documentation Notice
Overview
Introduction
Version Compatibility
Supported File Formats
Licensing
Installation
Overview
Deployment Architecture
Components Required for All Deployments
NilRead Components
OnBase Components
Configuring the API Server for Clinician Window
XDS Components
Load Balancing
Additional Resources
Identity and Access Management Services
Integrating With Hyland IAM Services
API Server
Hyland Preferences Service
Hyland Healthcare Configuration Provider Host
Hyland Healthcare Configuration Provider Host Requirements
Setting Up the Configuration Database
Creating the Solution Schema
Checking for Schema Updates
Updating the Schema
Admin Tool Command Line Reference
Command Modes
Arguments
Example Configuration Files
Creating or Updating the Database Schema for MS SQL
Creating or Updating the Database Schema for Oracle
Installing the Hyland Healthcare Configuration Provider Host
Installing Using the Setup Wizard
Installing Using the Command Line
WEB_SITE_ID
APPNAME
APPPOOL
APIROOT
Default Folder Permissions
Configuring the Hyland Healthcare Configuration Provider Host
Configuring Schema and Tenant Settings
Configuring Authentication Settings
Next Steps
Hyland Healthcare Configuration Utility Server
Hyland Healthcare Configuration Utility Server Requirements
Installing the Hyland Healthcare Configuration Utility Server
Installing Using the Setup Wizard
Installing Using the Command Line
WEB_SITE_ID
APPNAME
APPPOOL
APIROOT
Default Folder Permissions
Configuring the Hyland Healthcare Configuration Utility Server
Configuring Allowed Origins
Configuring Connection Settings and Privileges
Configuring IdP Settings
Next Steps
Hyland Healthcare Configuration Utility User Interface (UI)
Hyland Healthcare Configuration Utility UI Requirements
Installing the Hyland Healthcare Configuration Utility UI
Installing Using the Setup Wizard
Installing Using the Command Line
WEB_SITE_ID
APPNAME
APPPOOL
APIROOT
Default Folder Permissions
Configuring the Hyland Healthcare Configuration Utility UI
Configuring URL Rewrite Settings
Configuring Application Settings
Configuring IdP Settings
Next Steps
OnBase Healthcare API
OnBase Healthcare API Requirements
Installing the OnBase Healthcare API
Installing Using the Setup Wizard
Installing Using the Command Line
WEB_SITE_ID
APPNAME
APPPOOL
APIROOT
Default Folder Permissions
Configuring the OnBase Healthcare API
Configuring Allowed Origins
Configuring Data Source Settings for the OnBase Healthcare API
Configuring Corrections Settings
Changing the Description Keyword Type
Configuring IdP Settings
OnBase Privilege Requirements
OnBase Patient Access
Configuring Patient Access
OnBase Document Collections
Configuring Document Collections
OnBase Emergency Access
Configuring Emergency Access
OnBase VIP Patients
Enabling VIP at the Patient Level
Designating Patients as VIP
Access to VIP Patients
OnBase Healthcare API Retrieval Flowcharts
Retrieve Patient Metadata by Internal ID
Retrieve Encounter Metadata by Internal ID
Retrieve Documents by Patient or Encounter
Hyland Healthcare OnBase Adapter
Hyland Healthcare OnBase Adapter Requirements
Installing the Hyland Healthcare OnBase Adapter
Installing Using the Setup Wizard
Installing Using the Command Line
WEB_SITE_ID
APPNAME
APPPOOL
APIROOT
Default Folder Permissions
Configuring Application Settings
Configuring Allowed Origins
Configuring Adaptee Settings
Configuring Correction Settings
Configuring Unified Type Settings
Hyland Healthcare NilRead Adapter
Hyland Healthcare NilRead Adapter Requirements
Installing the Hyland Healthcare NilRead Adapter
Installing Using the Setup Wizard
Installing Using the Command Line
WEB_SITE_ID
APPNAME
APPPOOL
APIROOT
Default Folder Permissions
Configuring Application Settings
Configuring Allowed Origins
Configuring NilRead URL Settings
LightweightViewer
FullViewer
Thumbnail
PatientFederatedSearch
PatientRetrievalFederatedSearch
ContentFederatedSearch
Secrets
WaitForResponseTimeout
Adding the Site Parameter to NilRead URLs
Adding Parameters to NilRead URLs
Configuring Unified Type Settings
HCConfigurationUrl
SourceId
ContentTypeID
ContentTypeSystemName
Configuring Authentication Settings
Hyland Healthcare XDS Adapter
Hyland Healthcare XDS Adapter Requirements
Installing the Hyland Healthcare XDS Adapter
Installing Using the Setup Wizard
Installing Using the Command Line
WEB_SITE_ID
APPNAME
APPPOOL
APIROOT
Default Folder Permissions
Configuring Application Settings
Configuring Allowed Origins
Configuring Adaptee Settings
Configuring Unified Type Settings
Configuring Security Settings
Mapping Assigning Authority Identifiers
Adding the XDS Class Codes File
XDS Class Codes File Requirements
Configuring Authentication Settings
Hyland Patient API
Hyland Patient API Requirements
Installing the Hyland Patient API
Installing Using the Setup Wizard
Installing Using the Command Line
WEB_SITE_ID
APPNAME
APPPOOL
APIROOT
Default Folder Permissions
Configuring the Hyland Patient API
Configuring Allowed Origins
Configuring Patient API Settings
Adapter Settings
Order of Priority for Source Adapters
Hyland License Check API
Hyland License Check API Requirements
Installing using the Hyland License Check API Installer
Installing using the Hyland License Check API Setup Wizard
Installing using the Command Line
Default Folder Permissions
Configuring the Hyland License Check API
Hyland Clinician Window API
Hyland Clinician Window API Requirements
Installer Requirements
Security Requirements
Installing the Hyland Clinician Window API
Installing Using the Setup Wizard
Installing Using the Command Line
WEB_SITE_ID
APPPOOL
APPNAME
APIROOT
REQUIRESSL
Default Folder Permissions
Configuring the Hyland Clinician Window API
Configuring Connecting Component URLs
Configuring XDS Content Viewing
Configuring the Hyland License Check API
Configuring Authentication Settings
Clinician Window Backend for Frontend (BFF) Server
Clinician Window BFF Requirements
Installer Requirements
Security Requirements
Installing the Clinician Window BFF Server
Installing Using the Setup Wizard
Installing Using the Command Line
WEB_SITE_ID
APPPOOL
APPNAME
APIROOT
Default Folder Permissions
Configuring the Clinician Window BFF
Configuring Connection Component URLs
Configuring Allowed Domains
Configuring Cache Expiration Settings
Configuring Privilege Settings
Configuring Miscellaneous Settings
Configuring Proxy Target Settings
Configuring Non-Proxied Unified Types
Configuring Log Files for the Clinician Window BFF
Configuring Authentication Settings
Clinician Window User Interface (UI)
Clinician Window UI Requirements
Installer Requirements
Security Requirements
Resolution Requirements
Installing the Clinician Window UI
Installing Using the Setup Wizard
Installing Using the Command Line
WEB_SITE_ID
APPPOOL
APPNAME
APIROOT
Default Folder Permissions
Configuring the Clinician Window UI
Configuring URL Rewrite Settings
Configuring Hyland.Logging Settings
Configuring hyConfigMappings Settings
Configuring URLs for the Content Security Policy
Configuring Authentication Settings
Hyland IdP Setup for Clinician Window
Configuring the Clinician Window UI to Use IdP Authentication
Configuring the IdP Client for the Clinician Window UI
Configuring IdP Settings for the Clinician Window UI
Configuring the Clinician Window BFF Server to Use IdP Authentication
Configuring the IdP Client for Token Exchange
Configuring the referencelogout API Resource
Configuring IdP Settings for the Clinician Window BFF Server
Configuring the Clinician Window API to Use IdP Authentication
Configuring the IdP Client for the Hyland Preferences Service
Configuring IdP Settings for the Hyland Preferences Service
Configuring the IdP Client for the License Check API
Configuring IdP Settings for the Clinician Window API
Configuring the Hyland Healthcare Configuration Provider Host to Use IdP Authentication
Configuring Hyland Healthcare Configuration Utility Server to Use IdP Authentication
Configuring the IdP Client for the Hyland Healthcare Configuration Utility Server
Configuring IdP Settings for the Hyland Healthcare Configuration Utility Server
Configuring Hyland Healthcare Configuration Utility UI to Use IdP Authentication
Configuring the IdP Client for the Hyland Healthcare Configuration Utility UI
Configuring IdP Settings for the Hyland Healthcare Configuration Utility UI
Configuring the OnBase Healthcare API to Use IdP Authentication
Configuring the Hyland Healthcare NilRead Adapter to Use IdP Authentication
Configuring NilRead to Use IdP Authentication
Configuring the NilRead Site to Use Hyland IdP
Adding the NilRead Scope to Clinician Window Components
Configuring the Hyland Healthcare XDS Adapter to Use IdP Authentication
SMART on FHIR Launch Configuration
Configuring the Hyland Identity Provider for SMART on FHIR
Configuring a Provider for the EHR Authorization Server
Configuring the SMART on FHIR Token Exchange Client Connection
Configuring the SMART on FHIR Launch Client Connection
Configuring the Clinician Window BFF for SMART on FHIR
BaseRedirectUrl
BaseRedirectUrlCookieDomainOption
BaseRedirectUrlCookiePathOption
BaseRedirectUrlCookieExpiresInSecondsOption
LaunchContextMetadata
SoFTokenExchangeConfiguration
EHRRedirectUri
EHRLaunchIssuers
EHRTokenIssuers
EHRScopes
EHRClientEndpoints
IdPAuthority
IdPScopes
IdPClientEndpoints
Secrets
URL Integrations
Displaying the Patient Record
Encoding Filter Criteria
JSON Value Descriptions for the Filter Segment
Encoding the Content ID
Displaying Contents in Gallery View
Query String Parameters
Adding the Assigning Authority
Showing or Hiding the Patient Banner
Closing Tabs When New Tabs Are Opened
Logging
Setting Logging Levels
Logging to File
Troubleshooting
Unable to Retrieve All Content
The Content Was Unable to Load
Page Not Found
Patient Not Found
Unknown Type Content Type
Unable to View Content on Mobile Application
Unable to Perform Full-Text Search
Clinician Window UI Site Redirects and Reauthenticates Continuously
Configuration
Repository Configuration Mapping
Unified Types
Creating a Unified Type
Remapping a Content Type to Another Unified Type
Importing Content Types (One-to-One Mapping)
Modifying a Unified Type
Deleting a Unified Type
Unified Note Types
Mapping Note Types
Configuring Clinician Window
Overview
Displaying Keyboard Shortcuts
Category Configuration
Adding or Modifying a Category
Deleting a Category
Reordering Categories
Content List Column Configuration
Configuring Content List Columns
Options for Content List Columns
Option: Enable
Option: Column Display Name
Option: Allow Sorting
Option: Default Sort Column
Option: Default Sort Direction
Reordering Display Columns
Corrections Configuration
Enabling Corrections
Date Range Filter Configuration
Configuring a Date Range Filter
Reordering Date Range Filters
Deleting a Date Range Filter
Filter Categories Configuration
Available Filters
Type
Description
Department
Encounter
Facility
Modality
Configuring Filters
Reordering Filters
Settings Configuration
Configuring the Standard Date Format
Enabling Full-Text Search
Enabling Telemetry Data Collection
Configuring Cache Expiration Times
Viewer Details Configuration
Configuring Default Image Sizing
Enabling Opening the NilRead Viewer
Configuring Viewer Headers
Keywords or Metadata Configuration
Adding Keyword Columns
Usage
Getting Started
Launching Clinician Window
Navigating the Patient Overview Layout
Navigating the Gallery View Layout
User Options
Updating Language Preferences
Updating Application Theme Preferences
Displaying Keyboard Shortcuts
Accessing Patient Information
Categories
Collapsing the Categories Pane
Expanding the Categories Pane
Personal Categories
Toggling the Enable Personal Categories Button On or Off
Enable Personal Categories
Disable Personal Categories
Adding a Personal Category
Deleting a Personal Category
Filtering Contents
Applying a Filter
Changing the Date Filter
Changing the Date Filter From the Filter Bar
Changing the Date Filter From the Apply Filters Pane
Custom Date Range Filters
Removing Applied Filters From the Filter Bar
Removing Applied Filters From the Apply Filters Pane
Viewing Contents
Opening a Document or Study
Content Viewer Options
Opening Multiple Documents or Studies
Accessing Full-Screen Mode
Entering Full-Screen Mode
Exiting Full-Screen Mode
Closing a Viewer
Returning to the Patient Record
Previewing Studies
Study Viewer Toolbar
Viewing Restricted Content
Accessing Restricted Content
Accessing Restricted Content from Patient Overview
Accessing Restricted Content from the Single Document View
Accessing a Restricted Patient Record
Flagging Documents for Corrective Action
Requesting a Correction
Adding Notes to a Document
Creating a Note from the Viewer Toolbar
Creating a Note from the Notes List
Editing Notes
Deleting Notes
Adding Annotations to a Document
Creating Annotations
Moving Annotations
Toggling the Display of Annotations
Deleting Annotations
Hit Highlight Annotation
System Interaction
Full-Text Search
Search Privileges

Back to home page