/
ACTION CONTEXT (JSON)

ACTION CONTEXT (JSON)

Some API functions that return lists of ACTIONS (e.g. action_list_case ()) accept a parameter providing context information to fine-tune the list of actions returned.

The action context is expressed in JSON format, and the possible filter fields are:

  • program: a PROGRAM referece. To obtain only actions related with the PROGRAM specified
  • subscription_team: a TEAM reference. To obtain only actions related with SUBSCRIPTIONS where the TEAM OWNER is the one specified
  • case: a CASE reference. To obtain only actions related with the CASE specified
  • admission: an ADMISSION reference. To obtain only actions related with the CASE specified
  • target_date: a datetime expression with format "yyyy-mm-dd hh:nn:ss") This date will be used as target date when the action involves the creation of a clinical object. For example, when inserting a TASK, it will be scheduled for the specified date
  • input_value: Used as a way of passing additional information requested by the API. This property should be provided when a call to an action_list function (i.e. action_list_user ()) returns an action with class="INPUT": this means that the API need some user interaction to generate an ACTION. In this cases, the value requested should be provided as input_value in a subsequent call to the corresponding action_list function

Example

TASK FILTER
{
"target_date: "2019-10-08 16:10:12",
"program" : 34,
"subscription_team" : 253,
"admission": 6224,
"case" : 5432,
"admission" : 32432,
"input_value" : "Peter Parker"
}

NOTE: Each function can support all or only part of the fields of the action context information. When calling to API functions it is not necessary to include empty values.

Related content