/
library_program_get_info ()

library_program_get_info ()

Owned by David Gaya (Unlicensed)
Function prototype

library_program_get_info ( session, program, [version], [language] )

API VersionAll

ü  library_program_get_info(session, program, version {DRAFT|LAST|n} )

MethodName

library_program_get_info

Description

Get basic information about a library program

Input

  • session: Session token obtained in a previous call to session_init (). This parameter can be NULL if the PROGRAM accessed has access type = "PUBLIC". Otherwise the session token is mandatory
  • program: reference of the library program
  • version: {DRAFT|LAST|n} 
    • DRAFT get the draft version
    • LAST get the newest published version (this is the default)
    • n get the version number n
  • language (default = "EN"). Only necessary when no session token has been provided

Output

  • result: XML with information about the PROGRAM
    • program:
      • ref: Reference of the PROGRAM
      • access: (PUBLIC / PRIVATE). Indicates whwho can use this PROGRAM:
        • PUBLIC: All professionals can get information about the PROGRAM, and it is allowed to create SUBSCRIPTIONS to this PROGRAM to any PROFESSIONAL with role "LIBRARY MANAGER"
        • PRIVATE: Only members of the TEAM owner of the PROGRAM with roles LIBRARY_MANAGER, PROGRAM MANAGER, PROGRAM EDITOR or SERVICE
      • code: Program code
      • name: Name of the PROGRAM in the active Session language
      • description: Description of the PROGRAM in the active Session language
      • target_description: Description of the patients for whom the PROGRAM is intended. Introduced in API Version 2.7.28
      • settings:
        • trial: (true/false) Indicates whether the PROGRAM is a TRIAL or not
        • trial_locked: (true/false). Indicates if the trial property of the PROGRAM TEMPLATE OBJECT is locked (cannot be changed). This restriction occurs when the PROGRAM is a TRIAL and contains WORKPLANS that have been assigned to a specific "trial group" (Intervention or Control)
        • randomized: (true/false). This property only makes sense in "TRIAL" PROGRAMS
        • randomize_settings: Properties to define how to apply randomization. This node is only returned in "TRIAL" PROGRAMS configured as RANDOMIZED. Introduced in API Version 2.7.21
          • mode: This property defines the algorithm used to apply randomization (how to assign an ADMISSION to either the "Intervention" or "Control" trial groups).. Possible values:
            • 1: Manual randomization. A TASK will be inserted in each ADMISSION to let the professional choose the TRIAL group (Intervention or Control). This was the default value in API versions before 2.7.21
            • 2: Automatic randomization: Linkcare platform will decide automatically the trial group for each ADMISSION
          • stratification_var: Allows to define 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 no value is provided, the selection of the trial group will be a simple random choice between "Intervention" and "Control"
        • double_blind: (true/false). This property only makes sense in "TRIAL" PROGRAMS
        • N: (true/false). This property only makes sense in "TRIAL" PROGRAMS. It is an informative field that indicates the number of patients that are expected to participate in the medical trial
        • stratified
        • duration: Maximum duration of the ADMISSIONS in this PROGRAM. If no value (or 0) is assigned, the duration is assumed to be infinite. If a duration is specified, the ADMISSIONs still active that were enrolled before that duration value will be discharged automatically. Introduced in API version 2.7.22.
          NOTE: The value assigned to this property may be overridden by the SUBSCRIPTION configuration
          • value: Number of units of duration. If 0 or empty, an infinite duration is assumed
          • unit: Units used to define the duration (DAYS, WEEKS, MONTHS, YEARS)
          • description: human readable description of the units
        • locked
        • events_disabled
        • predefined_events. Indicates if a PROGRAM should permit the creation of predefined EVENTS. Introduced in API Version 2.7.12
        • manual_admissions_enabled: indicates if a PROGRAM should permit the creation of ADMISSIONs manually. This is only a recommendation for the client application, who is responsible of permitting a user to create a new ADMISSION from the interface. The purpose of this property is to indicate that the ADMISSIONS should only be created programatically. Introduced in API Version 2.7.16
      • protocols: list of protocols of the PROGRAM
      • permissions: Introduced in API Version 2.7.23
        • edit: Indicates if the active user can modify the properties of the PROGRAM (name, description, access type, etc.)
        • delete: Indicates if the active user can delete the PROGRAM
        • manage_subscriptions: Indicates if the active user manage the SUBSCRIPTIONs of the PROGRAM (add/remove SUBSCRIPTIONS)
        • alter_content: Indicates if the active user can modify the content of the PROGRAM (add/remove PROTOCOLS, WORKPLANS, etc). Introduced in API Version 2.7.24
  • ErrorMsg:  Error message if the operation fails
  • ErrorCode

Request Sample

library_program_get_info (“LC53060c6f729de8.42629546”, 2156, "LAST")

ResponseSample


<?xml version="1.0" encoding="UTF-8"?>
<result>
  <program>
    <ref>383</ref>
    <code>TEST_LAB</code>
    <name>TEST LAB</name>
    <description>Program to perform battery of tests</description>
    <target_description/>
    <version>2</version>
    <outdated>false</outdated>
    <active>true</active>
    <image_info/>
    <access>PRIVATE</access>
    <published>2020-11-13 11:47:13</published>
    <settings>
      <trial>false</trial>
      <stratified>false</stratified>
      <stratified_locked>false</stratified_locked>
      <exclusion_inclusion_criteria>false</exclusion_inclusion_criteria>
      <locked>false</locked>
      <events_disabled>false</events_disabled>
      <predefined_events>true</predefined_events>
      <manual_admissions_disabled>false</manual_admissions_disabled>
      <duration>
        <value/>
        <unit/>
        <description/>
      </duration>
    </settings>
    <protocols>
      <protocol>
        <ref>2551</ref>
        <name>Common</name>
        <description/>
        <active>true</active>
      </protocol>
    </protocols>
    <owner>
      <ref>1</ref>
      <name>Linkcare</name>
    </owner>
    <authors>
      <author>
        <team>
          <ref>44</ref>
          <name>FARMACIA VARGAS</name>
        </team>
        <user>
          <ref>16761</ref>
          <name_complete>PEDRO SANCHEZ LULING</name_complete>
        </user>
      </author>
    </authors>
    <sponsors>
      <sponsor>
        <team>
          <ref>3</ref>
          <name>DEMO</name>
        </team>
        <user/>
      </sponsor>
    </sponsors>
    <categories>
      <category>
        <code_type>#PROGRAM.CATEGORY</code_type>
        <code>4</code>
        <description>Fragility</description>
      </category>
      <category>
        <code_type>#PROGRAM.CATEGORY</code_type>
        <code>9</code>
        <description>Diagnosis</description>
      </category>
    </categories>
    <diagnoses>
      <diagnosis>
        <code_type>DIAGNOSIS.MDC</code_type>
        <code>6</code>
        <description>Digestive System</description>
      </diagnosis>
      <diagnosis>
        <code_type>DIAGNOSIS.MDC</code_type>
        <code>7</code>
        <description>Hepatobiliary System And Pancreas</description>
      </diagnosis>
    </diagnoses>
    <draft>true</draft>
    <permissions>
      <edit>true</edit>
      <delete>true</delete>
      <manage_subscriptions>true</manage_subscriptions>
      <alter_content>false</alter_content>
    </permissions>
  </program>
</result>
<ErrorMsg></ErrorMsg>
<ErrorCode></ErrorCode>

Related content