/
user_search ()

user_search ()

Owned by Pedro Jose Sanchez Luling
Last updated: Jan 26, 2024
3 min read

Function prototype

user_search (session, search_str , [max_res = 1000], [offset = 1])

API Version

2.7.25 and higher

Supported interfaces

SOAP

Description

Returns a list of professional USERs that match the search criteria

If the instance is configured to connect to an external HIS (interoperability) and the HIS supports the search of USERS, the results returned by the function will contain the USERS found in the internal DB in addition to the ones found in the external HIS

If a simple string is provided in the search_str parameter, it will we used to find USERS 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

Input parameters:

  • session: is the session token obtained in the session_init() call

  • search_str: is the text with we made the matching search in the list of USERS. It is possible to provide a simple string or a structured JSON expression to customize search. See below the Search expression format

  • max_res: It sets the maximum number of USERS to be returned by the function

  • offset: the base-one position of the first USER to be returned

Output parameters:

  • result: List of users

    • users:

      • items: the total number of USERS that could be returned. If items is higher than max-items item will still be the total number, while the “users” node will only include the max_res USERS passed

      • offset: the base-one position of the first USER returned

      • user: 

        • ref: is the source of the admission, must be Linkcare or a HIS connected to Linkcare

        • pictures: Images of the USER

          • insignia:

            • ref: reference to the "INSIGNIA" image

        • data:

          • nickname: is the nickname on Linkcare of the USER

          • full_name: is the full-name of the USER if it’s informed

          • bdate: is the USER's birth date

          • age: is the age of the USER

          • gender: M for male F for female

  • ErrorMsg: If any error occurs, then this value contains a description of the error translated to the current language

  • ErrorCode: If any error occurs, then this value contains any of the standard ERROR CODES

Request example

user_search ( “LCAAAAAAAAAAAA”, "john")

Response

<?xml version="1.0" encoding="utf-8" standalone="yes"?> <result> <users> <items>3</items> <user> <ref>14872</ref> <pictures> <insignia> <ref>P1860000</ref> </insignia> </pictures> <data> <nickname>JAMES S</nickname> <full_name>James Swift</full_name> <bdate>1968-03-12</bdate> <age>54</age> <gender>M</gender> </data> </user> <user>…</user> … </users> </result> <ErrorMsg></ErrorMsg> <ErrorCode></ErrorCode>

Return Error codes

ERROR CODE

 

ERROR CODE

 

INVALID_TOKEN

The session token provided is not valid

INSUFFICIENT_PRIVILEGES

The session user does not have the necessary privileges to …

JSON search expression format

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

  • 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

  • username: Search by username

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

The following example requests to search any patient with

  • An IDENTIFIER called "NAT_ES" with value "72266626D"

  • AND username = "kx822"

{ "identifier" : { "code": "NAT_ES", "value": "72266626D" }, "username" : "kx822" }



Related content