GET api/v1/{EMRSystem}/Population/Personnel

Returns all Personnel that have been updated in a given timeframe.

Status: Beta

URI Parameters

Name	Description	Type	Additional information
EMRSystem	The emr system.	EMRSystem	None.
LocationList	The Location List	string	None.
UserId	Identifier of the user initiating the request.	string	Required
FromDateTime	Gets or sets from date time.	datetime	Required if EMRSystem = Cerner, or Epic, or Meditech
ToDateTime	Gets or sets to date time.	datetime	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

Collection of UdmPopulationPersonnelResponse

Name	Description	Type	Additional information
CreatedUpdatedDateTime	Gets or sets the created updated date time.	datetime	None.
UserName	Gets or sets the UserName	string	None.
ProviderId	Gets or sets the ProviderId	string	None.
DisplayName	Gets or sets the DisplayName	string	None.
FirstName	Gets or sets the FirstName	string	None.
LastName	Gets or sets the LastName	string	None.
MiddleName	Gets or sets the MiddleName	string	None.
Title	Gets or sets the Title	string	None.
Gender	Gets or sets the Gender	CodedObject	None.
UserRole	Gets or sets the UserRole	string	None.
UserRoleId	Gets or sets the UserRoleId	string	None.
UserStatus	Gets or sets the UserStatus	CodedObject	None.
BeginEffectiveDateTime	Gets or sets the BeginEffectiveDateTime	datetime	None.
EndEffectiveDateTime	Gets or sets the EndEffectiveDateTime	datetime	None.
Specialties	Gets or sets the List of Specialties	Collection of CodedObject	None.
Identities	Gets or sets the List of Identities	Collection of Identity	None.
AssociatedAccounts	Gets or sets the List of AssociatedAccounts	Collection of AssociatedAccount	None.
Addresses	Gets or sets the List of Addresses	Collection of Address	None.
Phones	Gets or sets the list of Phones	Collection of Phone	None.
IsPhysician	Gets or sets IsPhysician flag	boolean	None.

Response Codes

Http Status Code 200 - Indicates that the request was processed successfully.

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

[
  {
    "CreatedUpdatedDateTime": "2025-12-12T21:08:38.6117982+00:00",
    "UserName": "sample string 1",
    "ProviderId": "sample string 2",
    "DisplayName": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "MiddleName": "sample string 6",
    "Title": "sample string 7",
    "Gender": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "UserRole": "sample string 8",
    "UserRoleId": "sample string 9",
    "UserStatus": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "BeginEffectiveDateTime": "2025-12-12T21:08:38.6283512+00:00",
    "EndEffectiveDateTime": "2025-12-12T21:08:38.6284002+00:00",
    "Specialties": [
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    ],
    "Identities": [
      {
        "Code": "sample string 1",
        "Description": "sample string 2",
        "Value": "sample string 3"
      },
      {
        "Code": "sample string 1",
        "Description": "sample string 2",
        "Value": "sample string 3"
      }
    ],
    "AssociatedAccounts": [
      {
        "ProviderId": "sample string 1",
        "UserActive": "sample string 2",
        "AccountDisabled": true,
        "BeginEffectiveDateTime": "2025-12-12T21:08:38.6289292+00:00",
        "EndEffectiveDateTime": "2025-12-12T21:08:38.6380866+00:00"
      },
      {
        "ProviderId": "sample string 1",
        "UserActive": "sample string 2",
        "AccountDisabled": true,
        "BeginEffectiveDateTime": "2025-12-12T21:08:38.6289292+00:00",
        "EndEffectiveDateTime": "2025-12-12T21:08:38.6380866+00:00"
      }
    ],
    "Addresses": [
      {
        "AddressId": "sample string 1",
        "Address1": "sample string 2",
        "Address2": "sample string 3",
        "Address3": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "ZIP": "sample string 7",
        "Type": "sample string 8",
        "TypeId": "sample string 9",
        "SequenceNumber": "sample string 10",
        "Country": "sample string 11",
        "County": "sample string 12",
        "EndEffectiveDateTime": "2025-12-12T21:08:38.6383845+00:00"
      },
      {
        "AddressId": "sample string 1",
        "Address1": "sample string 2",
        "Address2": "sample string 3",
        "Address3": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "ZIP": "sample string 7",
        "Type": "sample string 8",
        "TypeId": "sample string 9",
        "SequenceNumber": "sample string 10",
        "Country": "sample string 11",
        "County": "sample string 12",
        "EndEffectiveDateTime": "2025-12-12T21:08:38.6383845+00:00"
      }
    ],
    "Phones": [
      {
        "PhoneId": "sample string 1",
        "Number": "sample string 2",
        "SequenceNumber": "sample string 3",
        "Type": "sample string 4",
        "TypeId": "sample string 5",
        "Extension": "sample string 6",
        "EndEffectiveDateTime": "2025-12-12T21:08:38.6384538+00:00",
        "Format": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      },
      {
        "PhoneId": "sample string 1",
        "Number": "sample string 2",
        "SequenceNumber": "sample string 3",
        "Type": "sample string 4",
        "TypeId": "sample string 5",
        "Extension": "sample string 6",
        "EndEffectiveDateTime": "2025-12-12T21:08:38.6384538+00:00",
        "Format": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      }
    ],
    "IsPhysician": true
  },
  {
    "CreatedUpdatedDateTime": "2025-12-12T21:08:38.6117982+00:00",
    "UserName": "sample string 1",
    "ProviderId": "sample string 2",
    "DisplayName": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "MiddleName": "sample string 6",
    "Title": "sample string 7",
    "Gender": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "UserRole": "sample string 8",
    "UserRoleId": "sample string 9",
    "UserStatus": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "BeginEffectiveDateTime": "2025-12-12T21:08:38.6283512+00:00",
    "EndEffectiveDateTime": "2025-12-12T21:08:38.6284002+00:00",
    "Specialties": [
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    ],
    "Identities": [
      {
        "Code": "sample string 1",
        "Description": "sample string 2",
        "Value": "sample string 3"
      },
      {
        "Code": "sample string 1",
        "Description": "sample string 2",
        "Value": "sample string 3"
      }
    ],
    "AssociatedAccounts": [
      {
        "ProviderId": "sample string 1",
        "UserActive": "sample string 2",
        "AccountDisabled": true,
        "BeginEffectiveDateTime": "2025-12-12T21:08:38.6289292+00:00",
        "EndEffectiveDateTime": "2025-12-12T21:08:38.6380866+00:00"
      },
      {
        "ProviderId": "sample string 1",
        "UserActive": "sample string 2",
        "AccountDisabled": true,
        "BeginEffectiveDateTime": "2025-12-12T21:08:38.6289292+00:00",
        "EndEffectiveDateTime": "2025-12-12T21:08:38.6380866+00:00"
      }
    ],
    "Addresses": [
      {
        "AddressId": "sample string 1",
        "Address1": "sample string 2",
        "Address2": "sample string 3",
        "Address3": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "ZIP": "sample string 7",
        "Type": "sample string 8",
        "TypeId": "sample string 9",
        "SequenceNumber": "sample string 10",
        "Country": "sample string 11",
        "County": "sample string 12",
        "EndEffectiveDateTime": "2025-12-12T21:08:38.6383845+00:00"
      },
      {
        "AddressId": "sample string 1",
        "Address1": "sample string 2",
        "Address2": "sample string 3",
        "Address3": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "ZIP": "sample string 7",
        "Type": "sample string 8",
        "TypeId": "sample string 9",
        "SequenceNumber": "sample string 10",
        "Country": "sample string 11",
        "County": "sample string 12",
        "EndEffectiveDateTime": "2025-12-12T21:08:38.6383845+00:00"
      }
    ],
    "Phones": [
      {
        "PhoneId": "sample string 1",
        "Number": "sample string 2",
        "SequenceNumber": "sample string 3",
        "Type": "sample string 4",
        "TypeId": "sample string 5",
        "Extension": "sample string 6",
        "EndEffectiveDateTime": "2025-12-12T21:08:38.6384538+00:00",
        "Format": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      },
      {
        "PhoneId": "sample string 1",
        "Number": "sample string 2",
        "SequenceNumber": "sample string 3",
        "Type": "sample string 4",
        "TypeId": "sample string 5",
        "Extension": "sample string 6",
        "EndEffectiveDateTime": "2025-12-12T21:08:38.6384538+00:00",
        "Format": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      }
    ],
    "IsPhysician": true
  }
]

GET api/v1/{EMRSystem}/Population/Personnel

Returns all Personnel that have been updated in a given timeframe.

Status: Beta

URI Parameters

EMRSystem

Required

LocationList

UserId

Required

FromDateTime

Required if EMRSystem = Cerner, or Epic, or Meditech

ToDateTime

Header Parameters

LoginId

Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox

Password

Data type: Password , Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox

EmrInstance

ApplicationName

Required if using application keys

ApplicationKey

Data type: Password , Required if using application keys

AuthorizationToken

RequestVerboseLogging

Request: {{ method }} {{ url }}

Http Request Headers
{{header.name}} : {{header.value}} ******

Http Request Body
```
{{httpRequestBody}}
```

Http Status Code: {{httpResponseStatus}}

Http Response Headers
{{header.name}} : {{header.value}} ******

Http Response Data
```
{{httpResponseData}}
```