Config DiagnosticsTrial
The "Config Diagnostics" page in Smile CDR's Web Admin Console detects and reports common misconfigurations that might lead to errors or warnings while setting up the appSphere. To validate the configurations made to set up the appSphere, refer to the following examples:
| Warnings |
|---|
| [appSphere module ID] should have dependency set up for OpenID Connect Authentication |
| Sandbox FHIR Endpoint dependency in [appSphere module ID] should be assigned if FHIR Sandbox URL is set |
| OpenID Connect Security or security.oic.enabled (property key) value should be true in [FHIR Endpoint/Sandbox FHIR Endpoint module ID] for OpenID Connect Client creation and FHIR Endpoint access to work |
| [FHIR Endpoint/Sandbox FHIR Endpoint module ID] should have OpenID Connect Authentication dependency assigned for OIC Client creation and FHIR Endpoint access to work |
| [Client ID] should be set up and enabled as an OpenID Connect Client under the module specified in OpenID Connect Authentication dependency for [appSphere module ID] |
| Errors |
|---|
| Sandbox FHIR Endpoint dependency not set in the [appSphere module ID] |
| FHIR Endpoint should be different from Sandbox FHIR Endpoint |
| [FHIR Endpoint module ID] and [Sandbox FHIR Endpoint module ID] should have different OpenID Connect Authentication dependencies to prevent sandbox clients from accessing production data |
Note: Module ID for each module type can be assigned by users based on preference
App Registration Help TextTrial
| Step | Label | Help Text |
|---|
| 1 | App Name | Name of the App as it appears in supported App stores and download sites. |
| 2 | Supported Operating Systems | The operating systems for which the App is available. |
| 2 | App Homepage URL | The URL where the App’s download sites can be found. Use your homepage if no specific App page exists. |
| 2 | URL to the App’s Privacy Policy | The URL of a webpage describing the App’s privacy policy. |
| 2 | URL to App’s Terms of Service | The URL of a webpage describing the App’s terms of service. |
| 2 | OAuth Redirect URL | The URL to which users are redirected upon successful authentication |
| 2 | Web App Launch URL | For web Apps only. The URL used to start the authentication process. See the SMART App Launch Implementation Guide. |
| 3 | App Descriptions | These will appear in the public-facing site. |
| 3 | Upload App Icon | Use the guidelines from the Google Play Store. Upload the same icon used on other download sites. |
| 4 | For the following categories, select all that are applicable | Choose one or more options from each category to help users search for and find your App. |
| 4 | HIPPA | Select if your organization is HIPAA compliant. You may be asked to provide supporting documents. Learn More |
| 4 | GDPR | Select if your organization is GDPR compliant. You may be asked to provide supporting documents. Learn More |
| 4 | CARIN Code of Conduct | Select if your organization attests to following the CARIN Code of Conduct. You may be asked to provide supporting documents. Learn More |
| 4 | ONC Model Privacy Notice | Select if your organization has completed the ONC Privacy Notice. You may be asked to provide supporting documents. Learn More |
| 4 | Confidentiality | Declare if the app runs in an execution environment that enables the app to protect secrets. If not, toggle to “Public”. Learn More |
| 5 | Request Scopes | Type in scopes to request app permissions. Learn More |
| 7 | Legal Attestation | Either accept or decline adherence to the CMS ruling. Note that declining is allowed but may result in a public warning placed on your App on our hosted sites. |
Sign Up Help TextTrial
| Step | Label | Help Text |
|---|
| 1 | Legal Business Name | Individuals without a registered business may enter their full name. |
| 1 | DUNS | For registered businesses in the USA and Canada, this is a required field. If you do not have a DUNS, please apply for one here. |
| 2 | Address | Enter the address of your place of business. If you do not have a business address, enter your home address. |
Smile CDR ConfigTrial
| Name | Description |
|---|
| Legal Company Name | This is used for legal documentation such as in Attestation documents and should not be changed without reason. |
Attestation CreationTrial
| Name | Tag | Help Text |
|---|
| Legal Company Name | {{Legal Company Name}} | This is the Company Name configured in Smile CDR. It refers to the Company owning the CDR. |
| Legal Vendor Name | {{Legal Vendor Name}} | This refers to the name of the Company registering an app. |
| App Developer Legal Name | {{App Developer Legal Name}} | This is the legal name of an individual representing the Vendor or acting as a sole proprietor. |
| App Name | {{App Name}} | This refers to the name of the App. |
| Vendor Position or Designation | {{Vendor Position or Designation}} | This refers to the job title of the individual or vendor representative. |
Current Software Versions --TRAIL--
The Current Software versions refer to the latest releases or iterations of Developer Portal and App Management Console. These versions often incorporate improvements, enchancements, and bug fixes to provide users with an updated and more efficient experience. Staying up-to date with current software versions is crucial for businesses and individulas to benefit from new features, security patches, and compatibility with the latest technologies.
| Name | Current Smile CDR Version | Current Appshere Version |
| ____ | _______ _____ ___ _______ | _______ ________ _______ |
| Developer Portal | Smile CDR v2023.11.R01 | Appshere v2023.11.1 |
| Admin Console | Smile CDR v2023.11.R01 | Appshere v2023.11.1 |
TroubleshootingTrial
Common Issues
| Module | Issue/Question | Solution |
|---|
| Developer Portal | When entering urls in the registration form, they must be in the following format http://websitename.domain. If the entered url does not follow this format the form will display an error message. | Will add an example to each error message in the future |
| Developer Portal and Admin Console | Logging out in an incognito chrome window | Enable cookies by going to the three dots in the top right hand corner of the browser > Settings > Cookies and other site data > select All cookies |
| Developer Portal and Admin Console | Trying to login to developer portal while already logged into admin console redirects user to unauthorized page in portal. The same occurs vice versa | Open an incognito window or a different browser to access the second application |
Usability Related Issues
| Module | Issue | Solution |
|---|
| Management Console | Transitions and states don’t fit customer workflow | Contact the product team |
| Management Console | Can’t transition multiple apps at once | Contact the product team |
| Management Console | Can’t find where to view registration info for an app | Click on the app row (anywhere except the three dot menu icon) |
| Management Console | Can’t find where to change the Attestation | Click the gear icon, top right corner |
| Management Console | Can’t find notes that app developers entered during registration | Login to the App Management Console, find the app in the registered apps table, click on the three dots icon for that row, select 'View Audit Log'. The note should appear in the audit log table here. (latest entries appear at the bottom) |
| Smile CDR (Config) | Image URLs for logos, hero images, etc. - images displaying incorrectly | Follow the instructions in Smile CDR config descriptions |
| Smile CDR (Config) | Image URLs for logos, hero images, etc. - images not displaying | URL entered correctly? Or contact the product team |
| Developer Portal | Developer loses password | Expected behaviour. Contact the product team. |
| Developer Portal | Developer can’t change email, first name or last name | Expected behaviour. Contact the product team. |
| Developer Portal | Updating contact info in the developer portal will not update contact info in app details for old apps | Investigation needed |
| Gallery | App not appearing in Gallery | Status must be set to “Live” in Console |
Glossary of TermsTrial
| Term | Definition |
|---|
| Attestation | To certify that you’ve met or exceeded the standards for meaningful use |
| D.U.N.S Number | A unique nine-digit number used as a standard business identifier. It is used to check the identity and legal entity status of an organization |
| FHIR (Fast Healthcare Interoperability Resource) | Provides an API and a set of data models for structuring and accessing medical data |
| Meaningful use | Ensuring that the I.T solution connects in a manner that provides for the safe electronic exchange of health information to improve the quality of care |
| SMART (Substitutable Medical Applications and Reusable Technologies) | Provides a standard for how EHR systems and their applications authenticate and integrate. By standardizing these processes, health care providers can utilize more apps, and developers can write apps for a wider audience |
| White Label App Gallery | Public facing web page of the App Gallery that is modifiable by customers |