Most user-visible strings in Smile CDR can be replaced with your own text. This might be done in order to supply text in another language but it can also be done simply to customize the text being displayed.
To supply your own strings, a file called cdr-messages.properties should be placed in the classes/ directory within your Smile CDR installation.
The following table lists the strings that are supplied in the base localization definition file. Any of these strings can be overridden using the custom localization file.
| Key | Default Value |
|---|---|
| AbstractAccessDecisionManager.accessDenied | Access Denied. |
| AbstractSecurityInterceptor.authenticationNotFound | Request not authenticated. |
| AbstractUserDetailsAuthenticationProvider.badCredentials | Incorrect or invalid credentials supplied. |
| AbstractUserDetailsAuthenticationProvider.onlySupports | Only UsernamePasswordAuthenticationToken is supported. |
| FhirEndpointErrorTrapFilter.failure_description.401_bad_auth_header | HTTP 401 Not Authorized (Authorization header present but not accepted) |
| FhirEndpointErrorTrapFilter.failure_description.401_no_auth_header | HTTP 401 Not Authorized (no Authorization header present) |
| ProviderManager.providerNotFound | No Authorization Provider found. |
| audit_event_validation.wrong_module_type | Wrong module type, found {0}. |
| auditevent.ADMINWEB_LOGIN.name | Log into the Web Admin Console |
| auditevent.ADMINWEB_LOGOUT.name | Log out of the Web Admin Console |
| auditevent.CLUSTERMGR_ARCHIVE_MODULE.name | Archive module |
| auditevent.CLUSTERMGR_CREATE_MODULE.name | Create a new module |
| auditevent.CLUSTERMGR_REINSTATE_MODULE.name | Reinstate module |
| auditevent.CLUSTERMGR_SAVE_MODULE_CONFIG.name | Update/change/save module config |
| auditevent.CLUSTERMGR_START_MODULE.name | Start a stopped module |
| auditevent.CLUSTERMGR_STOP_MODULE.name | Stop a running module |
| auditevent.CONFIRM_2FA_TOTP_KEY.name | Confirm Two Factor TOTP Key |
| auditevent.CREATE_2FA_TOTP_KEY.name | Create Two Factor TOTP Key |
| auditevent.DISABLE_2FA_TOTP_KEY.name | Revoke Two Factor TOTP Key |
| auditevent.ENDPOINT_FHIRWEB_LOGIN.name | Log into FHIRWeb Console |
| auditevent.ENDPOINT_FHIRWEB_LOGOUT.name | Log out of FHIRWeb Console |
| auditevent.FHIR_ADD_TAGS.name | Add Tags to FHIR Resource |
| auditevent.FHIR_APPLY_CODESYSTEM_DELTA_ADD.name | Apply CodeSystem Delta: Add Concepts |
| auditevent.FHIR_APPLY_CODESYSTEM_DELTA_REMOVE.name | Apply CodeSystem Delta: Remove Concepts |
| auditevent.FHIR_CREATE.name | Create FHIR Resource |
| auditevent.FHIR_DELETE.name | Delete FHIR Resource |
| auditevent.FHIR_DELETE_TAGS.name | Delete Tags from FHIR Resource |
| auditevent.FHIR_DIFF.name | Diff Resource(s) ($diff) |
| auditevent.FHIR_EXPUNGE.name | Expunge |
| auditevent.FHIR_GET_PAGE.name | Fetch FHIR Result Page |
| auditevent.FHIR_GET_RESOURCE_COUNTS.name | FHIR Get Resource Counts ($get-resource-counts) |
| auditevent.FHIR_GET_TAGS.name | Fetch FHIR Resource Tags |
| auditevent.FHIR_GRAPHQL_REQUEST.name | GraphQL Request |
| auditevent.FHIR_HISTORY_INSTANCE.name | FHIR Resource Instance History |
| auditevent.FHIR_HISTORY_SYSTEM.name | FHIR System History |
| auditevent.FHIR_HISTORY_TYPE.name | FHIR Resource Type History |
| auditevent.FHIR_INITIATE_BULK_EXPORT.name | Initiate Bulk Export ($export) |
| auditevent.FHIR_MARK_ALL_RESOURCES_FOR_REINDEXING.name | Mark all resources for reindexing |
| auditevent.FHIR_META.name | Fetch FHIR Resource Metadata |
| auditevent.FHIR_META_ADD.name | Add to FHIR Resource Metadata |
| auditevent.FHIR_META_DELETE.name | Delete from FHIR Resource Metadata |
| auditevent.FHIR_OPERATION_UNCLASSIFIED.name | FHIR Extended Operation (unclassified) |
| auditevent.FHIR_OP_BINARY_ACCESS_READ.name | Binary Access Read ($binary-access-read) |
| auditevent.FHIR_OP_BINARY_ACCESS_WRITE.name | Binary Access Write ($binary-access-write) |
| auditevent.FHIR_OP_COMPOSITION_DOCUMENT.name | Generate Document from Composition ($document) |
| auditevent.FHIR_OP_COMPOSITION_LIVEBUNDLE.name | Request LiveBundle for a Rule and Target Id ($livebundle) |
| auditevent.FHIR_OP_COMPOSITION_LIVEBUNDLE_SUBSCRIBER_GROUP_ADD.name | Add a target to a LiveBundle subscriber group ($livebundle-group-add) |
| auditevent.FHIR_OP_COMPOSITION_LIVEBUNDLE_SUBSCRIBER_GROUP_DELETE.name | Remove a target from a LiveBundle subscriber group ($livebundle-group-delete) |
| auditevent.FHIR_OP_COMPOSITION_LIVEBUNDLE_WATCHLIST.name | Request LiveBundle Rule Watchlist ($livebundle-watchlist) |
| auditevent.FHIR_OP_COMPOSITION_LIVEBUNDLE_WATCHLIST_ADD.name | Add a target to a LiveBundle Rule Watchlist ($livebundle-watchlist-add) |
| auditevent.FHIR_OP_COMPOSITION_LIVEBUNDLE_WATCHLIST_DELETE.name | Remove a target from a LiveBundle Rule Watchlist ($livebundle-watchlist-delete) |
| auditevent.FHIR_OP_EMPI_CLEAR.name | EMPI Clear links(<code>$empi-clear</code>) |
| auditevent.FHIR_OP_EMPI_DUPLICATE_PERSONS.name | FHIR EMPI Duplicate Persons (<code>$empi-duplicate-persons</code>) |
| auditevent.FHIR_OP_EMPI_MERGE_PERSONS.name | FHIR EMPI Merge Persons ($empi-merge-persons) |
| auditevent.FHIR_OP_EMPI_QUERY_LINKS.name | FHIR EMPI Query Links (<code>$empi-query-links</code>) |
| auditevent.FHIR_OP_EMPI_SUBMIT.name | EMPI Batch Submission For Processing(<code>$empi-submit</code>) |
| auditevent.FHIR_OP_EMPI_UPDATE_LINK.name | FHIR EMPI Update Link (<code>$empi-update-link</code>) |
| auditevent.FHIR_OP_ENCOUNTER_INSTANCE_EVERYTHING.name | Search entire Encounter record ($everything) |
| auditevent.FHIR_OP_PATIENT_INSTANCE_EVERYTHING.name | Search entire Patient record ($everything) |
| auditevent.FHIR_OP_PATIENT_MATCH.name | FHIR Patient Match ($match) |
| auditevent.FHIR_PARTITION_MANAGEMENT_CREATE_PARTITION.name | Partition Management: Add Partition |
| auditevent.FHIR_PARTITION_MANAGEMENT_DELETE_PARTITION.name | Partition Management: Delete Partition |
| auditevent.FHIR_PARTITION_MANAGEMENT_READ_PARTITION.name | Partition Management: Read Partition |
| auditevent.FHIR_PARTITION_MANAGEMENT_UPDATE_PARTITION.name | Partition Management: Update Partition |
| auditevent.FHIR_PATCH.name | FHIR Resource Patch |
| auditevent.FHIR_PERFORM_REINDEXING_PASS.name | Perform FHIR reindexing pass |
| auditevent.FHIR_PROCESS_MESSAGE.name | FHIR Process Message |
| auditevent.FHIR_READ.name | FHIR Resource Instance Read |
| auditevent.FHIR_SEARCH_SYSTEM.name | FHIR Resource Search (System-wide) |
| auditevent.FHIR_SEARCH_TYPE.name | FHIR Resource Search (Type-specific) |
| auditevent.FHIR_SUGGEST_KEYWORDS.name | FHIR Suggest Keywords ($suggest-keywords) |
| auditevent.FHIR_TRANSACTION.name | FHIR Transaction |
| auditevent.FHIR_TRIGGER_SUBSCRIPTION.name | Manually Trigger Subscription |
| auditevent.FHIR_UPDATE.name | Update FHIR Resource |
| auditevent.FHIR_UPLOAD_EXTERNAL_CODE_SYSTEM.name | Upload External Terminology Code System |
| auditevent.FHIR_VREAD.name | FHIR Resource Instance Read (Version-specific) |
| auditevent.OAUTH2_CLIENT_CHANGE_OWN_SECRET.name | Client Changed Own Secret |
| auditevent.OAUTH2_CREATE_CLIENT.name | Create OpenID Connect Client |
| auditevent.OAUTH2_CREATE_SERVER.name | Create OpenID Connect Server |
| auditevent.OAUTH2_EDIT_CLIENT.name | Edit OpenID Connect Client |
| auditevent.OAUTH2_EDIT_SERVER.name | Edit OpenID Connect Server |
| auditevent.SECURITY_OUT_SMART_APPROVE_SCOPE.name | User approve SMART Client Scope |
| auditevent.SECURITY_OUT_SMART_LOGIN.name | Sign into OpenID Connect Server |
| auditevent.SECURITY_OUT_SMART_LOGOUT.name | Sign out of OpenID Connect Server |
| auditevent.SECURITY_OUT_SMART_REVOKE_SCOPE.name | User revoke SMART Client Scope |
| auditevent.SECURITY_OUT_SMART_REVOKE_TOKEN.name | Revoke an OpenID Connect Token |
| auditevent.USERMGR_CREATE_USER.name | Create a new user |
| auditevent.USERMGR_UPDATE_OWN_PASSWORD.name | Update user's own password |
| auditevent.USERMGR_UPDATE_PASSWORD.name | Update another user's password |
| auditevent.USERMGR_UPDATE_USER.name | Update an existing user |
| ca.cdr.admin.json.controller.FhirIndexingController.invalidSaveStatus | Cannot save search parameter with status: {0}. |
| ca.cdr.admin.web.controller.ConfigModulesController.cannotBeArchivedDueToDependencies | Module: {0} cannot be archived as it affects Module(s): {1} |
| ca.cdr.admin.web.controller.ConfigModulesController.cannotBeReinstatedDueToDependency | "Module: {0} cannot be reinstated as it depends on archived Module(s): {1} |
| ca.cdr.admin.web.controller.ConfigModulesController.moduleSuccessfullySaved | Module {0} successfully saved |
| ca.cdr.admin.web.controller.ConfigUserManagerController.2fa_confirmed | Two Factor Authentication has been enabled for your account. |
| ca.cdr.admin.web.controller.ConfigUserManagerController.2fa_created | Two Factor code has been created. You must verify this in order to enable Two Factor Authentication. |
| ca.cdr.admin.web.controller.ConfigUserManagerController.2fa_disabled | Two Factor Authentication has been disabled for your account. |
| ca.cdr.api.web.JettyHealthCheckFilterHttpResponses.healthy | Listening: {0} transactions since started. |
| ca.cdr.api.web.JettyHealthCheckFilterHttpResponses.lastResponse5xx | Last {0} responses have failed with HTTP {1} {2}. |
| ca.cdr.api.web.JettyHealthCheckFilterHttpResponses.noTransactions | Listening: No transactions since started. |
| ca.cdr.clustermgr.entity.NodeHealthChecks.healthy | Node is happy: {0} health checks passed. |
| ca.cdr.clustermgr.entity.NodeHealthChecks.unhealthy | Node is unhappy: {0} health checks failed ({1} health checks passed). |
| ca.cdr.clustermgr.metric.BaseDbConnectionPoolMetric.healthCheck_healthy | Acquired connection in {0}ms. |
| ca.cdr.clustermgr.metric.BaseDbConnectionPoolMetric.healthCheck_unhealthy | Failed to acquire connection in {0}ms: {1}. |
| ca.cdr.clustermgr.svc.impl.ModuleConfigSvcImpl.archivingFailed_DependentModule | Can not archive module {0} because the module {1} depends on it - Archive that module first |
| ca.cdr.clustermgr.svc.impl.ModuleConfigSvcImpl.archivingFailed_StillRunning | Can not archive module {0} because it is still running |
| ca.cdr.clustermgr.svc.impl.StatsHeartbeatSvcImpl.last_heartbeat_failed | Most recent heartbeat failed: {0}. |
| ca.cdr.clustermgr.svc.impl.StatsHeartbeatSvcImpl.last_heartbeat_succeeded | Heartbeat succeeded in {0}ms. |
| ca.cdr.clustermgr.svc.impl.StatsHeartbeatSvcImpl.too_long_since_last_heartbeat | Last successful heartbeat was {0} seconds ago. |
| ca.cdr.endpoint.fhir.interceptor.CdrRequestValidatingInterceptor.unknown_profiles | One or more StructureDefinitions declared in Resource.meta.profile cannot be found in the repository. Unknown profile(s): {0}. |
| ca.cdr.endpoint.fhir.interceptor.CdrRequestValidatingInterceptor.validation_failed_with_error | Validation Failed with Error |
| ca.cdr.endpoint.fhir.interceptor.CdrRequestValidatingInterceptor.validation_failed_with_warning | Validation Failed with Warning |
| ca.cdr.endpoint.fhir.interceptor.CdrRequestValidatingInterceptor.validation_passed | Validation Passed |
| ca.cdr.endpoint.fhir.web.BaseFhirEndpointServlet.invalid_tenant_id | Invalid tenant ID: {0}. |
| ca.cdr.endpoint.fhir.web.BaseFhirEndpointServlet.unknownFhirOperationErrorSuppressed | Unknown FHIR operation: This server does not know how to handle this request. |
| ca.cdr.endpoint.fhir.web.BaseFhirEndpointServlet.unknownResourceTypeErrorSuppressed | Unknown resource type |
| ca.cdr.endpoint.fhirgw.server.ResourceProviderSearchType.invalidSearchParameter | Unknown search parameter: {0} |
| ca.cdr.endpoint.fhirweb.controller.FhirwebController.forbidden_operation_exception | You lack adequate permissions to perform the requested operation. Please review <a href="https://smilecdr.com/docs/security/roles_and_permissions.html" target="_blank">Roles and Permissions</a>, and contact your Smile CDR administrator. |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7FeedToStorageMapper.notProcessingUnknownMessageType | Unknown HL7v2 Message Type (not going to process): {0} |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.admitSourceRequiresBothCodeAndSystem | Both a code in PV1-14.1 and a system in PV1-14.3 must be populated for PV1-14: {0} |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.duplicateObservationIdentifersCausedByDuplicateCodes | More than one Observation resulting from this message has the same generated identifier. This is likely due to duplicate OBX-3 observation codes in the source message. Duplicate ID: {0} |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.encounterMustHaveIdentifierWithTypeVnAsFirstRep | Encounter must have at least one business identifier, and the first business identifier must have a type code (PV1-19-5) of 'VN' as well as values in PV1-19-1 and PV1-19-4 |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.inputFieldInvalidLength | Field {0} has a length of {1} - Must be >= {2} and <= {3} |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.invalidDateProvided | Invalid date provided in {0}, should be {1}: {2} |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.invalidDiagnosisPriority | Invalid diagnosis priority provided in {0}, should be an integer: {1} |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.invalidGiveRateAmount | RXE-23 (Give Rate Amount) must be a non-negative quantity, range, or ratio. Invalid value provided: {0} |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.invalidNmValue | Invalid value "{0}" for NM datatype |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.invalidPath | {0} must provide a valid FHIR path: {1} |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.missingCombo | {0} and {1} must both be populated |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.multipleSpecimenGroups | {0} includes multiple SPECIMEN groups; Observation.specimen will not be populated |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.obrMustHaveIdentifier | Unable to process result - No suitable identifier found in OBR segment |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.obrMustHaveStatus | Result status must be present and have a valid value, found: {0} |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.obrQuantityTimingInvalidValue | Invalid Quantity Timing priority value: {0} |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.obxInvalidStructuredNumeric | Invalid component combination for structured numeric: {0} |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.obxMustHaveStatus | Observation status must be present and have a valid value, found: {0} |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.obxValueType | Invalid value type "{0}" for OBX segment |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.orcMustHaveIdentifier | Segment ORC must have a valid identifier |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.patientHasNoIdentifier | No valid identifier found for Patient in segment PID, unable to process Patient |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.patientMustHaveIdentifierWithTypeMrAsFirstRep | Patient must have at least one business identifier, and the first business identifier must have a type code (PID-3-5) of 'MR' as well as values in PID-3-1 and PID-3-4 |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.pharmacyAdministrationHasNoAdminCode | Pharmacy administration has no administered code |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.pharmacyAdministrationHasNoAdminCodeSystem | Pharmacy administration has no administered code system |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.pharmacyAdministrationHasNoCompletionStatus | Pharmacy administration has no valid completion status |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.pharmacyAdministrationHasNoComponentCode | Pharmacy administration has no component code |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.pharmacyAdministrationHasNoComponentCodeSystem | Pharmacy administration has no component code system |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.pharmacyAdministrationHasNoSubId | Pharmacy administration has no sub-ID |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.pharmacyOrderHasInvalidStatus | Pharmacy order has missing/invalid status: "{0}" |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.pharmacyOrderHasNoComponentCode | Pharmacy order has no component code |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.pharmacyOrderHasNoComponentCodeSystem | Pharmacy order has no component code system |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.pharmacyOrderHasNoGiveCode | Pharmacy order has no give code |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.pharmacyOrderHasNoGiveCodeSystem | Pharmacy order has no give code |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.pharmacyOrderHasNoPlacerOrderNumber | Pharmacy order has no valid identifier |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.unknownDiagnosisCodingMethod | Unknown diagnosis coding method provided for {0}: {1} |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.unknownObservationCode | Unknown observation code provided in {0}: {1} |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.zxtInvalidResourceType | {0} must provide a valid FHIR resource type (case-sensitive): {1} |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.zxtInvalidValueBoolean | Invalid boolean value "{0}" for {1}. Acceptable values are (case-insensitive): {2} |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.zxtInvalidValueType | Invalid value type "{0}" for {1}. Acceptable values are (case-sensitive): {2} |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.zxtInvalidValueTypeForPath | Invalid value type "{0}" for path: {1} |
| ca.cdr.endpoint.hl7v2.in.converter.Hl7V2InboundMapperImpl.zxtMissingValue | {0} must be populated |
| ca.cdr.endpoint.hl7v2.in.listener.MllpListener.healthy | Listening: {0} transactions since started. |
| ca.cdr.endpoint.hl7v2.in.listener.MllpListener.noTransactions | Listening: No transactions since started. |
| ca.cdr.endpoint.hl7v2.out.svc.impl.Hl7V2OutboundMapperSvcImpl.didNotFindPersistedMessageHeader | Did not find a MessageHeader resource with target: {0} |
| ca.cdr.pers.svc.impl.BaseSearchParameterSyncSvc.analyze_failed | Search Parameter analysis failed with error: {0}. |
| ca.cdr.pers.svc.impl.BaseSearchParameterSyncSvc.analyze_healthy | Analyzed {0} keys in {1}ms. |
| ca.cdr.pers.svc.impl.BaseSearchParameterSyncSvc.sync_failed | Search Parameter sync failed with error: {0}. |
| ca.cdr.pers.svc.impl.BaseSearchParameterSyncSvc.sync_healthy | Completed in {0}ms. |
| ca.cdr.pers.svc.impl.ClusterNodeIndexingSvcImpl.healthy | Indexed {0} resources in {1}ms ({2} pending, {3} since startup). |
| ca.cdr.pers.svc.impl.ClusterNodeIndexingSvcImpl.notRunSince | Indexer has not run since {0}. |
| ca.cdr.pers.svc.impl.ClusterNodeIndexingSvcImpl.notRunning | Indexer has never run. |
| ca.cdr.pers.svc.impl.ClusterNodeIndexingSvcImpl.passFailed | Index pass failed with error: {0}. |
| ca.cdr.security.out.smart.security.LogoutEndpointSecurityFilter.noAccessToken | No access token found in request |
| ca.cdr.security.out.smart.security.LogoutEndpointSecurityFilter.noSessionCookie | No session cookie found in request |
| ca.uhn.fhir.context.FhirContext.noStructures | Could not find any HAPI-FHIR structure JARs on the classpath. Note that as of HAPI-FHIR v0.8, a separate FHIR strcture JAR must be added to your classpath (or project pom.xml if you are using Maven) |
| ca.uhn.fhir.context.FhirContext.noStructuresForSpecifiedVersion | Could not find the HAPI-FHIR structure JAR on the classpath for version {0}. Note that as of HAPI-FHIR v0.8, a separate FHIR strcture JAR must be added to your classpath (or project pom.xml if you are using Maven) |
| ca.uhn.fhir.context.FhirContext.unknownResourceName | Unknown resource name "{0}" (this name is not known in FHIR version "{1}") |
| ca.uhn.fhir.context.RuntimeResourceDefinition.nonInstantiableType | Resource type "{0}" can not be instantiated. Check that this class has a no-argument constructor, and that it is static if it is a nested type. Error is: {1} |
| ca.uhn.fhir.context.RuntimeResourceDefinition.typeWrongVersion | This context is for FHIR version "{0}" but the class "{1}" is for version "{2}" |
| ca.uhn.fhir.jpa.binstore.BinaryAccessProvider.noAttachmentDataPresent | The resource with ID {0} has no data at path: {1} |
| ca.uhn.fhir.jpa.binstore.BinaryAccessProvider.unknownBlobId | Can not find the requested binary content. It may have been deleted. |
| ca.uhn.fhir.jpa.binstore.BinaryAccessProvider.unknownPath | Unable to find content in resource of type {0} at path: {1} |
| ca.uhn.fhir.jpa.binstore.BinaryAccessProvider.unknownType | Content in resource of type {0} at path {1} is not appropriate for binary storage: {2} |
| ca.uhn.fhir.jpa.bulk.svc.BulkDataExportSvcImpl.onlyBinarySelected | Binary resources may not be exported with bulk export |
| ca.uhn.fhir.jpa.bulk.svc.BulkDataExportSvcImpl.unknownResourceType | Unknown or unsupported resource type: {0} |
| ca.uhn.fhir.jpa.config.HapiFhirHibernateJpaDialect.forcedIdConstraintFailure | The operation has failed with a client-assigned ID constraint failure. This typically means that multiple client threads are trying to create a new resource with the same client-assigned ID at the same time, and this thread was chosen to be rejected. |
| ca.uhn.fhir.jpa.config.HapiFhirHibernateJpaDialect.resourceIndexedCompositeStringUniqueConstraintFailure | The operation has failed with a unique index constraint failure. This probably means that the operation was trying to create/update a resource that would have resulted in a duplicate value for a unique index. |
| ca.uhn.fhir.jpa.config.HapiFhirHibernateJpaDialect.resourceVersionConstraintFailure | The operation has failed with a version constraint failure. This generally means that two clients/threads were trying to update the same resource at the same time, and this request was chosen as the failing request. |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirDao.externalizedBinaryStorageExtensionFoundInRequestBody | Illegal extension found in request payload - URL "{0}" and value "{1}" |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirDao.incomingNoopInTransaction | Transaction contains resource with operation NOOP. This is only valid as a response operation, not in a request |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirDao.invalidMatchUrlInvalidResourceType | Invalid match URL "{0}" - Unknown resource type: "{1}" |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirDao.invalidMatchUrlMultipleMatches | Invalid match URL "{0}" - Multiple resources match this search |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirDao.invalidMatchUrlNoMatches | Invalid match URL "{0}" - No resources match this search |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirDao.transactionOperationFailedNoId | Failed to {0} resource in transaction because no ID was provided |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirDao.transactionOperationFailedUnknownId | Failed to {0} resource in transaction because no resource could be found with ID {1} |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirDao.transactionOperationWithMultipleMatchFailure | Failed to {0} resource with match URL "{1}" because this search matched {2} resources |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirDao.uniqueIndexConflictFailure | Can not create resource of type {0} as it would create a duplicate index matching query: {1} (existing index belongs to {2}) |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirResourceDao.cantValidateWithNoResource | No resource supplied for $validate operation (resource is required unless mode is "delete") |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirResourceDao.deleteBlockedBecauseDisabled | Resource deletion is not permitted on this server |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirResourceDao.duplicateCreateForcedId | Can not create entity with ID[{0}], a resource with this ID already exists |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirResourceDao.failedToCreateWithClientAssignedId | Can not create resource with ID[{0}], ID must not be supplied on a create (POST) operation |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirResourceDao.failedToCreateWithClientAssignedIdNotAllowed | No resource exists on this server resource with ID[{0}], and client-assigned IDs are not enabled. |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirResourceDao.failedToCreateWithClientAssignedNumericId | Can not create resource with ID[{0}], no resource with this ID exists and clients may only assign IDs which contain at least one non-numeric character |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirResourceDao.failedToCreateWithInvalidId | Can not process entity with ID[{0}], this is not a valid FHIR ID |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirResourceDao.incorrectResourceType | Incorrect resource type detected for endpoint, found {0} but expected {1} |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirResourceDao.invalidParameterChain | Invalid parameter chain: {0} |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirResourceDao.invalidSearchParameter | Unknown search parameter "{0}" for resource type "{1}". Valid search parameters for this search are: {2} |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirResourceDao.invalidSortParameter | Unknown _sort parameter value "{0}" for resource type "{1}" (Note: sort parameters values must use a valid Search Parameter). Valid values for this search are: {2} |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirResourceDao.invalidVersion | Version "{0}" is not valid for resource {1} |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirResourceDao.missingBody | No body was supplied in request |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirResourceDao.multipleParamsWithSameNameOneIsMissingTrue | This server does not know how to handle multiple "{0}" parameters where one has a value of :missing=true |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirResourceDao.successfulCreate | Successfully created resource "{0}" in {1}ms |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirResourceDao.successfulDeletes | Successfully deleted {0} resource(s) in {1}ms |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirResourceDao.successfulUpdate | Successfully updated resource "{0}" in {1}ms |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirResourceDao.unableToDeleteNotFound | Unable to find resource matching URL "{0}". Deletion failed. |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirSystemDao.transactionContainsMultipleWithDuplicateId | Transaction bundle contains multiple resources with ID: {0} |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirSystemDao.transactionEntryHasInvalidVerb | Transaction bundle entry has missing or invalid HTTP Verb specified in Bundle.entry({1}).request.method. Found value: "{0}" |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirSystemDao.transactionInvalidUrl | Unable to perform {0}, URL provided is invalid: {1} |
| ca.uhn.fhir.jpa.dao.BaseHapiFhirSystemDao.transactionMissingUrl | Unable to perform {0}, no URL provided. |
| ca.uhn.fhir.jpa.dao.HistoryBuilder.noSystemOrTypeHistoryForPartitionAwareServer | Type- and Server- level history operation not supported across partitions on partitioned server |
| ca.uhn.fhir.jpa.dao.LegacySearchBuilder.invalidCodeMissingCode | Invalid token specified for parameter {0} - No code specified: {1}|{2} |
| ca.uhn.fhir.jpa.dao.LegacySearchBuilder.invalidCodeMissingSystem | Invalid token specified for parameter {0} - No system specified: {1}|{2} |
| ca.uhn.fhir.jpa.dao.LegacySearchBuilder.invalidNumberPrefix | Unable to handle number prefix "{0}" for value: {1} |
| ca.uhn.fhir.jpa.dao.LegacySearchBuilder.invalidQuantityPrefix | Unable to handle quantity prefix "{0}" for value: {1} |
| ca.uhn.fhir.jpa.dao.LegacySearchBuilder.sourceParamDisabled | The _source parameter is disabled on this server |
| ca.uhn.fhir.jpa.dao.TransactionProcessor.fhirPatchShouldNotUseBinaryResource | Binary PATCH detected with FHIR content type. FHIR Patch should use Parameters resource. |
| ca.uhn.fhir.jpa.dao.TransactionProcessor.missingMandatoryResource | Missing required resource in Bundle.entry[{1}].resource for operation {0} |
| ca.uhn.fhir.jpa.dao.TransactionProcessor.missingPatchBody | Unable to determine PATCH body from request |
| ca.uhn.fhir.jpa.dao.dstu3.FhirResourceDaoConceptMapDstu3.matchesFound | Matches found! |
| ca.uhn.fhir.jpa.dao.dstu3.FhirResourceDaoConceptMapDstu3.noMatchesFound | No matches found! |
| ca.uhn.fhir.jpa.dao.index.IdHelperService.nonUniqueForcedId | Non-unique ID specified, can not process request |
| ca.uhn.fhir.jpa.dao.predicate.PredicateBuilderReference.invalidResourceType | Invalid/unsupported resource type: "{0}" |
| ca.uhn.fhir.jpa.dao.predicate.PredicateBuilderReference.invalidTargetTypeForChain | Resource type "{0}" is not a valid target type for reference search parameter: {1} |
| ca.uhn.fhir.jpa.dao.predicate.PredicateBuilderToken.textModifierDisabledForSearchParam | The :text modifier is disabled for this search parameter |
| ca.uhn.fhir.jpa.dao.predicate.PredicateBuilderToken.textModifierDisabledForServer | The :text modifier is disabled on this server |
| ca.uhn.fhir.jpa.dao.r4.FhirResourceDaoConceptMapR4.matchesFound | Matches found! |
| ca.uhn.fhir.jpa.dao.r4.FhirResourceDaoConceptMapR4.noMatchesFound | No matches found! |
| ca.uhn.fhir.jpa.dao.r4.FhirResourceDaoSearchParameterR4.invalidSearchParamExpression | The expression "{0}" can not be evaluated and may be invalid: {1} |
| ca.uhn.fhir.jpa.dao.r5.FhirResourceDaoConceptMapR5.matchesFound | Matches found! |
| ca.uhn.fhir.jpa.dao.r5.FhirResourceDaoConceptMapR5.noMatchesFound | No matches found! |
| ca.uhn.fhir.jpa.graphql.JpaStorageServices.invalidGraphqlArgument | Unknown GraphQL argument "{0}". Value GraphQL argument for this type are: {1} |
| ca.uhn.fhir.jpa.interceptor.CascadingDeleteInterceptor.noParam | Note that cascading deletes are not active for this request. You can enable cascading deletes by using the "_cascade=delete" URL parameter. |
| ca.uhn.fhir.jpa.interceptor.CascadingDeleteInterceptor.successMsg | Cascaded delete to {0} resources: {1} |
| ca.uhn.fhir.jpa.partition.PartitionLookupSvcImpl.cantCreateDuplicatePartitionName | Partition name "{0}" is already defined |
| ca.uhn.fhir.jpa.partition.PartitionLookupSvcImpl.cantCreatePartition0 | Can not create a partition with ID 0 (this is a reserved value) |
| ca.uhn.fhir.jpa.partition.PartitionLookupSvcImpl.cantDeleteDefaultPartition | Can not delete default partition |
| ca.uhn.fhir.jpa.partition.PartitionLookupSvcImpl.cantRenameDefaultPartition | Can not rename default partition |
| ca.uhn.fhir.jpa.partition.PartitionLookupSvcImpl.invalidName | Partition name "{0}" is not valid |
| ca.uhn.fhir.jpa.partition.PartitionLookupSvcImpl.missingPartitionIdOrName | Partition must have an ID and a Name |
| ca.uhn.fhir.jpa.partition.PartitionLookupSvcImpl.noIdSupplied | No Partition ID supplied |
| ca.uhn.fhir.jpa.partition.PartitionLookupSvcImpl.unknownPartitionId | No partition exists with ID {0} |
| ca.uhn.fhir.jpa.partition.RequestPartitionHelperSvc.blacklistedResourceTypeForPartitioning | Resource type {0} can not be partitioned |
| ca.uhn.fhir.jpa.partition.RequestPartitionHelperSvc.unknownPartitionId | Unknown partition ID: {0} |
| ca.uhn.fhir.jpa.partition.RequestPartitionHelperSvc.unknownPartitionName | Unknown partition name: {0} |
| ca.uhn.fhir.jpa.patch.FhirPatch.invalidInsertIndex | Invalid insert index {0} for path {1} - Only have {2} existing entries |
| ca.uhn.fhir.jpa.patch.FhirPatch.invalidMoveDestinationIndex | Invalid move destination index {0} for path {1} - Only have {2} existing entries |
| ca.uhn.fhir.jpa.patch.FhirPatch.invalidMoveSourceIndex | Invalid move source index {0} for path {1} - Only have {2} existing entries |
| ca.uhn.fhir.jpa.patch.JsonPatchUtils.failedToApplyPatch | Failed to apply JSON patch to {0}: {1} |
| ca.uhn.fhir.jpa.provider.BaseJpaProvider.cantCombintAtAndSince | Unable to combine _at and _since parameters for history operation |
| ca.uhn.fhir.jpa.provider.DiffProvider.cantDiffDifferentTypes | Unable to diff two resources of different types |
| ca.uhn.fhir.jpa.searchparam.extractor.BaseSearchParamExtractor.externalReferenceNotAllowed | Resource contains external reference to URL "{0}" but this server is not configured to allow external references |
| ca.uhn.fhir.jpa.searchparam.extractor.BaseSearchParamExtractor.failedToExtractPaths | Failed to extract values from resource using FHIRPath "{0}": {1} |
| ca.uhn.fhir.jpa.term.BaseTermReadSvcImpl.cannotCreateDuplicateCodeSystemUrl | Can not create multiple CodeSystem resources with CodeSystem.url "{0}", already have one with resource ID: {1} |
| ca.uhn.fhir.jpa.term.BaseTermReadSvcImpl.cannotCreateDuplicateCodeSystemUrlAndVersion | Can not create multiple CodeSystem resources with CodeSystem.url "{0}" and CodeSystem.version "{1}", already have one with resource ID: {2} |
| ca.uhn.fhir.jpa.term.BaseTermReadSvcImpl.cannotCreateDuplicateConceptMapUrl | Can not create multiple ConceptMap resources with ConceptMap.url "{0}", already have one with resource ID: {1} |
| ca.uhn.fhir.jpa.term.BaseTermReadSvcImpl.cannotCreateDuplicateConceptMapUrlAndVersion | Can not create multiple ConceptMap resources with ConceptMap.url "{0}" and ConceptMap.version "{1}", already have one with resource ID: {2} |
| ca.uhn.fhir.jpa.term.BaseTermReadSvcImpl.cannotCreateDuplicateValueSetUrl | Can not create multiple ValueSet resources with ValueSet.url "{0}", already have one with resource ID: {1} |
| ca.uhn.fhir.jpa.term.BaseTermReadSvcImpl.cannotCreateDuplicateValueSetUrlAndVersion | Can not create multiple ValueSet resources with ValueSet.url "{0}" and ValueSet.version "{1}", already have one with resource ID: {2} |
| ca.uhn.fhir.jpa.term.BaseTermReadSvcImpl.cannotUpdateUrlOrVersionForValueSetResource | Cannot update URL or version for ValueSet resource. Existing ValueSet resource with resource ID {0} found with ValueSet.url "{1}" and ValueSet.version "{2}" |
| ca.uhn.fhir.jpa.term.BaseTermReadSvcImpl.expansionRefersToUnknownCs | Unknown CodeSystem URI "{0}" referenced from ValueSet |
| ca.uhn.fhir.jpa.term.BaseTermReadSvcImpl.expansionTooLarge | Expansion of ValueSet produced too many codes (maximum {0}) - Operation aborted! |
| ca.uhn.fhir.jpa.term.BaseTermReadSvcImpl.valueSetNotYetExpanded | ValueSet "{0}" has not yet been pre-expanded. Performing in-memory expansion without parameters. Current status: {1} | {2} |
| ca.uhn.fhir.jpa.term.BaseTermReadSvcImpl.valueSetNotYetExpanded_OffsetNotAllowed | ValueSet expansion can not combine "offset" with "ValueSet.compose.exclude" unless the ValueSet has been pre-expanded. ValueSet "{0}" must be pre-expanded for this operation to work. |
| ca.uhn.fhir.parser.ParserState.wrongResourceTypeFound | Incorrect resource type found, expected "{0}" but found "{1}" |
| ca.uhn.fhir.rest.api.PatchTypeEnum.invalidPatchContentType | Invalid Content-Type for PATCH operation: {0} |
| ca.uhn.fhir.rest.api.PatchTypeEnum.missingPatchContentType | Missing or invalid content type for PATCH operation |
| ca.uhn.fhir.rest.client.impl.BaseClient.failedToParseResponse | Failed to parse response from server when performing {0} to URL {1} - {2} |
| ca.uhn.fhir.rest.client.impl.BaseClient.ioExceptionDuringOperation | Encountered IOException when performing {0} to URL {1} - {2} |
| ca.uhn.fhir.rest.client.impl.GenericClient.cannotDetermineResourceTypeFromUri | Unable to determine the resource type from the given URI: {0} |
| ca.uhn.fhir.rest.client.impl.GenericClient.cantDetermineRequestType | Unable to determing encoding of request (body does not appear to be valid XML or JSON) |
| ca.uhn.fhir.rest.client.impl.GenericClient.incompleteUriForRead | The given URI is not an absolute URL and is not usable for this operation: {0} |
| ca.uhn.fhir.rest.client.impl.GenericClient.noPagingLinkFoundInBundle | Can not perform paging operation because no link was found in Bundle with relation "{0}" |
| ca.uhn.fhir.rest.client.impl.GenericClient.noVersionIdForVread | No version specified in URL for 'vread' operation: {0} |
| ca.uhn.fhir.rest.client.impl.RestfulClientFactory.failedToRetrieveConformance | Failed to retrieve the server metadata statement during client initialization. URL used was {0} |
| ca.uhn.fhir.rest.client.impl.RestfulClientFactory.wrongVersionInConformance | The server at base URL "{0}" returned a conformance statement indicating that it supports FHIR version "{1}" which corresponds to {2}, but this client is configured to use {3} (via the FhirContext). |
| ca.uhn.fhir.rest.client.method.SearchMethodBinding.idNullForCompartmentSearch | ID parameter can not be null or empty for compartment search |
| ca.uhn.fhir.rest.param.BaseParam.chainNotSupported | Invalid search parameter "{0}". Parameter contains a chain ({1}) and chains are not supported for this parameter (chaining is only allowed on reference parameters) |
| ca.uhn.fhir.rest.server.RestfulServer.getPagesNonHttpGet | Requests for _getpages must use HTTP GET |
| ca.uhn.fhir.rest.server.RestfulServer.rootRequest | This is the base URL of FHIR server. Unable to handle this request, as it does not contain a resource type or operation name. |
| ca.uhn.fhir.rest.server.RestfulServer.rootRequest.multitenant | This is the base URL of a multitenant FHIR server. Unable to handle this request, as it does not contain a tenant ID. |
| ca.uhn.fhir.rest.server.RestfulServer.unknownMethod | Invalid request: The FHIR endpoint on this server does not know how to handle {0} operation[{1}] with parameters [{2}] |
| ca.uhn.fhir.rest.server.interceptor.auth.RuleImplOp.invalidRequestBundleTypeForTransaction | Invalid request Bundle.type value for transaction: {0} |
| ca.uhn.fhir.rest.server.interceptor.partition.RequestTenantPartitionInterceptor.unknownTenantName | Unknown tenant: {0} |
| ca.uhn.fhir.rest.server.method.BaseOutcomeReturningMethodBindingWithResourceParam.idInBodyForCreate | Can not create resource with ID "{0}", an ID element must not be supplied in the resource body on a create (POST) operation |
| ca.uhn.fhir.rest.server.method.BaseOutcomeReturningMethodBindingWithResourceParam.idInUrlForCreate | Can not create resource with ID "{0}", ID must not be supplied on a create (POST) operation (use an HTTP PUT / update operation if you wish to supply an ID) |
| ca.uhn.fhir.rest.server.method.BaseOutcomeReturningMethodBindingWithResourceParam.incorrectIdForUpdate | Can not update resource, resource body must contain an ID element which matches the request URL for update (PUT) operation - Resource body ID of "{0}" does not match URL ID of "{1}" |
| ca.uhn.fhir.rest.server.method.BaseOutcomeReturningMethodBindingWithResourceParam.noIdInBodyForUpdate | Can not update resource, resource body must contain an ID element for update (PUT) operation |
| ca.uhn.fhir.rest.server.method.BaseOutcomeReturningMethodBindingWithResourceParam.noIdInUrlForUpdate | Can not update resource, request URL must contain an ID element for update (PUT) operation (it must be of the form [base]/[resource type]/[id]) |
| ca.uhn.fhir.rest.server.method.IncludeParameter.invalidIncludeNameInRequest | Invalid {2} parameter value: "{0}". Valid values are: {1} |
| ca.uhn.fhir.rest.server.method.IncludeParameter.orIncludeInRequest | 'OR' query parameters (values containing ',') are not supported in _include parameters |
| ca.uhn.fhir.rest.server.method.OperationMethodBinding.methodNotSupported | HTTP Method {0} is not allowed for this operation. Allowed method(s): {1} |
| ca.uhn.fhir.rest.server.method.OperationParameter.urlParamNotPrimitive | Can not invoke operation {0} using HTTP GET because parameter {1} is not a primitive datatype |
| ca.uhn.fhir.rest.server.method.PageMethodBinding.unknownSearchId | Search ID "{0}" does not exist and may have expired |
| ca.uhn.fhir.rest.server.method.ReadMethodBinding.invalidParamsInRequest | Invalid query parameter(s) for this request: "{0}" |
| ca.uhn.fhir.rest.server.method.ResourceParameter.failedToParseRequest | Failed to parse request body as {0} resource. Error was: {1} |
| ca.uhn.fhir.rest.server.method.ResourceParameter.invalidContentTypeInRequest | Incorrect Content-Type header value of "{0}" was provided in the request. A FHIR Content-Type is required for "{1}" operation |
| ca.uhn.fhir.rest.server.method.ResourceParameter.noContentTypeInRequest | No Content-Type header was provided in the request. This is required for "{0}" operation |
| ca.uhn.fhir.rest.server.method.SearchMethodBinding.idNullForCompartmentSearch | ID parameter can not be null or empty for compartment search |
| ca.uhn.fhir.rest.server.method.SearchMethodBinding.idWithoutCompartment | Method [{0}] in provider [{1}] has an @IdParam parameter. This is only allowable for compartment search (e.g. @Search(compartment="foo") ) |
| ca.uhn.fhir.rest.server.method.SearchMethodBinding.invalidSpecialParamName | Method [{0}] in provider [{1}] contains search parameter annotated to use name [{2}] - This name is reserved according to the FHIR specification and can not be used as a search parameter name. |
| ca.uhn.fhir.rest.server.method.SummaryEnumParameter.cantCombineText | Can not combine _summary=text with other values for _summary |
| ca.uhn.fhir.validation.FhirValidator.noPhError | Ph-schematron library not found on classpath, can not enable perform schematron validation |
| ca.uhn.fhir.validation.FhirValidator.noPhWarningOnStartup | Ph-schematron library not found on classpath, will not attempt to perform schematron validation |
| ca.uhn.fhir.validation.ValidationContext.unableToDetermineEncoding | Unable to determine encoding (e.g. XML / JSON) on validation input. Is this a valid FHIR resource body? |
| ca.uhn.fhir.validation.ValidationResult.noIssuesDetected | No issues detected during validation |
| channel_retry_config.channel.failed.name | Failure Channel Name |
| channel_retry_config.channel.failed.name.desc | The name of Kafka topic or ActiveMQ queue where resources are sent after they have exceeded the maximum number of retry attempts, and have still not been successfully processed. |
| channel_retry_config.channel.retry.delay_milliseconds | Retry Delay(ms) |
| channel_retry_config.channel.retry.delay_milliseconds.desc | The minimum amount of time to wait (milliseconds) between retry attempts. |
| channel_retry_config.channel.retry.maximum_attempts | Maximum amount of retry attempts. |
| channel_retry_config.channel.retry.maximum_attempts.desc | The maximum amount of times to attempt import before considering a message failed. |
| channel_retry_config.channel.retry.maximum_delay_milliseconds | Maximum Delay(ms) between attempts. |
| channel_retry_config.channel.retry.maximum_delay_milliseconds.desc | The maximum amount of time to wait (milliseconds) between retry attempts. This provides an upper limit for exponential backoff. |
| channel_retry_config.channel.retry.name | Retry Channel Name |
| channel_retry_config.channel.retry.name.desc | The name of Kafka topic or ActiveMQ queue where inbound resources are sent when a failure occurs during processing of an incoming resource. |
| channel_retry_config.channel.retry.retriable_exceptions | Retriable Exceptions |
| channel_retry_config.channel.retry.retriable_exceptions.desc | A list of Exception classes that indicate processing should be retried. Add one per line. |
| channel_retry_config.channel.retry.strategy | Retry Strategy |
| channel_retry_config.channel.retry.strategy.desc | Which backoff strategy to attempt during retries. Valid options are <code>CONSTANT</code> and <code>EXPONENTIAL</code> |
| dateformatter.1_day_ago | 1 day ago |
| dateformatter.n_days_ago | {0} days ago |
| dateformatter.never | Never |
| dateformatter.today | Today |
| healthcheck.connection_pool.name | DB Connection Pool |
| healthcheck.ft_indexing_status.name | FullText Indexer |
| healthcheck.heartbeat_svc.name | Cluster Heartbeat |
| healthcheck.hl7v2_mllp_listener.name | HL7 v2.x MLLP Listener |
| healthcheck.http_responses.name | HTTP Pipeline |
| healthcheck.sp_sync_analysis.name | Search Parameter Analysis |
| healthcheck.sp_sync_sync.name | Search Parameter Synchronization |
| healthcheck.stats_cleanup_collapse.name | Statistics Collapser |
| healthcheck.stats_cleanup_purge.name | Old Statistics Purge |
| healthcheck.stats_heartbeat.name | Statistics Heartbeat |
| healthcheck.transaction_log_purge.name | Transaction Log Purge |
| healthcheck.xact_log_purger.name | Transaction Log Purger |
| javax.validation.constraints.AssertFalse.message | must be false |
| javax.validation.constraints.AssertTrue.message | must be true |
| javax.validation.constraints.DecimalMax.message | must be less than ${inclusive == true ? ''or equal to '' : ''''}{value} |
| javax.validation.constraints.DecimalMin.message | must be greater than ${inclusive == true ? ''or equal to '' : ''''}{value} |
| javax.validation.constraints.Digits.message | numeric value out of bounds (<{integer} digits>.<{fraction} digits> expected) |
| javax.validation.constraints.Email.message | must be a well-formed email address |
| javax.validation.constraints.Future.message | must be a future date |
| javax.validation.constraints.FutureOrPresent.message | must be a date in the present or in the future |
| javax.validation.constraints.Max.message | must be less than or equal to {value} |
| javax.validation.constraints.Min.message | must be greater than or equal to {value} |
| javax.validation.constraints.Negative.message | must be less than 0 |
| javax.validation.constraints.NegativeOrZero.message | must be less than or equal to 0 |
| javax.validation.constraints.NotBlank.message | must not be blank |
| javax.validation.constraints.NotEmpty.message | must not be empty |
| javax.validation.constraints.NotNull.message | must not be null |
| javax.validation.constraints.Null.message | must be null |
| javax.validation.constraints.Past.message | must be a past date |
| javax.validation.constraints.PastOrPresent.message | must be a date in the past or in the present |
| javax.validation.constraints.Pattern.message | must match "{regexp}" |
| javax.validation.constraints.Positive.message | must be greater than 0 |
| javax.validation.constraints.PositiveOrZero.message | must be greater than or equal to 0 |
| javax.validation.constraints.Size.message | size must be between {min} and {max} |
| module_config.admin_web_console.transaction_log.payload_body_display_mode | Transaction Log - Event Body Display Mode |
| module_config.admin_web_console.transaction_log.payload_body_display_mode.desc | This setting controls whether Transaction Log payload bodies are displayed by default. |
| module_config.base.requires.CLUSTERMGR | The cluster manager to use as a manager for this module. |
| module_config.base.requires.ENDPOINT_FHIR | The underlying FHIR endpoint for this module. |
| module_config.base.requires.ENDPOINT_FHIR.name | FHIR Endpoint |
| module_config.base.requires.ENDPOINT_SUBSCRIPTION_WEBSOCKET | Add this to include the websocket URL in your server's FHIR CapabilityStatement |
| module_config.base.requires.ENDPOINT_SUBSCRIPTION_WEBSOCKET.name | Websocket Subscription Endpoint |
| module_config.base.requires.NARRATIVE_GENERATOR | The Narrative Generator module is used to create FHIR narrative content based on the structured contents of resources. |
| module_config.base.requires.NARRATIVE_GENERATOR.name | Narrative Generator |
| module_config.base.requires.PACKAGE_CACHE.name | Package Cache |
| module_config.base.requires.PERSISTENCE_ALL | The FHIR Storage module to associate with this module. |
| module_config.base.requires.PERSISTENCE_ALL.forSecurityModule | The (optional) FHIR Storage module to supply any authentication callback scripts called by this module. |
| module_config.base.requires.PERSISTENCE_ALL.forSecurityModule.name | FHIR Storage Module |
| module_config.base.requires.PERSISTENCE_ALL.name | FHIR Storage Module (any FHIR version) |
| module_config.base.requires.PERSISTENCE_DSTU2 | The FHIR DSTU2 Storage engine to use as a manager for this module. |
| module_config.base.requires.PERSISTENCE_DSTU2.name | FHIR DSTU2 Storage |
| module_config.base.requires.PERSISTENCE_DSTU3 | The FHIR R3 Storage engine to use as a manager for this module. |
| module_config.base.requires.PERSISTENCE_DSTU3.name | FHIR R3 Storage |
| module_config.base.requires.PERSISTENCE_R4 | The FHIR R4 Storage engine to use as a manager for this module. |
| module_config.base.requires.PERSISTENCE_R4.name | FHIR R4 Storage |
| module_config.base.requires.SECURITY_IN_ANONYMOUS | This dependency may optionally be used to specify a security module to use for anonymous authentication (essentially this means that the given provider will provide the account containing permissions to be assigned to anonymous requests). |
| module_config.base.requires.SECURITY_IN_ANONYMOUS.name | Anonymous Authentication |
| module_config.base.requires.SECURITY_IN_OIC | The inbound security module (or outbound security module if using internal access tokens) to use for authenticating and authorizing users to this module using OpenID Connect Authentication. |
| module_config.base.requires.SECURITY_IN_OIC.name | OpenID Connect Authentication |
| module_config.base.requires.SECURITY_IN_SAML | The SAML Inbound Security module to use when performing a SAML user authentication. |
| module_config.base.requires.SECURITY_IN_SAML.name | SAML Authentication |
| module_config.base.requires.SECURITY_IN_UP | The inbound security module to use for authenticating and authorizing users to this module where authentication requires a username and password. |
| module_config.base.requires.SECURITY_IN_UP.name | Username/Password Authentication |
| module_config.base.requires.SUBSCRIPTION | The subscription matcher matches new and updated resources against active subscriptions and sends matches to endpoints. |
| module_config.base.requires.SUBSCRIPTION.name | Subscription Matcher |
| module_config.base_jetty_server.access_log.appenders | Appenders |
| module_config.base_jetty_server.access_log.appenders.desc | Specifies the appenders for the access log on this endpoint. See <a href="/docs/product_configuration/http_server_setup.html#access-logs">Access Logs</a> for information on how these are configured. |
| module_config.base_jetty_server.anonymous.access.account_username | Anonymous Account Username |
| module_config.base_jetty_server.anonymous.access.account_username.desc | The account name for the system account to use for anonymous requests. |
| module_config.base_jetty_server.anonymous_access_enabled | Allow Anonymous Access |
| module_config.base_jetty_server.anonymous_access_enabled.desc | If enabled, anonymous requests (i.e. requests without credentials) will be allowed to proceed. This means that they will not be blocked by the security manager, and they will instead proceed under the authority of the designated anonymous user. Only roles and permissions that have been assigned to the anonymous user will be granted to these requests. See <a href="/docs/security/anonymous_access.html">Anonymous Access</a> for more information. |
| module_config.base_jetty_server.bind_address | Bind Address |
| module_config.base_jetty_server.bind_address.desc | The local network interface address to bind to. Set to <code>0.0.0.0</code> to bind to all addresses. |
| module_config.base_jetty_server.block_http_head | Block HTTP HEAD |
| module_config.base_jetty_server.block_http_head.desc | If set, the server will reject the HTTP <code>HEAD</code> verb. This verb is considered insecure in some environments. |
| module_config.base_jetty_server.block_http_options | Block HTTP OPTIONS |
| module_config.base_jetty_server.block_http_options.desc | If set, the server will reject the HTTP <code>OPTIONS</code> verb. This verb is considered insecure in some environments. |
| module_config.base_jetty_server.context_path | Context Path |
| module_config.base_jetty_server.context_path.desc | This setting provides the path at the given port that this server will listen on. By default the server simply listens at the <code>/</code> path, but this could be changed to a sub-path for some network architectures. For example, if a reverse proxy is proxying the server but also serving other endpoints with the same port at different paths, this setting can be used as a hint to this server as to which path should be used. |
| module_config.base_jetty_server.context_path.extended | This setting provides the path at the given port that this server will listen on. By default the server simply listens at the <code>/</code> path, but this could be changed to a sub-path for some network architectures. For example, if a reverse proxy is proxying the server but also serving other endpoints with the same port at different paths, this setting can be used as a hint to this server as to which path should be used. If a reverse proxy is serving this server in such a way that a request to the proxy at <code>/baseurl/foo/index.html</code> should map to <code>/index.html</code> on this server, you should put <code>/baseurl/foo</code> as the context root. |
| module_config.base_jetty_server.cors_enable | CORS Enabled |
| module_config.base_jetty_server.cors_enable.desc | Should this endpoint allow the use of <a href="https://en.wikipedia.org/wiki/Cross-origin_resource_sharing" target="_blank">CORS</a>? Enable this item only if you understand what it is doing. |
| module_config.base_jetty_server.cors_origins | CORS Origins |
| module_config.base_jetty_server.cors_origins.desc | A comma-separated list of allowable origins for the CORS filter. For example: <code>https://example.com, https://try.smilecdr.com:9201</code>. You may also use the wildcard value <code>*</code> to allow CORS for all domains, however this is generally not considered a good practice for production systems serving sensitive data. |
| module_config.base_jetty_server.endpoint_health.path | Endpoint Health Path |
| module_config.base_jetty_server.endpoint_health.path.desc | Specifies a path (in the form <code>/path/to/endpoint</code>) that will be used as the Endpoint Health Check path. See <a href="/docs/monitoring/monitoring_basics.html#endpoint-health">Endpoint Health</a> for information on this feature. |
| module_config.base_jetty_server.frame_options.allow_from | Frame Options (Allow From) |
| module_config.base_jetty_server.frame_options.allow_from.desc | This setting can be used to set the <a href="https://developer.mozilla.org/en-US/DOCS/Web/HTTP/Headers/X-Frame-Options">X-Frame-Options</a> header. Leave this setting blank (the default) in order to set a value of <code>DENY</code>. See <a href="/docs/product_configuration/http_server_setup.html#frame-options">Frame Options</a> for more information. |
| module_config.base_jetty_server.https_forwarding_assumed | HTTPS Forwarding Assumed |
| module_config.base_jetty_server.https_forwarding_assumed.desc | If enabled, the server will treat incoming requests as though they were secure even if they are not. This is useful in order to force redirects to use HTTPS in environments where the <code>X-Forwarded-Proto</code> does not reliably get passed from network infrastructure in front of Smile CDR to Smile CDR. |
| module_config.base_jetty_server.max_header_size.request.kb | Maximum Request Header Size (KB) |
| module_config.base_jetty_server.max_header_size.request.kb.desc | This setting controls the maximum total size for the request headers to parse by the server. Increase this setting if you expect to have large request header groups. |
| module_config.base_jetty_server.max_header_size.response.kb | Maximum Response Header Size (KB) |
| module_config.base_jetty_server.max_header_size.response.kb.desc | This setting controls the maximum total size for the response headers to be generated by the server. Increase this setting if you expect the server to generate large response headers, e.g. if <a href="/docs/fhir_repository/tracing_and_provenance.html#performance-tracing">Performance Tracing</a> or validation will be output to the HTTP headers. |
| module_config.base_jetty_server.pin_host | Pin Host |
| module_config.base_jetty_server.pin_host.desc | If set, the server will always use the given host name instead of respecting the <code>Host</code> header. This can be useful to mitigate <a href="https://dzone.com/articles/what-is-a-host-header-attack">host poisoning attacks</a>. The value for this setting is a comma-separated list in the form: <code>hosta.com:8888, hostb.org</code>. Any request that does not request one of the hosts in the list will be treated as though it had requested the first entry in the list. |
| module_config.base_jetty_server.port | Listener Port |
| module_config.base_jetty_server.port.desc | The TCP port on which this module listens. |
| module_config.base_jetty_server.read_idle_timeout.millis | Read Idle Timeout (millis) |
| module_config.base_jetty_server.read_idle_timeout.millis.desc | When reading a request payload arriving from a client, this value specifies how long the server should wait if data stalls before timing out. |
| module_config.base_jetty_server.respect_forward_headers | Respect Forward Headers |
| module_config.base_jetty_server.respect_forward_headers.desc | If enabled, the server will respect values provided by the client in the HTTP <code>Forward</code>, <code>X-Forwarded-For</code>, <code>X-Forwarded-Host</code>, and <code>X-Forwarded-Proto</code> headers. These headers are useful in cases where Smile CDR is being served behind a reverse proxy. This setting should be disabled if the server is not behind a proxy since this could allow clients to masquerade their source IP, which is a security risk. See <a href="/docs/product_configuration/http_server_setup.html#respecting-forward-headers">Respecting Forward Headers</a> for more information. |
| module_config.base_jetty_server.saml.enabled | SAML Authentication Enabled |
| module_config.base_jetty_server.saml.enabled.desc | If enabled, this server will support authentication using SAML. See <a href="/docs/security/saml_inbound_security_module.html">SAML Inbound Security</a> for more information. |
| module_config.base_jetty_server.security.http_basic.enabled | HTTP Basic Security |
| module_config.base_jetty_server.security.http_basic.enabled.desc | Should this endpoint support the use of <a href="https://en.wikipedia.org/wiki/Basic_access_authentication" target="_blank">HTTP Basic Access Authentication</a>? |
| module_config.base_jetty_server.security.http_basic.realm | HTTP Basic Realm |
| module_config.base_jetty_server.security.http_basic.realm.desc | The realm to provide in HTTP 401 Authorization Required responses. |
| module_config.base_jetty_server.security.oic.enabled | OpenID Connect Security |
| module_config.base_jetty_server.security.oic.enabled.desc | Should this endpoint support the use of OpenID Connect Authentication (e.g. <a href="http://smarthealthit.org/" target="_blank">SMART</a>)? |
| module_config.base_jetty_server.session_scavenger_interval_millis | Session Scavenger Interval (Millis) |
| module_config.base_jetty_server.session_scavenger_interval_millis.desc | The number of milliseconds between session scavenger passes. |
| module_config.base_jetty_server.session_timeout_mins | Session Timeout (Mins) |
| module_config.base_jetty_server.session_timeout_mins.desc | The number of minutes that a user session can sit idle before it is eligible to expire. |
| module_config.base_jetty_server.suppress_error_details | Suppress Error Details |
| module_config.base_jetty_server.suppress_error_details.desc | If enabled, the server suppress most details about errors from being released in HTTP responses. For example, invalid paths will not be echoed in 404 messages and details about invalid OAuth2 scopes will be suppressed. This setting is useful for production environments, as it minimizes the risk of malicious users gaining insights into the running system via error messages. |
| module_config.base_jetty_server.suppress_platform_info | Suppress Platform Information |
| module_config.base_jetty_server.suppress_platform_info.desc | If this setting is enabled, Smile CDR will not advertise the software or version being used via the REST endpoint CapabilityStatement/Conformance or <code>X-Powered-By</code> header. |
| module_config.base_jetty_server.threadpool.accept_queue_size | Thread Pool Accept Queue Size |
| module_config.base_jetty_server.threadpool.accept_queue_size.desc | If set, provides the number of requests that will be queued waiting for an available thread before giving up and rejecting incoming connections. By default the queue is unbounded. |
| module_config.base_jetty_server.threadpool_max | Thread Pool Maximum Size |
| module_config.base_jetty_server.threadpool_max.desc | The maximum number of threads to create for servicing requests when this module is under full load. |
| module_config.base_jetty_server.threadpool_min | Thread Pool Minimum Size |
| module_config.base_jetty_server.threadpool_min.desc | The minimum number of threads to keep idle in the pool between servicing requests. |
| module_config.base_jetty_server.trusted_client.assert_permissions | Assert Permissions |
| module_config.base_jetty_server.trusted_client.assert_permissions.desc | If enabled, the trusted client will be allowed to assert a set of permissions to grant the calling user, replacing the existing permissions. |
| module_config.base_jetty_server.trusted_client.enabled | Trusted Client Mode Enabled |
| module_config.base_jetty_server.trusted_client.enabled.desc | If enabled, client requests will be inspected for a header indicating the identity and/or permissions to grant the calling user. Note that this <strong>should only be enabled</strong> in circumstances where the FHIR client is trusted not to be malicious (e.g. a server-to-server communication). See the <a href="/docs/security/trusted_client_mode.html" target="_blank">Trusted Client Mode</a> documentation for more information. |
| module_config.base_jetty_server.use_inmemory_sessions | Use In-Memory Sessions |
| module_config.base_jetty_server.use_inmemory_sessions.desc | If enabled, any HTTP sessions created for this listener will be stored only in memory, as opposed to being persisted in the database. This may lead to a performance boost in some situations but also prevents sessions from working in some clustered configurations or surviving a restart of the system. Note that not all listeners even create sessions (e.g. FHIR endpoints do not) so this setting may have no effect. |
| module_config.base_server.tls.protocol.cipher_blacklist | TLS Cipher Blacklist |
| module_config.base_server.tls.protocol.cipher_blacklist.desc | If specified, contains a space-separated list of ciphers that are not permitted for use by TLS clients. See <a href="/docs/product_configuration/tls_https.html#tls-ciphers-and-protocol">Selecting Ciphers and Protocol</a> for more information. |
| module_config.base_server.tls.protocol.cipher_whitelist | TLS Cipher Whitelist |
| module_config.base_server.tls.protocol.cipher_whitelist.desc | If specified, contains a space-separated list of ciphers that are permitted for use by TLS clients. See <a href="/docs/product_configuration/tls_https.html#tls-ciphers-and-protocol">Selecting Ciphers and Protocol</a> for more information. |
| module_config.base_server.tls.protocol.protocol_blacklist | TLS Protocol Blacklist |
| module_config.base_server.tls.protocol.protocol_blacklist.desc | If specified, contains a space-separated list of protocols that are not permitted for use by TLS clients. See <a href="/docs/product_configuration/tls_https.html#tls-ciphers-and-protocol">Selecting Ciphers and Protocol</a> for more information. |
| module_config.base_server.tls.protocol.protocol_whitelist | TLS Protocol Whitelist |
| module_config.base_server.tls.protocol.protocol_whitelist.desc | If specified, contains a space-separated list of protocols that are permitted for use by TLS clients. See <a href="/docs/product_configuration/tls_https.html#tls-ciphers-and-protocol">Selecting Ciphers and Protocol</a> for more information. |
| module_config.base_server.tls_clientauth_enabled | TLS Client Authentication |
| module_config.base_server.tls_clientauth_enabled.desc | Should the listener for this module require incoming connections to authenticate using TLS Client Authentication? |
| module_config.base_server.tls_enabled | TLS Enabled |
| module_config.base_server.tls_enabled.desc | Should the listener for this module require TLS (i.e. SSL or HTTPS) encryption for incoming connections? |
| module_config.base_server.tls_keystore_file | TLS KeyStore Filename |
| module_config.base_server.tls_keystore_file.desc | The filename for the TLS KeyStore used to hold private keys for TLS connections. This can be in the format <code>classpath:path/to/file.p12</code> or <code>file:///path/to/file.p12</code>. Valid file extensions are <code>.jks</code> (Java Keystore) or <code>.p12</code> (PKCS#12 store). |
| module_config.base_server.tls_keystore_keyalias | TLS KeyStore Key Alias |
| module_config.base_server.tls_keystore_keyalias.desc | The alias for the specific key within the KeyStore that should be selected for incoming TLS connections. |
| module_config.base_server.tls_keystore_keypass | TLS KeyStore Key Password |
| module_config.base_server.tls_keystore_keypass.desc | The password for the specific key within the KeyStore (leave blank if the key has no password). |
| module_config.base_server.tls_keystore_password | TLS KeyStore Password |
| module_config.base_server.tls_keystore_password.desc | The password for the TLS KeyStore (leave blank if the store has no password). |
| module_config.base_server.tls_truststore_file | TLS TrustStore Filename |
| module_config.base_server.tls_truststore_file.desc | The filename for the TLS <a href="/docs/product_configuration/tls_https.html#truststores-and-keystores">TrustStore</a> used to hold trusted certificates for TLS connections. This can be in the format <code>classpath:path/to/file.p12</code> or <code>file:///path/to/file.p12</code>. Valid file extensions are <code>.jks</code> (Java Keystore) or <code>.p12</code> (PKCS#12 store). |
| module_config.base_server.tls_truststore_password | TLS TrustStore Password |
| module_config.base_server.tls_truststore_password.desc | The password for the TLS TrustStore (leave blank if the store has no password). |
| module_config.channel_import.channel.concurrent_consumers | Concurrent Consumers |
| module_config.channel_import.channel.concurrent_consumers.desc | The number of the concurrent consumers. |
| module_config.channel_import.channel.name | Channel Name |
| module_config.channel_import.channel.name.desc | The name of Kafka topic or ActiveMQ queue where inbound resources will be arriving. |
| module_config.clustermgr.audit_log.broker.enabled | Audit Log Broker Enabled |
| module_config.clustermgr.audit_log.broker.enabled.desc | This setting may be used to submit all audit log events to a message queue. |
| module_config.clustermgr.audit_log.db.enabled | Audit Log Database Enabled |
| module_config.clustermgr.audit_log.db.enabled.desc | This setting may be used to disable saving audit logs to a database if it is not needed in a given solution design. |
| module_config.clustermgr.db_schema_update_mode | Database Update Mode |
| module_config.clustermgr.db_schema_update_mode.desc | Controls whether Smile CDR should attempt to update the Cluster Manager database on startup. If the database schema is out of date, Smile CDR automatically run migration on the Cluster Manager database if the value is "UPDATE" If the value is "NONE", then Smile CDR will abort on startup if the Cluster Manager database is out of date. When set to "NONE", you should use the "smileutil migrate" command to upgrade the Cluster Manager database manually. |
| module_config.clustermgr.messagebroker.address | Message Broker Address |
| module_config.clustermgr.messagebroker.address.desc | The connection string to use when connecting to a remote broker. |
| module_config.clustermgr.messagebroker.channel_naming.prefix | Channel Naming Prefix |
| module_config.clustermgr.messagebroker.channel_naming.prefix.desc | If specified, all channels used by the Message Broker will have the given prefix applied to their name. |
| module_config.clustermgr.messagebroker.password | Message Broker Password |
| module_config.clustermgr.messagebroker.password.desc | The password to use when connecting to the message broker. |
| module_config.clustermgr.messagebroker.type | Message Broker Type |
| module_config.clustermgr.messagebroker.type.desc | Determines the type of message broker used for subscriptions. If EMBEDDED_ACTIVEMQ is chosen, it is started by the Subscription Matcher module. EMBEDDED_ACTIVEMQ and REMOTE_ACTIVEMQ use the following "Message Broker" configuration. KAFKA uses the following "Kafka" configuration. |
| module_config.clustermgr.messagebroker.username | Message Broker Username |
| module_config.clustermgr.messagebroker.username.desc | The username to use when connecting to the message broker. |
| module_config.clustermgr.schedule.thread_count | Scheduler Thread Count |
| module_config.clustermgr.schedule.thread_count.desc | The number of threads allocated to processing cluster-wide scheduled background tasks. All nodes share the same pool of clustered tasks. |
| module_config.clustermgr.stats.heartbeat_persist_frequency_ms | Heartbeat Persist Frequency MS |
| module_config.clustermgr.stats.heartbeat_persist_frequency_ms.desc | How often module health status is persisted to the database |
| module_config.clustermgr.stats.stats_cleanup_frequency_ms | Stats Cleanup Frequency MS |
| module_config.clustermgr.stats.stats_cleanup_frequency_ms.desc | How often module module performance statistics are deleted from the database and collapsed into time interval statistics. Should be greater than stats.stats_persist_frequency_ms |
| module_config.clustermgr.stats.stats_persist_frequency_ms | Stats Persist Frequency MS |
| module_config.clustermgr.stats.stats_persist_frequency_ms.desc | How often module module performance statistics are persisted to the database. Should be greater than or equal to stats.heartbeat_persist_frequency_ms |
| module_config.clustermgr.transactionlog.enabled | Transaction Log Enabled |
| module_config.clustermgr.transactionlog.enabled.desc | If disabled, no new entries will be written to the transaction log. Existing entries will remain available until the configured retention period has elapsed. |
| module_config.clustermgr.transactionlog.event_blacklist | Event Blacklist |
| module_config.clustermgr.transactionlog.event_blacklist.desc | This setting provides a blacklist of event Type/SubType codes that should not be stored in the Transaction Log. See <a href="/docs/logging/transaction_log.html#controlling-transaction-log-events">Controlling Transaction Log Events</a> for more information. |
| module_config.clustermgr.transactionlog.event_whitelist | Event Whitelist |
| module_config.clustermgr.transactionlog.event_whitelist.desc | This setting provides a whitelist of event Type/SubType codes to be stored in the Transaction Log. See <a href="/docs/logging/transaction_log.html#controlling-transaction-log-events">Controlling Transaction Log Events</a> for more information. |
| module_config.clustermgr.transactionlog.persist_bodies_in_clustermgr_db | Persist Transaction Bodies (Global) |
| module_config.clustermgr.transactionlog.persist_bodies_in_clustermgr_db.desc | If enabled, the bodies of transactions will be stored in the cluster manager database. This can be useful for troubleshooting; however, it has database capacity and performance implications under heavy load. This configuration is enabled by default. Note that this is a master switch, and disabling it takes precedence over any more specific persistence switches. |
| module_config.clustermgr.transactionlog.persist_endpoint_receive_bodies | Persist Transaction Bodies: Incoming Request |
| module_config.clustermgr.transactionlog.persist_endpoint_receive_bodies.desc | If enabled, incoming request transaction bodies (e.g. the request body for a FHIR create request received by a FHIR Endpoint module) will be persisted in the transaction log. |
| module_config.clustermgr.transactionlog.persist_endpoint_reply_bodies | Persist Transaction Bodies: Incoming Response |
| module_config.clustermgr.transactionlog.persist_endpoint_reply_bodies.desc | If enabled, incoming response transaction bodies (e.g. the response body for a FHIR search request received by a FHIR Endpoint module) will be persisted in the transaction log. |
| module_config.clustermgr.transactionlog.truncate_body.bytes | Truncate Transaction Bodies (bytes) |
| module_config.clustermgr.transactionlog.truncate_body.bytes.desc | If set to a positive integer, transaction log payload bodies will be truncated before being stored in the transaction log. |
| module_config.clustermgr_maintenance.retain_day_stats_days | Stats Retention (Days) - Day Level |
| module_config.clustermgr_maintenance.retain_day_stats_days.desc | The number of days that statistics at the day precision will be retained. |
| module_config.clustermgr_maintenance.retain_hour_stats_days | Stats Retention (Days) - Hour Level |
| module_config.clustermgr_maintenance.retain_hour_stats_days.desc | The number of days that statistics at the hour precision will be retained. |
| module_config.clustermgr_maintenance.retain_minute_stats_days | Stats Retention (Days) - Minute Level |
| module_config.clustermgr_maintenance.retain_minute_stats_days.desc | The number of days that statistics at the minute precision will be retained. |
| module_config.clustermgr_maintenance.retain_transaction_log_days | Transaction Log Retention (Days) |
| module_config.clustermgr_maintenance.retain_transaction_log_days.desc | The number of days that entries in the transaction log should be retained before being deleted from the database. If blank, the transaction log will be retained indefinitely. |
| module_config.empi.consumer_count | EMPI Consumer Thread Count |
| module_config.empi.consumer_count.desc | Number of concurrent threads dedicated to matching incoming Patient and Practitioner resources. Experimental new feature under development. |
| module_config.empi.prevent_eid_updates | Prevent modification of External EIDs |
| module_config.empi.prevent_eid_updates.desc | If enabled, EMPI Enterprise Identifiers (EIDs) may not be modified once set on a Patient/Practitioner. |
| module_config.empi.prevent_multiple_eids | Prevent multiple EIDs from existing simultaneously on a Patient/Practitioner |
| module_config.empi.prevent_multiple_eids.desc | If enabled, Patient/Practitioner creates and updates will be rejected if they contain multiple Enterprise Identifiers (EIDs). |
| module_config.empi.script.file | EMPI Rule Definition Script (File) |
| module_config.empi.script.file.desc | If set, supplies the absolute filepath of a file containing a set of EMPI rules used by the EMPI service. Values should be prefixed with <code>file:</code> or <code>classpath:</code>. |
| module_config.empi.script.text | EMPI Rule Definition Script (Text) |
| module_config.empi.script.text.desc | If set, supplies a set of EMPI rules used by the EMPI service. |
| module_config.etl_import.csv.delimiter | CSV File Delimiter |
| module_config.etl_import.csv.delimiter.desc | For CSV import files, this setting defines the delimiter to use when parsing files. |
| module_config.etl_import.csv.parse_quotes | Parse Quotes |
| module_config.etl_import.csv.parse_quotes.desc | If enabled, quoted values will be parsed per the rules specified in <a href="https://tools.ietf.org/html/rfc4180">RFC 4180</a>. If this is disabled, quoted values will be parsed verbatim (and any quote marks will be included in the parsed values). |
| module_config.etl_import.import_source | Import Source |
| module_config.etl_import.import_source.desc | This setting defines the format for files being imported. |
| module_config.etl_import.mapping.script | Mapping Script |
| module_config.etl_import.mapping.script.desc | This is the script that processes each received row. It must have at least one function, with signature <code>function handleEtlImportRow(inputMap, context)</code>. See <a href="/docs/bulk/etl_import_module.html">ETL Importer</a> module for details on how this function works. |
| module_config.etl_import.parallelism.hashing.script | Worker Row Hashing Function |
| module_config.etl_import.parallelism.hashing.script.desc | If set, this script is used to provide an appropriate hash for each individual row in order to ensure that rows are processed in an appropriate order. This setting may be left blank if in-order processing of individual rows is not necessary. |
| module_config.etl_import.parallelism.threadcount | Worker Thread Count |
| module_config.etl_import.parallelism.threadcount.desc | This setting configures the number of worker threads that will be allocated to processing rows of the CSV file. If set to <code>1</code>, the file will be processed in a single-threaded manner. |
| module_config.fhir_endpoint.fhir_endpoint_conversion.enabled | Versioned API Mode |
| module_config.fhir_endpoint.fhir_endpoint_conversion.enabled.desc | <strong>This is an experimental feature, use with caution!</strong> This setting enables versioned mode, which allows a client to request a specific version of FHIR via the <code>fhirVersion</code> parameter in the <code>Accept</code> header, and the server will automatically convert responses to conform to the desired version. Conversions are performed automatically using translations that are supplied as a part of the FHIR specification, and they are not guaranteed to be correct. |
| module_config.fhir_endpoint.fhir_endpoint_security.automatically_narrow_search_scope | Automatically Narrow Search Scope |
| module_config.fhir_endpoint.fhir_endpoint_security.automatically_narrow_search_scope.desc | When enabled, the server will automatically try to narrow the scope of searches when the user only has permission to access specific instances or compartments. For example, when a user only has the <code>FHIR_READ_ALL_IN_COMPARTMENT/Patient/123</code> permission and tries to perform a search for <code>Observation?code=foo</code>, this search will be performed automatically as <code>Observation?subject=Patient/123&code=foo</code>. |
| module_config.fhir_endpoint_servlet.base_url_fixed | Fixed Value for Endpoint Base URL |
| module_config.fhir_endpoint_servlet.base_url_fixed.desc | If specified, the server will always use this base URL for FHIR responses (e.g. in <code>Location</code> headers, Bundle paging links, etc.). Note that changing this setting <strong>does not actually change the port or address</strong> that Smile CDR will use to serve up this endpoint. This setting merely changes the URL that will be advertised in responses. |
| module_config.fhir_endpoint_servlet.browser_syntax_highlighting.enabled | Browser Syntax Highlighting Enabled |
| module_config.fhir_endpoint_servlet.browser_syntax_highlighting.enabled.desc | If a FHIR request is determined to be coming from a browser, should the server use syntax highlighting to format the response? This option is useful for beginners who want to play with the FHIR API but can cause problems for some AJAX applications since FHIR content might be returned using formatted HTML instead of raw JSON/XML. |
| module_config.fhir_endpoint_servlet.browser_syntax_highlighting.show_request_headers | Show Request Headers |
| module_config.fhir_endpoint_servlet.browser_syntax_highlighting.show_request_headers.desc | If enabled, the request headers will be shown in the syntax highlighted response page (when used). |
| module_config.fhir_endpoint_servlet.browser_syntax_highlighting.show_response_headers | Show Response Headers |
| module_config.fhir_endpoint_servlet.browser_syntax_highlighting.show_response_headers.desc | If enabled, the response headers will be shown in the syntax highlighted response page (when used). |
| module_config.fhir_endpoint_servlet.consent_service.enabled | Consent Service Enabled |
| module_config.fhir_endpoint_servlet.consent_service.enabled.desc | This is a global switch to enable or disable the consent service. |
| module_config.fhir_endpoint_servlet.consent_service.script.file | Consent Service Script (File) |
| module_config.fhir_endpoint_servlet.consent_service.script.file.desc | If set, supplies a set of callback functions that will be executed for the consent service. Values should be prefixed with <code>file:</code> or <code>classpath:</code>. |
| module_config.fhir_endpoint_servlet.consent_service.script.text | Consent Service Script (Text) |
| module_config.fhir_endpoint_servlet.consent_service.script.text.desc | If set, supplies a set of callback functions that will be executed for the consent service. |
| module_config.fhir_endpoint_servlet.custom_interceptor_can_replace_authorization_interceptor | Can Replace Authorization Interceptor |
| module_config.fhir_endpoint_servlet.custom_interceptor_can_replace_authorization_interceptor.desc | If enabled, if a custom interceptor is found that extends the HAPI FHIR AuthorizationInterceptor, it will replace the built-in Smile CDR AuthorizationInterceptor. |
| module_config.fhir_endpoint_servlet.default_encoding | Default Encoding |
| module_config.fhir_endpoint_servlet.default_encoding.desc | Specifies the default encoding (i.e. JSON/XML) to use if the client does not specify a preference in the request. |
| module_config.fhir_endpoint_servlet.default_prefer_return | Default Prefer Return |
| module_config.fhir_endpoint_servlet.default_prefer_return.desc | This setting controls the default HTTP response payload for FHIR create/update/patch/transaction operations. By default the body of the resource as it was stored is returned (<code>REPRESENTATION</code>), but this default behavior can be changed to return an OperationOutcome resource (<code>OPERATION_OUTCOME</code>) or no payload at all (<code>MINIMAL</code>) by modifying this setting. Note that clients may override the default behavior on individual requests using the HTTP <code>Prefer</code> header as described in the <a href="http://hl7.org/fhir/http.html#ops">FHIR Specification</a>. |
| module_config.fhir_endpoint_servlet.default_pretty_print | Pretty-Print by Default |
| module_config.fhir_endpoint_servlet.default_pretty_print.desc | If enabled, responses will be pretty-printed by default unless the client request explicitly requests non-pretty-printed responses. Pretty-printed responses are useful for debugging and human readability but they contain extra spaces to they can have performance and size impacts. |
| module_config.fhir_endpoint_servlet.interceptor_bean_types | Interceptor Bean Types |
| module_config.fhir_endpoint_servlet.interceptor_bean_types.desc | A comma-separated list of bean classes to register as HAPI FHIR Interceptors against the endpoint server. |
| module_config.fhir_endpoint_servlet.partitioning.tenant_identification_strategy | Tenant Identification Strategy |
| module_config.fhir_endpoint_servlet.partitioning.tenant_identification_strategy.desc | If the attached FHIR Storage module has partitioning enabled and is configured to run in <em>REQUEST_TENANT</em> mode, this setting determines how tenants are identified. See <a href="/docs/fhir_repository/partitioning.html#tenant-identification-strategy">Tenant Identification Strategies</a> for more information. |
| module_config.fhir_endpoint_servlet.process_request_header.request_source_enabled | Process Header: Request Source |
| module_config.fhir_endpoint_servlet.process_request_header.request_source_enabled.desc | If enabled, the server will respect the <code>X-Request-Source</code> header. See <a href="/docs/fhir_repository/fhir_endpoint_module.html#capturing-source-information">Capturing Source Information</a> for more details. |
| module_config.fhir_endpoint_servlet.request_validating.enabled | Request Validating Enabled |
| module_config.fhir_endpoint_servlet.request_validating.enabled.desc | If enabled, the official FHIR StructureDefinitions and ValueSets will be used to validate resources for incoming FHIR requests. |
| module_config.fhir_endpoint_servlet.request_validating.fail_on_severity | Fail On Severity |
| module_config.fhir_endpoint_servlet.request_validating.fail_on_severity.desc | The severity at which to fail validated requests. <p><b>Request Validating must be enabled for this setting to take effect.</b></p> |
| module_config.fhir_endpoint_servlet.request_validating.response_headers.enabled | Validation Response Headers Enabled |
| module_config.fhir_endpoint_servlet.request_validating.response_headers.enabled.desc | If enabled, an informative header will be added to the response during validation. <p><b>Request Validating must be enabled for this setting to take effect.</b></p> |
| module_config.fhir_endpoint_servlet.request_validating.tags.enabled | Validation Tags Enabled |
| module_config.fhir_endpoint_servlet.request_validating.tags.enabled.desc | If enabled, an informative tag will be added to a resource during validation. Existing Smile CDR validation tags will be stripped from the incoming resource. <p><b>Request Validating must be enabled for this setting to take effect.</b></p> |
| module_config.fhir_endpoint_servlet.serve_raw_media_resource | Serve Raw Media Resources |
| module_config.fhir_endpoint_servlet.serve_raw_media_resource.desc | If enabled, clients may request a FHIR Read on a Media resource using either an Accept header or an additional parameter that requests the raw contents of the resource be served directly instead of the complete FHIR resource. See <a href="/docs/fhir_repository/binary_data.html#serving-raw-media">Serving Raw Media Resources</a> for more information. |
| module_config.fhir_gateway.cache.page.default_size | Cached Result Page Size (Default) |
| module_config.fhir_gateway.cache.page.default_size.desc | This is the default number of results that the gateway will return from a single cached page, if the client has not explicitly requested a page size. |
| module_config.fhir_gateway.cache.page.maximum_size | Cached Result Page Size (Maximum) |
| module_config.fhir_gateway.cache.page.maximum_size.desc | This is the maximum number of results that the gateway will return from a single cached page. |
| module_config.fhir_gateway.cache.purge_after.mins | Cache Time (mins) |
| module_config.fhir_gateway.cache.purge_after.mins.desc | This is the number of minutes that cached search results should remain available in the cache before being deleted. |
| module_config.fhir_gateway.cache.search_results.cache_data | Cache Search Results |
| module_config.fhir_gateway.cache.search_results.cache_data.desc | If enabled, search results wil be cached by the gateway in a local database. This allows the gateway to provide result paging even if the underlying server does not support it. |
| module_config.fhir_gateway.cache.search_results.max_count_to_store | Cache Search Results: Maximum Count |
| module_config.fhir_gateway.cache.search_results.max_count_to_store.desc | If <em>Cache Search Results</em> is enabled, this setting provides the maximum number of results that will be stored in the cache. |
| module_config.fhir_gateway.target_server.auth.basic.credentials | Basic Auth Credentials |
| module_config.fhir_gateway.target_server.auth.basic.credentials.desc | This setting contains the HTTP Basic Auth credentials to send from the gateway to the target server. Values should be in the form <code>username:password</code>. |
| module_config.fhir_gateway.target_server.auth.basic.enabled | Basic Auth Enabled |
| module_config.fhir_gateway.target_server.auth.basic.enabled.desc | Enable this setting in order for requests from the FHIR Gateway to the target server to contain an HTTP Basic Auth header. |
| module_config.fhir_gateway.target_server.base_url | Target Base URL |
| module_config.fhir_gateway.target_server.base_url.desc | This is the base URL for the target FHIR REST server |
| module_config.fhir_gateway.target_server.client.connect_timeout.secs | Target Client: Connect Timeout (secs) |
| module_config.fhir_gateway.target_server.client.connect_timeout.secs.desc | The number of seconds that a connect attempt to the target server should be allowed to take before timing out. |
| module_config.fhir_gateway.target_server.client.socket_timeout.secs | Target Client: Socket Timeout (secs) |
| module_config.fhir_gateway.target_server.client.socket_timeout.secs.desc | The number of seconds that an IO read/write to the target server should be allowed to take before timing out. |
| module_config.fhir_gateway.target_server.fhir_version | FHIR Version |
| module_config.fhir_gateway.target_server.fhir_version.desc | This is the version of FHIR supported by the target FHIR REST server |
| module_config.fhir_gateway.target_server.pass_through_headers | Passthrough Headers |
| module_config.fhir_gateway.target_server.pass_through_headers.desc | This setting provides a comma or space separated list of header names that should be passed through from the incoming client (the client that is calling the gateway) to the target server client. For example, if this setting is provided a value of <code>Authorization</code>, the authorization header will be examined by Smile CDR for security purposes, but it will also be copied in each request to the target server. |
| module_config.fhir_gateway.target_server.truststore.file | Target Client: TLS TrustStore File |
| module_config.fhir_gateway.target_server.truststore.file.desc | If the target server is using TLS (i.e. it has an <em>https</em> address base URL) this setting can be used to supply a <a href="/docs/product_configuration/tls_https.html#truststores-and-keystores">TrustStore</a>. |
| module_config.fhir_gateway.target_server.truststore.password | Target Client: TLS TrustStore Password |
| module_config.fhir_gateway.target_server.truststore.password.desc | Specifies the password used to open the TLS <a href="/docs/product_configuration/tls_https.html#truststores-and-keystores">TrustStore</a>. |
| module_config.hl7v2_fhir_mapper.forced_namespace_mode.encounter_system | Forced Namespace Mode: Encounter System |
| module_config.hl7v2_fhir_mapper.forced_namespace_mode.encounter_system.desc | If a URI is provided, the first encounter identifier (<code>PV1-19[0].1</code>) will be treated as the primary identifier, and this value will be used as the <code>Encounter.identifier.system</code> in the generated FHIR resource. |
| module_config.hl7v2_fhir_mapper.forced_namespace_mode.patient_system | Forced Namespace Mode: Patient System |
| module_config.hl7v2_fhir_mapper.forced_namespace_mode.patient_system.desc | If a URI is provided, the first patient identifier (<code>PID-3[0].1</code>) will be treated as the primary identifier, and this value will be used as the <code>Patient.identifier.system</code> in the generated FHIR resource. |
| module_config.hl7v2_fhir_mapper.identifiers.patient.primary_identifier_search_param_name | Patient Primary Identifier Search Parameter |
| module_config.hl7v2_fhir_mapper.identifiers.patient.primary_identifier_search_param_name.desc | If specified, Patient resources will be created using this search parameter to match the primary identifier. Typically the default value of <code>identifier</code> is good for this setting. |
| module_config.hl7v2_fhir_mapper_general.create_message_header | Create MessageHeader for Each Message |
| module_config.hl7v2_fhir_mapper_general.create_message_header.desc | If enabled, a MessageHeader resource will be created and stored in the repository for every HL7 v2.x message that is processed. See <a href="/docs/hl7_v2x_support/inbound_hl7v2.html#messageheader">Creating MessageHeader</a> for more information. |
| module_config.hl7v2_fhir_mapper_general.creation_mode.practitioner | Creation Mode - Practitioner |
| module_config.hl7v2_fhir_mapper_general.creation_mode.practitioner.desc | This setting controls the create/update mode for Practitioner resources that are generated when converting from HL7 v2.x. This setting can be used to specify that resources should always be updated using values from the v2.x message (conditional update) or should only be created if they do not already exist (conditional create). |
| module_config.hl7v2_fhir_mapper_general.infer_timezone_when_not_present | Inferred TimeZone When Not Present |
| module_config.hl7v2_fhir_mapper_general.infer_timezone_when_not_present.desc | If enabled, the given timezone offset will be used when an HL7 v2.x timestamp (TS) datatype is received that does not contain a timezone offset. This is useful because many HL7 v2.x systems do not transmit an offset, assuming instead that all times they transmit are in their local timezone. Set this value to explicitly state which timezone to infer. <p>Values for this property should be a valid Java TimeZone identifier (e.g. <code>America/Chicago</code> or <code>Australia/Canberra</code>).</p> |
| module_config.hl7v2_fhir_mapper_general.mapper_bean_types | Mapper Bean Types |
| module_config.hl7v2_fhir_mapper_general.mapper_bean_types.desc | A comma-separated list of bean classes that will be used to map messages as they are processed by this endpoint. Classes listed here must implement the interface <code>ca.cdr.api.pub.hl7v2.IHl7V2MessageMapper</code>. |
| module_config.hl7v2_fhir_mapper_general.messageheader.hardcoded_destination_name | MessageHeader Hardcoded Destination Name |
| module_config.hl7v2_fhir_mapper_general.messageheader.hardcoded_destination_name.desc | If set, supplies a hardcoded value to use for the <code>MessageHeader.destination.name</code> field in generated MessageHeader resources. This can be useful if you wish to place an identifier to uniquely track all messages received from a specific endpoint. |
| module_config.hl7v2_fhir_mapper_medications.use_standalone_medications_with_administered_code | Use Standalone Medications with Administered Code |
| module_config.hl7v2_fhir_mapper_medications.use_standalone_medications_with_administered_code.desc | If enabled, Medication resources derived from RXA segments will be standalone resources; otherwise they will be contained resources. This should <strong>only</strong> be enabled if <code>RXA-5</code> (Administered Code) uniquely identifies a given medication and <strong>all</strong> of its meaningful fields. |
| module_config.hl7v2_fhir_mapper_medications.use_standalone_medications_with_component_code | Use Standalone Medications with Component Code |
| module_config.hl7v2_fhir_mapper_medications.use_standalone_medications_with_component_code.desc | If enabled, Medication resources derived from RXC segments will be standalone resources; otherwise they will be contained resources. This should <strong>only</strong> be enabled if <code>RXC-2</code> (Component Code) uniquely identifies a given medication and <strong>all</strong> of its meaningful fields. |
| module_config.hl7v2_fhir_mapper_medications.use_standalone_medications_with_give_code | Use Standalone Medications with Give Code |
| module_config.hl7v2_fhir_mapper_medications.use_standalone_medications_with_give_code.desc | If enabled, Medication resources derived from RXE segments will be standalone resources; otherwise they will be contained resources. This should <strong>only</strong> be enabled if <code>RXE-2</code> (Give Code) uniquely identifies a given medication and <strong>all</strong> of its meaningful fields. |
| module_config.hl7v2_fhir_mapper_obr.observation_identification_mode | Observation Identification Mode |
| module_config.hl7v2_fhir_mapper_obr.observation_identification_mode.desc | This setting controls how Observation resources created by mapping OBX segments are given an identifier upon creation. See <a href="/docs/hl7_v2x_support/processing_results.html#observation-identification">Observation Identification</a> for information on how this setting works. |
| module_config.hl7v2_fhir_mapper_obr.use_obr2_placer_order_number_as_primary | Use OBR-2 as Primary Identifier |
| module_config.hl7v2_fhir_mapper_obr.use_obr2_placer_order_number_as_primary.desc | If enabled, the value of <code>OBR-2</code> (Placer Order Number) will be used as a primary identifier for generated <code>DiagnosticReport</code> resources. Note that at least one of <code>OBR-2</code> or <code>OBR-3</code> must be enabled, or both. |
| module_config.hl7v2_fhir_mapper_obr.use_obr2_placer_order_number_as_primary.extended | If enabled, the value of <code>OBR-2</code> (Placer Order Number) will be used as a primary identifier for generated <code>DiagnosticReport</code> resources. Note that at least one of <code>OBR-2</code> or <code>OBR-3</code> must be enabled for use as the primary identifier. It is also acceptable to select both, in which case updates will affect any existing <code>DiagnosticReport</code> that has either identifier. |
| module_config.hl7v2_fhir_mapper_obr.use_obr3_filler_order_number_as_primary | Use OBR-3 as Primary Identifier |
| module_config.hl7v2_fhir_mapper_obr.use_obr3_filler_order_number_as_primary.desc | If enabled, the value of <code>OBR-3</code> (Filler Order Number) will be used as a primary identifier for generated <code>DiagnosticReport</code> resources. Note that at least one of <code>OBR-2</code> or <code>OBR-3</code> must be enabled, or both. |
| module_config.hl7v2_fhir_mapper_obr.use_obr3_filler_order_number_as_primary.extended | If enabled, the value of <code>OBR-3</code> (Filler Order Number) will be used as a primary identifier for generated <code>DiagnosticReport</code> resources. Note that at least one of <code>OBR-2</code> or <code>OBR-3</code> must be enabled for use as the primary identifier. It is also acceptable to select both, in which case updates will affect any existing <code>DiagnosticReport</code> that has either identifier. |
| module_config.hl7v2_fhir_mapper_observation_group.observation_group_text_delimiter.nte | OBSERVATION Group Text Delimiter - NTE |
| module_config.hl7v2_fhir_mapper_observation_group.observation_group_text_delimiter.nte.desc | This delimiter will be used as a separator between multiple repetitions of NTE-3 (Note Text), as well as <code>NTE-3</code> from multiple contiguous NTE segments following a given OBX segment. By default, <code>\n</code> is used to indicate a newline. |
| module_config.hl7v2_fhir_mapper_observation_group.observation_group_text_delimiter.obx | OBSERVATION Group Text Delimiter - OBX |
| module_config.hl7v2_fhir_mapper_observation_group.observation_group_text_delimiter.obx.desc | Where <code>OBX-2</code> (Observation Value Type) is one of <code>ST</code>, <code>TX</code>, or <code>FT</code>, this delimiter will be used as a separator between multiple repetitions of OBX-5 (Value). By default, <code>\n</code> is used to indicate a newline. |
| module_config.hl7v2_fhir_mapper_order_observation_group.order_observation_group_text_delimiter.nte | ORDER_OBSERVATION Group Text Delimiter - NTE |
| module_config.hl7v2_fhir_mapper_order_observation_group.order_observation_group_text_delimiter.nte.desc | This delimiter will be used as a separator between multiple repetitions of NTE-3 (Note Text), as well as <code>NTE-3</code> from multiple contiguous NTE segments following a given OBR segment. By default, <code>\n</code> is used to indicate a newline. |
| module_config.hl7v2_fhir_mapper_pv1.treat_pv1_3_and_6_patient_locations_as_atomic | Treat PV1-3 and PV1-6 Patient Locations as Single Atomic Locations |
| module_config.hl7v2_fhir_mapper_pv1.treat_pv1_3_and_6_patient_locations_as_atomic.desc | By default, we treat each of <code>PL.1</code>, <code>PL.2</code>, and <code>PL.3</code> as distinct locations (e.g. ward, room, bed). <code>PL.1</code>, <code>PL.2</code>, and <code>PL.3</code> will each result in a unique Location resource. If this setting is enabled, all of <code>PL-1</code>, <code>PL-2</code>, and <code>PL-3</code> will be treated as a single atomic location (e.g. ward-room-bed). Processing the PL in this way will result in a single Location resource. |
| module_config.hl7v2_mllp_listener.charset.forced | Charset: Forced |
| module_config.hl7v2_mllp_listener.charset.forced.desc | If a charset is specified here (e.g. <code>ISO-8859-1</code> or <code>UTF-8</code>), all message parsing will use the given charset. Only used for MLLP. Ignored for HL7 over HTTP. |
| module_config.hl7v2_mllp_listener.charset.respect_msh18 | Charset: Respect MSH-18 |
| module_config.hl7v2_mllp_listener.charset.respect_msh18.desc | If enabled, the Minimal Lower Level Protocol (MLLP) listener will use the charset specified in <code>MSH-18</code> of a given message as the encoding to use when parsing the rest of the message. This is disabled by default as <code>MSH-18</code> is often incorrect in real world applications; however, it should be enabled in systems that are known to use it correctly. Ignored for HL/7 over HTTP. |
| module_config.hl7v2_mllp_listener.listener_script.file | Listener Processing Script (File) |
| module_config.hl7v2_mllp_listener.listener_script.file.desc | If specified, provides a script that is executed to provide processing logic for the endpoint. See <a href="/docs/hl7_v2x_support/inbound_hl7v2.html#callback-scripts">Scripted Processing Mode</a> for more information. Values should be prefixed with <code>file:</code> or <code>classpath:</code>. |
| module_config.hl7v2_mllp_listener.listener_script.text | Listener Processing Script (Text) |
| module_config.hl7v2_mllp_listener.listener_script.text.desc | If specified, provides a script containing callback functions that are executed to enhance the processing logic for the endpoint. See <a href="/docs/hl7_v2x_support/inbound_hl7v2.html#callback-scripts">Scripted Processing Mode</a> for more information. |
| module_config.hl7v2_mllp_listener.port | HL7 v2.x Listener Port |
| module_config.hl7v2_mllp_listener.port.desc | The TCP port on which this module listens. |
| module_config.hl7v2_mllp_listener.socket_timeout.millis | Socket Timeout (Millis) |
| module_config.hl7v2_mllp_listener.socket_timeout.millis.desc | The number of milliseconds that this port should block on read/write operations before flagging an error and aborting. |
| module_config.hl7v2_mllp_listener.transport | Transport Protocol |
| module_config.hl7v2_mllp_listener.transport.desc | Specifies the transport used to send HL7 v2.x messages to Smile CDR. Note that most existing systems will send the MLLP protocol unless specifically configured otherwise. |
| module_config.hl7v2_mllp_listener.unprocessable_message_handling | Unprocessable Message Handling |
| module_config.hl7v2_mllp_listener.unprocessable_message_handling.desc | This setting controls how the HL7 v2.x listening endpoint should respond when a message can not be processed (e.g. due to the message being invalid, business rule failures, conversion failures, etc.). This setting does not affect behavior when Smile CDR experiences internal errors such as database connectivity failures. |
| module_config.hl7v2_mllp_sender.delay_between_failed_deliveries.millis | Delay Between Failed Deliveries (millis) |
| module_config.hl7v2_mllp_sender.delay_between_failed_deliveries.millis.desc | If set to a number above 0, sets the minimum number of milliseconds to wait after a failed delivery attempt before trying again. |
| module_config.hl7v2_mllp_sender.host | HL7 v2.x Destination Host |
| module_config.hl7v2_mllp_sender.host.desc | The TCP hostname to which this module will transmit. |
| module_config.hl7v2_mllp_sender.map_identifiers_using_namingsystem | Map Identifiers using NamingSystem |
| module_config.hl7v2_mllp_sender.map_identifiers_using_namingsystem.desc | If enabled, the FHIR -> HL7 v2.x mapper will attempt to use NamingSystem resources stored in the repository when mapping identifiers. See <a href="/docs/hl7_v2x_support/namingsystem_mapping.html">NamingSystem Mapping</a> for information on this process. |
| module_config.hl7v2_mllp_sender.path | Request Path |
| module_config.hl7v2_mllp_sender.path.desc | The path to transmit messages to. Note that this applies only to HTTP transports and will be ignored for MLLP transports. |
| module_config.hl7v2_mllp_sender.port | HL7 v2.x Destination Port |
| module_config.hl7v2_mllp_sender.port.desc | The TCP port to which this module will transmit. |
| module_config.hl7v2_mllp_sender.retry_message_on_nak | Retry message on NAK |
| module_config.hl7v2_mllp_sender.retry_message_on_nak.desc | If the receiving system responds with a non-positive acknowledgement message (e.g an ACK message with an <code>AE</code> response code), should we attempt to redeliver the message until we are successful? |
| module_config.hl7v2_mllp_sender.send_timeout.millis | Send Timeout (millis) |
| module_config.hl7v2_mllp_sender.send_timeout.millis.desc | The number of milliseconds to wait for a response before timing out. |
| module_config.hl7v2_mllp_sender.transport | Transport Protocol |
| module_config.hl7v2_mllp_sender.transport.desc | Specifies the transport to use when sending HL7 v2.x messages. Note that most existing systems expect the MLLP protocol unless specifically configured otherwise. |
| module_config.hl7v2_mllp_sender.use_persisted_message_headers | Use Persisted Message Headers |
| module_config.hl7v2_mllp_sender.use_persisted_message_headers.desc | If enabled, this setting causes the FHIR -> HL7 v2.x mapper to attempt to load a MessageHeader resource from FHIR Storage for use in populating the MSH segment on the generated HL7 v2.x message. |
| module_config.hl7v2_out_mapper_script.mapper_script.file | HL7 v2.x Conversion Mapper Script (File) |
| module_config.hl7v2_out_mapper_script.mapper_script.file.desc | If set, supplies a JavaScript callback function that will be used to perform conversions on HL7 v2.x messages being transmitted. See <a href="/docs/hl7_v2x_support/outbound_hl7v2.html#enriching-conversion">Enriching Message Conversion using Scripts</a> for information on how these scripts work. Values should be prefixed with <code>file:</code> or <code>classpath:</code>. |
| module_config.hl7v2_out_mapper_script.mapper_script.text | HL7 v2.x Conversion Mapper Script (Text) |
| module_config.hl7v2_out_mapper_script.mapper_script.text.desc | If set, supplies a JavaScript callback function that will be used to perform conversions on HL7 v2.x messages being transmitted. See <a href="/docs/hl7_v2x_support/outbound_hl7v2.html#enriching-conversion">Enriching Message Conversion using Scripts</a> for information on how these scripts work. |
| module_config.hybrid_providers_endpoint.definitions.fhir_version | FHIR Version |
| module_config.hybrid_providers_endpoint.definitions.fhir_version.desc | The version of FHIR that the this endpoint will expose |
| module_config.hybrid_providers_endpoint.definitions.spring_context_config.class | Spring Context Config Class |
| module_config.hybrid_providers_endpoint.definitions.spring_context_config.class.desc | This is the classname for a Spring Annotation-based Context Config which will be used to create the resource providers |
| module_config.kafka.ack_mode | Kafka Consumer Ack Mode |
| module_config.kafka.ack_mode.desc | Kafka consumer listener container offset commit behavior. This value is only used if Kafka Auto Commit is false. By default, cdr kafka consumers manually acknowledge every successful message processing back to the Kafka broker. This ensures that no message is ever processed twice. However it adds processing overhead. If downstream consumers can process the same message twice, then it is recommended to set kafka.auto_commit to true (in which case the kafka.ack_mode property will be ignored). See <a href="https://docs.spring.io/spring-kafka/reference/html/#committing-offsets">Committing Offsets</a> for a list of options. |
| module_config.kafka.auto_commit | Kafka Consumer Auto Commit Enabled |
| module_config.kafka.auto_commit.desc | If this property is set to true, Kafka auto-commits the offsets according to its configuration. If it is false, the Kafka Consumer Ack Mode is used to determine commit behavior. See <a href="https://docs.spring.io/spring-kafka/reference/html/#committing-offsets">Committing Offsets</a> |
| module_config.kafka.bootstrap_address | Kafka Bootstrap Address |
| module_config.kafka.bootstrap_address.desc | This is a comma-separated list of host and port pairs that are the addresses of the Kafka brokers in a "bootstrap" Kafka cluster that a Kafka client connects to initially to bootstrap itself. |
| module_config.kafka.consumer.properties.file | Kafka Consumer Config Properties (File) |
| module_config.kafka.consumer.properties.file.desc | If set, the <a href="https://kafka.apache.org/documentation/#consumerconfigs">Kafka Consumer Config</a> properties listed in this file are used by all Kafka Consumers |
| module_config.kafka.consumer.properties.text | Kafka Consumer Config Properties (Text) |
| module_config.kafka.consumer.properties.text.desc | If set, the <a href="https://kafka.apache.org/documentation/#consumerconfigs">Kafka Consumer Config</a> properties provided here are used by all Kafka Consumers |
| module_config.kafka.group_id | Kafka Subscription Matcher Consumer Group Id |
| module_config.kafka.group_id.desc | The name of the kafka consumer group id used by all Kafka subscription consumers. |
| module_config.kafka.producer.properties.file | Kafka Producer Config Properties (File) |
| module_config.kafka.producer.properties.file.desc | If set, the <a href="https://kafka.apache.org/documentation/#producerconfigs">Kafka Producer Config</a> properties listed in this file are used by all Kafka Producers |
| module_config.kafka.producer.properties.text | Kafka Producer Config Properties (Text) |
| module_config.kafka.producer.properties.text.desc | If set, the <a href="https://kafka.apache.org/documentation/#producerconfigs">Kafka Producer Config</a> properties provided here are used by all Kafka Producers |
| module_config.kafka.sasl.jaas.config | Kafka SASL JAAS Config |
| module_config.kafka.sasl.jaas.config.desc | If the Kafka Security Protocol is set to use SASL, specifies the associated JAAS configuration string. |
| module_config.kafka.sasl.mechanism | Kafka SASL Mechanism |
| module_config.kafka.sasl.mechanism.desc | If the Kafka Security Protocol is set to use SASL, specifies the associated mechanism to use. |
| module_config.kafka.security.protocol | Kafka Security Protocol |
| module_config.kafka.security.protocol.desc | The Kafka Security Protocol to use. |
| module_config.kafka.ssl.enabled | Kafka Broker SSL Enabled |
| module_config.kafka.ssl.enabled.desc | Enable this if your Kafka Broker requires SSL |
| module_config.kafka.ssl.key.password | Kafka SSL Key Password |
| module_config.kafka.ssl.key.password.desc | The Password for your SSL Key |
| module_config.kafka.ssl.keystore.location | Kafka SSL Keystore Location |
| module_config.kafka.ssl.keystore.location.desc | The location on disk of your Kafka keystore file |
| module_config.kafka.ssl.keystore.password | Kafka Keystore Password |
| module_config.kafka.ssl.keystore.password.desc | The password of your SSL Keystore file |
| module_config.kafka.ssl.truststore.location | Kafka SSL TrustStore File Location |
| module_config.kafka.ssl.truststore.location.desc | The location on disk of your kafka <a href="/docs/product_configuration/tls_https.html#truststores-and-keystores">TrustStore</a> file |
| module_config.kafka.ssl.truststore.password | Kafka SSL Truststore Password |
| module_config.kafka.ssl.truststore.password.desc | The password of your SSL Truststore file |
| module_config.kafka.validate_topics_exist_before_use | Validate Kafka Topics Exist Before Use |
| module_config.kafka.validate_topics_exist_before_use.desc | Set this to true if your Kafka broker is configured to prevent new topics from being automatically created (e.g. if 'auto.create.topics.enable' is set to false on the broker). When this property is set to true, Smile will prevent subscriptions from being created or updated if the delivery topic they depend on doesn't exist yet. |
| module_config.metadata.resource_counts.cache.minutes | Cache Resource Counts (Mins) |
| module_config.metadata.resource_counts.cache.minutes.desc | If set, resource counts will be cached for up to this amount of time. |
| module_config.metadata.resource_counts.enabled | Include Resource Counts |
| module_config.metadata.resource_counts.enabled.desc | If enabled, the server <code>CapabilityStatement</code> (i.e. the <code>/metadata</code> response on a FHIR endpoint) will have counts for all of the individual resource types added as extensions. These counts are displayed in the FHIRWeb Console, and they can be used by client applications. |
| module_config.mongo.db.password | Database Password |
| module_config.mongo.db.password.desc | Password for the database. (Optional) |
| module_config.mongo.db.url | Database Connection URL |
| module_config.mongo.db.url.desc | Mongo Connection URL for the database. (ex. "mongodb://localhost:27017/databaseName") |
| module_config.mongo.db.username | Database Username |
| module_config.mongo.db.username.desc | Username for the database. (Optional) |
| module_config.mongo.fhir_version | FHIR Version |
| module_config.mongo.fhir_version.desc | The version of FHIR to support in this module |
| module_config.narrative_generator.manifest_file | Narrative Template Manifest File |
| module_config.narrative_generator.manifest_file.desc | Specifies the filename to use for the narrative template manifest. |
| module_config.openid.signing.jwks_file | Signing JWKS (File) |
| module_config.openid.signing.jwks_file.desc | This is the file/resource path to use to load a JWKS (JSON Web KeySet) file that is used for signing OpenID Connect tokens. Generally, the format should be <code>classpath:/filename.jwks</code> for a file placed in the Smile CDR <code>classes</code> directory. Note that a JWKS must be provided in <strong>either</strong> <em>File</em> or <em>Text</em> format, not both. |
| module_config.openid.signing.jwks_text | Signing JWKS (Text) |
| module_config.openid.signing.jwks_text.desc | This is a string containing a raw JSON JWKS (JSON Web KeySet) file that is used for signing OpenID Connect tokens. Note that a JWKS must be provided in <strong>either</strong> <em>File</em> or <em>Text</em> format, not both. |
| module_config.openid.signing.key_id | Signing Key ID |
| module_config.openid.signing.key_id.desc | This is the ID of the key to use in the JWKS file when signing OpenID Connect tokens. This setting is optional. If no value is provided, the first key in the JWKS file will be used. |
| module_config.package_registry.requires.PACKAGE_CACHE | The package storage engine that this endpoint connects to. |
| module_config.persistence.binary_storage.access_operations.enabled | Binary Access Operations Enabled |
| module_config.persistence.binary_storage.access_operations.enabled.desc | This setting enables the binary access read/write operations. See <a href="/docs/fhir_repository/binary_data.html#binary-access-operations">Binary Access Operations</a> for more information. |
| module_config.persistence.binary_storage.filesystem.directory | Filesystem Mode: Base Directory |
| module_config.persistence.binary_storage.filesystem.directory.desc | When operating in <code>FILESYSTEM</code> binary storage mode, this setting provides the base path in which to store large binary objects. |
| module_config.persistence.binary_storage.mode | Binary Storage Mode |
| module_config.persistence.binary_storage.mode.desc | This setting sets a storage mechanism for large binary objects. See <a href="/docs/fhir_repository/binary_data.html#externalized-binary-storage">Externalized Binary Storage</a> for more information. |
| module_config.persistence.binary_storage.size.max | Maximum Size (bytes) |
| module_config.persistence.binary_storage.size.max.desc | This setting provides the maximum size of a binary object to be stored in binary storage. Binaries larger than this cutoff will be rejected and may not be stored. |
| module_config.persistence.binary_storage.size.min | Minimum Size (bytes) |
| module_config.persistence.binary_storage.size.min.desc | This setting provides the minimum size of a binary object before it is stored in binary storage. Any binaries smaller than this size will still be stored, but may be stored inline within resource bodies as base 64 encoded content. |
| module_config.persistence.bulk_export.enabled | FHIR Bulk Export Enabled |
| module_config.persistence.bulk_export.enabled.desc | If enabled, this server will support the FHIR Bulk Export protocol. See <a href="/docs/bulk/fhir_bulk_export.html">FHIR Bulk Export</a> for more information. |
| module_config.persistence.callback_script.file | FHIR storage Callback Script (File) |
| module_config.persistence.callback_script.file.desc | If set, supplies a callback function that will be executed. This script allows JavaScript-based interceptors to be written and inject logic into the server. Values should be prefixed with <code>file:</code> or <code>classpath:</code>. |
| module_config.persistence.callback_script.text | FHIR storage Callback Script (Text) |
| module_config.persistence.callback_script.text.desc | If set, supplies a callback function that will be executed. This script allows JavaScript-based interceptors to be written and inject logic into the server. |
| module_config.persistence.cascading_delete.enabled | Cascading Deletes Enabled |
| module_config.persistence.cascading_delete.enabled.desc | Enable this setting to permit cascading deletes across resource references. See <a href="/docs/fhir_repository/deleting_data.html#cascading-deletes">Cascading Deletes</a> for more information. |
| module_config.persistence.consent_service.enabled | Consent Service Enabled |
| module_config.persistence.consent_service.enabled.desc | This is a global switch to enable or disable the consent service. |
| module_config.persistence.consent_service.script.file | Consent Service Script (File) |
| module_config.persistence.consent_service.script.file.desc | If set, supplies a set of callback functions that will be executed for the consent service. |
| module_config.persistence.consent_service.script.text | Consent Service Script (Text) |
| module_config.persistence.consent_service.script.text.desc | If set, supplies a set of callback functions that will be executed for the consent service. |
| module_config.persistence.dao_config.allow_contains_searches | Allow :contains Searches |
| module_config.persistence.dao_config.allow_contains_searches.desc | If set to <code>true</code>, clients will be permitted to use the <code>:contains</code> modifier on String searches. This is a potentially slow operation so enable with caution. |
| module_config.persistence.dao_config.allow_external_references.enabled | Allow External References Enabled |
| module_config.persistence.dao_config.allow_external_references.enabled.desc | If enabled, the server will allow resources to have references to external servers. This means (for example) that with this setting enabled, a Patient could be uploaded containing a reference to Organization <code>http://example.com/fhir/Organization/123</code>. With this setting disabled, only relative references (e.g. <code>Organization/123</code> or absolute references corresponding to the base URL of the server are allowed. |
| module_config.persistence.dao_config.allow_inline_match_url_references.enabled | Allow Inline Match URL References Enabled |
| module_config.persistence.dao_config.allow_inline_match_url_references.enabled.desc | If enabled, references containing match URLs will be resolved and replaced in <code>create</code> and <code>update</code> operations. For example, if a Patient is created, and the <code>Patient.managingOrganization</code> is set to a value of <code>Organization?identifier=123</code>, the server will resolve this search and replace the search URL with a correct reference before the resource is saved. Note that this search is not subjected to any security or access control checks, so this feature has potential security implications. Enable with caution. |
| module_config.persistence.dao_config.allow_multiple_delete.enabled | Allow Multiple Delete Enabled |
| module_config.persistence.dao_config.allow_multiple_delete.enabled.desc | If enabled, the server will allow <code>delete</code> operations that match more than one resource. For example, if this is enabled and a <code>delete</code> is issued for <code>Patient?name=smith</code> then multiple <code>Patient</code> resources named "smith" can be deleted. If this setting is disabled, the delete will only be allowed when only one <code>Patient</code> named "smith" exists. Enabling this setting can be convenient but it increases the possibility of accidental bulk deletion. |
| module_config.persistence.dao_config.allow_storing_all_bundle_types | Allow storing all bundle types |
| module_config.persistence.dao_config.allow_storing_all_bundle_types.desc | If enabled, all Bundle types may be stored. By default with this setting disabled, only Bundle types such as <code>document</code>, <code>message</code> and <code>collection</code> are permitted for storage. |
| module_config.persistence.dao_config.auto_create_placeholder_reference_targets.enabled | Auto-Create Placeholder Reference Targets |
| module_config.persistence.dao_config.auto_create_placeholder_reference_targets.enabled.desc | If this setting is enabled and a resource is created with a reference to a non-existing resource (e.g. <code>Patient/FOO</code> if that patient does not exist on the server), the server will automatically create an empty placeholder resource to satisfy this reference. See <a href="/docs/fhir_repository/creating_data.html#auto-create-placeholder-reference-targets">Auto-Create Placeholder Reference Targets</a> for more information. |
| module_config.persistence.dao_config.client_id_mode | Client ID Mode |
| module_config.persistence.dao_config.client_id_mode.desc | This setting controls whether clients may create resources with IDs assigned by the client, and what types of IDs are acceptable. By default, clients may only supply IDs containing at least one letter. See <a href="/docs/fhir_repository/resource_ids.html#client-assigned-ids">Client Assigned IDs</a> for more information. |
| module_config.persistence.dao_config.default_total_mode | Default Total Calculation Mode |
| module_config.persistence.dao_config.default_total_mode.desc | This setting may be used to force the calculation of the total number of results when large searches are performed. This setting can have an impact on performance, since calculating the total can mean an extra (potentially expensive) database query. |
| module_config.persistence.dao_config.delete_child_resource.count | Delete Child Resource Count |
| module_config.persistence.dao_config.delete_child_resource.count.desc | This setting determines the maximum number of child resources that should be processed during each pass of a cascading delete. May need to be increased if deleting resources with large numbers of child resources. |
| module_config.persistence.dao_config.delete_enabled | Delete Enabled |
| module_config.persistence.dao_config.delete_enabled.desc | If set to false, deletes will not be supported on this server. This should be disabled if the server does not need to support any resource deletion, as it improves performance by reducing the number of deletion checks performed during write operations. |
| module_config.persistence.dao_config.delete_expunge_enabled | Delete Expunge Enabled |
| module_config.persistence.dao_config.delete_expunge_enabled.desc | If set to true (default is false), the _expunge parameter on the DELETE operation will be enabled on this server. DELETE _expunge removes all data associated with a resource in a highly performant way, skipping most of the the checks that are enforced with usual DELETE operations. The only check that is performed before deleting the resources and their indexes is that no other resources reference the resources about to be deleted. This operation is potentially dangerous since it allows a client to physically delete data in a way that can not be recovered (without resorting to backups). |
| module_config.persistence.dao_config.enforce_reference_target_types | Enforce Reference Target Types |
| module_config.persistence.dao_config.enforce_reference_target_types.desc | If this setting is disabled, references in resources being persisted will not be validated to ensure that the target of the reference is a valid resource type for the field containing the reference. This should generally be left enabled, but can be useful in cases where a nonstandard reference is needed. |
| module_config.persistence.dao_config.enforce_referential_integrity_on_delete.disable_for_paths | Disable Deletion Ref Checks for Paths |
| module_config.persistence.dao_config.enforce_referential_integrity_on_delete.disable_for_paths.desc | If referential integrity checking is enabled for deletes, this setting may be used to selectively disable this checking only for specific paths. This setting takes one or more FHIRPath expressions, each one on a new line. See <a href="/docs/fhir_repository/deleting_data.html#referential-integrity">Referential Integrity</a> for more information. |
| module_config.persistence.dao_config.enforce_referential_integrity_on_delete.enabled | Enforce Referential Integrity on Delete |
| module_config.persistence.dao_config.enforce_referential_integrity_on_delete.enabled.desc | If disabled, resources may be deleted even if they are referenced by other resources. This property can cause confusing results for clients of the server since searches, includes, and other FHIR features may not behave as expected when referential integrity is not preserved. <p><b>Disable with caution.</b></p> |
| module_config.persistence.dao_config.enforce_referential_integrity_on_write.enabled | Enforce Referential Integrity on Write |
| module_config.persistence.dao_config.enforce_referential_integrity_on_write.enabled.desc | If disabled, resources may be created or updated even if they contain references to local resources that do not exist. For example, if a patient contains a reference to managing organization <code>Organization/FOO</code> but <code>FOO</code> is not a valid ID for an organization on the server then the operation will be blocked unless this property has been disabled. This property can cause confusing results for clients of the server since searches, includes, and other FHIR features may not behave as expected when referential integrity is not preserved. In particular, <b>resource references to target resources that do not exist at the time that the source resource is created will not be indexed</b>, even if the target resource is created later. <p><b>Disable with caution.</b></p> |
| module_config.persistence.dao_config.expire_search_results_after_minutes | Expire Search Results After Minutes |
| module_config.persistence.dao_config.expire_search_results_after_minutes.desc | The number of minutes that search results for a given client search should be preserved before being purged from the database. See <a href="/docs/fhir_repository/performance_and_caching.html">Caching Results</a> for more information. |
| module_config.persistence.dao_config.expunge_batch_size | Expunge Batch Size |
| module_config.persistence.dao_config.expunge_batch_size.desc | The expunge batch size determines the number of records deleted within a single transaction by the expunge operation. |
| module_config.persistence.dao_config.expunge_operation_enabled | Expunge Operation Enabled |
| module_config.persistence.dao_config.expunge_operation_enabled.desc | Enabling this setting allows the <a href="/docs/fhir_repository/deleting_data.html#expunge">Expunge Operation</a> (<code>$expunge</code>) to be performed by users with appropriate permission. Expunge is a dangerous operation so it is disabled by default. |
| module_config.persistence.dao_config.expunge_thread_count | Expunge Thread Count |
| module_config.persistence.dao_config.expunge_thread_count.desc | This setting controls the number of threads allocated to the expunge operation |
| module_config.persistence.dao_config.fetch_size.default_maximum | Fetch Size (Default Maximum) |
| module_config.persistence.dao_config.fetch_size.default_maximum.desc | If set, this value determines the maximum number of results that may be returned by a single search. Setting this value to a sensible value for the anticipated usage of the CDR can help to prevent careless queries that exhaust resources on the server. |
| module_config.persistence.dao_config.mark_resources_for_reindexing_after_sp_change | Mark Resources for Reindexing after SearchParameter change |
| module_config.persistence.dao_config.mark_resources_for_reindexing_after_sp_change.desc | If enabled, the repository will automatically mark any resources which are potentially affected by a SearchParameter for reindexing when any SearchParameter is modified. This is generally desirable on new servers, but can can be problematic on servers with a large amount of existing data. |
| module_config.persistence.dao_config.maximum_transaction_bundle_size | Maximum Transaction Bundle Size |
| module_config.persistence.dao_config.maximum_transaction_bundle_size.desc | Specifies the maximum number of resources permitted within a single transaction bundle. If a transaction bundle is submitted with more than this number of resources, it will be rejected with a PayloadTooLarge exception. If blank, there is no limit. |
| module_config.persistence.dao_config.reindex_thread_count | Reindex Thread Count |
| module_config.persistence.dao_config.reindex_thread_count.desc | This setting controls the number of threads allocated to resource reindexing (which is only ever used if SearchParameters change, or a manual reindex is triggered due to a Smile CDR upgrade or some other reason). |
| module_config.persistence.dao_config.reuse_cached_results_timeout_millis | Reuse Cached Results Timeout (Millis) |
| module_config.persistence.dao_config.reuse_cached_results_timeout_millis.desc | If set, any searches repeated during this period for the exact same criteria will reuse the same search results instead of performing a new search. Set this value to <code>0</code> to disable the query cache entirely or set to a positive number of milliseconds to specify a specific timeout. See <a href="/docs/fhir_repository/performance_and_caching.html#the-query-cache" target="_blank">The Query Cache</a> for more information. |
| module_config.persistence.dao_config.server_id_mode | Server ID Mode |
| module_config.persistence.dao_config.server_id_mode.desc | This setting controls how IDs are generated by the server for newly created resources. By default, each newly created resource will receive a sequential numeric ID but this behaviour can be changed. See <a href="/docs/fhir_repository/resource_ids.html#server-assigned-ids">Server Assigned IDs</a> for more information. |
| module_config.persistence.dao_config.store_source_information | Store Meta.source information |
| module_config.persistence.dao_config.store_source_information.desc | If enabled, values from Resource.meta.source will be stored and indexed. This may be disabled in order to save space and improve write efficiency. |
| module_config.persistence.dao_config.use_2020_new_search_builder | Use New Search SQL Builder (2020) |
| module_config.persistence.dao_config.use_2020_new_search_builder.desc | Smile CDR 2020.11 introduced a new SQL generator for FHIR search operations. This generator creates more streamlined SQL and can dramatically improve performance in some cases. This new feature must be manually enabled in Smile CDR 2020.11 but this flag (and the legacy generator) will likely be removed in Smile CDR 2021.02. |
| module_config.persistence.dao_config.use_ordinal_dates_for_day_precision_searches | Use ordinal date values for day precision searches. |
| module_config.persistence.dao_config.use_ordinal_dates_for_day_precision_searches.desc | If enabled, causes date search params with DAY precision to rely on the ordinal versions of the dates. |
| module_config.persistence.db.connectionpool.default_query_timeout_seconds | Default Query Timeout (Seconds) |
| module_config.persistence.db.connectionpool.default_query_timeout_seconds.desc | This setting is the maximum number of seconds that a query may run before being automatically aborted by the database. This setting is a failsafe to prevent overly taxing searches from dominating the database. |
| module_config.persistence.db.connectionpool.maxidle | Max Idle Connections |
| module_config.persistence.db.connectionpool.maxidle.desc | The maximum number of idle connections to keep in the database connection pool at any given time. |
| module_config.persistence.db.connectionpool.maxlifetime.millis | Connection Max Lifetime (millis) |
| module_config.persistence.db.connectionpool.maxlifetime.millis.desc | If set, provides the maximum total number of milliseconds that a connection is allowed to live. Any connections that are open for longer will be closed instead of being reused. Note that this setting applies only to idle connections in the pool, it does not affect active database operations even if the timeout is exceeded. |
| module_config.persistence.db.connectionpool.maxtotal | Max Total Connections |
| module_config.persistence.db.connectionpool.maxtotal.desc | The maximum total number of connections to allow the database connection pool to hold at any given time. Set this value carefully as it may negatively impact database performance when set too low or too high. |
| module_config.persistence.db.connectionpool.maxwait_seconds | Max Wait (Seconds) |
| module_config.persistence.db.connectionpool.maxwait_seconds.desc | The maximum number of seconds that a request should wait for a database connection before timing out and aborting. |
| module_config.persistence.db.connectionpool.minidle | Min Idle Connections |
| module_config.persistence.db.connectionpool.minidle.desc | The minimum number of idle connections to keep in the database connection pool at any given time. |
| module_config.persistence.db.connectionpool.pool_prepared_statements | Pool Prepared Statements |
| module_config.persistence.db.connectionpool.pool_prepared_statements.desc | If enabled, prepared statements will be pooled by the connection pool. Note that when using schema-based multitenancy, Smile CDR may choose to ignore this setting. |
| module_config.persistence.db.hibernate_search.elasticsearch.password | ElasticSearch Password |
| module_config.persistence.db.hibernate_search.elasticsearch.password.desc | The password to use for connections to the ElasticSearch cluster. |
| module_config.persistence.db.hibernate_search.elasticsearch.url | ElasticSearch URL |
| module_config.persistence.db.hibernate_search.elasticsearch.url.desc | The connection URL to use for connections to the ElasticSearch cluster. |
| module_config.persistence.db.hibernate_search.elasticsearch.username | ElasticSearch Username |
| module_config.persistence.db.hibernate_search.elasticsearch.username.desc | The username to use for connections to the ElasticSearch cluster. |
| module_config.persistence.db.hibernate_search.index.fulltext_content | Enable FullText Content Index |
| module_config.persistence.db.hibernate_search.index.fulltext_content.desc | Should the system index FullText Content on the resources stored in the repository. See <a href="/docs/fhir_repository/lucene.html#indexes">Indexes</a> for more information. |
| module_config.persistence.db.hibernate_search.index.terminology | Enable Terminology Index |
| module_config.persistence.db.hibernate_search.index.terminology.desc | Should the system index terminology (i.e. CodeSystem) content in the Lucene Index. See <a href="/docs/fhir_repository/lucene.html#indexes">Indexes</a> for more information. |
| module_config.persistence.db.hibernate_search.mode | Lucene Indexing Provider |
| module_config.persistence.db.hibernate_search.mode.desc | Specifies which provider will be used. See <a href="/docs/fhir_repository/lucene.html#lucene-providers">Lucene Providers</a> for information on the available options. |
| module_config.persistence.db.sql_parameter_bind_mode | SQL Parameter Bind Mode |
| module_config.persistence.db.sql_parameter_bind_mode.desc | Specifies whether parameters in SQL statements should be inlined or bound to parameters. |
| module_config.persistence.db_driver | Database Type |
| module_config.persistence.db_driver.desc | The database platform being used. |
| module_config.persistence.db_driver.extended | The database platform being used. Smile CDR supports several relational database platforms for persistence so this setting selects the dialect that is specific to the platform being used.<br/><br/>For example, if you are using Postgres 9.4, select the <code>POSTGRES_9_4</code> dialect. |
| module_config.persistence.db_password | Database Password |
| module_config.persistence.db_password.desc | Password for the persistence database. |
| module_config.persistence.db_schema_update_mode | Database Update Mode |
| module_config.persistence.db_schema_update_mode.desc | Controls whether Smile CDR should attempt to update the FHIR storage database schema on startup. If the database schema is out of date, Smile CDR automatically run migration on the FHIR storage schema at startup if the value is "UPDATE" If the value is "NONE", then Smile CDR will abort starting the FHIR storage module if its schema is out of date. When set to "NONE", you should use the "smileutil migrate" command to upgrade the database manually. |
| module_config.persistence.db_url | Database Connection URL |
| module_config.persistence.db_url.desc | JDBC Connection URL for the persistence database. |
| module_config.persistence.db_url.extended | JDBC Connection URL for the persistence database.<br/><br/>The following examples show JDBC URLs for a few different database platforms:<ul><li><b>Derby Filesystem</b>: <code>jdbc:derby:directory:target/testDatabase;create=true</code></li><li><b>Postgresql</b>: <code>jdbc:postgresql://localhost/cdr</code></li><li><b>MariaDB</b>: <code>jdbc:mariadb://localhost:3306/cdr</code></li></ul> |
| module_config.persistence.db_username | Database Username |
| module_config.persistence.db_username.desc | Username for the persistence database. |
| module_config.persistence.empi.enabled | EMPI Mode Enabled (Experimental) |
| module_config.persistence.empi.enabled.desc | If enabled, this storage module will operate in <a href="/docs/empi/empi.html">EMPI Mode</a>. |
| module_config.persistence.filter_search.enabled | Filter Search Parameter Enabled |
| module_config.persistence.filter_search.enabled.desc | This setting enables the <code>_filter</code> search parameter. Filter is a standard FHIR search parameter that can be used to narrow down the scope of a search. |
| module_config.persistence.fulltext_delay_seconds | FullText Index Delay (Secs) |
| module_config.persistence.fulltext_delay_seconds.desc | Specify how long to wait after a resource is updated before beginning a fulltext index pass across the cluster. This setting is necessary in order to prevent errors caused by clock skew between nodes in the cluster. |
| module_config.persistence.fulltext_index_pass_size | FullText Indexing Pass Size |
| module_config.persistence.fulltext_index_pass_size.desc | The number of resources to index in a single fulltext indexing pass. |
| module_config.persistence.graphql.enabled | GraphQL Enabled |
| module_config.persistence.graphql.enabled.desc | If enabled, endpoints configured against this storage module will support GraphQL Queries. |
| module_config.persistence.hibernate_search_directory | Lucene Index Directory |
| module_config.persistence.hibernate_search_directory.desc | This is the local directory where Lucene will put its index files when operating in <code>LUCENE_DISK</code> mode. This can be an absolute path, or a relative path (treated as relative to the base of the Smile CDR installation). |
| module_config.persistence.hibernate_search_memory | |
| module_config.persistence.indexing.index_missing_search_params | Index Missing Search Params |
| module_config.persistence.indexing.index_missing_search_params.desc | If disabled, the FHIR endpoint will not support <code>:missing</code> modifiers on searches. Disabling this feature causes fewer index rows to be generated in the database when persisting resources. Note that enabling this feature this can negatively impact write performance, perticularly on systems with a large number of search parameters enabled. |
| module_config.persistence.interceptor_bean_types | Interceptor Bean Types |
| module_config.persistence.interceptor_bean_types.desc | A comma-separated list of bean classes to register as HAPI FHIR Interceptors against the persistence module. |
| module_config.persistence.livebundle_service.enabled | LiveBundle Enabled |
| module_config.persistence.livebundle_service.enabled.desc | Enable LiveBundle rule-based reference caching. Experimental new feature under development. |
| module_config.persistence.livebundle_service.script.file | LiveBundle Rule Definition Script (File) |
| module_config.persistence.livebundle_service.script.file.desc | If set, supplies the absolute filepath of a file containing a set of LiveBundle rules used by the LiveBundle service. Values should be prefixed with <code>file:</code> or <code>classpath:</code>. |
| module_config.persistence.livebundle_service.script.text | LiveBundle Rule Definition Script (Text) |
| module_config.persistence.livebundle_service.script.text.desc | If set, supplies a set of LiveBundle rules used by the LiveBundle service. |
| module_config.persistence.livebundle_service.threadcount | LiveBundle Thread Count |
| module_config.persistence.livebundle_service.threadcount.desc | Parallelism of resource inflation for large bundles. Experimental new feature under development. |
| module_config.persistence.livebundle_service.watchlist_cache.enabled | LiveBundle Watchlist Cache Enabled |
| module_config.persistence.livebundle_service.watchlist_cache.enabled.desc | Cache Watchlist subscriptions in memory--improves performance of the LiveBundle interceptor. However, if a new resource arrives for a watchlist subscriber within 1 minute of that subscriber being added to the watchlist, that resource may be missed from that subscriber's bundle. |
| module_config.persistence.lucene.enabled | Lucene Indexing Enabled |
| module_config.persistence.lucene.enabled.desc | If enabled, Lucene will be used for indexing (default is disabled). Lucene can be used to provide fulltext searching, and enhances the capabilities of the Smile CDR Terminology Services. |
| module_config.persistence.package_registry.startup_installation_specs | Package Pre-Seed Installation Spec Files |
| module_config.persistence.package_registry.startup_installation_specs.desc | This setting takes a whitespace separated list of paths to Package Installation Specification files. See <a href="/docs/fhir_repository/packages_and_igs.html#pre-seed">Package Pre-Seed Installation</a> for more information. |
| module_config.persistence.page_size.default | Page Size (Default) |
| module_config.persistence.page_size.default.desc | This value sets the default page size for <code>Bundle</code> results of search and history operations. |
| module_config.persistence.page_size.maximum | Page Size (Maximum) |
| module_config.persistence.page_size.maximum.desc | This value sets the maximum page size for <code>Bundle</code> results of search and history operations. Client requests for values larger than this will be automatically overridden by the server to use this value. |
| module_config.persistence.partitioning.cross_partition_reference_mode | Cross-Partition Reference Mode |
| module_config.persistence.partitioning.cross_partition_reference_mode.desc | If enabled, references between resources in different partitions are allowed under certain circumstances. See <a href="/docs/fhir_repository/partitioning.html#cross-partition-references">Cross-Partition References</a> for more information. |
| module_config.persistence.partitioning.enabled | Partitioning Enabled |
| module_config.persistence.partitioning.enabled.desc | Enable data partitioning: If this is not enabled, all other settings in this category are ignored. |
| module_config.persistence.partitioning.partition_selection_mode | Partition Selection Mode |
| module_config.persistence.partitioning.partition_selection_mode.desc | Determines whether the request partition selection is determined from the incoming request in the FHIR Endpoint module |
| module_config.persistence.partitioning.seed.file | Partition Seed File |
| module_config.persistence.partitioning.seed.file.desc | This setting can be used to supply a set of partition definitions to seed when the server first start up. See <a href="/docs/fhir_repository/partitioning.html#seeding">Seeding Partitions</a> for more information. |
| module_config.persistence.performance_tracing.capture.raw_sql | Capture Raw SQL |
| module_config.persistence.performance_tracing.capture.raw_sql.desc | Should raw SQL statements that are sent to the database be captured? |
| module_config.persistence.performance_tracing.capture.trigger | Trigger |
| module_config.persistence.performance_tracing.capture.trigger.desc | Adjust this setting to determine which transactions are traced. |
| module_config.persistence.performance_tracing.enabled | Performance Tracing Enabled |
| module_config.persistence.performance_tracing.enabled.desc | Enable this setting in order to enable detailed performance tracing. Note that this feature has an impact on performance itself, so it should be enabled with caution on production systems. The other settings in this category will have no effect if this is not enabled. See <a href="/docs/fhir_repository/tracing_and_provenance.html#performance-tracing">Performance Tracing</a> for more information. |
| module_config.persistence.performance_tracing.output.response_headers | Output to Response Headers |
| module_config.persistence.performance_tracing.output.response_headers.desc | Should performance tracing logs be appended to the HTTP response headers? |
| module_config.persistence.performance_tracing.output.system_log | Output to System Log |
| module_config.persistence.performance_tracing.output.system_log.desc | Should performance tracing logs be appended to the <a href="/docs/logging/system_logging.html">System Logs</a>? |
| module_config.persistence.performance_tracing.output.transaction_log | Output to Transaction Log |
| module_config.persistence.performance_tracing.output.transaction_log.desc | Should performance tracing messages be appended to the <a href="/docs/logging/transaction_log.html">Transaction Log</a>? |
| module_config.persistence.realtime_export.pointcut.enabled | Pointcut-based Realtime Export Mode Enabled |
| module_config.persistence.realtime_export.pointcut.enabled.desc | If enabled, this storage module will operate in <a href="/docs/realtime_export/realtime_export_overview.html">Realtime Export Mode</a>. |
| module_config.persistence.remote_term_svc.base_url | Base URL |
| module_config.persistence.remote_term_svc.base_url.desc | The Base URL for the FHIR server containing terminology services to use for validation. |
| module_config.persistence.remote_term_svc.enabled | Remote Terminology Service - Enabled |
| module_config.persistence.remote_term_svc.enabled.desc | If enabled, a FHIR REST-based terminology service. |
| module_config.persistence.remote_term_svc.log_http_calls | Log HTTP Calls |
| module_config.persistence.remote_term_svc.log_http_calls.desc | If enabled, debugging HTTP logs for outbound terminology service calls will be added to smile.log. Note that this logging is very verbose and should only be used for troubleshooting. |
| module_config.persistence.resource_types.supported.whitelist | Resource Types (whitelist) |
| module_config.persistence.resource_types.supported.whitelist.desc | This property may be used to specify a comma-separated list of FHIR Resource types to be supported by this persistence module (e.g. <code>Patient,Encounter,Practitioner</code>). |
| module_config.persistence.search.phonetic_encoder | Phonetic Encoder |
| module_config.persistence.search.phonetic_encoder.desc | The encoder used for predefined FHIR Search Parameters named "phonetic" (e.g. the one on Patient). See <a href="/docs/fhir_repository/search_parameter_phonetic.html">Phonetic Search Parameters</a> for more information. |
| module_config.persistence.searchcache.infinispan.cache.name | Infinispan Cache Name |
| module_config.persistence.searchcache.infinispan.cache.name.desc | The name of the Infinispan Cache |
| module_config.persistence.searchcache.infinispan.protocol_version | Infinispan Hot Rod Protocol Version |
| module_config.persistence.searchcache.infinispan.protocol_version.desc | The Hot Rod Protocol Version required by your Infinispan server |
| module_config.persistence.searchcache.infinispan.servers | Infinispan Servers |
| module_config.persistence.searchcache.infinispan.servers.desc | A list of semicolon separated infinispan URLS. E.g. "localhost:11223;localhost:11224" |
| module_config.persistence.searchcache.type | Search Cache Storage |
| module_config.persistence.searchcache.type.desc | The default DATABASE maintains the fhir search result cache in the DATABASE. INFINISPAN stores the search results in an infinispan instance. |
| module_config.persistence.seed.base_validation_resources | Seed Base Validation Resources |
| module_config.persistence.seed.base_validation_resources.desc | If enabled, validation resources such as StructureDefinitions, ValueSets, and CodeSystems will be automatically seeded into the repository on startup. This can help to speed up validation and allows clients to browse these resources. |
| module_config.persistence.subscription.consumers_per_delivery_queue | Consumers Per Delivery Queue |
| module_config.persistence.subscription.consumers_per_delivery_queue.desc | The number of listener threads created per subscription. These threads deliver subscription matches to subscription endpoints. |
| module_config.persistence.subscription.consumers_per_matching_queue | Matching Queue Consumers |
| module_config.persistence.subscription.consumers_per_matching_queue.desc | The number of listener threads that match new resources against active subscriptions. |
| module_config.persistence.subscription.email.enabled | Email Subscription Enabled |
| module_config.persistence.subscription.email.enabled.desc | Requires a Subscription Matching module. If enabled, the server will activate FHIR Subscriptions with the <strong>Email</strong> channel delivery type. See <a href="/docs/subscription/introduction.html" target="_blank">Subscription</a> documentation for more information. |
| module_config.persistence.subscription.message.enabled | Message Subscription Enabled |
| module_config.persistence.subscription.message.enabled.desc | Requires a Subscription Matching module. If enabled, the server will activate FHIR Subscriptions with the <strong>Message</strong> channel delivery type. See <a href="/docs/subscription/introduction.html" target="_blank">Subscription</a> documentation for more information. |
| module_config.persistence.subscription.rest_hook.enabled | REST Hook Subscription Enabled |
| module_config.persistence.subscription.rest_hook.enabled.desc | Requires a Subscription Matching module. If enabled, the server will activate FHIR Subscriptions with the <strong>REST Hook</strong> channel delivery type. See <a href="/docs/subscription/introduction.html" target="_blank">Subscription</a> documentation for more information. |
| module_config.persistence.subscription.websocket.enabled | Websocket Subscription Enabled |
| module_config.persistence.subscription.websocket.enabled.desc | Requires a Subscription Matching module. If enabled, the server will activate FHIR Subscriptions with the <strong>Websocket</strong> channel delivery type. See <a href="/docs/subscription/introduction.html" target="_blank">Subscription</a> documentation for more information. |
| module_config.persistence.suppress_scheduled_maintenance_jobs | Suppress Scheduled Maintenance Jobs |
| module_config.persistence.suppress_scheduled_maintenance_jobs.desc | If this is enabled, no scheduled tasks will be invoked by this module. This setting is only useful in cases where multiple master FHIR Storage modules are pointed at the same database, in order to ensure that only one of them performs scheduled jobs. |
| module_config.persistence.suppress_string_indexing_in_tokens | Suppress String Indexing In Tokens |
| module_config.persistence.suppress_string_indexing_in_tokens.desc | This setting globally disables the indexing of the <code>:text</code> modifier for token search parameters. Disabling this setting can free up a lot of index space on some systems. See <a href="/docs/fhir_repository/search_parameter_features.html#text-modifier">Index Text on Tokens</a> for more information. |
| module_config.persistence.validator.local_reference_policy | Local Reference Policy |
| module_config.persistence.validator.local_reference_policy.desc | This property controls whether the validator should attempt to dereference/load resource references from the resource being validated to ensure that they exist, and are valid for the given reference. This type of validation is more thorough but also increases the time that an individual resource validation will take. See <a href="/docs/fhir_repository/validation.html#reference_validation">Validating References</a> for more information. |
| module_config.realtime_export.channel.name | Import Channel Name |
| module_config.realtime_export.channel.name.desc | If using a <code>CHANNEL</code> source, this is the name of the channel it is publishing to. If you are using <code>POINTCUT</code> as a source, this can be left blank. |
| module_config.realtime_export.script.file | Realtime Export Script (File) |
| module_config.realtime_export.script.file.desc | If set defines a set of rules to transform resources into exported rows in an external database. |
| module_config.realtime_export.script.text | Realtime Export Script (Text) |
| module_config.realtime_export.script.text.desc | If set defines a set of rules to transform resources into exported rows in an external database. |
| module_config.realtime_export.source.type | Published Data source |
| module_config.realtime_export.source.type.desc | Whether the data source is from Debezium (<code>CHANNEL</code>), or from a pointcut-based solution (<code>POINTCUT</code>). |
| module_config.security_in_ldap.authenticator.bind.user.base | Authentication: User Base DN |
| module_config.security_in_ldap.authenticator.bind.user.base.desc | When authenticating users, this is the base DN used to attempt to bind the user. |
| module_config.security_in_ldap.authenticator.bind.user.query | Authentication: User Query |
| module_config.security_in_ldap.authenticator.bind.user.query.desc | This query is used to locate the authenticating user in order to attempt a bind. |
| module_config.security_in_ldap.authenticator.require_group_membership.dn | Require Group DN |
| module_config.security_in_ldap.authenticator.require_group_membership.dn.desc | If set, specifies the DN for a required group. Any authenticating users will only be permitted to authenticate if they are a member of this group. |
| module_config.security_in_ldap.groups.basedn | Base DN for Groups |
| module_config.security_in_ldap.groups.basedn.desc | The DN to use when searching for groups. |
| module_config.security_in_ldap.groups.search_recursively | Search Groups Recursively |
| module_config.security_in_ldap.groups.search_recursively.desc | If enabled, searching for groups will occur at any level below the value of <code>groups.basedn</code> and not just directly under that level. |
| module_config.security_in_ldap.ldap.systemuser.dn | System User DN |
| module_config.security_in_ldap.ldap.systemuser.dn.desc | The identity for the user account that Smile CDR will use for system operations. |
| module_config.security_in_ldap.ldap.systemuser.password | System User Password |
| module_config.security_in_ldap.ldap.systemuser.password.desc | The password for the user account that Smile CDR will use for system operations. |
| module_config.security_in_ldap.ldap.url | LDAP Server URL |
| module_config.security_in_ldap.ldap.url.desc | The URL to connect to the LDAP server (e.g. <code>ldap://example.com:389</code>). |
| module_config.security_in_ldap.user.global_permissions | Global Permissions |
| module_config.security_in_ldap.user.global_permissions.desc | A comma separated list of permissions to grant all users who authenticate using this module (e.g. <code>ROLE_FHIR_CLIENT, FHIR_READ_ALL_IN_COMPARTMENT/Patient/123</code>). |
| module_config.security_in_ldap.user.map.native_permission_attribute_name | Native Permission User Attribute |
| module_config.security_in_ldap.user.map.native_permission_attribute_name.desc | If specified, this user attribute will be treated as having native Smile CDR permission strings that will be granted to users. |
| module_config.security_in_ldap.user.map.user_attr.familyname | User Attribute: Family Name |
| module_config.security_in_ldap.user.map.user_attr.familyname.desc | The name of the LDAP User Attribute from which to read the user's family (last) name. |
| module_config.security_in_ldap.user.map.user_attr.givenname | User Attribute: Given Name |
| module_config.security_in_ldap.user.map.user_attr.givenname.desc | The name of the LDAP User Attribute from which to read the user's given (first) name. |
| module_config.security_in_local.cache_successful_credentials | Cache Successful Credentials |
| module_config.security_in_local.cache_successful_credentials.desc | If enabled, the authorization service will enable a very short-term cache of successful credentials. This is useful in environments where many requests are being made using username/password credentials in each request (i.e. a backend service secured with HTTP Basic Auth). Enable with caution as this setting also has security considerations. |
| module_config.security_in_local.callback_script.file | Authentication Callback Script (File) |
| module_config.security_in_local.callback_script.file.desc | If set, supplies a callback function that will be executed after a successful authentication. This script can modify permissions, enhance the returned login details, or even reject the authentication. See <a href="/docs/security/callback_scripts.html">Callback Scripts</a> for more information. Values should be prefixed with <code>file:</code> or <code>classpath:</code>. |
| module_config.security_in_local.callback_script.text | Authentication Callback Script (Text) |
| module_config.security_in_local.callback_script.text.desc | If set, supplies a callback function that will be executed after a successful authentication. This script can modify permissions, enhance the returned login details, or even reject the authentication. See <a href="/docs/security/callback_scripts.html">Callback Scripts</a> for more information. |
| module_config.security_in_local.create_unknown_users | Create Unknown Users |
| module_config.security_in_local.create_unknown_users.desc | If a user is requested and does not already exist, having this setting enabled will cause that user to be created. <strong>Use this setting with caution</strong> as it can result in an unlimited number of users being created within the Smile CDR database. This setting is useful only in situations where the client is trusted (e.g. a server-to-server communication). |
| module_config.security_in_local.password_case_sensitive | Case-Sensitive Passwords |
| module_config.security_in_local.password_case_sensitive.desc | If enabled, passwords are case-sensitive. Note that any passwords created before this setting is changed are not affected. Change with caution! |
| module_config.security_in_local.password_encoding_type | Password Encoding Scheme |
| module_config.security_in_local.password_encoding_type.desc | Specify the scheme that will be used to store passwords in the database. Note that changing this value will only affect newly created and updated passwords. Existing passwords will remain encoded using the scheme that was selected at the time that they were saved. See <a href="/docs/appendix/password_hashing_algorithms.html">Password Hashing Algorithms</a> for more information. |
| module_config.security_in_local.password_pattern | Minimum Password Requirements |
| module_config.security_in_local.password_pattern.desc | Specify password requirements using a regular expression (e.g. <code>.{4,100}</code>). Separate each requirement from the other with a single space. Note that these requirements will only be enforced when evaluating newly created and updated passwords; existing passwords remain unaffected. |
| module_config.security_in_local.password_pattern_compilation_error | Error(s) in the following regular expression(s) specified for Minimum Password Requirements: |
| module_config.security_in_local.password_pattern_mismatch_error | Password Mismatch Error |
| module_config.security_in_local.password_pattern_mismatch_error.desc | Error message that will be displayed to the user if the password they are trying to create/update does not match the regular expression specified in Minimum Password Requirements. This message needs to be updated for any change in the Minimum Password Requirements. |
| module_config.security_in_local.seed.users.file | Users Seed File |
| module_config.security_in_local.seed.users.file.desc | Contains a link to a file with a set of users to seed when the module is first started. See <a href="/docs/installation/pre_seeding.html">Pre-Seeding</a> for more information. |
| module_config.security_in_local.tfa.totp.issuer_name | TOTP Issuer Name |
| module_config.security_in_local.tfa.totp.issuer_name.desc | This setting provides a short description of the TOTP issuer, which is the name associated with a specific key in the authenticator app. |
| module_config.security_in_local.tfa.totp.lock_after_failed_attempts | Lock After Failed Attempts |
| module_config.security_in_local.tfa.totp.lock_after_failed_attempts.desc | Sets the number of failed verification attempts that are allowed before the TOTP key is locked and no longer usable. |
| module_config.security_in_local.username_case_sensitive | Case-Sensitive Usernames |
| module_config.security_in_local.username_case_sensitive.desc | If enabled, usernames are treated as case-sensitive. <strong>If you change this value after accounts are created, these accounts may be orphaned. Change with caution!</strong> |
| module_config.security_in_saml.relying_party.default.entity_id_template | Relying Party Entity ID Template |
| module_config.security_in_saml.relying_party.default.entity_id_template.desc | This setting controls the Entity ID that will be assigned to the SAML Relying Party (i.e. the Smile CDR web application being authenticated). See <a href="/docs/security/saml_inbound_security_module.html#entity-id-template">Entity ID Template</a> for more information. |
| module_config.security_in_saml.relying_party.default.issuer_id | Issuer ID |
| module_config.security_in_saml.relying_party.default.issuer_id.desc | Contains the ID for the IDP (Identity Provider) that will be used to authenticate, and must match the value configured in that system. This is also sometimes called an Entity ID. |
| module_config.security_in_saml.relying_party.default.keystore.file | Keystore File |
| module_config.security_in_saml.relying_party.default.keystore.file.desc | Specifies a <a href="/docs/product_configuration/tls_https.html#truststores-and-keystores">Keystore</a> to obtain keys and certificates for use in signing and verifying signatures in SAML assertions. |
| module_config.security_in_saml.relying_party.default.keystore.password | Keystore Password |
| module_config.security_in_saml.relying_party.default.keystore.password.desc | The keystore password |
| module_config.security_in_saml.relying_party.default.registration_id | Registration ID |
| module_config.security_in_saml.relying_party.default.registration_id.desc | An identifier intended to uniquely identify the registration between the Identity Provider and Smile CDR (the Service Provider). The default value of <code>SMILECDR</code> is typically fine, unless you are authenticating multiple instances of Smile CDR using SAML, and the different instances have different purposes/users/etc. |
| module_config.security_in_saml.relying_party.default.sign_auth_request | Sign Auth Request |
| module_config.security_in_saml.relying_party.default.sign_auth_request.desc | Should the SAML Authentication Request be signed? |
| module_config.security_in_saml.relying_party.default.signing_key_alias | Signing Key Alias |
| module_config.security_in_saml.relying_party.default.signing_key_alias.desc | Specifies the alias within the keystore for the key that will be used to sign the Authentication Request. |
| module_config.security_in_saml.relying_party.default.signing_key_password | Signing Key Password |
| module_config.security_in_saml.relying_party.default.signing_key_password.desc | The password for the key used for signing. |
| module_config.security_in_saml.relying_party.default.verification_cert_alias | Verification Certificate Alias |
| module_config.security_in_saml.relying_party.default.verification_cert_alias.desc | Specifies the alias in the keystore for the certificate to use to verify the SAML response signature. |
| module_config.security_in_saml.relying_party.default.web_sso_url | Web SSO URL |
| module_config.security_in_saml.relying_party.default.web_sso_url.desc | Specifies the URL that should be used as the destination for the initial redirect from the Service Provider to the Identity Provider. |
| module_config.security_in_script.script.file | Script (File) |
| module_config.security_in_script.script.file.desc | If provided (either text or file must be provided), this property contains a resource path to the file containing the text of the script to use as the authentication script. |
| module_config.security_in_script.script.text | Script (Text) |
| module_config.security_in_script.script.text.desc | If provided (either text or file must be provided), this property contains the text of the script to use as the authentication script. |
| module_config.security_in_smart.authorization_endpoint | Authorization Endpoint |
| module_config.security_in_smart.authorization_endpoint.desc | If set, this URL specifies the OAuth2 authorization endpoint associated with this server. This setting <strong>has no effect</strong> on the operation of the security module but will be provided to FHIR endpoints that are secured using this module in order for them to expose this endpoint in their conformance statement. |
| module_config.security_in_smart.cache_authentication.seconds | Authentication Cache Timeout (Seconds) |
| module_config.security_in_smart.cache_authentication.seconds.desc | If set to a non-zero, non-negative value, successfully validated authentication tokens will be cached for the given number of seconds. This cache has a positive impact on performance since validating a token is a non-trivial operation and may involve lookups and crypto operations. However, setting this timeout to a value that is high means that invalidated tokens will be trusted for longer than they should be. |
| module_config.security_in_smart.enforce_approved_scopes_to_restrict_permissions | Enforce Approved Scopes to Restrict Permissions |
| module_config.security_in_smart.enforce_approved_scopes_to_restrict_permissions.desc | When enabled, permission will be stripped from a user's session if they are not supported by an approved SMART on FHIR scope. For example, any FHIR write permissions will be removed from a session if the user has not approved (or a client is set to auto-approve) a scope such as <code>Patient/*.write</code>. |
| module_config.security_in_smart.introspection_client.truststore.file | Token Introspection Client: Truststore File |
| module_config.security_in_smart.introspection_client.truststore.file.desc | Specifies a <a href="/docs/product_configuration/tls_https.html#truststores-and-keystores">TrustStore</a> to use for outbound client connections from the OIDC server. This is only needed in cases where the remote OIDC server uses a self-signed certificate for TLS. |
| module_config.security_in_smart.introspection_client.truststore.password | Token Introspection Client: Truststore Password |
| module_config.security_in_smart.introspection_client.truststore.password.desc | The password to use to open the truststore, if specified. |
| module_config.security_in_smart.key_validation.prevent_token_key_reuse | Prevent Token KeyID Reuse |
| module_config.security_in_smart.key_validation.prevent_token_key_reuse.desc | If enabled, the server will block tokens with a signed key from being reused. In other words, when the key is decoded as a JWT, the <code>kid</code> (KeyID) claim is verified to ensure that the same key has not been reused. |
| module_config.security_in_smart.key_validation.require_key_expiry | Require Key Expiry |
| module_config.security_in_smart.key_validation.require_key_expiry.desc | If enabled, the server will block tokens that do not have an expiry. |
| module_config.security_in_smart.seed_clients.file | OpenID Connect Client Pre-Seed File |
| module_config.security_in_smart.seed_clients.file.desc | Provides the location of a file to use to pre-seed OpenID Connect Client definitions at startup time. See <a href="/docs/installation/pre_seeding.html">Pre-Seeding</a> for more information. |
| module_config.security_in_smart.seed_servers.file | OpenID Connect Server Pre-Seed File |
| module_config.security_in_smart.seed_servers.file.desc | Provides the location of a file to use to pre-seed OpenID Connect Server definitions at startup time. See <a href="/docs/installation/pre_seeding.html">Pre-Seeding</a> for more information. |
| module_config.security_in_smart.token_endpoint | Token Endpoint |
| module_config.security_in_smart.token_endpoint.desc | If set, this URL specifies the OAuth2 token endpoint associated with this server. This setting <strong>has no effect</strong> on the operation of the security module but will be provided to FHIR endpoints that are secured using this module in order for them to expose this endpoint in their conformance statement. |
| module_config.security_in_smart.trust_intra_cluster_tokens.modules | Trust Intra-Cluster SMART Tokens from Module(s) |
| module_config.security_in_smart.trust_intra_cluster_tokens.modules.desc | This property provides a comma-separated list of Smile CDR <em><a href="/docs/security/smart_on_fhir_outbound_security_module.html">SMART Outbound Security</a></em> modules from which tokens will be accepted. See <a href="/docs/security/smart_on_fhir_inbound_security_module.html#accepting-internal-access-tokens">Accepting Internal Access Tokens</a> for information on how to use this setting. Values for this setting should be in the form <code>node_id/module_id</code>, where <strong>node_id</strong> refers to a master node, and <strong>module_id</strong> refers to a SMART Outbound Security module on that node. If no value is supplied, only tokens issued by external OpenID Connect providers will be trusted, and these providers must be registered as OpenID Connect servers in the Smile CDR configuration. |
| module_config.security_out_smart.cache.authorized_tokens.millis | Cache Authorizations (millis) |
| module_config.security_out_smart.cache.authorized_tokens.millis.desc | If a non-zero value is supplied, the authorization server will cache successful authorizations for up to this amount of time. This means that if an Access Token is received as authentication with a request (e.g. in an Authorization header during a FHIR call) multiple times within the cache timespan, only one attempt to validate the token will be made. Using the cache can greatly improve performance on heavily loaded systems. However, manually invalidated tokens may be accepted as still being valid during the cache period so it is important to not use a value that is unnecessarily long. |
| module_config.security_out_smart.client_secret.encoding | Client Secret Encoding |
| module_config.security_out_smart.client_secret.encoding.desc | Select the hashing algorithm to use when storing client secrets. Note that the value selected here will apply only to newly created secrets, and this may be changed at any time without affecting existing secrets. See <a href="/docs/appendix/password_hashing_algorithms.html">Password Hashing Algorithms</a> for more information. |
| module_config.security_out_smart.codap.auth_script.file | CODAP Authorization Script (File) |
| module_config.security_out_smart.codap.auth_script.file.desc | When using CODAP, a callback script must be provided. This script is used to assess the incoming identity assertion and provide the appropriate authorization. Values should be prefixed with <code>file:</code> or <code>classpath:</code>. |
| module_config.security_out_smart.codap.auth_script.text | CODAP Authorization Script (Text) |
| module_config.security_out_smart.codap.auth_script.text.desc | When using CODAP, a callback script must be provided. This script is used to assess the incoming identity assertion and provide the appropriate authorization. |
| module_config.security_out_smart.codap.enabled | Enable Cross-Organization Data Access Profile |
| module_config.security_out_smart.codap.enabled.desc | If enabled, this module will support the use of the Cross-Organization Data Access Profile (CODAP). |
| module_config.security_out_smart.federate_mode.enabled | Federated OAuth2/OIDC Login |
| module_config.security_out_smart.federate_mode.enabled.desc | When enabled, this server will federate to a federated OAuth2/OIDC server instead of prompting the user for credentials. See <a href="/docs/security/federated_oauth2.html">Federated OAuth2/OIDC Login</a> for more information. |
| module_config.security_out_smart.issuer.url | Issuer URL |
| module_config.security_out_smart.issuer.url.desc | This is the URL that will be placed in OpenID Connect tokens as the <code>iss</code> (issuer) token. The value should be the URL to the identity server. |
| module_config.security_out_smart.post_authorize_script.file | Post Authorization Script (File) |
| module_config.security_out_smart.post_authorize_script.file.desc | If supplied, provides a script that will be invoked after various authorization flows complete. See <a href="/docs/security/smart_on_fhir_outbound_security_module.html#smart-callback-script">SMART Callback Script</a> for details on how this script works. Values should be prefixed with <code>file:</code> or <code>classpath:</code>. |
| module_config.security_out_smart.post_authorize_script.text | Post Authorization Script (Text) |
| module_config.security_out_smart.post_authorize_script.text.desc | If supplied, provides a script that will be invoked after various authorization flows complete. See <a href="/docs/security/smart_on_fhir_outbound_security_module.html#smart-callback-script">SMART Callback Script</a> for details on how this script works. |
| module_config.security_out_smart.rotate_refresh_token_after_use | Rotate Refresh Token After Use |
| module_config.security_out_smart.rotate_refresh_token_after_use.desc | If enabled, each time a refresh token is used to obtain a new access token, the refresh token will be invalidated and a new one automatically issued with the new access token. |
| module_config.security_out_smart.skin.approve_page.template | Approval Page Template |
| module_config.security_out_smart.skin.approve_page.template.desc | This is the path within the WebJar for the approval page, e.g. <code>/userapprove.html</code> |
| module_config.security_out_smart.skin.error_page.template | Error Page Template |
| module_config.security_out_smart.skin.error_page.template.desc | This is the path within the WebJar for the error page, e.g. <code>/usererror.html</code> |
| module_config.security_out_smart.skin.login_oauth2_page.template | Login Page (Federated OAuth2/OIDC) Template |
| module_config.security_out_smart.skin.login_oauth2_page.template.desc | This is the path within the WebJar for the federated OAuth2/OIDC Login Page, e.g. <code>/userlogin_oauth2.html</code>. This setting is not used unless Federated OAuth2/OIDC Login is enabled, and may be left blank otherwise. |
| module_config.security_out_smart.skin.login_page.template | Login Page Template |
| module_config.security_out_smart.skin.login_page.template.desc | This is the path within the WebJar for the interactive login page, e.g. <code>/userlogin.html</code> |
| module_config.security_out_smart.skin.revoke_page.template | Revoke Page Template |
| module_config.security_out_smart.skin.revoke_page.template.desc | This is the path within the WebJar for the approval page, e.g. <code>/userrevoke.html</code> |
| module_config.security_out_smart.skin.tfa_page.template | Two Factor Authentication Page Template |
| module_config.security_out_smart.skin.tfa_page.template.desc | This is the path within the WebJar for the two factor authentication code entry page, e.g. <code>/usertfa.html</code> |
| module_config.security_out_smart.skin.webjar_id | WebJar ID |
| module_config.security_out_smart.skin.webjar_id.desc | This is the ID of the WebJar to use as a skin for the SMART Outbound Security module for login and approval screens. This should take the form <code>groupId:artifactId:versionId</code>. |
| module_config.subscription.delivery_queue_naming | Subscription Delivery Queue Naming |
| module_config.subscription.delivery_queue_naming.desc | The approach used to derive subscription delivery queue names from subscriptions. See <a href="/docs/installation/message_broker.html">Message Broker</a> for more information. |
| module_config.subscription.email.smtp.hostname | Email SMTP Hostname |
| module_config.subscription.email.smtp.hostname.desc | For Email Subscription delivery, specifies the SMTP server hostname. |
| module_config.subscription.email.smtp.password | Email SMTP Password |
| module_config.subscription.email.smtp.password.desc | For Email Subscription delivery, specifies the SMTP server password. |
| module_config.subscription.email.smtp.port | Email SMTP Port |
| module_config.subscription.email.smtp.port.desc | For Email Subscription delivery, specifies the SMTP server port. |
| module_config.subscription.email.smtp.username | Email SMTP Username |
| module_config.subscription.email.smtp.username.desc | For Email Subscription delivery, specifies the SMTP server username. |
| module_config.subscription.fhir_server.password | FHIR Server Password |
| module_config.subscription.fhir_server.password.desc | Basic Auth HTTP Password for FHIR Server |
| module_config.subscription.fhir_server.url | FHIR Server URL |
| module_config.subscription.fhir_server.url.desc | URL of FHIR Server that Subscription server uses to retrieve Search Params, Subscriptions and perform matching not supported by the in-memory matcher |
| module_config.subscription.fhir_server.username | FHIR Server Username |
| module_config.subscription.fhir_server.username.desc | Basic Auth HTTP Username for FHIR Server |
| module_config.subscription.model_config.allow_external_references.enabled | Allow External References Enabled |
| module_config.subscription.model_config.allow_external_references.enabled.desc | If enabled, the server will allow resources to have references to external servers. This means (for example) that with this setting enabled, a Patient could be uploaded containing a reference to Organization <code>http://example.com/fhir/Organization/123</code>. With this setting disabled, only relative references (e.g. <code>Organization/123</code> or absolute references corresponding to the base URL of the server are allowed. |
| module_config.subscription.model_config.email.from_address | Email From Address |
| module_config.subscription.model_config.email.from_address.desc | Emails sent from matching EMAIL subscriptions will be sent from this e-mail address. |
| module_validation.invalid_client_id | Client ID is invalid: {0} - Must match regex {regexp} |
| module_validation.invalid_module_id | Module ID is invalid: {0} - Must match regex {regexp} |
| module_validation.invalid_node_id | Node ID is invalid: {0} - Must match regex {regexp} |
| module_validation.spring_parser | This value is not valid: {0} |
| moduletype.ADMIN_JSON.shortName | JSON Admin API |
| moduletype.ADMIN_WEB.shortName | Web Admin Console |
| moduletype.CDA_EXCHANGE.shortName | CDA Exchange |
| moduletype.CHANNEL_IMPORT.shortName | Channel Import |
| moduletype.CLUSTER_MGR.shortName | Cluster Manager |
| moduletype.EMPI.shortName | EMPI |
| moduletype.ENDPOINT_FHIRWEB.shortName | FHIRWeb Console |
| moduletype.ENDPOINT_FHIR_GATEWAY.shortName | FHIR Gateway REST Endpoint |
| moduletype.ENDPOINT_FHIR_REST_DSTU2.shortName | FHIR REST Endpoint (DSTU2) |
| moduletype.ENDPOINT_FHIR_REST_DSTU3.shortName | FHIR REST Endpoint (R3) |
| moduletype.ENDPOINT_FHIR_REST_R4.shortName | FHIR REST Endpoint (R4) |
| moduletype.ENDPOINT_FHIR_REST_XXX.shortName | FHIR Rest Endpoint |
| moduletype.ENDPOINT_HL7V2_IN.shortName | HL7 v2.x Listening Endpoint |
| moduletype.ENDPOINT_HL7V2_OUT.shortName | HL7 v2.x Sending Endpoint |
| moduletype.ENDPOINT_HYBRID_PROVIDERS.shortName | Hybrid Providers REST Endpoint |
| moduletype.ENDPOINT_PACKAGE_REGISTRY.shortName | Package Registry Endpoint |
| moduletype.ENDPOINT_SUBSCRIPTION_WEBSOCKET.shortName | Subscription Websocket Endpoint |
| moduletype.ETL_IMPORTER.shortName | ETL Importer |
| moduletype.NARRATIVE_GENERATOR.shortName | Narrative Generator |
| moduletype.PERSISTENCE_DSTU2.shortName | FHIR Storage (DSTU2 Relational) |
| moduletype.PERSISTENCE_DSTU3.shortName | FHIR Storage (R3 Relational) |
| moduletype.PERSISTENCE_MONGODB.shortName | FHIR Storage (MongoDB) |
| moduletype.PERSISTENCE_R4.shortName | FHIR Storage (R4 Relational) |
| moduletype.PERSISTENCE_XXX.shortName | FHIR Storage |
| moduletype.REALTIME_EXPORT.shortName | Realtime Export |
| moduletype.SECURITY_IN_LDAP.shortName | LDAP Inbound Security |
| moduletype.SECURITY_IN_LOCAL.shortName | Local Inbound Security |
| moduletype.SECURITY_IN_SAML.shortName | SAML Inbound Security |
| moduletype.SECURITY_IN_SCRIPT.shortName | Scripted Inbound Security |
| moduletype.SECURITY_IN_SMART.shortName | SMART Inbound Security |
| moduletype.SECURITY_OUT_SMART.shortName | SMART Outbound Security |
| moduletype.SMART_APPS_HOST.shortName | SMART App Host |
| moduletype.SUBSCRIPTION_MATCHER.shortName | Subscription Matcher (All FHIR Versions) |
| moduletype.SUBSCRIPTION_MATCHER_DSTU2.shortName | Subscription Matcher (DSTU2 - Deprecated) |
| moduletype.SUBSCRIPTION_MATCHER_DSTU3.shortName | Subscription Matcher (DSTU3 - Deprecated) |
| moduletype.SUBSCRIPTION_MATCHER_R4.shortName | Subscription Matcher (R4 - Deprecated) |
| oauth2.grant_type.AUTHORIZATION_CODE.name | Authorization Code |
| oauth2.grant_type.CLIENT_CREDENTIALS.name | Client Credentials |
| oauth2.grant_type.IMPLICIT.name | Implicit |
| oauth2.grant_type.JWT_BEARER.name | JWT Bearer Token |
| oauth2.grant_type.PASSWORD.name | Resource Owner Password Credentials |
| oauth2.grant_type.REFRESH_TOKEN.name | Refresh Token |
| org.hibernate.validator.constraints.CodePointLength.message | length must be between {min} and {max} |
| org.hibernate.validator.constraints.CreditCardNumber.message | invalid credit card number |
| org.hibernate.validator.constraints.Currency.message | invalid currency (must be one of {value}) |
| org.hibernate.validator.constraints.EAN.message | invalid {type} barcode |
| org.hibernate.validator.constraints.Email.message | not a well-formed email address |
| org.hibernate.validator.constraints.ISBN.message | invalid ISBN |
| org.hibernate.validator.constraints.Length.message | length must be between {min} and {max} |
| org.hibernate.validator.constraints.LuhnCheck.message | the check digit for ${validatedValue} is invalid, Luhn Modulo 10 checksum failed |
| org.hibernate.validator.constraints.Mod10Check.message | the check digit for ${validatedValue} is invalid, Modulo 10 checksum failed |
| org.hibernate.validator.constraints.Mod11Check.message | the check digit for ${validatedValue} is invalid, Modulo 11 checksum failed |
| org.hibernate.validator.constraints.ModCheck.message | the check digit for ${validatedValue} is invalid, ${modType} checksum failed |
| org.hibernate.validator.constraints.NotBlank.message | may not be empty |
| org.hibernate.validator.constraints.NotEmpty.message | may not be empty |
| org.hibernate.validator.constraints.ParametersScriptAssert.message | script expression "{script}" didn''t evaluate to true |
| org.hibernate.validator.constraints.Range.message | must be between {min} and {max} |
| org.hibernate.validator.constraints.SafeHtml.message | may have unsafe html content |
| org.hibernate.validator.constraints.ScriptAssert.message | script expression "{script}" didn''''t evaluate to true |
| org.hibernate.validator.constraints.URL.message | must be a valid URL |
| org.hibernate.validator.constraints.UniqueElements.message | must only contain unique elements |
| org.hibernate.validator.constraints.time.DurationMax.message | must be shorter than${inclusive == true ? '' or equal to'' : ''''}${days == 0 ? '''' : days == 1 ? '' 1 day'' : '' '' += days += '' days''}${hours == 0 ? '''' : hours == 1 ? '' 1 hour'' : '' '' += hours += '' hours''}${minutes == 0 ? '''' : minutes == 1 ? '' 1 minute'' : '' '' += minutes += '' minutes''}${seconds == 0 ? '''' : seconds == 1 ? '' 1 second'' : '' '' += seconds += '' seconds''}${millis == 0 ? '''' : millis == 1 ? '' 1 milli'' : '' '' += millis += '' millis''}${nanos == 0 ? '''' : nanos == 1 ? '' 1 nano'' : '' '' += nanos += '' nanos''} |
| org.hibernate.validator.constraints.time.DurationMin.message | must be longer than${inclusive == true ? '' or equal to'' : ''''}${days == 0 ? '''' : days == 1 ? '' 1 day'' : '' '' += days += '' days''}${hours == 0 ? '''' : hours == 1 ? '' 1 hour'' : '' '' += hours += '' hours''}${minutes == 0 ? '''' : minutes == 1 ? '' 1 minute'' : '' '' += minutes += '' minutes''}${seconds == 0 ? '''' : seconds == 1 ? '' 1 second'' : '' '' += seconds += '' seconds''}${millis == 0 ? '''' : millis == 1 ? '' 1 milli'' : '' '' += millis += '' millis''}${nanos == 0 ? '''' : nanos == 1 ? '' 1 nano'' : '' '' += nanos += '' nanos''} |
| permission.ACCESS_ADMIN_JSON.desc | User is allowed to invoke operations on the JSON Admin API endpoint. Note that this permission does not give the user the ability to actually perform any of the functions on the API so this permission is generally granted in combination with at least one other. |
| permission.ACCESS_ADMIN_JSON.name | Access JSON Admin API Endpoint |
| permission.ACCESS_ADMIN_WEB.desc | User is allowed to log into the Web Admin Console. |
| permission.ACCESS_ADMIN_WEB.name | Admin |
| permission.ACCESS_FHIRWEB.desc | User is allowed to access the FHIRWeb Console, which can be used for testing, building FHIR queries, and exploring data in the database. Note that this permission only allows access to the FHIRWeb Console; the user still needs to have other appropriate permissions for any desired operations or they will be blocked. |
| permission.ACCESS_FHIRWEB.name | Access FHIRWeb Console |
| permission.ACCESS_FHIR_ENDPOINT.desc | User is allowed to access FHIR services as a client. |
| permission.ACCESS_FHIR_ENDPOINT.name | FHIR Client |
| permission.ARCHIVE_MODULE.desc | User is allowed to archive modules. |
| permission.ARCHIVE_MODULE.name | Archive Modules |
| permission.CHANGE_OWN_DEFAULT_LAUNCH_CONTEXTS.desc | User is allowed to update the SMART launch context(s) associated with their own account. |
| permission.CHANGE_OWN_DEFAULT_LAUNCH_CONTEXTS.name | Change Own Launch Contexts |
| permission.CHANGE_OWN_PASSWORD.desc | User is allowed to change their own password. |
| permission.CHANGE_OWN_PASSWORD.name | Change Own Password |
| permission.CHANGE_OWN_TFA_KEY.desc | User is allowed to set up their own 2FA key (as opposed to having one assigned by an administrator). |
| permission.CHANGE_OWN_TFA_KEY.name | Can set own 2FA Key |
| permission.CONTROL_MODULE.desc | User is allowed to start/stop/restart modules. |
| permission.CONTROL_MODULE.name | Control Module |
| permission.CREATE_CDA_TEMPLATE.desc | User is allowed to create (and update existing) CDA document template scripts. <strong>Use this permission with caution</strong>, as these scripts, when called upon, have the ability to create, view, and modify data without additional permissions. |
| permission.CREATE_CDA_TEMPLATE.name | Create CDA templates |
| permission.CREATE_MODULE.desc | User is allowed to create new modules. |
| permission.CREATE_MODULE.name | Create Modules |
| permission.CREATE_USER.desc | User is allowed to create other users. |
| permission.CREATE_USER.name | Create Users |
| permission.DELETE_CDA_TEMPLATE.desc | User is allowed to delete CDA document template scripts. |
| permission.DELETE_CDA_TEMPLATE.name | Delete CDA templates |
| permission.DISABLE_2FA_TOTP_KEY.disable | Disable Two Factor Authentication for user. |
| permission.DISABLE_2FA_TOTP_KEY.name | Disable 2FA for User |
| permission.EMPI_ADMIN.desc | User may perform any administrative functions for the EMPI. |
| permission.EMPI_ADMIN.name | EMPI Admin |
| permission.EMPI_UPDATE_MATCH_RULES.desc | User can set/update matching rules for the EMPI. |
| permission.EMPI_UPDATE_MATCH_RULES.name | EMPI Update Match Rules |
| permission.EMPI_VIEW_MATCH_RULES.desc | User can view matching rules for the EMPI. |
| permission.EMPI_VIEW_MATCH_RULES.name | EMPI VIEW Match Rules |
| permission.ETL_IMPORT_PROCESS_FILE.desc | User is allowed to initiate the processing of an ETL import job. <strong>Use this permission with caution</strong>, as import jobs have a large amount of flexibility to create and modify data and do not require additional permissions. |
| permission.ETL_IMPORT_PROCESS_FILE.name | ETL Import / Process File |
| permission.FHIR_ACCESS_PARTITION_ALL.desc | User is allowed to access (includes both read and write operations) data in all partitions. Note that this permission does not actually authorize any specific read/write operations, it simply implies access to the partitions. |
| permission.FHIR_ACCESS_PARTITION_ALL.name | Access data in ALL Partitions |
| permission.FHIR_ACCESS_PARTITION_NAME.arg_desc | The argument to this permission is a partition name, or a comma separated collection of partition names |
| permission.FHIR_ACCESS_PARTITION_NAME.desc | User is allowed to access (includes both read and write operations) data in the given partition. Note that this permission does not actually authorize any specific read/write operations, it simply implies access to the given partition. |
| permission.FHIR_ACCESS_PARTITION_NAME.name | Access data in Partition |
| permission.FHIR_ALL_DELETE.desc | User is allowed to perform any FHIR delete operation. |
| permission.FHIR_ALL_DELETE.name | FHIR Delete (All) |
| permission.FHIR_ALL_READ.desc | User is allowed to perform any FHIR read/access-to-data operation (e.g. <code>read</code>, <code>search</code>, <code>history</code>, etc.). |
| permission.FHIR_ALL_READ.name | FHIR Read (All) |
| permission.FHIR_ALL_WRITE.desc | User is allowed to perform any FHIR write/modify operation (e.g. <code>create</code>, <code>update</code>, etc.). |
| permission.FHIR_ALL_WRITE.name | FHIR Write (All) |
| permission.FHIR_BATCH.desc | User is allowed to perform a FHIR Batch. Note that this permission only allows the batch operation to happen; the user still needs to have other appropriate permissions for the operations in the batch or it will be blocked. |
| permission.FHIR_BATCH.name | FHIR Batch |
| permission.FHIR_CAPABILITIES.desc | User is allowed to access the server's capability statement. This permission is often granted to anonymous users. |
| permission.FHIR_CAPABILITIES.name | FHIR Access Server Capability Statement (metadata) |
| permission.FHIR_CREATE_SUBSCRIPTION_MESSAGE.desc | User is allowed to create a subscription with the <code>message</code> channel type. |
| permission.FHIR_CREATE_SUBSCRIPTION_MESSAGE.name | Create Subscription: Message |
| permission.FHIR_CREATE_SUBSCRIPTION_REST_HOOK.desc | User is allowed to create a subscription with the <code>rest-hook</code> channel type. |
| permission.FHIR_CREATE_SUBSCRIPTION_REST_HOOK.name | Create Subscription: Rest Hook |
| permission.FHIR_DELETE_ALL_IN_COMPARTMENT.arg_desc | The argument to this permission is the name of the compartment to which access is being granted. |
| permission.FHIR_DELETE_ALL_IN_COMPARTMENT.desc | User is permitted to delete any resource in the given compartment. |
| permission.FHIR_DELETE_ALL_IN_COMPARTMENT.name | FHIR Delete (All in Compartment) |
| permission.FHIR_DELETE_ALL_OF_TYPE.arg_desc | The argument to this permission is the resource type. |
| permission.FHIR_DELETE_ALL_OF_TYPE.desc | User is allowed to delete any resource of the type specified in the argument (e.g. <code>Patient</code>). |
| permission.FHIR_DELETE_ALL_OF_TYPE.name | FHIR Delete (All of Type) |
| permission.FHIR_DELETE_CASCADE_ALLOWED.desc | User is permitted to perform cascading deletes. See <a href="/docs/fhir_repository/deleting_data.html#cascading-deletes">Cascading Deletes</a> for more information. |
| permission.FHIR_DELETE_CASCADE_ALLOWED.name | FHIR Delete - Cascading Allowed |
| permission.FHIR_DELETE_TYPE_IN_COMPARTMENT.arg_desc | The argument to this permission is the name of the type to allow deletion on, followed by a colon, followed by the name of the compartment to which access is being granted. For example, the argument <code>Observation:Patient/123</code> means that the user is permitted to delete any Observation resource in the Patient/123 compartment. |
| permission.FHIR_DELETE_TYPE_IN_COMPARTMENT.desc | User is permitted to delete any resource of the given type in the given compartment. |
| permission.FHIR_DELETE_TYPE_IN_COMPARTMENT.name | FHIR Delete (Specific Type in Compartment) |
| permission.FHIR_EMPI_ADMIN.desc | Can execute any EMPI operation. |
| permission.FHIR_EMPI_ADMIN.name | EMPI Administrative privileges |
| permission.FHIR_EXPUNGE_DELETED.desc | User is permitted to invoke the <code>$expunge</code> operation to permanently delete logically deleted resources. <strong>This is a dangerous operation</strong>, as it causes data to be permanently deleted. Use caution when granting this permission. See [/docs/fhir_repository/deleting_data.html](deleting data) for information on this operation. Note that the ROLE_FHIR_CLIENT_SUPERUSER role does not grant this permission, it must be explicitly enabled. |
| permission.FHIR_EXPUNGE_DELETED.name | FHIR Expunge ($expunge) Deleted Resources |
| permission.FHIR_EXPUNGE_EVERYTHING.desc | User is permitted to invoke the <code>$expunge</code> operation to permanently delete ALL data on the server. <strong>This is a dangerous operation</strong>, as it causes data to be permanently deleted. Use caution when granting this permission. See [/docs/fhir_repository/deleting_data.html](deleting data) for information on this operation. Note that the ROLE_FHIR_CLIENT_SUPERUSER role does not grant this permission, it must be explicitly enabled. |
| permission.FHIR_EXPUNGE_EVERYTHING.name | FHIR Expunge ($expunge) All Data |
| permission.FHIR_EXPUNGE_PREVIOUS_VERSIONS.desc | User is permitted to invoke the <code>$expunge</code> operation. <strong>This is a dangerous operation</strong>, as it causes data to be permanently deleted. Use caution when granting this permission. See [/docs/fhir_repository/deleting_data.html](deleting data) for information on this operation. Note that the ROLE_FHIR_CLIENT_SUPERUSER role does not grant this permission, it must be explicitly enabled. |
| permission.FHIR_EXPUNGE_PREVIOUS_VERSIONS.name | FHIR Expunge ($expunge) Previous Versions |
| permission.FHIR_EXTENDED_OPERATION_ON_ANY_INSTANCE_OF_TYPE.arg_desc | The argument to this permission is the resource type and operation name. |
| permission.FHIR_EXTENDED_OPERATION_ON_ANY_INSTANCE_OF_TYPE.desc | User may invoke operation at the instance level with type and operation name specified by argument in the form: <code>Patient/$fooOperation</code>. When using this permission, the operation response is not validated/authorized in any way, so this authority should only be granted for operations that are known to be appropriate for the user. |
| permission.FHIR_EXTENDED_OPERATION_ON_ANY_INSTANCE_OF_TYPE.name | Extended Operation (Instance Level / Unchecked Response) |
| permission.FHIR_EXTENDED_OPERATION_ON_SERVER.arg_desc | The argument to this permission is the resource type and operation name. |
| permission.FHIR_EXTENDED_OPERATION_ON_SERVER.desc | User may invoke operation with name specified by argument (e.g. <code>$fooOperation</code>). When using this permission, the operation response is not validated/authorized in any way, so this authority should only be granted for operations that are known to be appropriate for the user. |
| permission.FHIR_EXTENDED_OPERATION_ON_SERVER.name | Extended Operation (Server Level / Unchecked Response) |
| permission.FHIR_EXTENDED_OPERATION_ON_TYPE.arg_desc | The argument to this permission is the resource type and operation name. |
| permission.FHIR_EXTENDED_OPERATION_ON_TYPE.desc | User may invoke operation at the type level with type and name specified by argument in the form: <code>Patient/$fooOperation</code>. When using this permission, the operation response is not validated/authorized in any way, so this authority should only be granted for operations that are known to be appropriate for the user. |
| permission.FHIR_EXTENDED_OPERATION_ON_TYPE.name | Extended Operation (Type Level / Unchecked Response) |
| permission.FHIR_GET_RESOURCE_COUNTS.desc | User is permitted to call the <code>$get-resource-counts</code> operation, requesting the total counts of resources on the server. |
| permission.FHIR_GET_RESOURCE_COUNTS.name | FHIR Get Server Resource Counts |
| permission.FHIR_GRAPHQL.desc | User may invoke the GraphQL Operation. Note that user must still have additional permissions to see the resources being requested via GraphQL. |
| permission.FHIR_GRAPHQL.name | FHIR GraphQL Operation |
| permission.FHIR_LIVEBUNDLE.desc | User is allowed to invoke the $livebundle-watchlist-add, $livebundle-watchlist-delete, $livebundle-watchlist, and $livebundle operations |
| permission.FHIR_LIVEBUNDLE.name | FHIR LiveBundle Operations |
| permission.FHIR_MANAGE_PARTITIONS.desc | User is allowed to manage (add/update/delete) partition definitions in the system. Note that this permission is not automatically granted via the <code>ROLE_FHIR_CLIENT_SUPERUSER</code> permission and must be granted explicitly. |
| permission.FHIR_MANAGE_PARTITIONS.name | Manage Partitions |
| permission.FHIR_MANUAL_VALIDATION.desc | User is allowed to invoke the <code>$validate</code> operation to validate resources. |
| permission.FHIR_MANUAL_VALIDATION.name | FHIR Manual Validation |
| permission.FHIR_META_OPERATIONS_SUPERUSER.desc | User is allowed to invoke the resource metadata operations (<code>$meta</code>, <code>$meta-add</code>, and <code>$meta-delete</code>) on any resource. |
| permission.FHIR_META_OPERATIONS_SUPERUSER.name | Resource Metadata Operations: Superuser |
| permission.FHIR_MODIFY_SEARCH_PARAMETERS.desc | User is allowed to create, update, and delete search parameters. |
| permission.FHIR_MODIFY_SEARCH_PARAMETERS.name | Modify Search Parameters |
| permission.FHIR_OP_BINARY_ACCESS_READ.desc | User is allowed to invoke the $binary-access-read operation (note that the user will also need permission to read/write the individual resource that is actually being accessed) |
| permission.FHIR_OP_BINARY_ACCESS_READ.name | FHIR Binary Access Operations (read) |
| permission.FHIR_OP_BINARY_ACCESS_WRITE.desc | User is allowed to invoke the $binary-access-write operation (note that the user will also need permission to read/write the individual resource that is actually being accessed) |
| permission.FHIR_OP_BINARY_ACCESS_WRITE.name | FHIR Binary Access Operations (write) |
| permission.FHIR_OP_EMPI_CLEAR.desc | Delete all EMPI links, and remove all related Persons |
| permission.FHIR_OP_EMPI_CLEAR.name | EMPI Clear Links |
| permission.FHIR_OP_EMPI_DUPLICATE_PERSONS.desc | Request all EMPI Duplicate Persons |
| permission.FHIR_OP_EMPI_DUPLICATE_PERSONS.name | EMPI Duplicate Persons |
| permission.FHIR_OP_EMPI_MERGE_PERSONS.desc | Merge one Person resource into another, copying over fields that are empty in the target, and copying over links that are missing in the target. MANUAL links will overwrite AUTO links. The original Person resource is deleted. |
| permission.FHIR_OP_EMPI_MERGE_PERSONS.name | Merge to EMPI Person resources |
| permission.FHIR_OP_EMPI_QUERY_LINKS.desc | Request matching EMPI Links |
| permission.FHIR_OP_EMPI_QUERY_LINKS.name | EMPI Query Links |
| permission.FHIR_OP_EMPI_SUBMIT.desc | Submit Patients/Practitioners for EMPI processing. |
| permission.FHIR_OP_EMPI_SUBMIT.name | EMPI Batch Processing. |
| permission.FHIR_OP_EMPI_UPDATE_LINK.desc | Update an EMPI Link |
| permission.FHIR_OP_EMPI_UPDATE_LINK.name | EMPI Update Link |
| permission.FHIR_OP_ENCOUNTER_EVERYTHING.desc | User is allowed to search/fetch across the entire encounter (all resources belonging to that patient's compartment). |
| permission.FHIR_OP_ENCOUNTER_EVERYTHING.name | Encounter Fetch ($everything) |
| permission.FHIR_OP_INITIATE_BULK_DATA_EXPORT.desc | User may invoke the <code>$export</code> operation to initiate a FHIR Bulk Export of data. See <a href="/docs/bulk/fhir_bulk_export.html">FHIR Bulk Export Operation</a> for more information. |
| permission.FHIR_OP_INITIATE_BULK_DATA_EXPORT.name | Initiate Bulk Export ($export) |
| permission.FHIR_OP_PATIENT_EVERYTHING.desc | User is allowed to search/fetch across the entire patient's record (all resources belonging to that patient's compartment). |
| permission.FHIR_OP_PATIENT_EVERYTHING.name | Patient Search Chart ($everything) |
| permission.FHIR_OP_PATIENT_MATCH.desc | User may invoke the EMPI <code>$match</code> operation on a Patient |
| permission.FHIR_OP_PATIENT_MATCH.name | FHIR EMPI Patient Match |
| permission.FHIR_OP_STRUCTUREDEFINITION_SNAPSHOT.desc | User may invoke the StructureDefinition <code>$snapshot</code> operation |
| permission.FHIR_OP_STRUCTUREDEFINITION_SNAPSHOT.name | FHIR StructureDefinition Snapshot |
| permission.FHIR_PATCH.desc | User is allowed to perform a FHIR patch operation. Note that this permission allows a patch to be performed, but the user may need additional permissions in order to be able to write to specific resources. |
| permission.FHIR_PATCH.name | FHIR Patch |
| permission.FHIR_PROCESS_MESSAGE.desc | User is allowed to invoke the <code>$process-message</code> operation on a server that supports it. |
| permission.FHIR_PROCESS_MESSAGE.name | FHIR Process Message ($process-message) |
| permission.FHIR_READ_ALL_IN_COMPARTMENT.arg_desc | The argument to this permission is the name of the compartment to which access is being granted. |
| permission.FHIR_READ_ALL_IN_COMPARTMENT.desc | User is allowed to read resources of <strong>any type</strong> in the given compartment. This permission takes an argument that should take the form of the name of the compartment (e.g. <code>Patient/123</code>). |
| permission.FHIR_READ_ALL_IN_COMPARTMENT.name | FHIR Read ANY in Compartment X |
| permission.FHIR_READ_ALL_OF_TYPE.arg_desc | The argument to this permission is the name of the resource type. |
| permission.FHIR_READ_ALL_OF_TYPE.desc | User is allowed to fetch resources (<code>read</code>, <code>search</code>, <code>history</code>, etc.) of <strong>the specified type</strong>. This permission takes an argument that should be the name of the resource type (e.g. <code>Patient</code>). |
| permission.FHIR_READ_ALL_OF_TYPE.name | FHIR Read ANY of Type |
| permission.FHIR_READ_INSTANCE.arg_desc | The argument to this permission is the ID of the resource instance (e.g. <code>Patient/123</code>). |
| permission.FHIR_READ_INSTANCE.desc | User is allowed to fetch (<code>read</code>, <code>search</code>, <code>history</code>, etc.) <strong>the specified instance</strong>. This permission takes an argument that should be the ID of the resource instance (e.g. <code>Patient/123</code>). |
| permission.FHIR_READ_INSTANCE.name | FHIR Read Specific Instance |
| permission.FHIR_READ_SEARCH_PARAMETERS.desc | User is allowed to read/search for search parameters. |
| permission.FHIR_READ_SEARCH_PARAMETERS.name | Read Search Parameters |
| permission.FHIR_READ_TYPE_IN_COMPARTMENT.arg_desc | The argument to this permission is the name of the type to allow reading from, followed by a colon, followed by the name of the compartment to which access is being granted. For example, the argument <code>Observation:Patient/123</code> means that the user is permitted to read any Observation resource in the Patient/123 compartment. |
| permission.FHIR_READ_TYPE_IN_COMPARTMENT.desc | User is permitted to read any resource of the given type in the given compartment. |
| permission.FHIR_READ_TYPE_IN_COMPARTMENT.name | FHIR Read (Specific Type in Compartment) |
| permission.FHIR_TRANSACTION.desc | User is allowed to perform a FHIR transaction. Note that this permission only allows the transaction operation to happen; the user still needs to have other appropriate permissions for the operations in the transaction or it will be blocked. |
| permission.FHIR_TRANSACTION.name | FHIR Transaction |
| permission.FHIR_TRIGGER_SUBSCRIPTION.desc | User is permitted to call the <code>$trigger-subscription</code> operation. See <a href="/docs/subscription/manual_triggering.html">Manually Triggering Subscriptions</a> for information on this function. |
| permission.FHIR_TRIGGER_SUBSCRIPTION.name | FHIR Trigger Subscription |
| permission.FHIR_UPDATE_SUBSCRIPTION_MESSAGE.desc | User is allowed to update a subscription with the <code>message</code> channel type. |
| permission.FHIR_UPDATE_SUBSCRIPTION_MESSAGE.name | Update Subscription: Message |
| permission.FHIR_UPDATE_SUBSCRIPTION_REST_HOOK.desc | User is allowed to update a subscription with the <code>rest-hook</code> channel type. |
| permission.FHIR_UPDATE_SUBSCRIPTION_REST_HOOK.name | Update Subscription: Rest Hook |
| permission.FHIR_UPLOAD_EXTERNAL_TERMINOLOGY.desc | User is permitted to upload external CodeSystems using the <code>$upload-external-code-system</code> operation, as well as by using the Apply Delta operations. See <a href="/docs/terminology/uploading.html#uploading-external-codesystems">Uploading External Terminologies</a> for more information on this function. |
| permission.FHIR_UPLOAD_EXTERNAL_TERMINOLOGY.name | Upload External Terminology |
| permission.FHIR_WRITE_ALL_IN_COMPARTMENT.arg_desc | The argument to this permission is the name of the compartment to which access is being granted. |
| permission.FHIR_WRITE_ALL_IN_COMPARTMENT.desc | User is allowed to write resources of <strong>any type</strong> in the given compartment. This permission takes an argument that should take the form of the name of the compartment (e.g. <code>Patient/123</code>). |
| permission.FHIR_WRITE_ALL_IN_COMPARTMENT.name | FHIR Write ANY in Compartment X |
| permission.FHIR_WRITE_ALL_OF_TYPE.arg_desc | The argument to this permission is the name of the resource. |
| permission.FHIR_WRITE_ALL_OF_TYPE.desc | User is allowed to write resources (<code>create</code>, <code>update</code>, etc.) of <strong>the specified type</strong>. This permission takes an argument that should be the name of the resource type (e.g. <code>Patient</code>). |
| permission.FHIR_WRITE_ALL_OF_TYPE.name | FHIR Write ANY of Type |
| permission.FHIR_WRITE_INSTANCE.arg_desc | The argument to this permission is the ID of the resource instance (e.g. <code>Patient/123</code>). |
| permission.FHIR_WRITE_INSTANCE.desc | User is allowed to write (<code>create</code>, <code>update</code>, etc.) <strong>the specified instance</strong>. This permission takes an argument that should be the ID of the resource instance (e.g. <code>Patient/123</code>). |
| permission.FHIR_WRITE_INSTANCE.name | FHIR Write Specific Instance |
| permission.FHIR_WRITE_TYPE_IN_COMPARTMENT.arg_desc | The argument to this permission is the name of the type to allow writing to, followed by a colon, followed by the name of the compartment to which access is being granted. For example, the argument <code>Observation:Patient/123</code> means that the user is permitted to write any Observation resource in the Patient/123 compartment. |
| permission.FHIR_WRITE_TYPE_IN_COMPARTMENT.desc | User is permitted to write any resource of the given type in the given compartment. |
| permission.FHIR_WRITE_TYPE_IN_COMPARTMENT.name | FHIR Write (Specific Type in Compartment) |
| permission.MODULE_ADMIN.desc | User is allowed to create, reconfigure, and start/stop modules. |
| permission.MODULE_ADMIN.name | Module Admin |
| permission.OPENID_CONNECT_ADD_CLIENT.desc | User is allowed to create OpenID Connect clients. |
| permission.OPENID_CONNECT_ADD_CLIENT.name | Add OpenID Connect Client |
| permission.OPENID_CONNECT_ADD_SERVER.desc | User is allowed to create OpenID Connect servers. |
| permission.OPENID_CONNECT_ADD_SERVER.name | Add OpenID Connect Server |
| permission.OPENID_CONNECT_EDIT_CLIENT.desc | User is allowed to edit existing OpenID Connect clients. |
| permission.OPENID_CONNECT_EDIT_CLIENT.name | Edit OpenID Connect Client |
| permission.OPENID_CONNECT_EDIT_SERVER.desc | User is allowed to edit existing OpenID Connect servers. |
| permission.OPENID_CONNECT_EDIT_SERVER.name | Edit OpenID Connect Server |
| permission.OPENID_CONNECT_VIEW_CLIENT_LIST.desc | User is allowed to view the list of registered OpenID Connect clients. This permission does not give the user the ability to create/edit clients. |
| permission.OPENID_CONNECT_VIEW_CLIENT_LIST.name | View OpenID Connect Client List |
| permission.OPENID_CONNECT_VIEW_SERVER_LIST.desc | User is allowed to view the list of registered OpenID Connect servers. This permission does not give the user the ability to create/edit servers. |
| permission.OPENID_CONNECT_VIEW_SERVER_LIST.name | View OpenID Connect Server List |
| permission.PACKAGE_REGISTRY_READ.desc | User can access data from the package registry. |
| permission.PACKAGE_REGISTRY_READ.name | Package Registry: Read Operations |
| permission.PACKAGE_REGISTRY_WRITE.desc | User can write data to the package registry. |
| permission.PACKAGE_REGISTRY_WRITE.name | Package Registry: Write Operations |
| permission.REINSTATE_MODULE.desc | User is allowed to reinstate modules. |
| permission.REINSTATE_MODULE.name | Reinstate Modules |
| permission.ROLE_ANONYMOUS.desc | This role must be granted to any user that will be used for anonymous access requests. See <a href="/docs/security/anonymous_access.html">Anonymous Access</a> for more information. |
| permission.ROLE_ANONYMOUS.name | Anonymous |
| permission.ROLE_FHIR_CLIENT.desc | User has permission to access the FHIR services as a client. |
| permission.ROLE_FHIR_CLIENT.name | FHIR Client |
| permission.ROLE_FHIR_CLIENT_SUPERUSER.desc | User has permission to perform any standard FHIR client operation. This does not imply superuser status for other parts of the CDR (e.g. user management, FHIR search parameter modification, etc.). |
| permission.ROLE_FHIR_CLIENT_SUPERUSER.name | FHIR Client (Superuser) |
| permission.ROLE_FHIR_CLIENT_SUPERUSER_RO.desc | User has permission to perform any standard FHIR client read/fetch operation. This permission allows the user to perform any <code>read</code>, <code>search</code>, <code>history</code>, etc. operation but does not allow the user to perform <code>create</code>, <code>update</code>, etc. This permission does not imply superuser status for other parts of the CDR (e.g. user management, FHIR search parameter modification, etc.). |
| permission.ROLE_FHIR_CLIENT_SUPERUSER_RO.name | FHIR Client (Read-Only Superuser) |
| permission.ROLE_FHIR_TERMINOLOGY_READ_CLIENT.desc | User is permitted to invoke any terminology read-only operations. In other words, this role includes various capabilities relating to accessing data in the FHIR terminology services. This includes operations such as <code>$lookup</code> and <code>$validate-code</code>, as well as read and search capabilities on <code>ValueSet</code>, <code>CodeSystem</code>, and <code>ConceptMap</code> resources. |
| permission.ROLE_FHIR_TERMINOLOGY_READ_CLIENT.name | FHIR Terminology Service Read-Only Client |
| permission.ROLE_SUPERUSER.desc | User has all permissions to do anything. <strong>Use this permission with caution</strong> since it gives the user access to almost all administrative functions. |
| permission.ROLE_SUPERUSER.name | Superuser |
| permission.ROLE_SYSTEM.desc | User is the system itself. |
| permission.ROLE_SYSTEM.name | System |
| permission.ROLE_SYSTEM_INITIALIZATION.desc | User is the system during system startup only. |
| permission.ROLE_SYSTEM_INITIALIZATION.name | System (Initialization Time Only) |
| permission.SAVE_USER.desc | User is allowed to create/update users. |
| permission.SAVE_USER.name | Save Users |
| permission.START_STOP_MODULE.desc | User is allowed to start/stop modules and nodes. |
| permission.START_STOP_MODULE.name | Start/Stop Modules |
| permission.UPDATE_MODULE_CONFIG.desc | User is allowed to modify a module's configuration. |
| permission.UPDATE_MODULE_CONFIG.name | Update Module Configuration |
| permission.UPDATE_USER.desc | User is allowed to update other users. |
| permission.UPDATE_USER.name | Update Users |
| permission.USE_CDA_TEMPLATE.desc | User is allowed to create Compositions / Fhir Documents / CDA Documents via the cda template store. Use caution with this permission with severity relative to how much access the scripts themselves allow. |
| permission.USE_CDA_TEMPLATE.name | Generate CDA documents via the templates |
| permission.VIEW_AUDIT_LOG.desc | User is allowed to view the audit log. |
| permission.VIEW_AUDIT_LOG.name | View Audit Log |
| permission.VIEW_CDA_TEMPLATE.desc | User is allowed to view all CDA templates (including script contents and expected parameters list). |
| permission.VIEW_CDA_TEMPLATE.name | View CDA templates |
| permission.VIEW_METRICS.desc | User can access internal metrics API, including thread dump API |
| permission.VIEW_METRICS.name | View Metrics |
| permission.VIEW_MODULE_CONFIG.desc | User is allowed to view (but not change) module configuration information. This does not include database passwords. |
| permission.VIEW_MODULE_CONFIG.name | View Module Configuration |
| permission.VIEW_MODULE_STATUS.desc | User is allowed to view (but not change) status information about modules. This includes running/stopped status, health checks, etc. but does not give access to more sensitive details such as logs. |
| permission.VIEW_MODULE_STATUS.name | View Module Status |
| permission.VIEW_TRANSACTION_LOG.desc | User is allowed to view the overall transaction log. |
| permission.VIEW_TRANSACTION_LOG.name | View Transaction Log |
| permission.VIEW_TRANSACTION_LOG_EVENT.desc | User is allowed to view individual transaction log entries. |
| permission.VIEW_TRANSACTION_LOG_EVENT.name | View Transaction Log Entries |
| permission.VIEW_USERS.desc | User is allowed to view list of users and individual user details. |
| permission.VIEW_USERS.name | View Users |
| permission.category.ADMIN.name | Admin |
| permission.category.CDA.name | CDA |
| permission.category.EMPI.name | EMPI |
| permission.category.FHIR_CLIENT.name | FHIR Client |
| permission.category.FHIR_PARTITIONING.name | FHIR Partitioning |
| permission.category.PACKAGE_REGISTRY.name | Package Registry |
| permission.category.USER_MANAGER.name | User Manager |
| transaction_log_event_subtype.FHIR_APPLY_CODESYSTEM_DELTA_ADD.name | Apply Codesystem Delta: Add Codes |
| transaction_log_event_subtype.FHIR_APPLY_CODESYSTEM_DELTA_REMOVE.name | Apply Codesystem Delta: Remove Codes |
| transaction_log_event_subtype.FHIR_BINARY_ACCESS_READ.name | FHIR Binary Access - Read (<code>$binary-access-read</code>) |
| transaction_log_event_subtype.FHIR_BINARY_ACCESS_WRITE.name | FHIR Binary Access - Write (<code>$binary-access-write</code>) |
| transaction_log_event_subtype.FHIR_CODESYSTEM_LOOKUP.name | Code Lookup (<code>$lookup</code>) |
| transaction_log_event_subtype.FHIR_COMPOSITION_DOCUMENT.name | Generate Document (<code>$document</code>) |
| transaction_log_event_subtype.FHIR_CONCEPTMAP_TRANSLATE.name | Translate Code (<code>$translate</code>) |
| transaction_log_event_subtype.FHIR_CONFORMANCE.name | Fetch Conformance (<code>/metadata</code>) |
| transaction_log_event_subtype.FHIR_CREATE.name | Create Resource |
| transaction_log_event_subtype.FHIR_DELETE.name | Delete Resource |
| transaction_log_event_subtype.FHIR_GET_PAGE.name | Fetch Page |
| transaction_log_event_subtype.FHIR_HISTORY_INSTANCE.name | History (Instance) |
| transaction_log_event_subtype.FHIR_HISTORY_SYSTEM.name | History (System) |
| transaction_log_event_subtype.FHIR_HISTORY_TYPE.name | History (Type) |
| transaction_log_event_subtype.FHIR_MARK_ALL_RESOURCES_FOR_REINDEXING.name | Mark all resources for reindexing |
| transaction_log_event_subtype.FHIR_META_ADD.name | Add to Metadata (<code>$meta-add</code>) |
| transaction_log_event_subtype.FHIR_META_DELETE.name | Delete from Metadata (<code>$meta-delete</code>) |
| transaction_log_event_subtype.FHIR_META_GET.name | Fetch Metadata (<code>$meta</code>) |
| transaction_log_event_subtype.FHIR_OPERATION_ADD_PARTITION.name | Add Partition ($fhir-management-add-partition) |
| transaction_log_event_subtype.FHIR_OPERATION_DELETE_PARTITION.name | Delete Partition ($fhir-management-delete-partition) |
| transaction_log_event_subtype.FHIR_OPERATION_DIFF.name | Diff Operation ($diff) |
| transaction_log_event_subtype.FHIR_OPERATION_EMPI_CLEAR.name | EMPI Clear links(<code>$empi-clear</code>) |
| transaction_log_event_subtype.FHIR_OPERATION_EMPI_DUPLICATE_PERSONS.name | EMPI Duplicate Persons (<code>$empi-duplicate-persons</code>) |
| transaction_log_event_subtype.FHIR_OPERATION_EMPI_MERGE_PERSONS.name | EMPI Merge Persons (<code>$empi-merge-persons</code>) |
| transaction_log_event_subtype.FHIR_OPERATION_EMPI_QUERY_LINKS.name | EMPI Query Links (<code>$empi-query-links</code>) |
| transaction_log_event_subtype.FHIR_OPERATION_EMPI_SUBMIT.name | EMPI Batch Processing(<code>$empi-submit</code>) |
| transaction_log_event_subtype.FHIR_OPERATION_EMPI_UPDATE_LINK.name | EMPI Update Link (<code>$empi-update-link</code>) |
| transaction_log_event_subtype.FHIR_OPERATION_EVERYTHING_ENCOUNTER_INSTANCE.name | Search Entire Encounter Record (<code>$everything</code>) |
| transaction_log_event_subtype.FHIR_OPERATION_EVERYTHING_PATIENT_INSTANCE.name | Search Entire Patient Chart (<code>$everything</code>) |
| transaction_log_event_subtype.FHIR_OPERATION_EXPUNGE.name | Expunge Operation ($expunge) |
| transaction_log_event_subtype.FHIR_OPERATION_GET_RESOURCE_COUNTS.name | Get Resource Counts Operation ($get-resource-counts) |
| transaction_log_event_subtype.FHIR_OPERATION_GRAPHQL.name | GraphQL Operation (<code>$graphql</code>) |
| transaction_log_event_subtype.FHIR_OPERATION_INITIATE_BULK_EXPORT.name | Initiate FHIR Bulk Export (<code>$export</code>) |
| transaction_log_event_subtype.FHIR_OPERATION_LIVEBUNDLE.name | LiveBundle (<code>$livebundle</code>) |
| transaction_log_event_subtype.FHIR_OPERATION_LIVEBUNDLE_SUBSCRIBER_GROUP_ADD.name | LiveBundle Subscription Group Add (<code>$livebundle-group-add</code>) |
| transaction_log_event_subtype.FHIR_OPERATION_LIVEBUNDLE_SUBSCRIBER_GROUP_DELETE.name | LiveBundle Subscription Group Delete (<code>$livebundle-group-delete</code>) |
| transaction_log_event_subtype.FHIR_OPERATION_LIVEBUNDLE_WATCHLIST.name | LiveBundle Watchlist (<code>$livebundle-watchlist</code>) |
| transaction_log_event_subtype.FHIR_OPERATION_LIVEBUNDLE_WATCHLIST_ADD.name | LiveBundle Watchlist Add (<code>$livebundle-watchlist-add</code>) |
| transaction_log_event_subtype.FHIR_OPERATION_LIVEBUNDLE_WATCHLIST_DELETE.name | LiveBundle Watchlist Delete (<code>$livebundle-watchlist-delete</code>) |
| transaction_log_event_subtype.FHIR_OPERATION_LIVEBUNDLE_WATCHLIST_SUBSCRIBERS.name | LiveBundle Watchlist Subscribers (<code>$livebundle-watchlist-subscribers</code>) |
| transaction_log_event_subtype.FHIR_OPERATION_MATCH_PATIENT.name | FHIR Patient Match (<code>$match</code>) |
| transaction_log_event_subtype.FHIR_OPERATION_POLL_BULK_EXPORT_JOB_STATUS.name | Poll For Bulk Export Job Status (<code>$export-poll-status</code>) |
| transaction_log_event_subtype.FHIR_OPERATION_READ_PARTITION.name | Read Partition ($fhir-management-read-partition) |
| transaction_log_event_subtype.FHIR_OPERATION_SNAPSHOT.name | Snapshot (<code>$snapshot</code>) |
| transaction_log_event_subtype.FHIR_OPERATION_SUGGEST_KEYWORDS.name | Suggest Keywords |
| transaction_log_event_subtype.FHIR_OPERATION_TRIGGER_SUBSCRIPTION.name | Manually Trigger Subscription (<code>$trigger-subscription</code>) |
| transaction_log_event_subtype.FHIR_OPERATION_UNCLASSIFIED.name | FHIR Operation (Unclassified) |
| transaction_log_event_subtype.FHIR_OPERATION_UPDATE_PARTITION.name | Update Partition ($fhir-management-update-partition) |
| transaction_log_event_subtype.FHIR_PATCH.name | Patch Resource |
| transaction_log_event_subtype.FHIR_PERFORM_REINDEXING_PASS.name | Perform reindexing pass |
| transaction_log_event_subtype.FHIR_PROCESS_MESSAGE.name | Process Message (<code>$process-message</code>) |
| transaction_log_event_subtype.FHIR_READ.name | Read Resource |
| transaction_log_event_subtype.FHIR_SEARCH_SYSTEM.name | Search Across All Resource Types |
| transaction_log_event_subtype.FHIR_SEARCH_TYPE.name | Search for Resources |
| transaction_log_event_subtype.FHIR_TRANSACTION.name | Transaction |
| transaction_log_event_subtype.FHIR_UPDATE.name | Update Resource |
| transaction_log_event_subtype.FHIR_UPLOAD_EXTERNAL_CODE_SYSTEM.name | Upload External Terminology Code System |
| transaction_log_event_subtype.FHIR_VALIDATE.name | Validate Resource (<code>$validate</code>) |
| transaction_log_event_subtype.FHIR_VALUESET_EXPAND.name | Expand ValueSet (<code>$expand</code>) |
| transaction_log_event_subtype.FHIR_VALUESET_VALIDATE_CODE.name | Validate Code (<code>$validate-code</code>) |
| transaction_log_event_subtype.FHIR_VREAD.name | VRead Resource |
| transaction_log_event_subtype.HL7V2_ADT_A01.name | ADT^A01 (Admit) |
| transaction_log_event_subtype.HL7V2_ADT_A02.name | ADT^A02 (Transfer) |
| transaction_log_event_subtype.HL7V2_ADT_A03.name | ADT^A03 (Discharge) |
| transaction_log_event_subtype.HL7V2_ADT_A04.name | ADT^A04 (Register) |
| transaction_log_event_subtype.HL7V2_ADT_A05.name | ADT^A05 (Pre-Admit) |
| transaction_log_event_subtype.HL7V2_ADT_A06.name | ADT^A06 (Convert OP to IP) |
| transaction_log_event_subtype.HL7V2_ADT_A07.name | ADT^A07 (Convert IP to OP) |
| transaction_log_event_subtype.HL7V2_ADT_A08.name | ADT^A08 (Update Visit) |
| transaction_log_event_subtype.HL7V2_ADT_A11.name | ADT^A11 (Cancel Admit) |
| transaction_log_event_subtype.HL7V2_ADT_A12.name | ADT^A12 (Cancel Transfer) |
| transaction_log_event_subtype.HL7V2_ADT_A13.name | ADT^A13 (Cancel Discharge) |
| transaction_log_event_subtype.HL7V2_ADT_A14.name | ADT^A14 (Pending Admit) |
| transaction_log_event_subtype.HL7V2_ADT_A15.name | ADT^A15 (Pending Transfer) |
| transaction_log_event_subtype.HL7V2_ADT_A16.name | ADT^A16 (Pending Discharge) |
| transaction_log_event_subtype.HL7V2_ADT_A17.name | ADT^A17 (Swap Patients) |
| transaction_log_event_subtype.HL7V2_ADT_A21.name | ADT^A21 (Patient begins LOA) |
| transaction_log_event_subtype.HL7V2_ADT_A22.name | ADT^A22 (Patient returns from LOA) |
| transaction_log_event_subtype.HL7V2_ADT_A24.name | ADT^A24 (Link Patient Information) |
| transaction_log_event_subtype.HL7V2_ADT_A25.name | ADT^A25 (Cancel Pending Discharge) |
| transaction_log_event_subtype.HL7V2_ADT_A27.name | ADT^A27 (Cancel Pending Admit) |
| transaction_log_event_subtype.HL7V2_ADT_A28.name | ADT^A28 (Add Patient) |
| transaction_log_event_subtype.HL7V2_ADT_A29.name | ADT^A29 (Delete Person Information) |
| transaction_log_event_subtype.HL7V2_ADT_A31.name | ADT^A31 (Update Patient) |
| transaction_log_event_subtype.HL7V2_ADT_A34.name | ADT^A34 (Merge Patient Information) |
| transaction_log_event_subtype.HL7V2_ADT_A37.name | ADT^A37 (Unlink Patient) |
| transaction_log_event_subtype.HL7V2_ADT_A38.name | ADT^A38 (Cancel Pre-Admit) |
| transaction_log_event_subtype.HL7V2_ADT_A39.name | ADT^A39 (Merge Person - Patient ID) |
| transaction_log_event_subtype.HL7V2_ADT_A40.name | ADT^A40 (Merge Patient) |
| transaction_log_event_subtype.HL7V2_ADT_A45.name | ADT^A45 (Move Visit Information - Visit Number) |
| transaction_log_event_subtype.HL7V2_ADT_A47.name | ADT^A47 (Change Patient Identifier List) |
| transaction_log_event_subtype.HL7V2_ADT_A54.name | ADT^A54 (Change Attending) |
| transaction_log_event_subtype.HL7V2_ADT_A60.name | ADT^A60 (Update Allergies) |
| transaction_log_event_subtype.HL7V2_ADT_A61.name | ADT^A61 (Change Consulting) |
| transaction_log_event_subtype.HL7V2_BAR_P01.name | BAR^P01 (Establish Billing Account) |
| transaction_log_event_subtype.HL7V2_DFT_P03.name | DFT^P03 (Post Detailed Financial Transaction) |
| transaction_log_event_subtype.HL7V2_OMG_O19.name | OMG^O19 (General Clinical Order Message) |
| transaction_log_event_subtype.HL7V2_ORU_R01.name | ORU^R01 (Unsolicited Result) |
| transaction_log_event_subtype.HL7V2_RAS_O17.name | RAS^O17 (Medication Administration) |
| transaction_log_event_subtype.HL7V2_RDE_O01.name | RDE^O01 (Medication Order - Legacy) |
| transaction_log_event_subtype.HL7V2_RDE_O11.name | RDE^O11 (Medication Order) |
| transaction_log_event_subtype.HL7V2_UNKNOWN_MESSAGE_TRIGGER.name | Unknown Message Trigger |
| transaction_log_event_subtype.INVALID_REQUEST.name | Invalid Request |
| transaction_log_event_subtype.UNSPECIFIED.name | Unspecified |
| transaction_log_event_type.FHIR_REQUEST.desc | Indicates than a FHIR client request has been handled by a Smile CDR FHIR Server Endpoint. |
| transaction_log_event_type.FHIR_REQUEST.name | FHIR Request |
| transaction_log_event_type.HL7V2_INBOUND.desc | Indicates that an HL7 v2.x message has been <a href="/docs/hl7_v2x_support/inbound_hl7v2.html">received</a> by Smile CDR. |
| transaction_log_event_type.HL7V2_INBOUND.name | HL7 v2.x Inbound |
| transaction_log_event_type.HL7V2_OUTBOUND.desc | Indicates that an HL7 v2.x message has been <a href="/docs/hl7_v2x_support/outbound_hl7v2.html">sent</a> by Smile CDR. |
| transaction_log_event_type.HL7V2_OUTBOUND.name | HL7 v2.x Outbound |
| transaction_log_event_type.SOAP_REQUEST.desc | Indicates that a SOAP client request has been handled by Smile CDR. |
| transaction_log_event_type.SOAP_REQUEST.name | SOAP Request |
| user_change_own_password_success | Password successfully changed. |
| user_validation.duplicate_username | User already exists with username "{0}". |
| user_validation.general_error | Error adding user. Please see below for error in red. |
| user_validation.missing_familyname | Family name must be provided. |
| user_validation.missing_givenname | Given name must be provided. |
| user_validation.missing_password | Password must be provided. |
| user_validation.missing_username | Username must be provided. |
| user_validation_change_own_password_failure.empty_confirm_password | Password change failed: Confirm Password cannot be empty. |
| user_validation_change_own_password_failure.empty_new_password | Password change failed: New Password cannot be empty. |
| user_validation_change_own_password_failure.empty_old_password | Password change failed: Old Password cannot be empty. |
| user_validation_change_own_password_failure.incorrect_old_password | Password change failed: Incorrect old password. |
| user_validation_change_own_password_failure.mismatching_new_and_confirm_passwords | Password change failed: New password and Confirm password should match. |
| user_validation_change_own_password_forbidden.user_not_authorized | Not authorized to change password for User: "{0}". |
| webadmin.action.add | Add |
| webadmin.action.archive | Archive |
| webadmin.action.archive.module.desc | Archiving a module removes it from the list of modules and prevents it from starting, essentially deleting it. Archived modules can be restored if needed. Modules can not be archived while they are running. |
| webadmin.action.create | Create |
| webadmin.action.modify | Modify |
| webadmin.action.reinstate | Reinstate |
| webadmin.action.reinstate.module.desc | Reinstating a module restores it so it can be started. |
| webadmin.action.restart | Restart |
| webadmin.action.restart.module.desc | Restart this module on all running node processes. Note that any unsaved configuration changes will be lost. |
| webadmin.action.save | Save |
| webadmin.action.save.module.desc | Save the module configuration. |
| webadmin.action.save_config | Save |
| webadmin.action.start | Start |
| webadmin.action.start.module.desc | Start this module on all running node processes. Note that any unsaved configuration changes will be lost. |
| webadmin.action.stop | Stop |
| webadmin.action.stop.module.desc | Stop this module on all running node processes. Note that any unsaved configuration changes will be lost. |
| webadmin.action.view | View |
| webadmin.email.message | The value must be a valid e-mail address! |
| webadmin.notBlank.message | The value may not be empty! |
| webadmin.panel.health.title | Health |
| webadmin.panel.load.title | Load |
| webadmin.panel.reads.title | Reads |
| webadmin.panel.writes.title | Writes |
| webadmin.processId.idDescriptionPrefix | <b>About {0}: </b> |
| webadmin.processId.tooltipExplanation | The Process ID is randomly chosen to uniquely identify this process within the cluster. |
| webadmin.signup.success | Congratulations, {0}! You have successfully signed up. |
| webadmin.status.ARCHIVED | Archived |
| webadmin.status.ARCHIVE_ACKNOWLEDGED | Archiving... |
| webadmin.status.ARCHIVE_REQUESTED | Archive Requested |
| webadmin.status.FAILED_TO_ARCHIVE | Failed to Archive |
| webadmin.status.FAILED_TO_REINSTATE | Failed to Reinstate |
| webadmin.status.FAILED_TO_START | Failed to Start |
| webadmin.status.FAILED_TO_STOP | Failed to Stop |
| webadmin.status.REINSTATEMENT_ACKNOWLEDGED | Reinstating... |
| webadmin.status.REINSTATEMENT_REQUESTED | Reinstatement Requested |
| webadmin.status.RESTART_ACKNOWLEDGED | Restarting... |
| webadmin.status.RESTART_REQUESTED | Restart Requested |
| webadmin.status.RESTART_REQUIRED | Restart Required |
| webadmin.status.STARTED | Running |
| webadmin.status.START_ACKNOWLEDGED | Starting... |
| webadmin.status.START_REQUESTED | Start Requested |
| webadmin.status.STOPPED | Stopped |
| webadmin.status.STOP_ACKNOWLEDGED | Stopping... |
| webadmin.status.STOP_REQUESTED | Stop Requested |
| webadmin.time.seconds | Seconds |
| webadmin.view.config.addmodule.desc | Create a new module |
| webadmin.view.config.addmodule.success | Module {0} has been successfully created. |
| webadmin.view.config.addmodule.title | Create Module |
| webadmin.view.config.category.admin_web_console_config.title | Web Admin Console Settings |
| webadmin.view.config.category.auth_callback_scripts.title | Authentication Callback Scripts |
| webadmin.view.config.category.auth_general_for_apis.title | Auth: General for APIs |
| webadmin.view.config.category.auth_general_for_web.title | User Authentication |
| webadmin.view.config.category.auth_http_basic.title | Auth: HTTP Basic |
| webadmin.view.config.category.auth_openid_connect.title | Auth: OpenID Connect |
| webadmin.view.config.category.browser_syntax_highlighting.title | Browser Syntax Highlighting |
| webadmin.view.config.category.capability_statement_metadata.title | Capability Statement (metadata) |
| webadmin.view.config.category.channel_import.title | Channel Import |
| webadmin.view.config.category.channel_retry.title | Channel Retry |
| webadmin.view.config.category.clustermgr_kafka.title | Kafka |
| webadmin.view.config.category.clustermgr_maintenance.title | Cluster Manager Maintenance |
| webadmin.view.config.category.clustermgr_message_broker.title | Message Broker |
| webadmin.view.config.category.clustermgr_subscription_messaging.title | Subscription Messaging |
| webadmin.view.config.category.credentials.title | Credentials |
| webadmin.view.config.category.cross_origin_resource_sharing_cors.title | Cross-Origin Resource Sharing (CORS) |
| webadmin.view.config.category.database.title | Database |
| webadmin.view.config.category.empi.title | EMPI |
| webadmin.view.config.category.etl_import_csv.title | ETL Import: CSV Properties |
| webadmin.view.config.category.etl_import_source.title | ETL Import: Source |
| webadmin.view.config.category.fhir_binary_storage.title | FHIR Binary Storage |
| webadmin.view.config.category.fhir_bulk_operations.title | FHIR Bulk Operations |
| webadmin.view.config.category.fhir_configuration.title | FHIR Configuration |
| webadmin.view.config.category.fhir_consent_service.title | Consent Service |
| webadmin.view.config.category.fhir_empi.title | FHIR EMPI Server |
| webadmin.view.config.category.fhir_endpoint_conversion.title | FHIR Endpoint Conversion |
| webadmin.view.config.category.fhir_endpoint_interceptors.title | Interceptors |
| webadmin.view.config.category.fhir_endpoint_partitioning.title | FHIR Endpoint Partitioning |
| webadmin.view.config.category.fhir_endpoint_security.title | FHIR Endpoint Security |
| webadmin.view.config.category.fhir_gateway_cache.title | FHIR Gateway Cache |
| webadmin.view.config.category.fhir_gateway_target.title | FHIR Gateway Target |
| webadmin.view.config.category.fhir_interceptors.title | Interceptors |
| webadmin.view.config.category.fhir_livebundle_service.title | LiveBundle Service |
| webadmin.view.config.category.fhir_performance.title | FHIR Performance |
| webadmin.view.config.category.fhir_performance_tracing.title | FHIR Performance Tracing |
| webadmin.view.config.category.fhir_realtime_export.title | FHIR Realtime Export |
| webadmin.view.config.category.fhir_resource_types.title | FHIR Resource Types |
| webadmin.view.config.category.fhir_rest_endpoint.title | FHIR REST Endpoint |
| webadmin.view.config.category.fhir_search.title | FHIR Search |
| webadmin.view.config.category.fhir_storage_module_validation_svcs.title | FHIR Validation Services |
| webadmin.view.config.category.fhir_storage_package_registry.title | Package Registry |
| webadmin.view.config.category.fhir_storage_partitioning.title | FHIR Storage Partitioning |
| webadmin.view.config.category.fhir_subscription_delivery.title | FHIR Subscription Delivery |
| webadmin.view.config.category.fhir_subscription_persistence.title | FHIR Subscription Persistence |
| webadmin.view.config.category.hl7v2_fhir_mapper_forced_namespace_mode.title | HL7 v2.x Mapper - Forced Namespace Mode |
| webadmin.view.config.category.hl7v2_fhir_mapper_general.title | HL7 v2.x Mapper - General |
| webadmin.view.config.category.hl7v2_fhir_mapper_medications.title | HL7 v2.x Mapper - Medications |
| webadmin.view.config.category.hl7v2_fhir_mapper_obr.title | HL7 v2.x Mapper - OBR |
| webadmin.view.config.category.hl7v2_fhir_mapper_observation_group.title | HL7 v2.x to FHIR Mapper - OBSERVATION Group |
| webadmin.view.config.category.hl7v2_fhir_mapper_order_observation_group.title | HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group |
| webadmin.view.config.category.hl7v2_fhir_mapper_pv1.title | HL7 v2.x Mapper - PV1 |
| webadmin.view.config.category.hl7v2_listener_script.title | HL7 v2.x Listener Script |
| webadmin.view.config.category.hl7v2_mllp_listener.title | HL7 v2.x MLLP Listener |
| webadmin.view.config.category.hl7v2_mllp_sender.title | HL7 v2.x MLLP Sender |
| webadmin.view.config.category.hl7v2_out_mapper_script.title | FHIR to HL7 v2.x Mapper Script |
| webadmin.view.config.category.http_access_log.title | HTTP Access Log |
| webadmin.view.config.category.http_listener.title | HTTP Listener |
| webadmin.view.config.category.http_request_pool.title | HTTP Request Pool |
| webadmin.view.config.category.http_security.title | HTTP Security |
| webadmin.view.config.category.hybrid_providers_definitions.title | Hybrid Providers Definitions |
| webadmin.view.config.category.initial_user_seeding.title | Initial User Seeding |
| webadmin.view.config.category.json_web_keyset_jwks.title | JSON Web KeySet (JWKS) |
| webadmin.view.config.category.ldap_authentication.title | LDAP Authentication |
| webadmin.view.config.category.lucene_fulltext_indexing.title | Lucene FullText Indexing |
| webadmin.view.config.category.narrative_generator.title | Narrative Generator |
| webadmin.view.config.category.openid_connect_oic.title | OpenID Connect (OIC) |
| webadmin.view.config.category.other.title | Additional Configuration |
| webadmin.view.config.category.realtime_export.title | Realtime Export |
| webadmin.view.config.category.request_validating.title | Request Validating |
| webadmin.view.config.category.security_in_saml_provider.title | SAML Provider |
| webadmin.view.config.category.security_in_script_text.title | Security Inbound Script |
| webadmin.view.config.category.security_in_smart_auth.title | Inbound SMART on FHIR Authentication |
| webadmin.view.config.category.security_in_smart_endpoints.title | Inbound SMART on FHIR Endpoints |
| webadmin.view.config.category.security_in_smart_token_validation.title | OpenID Connect Token Validation |
| webadmin.view.config.category.security_oidc_federation.title | OAuth2/OIDC Federation |
| webadmin.view.config.category.security_out_smart_callback.title | SMART Callback Script |
| webadmin.view.config.category.security_out_smart_codap.title | Cross-Organizational Data Access Profile |
| webadmin.view.config.category.security_out_smart_login_skin.title | SMART Login Skin |
| webadmin.view.config.category.security_smart_authorization.title | SMART Authorization |
| webadmin.view.config.category.security_smart_seeding.title | SMART Definitions Seeding |
| webadmin.view.config.category.sessions.title | Sessions |
| webadmin.view.config.category.tfa_security_settings.title | Two Factor Authentication |
| webadmin.view.config.category.tls_ssl_encryption.title | TLS / SSL (Encryption) |
| webadmin.view.config.category.transactionlog.title | Transaction Log |
| webadmin.view.config.category.trusted_client.title | Trusted Client |
| webadmin.view.config.empi.auto_create_mode | This setting controls the creation of a new Person resource when no existing Person exists. |
| webadmin.view.config.empi.eid_system | This setting controls the FHIR Identifier System to use for enterprise identifiers generated and/or recognized by the EMPI. |
| webadmin.view.config.empi.id | ID |
| webadmin.view.config.empi.link_rule.desc | Link Rules control the automatic creation of links between target resources (Patient, Practitioner) and master resources (Person). |
| webadmin.view.config.empi.link_rule.max_score | Max Score |
| webadmin.view.config.empi.link_rule.min_score | Min Score |
| webadmin.view.config.empi.link_rule.outcome | Outcome |
| webadmin.view.config.empi.link_rule.review_queue | Review Queue |
| webadmin.view.config.empi.module.add_reviewQueue | Add Review Queue |
| webadmin.view.config.empi.module.add_rule | Add Rule |
| webadmin.view.config.empi.module.delete_reviewQueue | Delete Review Queue |
| webadmin.view.config.empi.module.delete_rule | Delete Rule |
| webadmin.view.config.empi.module.desc | This page controls matching logic for an EMPI module. All rules around automatic and manual linking criteria are set here. Changes to this configuration are applied when the module is restarted. |
| webadmin.view.config.empi.module.header | EMPI Module: {0} |
| webadmin.view.config.empi.module.link_rules.header | Link Rules |
| webadmin.view.config.empi.module.link_rules.outcome | Outcome |
| webadmin.view.config.empi.module.reviewQueues.header | Review Queues |
| webadmin.view.config.empi.module.save | Save |
| webadmin.view.config.empi.module.standard_match_rules.desc | Standard Matching Rules are applied any time a new potential target resource (Patient, Practitioner) is created or updated in the repository. A search is performed to determine whether a master record exists matching the given criteria, and if so the <strong>weight</strong> is added to a running total. See <strong>Link Rules</strong> below to configure automatic linking based on score thresholds. |
| webadmin.view.config.empi.module.standard_match_rules.header | Standard Matching Rules |
| webadmin.view.config.empi.module.standard_match_rules.match_city | Match Address: City |
| webadmin.view.config.empi.module.standard_match_rules.match_country | Match Address: Country |
| webadmin.view.config.empi.module.standard_match_rules.match_dob | Match Date of Birth |
| webadmin.view.config.empi.module.standard_match_rules.match_gender | Match Gender |
| webadmin.view.config.empi.module.standard_match_rules.match_name_first_and_last | Match Names (Family and Given) |
| webadmin.view.config.empi.module.standard_match_rules.match_postalcode | Match Address: Postal Code |
| webadmin.view.config.empi.module.standard_match_rules.match_state | Match Address: State/Province |
| webadmin.view.config.empi.module.title | EMPI Module Configuration |
| webadmin.view.config.empi.modules.header | EMPI Modules |
| webadmin.view.config.empi.name | Name |
| webadmin.view.config.empi.no_reviewQueue | No Review Queue |
| webadmin.view.config.empi.no_reviewQueues | No Review Queues Defined |
| webadmin.view.config.empi.no_rules | No Rules Defined |
| webadmin.view.config.empi.outcome_messages.config_saved | EMPI configuration has been saved. |
| webadmin.view.config.empi.outcome_messages.invalid_node_or_module_id | Invalid node/module specified. |
| webadmin.view.config.empi.outcome_messages.invalid_weight | An invalid rule weight was entered. Please check your values and try again. |
| webadmin.view.config.empi.reviewQueue.desc | The optional ability for the configuration to specify a review queue to be added to any Person resource, that has had a link automatically added to it. |
| webadmin.view.config.empi.title | EMPI Configuration |
| webadmin.view.config.module.password.placeholder | (leave blank for no change) |
| webadmin.view.config.module.status.panel.status.running | Running |
| webadmin.view.config.module.status.panel.status.stopped | Stopped |
| webadmin.view.config.module.status.panel.status.title | Status |
| webadmin.view.config.module.status.panel.title | Node <b>{0}</b> <i class="fa fa-chevron-right" style="color: #888;"></i> Module <b>{1}</b> |
| webadmin.view.config.module.title | Module Configuration: {0} |
| webadmin.view.config.module.title.short | Module Config |
| webadmin.view.config.nav.nodePanel | Node: {0} |
| webadmin.view.config.node.modules | Manage Node Modules |
| webadmin.view.config.node.modules.add | Add Module of Type |
| webadmin.view.config.node.modules.add.to_node | to Node |
| webadmin.view.config.node.modules.desc | A node is a single running process, and it hosts any number of modules. These modules perform individual functions, and they are configured and wired together via their individual configurations. |
| webadmin.view.config.node.modules.moduleId | Module ID |
| webadmin.view.config.node.modules.nodeId | Node ID |
| webadmin.view.config.node.modules.shortName | Description |
| webadmin.view.config.node.modules.status | Status |
| webadmin.view.config.node.title | Manage Node: {0} |
| webadmin.view.config.node.title.short | Manage Node |
| webadmin.view.config.oicclients.add.access_token_validity | Access Token Validity |
| webadmin.view.config.oicclients.add.access_token_validity.desc | Tokens requested by this client will be valid for the given time period. |
| webadmin.view.config.oicclients.add.always_require_approval | Always Require Approval |
| webadmin.view.config.oicclients.add.always_require_approval.desc | If this is set to "yes", the user will always be directed to an approval page before being redirected back to the client application, even if no scopes need explicit approval. |
| webadmin.view.config.oicclients.add.authorizedGrantTypes | Authorized Grant Types |
| webadmin.view.config.oicclients.add.authorizedGrantTypes.desc | The grant types supported by the client. See <a href="/docs/security/smart_on_fhir_authorization_flows.html#authorization-flows">Grant Types Documentation</a> for information on the various types. Note that you should only enable the types of grants that you are sure that the client actually needs to support, as there are security implications for each type. |
| webadmin.view.config.oicclients.add.auto_approve_scopes | Auto-Approve Scopes |
| webadmin.view.config.oicclients.add.auto_approve_scopes.desc | This is the list of scopes that the client will auto-approve, meaning the user does not need to manually approve them (whitespace separated). Note that unlike Auto-Grant scopes, the client must still explicitly request this scope during the authorization flow in order for it to be granted. |
| webadmin.view.config.oicclients.add.auto_grant_scopes | Auto-Grant Scopes |
| webadmin.view.config.oicclients.add.auto_grant_scopes.desc | Any scopes listed here will be granted to the client every time it authorizes without requiring user approval. Unlike Auto-Approve Scopes, the user/client does not need to request any scopes listed here in order for them to be granted (whitespace separated). |
| webadmin.view.config.oicclients.add.can_introspect_tokens | Token Introspection |
| webadmin.view.config.oicclients.add.can_introspect_tokens.any | Any Tokens |
| webadmin.view.config.oicclients.add.can_introspect_tokens.desc | If enabled, this client will be eligible to introspect tokens. |
| webadmin.view.config.oicclients.add.can_introspect_tokens.own | Own Tokens |
| webadmin.view.config.oicclients.add.can_reuse_tokens | Token Reuse |
| webadmin.view.config.oicclients.add.can_reuse_tokens.desc | If enabled, access tokens (and <a href="/docs/security/smart_on_fhir_authorization_flows.html#refresh-flow">refresh tokens</a> if they are permitted for the client) can be reissued if the client makes multiple authorization requests with the same parameters. This can be useful for clients that are designed to frequently make the same request for tokens, in order to avoid excessive token creation. When a token is reused, callback scripts are not executed. |
| webadmin.view.config.oicclients.add.clientDetails | Client Details |
| webadmin.view.config.oicclients.add.clientDetails.allowSelfClientSecretChange | Client Secret can be changed by Client |
| webadmin.view.config.oicclients.add.clientDetails.clientId | Client ID |
| webadmin.view.config.oicclients.add.clientDetails.clientId.desc | The ID that is supplied by the client 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. <code>growth-chart</code>). |
| webadmin.view.config.oicclients.add.clientDetails.clientName | Client Name |
| webadmin.view.config.oicclients.add.clientDetails.clientName.desc | This is the name/description of this client that will be shown to end users when they are authorizing. |
| webadmin.view.config.oicclients.add.clientDetails.clientSecret | Client Secrets |
| webadmin.view.config.oicclients.add.clientDetails.clientSecret.desc | The client secret is used to authenticate the Client (as opposed to the user) with the authentication server. The credentials supplied here are used when the Client needs to communicate directly with the Authorization Server, such as during the Authorization Code flow and during the Refresh flow. See the documentation on <a href="/docs/security/smart_on_fhir_outbound_security_module.html#client-secrets">Client Secrets</a> for information on how these are used. |
| webadmin.view.config.oicclients.add.clientDetails.clientSecretRequired | Client Secret Required to Authenticate |
| webadmin.view.config.oicclients.add.clientDetails.fixedScope | Fixed Scope |
| webadmin.view.config.oicclients.add.clientDetails.fixedScope.desc | If the client is marked as a fixed scope client, all authorization requests will be treated as though the client had explicitly requested the scopes listed in the <em>Scopes</em> section. The list of requested scopes will be ignored. |
| webadmin.view.config.oicclients.add.clientDetails.rememberApprovedScopes | Remember User Approved Scopes |
| webadmin.view.config.oicclients.add.clientDetails.rememberApprovedScopes.desc | If enabled, individual users' approved scopes will be persisted. |
| webadmin.view.config.oicclients.add.oauth2_details | OAuth2 Properties |
| webadmin.view.config.oicclients.add.permissions | Client Permissions |
| webadmin.view.config.oicclients.add.permissions.desc | Use this section to grant permissions to the client itself. Note that these permissions will only be used when the client is authenticating directly, without a user present (i.e. via the <a href="/docs/security/smart_on_fhir_authorization_flows.html#client-credentials">client credentials grant type</a>). |
| webadmin.view.config.oicclients.add.redirect_urls | Authorized Redirect URLs |
| webadmin.view.config.oicclients.add.redirect_urls.desc | These are the URLs that the application is permitted to use when requesting an OAuth2 redirect. Place one URL per line. |
| webadmin.view.config.oicclients.add.refresh_token_validity | Refresh Token Validity |
| webadmin.view.config.oicclients.add.refresh_token_validity.desc | If <a href="/docs/security/smart_on_fhir_authorization_flows.html#refresh-flow">refresh tokens</a> are enabled, any refresh tokens requested by this client will be valid for the given time period. |
| webadmin.view.config.oicclients.add.save_completed | Client "{0}" has been saved. |
| webadmin.view.config.oicclients.add.scopes | Scopes |
| webadmin.view.config.oicclients.add.scopes.desc | This is the list of scopes that the client is permitted to request (whitespace separated). See <a href="/docs/security/smart_on_fhir_smile_cdr.html#smile-cdr-supported-smart-scopes">Supported Scopes Documentation</a> for information about available scopes. |
| webadmin.view.config.oicclients.add.smart_scopes | SMART Scopes |
| webadmin.view.config.oicclients.add.title | Create Client |
| webadmin.view.config.oicclients.add_client | Create Client |
| webadmin.view.config.oicclients.client_table.authorizedGrantTypes | Authorized Grant Types |
| webadmin.view.config.oicclients.client_table.clientId | Client ID |
| webadmin.view.config.oicclients.client_table.clientName | Name |
| webadmin.view.config.oicclients.client_table.module | Module |
| webadmin.view.config.oicclients.client_table.status | Status |
| webadmin.view.config.oicclients.clients_table_header | Clients |
| webadmin.view.config.oicclients.desc | This section is used to create authorized OpenID Connect Clients, which can authenticate via outbound security modules (e.g. SMART applications). |
| webadmin.view.config.oicclients.edit.clientDetails | Client Details |
| webadmin.view.config.oicclients.edit.clientDisabled | Disabled |
| webadmin.view.config.oicclients.edit.clientEnabled | Enabled |
| webadmin.view.config.oicclients.edit.title | Modify Client |
| webadmin.view.config.oicclients.no_modules | Note that there are no OpenID Connect modules configured so no clients may be created. |
| webadmin.view.config.oicclients.title | OpenID Connect Clients |
| webadmin.view.config.oicservers.add.jwks | JSON Web Keys |
| webadmin.view.config.oicservers.add.jwks.desc | This section specifies the Public JSON Web Keys associated with this server. |
| webadmin.view.config.oicservers.add.jwks.key_file | Key (File) |
| webadmin.view.config.oicservers.add.jwks.key_file.desc | For flows that require Smile CDR to verify a JWK that was signed by the remote server (i.e. the Cross-Organization Data Access Profile), this field may be populated with a JWK. Typically this JWK will contain only the public key. |
| webadmin.view.config.oicservers.add.jwks.key_text | Key (Text) |
| webadmin.view.config.oicservers.add.jwks.key_text.desc | For flows that require Smile CDR to verify a JWK that was signed by the remote server (i.e. the Cross-Organization Data Access Profile), this field may be populated with a JWK. Typically this JWK will contain only the public key. |
| webadmin.view.config.oicservers.add.oauth2_details | OAuth2 Details |
| webadmin.view.config.oicservers.add.oidc_federation.authScriptText | Authorization Script (Text) |
| webadmin.view.config.oicservers.add.oidc_federation.authScriptText.desc | When using Federated OAuth2/OIDC Login, a script is used to bridge between the user authorization details received from the federated provider and the requested authorization details in the originating SMART on FHIR application. This script is used to assign appropriate permissions and inject any other required details into the user session. It may obtain all required information by inspecting the access token details, or it may make additional service calls to fetch information. |
| webadmin.view.config.oicservers.add.oidc_federation.authorizationUrl | Authorization URL |
| webadmin.view.config.oicservers.add.oidc_federation.authorizationUrl.desc | The URL to redirect the requesting user to in order to request user authentication/authorization with the federated provider. |
| webadmin.view.config.oicservers.add.oidc_federation.cardtitle | Federated OAuth2/OIDC Login |
| webadmin.view.config.oicservers.add.oidc_federation.desc | This section will only be used for Outbound SMART Security modules with <a href="/docs/security/federated_oauth2.html">Federated OAuth2/OIDC Login</a> enabled. Settings here apply to the remote (federated) OAuth2/OIDC provider. |
| webadmin.view.config.oicservers.add.oidc_federation.jwkSetUrl | JWKSet URL |
| webadmin.view.config.oicservers.add.oidc_federation.jwkSetUrl.desc | The URL from which to obtain the federated provider's token signing public key. |
| webadmin.view.config.oicservers.add.oidc_federation.registrationId | Registration ID |
| webadmin.view.config.oicservers.add.oidc_federation.registrationId.desc | A unique identifier for the federation between Smile CDR and the federated provider. If this is left blank, a unique value will be automatically created by Smile CDR. You may choose to use a more descriptive value however, as it will appear in URLs and log statements. Since this value will appear in URL paths, only letters and numbers should be used with no whitespace. |
| webadmin.view.config.oicservers.add.oidc_federation.requestScopes | Request Scopes |
| webadmin.view.config.oicservers.add.oidc_federation.requestScopes.desc | When requesting authorization against the federated provider, this setting controls which OAuth2 scopes will be requested. Note that the scopes requested by the security module from the federated provider are independent from the scopes requested by the SMART application that is authorizing against Smile CDR. In a typical flow, a SMART on FHIR application will request SMART scopes from Smile CDR, and Smile CDR will in turn request a different set of appropriate scopes from the federated provider. |
| webadmin.view.config.oicservers.add.oidc_federation.tokenUrl | Token URL |
| webadmin.view.config.oicservers.add.oidc_federation.tokenUrl.desc | The service URL used by the SMART Outbound Security module for code exchange when requesting a token from the federated provider. |
| webadmin.view.config.oicservers.add.oidc_federation.userInfoUrl | UserInfo URL |
| webadmin.view.config.oicservers.add.oidc_federation.userInfoUrl.desc | The service URL used by the SMART Outbound Security module for requesting user details. |
| webadmin.view.config.oicservers.add.save_completed | Server "{0}" has been saved. |
| webadmin.view.config.oicservers.add.serverDetails | Server Details |
| webadmin.view.config.oicservers.add.serverDetails.issuer | Issuer |
| webadmin.view.config.oicservers.add.serverDetails.issuer.desc | The URL associated with this issuer. This URL will be provided within the <code>iss</code> claim in Access Tokens generated by this server. Note that the issuer URL serves as the identifier for a given server definition. It must be unique. Note that any trailing slash will be ignored, and this definition will still be matched if a trailing slash is present in tokens being validated. |
| webadmin.view.config.oicservers.add.serverDetails.name | Server Name |
| webadmin.view.config.oicservers.add.serverDetails.name.desc | A name to give this server (this property is just for convenience, it does not need to match any value elsewhere). |
| webadmin.view.config.oicservers.add.title | Add Server |
| webadmin.view.config.oicservers.add.tokenIntrospection | Token Introspection |
| webadmin.view.config.oicservers.add.tokenIntrospectionClientId | Client ID |
| webadmin.view.config.oicservers.add.tokenIntrospectionClientId.desc | If Smile CDR needs to perform token introspection in order to learn more about an access token, this client ID will be used. |
| webadmin.view.config.oicservers.add.tokenIntrospectionClientSecret | Client Secret |
| webadmin.view.config.oicservers.add.tokenIntrospectionClientSecret.desc | If Smile CDR needs to perform token introspection in order to learn more about an access token, this client secret will be used. |
| webadmin.view.config.oicservers.add_server | Add Server |
| webadmin.view.config.oicservers.desc | This section is used to create OpenID Connect server definitions. A server definition in this context refers to an external OpenID Connect server (i.e. 3rd party or a separate instance of Smile CDR) that is trusted to issue tokens that can be used by Smile CDR. |
| webadmin.view.config.oicservers.edit.serverDetails | Server Details |
| webadmin.view.config.oicservers.edit.title | Modify Server |
| webadmin.view.config.oicservers.no_modules | Note that there are no OpenID Connect modules defined so it is not possible to create OpenID Connect servers. |
| webadmin.view.config.oicservers.server_table.issuer | Issuer URL |
| webadmin.view.config.oicservers.server_table.module | Module |
| webadmin.view.config.oicservers.server_table.name | Name |
| webadmin.view.config.oicservers.servers_table_header | Servers |
| webadmin.view.config.oicservers.title | OpenID Connect Servers |
| webadmin.view.config.overview | This section may be used to configure storage modules, endpoints, security, and other features. Smile CDR is divided into modules that are individually configured according to the needs of the deployment. |
| webadmin.view.config.searchparams.add.action | Add New |
| webadmin.view.config.searchparams.add.success | Search parameter {0} has been added. |
| webadmin.view.config.searchparams.add.title.short | Add Search Parameter |
| webadmin.view.config.searchparams.add_or_edit.no_code | Search parameters must have a code specified. |
| webadmin.view.config.searchparams.add_or_edit.no_path | Search parameters must have a path specified. |
| webadmin.view.config.searchparams.add_or_edit.no_resource | Search parameters must have a Resource/Base specified. |
| webadmin.view.config.searchparams.add_or_edit.no_status | Search parameters must have a status specified. |
| webadmin.view.config.searchparams.add_or_edit.no_type | Search parameters must have a type specified. |
| webadmin.view.config.searchparams.add_or_edit.properties | Search Parameter Properties |
| webadmin.view.config.searchparams.edit.success | Search parameter {0} has been saved. |
| webadmin.view.config.searchparams.edit.title.short | Edit Search Parameter |
| webadmin.view.config.searchparams.fhir_status.ACTIVE | Active |
| webadmin.view.config.searchparams.fhir_status.DRAFT | Draft (Disabled) |
| webadmin.view.config.searchparams.fhir_status.RETIRED | Retired (Disabled) |
| webadmin.view.config.searchparams.fhir_status.UNKNOWN | Unknown |
| webadmin.view.config.searchparams.no_modules.message | No FHIR Storage modules have been defined. |
| webadmin.view.config.searchparams.sync_status.INDEXING | Indexing |
| webadmin.view.config.searchparams.sync_status.SYNCHRONIZED | Synchronized |
| webadmin.view.config.searchparams.sync_status.UNSYNCHRONIZED | Unsynchronized |
| webadmin.view.config.searchparams.table.header.code | Code |
| webadmin.view.config.searchparams.table.header.description | Description |
| webadmin.view.config.searchparams.table.header.last_used | Last Used |
| webadmin.view.config.searchparams.table.header.overall_count | Overall Count |
| webadmin.view.config.searchparams.table.header.path | Path |
| webadmin.view.config.searchparams.table.header.resource | Base/Resource |
| webadmin.view.config.searchparams.table.header.resource_spread | Resource Spread |
| webadmin.view.config.searchparams.table.header.status | Status |
| webadmin.view.config.searchparams.table.header.title | Title |
| webadmin.view.config.searchparams.table.header.type | Type |
| webadmin.view.config.searchparams.table.header.value_spread | Value Spread |
| webadmin.view.config.searchparams.title.short | Search Parameters |
| webadmin.view.config.title | Configuration |
| webadmin.view.config.title.short | Config |
| webadmin.view.config.usermgr.add_user.action | Add User |
| webadmin.view.config.usermgr.add_user.desc | Use this form to create a new user record |
| webadmin.view.config.usermgr.add_user.saved | User {0} has been created. |
| webadmin.view.config.usermgr.add_user.title | Add User |
| webadmin.view.config.usermgr.change_password | Change password: {0} |
| webadmin.view.config.usermgr.edit_user | Edit User: {0} |
| webadmin.view.config.usermgr.edit_user.desc | Use this form to modify the user record |
| webadmin.view.config.usermgr.edit_user.saved | User {0} has been saved. Note that changes may take a few moments to propagate. |
| webadmin.view.config.usermgr.filter.search | Search |
| webadmin.view.config.usermgr.filter.search.placeholder | (Username or Family Name) |
| webadmin.view.config.usermgr.title | User Manager |
| webadmin.view.config.usermgr.title.short | User Manager |
| webadmin.view.config.usermgr.users_table.default_launch_contexts.desc | Default launch contexts are contexts associated with a user by default for the purpose of supplying a <em>launch context</em> claim during SMART on FHIR app launch. |
| webadmin.view.config.usermgr.users_table.default_launch_contexts.encounter | Encounter |
| webadmin.view.config.usermgr.users_table.default_launch_contexts.header | Default Launch Contexts |
| webadmin.view.config.usermgr.users_table.default_launch_contexts.location | Location |
| webadmin.view.config.usermgr.users_table.default_launch_contexts.patient | Patient |
| webadmin.view.config.usermgr.users_table.demographics | Demographics |
| webadmin.view.config.usermgr.users_table.disabled | Disabled |
| webadmin.view.config.usermgr.users_table.email | Email Address |
| webadmin.view.config.usermgr.users_table.expires | Account Expires |
| webadmin.view.config.usermgr.users_table.familyName | Family Name |
| webadmin.view.config.usermgr.users_table.flag.account_disabled | Disabled |
| webadmin.view.config.usermgr.users_table.flag.account_locked | Locked |
| webadmin.view.config.usermgr.users_table.flag.external | External |
| webadmin.view.config.usermgr.users_table.flag.service_account | Service Account |
| webadmin.view.config.usermgr.users_table.flag.system_user | System User |
| webadmin.view.config.usermgr.users_table.flags | Flags |
| webadmin.view.config.usermgr.users_table.givenName | Given Name |
| webadmin.view.config.usermgr.users_table.lastActive | Last Active Date |
| webadmin.view.config.usermgr.users_table.locked | Locked |
| webadmin.view.config.usermgr.users_table.module | Module |
| webadmin.view.config.usermgr.users_table.notes | User Notes |
| webadmin.view.config.usermgr.users_table.notes.header | Notes |
| webadmin.view.config.usermgr.users_table.password | Password |
| webadmin.view.config.usermgr.users_table.password.placeholder | (leave blank for no change) |
| webadmin.view.config.usermgr.users_table.roles | Roles and Permissions |
| webadmin.view.config.usermgr.users_table.security | Security |
| webadmin.view.config.usermgr.users_table.service_account | Service Account |
| webadmin.view.config.usermgr.users_table.service_account.desc | A service account is an account used by a system for backend processing (as opposed to for user activity). Service accounts to not generate audit log entries. |
| webadmin.view.config.usermgr.users_table.tfa | Two Factor Authentication |
| webadmin.view.config.usermgr.users_table.tfa.disable | Disable |
| webadmin.view.config.usermgr.users_table.tfa.enabled | Two Factor Authentication is enabled for this account. |
| webadmin.view.config.usermgr.users_table.tfa.enabledAt | Enabled At |
| webadmin.view.config.usermgr.users_table.tfa.not_confirmed | Two Factor Authentication was activated but not confirmed for this account. |
| webadmin.view.config.usermgr.users_table.tfa.not_confirmed_short | Unconfirmed |
| webadmin.view.config.usermgr.users_table.tfa.not_enabled | Two Factor Authentication is not enabled for this account. |
| webadmin.view.config.usermgr.users_table.tfa.not_enabled_short | No |
| webadmin.view.config.usermgr.users_table.tfa.totp_enabled_short | TOTP |
| webadmin.view.config.usermgr.users_table.tfa_short | 2FA |
| webadmin.view.config.usermgr.users_table.username | Username |
| webadmin.view.config.usermgr.users_table_header | Users |
| webadmin.view.docs.hl7v2.in.title | HL7 v2 Input Specification |
| webadmin.view.docs.intro.title | Introduction |
| webadmin.view.docs.title | Documentation |
| webadmin.view.error.title | Error |
| webadmin.view.home.title | Home |
| webadmin.view.home_not_signed_in.title | Smile CDR (not signed in) |
| webadmin.view.runtime.auditLog.header.action | Action |
| webadmin.view.runtime.auditLog.header.action.code | Code |
| webadmin.view.runtime.auditLog.header.action.display | Display Name |
| webadmin.view.runtime.auditLog.header.action.system | System |
| webadmin.view.runtime.auditLog.header.client | Client |
| webadmin.view.runtime.auditLog.header.datetime | Date/Time |
| webadmin.view.runtime.auditLog.header.endpoint | Endpoint |
| webadmin.view.runtime.auditLog.header.endpoint.module | Module |
| webadmin.view.runtime.auditLog.header.endpoint.node | Node |
| webadmin.view.runtime.auditLog.header.id | Id |
| webadmin.view.runtime.auditLog.header.remote_address | Remote Address |
| webadmin.view.runtime.auditLog.header.target.module | Target Module |
| webadmin.view.runtime.auditLog.header.target.module.moduleId | Module ID |
| webadmin.view.runtime.auditLog.header.target.module.nodeId | Node ID |
| webadmin.view.runtime.auditLog.header.target.resource | Target Resource |
| webadmin.view.runtime.auditLog.header.target.resource.moduleId | Persistence Module ID |
| webadmin.view.runtime.auditLog.header.target.resource.nodeId | Persistence Node ID |
| webadmin.view.runtime.auditLog.header.target.resource.requestValidatingResult | Request Validating Result |
| webadmin.view.runtime.auditLog.header.target.resource.requestValidatingResult.no_validation | Not validated |
| webadmin.view.runtime.auditLog.header.target.resource.requestValidatingResult.validation_failed_with_error | Validation failed with error(s) |
| webadmin.view.runtime.auditLog.header.target.resource.requestValidatingResult.validation_failed_with_warning | Validation failed with warning(s) |
| webadmin.view.runtime.auditLog.header.target.resource.requestValidatingResult.validation_passed | Validation passed |
| webadmin.view.runtime.auditLog.header.target.resource.resourceId | Resource ID |
| webadmin.view.runtime.auditLog.header.target.resource.resourceVersion | Resource Version |
| webadmin.view.runtime.auditLog.header.target.user | Target User |
| webadmin.view.runtime.auditLog.header.targets | Targets |
| webadmin.view.runtime.auditLog.header.targets.desc | The audit event is the focal object that the event is viewing/changing/acting on/etc. |
| webadmin.view.runtime.auditLog.header.user | User |
| webadmin.view.runtime.auditLog.title | Audit Log (User Actions) |
| webadmin.view.runtime.auditLog.viewentry.title | View Audit Log Entry |
| webadmin.view.runtime.auditLog.viewentry.title.short | View Entry |
| webadmin.view.runtime.node.nodePanel | Node: |
| webadmin.view.runtime.node.process_information | Process Information |
| webadmin.view.runtime.node.status | Status |
| webadmin.view.runtime.node.statusTime | Status Time |
| webadmin.view.runtime.status.graph.active_searches.byline | This chart shows the number of currently active searches. An active search remains available for paging in the database (via next/prev links) until it has been purged after a configurable timeout period. |
| webadmin.view.runtime.status.graph.active_searches.title | Active Searches |
| webadmin.view.runtime.status.graph.authentication_failure_count.suffix | Attempts |
| webadmin.view.runtime.status.graph.authentication_failure_count.title | Failed Authentication Attempts |
| webadmin.view.runtime.status.graph.authentication_success_count.suffix | Attempts |
| webadmin.view.runtime.status.graph.authentication_success_count.title | Successful Authentication Attempts |
| webadmin.view.runtime.status.graph.cpu_stats.jvm.description | This chart shows the amount of processing time consumed by each individual Smile CDR process. |
| webadmin.view.runtime.status.graph.cpu_stats.jvm.title | JVM CPU Usage |
| webadmin.view.runtime.status.graph.cpu_stats.system.description | This chart shows the amount of processing time consumed by the host where the Smile CDR process is running (including CPU cycles consumed by Smile CDR, but also including cycles consumed by other processes). |
| webadmin.view.runtime.status.graph.cpu_stats.system.title | System CPU Usage |
| webadmin.view.runtime.status.graph.date_range_selector | Chart Date Range |
| webadmin.view.runtime.status.graph.db_connection_pool.title | Database Connection Pool: Active Connections |
| webadmin.view.runtime.status.graph.fhir_persistence_across_cluster.title | FHIR Invocation Count |
| webadmin.view.runtime.status.graph.fulltext_index_queue.title | FullText Index Queue Size |
| webadmin.view.runtime.status.graph.http_distribution.title | HTTP Cluster Distribution |
| webadmin.view.runtime.status.graph.http_pipeline_throughput.2xx | HTTP 2xx (Ok) |
| webadmin.view.runtime.status.graph.http_pipeline_throughput.3xx | HTTP 3xx (Ok) |
| webadmin.view.runtime.status.graph.http_pipeline_throughput.4xx | HTTP 4xx (Client Error) |
| webadmin.view.runtime.status.graph.http_pipeline_throughput.5xx | HTTP 5xx (Server Error) |
| webadmin.view.runtime.status.graph.http_threadpool.busy.title | HTTP Pipeline Thread Pool: Busy Threads |
| webadmin.view.runtime.status.graph.http_throughput.title | HTTP Pipeline Throughput |
| webadmin.view.runtime.status.graph.invoc_count.title | Invocation Counts |
| webadmin.view.runtime.status.graph.jvm_cpu_stats.title | CPU Usage |
| webadmin.view.runtime.status.graph.jvm_cpu_stats_allnodes.byline | This chart shows the CPU usage for all nodes in the cluster. |
| webadmin.view.runtime.status.graph.jvm_memory_stats.title | Memory Usage |
| webadmin.view.runtime.status.graph.meter_latency.avg.description | <b>Average Latency</b>: This chart shows the average latency experienced across all requests during the measurement period. |
| webadmin.view.runtime.status.graph.meter_latency.max.description | <b>Maximum Latency</b>: This chart shows the maximum latency experienced by any request during the measurement period. |
| webadmin.view.runtime.status.graph.meter_latency.min.description | <b>Minimum Latency</b>: This chart shows the minimum latency experienced by any request during the measurement period. |
| webadmin.view.runtime.status.graph.meter_latency.title | Invocation Latency |
| webadmin.view.runtime.status.graph.resources.suffix | Resources |
| webadmin.view.runtime.status.graph.searches.suffix | Searches |
| webadmin.view.runtime.status.graph.session_count.suffix | Sessions |
| webadmin.view.runtime.status.graph.session_count.title | Active User Sessions |
| webadmin.view.runtime.status.graph.val_suffix.invocs_per_10_minute | / 10 min |
| webadmin.view.runtime.status.graph.val_suffix.invocs_per_minute | / minute |
| webadmin.view.runtime.status.graph.yaxis.invocs_per_10_minute | Invocations / 10 min |
| webadmin.view.runtime.status.graph.yaxis.invocs_per_minute | Invocations / minute |
| webadmin.view.runtime.status.jump_to.module_config | Module Config |
| webadmin.view.runtime.status.jump_to.module_runtime_status | Module Runtime Status |
| webadmin.view.runtime.status.jump_to.prefix | Jump to: |
| webadmin.view.runtime.status.title | Monitors and Health Checks |
| webadmin.view.runtime.title | Runtime |
| webadmin.view.runtime.transactionLog.header.client | Client |
| webadmin.view.runtime.transactionLog.header.code | Code |
| webadmin.view.runtime.transactionLog.header.datetime | Date/Time |
| webadmin.view.runtime.transactionLog.header.endpoint | Endpoint |
| webadmin.view.runtime.transactionLog.header.id | Id |
| webadmin.view.runtime.transactionLog.header.processingTime | Process Outcome |
| webadmin.view.runtime.transactionLog.header.source | Source |
| webadmin.view.runtime.transactionLog.header.subtype | SubType |
| webadmin.view.runtime.transactionLog.header.type | Type |
| webadmin.view.runtime.transactionLog.header.user | User |
| webadmin.view.runtime.transactionLog.modulePrefix | Module: |
| webadmin.view.runtime.transactionLog.noEvents | No events found matching selected criteria. |
| webadmin.view.runtime.transactionLog.noMoreEvents | No more events found matching selected criteria. Found {0} events in total. |
| webadmin.view.runtime.transactionLog.nodePrefix | Node: |
| webadmin.view.runtime.transactionLog.title | Transaction Log (System Actions) |
| webadmin.view.runtime.transactionLog.usernamePrefix | Username |
| webadmin.view.runtime.transactionLogEntry.body | Body |
| webadmin.view.runtime.transactionLogEntry.endpoint | Endpoint |
| webadmin.view.runtime.transactionLogEntry.eventTiming | Event Timing |
| webadmin.view.runtime.transactionLogEntry.eventType | Event Type |
| webadmin.view.runtime.transactionLogEntry.httpRequest | HTTP Request |
| webadmin.view.runtime.transactionLogEntry.httpResponseStatus | HTTP Response Status |
| webadmin.view.runtime.transactionLogEntry.initialTimestamp | Initial Timestamp |
| webadmin.view.runtime.transactionLogEntry.localAddress | Local Address |
| webadmin.view.runtime.transactionLogEntry.outcome | Outcome |
| webadmin.view.runtime.transactionLogEntry.processingTime | Processing Time |
| webadmin.view.runtime.transactionLogEntry.remoteAddress | Remote Address |
| webadmin.view.runtime.transactionLogEntry.requestValidatingResult | Request Validating Result |
| webadmin.view.runtime.transactionLogEntry.requestValidatingResult.no_validation | Not validated |
| webadmin.view.runtime.transactionLogEntry.requestValidatingResult.validation_failed_with_error | Validation failed with error(s) |
| webadmin.view.runtime.transactionLogEntry.requestValidatingResult.validation_failed_with_warning | Validation failed with warning(s) |
| webadmin.view.runtime.transactionLogEntry.requestValidatingResult.validation_passed | Validation passed |
| webadmin.view.runtime.transactionLogEntry.subscriptionId | Subscription ID |
| webadmin.view.runtime.transactionLogEntry.timeStamp | Timestamp |
| webadmin.view.runtime.transactionLogEntry.title | View Transaction {0} |
| webadmin.view.runtime.transactionLogEntry.transactionLogEventView | Transaction Log Event View |
| webadmin.view.security_out_smart.authorize.header | Authorizing application: {0} |
| webadmin.view.security_out_smart.authorize.scopesheader | This application is requesting the following permissions: |
| webadmin.view.security_out_smart.authorize.title | Login to SMART Application |
| webadmin.view.security_out_smart.error.dont_have_profile_scope | Authentication does not have the 'profile' scope |
| webadmin.view.security_out_smart.error.no_access_to_resource | No rights to view resource {0} |
| webadmin.view.security_out_smart.revoke.clientsheader | Click "Revoke" beside the application for which you would like to revoke access: |
| webadmin.view.security_out_smart.revoke.header | Revoke access from SMART Applications |
| webadmin.view.security_out_smart.revoke.title | Revoke access to SMART Applications |
| webadmin.view.security_out_smart.scope.cdr_all_user_authorities.name | All Granted Authorities |
| webadmin.view.security_out_smart.scope.email.name | View Your E-mail Address |
| webadmin.view.security_out_smart.scope.launch.name | Launch SMART on FHIR Application |
| webadmin.view.security_out_smart.scope.launch/encounter.name | Access Encounter Context |
| webadmin.view.security_out_smart.scope.launch/location.name | Access Location Context |
| webadmin.view.security_out_smart.scope.launch/patient.name | Access Patient Context |
| webadmin.view.security_out_smart.scope.offline_access.name | Stay Connected (Offline Access) |
| webadmin.view.security_out_smart.scope.online_access.name | Stay Connected (Online Access) |
| webadmin.view.security_out_smart.scope.openid.name | OpenID Connect |
| webadmin.view.security_out_smart.scope.patient/*.read.name | Read Patient Information |
| webadmin.view.security_out_smart.scope.patient/*.write.name | Write Patient Information |
| webadmin.view.security_out_smart.scope.patient_resource_specific_read.name | Read {0} Information |
| webadmin.view.security_out_smart.scope.patient_resource_specific_write.name | Write {0} Information |
| webadmin.view.security_out_smart.scope.profile.name | View User Profile |
| webadmin.view.security_out_smart.view.signin.error | Sign-in error. Please try again. |
| webadmin.view.security_out_smart.view.signin.login | Login |
| webadmin.view.security_out_smart.view.signin.password | Password |
| webadmin.view.security_out_smart.view.signin.remember_me | Remember Me |
| webadmin.view.security_out_smart.view.signin.tfa_code | Two Factor Authentication Code |
| webadmin.view.security_out_smart.view.signin.title | Login to SMART Application |
| webadmin.view.security_out_smart.view.signin.username | Username |
| webadmin.view.signin-tfa.title | Confirm Two Factor Authentication |
| webadmin.view.signin.MISSING_LDAP_GROUP | User does not have appropriate LDAP group membership to login. |
| webadmin.view.signin.NO_PERMISSION_TO_SYSTEM | User does not have permission to access this system. |
| webadmin.view.signin.bad_password | Invalid username or password, please try again. |
| webadmin.view.signin.bad_username | Invalid username or password, please try again. |
| webadmin.view.signin.error | Sign-in error. Please try again. |
| webadmin.view.signin.error_account_expired | Account has expired. |
| webadmin.view.signin.error_disabled | Your account is disabled, and you may not log in. |
| webadmin.view.signin.error_locked | Your account is locked, and you may not log in. |
| webadmin.view.signin.insufficient_access | You do not have sufficient access to sign into this system. |
| webadmin.view.signin.login | Login |
| webadmin.view.signin.password | Password |
| webadmin.view.signin.remember_me | Remember Me |
| webadmin.view.signin.tfa.auth_code | Two Factor Authenticator Code |
| webadmin.view.signin.title | Login |
| webadmin.view.signin.username | Username |
| webadmin.view.subscriptionMetrics.BEFORE_DELIVERY | Delivery Attempts |
| webadmin.view.subscriptionMetrics.DELIVERY_FAILED | Failed Delivery |
| webadmin.view.subscriptionMetrics.DELIVERY_SUCCEEDED | Successful Delivery |
| webadmin.view.subscriptionMetrics.MATCHED | Matched |
| webadmin.view.subscriptionMetrics.MATCHED_DATABASE | Matched With Database Call |
| webadmin.view.subscriptionMetrics.MATCHED_IN_MEMORY | Matched In-Memory |
| webadmin.view.subscriptionMetrics.title | Subscriptions |