diff --git a/dokka/engine/org.smartregister.fhircore.engine.configuration.app/-coding-system-config/index.html b/dokka/engine/org.smartregister.fhircore.engine.configuration.app/-coding-system-config/index.html index 05de7271d6..c35d07f7c0 100644 --- a/dokka/engine/org.smartregister.fhircore.engine.configuration.app/-coding-system-config/index.html +++ b/dokka/engine/org.smartregister.fhircore.engine.configuration.app/-coding-system-config/index.html @@ -62,7 +62,7 @@
This configuration provides the various Code systems used in the application and how they are to be used. For instance the code with CodingSystemUsage.LOCATION_LINKAGE type of usage will be used to link any FHIR resource to a Location via a List resource. The List resource will include the Location as it's subject and the linked resources in it's entry property. The List resource will have a special code used to differentiate it from other List resources.
This configuration provides the various Code systems used in the application and how they are to be used. For instance the code with CodingSystemUsage.LOCATION_LINKAGE type of usage will be used to link any FHIR resource to a Location via a List resource. The List resource will include the Location as it's subject and the linked resources in it's entry property. The List resource will have a special code used to differentiate it from other List resources.
This configuration provides the various Code systems used in the application and how they are to be used. For instance the code with CodingSystemUsage.LOCATION_LINKAGE type of usage will be used to link any FHIR resource to a Location via a List resource. The List resource will include the Location as it's subject and the linked resources in it's entry property. The List resource will have a special code used to differentiate it from other List resources.
This configuration provides the various Code systems used in the application and how they are to be used. For instance the code with CodingSystemUsage.LOCATION_LINKAGE type of usage will be used to link any FHIR resource to a Location via a List resource. The List resource will include the Location as it's subject and the linked resources in it's entry property. The List resource will have a special code used to differentiate it from other List resources.
An abstract for view properties. This is needed so we can serialize/deserialize view properties map into different data classes. Common view properties MUST be implemented by subclasses for access.
An abstract for view properties. This is needed so we can serialize/deserialize view properties map into different data classes. Common view properties MUST be implemented by subclasses for access.
An abstract for view properties. This is needed so we can serialize/deserialize view properties map into different data classes. Common view properties MUST be implemented by subclasses for access.
An abstract for view properties. This is needed so we can serialize/deserialize view properties map into different data classes. Common view properties MUST be implemented by subclasses for access.
Retrieve translation configuration for the provided bundleName. The Bundle value is retrieved from configsJsonMap can be directly converted to a ResourceBundle.
Retrieve translation configuration for the provided bundleName. The Bundle value is retrieved from configsJsonMap can be directly converted to a ResourceBundle.
Retrieve translation configuration for the provided bundleName. The Bundle value is retrieved from configsJsonMap can be directly converted to a ResourceBundle.
Retrieve translation configuration for the provided bundleName. The Bundle value is retrieved from configsJsonMap can be directly converted to a ResourceBundle.
This function uses the provided currentRefreshToken to get a new auth token or throws HttpException or UnknownHostException exceptions
This function uses the provided currentRefreshToken to get a new auth token or throws HttpException or UnknownHostException exceptions
This function uses the provided currentRefreshToken to get a new auth token or throws HttpException or UnknownHostException exceptions
This function uses the provided currentRefreshToken to get a new auth token or throws HttpException or UnknownHostException exceptions
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.
Data filtering: dataQueries are used to apply conditions for filtering data in the WHERE clause of the SQL statement run against the SQLite database. The data queries follow the pattern provided by the Search DSL. NestedSearchConfig can be used to apply conditional filter against other resources. Example: Retrieve all Patients with Condition Diabetes; result will be a list of Patient (Condition resources will NOT be included in the returned results)
Sorting: Some resource properties support sorting. To configure how to sort the data SortConfig can be used.
isRevInclude property is a required configuration (default: true) needed to determine whether to use forward or reverse include operations of the Search DSL to include the configured resource in the final result of the query.
If isRevInclude is set to false
, the configured resource will be retrieved via the referenced property on the parent resource, provided via searchParameter. Usage example: Retrieve all Group as well as the Patient resources referenced in the 'Group.member' property.
If isRevInclude is set to true
, the database will query for any of the configured resources that include the parent resource in their references (the reverse of forward include). Usage example: Retrieve all Patients including their Immunizations, Observation etc in the result.
Both reverse and forward include require searchParameter which refers to the name of the property or search parameter used to reference other resources.
A ResourceConfig can have nested list of other ResourceConfig configured via relatedResources property.
CountResultConfig is used to configure how to compute the total counts returned. If CountResultConfig.sumCounts is set to true, all the related resources counts are computed once via one query. However there may be scenarios to return count for each related resource e.g. for every Patient in a Group, return their Tasks count.
filterId Refers to a unique ID used to identify the Resource in data filter screen (The data filter screen renders a questionnaire with the linkIds for the content to be filtered)
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.
Data filtering: dataQueries are used to apply conditions for filtering data in the WHERE clause of the SQL statement run against the SQLite database. The data queries follow the pattern provided by the Search DSL. NestedSearchConfig can be used to apply conditional filter against other resources. Example: Retrieve all Patients with Condition Diabetes; result will be a list of Patient (Condition resources will NOT be included in the returned results)
Sorting: Some resource properties support sorting. To configure how to sort the data SortConfig can be used.
isRevInclude property is a required configuration (default: true) needed to determine whether to use forward or reverse include operations of the Search DSL to include the configured resource in the final result of the query.
If isRevInclude is set to false
, the configured resource will be retrieved via the referenced property on the parent resource, provided via searchParameter. Usage example: Retrieve all Group as well as the Patient resources referenced in the 'Group.member' property.
If isRevInclude is set to true
, the database will query for any of the configured resources that include the parent resource in their references (the reverse of forward include). Usage example: Retrieve all Patients including their Immunizations, Observation etc in the result.
Both reverse and forward include require searchParameter which refers to the name of the property or search parameter used to reference other resources.
A ResourceConfig can have nested list of other ResourceConfig configured via relatedResources property.
CountResultConfig is used to configure how to compute the total counts returned. If CountResultConfig.sumCounts is set to true, all the related resources counts are computed once via one query. However there may be scenarios to return count for each related resource e.g. for every Patient in a Group, return their Tasks count.
filterId Refers to a unique ID used to identify the Resource in data filter screen (The data filter screen renders a questionnaire with the linkIds for the content to be filtered)
Represents FHIR resources used on the register. The baseResource is the main resource used which can be accompanied by relatedResources.
Represents FHIR resources used on the register. The baseResource is the main resource used which can be accompanied by relatedResources.
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.
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.
This function is responsible for formatting a date for whatever expectedFormat we need. It takes an inputDate string along with the inputDateFormat so it can convert it to the Date and then it gives output in expected Format, expectedFormat is by default (Example: Mon, Nov 5 2021)
This function is responsible for formatting a date for whatever expectedFormat we need. It takes an input a date as input and then it gives output in expected Format, expectedFormat is by default (Example: Mon, Nov 5 2021)
This function is responsible for formatting a date for whatever expectedFormat we need. It takes an inputDate string along with the inputDateFormat so it can convert it to the Date and then it gives output in expected Format, expectedFormat is by default (Example: Mon, Nov 5 2021)
This function is responsible for formatting a date for whatever expectedFormat we need. It takes an input a date as input and then it gives output in expected Format, expectedFormat is by default (Example: Mon, Nov 5 2021)
This function is responsible for formatting a date for whatever expectedFormat we need. It takes an input a date as input and then it gives output in expected Format, expectedFormat is by default (Example: Mon, Nov 5 2021)
This function is responsible for formatting a date for whatever expectedFormat we need. It takes an inputDate string along with the inputDateFormat so it can convert it to the Date and then it gives output in expected Format, expectedFormat is by default (Example: Mon, Nov 5 2021)
This function is responsible for formatting a date for whatever expectedFormat we need. It takes an input a date as input and then it gives output in expected Format, expectedFormat is by default (Example: Mon, Nov 5 2021)
This function is responsible for formatting a date for whatever expectedFormat we need. It takes an inputDate string along with the inputDateFormat so it can convert it to the Date and then it gives output in expected Format, expectedFormat is by default (Example: Mon, Nov 5 2021)
This function takes inputDate and returns a difference (for examples 7 hours, 2 day, 5 months, 3 years etc)
This function takes inputDateString like 2022-7-1 and returns a difference (for examples 7 hours ago, 2 days ago, 5 months ago, 3 years ago etc) inputDateString can give given as 2022-02 or 2022
This function takes inputDate and returns a difference (for examples 7 hours, 2 day, 5 months, 3 years etc)
This function takes inputDateString like 2022-7-1 and returns a difference (for examples 7 hours ago, 2 days ago, 5 months ago, 3 years ago etc) inputDateString can give given as 2022-02 or 2022
This function takes inputDate and returns a difference (for examples 7 hours, 2 day, 5 months, 3 years etc)
This function takes inputDateString like 2022-7-1 and returns a difference (for examples 7 hours ago, 2 days ago, 5 months ago, 3 years ago etc) inputDateString can give given as 2022-02 or 2022
This function takes inputDate and returns a difference (for examples 7 hours, 2 day, 5 months, 3 years etc)
This function takes inputDateString like 2022-7-1 and returns a difference (for examples 7 hours ago, 2 days ago, 5 months ago, 3 years ago etc) inputDateString can give given as 2022-02 or 2022
This function calculates the age from date then translates the abbreviation for the the periods. If year is 0 display the age in years, if year is 0 then display age in month and weeks, if month is 0 display age in weeks and days otherwise if week is 0 display age in days.
This function calculates the age from date then translates the abbreviation for the the periods. If year is 0 display the age in years, if year is 0 then display age in month and weeks, if month is 0 display age in weeks and days otherwise if week is 0 display age in days.
This function calculates the age from date then translates the abbreviation for the the periods. If year is 0 display the age in years, if year is 0 then display age in month and weeks, if month is 0 display age in weeks and days otherwise if week is 0 display age in days.
This function calculates the age from date then translates the abbreviation for the the periods. If year is 0 display the age in years, if year is 0 then display age in month and weeks, if month is 0 display age in weeks and days otherwise if week is 0 display age in days.
Extract a Resource's birthDate if it's an available field
Extract a Resource's birthDate if it's an available field
Wrapper method around the Java text formatter
Wrapper method around the Java text formatter
Parses a string that represents a duration in ISO-8601 format and returns the parsed Duration value. If parsing fails a default of 1 day duration value is returned
Parses a string that represents a duration in ISO-8601 format and returns the parsed Duration value. If parsing fails a default of 1 day duration value is returned
String of the interpolated template string
base name of the bundle e.g. strings
the specific Locale, e.g. Locale.FRENCH. The language tag returned for French locale is fr
the input string with placeholder variables to be replaced with translated values
String of the interpolated template string
base name of the bundle e.g. strings
the specific Locale, e.g. Locale.FRENCH. The language tag returned for French locale is fr
the input string with placeholder variables to be replaced with translated values
Method for returning all files in a dir
Method for returning all files in a dir
Method for returning all files in a dir
Directory to recurse
Method for returning all files in a dir
Directory to recurse