Function prototype	case_search (session, search_str , [max_res = 1000], [offset = 1], [status = "ALL"])
API Version	All

API Version	Changes respect to previous versions
2.7.15	The customized search expression is expressed as a JSON instead of an XML
IMPORTANT: Remember to call session_init() indicating the appropriate API Version

Returns a list of CASEs that match the search criteria If a simple string is provided, it will we used to find CASES who: The name/surname matches the search string Have a communication channel (eMail, Phone) that matches the search string Have any IDENTIFIER that matches the search string It is also possible to provide a structured search expression to do a tailored search
Input parameters:	*session: is the session id obtained in the session_init() call search_str: is the text with we made the matching search in the list of cases. It is possible to provide a simple string or a structured JSON expression to customize search. See below the JSON search expression format max_res: It sets the maximum number of cases to be returned by the function offset: the base-one position of the first case to be returned status*: “ALL” for all cases or “ACTIVE” for only active cases. The default value is “ACTIVE”. An “ACTIVE” case is a case with open (active) or paused admissions, or pre-admissions in Linkcare.
Output parameters:	*result: is an XML that contains the searched cases list cases: items: the total number of cases that could be returned. If items is higher than max-items item will still be the total number, while the “cases” tag will only include the max_res cases passed offset: the base-one position of the first case returned case: ref: is the source of the admission, must be Linkcare or a HIS connected to Linkcare nickname: is the nickname on Linkcare of the patient full_name: is the full-name of the patient if it’s informed bdate: is the case’s birth date age: is the age of the patient gender: M for male F for female status: depends of the status of the admission. See the possible status in the call action_list();* *ErrorMsg: any fault in the call, either in the validation of input parameters, errors in the connection to the database or any other error, this parameter returns the error message produced ErrorCode*: If any error occurs, then this value contains any of the standard ERROR CODES
Request sample:	case_search ( “LCAAAAAAAAAAAA”, “ <?xml version="1.0" encoding="utf-8" standalone="yes"?> <search> <text>search text</text> {<name>specific field to search: EHR, PIC, full-name. By default all fields</name>} {<ref>location to search. By default all centers and HIS connected in Linkcare System</ref>} </search> “, 100, 1{,“ALL”});
Response sample:	<?xml version="1.0" encoding="utf-8" standalone="yes"?> <result> <cases> <items>10</items> <offset>1</offset> <case> <username>peter983</username> <ref>12545</ref> <data> {<nickname>Raul P.M.</nickname>}\| {<full_name> </full_name>} <bdate></bdate> <age></age> <gender>M/F</gender> <status></status> </data> </case> <case>…</case> … </cases> </result> <ErrorMsg></ErrorMsg> <ErrorCode></ErrorCode>
Notes:

JSON search expression format

It is possible to provide a JSON formatted string in the parameter search_str to customize the search of CASES. The structure of the JSON string can contain:

program: Search only CASES with ADMISSIONS in the selected PROGRAM. The program can be expressed either as a PROGRAM ID or PROGRAM CODE. Introduced in API Version 2.7.20.
subscription: Search by SUBSCRIPTION: search only cases that have an ADMISSION in the specified SUBSCRIPTION
identifier: Search by IDENTIFIER: allows to search CASES that have an specific IDENTIFIER in their contact data with the requested value. To use this search type it is necessary to provide 2 values:
- code: name of the IDENTIFIER (e.g. "NAT_ZH"). If it is empty, the search will be done for any IDENTIFIER of the CASE
- value: Value searched (the value that the IDENTIFIER of the CASE should have)
- program: This filter only takes effect when searching an IDENTIFIER OBJECT that is a SUBSCRIPTION IDENTIFIER. If provided, only the IDENTIFIERS assigned to CASES in SUBSCRIPTIONs of that PROGRAM will be considered
- team:This filter only takes effect when searching an IDENTIFIER OBJECT that is a SUBSCRIPTION IDENTIFIER or a TEAM IDENTIFIER.
  - If the program filter is also provided, only the IDENTIFIERS assigned to CASES in SUBSCRIPTIONs of that TEAM will be considered
  - Otherwise, only the TEAM IDENTIFIERS related with the selected TEAM will be considered
data_code: Search by DATA_CODE: allows to search CASES for whom there exist any ADMISSION with FORMS that include an ITEM with a specific DATA CODE and the requested value assigned. It is mandatory to indicate the DATA_CODE name. To use this search type it is necessary to provide 2 values:
- code: name of the DATA_CODE (e.g. "BLOOD_O2").This parameter cannot be empty or it will be ignored.
- value: Value searched (the value assigned to the ITEM with the requested DATA_CODE)
device: Search by DEVICE: Allows to search CASES that are associated to a specific device (Step counter, etc...). The search is done by a string that represents a unique identifier of the device. Introduced in API Version 2.7.19.
- id: string that identifies the device. The match must be exact (case sensitive)

If more than one search criteria is provided, the funcion will return the CASES that match simultaneously all af them (logical AND)

The following example requests to search any patient with

Have an ADMISSION in SUBSCRIPTION 1803
An IDENTIFIER called "NAT_ES" with value "72266626D"
AND a questionnaire that contains an ITEM with DATA_CODE="BLOOD_02" and with value "98"

{
  "subscription" : "1803",
  "identifier" : {
    "code": "NAT_ES",
    "value": "72266626D"
  },
  "data_code" : {
    "name": "BLOOD_O2",
    "value": "98"
  }
}

XML changes in API version 2.7.15 respect previous versions

In versions prior to 2.7.15 the search could be customized providing a XML expression as the search string. From version 2.7.15, the expression is provided as a JSON as described above.

The XML format of the search string in older versions was:

search_str: is the text with we made the matching search in the list of cases. It is possible to provide a simple string or a structured XML to customize search. There are 2 fields in the search XML:
- text to indicate the searched text.
- name to specify the field or fields to made the search. By default is null and search for all fields. But if it has next format: DATA_CODE=STRING function will search for cases that have answers with VALUE(RESPUESTA) = search_str and DATACODE = STRING in the form in any non-deleted admission

Example:

The following example requests to search any patient with a questionnaire that contains an ITEM with DATA_CODE="BLOOD_02" and with value "98"

<search>
  <text>98</text>
  <name>DATA_CODE=BLOOD_O2</name>
</search>

Browser not supported