GET api/v1/{EMRSystem}/Population/Patients
Returns all Patients 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. |
| IncludeExtended |
Gets or sets a value indicating whether [include extended]. |
boolean |
None. |
| IncludeIdentity |
Gets or sets a value indicating whether [include identity]. |
boolean |
None. |
| IncludeRelatedPersons |
Gets or sets a value indicating whether [include related persons]. |
boolean |
None. |
| IncludeCustomFields |
Gets or sets a value of the Custom Fields |
boolean |
None. |
| IncludeComments |
Gets or sets a value of the getting the Comments |
boolean |
None. |
| IncludeCreateDateTimeSearch |
This parameter specifies whether or not to also search the create datetime in addition to the update datetime. |
boolean |
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 UdmPopulationPatientsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| UpdatedByUserName |
Username of the user that did the update |
string |
None. |
| CreatedUpdatedDateTime |
Created Update Time |
datetime |
None. |
| EndEffectiveDateTime |
End Effective Date time |
datetime |
None. |
| Patient |
Gets or sets the patient. |
BasePatient |
None. |
| MRNIdentities |
Gets or sets the list of MRN's that belong to the patient |
Collection of MRNIdentity |
None. |
| Identities |
Gets or sets a list of Identities. |
Collection of Identity |
None. |
| RelatedPersons |
Gets or sets the list of Related Persons |
Collection of RelatedPersonRelationship |
None. |
| ProviderRelationships |
Gets or sets the list of Provider Relationships |
Collection of ProviderWithRelationship |
None. |
| CustomFields |
Gets or sets the list of Custom Fields |
Collection of CustomFieldObject |
None. |
| ExtendedInfo |
Gets or sets the Extended Information |
PopulationExtendedInfo |
None. |
| Comments |
Gets or sets the list of Comments |
Collection of Comment |
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
[
{
"UpdatedByUserName": "2025-12-12",
"CreatedUpdatedDateTime": "2025-12-12T20:51:47.3206893+00:00",
"EndEffectiveDateTime": "2025-12-12T20:51:47.3207545+00:00",
"Patient": {
"PatientId": "sample string 1",
"DisplayName": "sample string 2",
"LastName": "sample string 3",
"FirstName": "sample string 4",
"MiddleName": "sample string 5",
"MRN": "sample string 6",
"BirthDateTime": "2025-12-12T20:51:47.3208189+00:00",
"Gender": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"DeceasedDateTime": "2025-12-12T20:51:47.3208313+00:00"
},
"MRNIdentities": [
{
"Value": "sample string 1",
"Type": {
"Id": "sample string 1",
"Name": "sample string 2",
"Description": "sample string 3"
},
"SubType": {
"Id": "sample string 1",
"Name": "sample string 2",
"Description": "sample string 3"
}
},
{
"Value": "sample string 1",
"Type": {
"Id": "sample string 1",
"Name": "sample string 2",
"Description": "sample string 3"
},
"SubType": {
"Id": "sample string 1",
"Name": "sample string 2",
"Description": "sample string 3"
}
}
],
"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"
}
],
"RelatedPersons": [
{
"Person": {
"PersonId": "sample string 1",
"PersonName": "sample string 2"
},
"RelationshipType": "sample string 1",
"FromDate": "2025-12-12T20:51:47.3222013+00:00",
"ToDate": "2025-12-12T20:51:47.3222479+00:00",
"ReltnTypeCD": "sample string 2",
"PersonReltnDisp": "sample string 3",
"PersonReltnCD": "sample string 4",
"RelatedPersonReltnTypeDisp": "sample string 5",
"RelatedPersonReltnTypeCD": "sample string 6",
"ActiveStatusCD": "sample string 7",
"ActiveStatusDisp": "sample string 8",
"DataStatusCD": "sample string 9",
"DataStatusDisp": "sample string 10",
"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-12T20:51:47.3236946+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-12T20:51:47.3236946+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
]
},
{
"Person": {
"PersonId": "sample string 1",
"PersonName": "sample string 2"
},
"RelationshipType": "sample string 1",
"FromDate": "2025-12-12T20:51:47.3222013+00:00",
"ToDate": "2025-12-12T20:51:47.3222479+00:00",
"ReltnTypeCD": "sample string 2",
"PersonReltnDisp": "sample string 3",
"PersonReltnCD": "sample string 4",
"RelatedPersonReltnTypeDisp": "sample string 5",
"RelatedPersonReltnTypeCD": "sample string 6",
"ActiveStatusCD": "sample string 7",
"ActiveStatusDisp": "sample string 8",
"DataStatusCD": "sample string 9",
"DataStatusDisp": "sample string 10",
"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-12T20:51:47.3236946+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-12T20:51:47.3236946+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
]
}
],
"ProviderRelationships": [
{
"ProviderRelationship": "sample string 1",
"ProviderId": "sample string 2",
"ProviderName": "sample string 3"
},
{
"ProviderRelationship": "sample string 1",
"ProviderId": "sample string 2",
"ProviderName": "sample string 3"
}
],
"CustomFields": [
{
"Field": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"CodedResponseValue": [
{
"Id": "sample string 1",
"Name": "sample string 2"
},
{
"Id": "sample string 1",
"Name": "sample string 2"
}
],
"TextResponseValue": [
"sample string 1",
"sample string 2"
]
},
{
"Field": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"CodedResponseValue": [
{
"Id": "sample string 1",
"Name": "sample string 2"
},
{
"Id": "sample string 1",
"Name": "sample string 2"
}
],
"TextResponseValue": [
"sample string 1",
"sample string 2"
]
}
],
"ExtendedInfo": {
"BirthGender": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"GenderIdentity": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Vip": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Deceased": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"PreviousLastName": "sample string 1",
"Email": "sample string 2",
"Language": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Ethnicity": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Ethnicities": [
{
"Id": "sample string 1",
"Name": "sample string 2"
},
{
"Id": "sample string 1",
"Name": "sample string 2"
}
],
"MaritalStatus": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Race": [
{
"Id": "sample string 1",
"Name": "sample string 2"
},
{
"Id": "sample string 1",
"Name": "sample string 2"
}
],
"Religion": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"EducationLevel": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"NeedsInterpreter": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"StudentStatus": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"WrittenFormat": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"AlternativeNames": [
{
"NameType": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"LastName": "sample string 1",
"FirstName": "sample string 2",
"MiddleName": "sample string 3",
"Prefix": "sample string 4",
"Suffix": "sample string 5"
},
{
"NameType": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"LastName": "sample string 1",
"FirstName": "sample string 2",
"MiddleName": "sample string 3",
"Prefix": "sample string 4",
"Suffix": "sample string 5"
}
],
"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-12T20:51:47.3272308+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-12T20:51:47.3272308+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-12T20:51:47.3236946+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-12T20:51:47.3236946+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"PersonType": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"PatientPortal": {
"ChallengeQuestionId": "sample string 1",
"ChallengeAnswer": "sample string 2",
"HealthInfoAccessOfferedId": "sample string 3"
}
},
"Comments": [
{
"CommentText": "sample string 1",
"CommentUpdateDateTime": "2025-12-12T20:51:47.3285976+00:00",
"CommentUpdatePersonnel": "2025-12-12",
"InternalSequence": "sample string 2"
},
{
"CommentText": "sample string 1",
"CommentUpdateDateTime": "2025-12-12T20:51:47.3285976+00:00",
"CommentUpdatePersonnel": "2025-12-12",
"InternalSequence": "sample string 2"
}
]
},
{
"UpdatedByUserName": "2025-12-12",
"CreatedUpdatedDateTime": "2025-12-12T20:51:47.3206893+00:00",
"EndEffectiveDateTime": "2025-12-12T20:51:47.3207545+00:00",
"Patient": {
"PatientId": "sample string 1",
"DisplayName": "sample string 2",
"LastName": "sample string 3",
"FirstName": "sample string 4",
"MiddleName": "sample string 5",
"MRN": "sample string 6",
"BirthDateTime": "2025-12-12T20:51:47.3208189+00:00",
"Gender": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"DeceasedDateTime": "2025-12-12T20:51:47.3208313+00:00"
},
"MRNIdentities": [
{
"Value": "sample string 1",
"Type": {
"Id": "sample string 1",
"Name": "sample string 2",
"Description": "sample string 3"
},
"SubType": {
"Id": "sample string 1",
"Name": "sample string 2",
"Description": "sample string 3"
}
},
{
"Value": "sample string 1",
"Type": {
"Id": "sample string 1",
"Name": "sample string 2",
"Description": "sample string 3"
},
"SubType": {
"Id": "sample string 1",
"Name": "sample string 2",
"Description": "sample string 3"
}
}
],
"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"
}
],
"RelatedPersons": [
{
"Person": {
"PersonId": "sample string 1",
"PersonName": "sample string 2"
},
"RelationshipType": "sample string 1",
"FromDate": "2025-12-12T20:51:47.3222013+00:00",
"ToDate": "2025-12-12T20:51:47.3222479+00:00",
"ReltnTypeCD": "sample string 2",
"PersonReltnDisp": "sample string 3",
"PersonReltnCD": "sample string 4",
"RelatedPersonReltnTypeDisp": "sample string 5",
"RelatedPersonReltnTypeCD": "sample string 6",
"ActiveStatusCD": "sample string 7",
"ActiveStatusDisp": "sample string 8",
"DataStatusCD": "sample string 9",
"DataStatusDisp": "sample string 10",
"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-12T20:51:47.3236946+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-12T20:51:47.3236946+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
]
},
{
"Person": {
"PersonId": "sample string 1",
"PersonName": "sample string 2"
},
"RelationshipType": "sample string 1",
"FromDate": "2025-12-12T20:51:47.3222013+00:00",
"ToDate": "2025-12-12T20:51:47.3222479+00:00",
"ReltnTypeCD": "sample string 2",
"PersonReltnDisp": "sample string 3",
"PersonReltnCD": "sample string 4",
"RelatedPersonReltnTypeDisp": "sample string 5",
"RelatedPersonReltnTypeCD": "sample string 6",
"ActiveStatusCD": "sample string 7",
"ActiveStatusDisp": "sample string 8",
"DataStatusCD": "sample string 9",
"DataStatusDisp": "sample string 10",
"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-12T20:51:47.3236946+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-12T20:51:47.3236946+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
]
}
],
"ProviderRelationships": [
{
"ProviderRelationship": "sample string 1",
"ProviderId": "sample string 2",
"ProviderName": "sample string 3"
},
{
"ProviderRelationship": "sample string 1",
"ProviderId": "sample string 2",
"ProviderName": "sample string 3"
}
],
"CustomFields": [
{
"Field": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"CodedResponseValue": [
{
"Id": "sample string 1",
"Name": "sample string 2"
},
{
"Id": "sample string 1",
"Name": "sample string 2"
}
],
"TextResponseValue": [
"sample string 1",
"sample string 2"
]
},
{
"Field": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"CodedResponseValue": [
{
"Id": "sample string 1",
"Name": "sample string 2"
},
{
"Id": "sample string 1",
"Name": "sample string 2"
}
],
"TextResponseValue": [
"sample string 1",
"sample string 2"
]
}
],
"ExtendedInfo": {
"BirthGender": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"GenderIdentity": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Vip": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Deceased": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"PreviousLastName": "sample string 1",
"Email": "sample string 2",
"Language": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Ethnicity": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Ethnicities": [
{
"Id": "sample string 1",
"Name": "sample string 2"
},
{
"Id": "sample string 1",
"Name": "sample string 2"
}
],
"MaritalStatus": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"Race": [
{
"Id": "sample string 1",
"Name": "sample string 2"
},
{
"Id": "sample string 1",
"Name": "sample string 2"
}
],
"Religion": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"EducationLevel": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"NeedsInterpreter": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"StudentStatus": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"WrittenFormat": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"AlternativeNames": [
{
"NameType": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"LastName": "sample string 1",
"FirstName": "sample string 2",
"MiddleName": "sample string 3",
"Prefix": "sample string 4",
"Suffix": "sample string 5"
},
{
"NameType": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"LastName": "sample string 1",
"FirstName": "sample string 2",
"MiddleName": "sample string 3",
"Prefix": "sample string 4",
"Suffix": "sample string 5"
}
],
"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-12T20:51:47.3272308+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-12T20:51:47.3272308+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-12T20:51:47.3236946+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-12T20:51:47.3236946+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"PersonType": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"PatientPortal": {
"ChallengeQuestionId": "sample string 1",
"ChallengeAnswer": "sample string 2",
"HealthInfoAccessOfferedId": "sample string 3"
}
},
"Comments": [
{
"CommentText": "sample string 1",
"CommentUpdateDateTime": "2025-12-12T20:51:47.3285976+00:00",
"CommentUpdatePersonnel": "2025-12-12",
"InternalSequence": "sample string 2"
},
{
"CommentText": "sample string 1",
"CommentUpdateDateTime": "2025-12-12T20:51:47.3285976+00:00",
"CommentUpdatePersonnel": "2025-12-12",
"InternalSequence": "sample string 2"
}
]
}
]