Skip to content

Changes

Page history
Update [ADT] Catalogs and price lists authored by Rina's avatar Rina
Hide whitespace changes
Inline Side-by-side
[ADT]-Catalogs-and-price-lists.md
View page @ 6df50ffd
# Catalog # 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. 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_]] [[_TOC_]]
![image](uploads/a58a510050182bacb7ff47ddca3da411/image.png) ![image](uploads/a58a510050182bacb7ff47ddca3da411/image.png)
All catalogs have CRUD functionality (i.e.: create, read, update, delete). All catalogs have CRUD functionality (i.e.: create, read, update, delete).
![image](uploads/fdb8d923872aeff53a9574fa9b7473f0/image.png) button opens a modal window with all fields for particular catalog. ![image](uploads/fdb8d923872aeff53a9574fa9b7473f0/image.png) button opens a modal window with all fields for particular catalog.
Clicking on the row opens an entry for editing. Clicking on the row opens an entry for editing.
![image](uploads/3aa5dd73d1f666d0d705c978f0580a4f/image.png) — operation button also allow editing, as well as archiving of an element. ![image](uploads/3aa5dd73d1f666d0d705c978f0580a4f/image.png) — 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. ![image](uploads/f6e969814c612cd949e209abec1b0098/image.png) 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. ![image](uploads/f6e969814c612cd949e209abec1b0098/image.png)
Archived rows are highlighted red and only have one control button - restore ![image](uploads/5801ea1f6506de45f4be2250bf3e4f67/image.png) . On clicking this button, confirm message is shown above this row: Archived rows are highlighted red and only have one control button - restore ![image](uploads/5801ea1f6506de45f4be2250bf3e4f67/image.png) . On clicking this button, confirm message is shown above this row:
![image](uploads/81a52f19103fe00b01a004a046e3c0d3/image.png) ![image](uploads/81a52f19103fe00b01a004a046e3c0d3/image.png)
If OK - row is restored, if not - remains archived. If OK - row is restored, if not - remains archived.
## Identifiers ## 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: <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 * Payer
* Ward * Ward
Each identifier has: Each identifier has:
* **<span dir="">Identifier Name</span>** - text field, required. * **<span dir="">Identifier Name</span>** - text field, required.
* **<span dir="">Identifier</span> Value** - 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. 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 Used identifiers are described further in particular catalogs.
### Activity ## Existing catalogs
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
![image](uploads/c68440d8623f1ce924681c5a2813a018/image.png) 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. ![image](uploads/c68440d8623f1ce924681c5a2813a018/image.png)
* **Name** — text field, required.
* **Code** — text field, required. * **Activity ID** — text field, required. Currently is used to link activity to other systems.
* **Description** — text field, optional. * **Name** — text field, required.
* **Code** — text field, required.
### <span dir="">Employee</span> * **Description** — text field, optional.
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. ### <span dir="">Employee</span>
![image](uploads/4a80c9cb0152ba2219a838645fc79e9c/image.png) 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. ![image](uploads/4a80c9cb0152ba2219a838645fc79e9c/image.png)
* **Code** — text field, optional.
* **Name** — text field, required.
### <span dir="">HMO</span> * **Code** — text field, optional.
HMO (<span dir="">Health Maintenance Organization</span>) can be selected in each patient's data in "Insurance" — "HMO". ### <span dir="">HMO</span>
![image](uploads/0f066b1bfb2257fe477d8bbb4409c3e4/image.png) HMO (<span dir="">Health Maintenance Organization</span>) can be selected in each patient's data in "Insurance" — "HMO".
* **Name** — text field, required. ![image](uploads/0f066b1bfb2257fe477d8bbb4409c3e4/image.png)
### <span dir="">HMO District</span> * **Name** — text field, required.
HMO District can be selected in each patient's data in "Insurance" — "HMO <span dir="">district</span>". ### <span dir="">HMO District</span>
![image](uploads/6bfc763de4751f77cdc08446dee2d45f/image.png) HMO District can be selected in each patient's data in "Insurance" — "HMO <span dir="">district</span>".
* **Name** — text field, required. ![image](uploads/6bfc763de4751f77cdc08446dee2d45f/image.png)
* **HMO** — select list, required. Values — from HMO catalog.
* **Name** — text field, required.
### **<span dir="">Insurance Company</span>** * **HMO** — select list, required. Values — from HMO catalog.
Insurance Company can be selected in each patient's data in "Insurance" → "Insurance Company". ### **<span dir="">Insurance Company</span>**
![image](uploads/061705c9f29bfc60505dfaddc0de3b44/image.png) Insurance Company can be selected in each patient's data in "Insurance" → "Insurance Company".
* **Name** — text field, required. ![image](uploads/061705c9f29bfc60505dfaddc0de3b44/image.png)
### Organization * **Name** — text field, required.
Can be selected in each admission in "Admission Data" section — "Referring Organization". ### Organization
![image](uploads/95906174812b392385157025496e7ce4/image.png) Can be selected in each admission in "Admission Data" section — "Referring Organization".
* **Name** — text field, required. ![image](uploads/95906174812b392385157025496e7ce4/image.png)
### Payer * **Name** — text field, required.
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. ### Payer
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. 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.
![image](uploads/69b93e87ba24cc6f0f98fa59316769ea/image.png) 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. ![image](uploads/69b93e87ba24cc6f0f98fa59316769ea/image.png)
* **Price list** — select list, required. Possible values — existing price lists.
* **Require Guarantee Letter** — Yes/No checkbox, required. * **Name** — text field, 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. * **Price list** — select list, required. Possible values — existing price lists.
* [**Identifiers**](https://gitlab.tools.gbooking.ru/adt/adt-wiki/-/wikis/%5BADT%5D-Catalogs-and-price-lists#identifiers) * **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.
### <span dir="">Visit Reason</span> * [**Identifiers**](https://gitlab.tools.gbooking.ru/adt/adt-wiki/-/wikis/%5BADT%5D-Catalogs-and-price-lists#identifiers)
Visit reason is selected as a required field during admission creation in "Admission Data" — "General" section. #### Existing identifiers
![image](uploads/a29c3e20ea7f3620c4e462887fe7f84d/image.png) 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
* **Name** — text field, required. 2. adt-leumit-payer-report-txt-v1
### <span dir="">Ward</span> ### <span dir="">Visit Reason</span>
Activities can be added to each admission in "Admission Data" section — these catalog's entries can be selected in "Ward" column. Visit reason is selected as a required field during admission creation in "Admission Data" — "General" section.
![image](uploads/1a26df1fb69614902db8ac5085a9adac/image.png) ![image](uploads/a29c3e20ea7f3620c4e462887fe7f84d/image.png)
* **Name** — text field, required. * **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) ### <span dir="">Ward</span>
### Laboratory Activities can be added to each admission in "Admission Data" section — these catalog's entries can be selected in "Ward" column.
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). ![image](uploads/1a26df1fb69614902db8ac5085a9adac/image.png)
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. * **Name** — text field, required.
* **Code** — text field, optional. This field is currently used to link the system with external systems.
Default laboratory is used to define application-level default lab if payer doesn't have one. * [**Identifiers**](https://gitlab.tools.gbooking.ru/adt/adt-wiki/-/wikis/%5BADT%5D-Catalogs-and-price-lists#identifiers)
![image](uploads/561b5dd23bdab4321387f6c74b6b0c53/image.png) ### Laboratory
![image](uploads/aa8879a7c47dbf4e8c31755ada3ff263/image.png) 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).
* **Name** - text field, required. 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.
* **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).
Default laboratory is used to define application-level default lab if payer doesn't have one.
## Price lists
![image](uploads/561b5dd23bdab4321387f6c74b6b0c53/image.png)
The list of price lists is a simple catalog.
![image](uploads/aa8879a7c47dbf4e8c31755ada3ff263/image.png)
![image](uploads/1151cbece90c9d4dc249f8bd3715986b/image.png)
* **Name** - text field, required.
* **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).
* **Description** — text field, optional.
## Price lists
They have additional button for each row ![image](uploads/ea55e66e28ebccfadf8eceb3612f356b/image.png) that opens price entries.
The list of price lists is a simple catalog.
#### Prices
![image](uploads/1151cbece90c9d4dc249f8bd3715986b/image.png)
Prices inside each price list are a catalog, too. Each price list entry is a price for a given activity and time period.
* **Name** — text field, required.
![image](uploads/e09b6646e605f98c066ebe536462ddb1/image.png) * **Description** — text field, optional.
* **Activity** — dropdown selection list with the built-in adaptive search, required. Possible values are active "Activity" catalog entries. They have additional button for each row ![image](uploads/ea55e66e28ebccfadf8eceb3612f356b/image.png) that opens price 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. #### Prices
* **<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. Prices inside each price list are a catalog, too. Each price list entry is a price for a given activity and time period.
* **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:\ ![image](uploads/e09b6646e605f98c066ebe536462ddb1/image.png)
![image](uploads/b6d9119a38cb3805af4b0944e98b7f26/image.png)\
It can be calculated as something below 0 — but it cannot be saved this way, an error message will appear:\ * **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:\
![image](uploads/b6d9119a38cb3805af4b0944e98b7f26/image.png)\
It can be calculated as something below 0 — but it cannot be saved this way, an error message will appear:\
![image](uploads/1af523d3b2c5ed3de5aabd87e8a6243b/image.png) ![image](uploads/1af523d3b2c5ed3de5aabd87e8a6243b/image.png)
\ No newline at end of file