GET api/v1/{EMRSystem}/PatientList

Returns a list of patients on a given Patient List.

Status: Released

URI Parameters

Name	Description	Type	Additional information
EMRSystem	The emr system.	EMRSystem	None.
UserId	Gets or sets the user identifier.	string	Required
ListId	Gets or sets the list identifier.	string	Required
ListType	Gets or sets the type of the list.	ListType	Required
IncludeExtended	Gets or sets a value indicating whether [include extended].	boolean	None.
IncludePCT	Gets or sets a value indicating whether [include PCT].	boolean	None.
IncludeIdentity	Gets or sets a value indicating whether [include identity].	boolean	None.
ProviderFilter	Gets or sets a value indicating whether [provider filter].	boolean	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 UdmPatientListResponse

Name	Description	Type	Additional information
PatientId	Gets or sets the patient identifier.	string	None.
EncounterId	Gets or sets the encounter identifier.	string	None.
EncounterAlias	Gets or sets the visit alias.	string	None.
DisplayName	Gets or sets the display name.	string	None.
LastName	Gets or sets the last name.	string	None.
FirstName	Gets or sets the first name.	string	None.
MiddleName	Gets or sets the name of the middle.	string	None.
Suffix	Gets or sets the suffix.	string	None.
Prefix	Gets or sets the prefix.	string	None.
BirthDateTime	Gets or sets the Date Of Birth.	datetime	Date only
Gender	Gets or sets the gender.	string	None.
MRN	Gets or sets the MRN.	string	None.
AdmitDateTime	Gets or sets the admit date time.	datetime	None.
DischargeDateTime	Gets or sets the discharge date time.	datetime	None.
DeceasedDateTime	Gets or sets the deceased date time.	datetime	Date only
Hospital	Gets or sets the hospital.	string	None.
Unit	Gets or sets the unit.	string	None.
Room	Gets or sets the room.	string	None.
Bed	Gets or sets the bed.	string	None.
EncounterType	Gets or sets the type of the encounter.	string	None.
ExtendedInfo	Gets or sets the extended information.	ExtendedInfo	None.
PatientCareTeams	Gets or sets the Patient Care Team object.	Collection of PatientCareTeam	None.
Vip	Gets or sets the vip.	string	None.
Confidentiality	Gets or sets the confidentiality.	string	None.
Identities	Gets or sets the identities.	Collection of Identity	None.
ReasonForVisit	Gets or sets the reason for visit.	string	None.
FinancialNumber	Gets or sets the financial number.	string	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

[
  {
    "PatientId": "sample string 1",
    "EncounterId": "sample string 2",
    "EncounterAlias": "sample string 3",
    "DisplayName": "sample string 4",
    "LastName": "sample string 5",
    "FirstName": "sample string 6",
    "MiddleName": "sample string 7",
    "Suffix": "sample string 8",
    "Prefix": "sample string 9",
    "BirthDateTime": "2025-12-12T21:05:25.7062143+00:00",
    "Gender": "sample string 10",
    "MRN": "sample string 11",
    "AdmitDateTime": "2025-12-12T21:05:25.7065735+00:00",
    "DischargeDateTime": "2025-12-12T21:05:25.7066875+00:00",
    "DeceasedDateTime": "2025-12-12T21:05:25.7067985+00:00",
    "Hospital": "sample string 12",
    "Unit": "sample string 13",
    "Room": "sample string 14",
    "Bed": "sample string 15",
    "EncounterType": "sample string 16",
    "ExtendedInfo": {
      "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:05:25.7072802+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:05:25.7072802+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:05:25.707301+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:05:25.707301+00:00",
          "Format": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        }
      ],
      "Ethnicity": "sample string 1",
      "Ethnicities": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "Language": "sample string 2",
      "Race": "sample string 3",
      "Races": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "Religion": "sample string 4",
      "MaritalStatus": "sample string 5",
      "Email": "sample string 6",
      "NeedsInterpreter": true,
      "PreferredPharmacies": [
        {
          "PharmacyId": "sample string 1",
          "PharmacyName": "sample string 2",
          "NCPDP": "sample string 3",
          "IsIntegratedRetail": true
        },
        {
          "PharmacyId": "sample string 1",
          "PharmacyName": "sample string 2",
          "NCPDP": "sample string 3",
          "IsIntegratedRetail": true
        }
      ],
      "GenderIdentity": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "BirthGender": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    },
    "PatientCareTeams": [
      {
        "NPI": "sample string 1",
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "RelationshipType": "sample string 2",
        "FromDate": "2025-12-12T21:05:25.7077194+00:00",
        "ToDate": "2025-12-12T21:05:25.7078884+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:05:25.707301+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:05:25.707301+00:00",
            "Format": {
              "Id": "sample string 1",
              "Name": "sample string 2"
            }
          }
        ],
        "IsManuallyAdded": true,
        "InternalSequence": "sample string 4"
      },
      {
        "NPI": "sample string 1",
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "RelationshipType": "sample string 2",
        "FromDate": "2025-12-12T21:05:25.7077194+00:00",
        "ToDate": "2025-12-12T21:05:25.7078884+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:05:25.707301+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:05:25.707301+00:00",
            "Format": {
              "Id": "sample string 1",
              "Name": "sample string 2"
            }
          }
        ],
        "IsManuallyAdded": true,
        "InternalSequence": "sample string 4"
      }
    ],
    "Vip": "sample string 17",
    "Confidentiality": "sample string 18",
    "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"
      }
    ],
    "ReasonForVisit": "sample string 19",
    "FinancialNumber": "sample string 20"
  },
  {
    "PatientId": "sample string 1",
    "EncounterId": "sample string 2",
    "EncounterAlias": "sample string 3",
    "DisplayName": "sample string 4",
    "LastName": "sample string 5",
    "FirstName": "sample string 6",
    "MiddleName": "sample string 7",
    "Suffix": "sample string 8",
    "Prefix": "sample string 9",
    "BirthDateTime": "2025-12-12T21:05:25.7062143+00:00",
    "Gender": "sample string 10",
    "MRN": "sample string 11",
    "AdmitDateTime": "2025-12-12T21:05:25.7065735+00:00",
    "DischargeDateTime": "2025-12-12T21:05:25.7066875+00:00",
    "DeceasedDateTime": "2025-12-12T21:05:25.7067985+00:00",
    "Hospital": "sample string 12",
    "Unit": "sample string 13",
    "Room": "sample string 14",
    "Bed": "sample string 15",
    "EncounterType": "sample string 16",
    "ExtendedInfo": {
      "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:05:25.7072802+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:05:25.7072802+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:05:25.707301+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:05:25.707301+00:00",
          "Format": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        }
      ],
      "Ethnicity": "sample string 1",
      "Ethnicities": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "Language": "sample string 2",
      "Race": "sample string 3",
      "Races": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "Religion": "sample string 4",
      "MaritalStatus": "sample string 5",
      "Email": "sample string 6",
      "NeedsInterpreter": true,
      "PreferredPharmacies": [
        {
          "PharmacyId": "sample string 1",
          "PharmacyName": "sample string 2",
          "NCPDP": "sample string 3",
          "IsIntegratedRetail": true
        },
        {
          "PharmacyId": "sample string 1",
          "PharmacyName": "sample string 2",
          "NCPDP": "sample string 3",
          "IsIntegratedRetail": true
        }
      ],
      "GenderIdentity": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "BirthGender": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    },
    "PatientCareTeams": [
      {
        "NPI": "sample string 1",
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "RelationshipType": "sample string 2",
        "FromDate": "2025-12-12T21:05:25.7077194+00:00",
        "ToDate": "2025-12-12T21:05:25.7078884+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:05:25.707301+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:05:25.707301+00:00",
            "Format": {
              "Id": "sample string 1",
              "Name": "sample string 2"
            }
          }
        ],
        "IsManuallyAdded": true,
        "InternalSequence": "sample string 4"
      },
      {
        "NPI": "sample string 1",
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "RelationshipType": "sample string 2",
        "FromDate": "2025-12-12T21:05:25.7077194+00:00",
        "ToDate": "2025-12-12T21:05:25.7078884+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:05:25.707301+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:05:25.707301+00:00",
            "Format": {
              "Id": "sample string 1",
              "Name": "sample string 2"
            }
          }
        ],
        "IsManuallyAdded": true,
        "InternalSequence": "sample string 4"
      }
    ],
    "Vip": "sample string 17",
    "Confidentiality": "sample string 18",
    "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"
      }
    ],
    "ReasonForVisit": "sample string 19",
    "FinancialNumber": "sample string 20"
  }
]

GET api/v1/{EMRSystem}/PatientList

Returns a list of patients on a given Patient List.

Status: Released

URI Parameters

EMRSystem

Required

UserId

Required

ListId

Required

ListType

Required

IncludeExtended

IncludePCT

IncludeIdentity

ProviderFilter

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}}
```