ID

Int

Id of PROGRAM TEMPLATE. This is a local ID assigned in the DB instance and is not preserved when a PROGRAM is exported to another instance

REF

String

Universal Unique reference (UUID). This reference is maintained when the PROGRAM template is exported to another instance

NAME

String

Name of the PROGRAM

DESCRIPTION

String

Long description of the PROGRAM

TARGET_AUDIENCE

String

Explanation of the targets for which this PROGRAM has been designed (e.g. patients with an specific symptom or disease)

PROG_CODE

String

Program Code associated to a PROGRAM

OWNER

[TEAM]

Team owner of the PROGRAM.

ACCESS

CHOICE of #PROG_TEMPL:ACCESS

Access properties of the PROGRAM for other teams

DESC

[DESCRIPTION]

Long description of the PROGRAM

SETTINGS:*

PROPERTY SET

A set of settings that allow to customize some general traits of the behavior of the PROGRAM

ACTIVE

Boolean

The program is active, meaning that it is possible to create SUBSCRIPTIONS to it

CREATION_DATE

Date

Date of creation of the PROGRAM

MODIFICATION_DATE

Date

Date of last modification of the PROGRAM

SOURCE

[SOURCE]

Used in PROGRAM imported from another instance. Provides the information about the procedence

SYNC_DATE

Date

Used in PROGRAM imported from another instance. Is the date of the last synchronization (update) of the local PROGRAM TEMPLATE

AUTHORS

A list of PROPERTY SET

Defines the author/s of a PROGRAM

SPONSORS

A list of [TEAMS]

Defines the TEAM/S that act as sponsors of a program

DIAGNOSES

A list of [DIAGNOSES]

Indicates the Diagnoses associated to the PROGRAM

CATEGORIES

A list of [PROGRAM CATEGORY]

Indicates the Categories assigned to the PROGRAM

VERSIONS

A list of [PROGRAM TEMPLATE VERSION]

List of versions of the PROGRAM

DURATION

Int

Defines if the ADMISSIONS related with this PROGRAM have a maximum duration. The ADMISSIONS in this PROGRAM will be automatically discharged after the configured duration has passed counting from the date in which the ADMISSION entered the “ENROLL” stage

The value defined here can be overridden by the SUBSCRIPTION:DURATION property

DURATION_UNITS

String

When a DURATION is defined, this setting it indicates the units for the duration.

Admitted values are DAYS, WEEKS, MONTHS, YEARS

The value defined here can be overridden by the SUBSCRIPTION:DURATION property

ACCESS:PRIVATE

Private

The program is only restricted to be used by the team owner

ACCESS:PUBLIC

Public

The program is publicly available for other teams to create admissions on it.

ACCESS:SHARED

Shared

The program can be used only by invitation of the owner.

TRIAL

Trial

Boolean

Defines a PROGRAM TEMPLATE as a trial.

TRIAL:RANDOMIZED

Randomized

Int

Indicates whether the PROGRAM is a Medical Trial, and if so, which method will be used to stratify the patients in the “Intervention” and “Control” groups. Possible values:

• 0: Not trial

• 1: Trial PROGRAM with manual stratification (a Case Manager will choose manually the trial group)

• 2: Trial PROGRAM with automatic stratification (the trial group will be assigned randomly by an algorithm). See also the TRIAL:RANDOMIZATION_STRATIFIED property

TRIAL:DOUBLE_BLIND

Double Blind

Boolean

If selected Trial, it can define PROGRAM TEMPLATE as a Double blind trial

TRIAL:N

Number of admissions

Int

If selected Trial, it indicates the number of ADMISSIONS expected

STRATIFIED

Stratified

Boolean

Defines a PROGRAM TEMPLATE as stratified

DURATION

Duration of the program

Int

Defines if a PROGRAM have a maximum duration. The ADMISSIONS in this PROGRAM will be automatically discharged after the configured duration has passed counting from the enroll date.

The value configured in this setting can be overridden by the configuration of the SUBSCRIPTION OBJECT

DURATION_UNITS

Units for the period

String

When a DURATION is defined, this setting it indicates the units for the duration.

Admitted values are DAYS, WEEKS, MONTHS, YEARS

The value configured in this setting can be overridden by the configuration of the SUBSCRIPTION OBJECT

LOCKED

Locked

Boolean

Defines the PROGRAM TEMPLATE as locked.

EVENTS_DISABLED

Events disabled

Boolean

Enables or disables the creation of EVENTS in ADMISSIONs of a PROGRAM.

The value configured in this setting can be overridden by the configuration of the SUBSCRIPTION OBJECT

PREDEFINED_EVENTS

Predefined events

Boolean

Enables or disables default events in the program. The custom EVENTS defined in the program template will still be available.

The value configured in this setting can be overridden by the configuration of the SUBSCRIPTION OBJECT

MANUAL_ADMISSIONS_DISABLED

Manual admissions disabled

Boolean

Enables or disables the ability to create new ADMISSIONS in a PROGRAM manually from a client application. The API does not use this setting to prevent or allow the creation of new ADMISSIONS, since they can still be created using the API functions like admission_create ().

The goal of this setting is to inform the client applications that they should not allow to let a user to create new ADMISSIONS manually.

The value configured in this setting can be overridden by the configuration of the SUBSCRIPTION OBJECT

TRIAL:RANDOMIZATION_STRATIFIED

When the PROGRAM is a TRIAL, allows to define the strategy algorithm used to assign the patients to the “Intervention” and “Control” groups (patient stratification).

The value of this field is the name of a variable that will be used to stratify the randomization. This parameter only makes sense when the randomization mode is "automatic". The name of the variable must be an ITEM_CODE.

If the value is NULL, the selection of the trial group will be a simple random choice between "Intervention" and "Control"

AUTHORS:TYPE

Type of author

TEXT

Can have two values:

• 'O': For the OWNER of the PROGRAM

• 'A': For an author of the PROGRAM

AUTHORS:NAME

Name of the author

[USER]

Defines a USER as author of a program

AUTHORS:TEAM

Team of the author

[TEAM]

Defines the TEAM assigned to the author of a program

library_program_action_list ()

Returns a list of possible choices related with actions with the versions of a library_program.

library_program_get_info ()

Get basic information about a library program.

library_program_list ()

Returns a list of the active/all programs were the selected target TEAM is the OWNER of the PROGRAM or the OWNER of a SUBSCRIPTION to the PROGRAM.

library_program_owner_list ()

Returns list of teams which could be an owner of program including current owner of program

library_program_set_authors ()

Sets the authors of a program.

library_program_set_code ()

Sets/unsets codes (categories/diagnoses) of the selected program

library_program_set_profile ()

Sets program's profile information

library_program_set_settings ()

Sets program's profile settings

library_program_set_sponsors ()

Sets program's sponsors

library_program_subscription_list()

Returns list of program subscriptions with STATUS = PUBLISHED

library_program_version_list ()

List all versions of a program