GET Users by Id

Developer Tools

GET api/v1/{EMRSystem}/Users/{UserId}

Returns User details for a given User ID.

HTTP Method

GET

Applicable Emissary Products

Clinical Analytics
Interactive Workflow

Allscripts

In Dev

Athena

In Dev

Cerner

Released

Meditech

Released

Sandbox

In Dev

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

Request Information

URI Parameters

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

EMRSystem

The emr system.

EMRsystem

Required

UserId

The user identifier.

string

Required

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing User Response View Model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

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.

UserRelationShips

Gets or sets the user relationships.

Collection of RelationshipViewModel

None.

UserIdentities

Gets or sets the user aliases.

Collection of IdentityViewModel

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.

Specilaties

The list of specialties for the user

Collection of CodedObjectViewModel

None.

 
Response Codes

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

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
{
  "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",
  "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 10",
  "NPI": "sample string 11",
  "PCTFlag": true,
  "PasswordExpired": true,
  "InvalidUserIdPassword": true
}
Sample Message
<UserResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <AccountDisabled>true</AccountDisabled>
  <DisplayName>sample string 2</DisplayName>
  <FirstName>sample string 4</FirstName>
  <InvalidUserIdPassword>true</InvalidUserIdPassword>
  <LastName>sample string 3</LastName>
  <MiddleName>sample string 5</MiddleName>
  <NPI>sample string 11</NPI>
  <PCTFlag>true</PCTFlag>
  <PasswordExpired>true</PasswordExpired>
  <ProviderId>sample string 10</ProviderId>
  <Title>sample string 6</Title>
  <UserActive>sample string 7</UserActive>
  <UserId>sample string 1</UserId>
  <UserIdentities xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:IdentityViewModel>
      <d2p1:Code>sample string 1</d2p1:Code>
      <d2p1:Description>sample string 2</d2p1:Description>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:IdentityViewModel>
    <d2p1:IdentityViewModel>
      <d2p1:Code>sample string 1</d2p1:Code>
      <d2p1:Description>sample string 2</d2p1:Description>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:IdentityViewModel>
  </UserIdentities>
  <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 9</UserRole>
</UserResponseViewModel>

Submit a Comment

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

 

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