"OUTCOME" OBJECT CODE
- Pedro Jose Sanchez Luling
Object code format
parent_object.OUTCOME.property
Introduced in API version 2.7.19
Possible parent objects | Example | Context information |
|---|---|---|
|
| Requires a valid ADMISSION, which is determined by the parent ADMISSION object |
|
| Requires a valid PROGRAM and a CASE that must be provided by the parent OBJECT |
The "OUTCOME" OBJECT CODE can be used to obtain information about the outcome of an ADMISSION or PROGRAM.
Outcome of an ADMISSION
It is possible to assign a value to some magnitudes of an ADMISSION that allow to evaluate its outcome. Currently the magnitudes supported are:
Compliance: measure of how well the CASE performed
Adherence: measure of how many TASKs (out of the number of total TASKs assigned to the CASE in the ADMISSION) where done.
Outcome: a value to determine the final result of an ADMISSION. For example, in a screening procedure it can be a value that determines if the final diagnostic was positive or negative.
Outcome of a PROGRAM
When requesting the OUTCOME of a PROGRAM, the system will look for the most recent ADMISSION in that PROGRAM (no matter if they belong to different SUBSCRIPTIONS), and the return value will be the one corresponding to the OUTCOME of that ADMISSION.
The most recent ADMISSION is not determined only by the date when the ADMISSION was created or the date of the last activity. The status of the ADMISSION plays also an important role:
ADMISSIONS with a status different than ENROLL, ACTIVE or DISCHARGED are not considered for the calculation
If 2 ADMISSIONs have different status, then a priority is assigned depending on the status (the one with more priority is selected). The priority order is:
ENROLLED
ACTIVE
DISCHARGED
If 2 ADMISSIONs have the same state, the most recent one is selected
Properties
PROPERTY | DESCRIPTION |
|---|---|
| Measure of the compliance of an ADMISSION or PROGRAM. Returns a value in the range [0, 6] The value must be understood as a tag. The recommendation is to present each value as a color code |
| Measure of the adherence or a CASE in an ADMISSION or PROGRAM. Returns a value in the range [0, 6] The value must be understood as a tag. The recommendation is to present each value as a color code |
| Value assigned to the output an ADMISSION or PROGRAM. Returns a value in the range [0, 6] The value must be understood as a tag. The recommendation is to present each value as a color code |
Recommended color codes for OUTCOME values
0: no value
1: Blue
2: Green
3: Yellow
4: Orange
5: Red
6: Black