Customization Guide

JSON Configuration File

Important Changes

Release 3.6

Search Radius has changed. Also includes the following fields to change default sort radius:
"defaultDistance"
"defaultDistanceMedGroupFilterApplied"
Sorting has been pulled into configuration file. See section below named "sorting"

Release 3.1

Fonts section has changed. No longer using fontType and fontUrl. Replaced with fontCssUrl as we will now load fonts using a .css file from typekit.net. This file contains multiple @font-face css tags with font-family, font-style and font-weight.
online scheduling under filters has been removed. It is a separate section now.
captcha added as a new section
placeholders section added with a subsection called searchTerm
under a medGroup, the following two new properties exist:
- getToKnowContent
- logoPath
providerCardLogo is a new section
inMyOwnWords is a new section

The JSON configuration file helps control customizations for the FAD SAAS application so that you can fine tune certain colors and content to fit your organization. It consists of two parts: the interfaces and the theme. An example is provided for your reference:

{
  "interfaces": {
    "search": {
      "locationSearchCookieName": "fadLocationSearch_dh",
      "medgroupDictionary": [
        {
          "code": "arizona",
          "identifiers": "dignity-health-medical-group|arizona",
          "url": "https://www.dignityhealth.org/arizona/medical-group/arizona",
          "title": "DHMG - Arizona",
          "city": "Phoenix",
          "state": "AZ",
          "latitude": "33.448261",
          "longitude": "-112.075768",
          "getToKnowContent": "{providerDisplayFullNamePlaceHolder} is part of <a href='{medGroupUrlPlaceHolder}'>{medGroupTitlePlaceHolder}.</a>",
          "logoPath": "https://dignity-health.cshcontentstage.org/content/dam/dignity-health/logo/dh-logo.svg"
        },
        {
          "code": "enterprise",
          "identifiers": "enterprise|all",
          "url": "https://www.dignityhealth.org/dhmf",
          "title": "All Medical Groups",
          "city": "",
          "state": "",
          "latitude": "",
          "longitude": ""
        },
        {
          "code": "intel",
          "identifiers": "icc|intel",
          "url": "https://www.connectedcarehealth-ipf.com/ca/",
          "title": "Intel Connected Care",
          "city": "Sacramento",
          "state": "CA",
          "latitude": "38.558504",
          "longitude": "-121.473647"
        },
        {
          "code": "bakersfield",
          "identifiers": "dignity-health-medical-group-bakersfield|bakersfield",
          "url": "https://www.dignityhealth.org/central-california/medical-group/bakersfield",
          "title": "DHMG - Bakersfield",
          "city": "Bakersfield",
          "state": "CA",
          "latitude": "35.366959",
          "longitude": "-119.01886"
        },
        {
          "code": "dominican",
          "identifiers": "dignity-health-medical-group-dominican|dominican",
          "url": "https://www.dignityhealth.org/bayarea/medical-group/dominican",
          "title": "DHMG - Dominican",
          "city": "Santa Cruz",
          "state": "CA",
          "latitude": "36.974018",
          "longitude": "-122.030952"
        },
        {
          "code": "inland-empire",
          "identifiers": "dignity-health-medical-group-inland-empire|inland-empire",
          "url": "https://www.dignityhealth.org/socal/medical-group/inland-empire",
          "title": "DHMG - Inland Empire",
          "city": "San Bernardino",
          "state": "CA",
          "latitude": "34.1083",
          "longitude": "-117.2889"
        },
        {
          "code": "merced",
          "identifiers": "dignity-health-medical-group-merced|merced",
          "url": "https://www.dignityhealth.org/central-california/medical-group/merced",
          "title": "DHMG - Merced",
          "city": "Merced",
          "state": "CA",
          "latitude": "37.30127",
          "longitude": "-120.486198"
        },
        {
          "code": "mic",
          "identifiers": "mercy-imaging-center|mic",
          "url": "https://www.dignityhealth.org/sacramento/medical-group/mercy-imaging-centers",
          "title": "DHMG - MIC",
          "city": "Rancho Cordova",
          "state": "CA",
          "latitude": "38.574539",
          "longitude": "-121.30349"
        },
        {
          "code": "mmg",
          "identifiers": "mercy-medical-group|mmg",
          "url": "https://www.dignityhealth.org/sacramento/medical-group/mercy-medical-group",
          "title": "Mercy Medical Group",
          "city": "Sacramento",
          "state": "CA",
          "latitude": "38.57906",
          "longitude": "-121.491013"
        },
        {
          "code": "nevada",
          "identifiers": "dignity-health-medical-group-nevada|nevada",
          "url": "https://www.dignityhealth.org/las-vegas/medical-group/nevada",
          "title": "DHMG - Nevada",
          "city": "Las Vegas",
          "state": "NV",
          "latitude": "36.171909",
          "longitude": "-115.139969"
        },
        {
          "code": "north-state",
          "identifiers": "dignity-health-medical-group-north-state|north-state",
          "url": "https://www.dignityhealth.org/north-state/medical-group/north-state",
          "title": "DHMG - North State",
          "city": "Redding",
          "state": "CA",
          "latitude": "40.587509",
          "longitude": "-122.392929"
        },
        {
          "code": "northridge",
          "identifiers": "dignity-health-medical-group-northridge-family-medicine|northridge",
          "url": "https://www.dignityhealth.org/socal/medical-group/northridge",
          "title": "DHMG - Northridge",
          "city": "Los Angeles",
          "state": "CA",
          "latitude": "34.234772",
          "longitude": "-118.533882"
        },
        {
          "code": "phc",
          "identifiers": "pacific-central-coast-health-center|pcc|phc",
          "url": "https://www.dignityhealth.org/central-coast/medical-group/phc",
          "title": "PHC",
          "city": "Arroyo Grande",
          "state": "CA",
          "latitude": "35.124191",
          "longitude": "-120.577171"
        },
        {
          "code": "san-francisco",
          "identifiers": "dignity-health-medical-group-saint-francis-st-marys|san-francisco",
          "url": "https://www.dignityhealth.org/bayarea/medical-group/san-francisco",
          "title": "DHMG - San Francisco",
          "city": "San Francisco",
          "state": "CA",
          "latitude": "37.77823",
          "longitude": "-122.442503"
        },
        {
          "code": "dhmn-santa-cruz",
          "identifiers": "dhin-santa-cruz|dhmn-santa-cruz",
          "url": "https://www.dignityhealth.org/dhmf/dhmn-santa-cruz",
          "title": "DHMN – Santa Cruz",
          "city": "Santa Cruz",
          "state": "CA",
          "latitude": "36.974018",
          "longitude": "-122.030952"
        },
        {
          "code": "sequoia",
          "identifiers": "dignity-health-medical-group-sequoia|sequoia",
          "url": "https://www.dignityhealth.org/bayarea/medical-group/sequoia",
          "title": "DHMG - Sequoia",
          "city": "Redwood City",
          "state": "CA",
          "latitude": "37.484169",
          "longitude": "-122.227097"
        },
        {
          "code": "sierra-nevada",
          "identifiers": "dignity-health-medical-group-sierra-nevada|sierra-nevada",
          "url": "https://www.dignityhealth.org/sacramento/medical-group/sierra-nevada",
          "title": "DHMG - Sierra Nevada",
          "city": "Grass Valley",
          "state": "CA",
          "latitude": "39.21906",
          "longitude": "-121.06106"
        },
        {
          "code": "stockton",
          "identifiers": "dignity-health-medical-group-stockton|stockton",
          "url": "https://www.dignityhealth.org/central-california/medical-group/stockton",
          "title": "DHMG - Stockton",
          "city": "Stockton",
          "state": "CA",
          "latitude": "37.953671",
          "longitude": "-121.290749"
        },
        {
          "code": "ventura",
          "identifiers": "dignity-health-medical-group-ventura-county|ventura",
          "url": "https://www.dignityhealth.org/central-coast/medical-group/ventura-county",
          "title": "DHMG - Ventura",
          "city": "Oxnard",
          "state": "CA",
          "latitude": "34.20034",
          "longitude": "-119.180443"
        },
        {
          "code": "woodland",
          "identifiers": "dignity-health-medical-foundation|woodland",
          "url": "https://www.dignityhealth.org/sacramento/medical-group/woodland-davis",
          "title": "DHMF - Woodland",
          "city": "Woodland",
          "state": "CA",
          "latitude": "38.6786109",
          "longitude": "-121.7733285"
        }
      ]
    },
    "tenant": {
      "tenantCode": "dignity-health",
      "divisionCodes": [],
      "marketCodes": []
    },
    "logoPath": {
      "dignityLogo": "https://dignity-health.cshcontentstage.org/content/dam/dignity-health/logo/dh-logo.svg"
    },
    "providerCardLogo": {
      "enabled": true
    },
    "inMyOwnWords": {
      "title": "In my own words"
    },
    "suggestAnEdit": {
      "enabled": true,
      "linkScheme": "/ourdoctors/provider/providerupdate?Npi={0}&previousPageReturnUrl="
    },
    "emergencyCare": {
      "enabled": true,
      "linkScheme": "https://www.dignityhealth.org/emergency-care"
    },
    "quickLinks": {
      "enabled": true,
      "categories": ["Video Visits", "Primary Care", "Cardiology", "Gynecology"]
    },
    "myProviders": {
      "enabled": true,
      "linkScheme": "https://www.dignityhealth.org/login?returnUrl=/my-home/myproviders"
    },
    "helplineNumbers": {
      "enabled": true,
      "heading": "Prefer to talk to someone? We're here, 24/7",
      "numbers": [
        {
          "heading": "Arizona",
          "phone": "(855) 530-6925"
        },
        {
          "heading": "California",
          "phone": "(844) 334-8371"
        },
        {
          "heading": "Nevada",
          "phone": "(855) 550-6022"
        }
      ]
    },
    "landingPage": {
      "landingPageHeader": "Find a doctor"
    },
    "errorLinks": [
      {
        "title": "Find a doctor",
        "url": "https://www.dignityhealth.org/ourdoctors"
      },
      {
        "title": "For physicians",
        "url": "https://www.dignityhealth.org/for-physicians"
      },
      {
        "title": "Patient Portal",
        "url": "https://www.dignityhealth.org/my-home/my-care-dignity-health"
      },
      {
        "title": "Emergency care",
        "url": "https://www.dignityhealth.org/emergency-care"
      },
      {
        "title": "Pay a bill",
        "url": "https://dignityhealth.mysecurebill.com"
      },
      {
        "title": "Working for Dignity Health",
        "url": "https://www.dignityhealthcareers.org"
      }
    ],
    "videoVisitsBanner": {
      "enabled": true
    },
    "guidedFlowButton": {
      "enabled": true
    },
    "placeholders": {
      "searchTerm": {
        "desktop": "Doctor’s name, specialty, procedure, or insurance",
        "tablet": "Name, specialty, insurance",
        "mobile": "Name, specialty, insurance"
      }
    },
    "sorting": {
      "default": "BestMatch",
      "showOptions": true,
      "options": [
      {
        "name": "BestMatch",
        "label": "Best match",
        "queryParam": "bestmatch",
        "value": 2
      },
      {
        "name": "Tiered",
        "label": "TBD",
        "queryParam": "tiered",
        "value": 10
      },
      {
        "name": "Distance",
        "label": "Distance",
        "queryParam": "distance",
        "value": 5
      },
      {
        "name": "LastName",
        "label": "Last name (A - Z)",
        "queryParam": "lastname",
        "value": 4
      },
      {
        "name": "LastNameInverted",
        "label": "Last name (Z - A)",
        "queryParam": "-lastname",
        "value": 99
      }
      ]
    },
    "filters": {
      "videoVisits": {
        "enabled": true
      },
      "acceptingNewPatients": {
        "enabled": true
      },
      "availability": {
        "enabled": true
      },
      "specialty": {
        "enabled": true
      },
      "medicalGroup": {
        "enabled": true
      },
      "gender": {
        "enabled": true
      },
      "insurance": {
        "enabled": true
      },
      "language": {
        "enabled": true
      },
      "searchRadius": {
        "enabled": true,
        "defaultDistance": 10,
        "defaultDistanceMedGroupFilterApplied": 25
      }
    },
    "onlineScheduling": {
      "onlineSchedulingType": "GuidedFlow",
      "docAsapProviderLookupUrl": ""
    },
    "showNewSchedulingApp": true,
    "captcha": {
      "enabled": true
    }
  },
  "theme": {
    "fonts": {
      "fontFamily": "\"trade-gothic-next\", Arial",
      "fontCssUrl": "https://use.typekit.net/dfg1mni.css"
    },
    "colors": {
      "locationPinColor": "#ed711c",
      "locationPinOutline": "#c85200",
      "locationPinLabel": "#fff"
    },
    "colorPalette": "dhcl-dignity-health"
  }
}

You can also find another example as raw JSON here.

Interfaces

This section of the JSON controls certain items like links, medical groups, and search behavior.

`"search"` section

locationSearchCookieName: when a user enters their location, a cookie is set so that it can be quickly retrieved once they return to the site. This value controls the name of that cookie.
medgroupDictionary: array of objects that helps to define the possible medical groups that a user can search for providers. Each object in the array has the following specification:

Key Description Required

code Medical group code yes

identifiers Pipe-delimited alternate identifiers yes

title Title for search results heading yes

city City for the medical group no

state State for the medical group no

latitude Latitude for the medical group no

longitude Longitude for the medical group no

getToKnowContent Template of contents to put into getToKnow section of the Provider details yes

logoPath path/url to the logo for the MedGroup yes (if logo is required for medGroup)

Key	Description	Required
`code`	Medical group code	yes
`identifiers`	Pipe-delimited alternate identifiers	yes
`title`	Title for search results heading	yes
`city`	City for the medical group	no
`state`	State for the medical group	no
`latitude`	Latitude for the medical group	no
`longitude`	Longitude for the medical group	no
`getToKnowContent`	Template of contents to put into getToKnow section of the Provider details	yes
`logoPath`	path/url to the logo for the MedGroup	yes (if logo is required for medGroup)

`"getToKnownContent"` tokens

The getToKnowContent string can be tokeneized. Currently, the following tokens are replaced by the application:

providerDisplayFullNamePlaceHolder - Replaced with the Providers Full Display Name
medGroupUrlPlaceHolder - Replaced by the url defined in the matching medGroup for the Provider
medGroupTitlePlaceHolder - Replaced by the title defined in the matching medGroup for the Provider

`"tenant"` section

Controls tenant-specific data for API requests

Key Description Required

tenantCode Value to use for x-tenant in http request header yes

divisionCodes array of strings that are appended to provider api query
strings to limit provider data to specific divisions no

marketCodes array of strings that are appended to provider api query
strings to limit provider data to specific markets no

Key	Description	Required
`tenantCode`	Value to use for `x-tenant` in http request header	yes
`divisionCodes`	array of strings that are appended to provider api query strings to limit provider data to specific divisions	no
`marketCodes`	array of strings that are appended to provider api query strings to limit provider data to specific markets	no

`"logoPath"` section: (This section will be removed in a future release, and will use logoPath in medGroups instead)

'dignityLogo': logo used for Dignity Health providers in any med group
'texasStJosephLogo': logo used for Texas St Joseph med group
'texasAMLogo': logo used for providers in Texas A&M med group
'stLukesLogo': logo used for providers in St Lukes med group

`"providerCardLogo"` section:

'enabled': Used to decide if logos should be shown next to a provider

`"inMyOwnWords"` section:

'title': Text for title of section 'In My Own Words' in provider details

`"suggestAnEdit"` section

Controls destination and appearance of the Suggest an Edit link on the provider details page.

enabled: toggles the Suggest an Edit link on/off
linkScheme: provides a format to help link providers to an edit form. The component will attempt to replace {0} with the NPI of that provider

`"emergencyCare"` section

Controls the destination and appearance of the Emergency Care link found below the quicklinks section on the search landing page.

enabled: toggles the Emergency Care section on/off
linkScheme: the URL of the Emergency Care link

`"quickLinks"` section

Controls the terms and appearance of the quicklinks on the search landing page.

enabled: toggles the quicklinks section on/off
categories: string array of search terms

`"myProviders"` section

Controls the destination and appearance of the link to a user's saved providers.

enabled: toggles the saved providers section on/off
linkScheme: the URL to navigate to a user's saved providers

`"helplineNumbers"` section

Controls the contact numbers and appearance of regional helpline numbers.

Key Description Required

enabled Toggles the regional helplines section on/off yes

heading Heading section for regional helplines no

numbers Array of objects, with each object having a required heading and phone section no

Key	Description	Required
`enabled`	Toggles the regional helplines section on/off	yes
`heading`	Heading section for regional helplines	no
`numbers`	Array of objects, with each object having a required `heading` and `phone` section	no

`"landingPage"` section

landingPageHeader: large text that appears above the search boxes on the search landing page

`"errorLinks"` section

Array of objects that controls the helpful links that appear on the application error page. Each object has the following properties:

title: link text
url: link destination

`"videoVisitsBanner"` section

Controls whether the blue CTA banner appears on the search results page to indicate that a user can refine their search based on providers who offer video visits.

enabled: toggles the CTA on/off

`"guidedFlowButton"` section

Controls whether the Schedule an Appointment button launches the guided appointment booking flow or not.

enabled: toggles the behavior of the button. true will enable the guided appointment booking experience

`"placeholders"` section (added in Release 3.1.x)

Controls whether the Schedule an Appointment button launches the guided appointment booking flow or not.

searchTerm:
desktop: text to put as placeholder in the Search box on desktop viewport
tablet: text to put as placeholder in the Search box on tablet viewport
mobile: text to put as placeholder in the Search box on mobile viewport

`"sorting"` section

Controls the appearance of sorting section on the search results page.

sorting:
default: default sorting type to be applied for the site
showOptions: toggles sorting section on/off
options: array of abjects that holds the user defined sorting types, Each object in the array has the following specification:

Key Description Required

name Name of the sorting type yes

label label to be shown in the UI yes

queryParam sort value to be shown in the browser url yes

value sort number/code to be sent to the backend yes

Key	Description	Required
`name`	Name of the sorting type	yes
`label`	label to be shown in the UI	yes
`queryParam`	sort value to be shown in the browser url	yes
`value`	sort number/code to be sent to the backend	yes

`"filters"` section

Controls the appearance of filters on the search results page. Each object corresponds to the filter it controls, and has one property:

enabled: toggles the given filter on/off
defaultDistance: perform the search within the given default distance in miles(specific to searchRadius filter)
defaultDistanceMedGroupFilterApplied: perform the search within the given default medgroup distance in miles when medgroup filter is selected(specific to searchRadius filter)

`"onlineScheduling"`

Key Description Required

onlineSchedulingType Must be one of the following: GuidedFlow,DocASAP, or none yes

docAsapProviderLookupUrl path to a file containing provider npi id to doc asap id if onlineSchedulingType is GuidedFlow

Key	Description	Required
`onlineSchedulingType`	Must be one of the following: `GuidedFlow`,`DocASAP`, or `none`	yes
`docAsapProviderLookupUrl`	path to a file containing provider npi id to doc asap id	if onlineSchedulingType is `GuidedFlow`

`"showNewSchedulingApp"` section:

(true/false): Use new 'GuidedFlow' scheduling app versus legacy SiteCore one. Always true in production. Set to false for QA Testing only.

`captcha` section

enabled: Use 'captcha' for Scheduling. Always true in production. Set to false for QA Testing only.

Theme

This section of the JSON controls color schemes and fonts for the application.

`"fonts"` section (updated in Release 3.1)

Here you can define your own custom font to be used throughout the page:

Key Description Required

fontFamily Name of the custom font you are providing yes

fontCssUrl URL of the font css file/project yes

Key	Description	Required
`fontFamily`	Name of the custom font you are providing	yes
`fontCssUrl`	URL of the font css file/project	yes

`"colors"` section

Here you can define colors for google maps.

locationPinColor: css color for google maps pin
locationPinOutline: css color for google maps pin outline
locationPinLabel: css color for text label for google map pin

Note: All other colors come from dhcl-color palettes as defined in the component library

`"colorPalette"` section

set the name of the color palette to use from component library.
Possible values are:
dhcl-chi-health
dhcl-dignity-health
dhcl-common-spirit

Customization Guide

JSON Configuration File

Important Changes

Interfaces

"search" section

"getToKnownContent" tokens

"tenant" section

"logoPath" section: (This section will be removed in a future release, and will use logoPath in medGroups instead)

"providerCardLogo" section:

"inMyOwnWords" section:

"suggestAnEdit" section

"emergencyCare" section

"quickLinks" section

"myProviders" section

"helplineNumbers" section

"landingPage" section

"errorLinks" section

"videoVisitsBanner" section

"guidedFlowButton" section

"placeholders" section (added in Release 3.1.x)

"sorting" section

"filters" section

"onlineScheduling"

"showNewSchedulingApp" section:

captcha section