Smile CDR v2022.08.PRE
On this page:
   37.0    Web Admin Console Settings 37.2    Payer Config   

37.1appSphere

 

The appSphere configuration category includes the following configurable options:

  • JSON URL

  • Auth URL

  • Client ID

  • Legal Company Name

  • Admin Console Name

  • Contact Helpdesk

  • Contact Us URL

  • FHIR Sandbox URL

  • FHIR URL

  • Application Gallery Name

  • Hero Image, Large Format URL

  • Hero Image, Small Format URL

  • Company Logo Small URL

  • Company Logo Large URL

  • Enable Marketplace Functionality

  • PHI Warning URL

  • Developer Portal Name

  • Privacy Policy URL

  • Request app mail-to

  • Terms of Use URL

37.1.1Property: JSON URL

 
Property Name JSON URL
Property Key
Property Type STRING
Description JSON Admin URL (e.g. "https://appgallery.smilecdr.com/json-admin")
Applies to Modules
  • appSphere
Default Value http://localhost:9000
Example Property
module.[MODULE_ID].config.api.url = http://localhost:9000

37.1.2Property: Auth URL

 
Property Name Auth URL
Property Key
Property Type STRING
Description Auth URL for authenticating users of Admin Console and Developer Portal (e.g. "https://appgallery.smilecdr.com/smartauth")
Applies to Modules
  • appSphere
Default Value http://localhost:9200
Example Property
module.[MODULE_ID].config.auth.url = http://localhost:9200

37.1.3Property: Client ID

 
Property Name Client ID
Property Key
Property Type STRING
Description The OIDC Client ID that is supplied by appSphere in the request flow. This ID will be passed around as a URL parameter so it is recommended that it be a fairly simple string (e.g. Please refer to OpenID Connect Clients setup)
Applies to Modules
  • appSphere
Default Value appsphere
Example Property
module.[MODULE_ID].config.client.id = appsphere

37.1.4Property: Legal Company Name

 
Property Name Legal Company Name
Property Key
Property Type STRING
Description This is used for legal documentation such as in Attestation documents and should not be changed without reason (e.g. "Smile CDR")
Applies to Modules
  • appSphere
Default Value Smile CDR
Example Property
module.[MODULE_ID].config.company.name = Smile CDR

37.1.5Property: Admin Console Name

 
Property Name Admin Console Name
Property Key
Property Type STRING
Description Admin Console Name to display in the application
Applies to Modules
  • appSphere
Default Value SMART on FHIR App Management Console
Example Property
module.[MODULE_ID].config.console.name = SMART on FHIR App Management Console

37.1.6Property: Contact Helpdesk

 
Property Name Contact Helpdesk
Property Key
Property Type STRING
Description The URL or mail-to link for Gallery support (e.g. "mailto:admin@example.com", "http://example.com/app/request")
Applies to Modules
  • appSphere
Default Value (no default)
Example Property
module.[MODULE_ID].config.contact.helpdesk = 

37.1.7Property: Contact Us URL

 
Property Name Contact Us URL
Property Key
Property Type STRING
Description appSphere Admin Contact Us URL (e.g. "https://www.smilecdr.com/contact-us")
Applies to Modules
  • appSphere
Default Value https://www.smilecdr.com/contact-us
Example Property
module.[MODULE_ID].config.contact.url = https://www.smilecdr.com/contact-us

37.1.8Property: FHIR Sandbox URL

 
Property Name FHIR Sandbox URL
Property Key
Property Type STRING
Description The FHIR REST Endpoint URL for Sandbox testing.
Applies to Modules
  • appSphere
Default Value (no default)
Example Property
module.[MODULE_ID].config.fhir.sandbox.url = 

37.1.9Property: FHIR URL

 
Property Name FHIR URL
Property Key
Property Type STRING
Description FHIR REST Endpoint URL (e.g. "https://appgallery.smilecdr.com/fhir-request")
Applies to Modules
  • appSphere
Default Value http://localhost:8000
Example Property
module.[MODULE_ID].config.fhir.url = http://localhost:8000

37.1.10Property: Application Gallery Name

 
Property Name Application Gallery Name
Property Key
Property Type STRING
Description Application Gallery Name to display in the application
Applies to Modules
  • appSphere
Default Value SMART on FHIR Application Gallery
Example Property
module.[MODULE_ID].config.gallery.name = SMART on FHIR Application Gallery

37.1.11Property: Hero Image, Large Format URL

 
Property Name Hero Image, Large Format URL
Property Key
Property Type STRING
Description Hero image for the white-labelled Gallery desktop size, .png, min width 2000px (e.g. "assets/masthead-desktop.png")
Applies to Modules
  • appSphere
Default Value assets/masthead-desktop.png
Example Property
module.[MODULE_ID].config.hero.image.large = assets/masthead-desktop.png

37.1.12Property: Hero Image, Small Format URL

 
Property Name Hero Image, Small Format URL
Property Key
Property Type STRING
Description Hero image for the white-labelled Gallery mobile size, .png, min width 1000px (e.g. "assets/masthead-mobile.png")
Applies to Modules
  • appSphere
Default Value assets/masthead-mobile.png
Example Property
module.[MODULE_ID].config.hero.image.small = assets/masthead-mobile.png

37.1.13Property: Company Logo Small URL

 
Property Name Company Logo Small URL
Property Key
Property Type STRING
Description Logo displayed in nav bar, .png, exact height 28px (e.g. "assets/smileCdrLogo.png")
Applies to Modules
  • appSphere
Default Value assets/smileCdrLogo.png
Example Property
module.[MODULE_ID].config.logo.small.url = assets/smileCdrLogo.png

37.1.14Property: Company Logo Large URL

 
Property Name Company Logo Large URL
Property Key
Property Type STRING
Description Logo displayed at login, .png, height 50-100px (e.g. "assets/smileCdrLogo.png")
Applies to Modules
  • appSphere
Default Value assets/smileCdrLogo.png
Example Property
module.[MODULE_ID].config.logo.url = assets/smileCdrLogo.png

37.1.15Property: Enable Marketplace Functionality

 
Property Name Enable Marketplace Functionality
Property Key
Property Type BOOLEAN
Description WARNING! Setting this toggle to 'Yes' could result in unpredictable behavior and loss of data. For use by Smile CDR company staff only.
Applies to Modules
  • appSphere
Default Value (no default)
Example Property
module.[MODULE_ID].config.marketplace.enabled = 

37.1.16Property: PHI Warning URL

 
Property Name PHI Warning URL
Property Key
Property Type STRING
Description The URL containing a plain-language explanation of the declined attestation
Applies to Modules
  • appSphere
Default Value https://www.cms.gov/files/document/patient-privacy-and-security-resources.pdf
Example Property
module.[MODULE_ID].config.phi.warning.url = https://www.cms.gov/files/document/patient-privacy-and-security-resources.pdf

37.1.17Property: Developer Portal Name

 
Property Name Developer Portal Name
Property Key
Property Type STRING
Description Developer Portal Name to display in the application
Applies to Modules
  • appSphere
Default Value SMART on FHIR App Developer Portal
Example Property
module.[MODULE_ID].config.portal.name = SMART on FHIR App Developer Portal

37.1.18Property: Privacy Policy URL

 
Property Name Privacy Policy URL
Property Key
Property Type STRING
Description appSphere Privacy Policy URL
Applies to Modules
  • appSphere
Default Value (no default)
Example Property
module.[MODULE_ID].config.privacy.url = 

37.1.19Property: Request app mail-to

 
Property Name Request app mail-to
Property Key
Property Type STRING
Description The URL or mail-to link for the Console Manager responsible for contacting unregistered vendors (e.g. "mailto:admin@example.com", "http://example.com/app/request")
Applies to Modules
  • appSphere
Default Value (no default)
Example Property
module.[MODULE_ID].config.request.app.url = 

37.1.20Property: Terms of Use URL

 
Property Name Terms of Use URL
Property Key
Property Type STRING
Description appSphere Terms of Use URL
Applies to Modules
  • appSphere
Default Value (no default)
Example Property
module.[MODULE_ID].config.terms.url = 
   37.0    Web Admin Console Settings 37.2    Payer Config