|
|
|
# Catalog
|
|
|
|
|
|
|
|
Catalogs are a way to store dynamic data structures, that need to be defined at system-level — such as activities, organizations, and so on. They can be accessed from the menu.
|
|
|
|
|
|
|
|
[[_TOC_]]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
All catalogs have CRUD functionality (i.e.: create, read, update, delete).
|
|
|
|
|
|
|
|
 button opens a modal window with all fields for particular catalog.
|
|
|
|
|
|
|
|
Clicking on the row opens an entry for editing.
|
|
|
|
|
|
|
|
 — operation button also allow editing, as well as archiving of an element.
|
|
|
|
|
|
|
|
Catalog entry is never deleted, instead it is only marked as archived and gets hidden from the view. They are shown on "Show archived" check-box in the top section of catalog page. 
|
|
|
|
|
|
|
|
Archived rows are highlighted red and only have one control button - restore  . On clicking this button, confirm message is shown above this row:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
If OK - row is restored, if not - remains archived.
|
|
|
|
|
|
|
|
## Identifiers
|
|
|
|
|
|
|
|
<span dir="">Identifiers</span> are multi-entry data. Row can be removed if not needed. They can be used in different catalogs, at this moment they are available for:
|
|
|
|
|
|
|
|
* Payer
|
|
|
|
* Ward
|
|
|
|
|
|
|
|
Each identifier has:
|
|
|
|
|
|
|
|
* **<span dir="">Identifier Name</span>** - text field, required.
|
|
|
|
* **<span dir="">Identifier</span> Value** - text field, required.
|
|
|
|
|
|
|
|
They are used for technical purposes, linking catalog values with their identifiers in external systems. This values should only be entered or edited by user that knows where each identifier is used in the application.
|
|
|
|
|
|
|
|
## Existing catalogs
|
|
|
|
|
|
|
|
### Activity
|
|
|
|
|
|
|
|
Activities can be added to each admission in "Admission Data" section — these catalog's entries can be selected in "<span dir="">Activity Code / Name</span>" column.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Activity ID** — text field, required. Currently is used to link activity to other systems.
|
|
|
|
* **Name** — text field, required.
|
|
|
|
* **Code** — text field, required.
|
|
|
|
* **Description** — text field, optional.
|
|
|
|
|
|
|
|
### <span dir="">Employee</span>
|
|
|
|
|
|
|
|
Employees can be selected in each admission in "Admission Data" section — when added activities are actual there's an "Involved specialists" section. These catalog's entries can be selected in "Employee Name" column.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Name** — text field, required.
|
|
|
|
* **Code** — text field, optional.
|
|
|
|
|
|
|
|
### <span dir="">HMO</span>
|
|
|
|
|
|
|
|
HMO (<span dir="">Health Maintenance Organization</span>) can be selected in each patient's data in "Insurance" — "HMO".
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Name** — text field, required.
|
|
|
|
|
|
|
|
### <span dir="">HMO District</span>
|
|
|
|
|
|
|
|
HMO District can be selected in each patient's data in "Insurance" — "HMO <span dir="">district</span>".
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Name** — text field, required.
|
|
|
|
* **HMO** — select list, required. Values — from HMO catalog.
|
|
|
|
|
|
|
|
### **<span dir="">Insurance Company</span>**
|
|
|
|
|
|
|
|
Insurance Company can be selected in each patient's data in "Insurance" → "Insurance Company".
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Name** — text field, required.
|
|
|
|
|
|
|
|
### Organization
|
|
|
|
|
|
|
|
Can be selected in each admission in "Admission Data" section — "Referring Organization".
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Name** — text field, required.
|
|
|
|
|
|
|
|
### Payer
|
|
|
|
|
|
|
|
Activities can be added to each admission in "Admission Data" section — these catalog's entries can be selected in "Payer" column. Depending on "<span dir="">Require Guarantee Letter</span>" for particular entry — additional fields for activity could be disabled or enabled.
|
|
|
|
|
|
|
|
Payers are also used in [OpenMRS pathology samples process](https://gitlab.tools.gbooking.ru/adt/adt-wiki/-/wikis/%5BOpenMRS%5D-Pathology-samples#biopsy-module) to define the default lab of the activity.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Name** — text field, required.
|
|
|
|
* **Price list** — select list, required. Possible values — existing price lists.
|
|
|
|
* **Require Guarantee Letter** — Yes/No checkbox, required.
|
|
|
|
* **Laboratory** - select list, optional. Possible values are active "Laboratory" catalog entries. Defines the laboratory that will be selected as default if this payer is paying for the activity.
|
|
|
|
* [**Identifiers**](https://gitlab.tools.gbooking.ru/adt/adt-wiki/-/wikis/%5BADT%5D-Catalogs-and-price-lists#identifiers)
|
|
|
|
|
|
|
|
### <span dir="">Visit Reason</span>
|
|
|
|
|
|
|
|
Visit reason is selected as a required field during admission creation in "Admission Data" — "General" section.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Name** — text field, required.
|
|
|
|
|
|
|
|
### <span dir="">Ward</span>
|
|
|
|
|
|
|
|
Activities can be added to each admission in "Admission Data" section — these catalog's entries can be selected in "Ward" column.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Name** — text field, required.
|
|
|
|
* **Code** — text field, optional. This field is currently used to link the system with external systems.
|
|
|
|
* [**Identifiers**](https://gitlab.tools.gbooking.ru/adt/adt-wiki/-/wikis/%5BADT%5D-Catalogs-and-price-lists#identifiers)
|
|
|
|
|
|
|
|
### Laboratory
|
|
|
|
|
|
|
|
Laboratories are used in [OpenMRS in pathology samples process](https://gitlab.tools.gbooking.ru/adt/adt-wiki/-/wikis/%5BOpenMRS%5D-Pathology-samples#pathology-samples-process). They are also a part of [Payer catalog](https://gitlab.tools.gbooking.ru/adt/adt-wiki/-/wikis/%5BADT%5D-Catalogs-and-price-lists#payer).
|
|
|
|
|
|
|
|
Laboratory catalog has a catalog-level field: **Default Laboratory**. It's available on the top of the catalog page - a select list field with all non-archived laboratories (+ saved in the field one even if it is achieved). If the value is changed - "Update Default" button turns blue and active.
|
|
|
|
|
|
|
|
Default laboratory is used to define application-level default lab if payer doesn't have one.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Name** - text field, required.
|
|
|
|
* **Sample Number Prefix** - number field, required. All non-digit symbols will be cleared on enter. Prefix is used in pathology samples process for generating number for each sample. [See here](https://gitlab.tools.gbooking.ru/adt/adt-wiki/-/wikis/%5BOpenMRS%5D-Pathology-samples#generate-sample-numbers).
|
|
|
|
|
|
|
|
## Price lists
|
|
|
|
|
|
|
|
The list of price lists is a simple catalog.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Name** — text field, required.
|
|
|
|
* **Description** — text field, optional.
|
|
|
|
|
|
|
|
They have additional button for each row  that opens price entries.
|
|
|
|
|
|
|
|
#### Prices
|
|
|
|
|
|
|
|
Prices inside each price list are a catalog, too. Each price list entry is a price for a given activity and time period.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Activity** — dropdown selection list with the built-in adaptive search, required. Possible values are active "Activity" catalog entries.
|
|
|
|
* **Price period start** and **Price period end** — date fields, optional. Determine when this price entry becomes active and when it stops, if left empty — date is considered infinite (can also be only one of the dates, so e.g. from infinity to a given end date).\
|
|
|
|
There can not be 2 overlapping prices for the same activity in the same price list, only one active price for each activity at each given time. When trying to save the second one — an error message will appear, and system will _not_ save the second price.
|
|
|
|
* **<span dir="">Government price</span>** — number field, required, default 0. This is a "basic" value of a given price.
|
|
|
|
* **Patient price** — number field, required, default value is 0. This is the amount that patients of the Clinic must pay for this activity — this field affects all of the "Payment" section in admission.
|
|
|
|
* **HMO discount** — number field, required, default value is 0. This is the % discount from the **government** price that HMOs have.
|
|
|
|
* **HMO price** — number field, required, disabled. It is calculated from the other three fields using the following formula:\
|
|
|
|
\
|
|
|
|
It can be calculated as something below 0 — but it cannot be saved this way, an error message will appear:\
|
|
|
|
# Catalog
|
|
|
|
|
|
|
|
Catalogs are a way to store dynamic data structures, that need to be defined at system-level — such as activities, organizations, and so on. They can be accessed from the menu.
|
|
|
|
|
|
|
|
[[_TOC_]]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
All catalogs have CRUD functionality (i.e.: create, read, update, delete).
|
|
|
|
|
|
|
|
 button opens a modal window with all fields for particular catalog.
|
|
|
|
|
|
|
|
Clicking on the row opens an entry for editing.
|
|
|
|
|
|
|
|
 — operation button also allow editing, as well as archiving of an element.
|
|
|
|
|
|
|
|
Catalog entry is never deleted, instead it is only marked as archived and gets hidden from the view. They are shown on "Show archived" check-box in the top section of catalog page. 
|
|
|
|
|
|
|
|
Archived rows are highlighted red and only have one control button - restore  . On clicking this button, confirm message is shown above this row:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
If OK - row is restored, if not - remains archived.
|
|
|
|
|
|
|
|
## Identifiers
|
|
|
|
|
|
|
|
<span dir="">Identifiers</span> are multi-entry data. Row can be removed if not needed. They can be used in different catalogs, at this moment they are available for:
|
|
|
|
|
|
|
|
* Payer
|
|
|
|
* Ward
|
|
|
|
|
|
|
|
Each identifier has:
|
|
|
|
|
|
|
|
* **<span dir="">Identifier Name</span>** - text field, required.
|
|
|
|
* **<span dir="">Identifier</span> Value** - text field, required.
|
|
|
|
|
|
|
|
They are used for technical purposes, linking catalog values with their identifiers in external systems. This values should only be entered or edited by user that knows where each identifier is used in the application.
|
|
|
|
|
|
|
|
Used identifiers are described further in particular catalogs.
|
|
|
|
|
|
|
|
## Existing catalogs
|
|
|
|
|
|
|
|
### Activity
|
|
|
|
|
|
|
|
Activities can be added to each admission in "Admission Data" section — these catalog's entries can be selected in "<span dir="">Activity Code / Name</span>" column.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Activity ID** — text field, required. Currently is used to link activity to other systems.
|
|
|
|
* **Name** — text field, required.
|
|
|
|
* **Code** — text field, required.
|
|
|
|
* **Description** — text field, optional.
|
|
|
|
|
|
|
|
### <span dir="">Employee</span>
|
|
|
|
|
|
|
|
Employees can be selected in each admission in "Admission Data" section — when added activities are actual there's an "Involved specialists" section. These catalog's entries can be selected in "Employee Name" column.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Name** — text field, required.
|
|
|
|
* **Code** — text field, optional.
|
|
|
|
|
|
|
|
### <span dir="">HMO</span>
|
|
|
|
|
|
|
|
HMO (<span dir="">Health Maintenance Organization</span>) can be selected in each patient's data in "Insurance" — "HMO".
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Name** — text field, required.
|
|
|
|
|
|
|
|
### <span dir="">HMO District</span>
|
|
|
|
|
|
|
|
HMO District can be selected in each patient's data in "Insurance" — "HMO <span dir="">district</span>".
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Name** — text field, required.
|
|
|
|
* **HMO** — select list, required. Values — from HMO catalog.
|
|
|
|
|
|
|
|
### **<span dir="">Insurance Company</span>**
|
|
|
|
|
|
|
|
Insurance Company can be selected in each patient's data in "Insurance" → "Insurance Company".
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Name** — text field, required.
|
|
|
|
|
|
|
|
### Organization
|
|
|
|
|
|
|
|
Can be selected in each admission in "Admission Data" section — "Referring Organization".
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Name** — text field, required.
|
|
|
|
|
|
|
|
### Payer
|
|
|
|
|
|
|
|
Activities can be added to each admission in "Admission Data" section — these catalog's entries can be selected in "Payer" column. Depending on "<span dir="">Require Guarantee Letter</span>" for particular entry — additional fields for activity could be disabled or enabled.
|
|
|
|
|
|
|
|
Payers are also used in [OpenMRS pathology samples process](https://gitlab.tools.gbooking.ru/adt/adt-wiki/-/wikis/%5BOpenMRS%5D-Pathology-samples#biopsy-module) to define the default lab of the activity.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Name** — text field, required.
|
|
|
|
* **Price list** — select list, required. Possible values — existing price lists.
|
|
|
|
* **Require Guarantee Letter** — Yes/No checkbox, required.
|
|
|
|
* **Laboratory** - select list, optional. Possible values are active "Laboratory" catalog entries. Defines the laboratory that will be selected as default if this payer is paying for the activity.
|
|
|
|
* [**Identifiers**](https://gitlab.tools.gbooking.ru/adt/adt-wiki/-/wikis/%5BADT%5D-Catalogs-and-price-lists#identifiers)
|
|
|
|
|
|
|
|
#### Existing identifiers
|
|
|
|
|
|
|
|
1. **PAYER_REPORT** - is used for producing particular file structure when creating a media in [Report module](https://gitlab.tools.gbooking.ru/adt/adt-wiki/-/wikis/%5BADT%5D-Report-module). Is used to determine how SICUM files are stored during the SICUM process.
|
|
|
|
1. adt-meuhedet-payer-report-txt-v1
|
|
|
|
2. adt-leumit-payer-report-txt-v1
|
|
|
|
|
|
|
|
### <span dir="">Visit Reason</span>
|
|
|
|
|
|
|
|
Visit reason is selected as a required field during admission creation in "Admission Data" — "General" section.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Name** — text field, required.
|
|
|
|
|
|
|
|
### <span dir="">Ward</span>
|
|
|
|
|
|
|
|
Activities can be added to each admission in "Admission Data" section — these catalog's entries can be selected in "Ward" column.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Name** — text field, required.
|
|
|
|
* **Code** — text field, optional. This field is currently used to link the system with external systems.
|
|
|
|
* [**Identifiers**](https://gitlab.tools.gbooking.ru/adt/adt-wiki/-/wikis/%5BADT%5D-Catalogs-and-price-lists#identifiers)
|
|
|
|
|
|
|
|
### Laboratory
|
|
|
|
|
|
|
|
Laboratories are used in [OpenMRS in pathology samples process](https://gitlab.tools.gbooking.ru/adt/adt-wiki/-/wikis/%5BOpenMRS%5D-Pathology-samples#pathology-samples-process). They are also a part of [Payer catalog](https://gitlab.tools.gbooking.ru/adt/adt-wiki/-/wikis/%5BADT%5D-Catalogs-and-price-lists#payer).
|
|
|
|
|
|
|
|
Laboratory catalog has a catalog-level field: **Default Laboratory**. It's available on the top of the catalog page - a select list field with all non-archived laboratories (+ saved in the field one even if it is achieved). If the value is changed - "Update Default" button turns blue and active.
|
|
|
|
|
|
|
|
Default laboratory is used to define application-level default lab if payer doesn't have one.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Name** - text field, required.
|
|
|
|
* **Sample Number Prefix** - number field, required. All non-digit symbols will be cleared on enter. Prefix is used in pathology samples process for generating number for each sample. [See here](https://gitlab.tools.gbooking.ru/adt/adt-wiki/-/wikis/%5BOpenMRS%5D-Pathology-samples#generate-sample-numbers).
|
|
|
|
|
|
|
|
## Price lists
|
|
|
|
|
|
|
|
The list of price lists is a simple catalog.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Name** — text field, required.
|
|
|
|
* **Description** — text field, optional.
|
|
|
|
|
|
|
|
They have additional button for each row  that opens price entries.
|
|
|
|
|
|
|
|
#### Prices
|
|
|
|
|
|
|
|
Prices inside each price list are a catalog, too. Each price list entry is a price for a given activity and time period.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Activity** — dropdown selection list with the built-in adaptive search, required. Possible values are active "Activity" catalog entries.
|
|
|
|
* **Price period start** and **Price period end** — date fields, optional. Determine when this price entry becomes active and when it stops, if left empty — date is considered infinite (can also be only one of the dates, so e.g. from infinity to a given end date).\
|
|
|
|
There can not be 2 overlapping prices for the same activity in the same price list, only one active price for each activity at each given time. When trying to save the second one — an error message will appear, and system will _not_ save the second price.
|
|
|
|
* **<span dir="">Government price</span>** — number field, required, default 0. This is a "basic" value of a given price.
|
|
|
|
* **Patient price** — number field, required, default value is 0. This is the amount that patients of the Clinic must pay for this activity — this field affects all of the "Payment" section in admission.
|
|
|
|
* **HMO discount** — number field, required, default value is 0. This is the % discount from the **government** price that HMOs have.
|
|
|
|
* **HMO price** — number field, required, disabled. It is calculated from the other three fields using the following formula:\
|
|
|
|
\
|
|
|
|
It can be calculated as something below 0 — but it cannot be saved this way, an error message will appear:\
|
|
|
|
 |
|
|
\ No newline at end of file |
