GET api/v1/{EMRSystem}/Users/{UserId}
Returns User details for a given User ID.
Status: Released
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
| UserId |
The User identifier. |
string |
Required |
Header Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| LoginId |
Gets or sets the login identifier. This Login Id will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| Password |
Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| EmrInstance |
Gets or sets the emr instance. This emr instance info will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| ApplicationName |
Gets or sets the requesting application name. This requesting application name will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if using application keys |
| ApplicationKey |
Gets or sets the requesting application key. This requesting application key will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if using application keys |
| AuthorizationToken |
Gets or sets the custom authorization token. This requesting authorization token will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| RequestVerboseLogging |
Enables verbose logging for a single request. When "true", verbose logging will occur. When "false", the configuration setting will be respected. This value will be passed in Sansoro specific Http Request Headers. |
boolean |
None. |
Response Information
UdmUserResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId |
The user identifier |
string |
None. |
| DisplayName |
The display name of the user |
string |
None. |
| LastName |
The last name of the user |
string |
None. |
| FirstName |
The first name of the user |
string |
None. |
| MiddleName |
The middle name of the user |
string |
None. |
| Title |
The title of the user |
string |
None. |
| UserActive |
Gets or sets the user active. |
string |
None. |
| AccountDisabled |
Gets or sets a value indicating whether [account disabled]. |
boolean |
None. |
| UserRole |
A role denoting if the user is a Doctor or a Nurse Practitioner |
string |
None. |
| UserRoleId |
A role id denoting if the user is a Doctor or a Nurse Practitioner |
string |
None. |
| UserRelationShips |
Gets or sets the user relationships. |
Collection of Relationship |
None. |
| UserIdentities |
Gets or sets the user aliases. |
Collection of Identity |
None. |
| ProviderId |
The identifier of the associated provider |
string |
None. |
| NPI |
The national provider identifier of the associated provider |
string |
None. |
| PCTFlag |
Gets or sets a value indicating whether [PCT flag]. |
boolean |
None. |
| PasswordExpired |
Gets or sets a value indicating whether [password expired]. |
boolean |
None. |
| InvalidUserIdPassword |
Gets or sets a value indicating whether [invalid user identifier password]. |
boolean |
None. |
| Specialties |
THe list of specialties for the user |
Collection of CodedObject |
None. |
| BeginEffectiveDateTime |
Gets or sets the begin effective date time. |
datetime |
None. |
| EndEffectiveDateTime |
Gets or sets the end effective date time. |
datetime |
None. |
| AssociatedAccounts |
The list of associated accounts for the user |
Collection of AssociatedAccount |
None. |
Response Codes
Http Status Code 200 - Indicates that the request was processed successfully.
Http Status Code 404 - Indicates that the resource to get could not be found.
Http Status Code 400 - Indicates that the request did not contain all the required fields or had an invalid value.
Http Status Code 401 - Indicates that authentication to the underlying EMR server using the provided LoginId and Password failed.
Http Status Code 403 - Indicates that there is an issue with the request UserId.
Http Status Code 408 - Indicates that the request to the underlying EMR server timed out.
Http Status Code 500 - Indicates that an internal server error occurred during processing of the request.
Http Status Code 502 - Indicates that a request made to the underlying EMR server could not be completed.
Response Formats
application/json
{
"UserId": "sample string 1",
"DisplayName": "sample string 2",
"LastName": "sample string 3",
"FirstName": "sample string 4",
"MiddleName": "sample string 5",
"Title": "sample string 6",
"UserActive": "sample string 7",
"AccountDisabled": true,
"UserRole": "sample string 9",
"UserRoleId": "sample string 10",
"UserRelationShips": [
{
"RelationshipId": "sample string 1",
"RelationshipDesc": "sample string 2",
"RelationshipType": "sample string 3"
},
{
"RelationshipId": "sample string 1",
"RelationshipDesc": "sample string 2",
"RelationshipType": "sample string 3"
}
],
"UserIdentities": [
{
"Code": "sample string 1",
"Description": "sample string 2",
"Value": "sample string 3"
},
{
"Code": "sample string 1",
"Description": "sample string 2",
"Value": "sample string 3"
}
],
"ProviderId": "sample string 11",
"NPI": "sample string 12",
"PCTFlag": true,
"PasswordExpired": true,
"InvalidUserIdPassword": true,
"Specialties": [
{
"Id": "sample string 1",
"Name": "sample string 2"
},
{
"Id": "sample string 1",
"Name": "sample string 2"
}
],
"BeginEffectiveDateTime": "2025-12-12T21:03:45.0861057+00:00",
"EndEffectiveDateTime": "2025-12-12T21:03:45.0861496+00:00",
"AssociatedAccounts": [
{
"ProviderId": "sample string 1",
"UserActive": "sample string 2",
"AccountDisabled": true,
"BeginEffectiveDateTime": "2025-12-12T21:03:45.0863855+00:00",
"EndEffectiveDateTime": "2025-12-12T21:03:45.0864246+00:00"
},
{
"ProviderId": "sample string 1",
"UserActive": "sample string 2",
"AccountDisabled": true,
"BeginEffectiveDateTime": "2025-12-12T21:03:45.0863855+00:00",
"EndEffectiveDateTime": "2025-12-12T21:03:45.0864246+00:00"
}
]
}