userGet
Get users based on given search criteria.
Returns an array of User Objects from the User/Clinician registry based on given search criteria.
While this method has no required parameters, it should always be called with a reasonable set of search criteria to avoid returning a response of unmanageable size.
/user
Usage and SDK Samples
curl -X GET "/csp/healthshare/hsregistry/configuration/api/user-clinician/v1/user?active-only=&last-name=&first-name=&user-id=&identifier-extension=&assigning-authority=&clinicians-only=&facilities=&relationship-id=&mpiid=&must-have-delivery-policy="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;
import java.io.File;
import java.util.*;
public class UserApiExample {
public static void main(String[] args) {
UserApi apiInstance = new UserApi();
Boolean activeOnly = true; // Boolean | Flag to show only active users. If not set, all users (active and inactive) will be shown.
String lastName = lastName_example; // String | Last name of user.
String firstName = firstName_example; // String | First name of user.
String userId = userId_example; // String | User ID of user.
String identifierExtension = identifierExtension_example; // String | Identifier associated with a clinician.
String assigningAuthority = assigningAuthority_example; // String | Assigning Authority of a clinician identifier in identifier-extension.
Boolean cliniciansOnly = true; // Boolean | Flag to show only users marked as clinician.
String facilities = facilities_example; // String | Facility codes that user is associated with. A comma separated list for multiple codes. If multiple codes are provided, any user whose facility code is intersected by the provided ones will be returned.
String relationshipId = relationshipId_example; // String | Relationship ID that a clinician is associated with.
String mpiid = mpiid_example; // String | MPIID that a clinician is associated with.
Boolean mustHaveDeliveryPolicy = true; // Boolean | Flag to show only results with a delivery policy.
try {
array[null] result = apiInstance.userGet(activeOnly, lastName, firstName, userId, identifierExtension, assigningAuthority, cliniciansOnly, facilities, relationshipId, mpiid, mustHaveDeliveryPolicy);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserApi#userGet");
e.printStackTrace();
}
}
}
import io.swagger.client.api.UserApi;
public class UserApiExample {
public static void main(String[] args) {
UserApi apiInstance = new UserApi();
Boolean activeOnly = true; // Boolean | Flag to show only active users. If not set, all users (active and inactive) will be shown.
String lastName = lastName_example; // String | Last name of user.
String firstName = firstName_example; // String | First name of user.
String userId = userId_example; // String | User ID of user.
String identifierExtension = identifierExtension_example; // String | Identifier associated with a clinician.
String assigningAuthority = assigningAuthority_example; // String | Assigning Authority of a clinician identifier in identifier-extension.
Boolean cliniciansOnly = true; // Boolean | Flag to show only users marked as clinician.
String facilities = facilities_example; // String | Facility codes that user is associated with. A comma separated list for multiple codes. If multiple codes are provided, any user whose facility code is intersected by the provided ones will be returned.
String relationshipId = relationshipId_example; // String | Relationship ID that a clinician is associated with.
String mpiid = mpiid_example; // String | MPIID that a clinician is associated with.
Boolean mustHaveDeliveryPolicy = true; // Boolean | Flag to show only results with a delivery policy.
try {
array[null] result = apiInstance.userGet(activeOnly, lastName, firstName, userId, identifierExtension, assigningAuthority, cliniciansOnly, facilities, relationshipId, mpiid, mustHaveDeliveryPolicy);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserApi#userGet");
e.printStackTrace();
}
}
}
Boolean *activeOnly = true; // Flag to show only active users. If not set, all users (active and inactive) will be shown. (optional) (default to true)
String *lastName = lastName_example; // Last name of user. (optional)
String *firstName = firstName_example; // First name of user. (optional)
String *userId = userId_example; // User ID of user. (optional)
String *identifierExtension = identifierExtension_example; // Identifier associated with a clinician. (optional)
String *assigningAuthority = assigningAuthority_example; // Assigning Authority of a clinician identifier in identifier-extension. (optional)
Boolean *cliniciansOnly = true; // Flag to show only users marked as clinician. (optional)
String *facilities = facilities_example; // Facility codes that user is associated with. A comma separated list for multiple codes. If multiple codes are provided, any user whose facility code is intersected by the provided ones will be returned. (optional)
String *relationshipId = relationshipId_example; // Relationship ID that a clinician is associated with. (optional)
String *mpiid = mpiid_example; // MPIID that a clinician is associated with. (optional)
Boolean *mustHaveDeliveryPolicy = true; // Flag to show only results with a delivery policy. (optional)
UserApi *apiInstance = [[UserApi alloc] init];
// Get users based on given search criteria.
[apiInstance userGetWith:activeOnly
lastName:lastName
firstName:firstName
userId:userId
identifierExtension:identifierExtension
assigningAuthority:assigningAuthority
cliniciansOnly:cliniciansOnly
facilities:facilities
relationshipId:relationshipId
mpiid:mpiid
mustHaveDeliveryPolicy:mustHaveDeliveryPolicy
completionHandler: ^(NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var UserClinicianApi = require('user_clinician_api');
var api = new UserClinicianApi.UserApi()
var opts = {
'activeOnly': true, // {{Boolean}} Flag to show only active users. If not set, all users (active and inactive) will be shown.
'lastName': lastName_example, // {{String}} Last name of user.
'firstName': firstName_example, // {{String}} First name of user.
'userId': userId_example, // {{String}} User ID of user.
'identifierExtension': identifierExtension_example, // {{String}} Identifier associated with a clinician.
'assigningAuthority': assigningAuthority_example, // {{String}} Assigning Authority of a clinician identifier in identifier-extension.
'cliniciansOnly': true, // {{Boolean}} Flag to show only users marked as clinician.
'facilities': facilities_example, // {{String}} Facility codes that user is associated with. A comma separated list for multiple codes. If multiple codes are provided, any user whose facility code is intersected by the provided ones will be returned.
'relationshipId': relationshipId_example, // {{String}} Relationship ID that a clinician is associated with.
'mpiid': mpiid_example, // {{String}} MPIID that a clinician is associated with.
'mustHaveDeliveryPolicy': true // {{Boolean}} Flag to show only results with a delivery policy.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.userGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class userGetExample
{
public void main()
{
var apiInstance = new UserApi();
var activeOnly = true; // Boolean | Flag to show only active users. If not set, all users (active and inactive) will be shown. (optional) (default to true)
var lastName = lastName_example; // String | Last name of user. (optional)
var firstName = firstName_example; // String | First name of user. (optional)
var userId = userId_example; // String | User ID of user. (optional)
var identifierExtension = identifierExtension_example; // String | Identifier associated with a clinician. (optional)
var assigningAuthority = assigningAuthority_example; // String | Assigning Authority of a clinician identifier in identifier-extension. (optional)
var cliniciansOnly = true; // Boolean | Flag to show only users marked as clinician. (optional)
var facilities = facilities_example; // String | Facility codes that user is associated with. A comma separated list for multiple codes. If multiple codes are provided, any user whose facility code is intersected by the provided ones will be returned. (optional)
var relationshipId = relationshipId_example; // String | Relationship ID that a clinician is associated with. (optional)
var mpiid = mpiid_example; // String | MPIID that a clinician is associated with. (optional)
var mustHaveDeliveryPolicy = true; // Boolean | Flag to show only results with a delivery policy. (optional)
try
{
// Get users based on given search criteria.
array[null] result = apiInstance.userGet(activeOnly, lastName, firstName, userId, identifierExtension, assigningAuthority, cliniciansOnly, facilities, relationshipId, mpiid, mustHaveDeliveryPolicy);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.userGet: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiUserApi();
$activeOnly = true; // Boolean | Flag to show only active users. If not set, all users (active and inactive) will be shown.
$lastName = lastName_example; // String | Last name of user.
$firstName = firstName_example; // String | First name of user.
$userId = userId_example; // String | User ID of user.
$identifierExtension = identifierExtension_example; // String | Identifier associated with a clinician.
$assigningAuthority = assigningAuthority_example; // String | Assigning Authority of a clinician identifier in identifier-extension.
$cliniciansOnly = true; // Boolean | Flag to show only users marked as clinician.
$facilities = facilities_example; // String | Facility codes that user is associated with. A comma separated list for multiple codes. If multiple codes are provided, any user whose facility code is intersected by the provided ones will be returned.
$relationshipId = relationshipId_example; // String | Relationship ID that a clinician is associated with.
$mpiid = mpiid_example; // String | MPIID that a clinician is associated with.
$mustHaveDeliveryPolicy = true; // Boolean | Flag to show only results with a delivery policy.
try {
$result = $api_instance->userGet($activeOnly, $lastName, $firstName, $userId, $identifierExtension, $assigningAuthority, $cliniciansOnly, $facilities, $relationshipId, $mpiid, $mustHaveDeliveryPolicy);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->userGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;
my $api_instance = WWW::SwaggerClient::UserApi->new();
my $activeOnly = true; # Boolean | Flag to show only active users. If not set, all users (active and inactive) will be shown.
my $lastName = lastName_example; # String | Last name of user.
my $firstName = firstName_example; # String | First name of user.
my $userId = userId_example; # String | User ID of user.
my $identifierExtension = identifierExtension_example; # String | Identifier associated with a clinician.
my $assigningAuthority = assigningAuthority_example; # String | Assigning Authority of a clinician identifier in identifier-extension.
my $cliniciansOnly = true; # Boolean | Flag to show only users marked as clinician.
my $facilities = facilities_example; # String | Facility codes that user is associated with. A comma separated list for multiple codes. If multiple codes are provided, any user whose facility code is intersected by the provided ones will be returned.
my $relationshipId = relationshipId_example; # String | Relationship ID that a clinician is associated with.
my $mpiid = mpiid_example; # String | MPIID that a clinician is associated with.
my $mustHaveDeliveryPolicy = true; # Boolean | Flag to show only results with a delivery policy.
eval {
my $result = $api_instance->userGet(activeOnly => $activeOnly, lastName => $lastName, firstName => $firstName, userId => $userId, identifierExtension => $identifierExtension, assigningAuthority => $assigningAuthority, cliniciansOnly => $cliniciansOnly, facilities => $facilities, relationshipId => $relationshipId, mpiid => $mpiid, mustHaveDeliveryPolicy => $mustHaveDeliveryPolicy);
print Dumper($result);
};
if ($@) {
warn "Exception when calling UserApi->userGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.UserApi()
activeOnly = true # Boolean | Flag to show only active users. If not set, all users (active and inactive) will be shown. (optional) (default to true)
lastName = lastName_example # String | Last name of user. (optional)
firstName = firstName_example # String | First name of user. (optional)
userId = userId_example # String | User ID of user. (optional)
identifierExtension = identifierExtension_example # String | Identifier associated with a clinician. (optional)
assigningAuthority = assigningAuthority_example # String | Assigning Authority of a clinician identifier in identifier-extension. (optional)
cliniciansOnly = true # Boolean | Flag to show only users marked as clinician. (optional)
facilities = facilities_example # String | Facility codes that user is associated with. A comma separated list for multiple codes. If multiple codes are provided, any user whose facility code is intersected by the provided ones will be returned. (optional)
relationshipId = relationshipId_example # String | Relationship ID that a clinician is associated with. (optional)
mpiid = mpiid_example # String | MPIID that a clinician is associated with. (optional)
mustHaveDeliveryPolicy = true # Boolean | Flag to show only results with a delivery policy. (optional)
try:
# Get users based on given search criteria.
api_response = api_instance.user_get(activeOnly=activeOnly, lastName=lastName, firstName=firstName, userId=userId, identifierExtension=identifierExtension, assigningAuthority=assigningAuthority, cliniciansOnly=cliniciansOnly, facilities=facilities, relationshipId=relationshipId, mpiid=mpiid, mustHaveDeliveryPolicy=mustHaveDeliveryPolicy)
pprint(api_response)
except ApiException as e:
print("Exception when calling UserApi->userGet: %s\n" % e)
Parameters
Name | Description |
---|---|
active-only |
Boolean
Flag to show only active users. If not set, all users (active and inactive) will be shown.
|
last-name |
String
Last name of user.
|
first-name |
String
First name of user.
|
user-id |
String
User ID of user.
|
identifier-extension |
String
Identifier associated with a clinician.
|
assigning-authority |
String
Assigning Authority of a clinician identifier in identifier-extension.
|
clinicians-only |
Boolean
Flag to show only users marked as clinician.
|
facilities |
String
Facility codes that user is associated with. A comma separated list for multiple codes. If multiple codes are provided, any user whose facility code is intersected by the provided ones will be returned.
|
relationship-id |
String
Relationship ID that a clinician is associated with.
|
mpiid |
String
MPIID that a clinician is associated with.
|
must-have-delivery-policy |
Boolean
Flag to show only results with a delivery policy.
|