The Smile Portal requires a "Custom Application Configuration" of the following form:
{
"externalApps": [
{
"label": "Custom Applications FHIR Endpoint",
"group": "Custom Applications",
"url": "https://external-host/some-external-application",
"description": "Description of the custom external application"
}
],
"bundledApps": [
{
"label": "Prior Auth",
"group": "Custom Applications",
"url": "https://host/prior-auth-fhir",
"appType": "PRIOR_AUTH"
},
{
"label": "Provider Access API",
"group": "Custom Applications",
"url": "https://host/provider-access-api",
"appType": "PROVIDER_ACCESS_API"
},
{
"label": "Terminology",
"group": "Custom Applications",
"url": "https://host/terminology-fhir",
"appType": "TERMINOLOGY"
},
{
"label": "Terminology Mapping",
"group": "Custom Applications",
"url": "https://host/terminology-mapping",
"appType": "TERMINOLOGY_MAPPING"
}
]
}
This is for manually configuring the applications that will appear inside Smile Portal.
When using appType in a bundledApps entry, each built-in application type has a corresponding admin role that must be granted to users who need access to that application. The following table lists the available bundled application types, their admin role names, and the FHIR resource permissions included with each role.
| Application Type | Admin Role | Included FHIR Permissions |
|---|---|---|
PATIENT_MANAGEMENT | PATIENT_MANAGEMENT_ADMIN | Read/Write Patient, Read/Write Consent |
PAYER_TO_PAYER | PAYER_TO_PAYER_ADMIN | Read Communication, Read Task |
PRIOR_AUTH | PRIOR_AUTH_ADMIN | Read Communication |
PROVIDER_ACCESS_API | PROVIDER_ACCESS_API_ADMIN | Read Communication |
TERMINOLOGY | TERMINOLOGY_ADMIN | Read/Write CodeSystem, Read/Write ConceptMap |
TERMINOLOGY_MAPPING | TERMINOLOGY_MAPPING_ADMIN | Read/Write Task |
INGESTION_DASHBOARD | INGESTION_DASHBOARD_ADMIN | View transaction log, View transaction log events |
TRANSACTION_LOG | TRANSACTION_LOG_ADMIN | View transaction log |
USER_MANAGEMENT | USER_MANAGEMENT_ADMIN | View/Create/Update users |
Admin roles are assigned to users via the User Management JSON Admin endpoint.
In addition to manually configured applications, Smile Portal automatically discovers certain CDR modules and makes them available in the portal. The following module types are auto-discovered:
| Module Type | Application Type | Portal URL | Required Role |
|---|---|---|---|
| FHIR REST Endpoint (all versions) | FHIR_ENDPOINT | Context path + /swagger-ui/ | FHIR_ENDPOINT_ADMIN |
| FHIRWeb Console | FHIR_WEB | Context path | FHIR_WEB_ADMIN |
| AppSphere (App Gallery) | APPSPHERE_CONSOLE, APPSPHERE_PORTAL, APPSPHERE_GALLERY | Context path + sub-path | AppSphere roles |
| MDM UI | MDMUI | Context path | MDMUI_ADMIN or MDMUI_DATA_STEWARD |
An OIDC client is also required as part of Smile Portal configuration. Client creation and configuration can be done as follows:
/ the end of the URL is important. e.g. https://try.smilecdr.com/smile-portal/e.g. online_access openid profile).You are about to leave the Smile Digital Health documentation and navigate to the Open Source HAPI-FHIR Documentation.