GET api/v1/{EMRSystem}/UserDemographics
Returns User Demographic information for a given User Id.
Status: Released
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
| UserId |
Gets or sets the user identifier. |
string |
Required |
| NPI |
Gets or sets the NPI |
string |
None. |
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
UdmUserDemographicsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| UserName |
Gets or sets the name of the user. |
string |
None. |
| UserId |
Gets or sets the user identifier. |
string |
None. |
| DisplayName |
Gets or sets the display name. |
string |
None. |
| UserRole |
Gets or sets the user role. |
string |
None. |
| NPI |
Gets or sets the npi. |
string |
None. |
| PCTFlag |
Gets or sets a value indicating whether [PCT flag]. |
boolean |
None. |
| UserAliases |
Gets or sets the user aliases. |
Collection of Alias |
None. |
| UserRelationShips |
Gets or sets the user relationships. |
Collection of Relationship |
None. |
| UserActive |
Gets or sets a value indicating whether [user active]. |
boolean |
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
{
"UserName": "sample string 1",
"UserId": "sample string 2",
"DisplayName": "sample string 3",
"UserRole": "sample string 4",
"NPI": "sample string 5",
"PCTFlag": true,
"UserAliases": [
{
"AliasDesc": "sample string 1",
"AliasType": "sample string 2",
"AliasValue": "sample string 3"
},
{
"AliasDesc": "sample string 1",
"AliasType": "sample string 2",
"AliasValue": "sample string 3"
}
],
"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"
}
],
"UserActive": true
}