Customization Guide

Overview

This page describes the various configuration settings exposed by the Find a Doctor application. These settings allow consuming platforms and markets to customize the look, feel, and behavior of the application. Each instance of the application (e.g. VMFH AEM, DH AEM, etc.) can be configured separately and uniquely while still sharing a common codebase. The settings available for customization range from user-interface settings that control, say, the color scheme, to lower-level settings that control which back-end APIs are called to retrieve provider and availability data.

By decoupling configuration settings that are more likely to change from the application and allowing platforms and markets to customize the values, stakeholders are empowered to make changes to their instance of the application without having to wait on a full release cycle before their changes can go live.

Example JSON Configuration File

Important Changes

Release 7.4.3

VMFH
Under "interfaces" "legalCopy" - The "tooltipInfo" property was added to control the aria label for the tooltip icon within the legal content section.

Release 7.4.2

Note: There were no configuration setting changes for this release. There were release tasks created to preemptively update the VMFH FAD configurations in AEM, however.

Release 7.4.1

In this release, several markets' configuration files in source control were updated to reflect the current state of the settings used in production. Here's the breakdown by market:
DH
- Under "interfaces" "search" "medgroupDictionary" - The DHMN - Santa Cruz entry was updated to remove the special dash character (–) in favor of a regular dash (-).
- Under "interfaces" "tenant"
- The "includeProviderTitle" setting was removed.
- The "showProviderPrefix" setting was added and set to false.
- Under "providerRatings" the "useNewRatingsEndpoint" setting was added and set to false.
- Under "tenant" "divisions" the "providerNotFoundRedirectUrl" setting was added and set to empty string ("").
- Under "interfaces" "helpLineNumbers" the "phone" properties for the various "numbers" entries were updated.
- Under "interfaces" "sorting" the last item in the "options" collection, named "LastNameInverted", had its "value" property changed to 7 (from 99).
- Under "interfaces" the "titleTag" setting was added with following properties and values:
- "enable": true
- "marketCode": "DH"
- Under "interfaces" the "useNewProviderDetailsRoute" setting was set to false (from true).
- Under "interfaces" "captcha" the "enabled" property was set to false (from true).
- The "globalErrorRedirectUrl" setting was added at the root with the value of empty string ("").
KY
- Under "interfaces" "tenant"
- The "includeProviderTitle" setting was removed.
- The "showProviderPrefix" setting was added and set to false.
- Under "providerRatings" the "useNewRatingsEndpoint" setting was added and set to false.
- Under "interfaces" the "titleTag" setting was added with following properties and values:
- "enable": true
- "marketCode": "KY"
SJH
- Under "interfaces" "tenant"
- The "includeProviderTitle" setting was removed.
- The "showProviderPrefix" setting was added and set to false.
- Under "providerRatings" the "useNewRatingsEndpoint" setting was added and set to false.
- Under "interfaces" the "titleTag" setting was added with following properties and values:
- "enable": true
- "marketCode": "SJH"
SLH
- Under "interfaces" "tenant"
- The "includeProviderTitle" setting was removed.
- The "showProviderPrefix" setting was added and set to false.
- Under "providerRatings" the "useNewRatingsEndpoint" setting was added and set to false.
- Under "interfaces" the "titleTag" setting was added with following properties and values:
- "enable": true
- "marketCode": "SLH"
VMFH
- Under "interfaces" "tenant"
- The "includeProviderTitle" setting was removed.
- The "showProviderPrefix" setting was added and set to false.
- Under "providerRatings" the "useNewRatingsEndpoint" setting was added and set to true.

Release 7.3.0

Configuration files for the various markets in source control were formatted for better consistency.

Release 7.2.2

Under "interfaces" "search" the "autoSuggestionLoadingMessage" property was added to control the loading text displayed when search suggestions are loading. This string is used for both provider/service/keyword suggestions as well as geolocation suggestions.

Release 7.2.1

The "aemFadUrlPathName" property was added for the VMFH market.

Release 7.2.0

The "enableAutoSuggestionProviders" property was added for the VMFH market with a default value of true.

Release 7.1.1

Under "interfaces" "filters" "searchRadius"
The "defaultDistance" property was updated from "10" to "25" for the DH market.
Under "tenant" "providerRatings"
- The "hideStarRating" setting was removed for the VMFH market.
- The "ratingsTooltipText" setting was updated for the VMFH market to include a reference to VMFH.

Release 7.1.0

Under "interfaces" "showPatientAgeRestrictions" - This property controls whether or not an age restriction text blurb appears near the schedule an appointment button (assuming online scheduling is available with the given provider)

Release 5.2

Under "tenant" "dynamicSEOContent" This array holds the dynamic content for onlineScheduling, Medical group and a list of specialties.
- "showContent"- To determine whether the content is to be shown for the specific market.
- "onlineSchedulingContent" - This array holds the dynamic content for onlineScheduling.
- "medicalGroupContent" - This array holds the dynamic content for Medical group items.
- "specialtyGroupContent" - This array holds the dynamic content for list of specialties that are specific to the order in which they are added in the config.
Under "onlineSchedulingContent" / "medicalGroupContent" / "specialtyGroupContent"
- "filterKeywords"- To set the filterKeywords for items in onlinescheduling/ medical group/ specialty group which is compared to the filter value.
- "subHeading"- To set the sub-heading for items in onlinescheduling/ medical group/ specialty group.
- "paragraph"- To set the content for items in onlinescheduling/ medical group/ specialty group.
- "group"- To set the group number for items in onlinescheduling/ medical group/ specialty group.
- "learnMoreLink"- To set the learn more link for each of item in onlineScheduling/ medical group / specialty group.

Release 4.4

Under "quicklink" "categories" This array holds what object can be used to display quick link filter in FAD landing page.
- "value"- Display button text for quicklinks categories.
- "type" - To specify how quicklinks will work.
- "icon" - Sets an icon to be part of the Quick Link button.
- "alternateText" - If alternate text is set, this value will override the Quick Link button text.

Release 4.3

Under "hospitalAffiliations" there are new options to enable or disable displaying of provider's hospital affiliations in the site.

Release 4.2.3

Under "logging" there are new options to Allow setting the log level in fad-configuration:
- "logLevel" - This property can be set to 4 to log application errors.

Release 4.2.2

Under "division"` and `"market" there are new options:
- "providerRatings" - This array holds what object can be used to display provider ratings in the site for both division and market level.
- "showStarRatings" - This property will allow to display start ratings in the site for both division and market level.
- "showProviderReviews" - This property will allow to display provider reviews in the site for both division and market level.
- "showRatingText" - This property will allow to display rating text in the site for both division and market level.
- "showReviewCount" - This property will allow to display review count in the site for both division and market level.
- "ratingsFooterText" - This property will allow to set rating footer text in the site for both division and market level.
- "ratingsFooterLinkText" - This property will allow to set rating footer link text in the site for both division and market level.
- "ratingsFooterLink" - This property will allow to set rating footer link in the site for both division and market level.
- "ratingsBannerText" - This property will allow to set rating banner text in the site for both division and market level.
- "ratingsBannerLink" - This property will allow to set rating banner link in the site for both division and market level.
- "ratingsBannerLinkText" - This property will allow to set rating banner link text in the site for both division and market level.
- "ratingsTooltipText" - This property will allow to set rating tooltip text in the site for both division and market level.
- "showStarRatingsBanner" - This property will allow to display star ratings banner in the site for both division and market level.

Release 4.2

Under "tenant" there are new options:
- "providerRatings" - This array holds what object can be used to display provider ratings in the site.
- "showStarRatings" - This property will allow to display start ratings in the site.
- "showProviderReviews" - This property will allow to display provider reviews in the site.
- "showRatingText" - This property will allow to display rating text in the site.
- "showReviewCount" - This property will allow to display review count in the site.
- "ratingsFooterText" - This property will allow to set rating footer text in the site.
- "ratingsFooterLinkText" - This property will allow to set rating footer link text in the site.
- "ratingsFooterLink" - This property will allow to set rating footer link in the site.
- "ratingsBannerText" - This property will allow to set rating banner text in the site.
- "ratingsBannerLink" - This property will allow to set rating banner link in the site.
- "ratingsBannerLinkText" - This property will allow to set rating banner link text in the site.
- "ratingsTooltipText" - This property will allow to set rating tooltip text in the site.
- "showStarRatingsBanner" - This property will allow to display star ratings banner in the site.

Release 4.1

Under "tenant" there are new options:
- "showProviderPrefix" - This property will allow to display provider name with title Dr in the site.
- "showMedGroupLogo" - This property will allow to display medical group logo in the site.

Release 4.0

Search section has changed. Also includes the following fields to configure location search:
- "locationRequired"
"medgroupDictionary" has changed. "banner" has been added to a Med Group with the following items under "banner" :
- "header"
- "medicalGroupLink"
- "medicalGroupLinkName"
- "content"
"medicalGroup" under "filters" has changed. Also includes the following fields to configure tooltip and hover text:
- "tooltipText"
- "hoverText"
Disclaimer has been pulled into configuration file. See section below named "disclaimer"
Under "tenant" there are new options:
- "showProviderVideo" - This property will allow for YouTube videos to show up in Provider Details page if a provider has Videos in their provider data.
  - This property can be overridden at the Division or Market level.
- "showMedGroupBanner" - This property determines if "banner" as defined under the "medGroupDictionary" will show up on the Provider Search Results page.

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

JSON Configuration File

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": {
      "locationRequired": true,
      "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",
          "banner": {
            "header": "Doctors in the Dignity Health network",
            "medicalGroupLink": "https://www.dignityhealth.org/dhmf",
            "medicalGroupLinkName": "Dignity Health medical groups.",
            "content": "Find a doctor within the Dignity Health network. Just look for the logo next to the provider’s image, or use the Medical Group filter. <br/><br/> Learn more about <a class=\"banner-medicalgroup\" target=\"_blank\" href={bannerMedicalGroupLinkPlaceholder}>{bannerMedicalGroupNamePlaceholder}</a>"
          }
        },
        {
          "code": "enterprise",
          "identifiers": "enterprise|all",
          "url": "https://www.dignityhealth.org/dhmf",
          "title": "All Medical Groups",
          "city": "",
          "state": "",
          "latitude": "",
          "longitude": "",
          "getToKnowContent": "{providerDisplayFullNamePlaceHolder} is part of <a href='{medGroupUrlPlaceHolder}'>{medGroupTitlePlaceHolder}.</a>",
          "logoPath": "https://dignity-health.cshcontentstage.org/content/dam/dignity-health/logo/dh-logo.svg",
          "banner": {
            "header": "Doctors in the Dignity Health network",
            "medicalGroupLink": "https://www.dignityhealth.org/dhmf",
            "medicalGroupLinkName": "Dignity Health medical groups.",
            "content": "Find a doctor within the Dignity Health network. Just look for the logo next to the provider’s image, or use the Medical Group filter. <br/><br/> Learn more about <a class=\"banner-medicalgroup\" target=\"_blank\" href={bannerMedicalGroupLinkPlaceholder}>{bannerMedicalGroupNamePlaceholder}</a>"
          }
        },
        {
          "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",
          "getToKnowContent": "{providerDisplayFullNamePlaceHolder} is part of <a href='{medGroupUrlPlaceHolder}'>{medGroupTitlePlaceHolder}.</a>",
          "logoPath": "https://dignity-health.cshcontentstage.org/content/dam/dignity-health/logo/dh-logo.svg",
          "banner": {
            "header": "Doctors in the Dignity Health network",
            "medicalGroupLink": "https://www.dignityhealth.org/dhmf",
            "medicalGroupLinkName": "Dignity Health medical groups.",
            "content": "Find a doctor within the Dignity Health network. Just look for the logo next to the provider’s image, or use the Medical Group filter. <br/><br/> Learn more about <a class=\"banner-medicalgroup\" target=\"_blank\" href={bannerMedicalGroupLinkPlaceholder}>{bannerMedicalGroupNamePlaceholder}</a>"
          }
        },
        {
          "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",
          "getToKnowContent": "{providerDisplayFullNamePlaceHolder} is part of <a href='{medGroupUrlPlaceHolder}'>{medGroupTitlePlaceHolder}.</a>",
          "logoPath": "https://dignity-health.cshcontentstage.org/content/dam/dignity-health/logo/dh-logo.svg",
          "banner": {
            "header": "Doctors in the Dignity Health network",
            "medicalGroupLink": "https://www.dignityhealth.org/dhmf",
            "medicalGroupLinkName": "Dignity Health medical groups.",
            "content": "Find a doctor within the Dignity Health network. Just look for the logo next to the provider’s image, or use the Medical Group filter. <br/><br/> Learn more about <a class=\"banner-medicalgroup\" target=\"_blank\" href={bannerMedicalGroupLinkPlaceholder}>{bannerMedicalGroupNamePlaceholder}</a>"
          }
        },
        {
          "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",
          "getToKnowContent": "{providerDisplayFullNamePlaceHolder} is part of <a href='{medGroupUrlPlaceHolder}'>{medGroupTitlePlaceHolder}.</a>",
          "logoPath": "https://dignity-health.cshcontentstage.org/content/dam/dignity-health/logo/dh-logo.svg",
          "banner": {
            "header": "Doctors in the Dignity Health network",
            "medicalGroupLink": "https://www.dignityhealth.org/dhmf",
            "medicalGroupLinkName": "Dignity Health medical groups.",
            "content": "Find a doctor within the Dignity Health network. Just look for the logo next to the provider’s image, or use the Medical Group filter. <br/><br/> Learn more about <a class=\"banner-medicalgroup\" target=\"_blank\" href={bannerMedicalGroupLinkPlaceholder}>{bannerMedicalGroupNamePlaceholder}</a>"
          }
        },
        {
          "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",
          "getToKnowContent": "{providerDisplayFullNamePlaceHolder} is part of <a href='{medGroupUrlPlaceHolder}'>{medGroupTitlePlaceHolder}.</a>",
          "logoPath": "https://dignity-health.cshcontentstage.org/content/dam/dignity-health/logo/dh-logo.svg",
          "banner": {
            "header": "Doctors in the Dignity Health network",
            "medicalGroupLink": "https://www.dignityhealth.org/dhmf",
            "medicalGroupLinkName": "Dignity Health medical groups.",
            "content": "Find a doctor within the Dignity Health network. Just look for the logo next to the provider’s image, or use the Medical Group filter. <br/><br/> Learn more about <a class=\"banner-medicalgroup\" target=\"_blank\" href={bannerMedicalGroupLinkPlaceholder}>{bannerMedicalGroupNamePlaceholder}</a>"
          }
        },
        {
          "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",
          "getToKnowContent": "{providerDisplayFullNamePlaceHolder} is part of <a href='{medGroupUrlPlaceHolder}'>{medGroupTitlePlaceHolder}.</a>",
          "logoPath": "https://dignity-health.cshcontentstage.org/content/dam/dignity-health/logo/dh-logo.svg",
          "banner": {
            "header": "Doctors in the Dignity Health network",
            "medicalGroupLink": "https://www.dignityhealth.org/dhmf",
            "medicalGroupLinkName": "Dignity Health medical groups.",
            "content": "Find a doctor within the Dignity Health network. Just look for the logo next to the provider’s image, or use the Medical Group filter. <br/><br/> Learn more about <a class=\"banner-medicalgroup\" target=\"_blank\" href={bannerMedicalGroupLinkPlaceholder}>{bannerMedicalGroupNamePlaceholder}</a>"
          }
        },
        {
          "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",
          "getToKnowContent": "{provderDisplayFullNamePlaceHolder} is part of <a href='{medGroupUrlPlaceHolder}'>{medGroupTitlePlaceHolder}.</a>",
          "logoPath": "https://dignity-health.cshcontentstage.org/content/dam/dignity-health/logo/dh-logo.svg",
          "banner": {
            "header": "Doctors in the Dignity Health network",
            "medicalGroupLink": "https://www.dignityhealth.org/dhmf",
            "medicalGroupLinkName": "Dignity Health medical groups.",
            "content": "Find a doctor within the Dignity Health network. Just look for the logo next to the provider’s image, or use the Medical Group filter. <br/><br/> Learn more about <a class=\"banner-medicalgroup\" target=\"_blank\" href={bannerMedicalGroupLinkPlaceholder}>{bannerMedicalGroupNamePlaceholder}</a>"
          }
        },
        {
          "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",
          "getToKnowContent": "{providerDisplayFullNamePlaceHolder} is part of <a href='{medGroupUrlPlaceHolder}'>{medGroupTitlePlaceHolder}.</a>",
          "logoPath": "https://dignity-health.cshcontentstage.org/content/dam/dignity-health/logo/dh-logo.svg",
          "banner": {
            "header": "Doctors in the Dignity Health network",
            "medicalGroupLink": "https://www.dignityhealth.org/dhmf",
            "medicalGroupLinkName": "Dignity Health medical groups.",
            "content": "Find a doctor within the Dignity Health network. Just look for the logo next to the provider’s image, or use the Medical Group filter. <br/><br/> Learn more about <a class=\"banner-medicalgroup\" target=\"_blank\" href={bannerMedicalGroupLinkPlaceholder}>{bannerMedicalGroupNamePlaceholder}</a>"
          }
        },
        {
          "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",
          "getToKnowContent": "{providerDisplayFullNamePlaceHolder} is part of <a href='{medGroupUrlPlaceHolder}'>{medGroupTitlePlaceHolder}.</a>",
          "logoPath": "https://dignity-health.cshcontentstage.org/content/dam/dignity-health/logo/dh-logo.svg",
          "banner": {
            "header": "Doctors in the Dignity Health network",
            "medicalGroupLink": "https://www.dignityhealth.org/dhmf",
            "medicalGroupLinkName": "Dignity Health medical groups.",
            "content": "Find a doctor within the Dignity Health network. Just look for the logo next to the provider’s image, or use the Medical Group filter. <br/><br/> Learn more about <a class=\"banner-medicalgroup\" target=\"_blank\" href={bannerMedicalGroupLinkPlaceholder}>{bannerMedicalGroupNamePlaceholder}</a>"
          }
        },
        {
          "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",
          "getToKnowContent": "{providerDisplayFullNamePlaceHolder} is part of <a href='{medGroupUrlPlaceHolder}'>{medGroupTitlePlaceHolder}.</a>",
          "logoPath": "https://dignity-health.cshcontentstage.org/content/dam/dignity-health/logo/dh-logo.svg",
          "banner": {
            "header": "Doctors in the Dignity Health network",
            "medicalGroupLink": "https://www.dignityhealth.org/dhmf",
            "medicalGroupLinkName": "Dignity Health medical groups.",
            "content": "Find a doctor within the Dignity Health network. Just look for the logo next to the provider’s image, or use the Medical Group filter. <br/><br/> Learn more about <a class=\"banner-medicalgroup\" target=\"_blank\" href={bannerMedicalGroupLinkPlaceholder}>{bannerMedicalGroupNamePlaceholder}</a>"
          }
        },
        {
          "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",
          "getToKnowContent": "{providerDisplayFullNamePlaceHolder} is part of <a href='{medGroupUrlPlaceHolder}'>{medGroupTitlePlaceHolder}.</a>",
          "logoPath": "https://dignity-health.cshcontentstage.org/content/dam/dignity-health/logo/dh-logo.svg",
          "banner": {
            "header": "Doctors in the Dignity Health network",
            "medicalGroupLink": "https://www.dignityhealth.org/dhmf",
            "medicalGroupLinkName": "Dignity Health medical groups.",
            "content": "Find a doctor within the Dignity Health network. Just look for the logo next to the provider’s image, or use the Medical Group filter. <br/><br/> Learn more about <a class=\"banner-medicalgroup\" target=\"_blank\" href={bannerMedicalGroupLinkPlaceholder}>{bannerMedicalGroupNamePlaceholder}</a>"
          }
        },
        {
          "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",
          "getToKnowContent": "{providerDisplayFullNamePlaceHolder} is part of <a href='{medGroupUrlPlaceHolder}'>{medGroupTitlePlaceHolder}.</a>",
          "logoPath": "https://dignity-health.cshcontentstage.org/content/dam/dignity-health/logo/dh-logo.svg",
          "banner": {
            "header": "Doctors in the Dignity Health network",
            "medicalGroupLink": "https://www.dignityhealth.org/dhmf",
            "medicalGroupLinkName": "Dignity Health medical groups.",
            "content": "Find a doctor within the Dignity Health network. Just look for the logo next to the provider’s image, or use the Medical Group filter. <br/><br/> Learn more about <a class=\"banner-medicalgroup\" target=\"_blank\" href={bannerMedicalGroupLinkPlaceholder}>{bannerMedicalGroupNamePlaceholder}</a>"
          }
        },
        {
          "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",
          "getToKnowContent": "{providerDisplayFullNamePlaceHolder} is part of <a href='{medGroupUrlPlaceHolder}'>{medGroupTitlePlaceHolder}.</a>",
          "logoPath": "https://dignity-health.cshcontentstage.org/content/dam/dignity-health/logo/dh-logo.svg",
          "banner": {
            "header": "Doctors in the Dignity Health network",
            "medicalGroupLink": "https://www.dignityhealth.org/dhmf",
            "medicalGroupLinkName": "Dignity Health medical groups.",
            "content": "Find a doctor within the Dignity Health network. Just look for the logo next to the provider’s image, or use the Medical Group filter. <br/><br/> Learn more about <a class=\"banner-medicalgroup\" target=\"_blank\" href={bannerMedicalGroupLinkPlaceholder}>{bannerMedicalGroupNamePlaceholder}</a>"
          }
        },
        {
          "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",
          "getToKnowContent": "{providerDisplayFullNamePlaceHolder} is part of <a href='{medGroupUrlPlaceHolder}'>{medGroupTitlePlaceHolder}.</a>",
          "logoPath": "https://dignity-health.cshcontentstage.org/content/dam/dignity-health/logo/dh-logo.svg",
          "banner": {
            "header": "Doctors in the Dignity Health network",
            "medicalGroupLink": "https://www.dignityhealth.org/dhmf",
            "medicalGroupLinkName": "Dignity Health medical groups.",
            "content": "Find a doctor within the Dignity Health network. Just look for the logo next to the provider’s image, or use the Medical Group filter. <br/><br/> Learn more about <a class=\"banner-medicalgroup\" target=\"_blank\" href={bannerMedicalGroupLinkPlaceholder}>{bannerMedicalGroupNamePlaceholder}</a>"
          }
        },
        {
          "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",
          "getToKnowContent": "{providerDisplayFullNamePlaceHolder} is part of <a href='{medGroupUrlPlaceHolder}'>{medGroupTitlePlaceHolder}.</a>",
          "logoPath": "https://dignity-health.cshcontentstage.org/content/dam/dignity-health/logo/dh-logo.svg",
          "banner": {
            "header": "Doctors in the Dignity Health network",
            "medicalGroupLink": "https://www.dignityhealth.org/dhmf",
            "medicalGroupLinkName": "Dignity Health medical groups.",
            "content": "Find a doctor within the Dignity Health network. Just look for the logo next to the provider’s image, or use the Medical Group filter. <br/><br/> Learn more about <a class=\"banner-medicalgroup\" target=\"_blank\" href={bannerMedicalGroupLinkPlaceholder}>{bannerMedicalGroupNamePlaceholder}</a>"
          }
        },
        {
          "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",
          "getToKnowContent": "{providerDisplayFullNamePlaceHolder} is part of <a href='{medGroupUrlPlaceHolder}'>{medGroupTitlePlaceHolder}.</a>",
          "logoPath": "https://dignity-health.cshcontentstage.org/content/dam/dignity-health/logo/dh-logo.svg",
          "banner": {
            "header": "Doctors in the Dignity Health network",
            "medicalGroupLink": "https://www.dignityhealth.org/dhmf",
            "medicalGroupLinkName": "Dignity Health medical groups.",
            "content": "Find a doctor within the Dignity Health network. Just look for the logo next to the provider’s image, or use the Medical Group filter. <br/><br/> Learn more about <a class=\"banner-medicalgroup\" target=\"_blank\" href={bannerMedicalGroupLinkPlaceholder}>{bannerMedicalGroupNamePlaceholder}</a>"
          }
        },
        {
          "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",
          "getToKnowContent": "{providerDisplayFullNamePlaceHolder} is part of <a href='{medGroupUrlPlaceHolder}'>{medGroupTitlePlaceHolder}.</a>",
          "logoPath": "https://dignity-health.cshcontentstage.org/content/dam/dignity-health/logo/dh-logo.svg",
          "banner": {
            "header": "Doctors in the Dignity Health network",
            "medicalGroupLink": "https://www.dignityhealth.org/dhmf",
            "medicalGroupLinkName": "Dignity Health medical groups.",
            "content": "Find a doctor within the Dignity Health network. Just look for the logo next to the provider’s image, or use the Medical Group filter. <br/><br/> Learn more about <a class=\"banner-medicalgroup\" target=\"_blank\" href={bannerMedicalGroupLinkPlaceholder}>{bannerMedicalGroupNamePlaceholder}</a>"
          }
        },
        {
          "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",
          "getToKnowContent": "{providerDisplayFullNamePlaceHolder} is part of <a href='{medGroupUrlPlaceHolder}'>{medGroupTitlePlaceHolder}.</a>",
          "logoPath": "https://dignity-health.cshcontentstage.org/content/dam/dignity-health/logo/dh-logo.svg",
          "banner": {
            "header": "Doctors in the Dignity Health network",
            "medicalGroupLink": "https://www.dignityhealth.org/dhmf",
            "medicalGroupLinkName": "Dignity Health medical groups.",
            "content": "Find a doctor within the Dignity Health network. Just look for the logo next to the provider’s image, or use the Medical Group filter. <br/><br/> Learn more about <a class=\"banner-medicalgroup\" target=\"_blank\" href={bannerMedicalGroupLinkPlaceholder}>{bannerMedicalGroupNamePlaceholder}</a>"
          }
        },
        {
          "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",
          "getToKnowContent": "{providerDisplayFullNamePlaceHolder} is part of <a href='{medGroupUrlPlaceHolder}'>{medGroupTitlePlaceHolder}.</a>",
          "logoPath": "https://dignity-health.cshcontentstage.org/content/dam/dignity-health/logo/dh-logo.svg",
          "banner": {
            "header": "Doctors in the Dignity Health network",
            "medicalGroupLink": "https://www.dignityhealth.org/dhmf",
            "medicalGroupLinkName": "Dignity Health medical groups.",
            "content": "Find a doctor within the Dignity Health network. Just look for the logo next to the provider’s image, or use the Medical Group filter. <br/><br/> Learn more about <a class=\"banner-medicalgroup\" target=\"_blank\" href={bannerMedicalGroupLinkPlaceholder}>{bannerMedicalGroupNamePlaceholder}</a>"
          }
        }
      ]
    },
    "tenant": {
      "tenantCode": "common-spirit",
      "showProviderVideo": false,
      "showMedGroupBanner": true,
      "showProviderPrefix": true,
      "showMedGroupLogo": true,
      "providerRatings": {
        "showStarRatings": true,
        "showProviderReviews": true,
        "showRatingText": true,
        "showReviewCount": true,
        "ratingsFooterText": "Transparency is our top priority. Providers can't change or delete reviews, and we do not publish any private health information.",
        "ratingsFooterLinkText": "Learn more here.",
        "ratingsFooterLink": "https://www.dignityhealth.org/my-home/about-our-survey",
        "ratingsBannerText": "We now display star ratings for our providers! ",
        "ratingsBannerLink": "https://www.dignityhealth.org/my-home/about-our-survey",
        "ratingsBannerLinkText": "Learn more about our rating system.",
        "ratingsTooltipText": "Ratings only display for Dignity Health providers with 20 or more patient surveys in the past 12 months.",
        "showStarRatingsBanner": true
      },
      "dynamicSEOContent": {
        "showContent": true,
        "onlineSchedulingContent": [{
          "filterKeywords": ["Online Scheduling"],
          "subHeading": "Schedule an appointment online",
          "paragraph": "You can have peace of mind knowing reliable coverage is even easier to access than ever before. We offer many ways for you to schedule an appointment with a doctor or health care professional, including online scheduling. Take the first step toward achieving better health.",
            "group": 1
          }
        ],
        "medicalGroupContent": [{
          "filterKeywords": ["Medical Group"],
          "subHeading": "Compassionate care close to home with Baylor St. Luke’s Medical Group",
          "paragraph": "At Baylor St. Luke’s Medical Group, our doctors, physician assistants, nurses, and other medical professionals work together to help our patients take charge of their health. We accept all major insurance plans, making it easier for you to access high-quality and high-value care. <a href='{learnMoreLinkPlaceholder}'>Learn more about the benefits of our health network.</a>",
          "group": 2,
          "learnMoreLink": "/baylor-st-lukes-medical-group"
        }],
        "specialtyGroupContent": [
          {
            "filterKeywords": ["Bariatric Surgery"],
            "subHeading": "Bariatric surgeons in Greater Houston and East Texas",
            "paragraph": "Our bariatric surgeons are dedicated to providing compassionate, patient-centered care to help people lose weight and improve their overall health. With various locations throughout the region, you can find the customized services you need close to home. <a href='{learnMoreLinkPlaceholder}'>Learn more about our weight-loss surgery options.</a>",
            "group": 3,
            "learnMoreLink": "/services-specialties/bariatric-surgery"
          },
          {
            "filterKeywords": ["Cardiology"],
            "subHeading": "Cardiology care in Greater Houston and East Texas",
            "paragraph": "Our cardiologists are dedicated to providing compassionate, patient-centered care for many heart conditions. With various locations throughout the region, you can find the customized services you need close to home. <a href='{learnMoreLinkPlaceholder}'>Learn more about our cardiology services.</a>",
            "group": 3,
            "learnMoreLink": "/services-specialties/cardiovascular-care"
          },
          {
            "filterKeywords": ["Spine Care"],
            "subHeading": "",
            "paragraph": "Our spine care specialists are passionate about providing high-quality diagnostic, treatment, surgery, and rehabilitation services for a full range of spinal conditions, ranging from trauma to chronic neck and back pain. <a href='{learnMoreLinkPlaceholder}'>Learn more about our spine care services.</a>",
            "group": 4,
            "learnMoreLink": "/services-specialties/spine-care"
          },
          {
            "filterKeywords": ["Orthopedic Surgery: Foot and Ankle"],
            "subHeading": "",
            "paragraph": "Our foot and ankle specialists treat Achilles tendinitis and tendinosis, plantar fasciitis, ligament tears, and more.",
            "group": 5
          }
        ]
      },
      "divisions": [
        {
          "name": "Texas",
          "divisionCode": "Texas",
          "providerRatings": {
            "showStarRatings": true,
            "showProviderReviews": true,
            "showRatingText": true,
            "showReviewCount": true,
            "ratingsFooterText": "Transparency is our top priority. Providers can't change or delete reviews, and we do not publish any private health information.",
            "ratingsFooterLinkText": "Learn more here.",
            "ratingsFooterLink": "https://www.dignityhealth.org/my-home/about-our-survey",
            "ratingsBannerText": "We now display star ratings for our providers! ",
            "ratingsBannerLink": "https://www.dignityhealth.org/my-home/about-our-survey",
            "ratingsBannerLinkText": "Learn more about our rating system.",
            "ratingsTooltipText": "Ratings only display for Dignity Health providers with 20 or more patient surveys in the past 12 months.",
            "showStarRatingsBanner": true
          },
          "markets": [
            {
              "name": "SJH",
              "code": "SJH",
              "providerRatings": {
                "showStarRatings": true,
                "showProviderReviews": true,
                "showRatingText": true,
                "showReviewCount": true,
                "ratingsFooterText": "Transparency is our top priority. Providers can't change or delete reviews, and we do not publish any private health information.",
                "ratingsFooterLinkText": "Learn more here.",
                "ratingsFooterLink": "https://www.dignityhealth.org/my-home/about-our-survey",
                "ratingsBannerText": "We now display star ratings for our providers! ",
                "ratingsBannerLink": "https://www.dignityhealth.org/my-home/about-our-survey",
                "ratingsBannerLinkText": "Learn more about our rating system.",
                "ratingsTooltipText": "Ratings only display for Dignity Health providers with 20 or more patient surveys in the past 12 months.",
                "showStarRatingsBanner": true
              },
            }
          ]
        }
      ]
    },
    "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}&providerName={1}&previousPageReturnUrl="
    },
    "emergencyCare": {
      "enabled": true,
      "linkScheme": "https://www.dignityhealth.org/emergency-care"
    },
    "quickLinks": {
      "enabled": true,
      "categories": [
      {
          "value": "Video Visits",
          "type": "videovisits",
          "icon": "videocam"
        },
        {
          "value": "Online Scheduling",
          "type": "bookonline",
          "alternateText": "Online Scheduling"
        },      
        {
          "value": "Primary Care" ,
          "type": "keywords"
        },
        {
          "value": "Cardiology",
          "type": "Specialities"
        },
        {
          "value": "Gynecology",
          "type": "keywords"
        }
      ]
    },
    "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,
        "tooltipText": "Search providers within the Dignity Health network",
        "hoverText": "Choose a medical group to show providers within the Dignity Health network."
      },
      "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
    },
    "disclaimer": {
      "enabled": true,
      "text": "Notice: \"Find a Doctor\" is provided by Dignity Health as a convenience to you. The information on each participating doctor is submitted to Dignity Health by each doctor and is not independently verified by Dignity Health. Each doctor is solely responsible for the completeness and accuracy of the information listed about him or her. Dignity Health is not responsible for any loss or damages caused by your reliance on the doctor information contained on Find a Doctor. You should telephone the doctor's office in advance to verify the accuracy of the information."
    },
    "logging": {
      "logLevel": 4
    },
    "hospitalAffiliations": {
      "enabled": true
    },
    "showPatientAgeRestrictions": {
      "enabled": false
    }
  },
  "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"
  },
  "useLegacyAPI": true
}

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

locationRequired: FAD SPA consumer can configure whether location input is mandatory for the search, if false - user can search without a location.
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

url Pipe-delimited alternate identifiers yes

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) yes

banner Network banner no

banner: network banner object has the following specification: | Key | Description | Required | |-------------------------|-------------------------------------------|----------| | header | Network banner header | yes | | medicalGroupLink | Medical group link for banner | yes | | medicalGroupLinkName | Link name for medical group | yes | | content | Banner content | yes |

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
`url`	Pipe-delimited alternate identifiers	yes
`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)	yes
`banner`	Network banner	no

`"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

showMedgroupBanner toggle on/off the network banner no

showProviderVideo toggle on/off provider video in details page no

showMedGroupLogo toggle on/off medgroup logo in the site no

showProviderPrefix toggle on/off display provider name with title in site no

providerRatings array of abject containing provider rating details no

dynamicSEOContent array of abject containing dynamic content details no

divisions array of abject containing division details no

Key	Description	Required
`tenantCode`	Value to use for `x-tenant` in http request header	yes
`showMedgroupBanner`	toggle on/off the network banner	no
`showProviderVideo`	toggle on/off provider video in details page	no
`showMedGroupLogo`	toggle on/off medgroup logo in the site	no
`showProviderPrefix`	toggle on/off display provider name with title in site	no
`providerRatings`	array of abject containing provider rating details	no
`dynamicSEOContent`	array of abject containing dynamic content details	no
`divisions`	array of abject containing division details	no

`"providerRatings"` section

Controls providerRatings-specific data

Key Description Required

useNewRatingsEndpoint Feature flag to call newer MuleSoft API endpoint no

showStarRatings toggle on/off star rating in the site no

showProviderReviews toggle on/off provider reviews in the site no

showRatingText toggle on/off rating text in the site no

showReviewCount toggle on/off review count in the site no

ratingsFooterText Text for ratings footer text in the site no

ratingsFooterLinkText Link text for ratings footer link text in the site no

ratingsFooterLink Link for ratings footer link in the site no

ratingsBannerText Text for ratings banner text in the site no

ratingsBannerLink Link for ratings banner link in the site no

ratingsBannerLinkText Link text for ratings banner link text in the site no

ratingsTooltipText Text for ratings tooltip text in the site no

showStarRatingsBanner toggle on/off star rating banner in the site no

useLiveMedGroups toggle on/off the usage of live ned groups in the site no

liveMedGroups Array of liveMedGroups no

Key	Description	Required
`useNewRatingsEndpoint`	Feature flag to call newer MuleSoft API endpoint	no
`showStarRatings`	toggle on/off star rating in the site	no
`showProviderReviews`	toggle on/off provider reviews in the site	no
`showRatingText`	toggle on/off rating text in the site	no
`showReviewCount`	toggle on/off review count in the site	no
`ratingsFooterText`	Text for ratings footer text in the site	no
`ratingsFooterLinkText`	Link text for ratings footer link text in the site	no
`ratingsFooterLink`	Link for ratings footer link in the site	no
`ratingsBannerText`	Text for ratings banner text in the site	no
`ratingsBannerLink`	Link for ratings banner link in the site	no
`ratingsBannerLinkText`	Link text for ratings banner link text in the site	no
`ratingsTooltipText`	Text for ratings tooltip text in the site	no
`showStarRatingsBanner`	toggle on/off star rating banner in the site	no
`useLiveMedGroups`	toggle on/off the usage of live ned groups in the site	no
`liveMedGroups`	Array of liveMedGroups	no

Note: We can define the "providerRatings" section either in market, division and tenant level or at all the levels, the most granular level(last child) will be considered.

`"dynamicSEOContent"` section

Controls dynamicSEOContent-specific data

Key Description Required

showContent toggle on/off showContent in the site no

onlineSchedulingContent array holds the dynamic content for onlineScheduling no

medicalGroupContent array holds the dynamic content for Medical group items no

specialtyGroupContent array holds the dynamic content for list of specialties no

Key	Description	Required
`showContent`	toggle on/off showContent in the site	no
`onlineSchedulingContent`	array holds the dynamic content for onlineScheduling	no
`medicalGroupContent`	array holds the dynamic content for Medical group items	no
`specialtyGroupContent`	array holds the dynamic content for list of specialties	no

`"onlineSchedulingContent"` section

Controls onlineSchedulingContent-specific data

Key Description Required

filterKeywords set the filterKeywords for items in onlinescheduling no

subHeading set the sub-heading for items in onlinescheduling no

paragraph set the content for items in onlinescheduling no

group set the group number for items in onlinescheduling no

learnMoreLink set the learn more link for each of item in onlineScheduling no

Key	Description	Required
`filterKeywords`	set the filterKeywords for items in onlinescheduling	no
`subHeading`	set the sub-heading for items in onlinescheduling	no
`paragraph`	set the content for items in onlinescheduling	no
`group`	set the group number for items in onlinescheduling	no
`learnMoreLink`	set the learn more link for each of item in onlineScheduling	no

`"medicalGroupContent"` section

Controls medicalGroupContent-specific data

Key Description Required

filterKeywords set the filterKeywords for items in medicalGroup no

subHeading set the sub-heading for items in medicalGroup no

paragraph set the content for items in medicalGroup no

group set the group number for items in medicalGroup no

learnMoreLink set the learn more link for each of item in medicalGroup no

Key	Description	Required
`filterKeywords`	set the filterKeywords for items in medicalGroup	no
`subHeading`	set the sub-heading for items in medicalGroup	no
`paragraph`	set the content for items in medicalGroup	no
`group`	set the group number for items in medicalGroup	no
`learnMoreLink`	set the learn more link for each of item in medicalGroup	no

`"specialtyGroupContent"` section

Controls specialtyGroupContent-specific data

Key Description Required

filterKeywords set the filterKeywords for items in specialty group which is compared to the filter value selected by the user no

subHeading set the sub-heading for items in specialty group no

paragraph set the content for items in specialty group no

group set the group number for items in specialty group no

learnMoreLink set the learn more link for each of item in specialty group no

Key	Description	Required
`filterKeywords`	set the filterKeywords for items in specialty group which is compared to the filter value selected by the user	no
`subHeading`	set the sub-heading for items in specialty group	no
`paragraph`	set the content for items in specialty group	no
`group`	set the group number for items in specialty group	no
`learnMoreLink`	set the learn more link for each of item in specialty group	no

`"divisions"` section

Controls division-specific data

Key Description Required

name name of the division yes

code code for the division no

showProviderVideo toggle on/off provider video in details page under division level no

providerRatings array of abject containing provider rating details no

markets array of abject containing markets details as divisions no

Key	Description	Required
`name`	name of the division	yes
`code`	code for the division	no
`showProviderVideo`	toggle on/off provider video in details page under division level	no
`providerRatings`	array of abject containing provider rating details	no
`markets`	array of abject containing markets details as divisions	no

`"markets"` section

Controls market-specific data

Key Description Required

name name of the market yes

code code for the market no

providerRatings array of abject containing provider rating details no

Key	Description	Required
`name`	name of the market	yes
`code`	code for the market	no
`providerRatings`	array of abject containing provider rating details	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 'In My Own Words' section in provider details

`"suggestAnEdit"` section

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

enabled: toggles the display of 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 and {1} with the full display name 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 display of 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 display of quicklinks section on/off
categories: Array of objects that holds the user defined quicklinks categories, Each object in the array has the following specification:

Key Description Required

value Display text and search value for quicklinks categories (when used with type=specialities a '|' can be used to defined a search against multiple specialities. Ex 'Primary Care|Internal Medicine'. yes

type To specify how quicklinks will work yes

icon Sets an icon to be part of the Quick Link button (only supports 'videocam') no

alternativeText If set, this value will override the Quick Link button text. This is most useful when searching against multiple specialities. no

Key	Description	Required
`value`	Display text and search value for quicklinks categories (when used with `type`=`specialities` a '\|' can be used to defined a search against multiple specialities. Ex 'Primary Care\|Internal Medicine'.	yes
`type`	To specify how quicklinks will work	yes
`icon`	Sets an icon to be part of the Quick Link button (only supports 'videocam')	no
`alternativeText`	If set, this value will override the Quick Link button text. This is most useful when searching against multiple specialities.	no

Note: Above type should be define either 'keywords', 'specialities', 'videovisits' or 'bookonline' values.

`"Logging"` section

Controls log-level specific data

Key Description Required

LogLevel 0 - All- union of all other level yes

1 - Debug- to perform diagonistics on the application

2 - Info-highlight the progress of application at coarsed grained level

3 - Warn-designates potential harmfull situation

4 - Error-designates error events that might still allow the application to run

5 - Fatal - designates very serious error event, this will lead the application to abort

6 - Off-turn off logging will lead nothing gets logged at all

`"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.

enabled: Toggles the regional helplines section on/off
heading: Heading section for regional helplines
numbers: Array of objects, with each object having a required heading and phone section and it has the following specification:

Key Description Required

heading Heading for each of the regional helpline numbers yes

phone The actual regional helpline number no

Key	Description	Required
`heading`	Heading for each of the regional helpline numbers	yes
`phone`	The actual regional helpline number	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)

Contains various objects that act as a place holder to be used in different areas of the site.

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 objects 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 various 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

`"VideoVisits"` section

Key Description Required

enabled toggles the given video visits on/off no

Key	Description	Required
`enabled`	toggles the given video visits on/off	no

`"acceptingNewPatients"` section

Key Description Required

enabled toggles the given accepting new patients on/off no

Key	Description	Required
`enabled`	toggles the given accepting new patients on/off	no

`"availability"` section

Key Description Required

enabled toggles the given availability on/off no

Key	Description	Required
`enabled`	toggles the given availability on/off	no

`"specialty"` section

Key Description Required

enabled toggles the given specialty on/off no

Key	Description	Required
`enabled`	toggles the given specialty on/off	no

`"gender"` section

Key Description Required

enabled toggles the given gender on/off no

Key	Description	Required
`enabled`	toggles the given gender on/off	no

`"insurance"` section

Key Description Required

enabled toggles the given insurance on/off no

Key	Description	Required
`enabled`	toggles the given insurance on/off	no

`"language"` section

Key Description Required

enabled toggles the given language on/off no

Key	Description	Required
`enabled`	toggles the given language on/off	no

`"medicalGroup"` section

Key Description Required

enabled toggles the given medicalGroup on/off no

hoverText Text to be displayed on hovering the mouse over no

tooltipText Text to be displayed on the tooltip no

Key	Description	Required
`enabled`	toggles the given medicalGroup on/off	no
`hoverText`	Text to be displayed on hovering the mouse over	no
`tooltipText`	Text to be displayed on the tooltip	no

`"searchRadius"` section

Key Description Required

enabled toggles the given searchRadius on/off no

defaultDistance DefaultDistance of searchradius yes

defaultDistanceMedGroupFilterApplied DefaultDistance of searchradius for selected med group yes

Key	Description	Required
`enabled`	toggles the given searchRadius on/off	no
`defaultDistance`	DefaultDistance of searchradius	yes
`defaultDistanceMedGroupFilterApplied`	DefaultDistance of searchradius for selected med group	yes

`"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 DocASAP

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 `DocASAP`

`"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.

`"disclaimer"` section

Disclaimer content in footer section of the page

Key Description Required

enabled toggle on/off the disclaimer content yes

text disclaimer content shown on the page yes

Key	Description	Required
`enabled`	toggle on/off the disclaimer content	yes
`text`	disclaimer content shown on the page	yes

`"hospitalAffiliations"` section

Controls the HospitalAffiliations content in provider details page

Key Description Required

enabled toggle on/off the hospitalAffiliations content no

Key	Description	Required
`enabled`	toggle on/off the hospitalAffiliations content	no

`"showPatientAgeRestrictions"` section

Controls the display of a patient age restriction text blurb within provider search result cards and on the provider detail page. For example:

"Accepting appointments from patients 18+ years of age"

Even if toggled on, the text blurb only displays for providers that allow for online booking.

Key Description Required

enabled toggle on/off the patient age restriction text blurb no

Key	Description	Required
`enabled`	toggle on/off the patient age restriction text blurb	no

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

UseLegacyAPI

This section of the JSON controls which apiBaseUrl(apiBaseUrl/newApiBaseUrl) to be used from the runtimeconfig.

`"useLegacyAPI"` section:

(true/false): Use apiBaseUrl versus newApiBaseUrl in runtime config . Set to false for vmfh market and true for other markets.

Key	Description	Required
`LogLevel`	0 - `All`- union of all other level	yes
	1 - `Debug`- to perform diagonistics on the application
	2 - `Info`-highlight the progress of application at coarsed grained level
	3 - `Warn`-designates potential harmfull situation
	4 - `Error`-designates error events that might still allow the application to run
	5 - `Fatal` - designates very serious error event, this will lead the application to abort
	6 - `Off`-turn off logging will lead nothing gets logged at all

Customization Guide

Example JSON Configuration File

Important Changes

JSON Configuration File

Interfaces

"search" section

"getToKnownContent" tokens

"tenant" section

"providerRatings" section

"dynamicSEOContent" section

"onlineSchedulingContent" section

"medicalGroupContent" section

"specialtyGroupContent" section

"divisions" section

"markets" 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

"Logging" 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

"VideoVisits" section

"acceptingNewPatients" section

"availability" section

"specialty" section

"gender" section

"insurance" section

"language" section

"medicalGroup" section

"searchRadius" section

"onlineScheduling"

"showNewSchedulingApp" section:

captcha section

"disclaimer" section

"hospitalAffiliations" section

"showPatientAgeRestrictions" section