{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Definitively removed in API Version 2.8.1","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff5630"}},{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"DEPRECATED in API Version 2.7.8 (replaced by ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff5630"}},{"type":"strong"}]},{"text":"action_list_patient ()","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff5630"}},{"type":"strong"},{"type":"link","attrs":{"href":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/794329094"}}]},{"text":")","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff5630"}},{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"full-width","width":1105.041474,"localId":"3052e5b0-a802-4be2-be1d-540d8911fd3b"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[186.28]},"content":[{"type":"paragraph","content":[{"text":"Function prototype","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[918.76]},"content":[{"type":"paragraph","content":[{"text":"patient_action_list (session, case {, program = NULL} {, team = NULL} , action{, path = NULL} {, parameter = TODAY})","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[186.28]},"content":[{"type":"paragraph","content":[{"text":"API Version","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[918.76]},"content":[{"type":"paragraph","content":[{"text":"2.6.18 and higher","type":"text"}]}]}]}]},{"type":"paragraph"},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"2f84e8ce-5903-4bde-9b6c-968d0265488b"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[340.0,340.0]},"content":[{"type":"paragraph","content":[{"text":"This function returns a list of possible actions that can be executed by a PATIENT or a PATIENT'S ASSOCIATE.","type":"text"}]},{"type":"paragraph","content":[{"text":"Depending on the \"action\" parameter the function will return the available choices for the active patient.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]}]},{"type":"paragraph","content":[{"text":"The \"EVENT\" action will return the possible MESSAGES that can be posted by a patient as they have been defined in the program template by associating EVENT stage, context \"PATIENT\" in context visibility and Insertion permission to \"Patient\".","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"The difference between this function and ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]},{"text":"† case_action_list ()","type":"text","marks":[{"type":"link","attrs":{"href":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/4260248"}}]},{"text":" is that this function is called from the PATIENT point of view, while ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]},{"text":"† case_action_list ()","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}},{"type":"link","attrs":{"href":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/4260248"}}]},{"text":" is called from the PROFESSIONAL point of view (a professional can execute actions on a patient that are not allowed to the patient itself).","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]}]},{"type":"paragraph","content":[{"text":"The input parameter “action” describes the type of action","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Input","type":"text"}]},{"type":"paragraph","content":[{"text":"parameters:","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"session","type":"text","marks":[{"type":"strong"}]},{"text":": is the session token obtained in the ","type":"text"},{"text":"session_init()","type":"text","marks":[{"type":"link","attrs":{"href":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/524509"}}]},{"text":" call","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"case","type":"text","marks":[{"type":"strong"}]},{"text":": is a CASE reference id (mandatory) of the active patient.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"program","type":"text","marks":[{"type":"strong"}]},{"text":": (optional, default = NULL) If provided it will be used to return only the actions for a specific PROGRAM","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"team","type":"text","marks":[{"type":"strong"}]},{"text":": (optional, default = NULL) If provided it will be used to return only the actions for the PROGRAMS where the subscription owner is the selected TEAM","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"action","type":"text","marks":[{"type":"strong"}]},{"text":": type of actions requested. If null, then the list of available actions will be returned. Possible values:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"empty: the function will return a list of available actions","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"\"","type":"text"},{"text":"EVENT","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]},{"text":"\": the function will return all the available NOTIFICATION actions for the CASE","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"\"CASE\": the function returns available TASKS for the CASE.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"path","type":"text","marks":[{"type":"strong"}]},{"text":": The goal of this parameter is to organize the actions hierarchically (as in a file tree where ","type":"text"},{"text":"path","type":"text","marks":[{"type":"strong"}]},{"text":" represents the subdirectory). When calling patient_action_list(), some of the actions returned may be of type PATH, in which case the value of the path returned can be used to make a subsequent call to patient_action_list() to get the actions nested in that path.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"parameter","type":"text","marks":[{"type":"strong"}]},{"text":": is the date that will be associated to the action. If no date is specified, then the current date will be used","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Output","type":"text"}]},{"type":"paragraph","content":[{"text":"parameters:","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"result","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": XML with the list of possible actions. Each action in the XML contains:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ref","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": action reference. If the action is of class PATH, then this it can be used to call again the function passing the value in the ","type":"text"},{"text":"path","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" parameter to obtain a new list of actions","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": short name in the active session’s language","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"description","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": description in the active session’s language","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"class","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": PATH | ACTION","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"strong"}]},{"text":": action type","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ErrorMsg","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": If any error occurs, then this value contains a description of the error translated to the current language","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ErrorCode","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": If any error occurs, then this value contains any of the standard ","type":"text"},{"text":"ERROR CODES","type":"text","marks":[{"type":"link","attrs":{"href":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/55967818"}}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Request","type":"text"}]},{"type":"paragraph","content":[{"text":"sample:","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"patient_action_list ( “LCAAAAAAAAAAAA”, \"232\",,, \"NOTIFICATION\" );","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Response","type":"text"}]},{"type":"paragraph","content":[{"text":"sample:","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph"},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n\n\t\n\t\tSelect an action\n \t\t\n\t\t\taction_token\n\t\t\tshort_name\n\t\t\tdesc\n\t\t\tACTION\n\t\t\n\t\t...\n\t\n\n\n\n","type":"text"}]},{"type":"paragraph"},{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Notes:","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Return Error codes","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"b75b04e1-19b8-4e4e-b107-c88fefaa44c0"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ERROR CODE","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"INVALID_TOKEN","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The session token provided is not valid","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"INSUFFICIENT_PRIVILEGES","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The session user does not have the necessary privileges to create request the '","type":"text"},{"text":"action","type":"text","marks":[{"type":"strong"}]},{"text":"' indicated","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"CASE.NOT_FOUND","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The CASE reference provided does not correspond to an existing CASE","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"TEAM.NOT_FOUND","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The TEAM reference provided does not correspond to a valid TEAM","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"WRONG_PARAMS","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Any of the parameters passed to the function has an invalid value","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333333"}}]}]}]}]}]},{"type":"paragraph"}],"version":1}

Browser not supported