GET User Demographics

Developer Tools

GET api/v1/{EMRSystem}/UserDemographics

Returns User Demographic information for a given User ID.

HTTP Method

GET

Applicable Emissary Products

Clinical Analytics
Interactive Workflow

Allscripts

Released

Athena

In Dev

Cerner

Released

Meditech

Released

Sandbox

In Dev

Don't see the data field you are looking for?

Request Information

URI Parameters
One of the following parameters must have a value specified: UserId, NPI

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

EMRSystem

The emr system.

EMRsystem

Required

UserId

Gets or sets the user identifier.

string

Required

NPI

Gets or sets the NPI.

string

None

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing User Demographics Response View Model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

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 AliasViewModel

None.

UserRelationShips

Gets or sets the user relationships.

Collection of RelationshipViewModel

None.

UserActive

Gets or sets a value indicating whether [user active].

boolean

None.

 
Response Codes

Http Status Code 200 – Returns Sansoro.Shared.SansoroServiceBus.Models.UserDemographicsResponseViewModel

Http Status Code 400 – Indicates that the request did not contain all the required fields.

Http Status Code 404 – Indicates that the resource to get could not be found.

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
Sample Message
Download Json Schema
{
  "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
}
Sample Message
<UserDemographicsResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <DisplayName>sample string 3</DisplayName>
  <NPI>sample string 5</NPI>
  <PCTFlag>true</PCTFlag>
  <UserActive>true</UserActive>
  <UserAliases xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:AliasViewModel>
      <d2p1:AliasDesc>sample string 1</d2p1:AliasDesc>
      <d2p1:AliasType>sample string 2</d2p1:AliasType>
      <d2p1:AliasValue>sample string 3</d2p1:AliasValue>
    </d2p1:AliasViewModel>
    <d2p1:AliasViewModel>
      <d2p1:AliasDesc>sample string 1</d2p1:AliasDesc>
      <d2p1:AliasType>sample string 2</d2p1:AliasType>
      <d2p1:AliasValue>sample string 3</d2p1:AliasValue>
    </d2p1:AliasViewModel>
  </UserAliases>
  <UserId>sample string 2</UserId>
  <UserName>sample string 1</UserName>
  <UserRelationShips xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:RelationshipViewModel>
      <d2p1:RelationshipDesc>sample string 2</d2p1:RelationshipDesc>
      <d2p1:RelationshipId>sample string 1</d2p1:RelationshipId>
      <d2p1:RelationshipType>sample string 3</d2p1:RelationshipType>
    </d2p1:RelationshipViewModel>
    <d2p1:RelationshipViewModel>
      <d2p1:RelationshipDesc>sample string 2</d2p1:RelationshipDesc>
      <d2p1:RelationshipId>sample string 1</d2p1:RelationshipId>
      <d2p1:RelationshipType>sample string 3</d2p1:RelationshipType>
    </d2p1:RelationshipViewModel>
  </UserRelationShips>
  <UserRole>sample string 4</UserRole>
</UserDemographicsResponseViewModel>

Submit a Comment

Your email address will not be published. Required fields are marked *

 

Don't see the data field you are looking for?