ecr-viewer
    Preparing search index...

    Interface ProcessEnv

    interface ProcessEnv {
        AUTH_CLIENT_ID?: string;
        AUTH_CLIENT_SECRET?: string;
        AUTH_ISSUER?: string;
        AUTH_PROVIDER?: "keycloak" | "ad";
        AUTH_SECRET?: string;
        AWS_ACCESS_KEY_ID?: string;
        AWS_REGION?: string;
        AWS_SECRET_ACCESS_KEY?: string;
        AZURE_CONTAINER_NAME?: string;
        AZURE_STORAGE_CONNECTION_STRING?: string;
        BASE_PATH: string;
        CONFIG_NAME:
            | "AWS_INTEGRATED"
            | "AWS_PG_NON_INTEGRATED"
            | "AWS_SQLSERVER_NON_INTEGRATED"
            | "AWS_PG_DUAL"
            | "AWS_SQLSERVER_DUAL"
            | "AZURE_INTEGRATED"
            | "AZURE_PG_NON_INTEGRATED"
            | "AZURE_SQLSERVER_NON_INTEGRATED"
            | "AZURE_PG_DUAL"
            | "AZURE_SQLSERVER_DUAL"
            | "GCP_INTEGRATED"
            | "GCP_PG_NON_INTEGRATED"
            | "GCP_SQLSERVER_NON_INTEGRATED"
            | "GCP_PG_DUAL"
            | "GCP_SQLSERVER_DUAL";
        DATABASE_URL?: string;
        DB_CIPHER?: string;
        ECR_BUCKET_NAME: string;
        GCP_CREDENTIALS?: string;
        GCP_PROJECT_ID?: string;
        NBS_PUB_KEY?: string;
        NEXTAUTH_SECRET?: string;
        NEXTAUTH_URL?: string;
        NODE_ENV: "test"
        | "development"
        | "production";
        ORCHESTRATION_URL: string;
        SQL_SERVER_HOST?: string;
        SQL_SERVER_PASSWORD?: string;
        SQL_SERVER_USER?: string;
        TZ?: string;
        VERCEL?: "1";
        [key: string]: undefined | string;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: undefined | string
    Index

    Base Required

    BASE_PATH CONFIG_NAME ECR_BUCKET_NAME ORCHESTRATION_URL

    eCR Storage - AWS

    AWS_ACCESS_KEY_ID? AWS_REGION? AWS_SECRET_ACCESS_KEY?

    eCR Storage - AZURE

    AZURE_CONTAINER_NAME? AZURE_STORAGE_CONNECTION_STRING?

    eCR Storage - GCP

    GCP_CREDENTIALS? GCP_PROJECT_ID?

    eCR Library Metadata

    DATABASE_URL? DB_CIPHER?

    Authentication - Integrated

    These variables are used to configure authentication for the eCR Viewer. All values are required when running in INTEGRATED or DUAL.

    NBS_PUB_KEY?

    Authentication - Non-Integrated

    These variables are used to configure authentication for the eCR Library & Viewer. All values are required when running in NON_INTEGRATED or DUAL.

    AUTH_CLIENT_ID? AUTH_CLIENT_SECRET? AUTH_ISSUER? AUTH_PROVIDER? NEXTAUTH_SECRET?

    Other

    AUTH_SECRET? NEXTAUTH_URL? NODE_ENV TZ? VERCEL?

    SQL Server

    SQL_SERVER_HOST? SQL_SERVER_PASSWORD? SQL_SERVER_USER?

    Base Required

    BASE_PATH: string

    Base url path for the eCR Viewer.

    /ecr-viewer
    CONFIG_NAME:
        | "AWS_INTEGRATED"
        | "AWS_PG_NON_INTEGRATED"
        | "AWS_SQLSERVER_NON_INTEGRATED"
        | "AWS_PG_DUAL"
        | "AWS_SQLSERVER_DUAL"
        | "AZURE_INTEGRATED"
        | "AZURE_PG_NON_INTEGRATED"
        | "AZURE_SQLSERVER_NON_INTEGRATED"
        | "AZURE_PG_DUAL"
        | "AZURE_SQLSERVER_DUAL"
        | "GCP_INTEGRATED"
        | "GCP_PG_NON_INTEGRATED"
        | "GCP_SQLSERVER_NON_INTEGRATED"
        | "GCP_PG_DUAL"
        | "GCP_SQLSERVER_DUAL"

    Configuration name that determines the type of eCR FHIR storage type, metadata database, and authentication used.

    ECR_BUCKET_NAME: string

    Name of the Container storage where eCR documents are stored.

    ORCHESTRATION_URL: string

    The full URL of the orchestration service.

    eCR Storage - AWS

    AWS_ACCESS_KEY_ID?: string

    AWS access key ID for accessing AWS services.

    AWS_REGION?: string

    AWS region where resources are located.

    AWS_SECRET_ACCESS_KEY?: string

    AWS secret access key for accessing AWS services.

    eCR Storage - AZURE

    AZURE_CONTAINER_NAME?: string

    Azure Blob Storage container name where eCR documents are stored.

    Since v3.1.0 - Use BaseRequired.ECR_BUCKET_NAME

    AZURE_STORAGE_CONNECTION_STRING?: string

    Connection string for Azure Storage account. Required for Azure Blob Storage.

    eCR Storage - GCP

    GCP_CREDENTIALS?: string

    Google Cloud service account credentials JSON (stringified) for GCP deployments.

    GCP_PROJECT_ID?: string

    Google Cloud project ID where resources are located.

    eCR Library Metadata

    DATABASE_URL?: string

    Connection URL for the database.

    DB_CIPHER?: string

    Cipher key for database encryption if different then the default.

    Authentication - Integrated

    NBS_PUB_KEY?: string

    Public key for NBS authentication. \n This public key should correspond to a private key that you generate and store within the NBS Configuration table. To generate these keys, you can use PuttyGen for Windows or ssh-keygen for MacOS/Linux

    Authentication - Non-Integrated

    AUTH_CLIENT_ID?: string

    The application/client id used to identify the client.

    AUTH_CLIENT_SECRET?: string

    The client secret that comes from the authentication provider.

    AUTH_ISSUER?: string

    Additional information used during authentication process. For Azure AD, this will be the 'Tenant Id'. For Keycloak, this will be the url issuer including the realm.

    Keycloak
    https://my-keycloak-domain.com/realms/My_Realm

    Azure
    4a62fd3e-be14-443f-b51d-a9facca4a0eb
    AUTH_PROVIDER?: "keycloak" | "ad"

    The authentication provider used for logging in. Supported values are keycloak for Keycloak or ad for Azure AD/Entra.

    NEXTAUTH_SECRET?: string

    A random key used for NextAuth.js sessions. This value can be generated by running openssl rand -base64 32.

    Other

    AUTH_SECRET?: string
    NEXTAUTH_URL?: string
    NODE_ENV: "test" | "development" | "production"
    TZ?: string

    Can be used to change the default timezone at runtime

    VERCEL?: "1"

    SQL Server

    SQL_SERVER_HOST?: string

    Hostname for SQL Server database.

    Since v3.1.0 - use DATABASE_URL

    SQL_SERVER_PASSWORD?: string

    Password for SQL Server authentication.

    Since v3.1.0 - use DATABASE_URL

    SQL_SERVER_USER?: string

    Username for SQL Server authentication.

    Since v3.1.0 - use DATABASE_URL

    Settings

    Member Visibility

    On This Page

    Base Required
    eCR Storage - AWS
    eCR Storage - AZURE
    eCR Storage - GCP
    eCR Library Metadata
    Authentication - Integrated
    Authentication - Non-Integrated
    Other
    SQL Server