engine/org.smartregister.fhircore.engine.domain.model

Package-level declarations

Types

@Serializable

data class ActionConfig(val trigger: ActionTrigger, val workflow: String? = null, val id: String? = null, val display: String? = null, val rules: List<RuleConfig>? = null, val questionnaire: QuestionnaireConfig? = null, val managingEntity: ManagingEntityConfig? = null, val params: List<ActionParameter> = emptyList(), val resourceConfig: FhirResourceConfig? = null, val toolBarHomeNavigation: ToolBarHomeNavigation = ToolBarHomeNavigation.OPEN_DRAWER, val popNavigationBackStack: Boolean? = null, val multiSelectViewConfig: MultiSelectViewConfig? = null) : Parcelable, Serializable

ActionParameter

@Serializable

data class ActionParameter(val key: String, val paramType: ActionParameterType? = null, val dataType: Enumerations.DataType? = null, val value: String, val linkId: String? = null, val resourceType: ResourceType? = null) : Parcelable, Serializable

ActionParameterType

enum ActionParameterType : Enum<ActionParameterType>

Represents different types of parameters that can be defined within the config actions

Code

@Stable

@Serializable

data class Code(var system: String? = null, var code: String? = null, var display: String? = null) : Parcelable, Serializable

CountResultConfig

@Serializable

data class CountResultConfig(val sumCounts: Boolean = true) : Parcelable, Serializable

DataQuery

@Serializable

data class DataQuery(val paramName: String, val operation: Operation = Operation.AND, val filterCriteria: List<FilterCriterionConfig>) : Parcelable, Serializable

FhirResourceConfig

@Serializable

data class FhirResourceConfig(val baseResource: ResourceConfig, val relatedResources: List<ResourceConfig> = emptyList()) : Parcelable, Serializable

Represents FHIR resources used on the register. The baseResource is the main resource used which can be accompanied by relatedResources.

FilterCriterionConfig

@Serializable(with = FilterCriterionSerializer::class)

sealed class FilterCriterionConfig : Parcelable, Serializable

KeyValueConfig

@Serializable

data class KeyValueConfig(val key: String, val value: String) : Parcelable, Serializable

Language

data class Language(val tag: String, val displayName: String)

LauncherType

enum LauncherType : Enum<LauncherType>

MultiSelectViewConfig

@Serializable

data class MultiSelectViewConfig(val resourceConfig: FhirResourceConfig, val parentIdFhirPathExpression: String, val contentFhirPathExpression: String, val rootNodeFhirPathExpression: KeyValueConfig) : Serializable, Parcelable

NestedSearchConfig

@Serializable

data class NestedSearchConfig(val resourceType: ResourceType, val referenceParam: String, val dataQueries: List<DataQuery>? = null) : Parcelable, Serializable

OverflowMenuItemConfig

@Serializable

data class OverflowMenuItemConfig(val id: Int = 1, val title: String = "", val confirmAction: Boolean = false, val icon: ImageConfig? = null, val titleColor: String = BLACK_COLOR_HEX_CODE, val backgroundColor: String? = null, val visible: String, val showSeparator: Boolean = false, val enabled: String = TRUE, val actions: List<ActionConfig> = emptyList()) : Parcelable, Serializable

QuestionnaireType

enum QuestionnaireType : Enum<QuestionnaireType>

RelatedResourceCount

@Stable

data class RelatedResourceCount(val relatedResourceType: ResourceType? = null, val parentResourceId: String? = null, val count: Long)

This model represent a count result for RepositoryResourceData. The parentResourceId refers to the id of the parent resource that we are interested in counting it's related resources.

RepositoryResourceData

@Stable

data class RepositoryResourceData(val resourceRulesEngineFactId: String? = null, val resource: Resource, val relatedResourcesMap: Map<String, List<Resource>> = emptyMap(), val relatedResourcesCountMap: Map<String, List<RelatedResourceCount>> = emptyMap(), val secondaryRepositoryResourceData: List<RepositoryResourceData>? = null)

This represent the outcome of a query performed via the Repository. The query performed can either return a count or map of Resource's (including nested resources flattened in the map). The optional property resourceRulesEngineFactId that can be used as the key in the rules factory facts map (each fact is represented as a key-value pair). The key for the relatedResourcesMap will either be the configured unique id for representing the resource(s) in Rules engine Facts map or the ResourceType. secondaryRepositoryResourceData returns a list of independent resources (which may include nested resource(s)) that have NO relationship with the base resource.

ResourceConfig

@Serializable

data class ResourceConfig(val id: String? = null, val resource: ResourceType, val filterId: String? = null, val searchParameter: String? = null, val isRevInclude: Boolean = true, val dataQueries: List<DataQuery>? = null, val relatedResources: List<ResourceConfig> = emptyList(), val sortConfigs: List<SortConfig> = emptyList(), val resultAsCount: Boolean = false, val countResultConfig: CountResultConfig? = CountResultConfig(), val nestedSearchResources: List<NestedSearchConfig>? = null, val configRules: List<RuleConfig>? = emptyList(), val planDefinitions: List<String>? = null, val attributesToUpdate: List<KeyValueConfig>? = emptyList(), val filterFhirPathExpressions: List<KeyValueConfig>? = emptyList()) : Parcelable, Serializable

This is the data class used to hold configurations for FHIR resources used in Profile and Registers. The property resource represents the ResourceType. id is a unique name used as key in the rules engine fact's map. resultAsCount property is used to indicate whether to perform count SQL query or not. Count queries return a count whereas search queries return the result of SQL SELECT statement.

ResourceData

@Stable

data class ResourceData(val baseResourceId: String, val baseResourceType: ResourceType, val computedValuesMap: Map<String, Any>, val listResourceDataMap: Map<String, List<ResourceData>>? = null)

Represent the resource types that are used on a Register.

ResourceFilterExpression

@Serializable

data class ResourceFilterExpression(val conditionalFhirPathExpressions: List<String>, val matchAll: Boolean = true, val resourceType: ResourceType? = null) : Serializable, Parcelable

RoundingStrategy

enum RoundingStrategy : Enum<RoundingStrategy>

Represents different types of rounding strategies that can be applied to Decimal numbers within the application

RuleConfig

@Serializable

data class RuleConfig(val name: String, val description: String = "", val priority: Int = 1, val condition: String = "true", val actions: List<String>) : Serializable, Parcelable

ServiceMemberIcon

enum ServiceMemberIcon : Enum<ServiceMemberIcon>

ServiceStatus

enum ServiceStatus : Enum<ServiceStatus>

SnackBarMessageConfig

@Serializable

data class SnackBarMessageConfig(val message: String = "", val actionLabel: String? = null, val duration: SnackbarDuration = SnackbarDuration.Short, val snackBarActions: List<ActionConfig> = emptyList()) : Serializable, Parcelable

SortConfig

@Serializable

data class SortConfig(val paramName: String? = null, val dataType: Enumerations.DataType, val order: Order = Order.ASCENDING, val fhirPathExpression: String = "") : Parcelable, Serializable

SyncLocationState

@Serializable

data class SyncLocationState(val locationId: String, val parentLocationId: String?, val toggleableState: ToggleableState)

ToolBarHomeNavigation

enum ToolBarHomeNavigation : Enum<ToolBarHomeNavigation>

TopBarConfig

@Serializable

data class TopBarConfig(val title: CompoundTextProperties? = null, val collapsible: Boolean = true, val content: List<ViewProperties> = emptyList(), val toolBarHomeNavigation: ToolBarHomeNavigation = ToolBarHomeNavigation.NAVIGATE_BACK, val showOverflowMenu: Boolean = true) : Parcelable, Serializable

TopScreenSectionConfig

@Serializable

data class TopScreenSectionConfig(val searchBar: RegisterContentConfig?, val title: String? = null, val menuIcons: List<ImageProperties>? = null)

ViewType

enum ViewType : Enum<ViewType>

Represents different types of views that can be rendered via compose

Functions

isDefault

fun QuestionnaireConfig.isDefault(): Boolean

isEditable

fun QuestionnaireConfig.isEditable(): Boolean

isReadOnly

fun QuestionnaireConfig.isReadOnly(): Boolean