GET api/v1/{EMRSystem}/Patients
Returns the Patients that match a given set of search parameters (e.g. MRN, account number, last name, first name, gender, DOB, etc.). FHIR connectors use the following resources for R4: Patient.Search.
Status: Released
One of the following parameters must have a value specified: FirstName, LastName, MRN, DOB, FinancialNumber
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
| UserId |
Gets or sets the user identifier. |
string |
Required |
| FirstName |
Gets or sets the first name. |
string |
None. |
| LastName |
Gets or sets the last name. |
string |
None. |
| MRN |
Gets or sets the MRN. |
string |
None. |
| DOB |
Gets or sets the dob. |
datetime |
Date only |
| GenderId |
Gets or sets the GenderId. |
string |
None. |
| FinancialNumber |
Gets or sets the financial number. |
string |
None. |
| ProviderFilter |
Gets or sets a value indicating whether [provider filter]. |
boolean |
None. |
| IncludeExtended |
Gets or sets a value indicating whether [include extended]. |
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 Patient| Name | Description | Type | Additional information |
|---|---|---|---|
| PatientId |
Gets or sets the patient identifier. |
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. |
CodedObject |
None. |
| MRN |
Gets or sets the MRN. |
string |
None. |
| Vip |
Gets or sets the vip. |
string |
None. |
| Confidentiality |
Gets or sets the confidentiality. |
string |
None. |
| DeceasedDateTime |
Gets or sets the deceased date time. |
datetime |
Date only |
| SSN |
Gets or sets the social security number. |
string |
None. |
| ExtendedInfo |
Gets or sets the extended object. |
ExtendedInfo |
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
[
{
"PatientId": "sample string 1",
"DisplayName": "sample string 2",
"LastName": "sample string 3",
"FirstName": "sample string 4",
"MiddleName": "sample string 5",
"Suffix": "sample string 6",
"Prefix": "sample string 7",
"BirthDateTime": "2025-12-12T20:51:35.4012982+00:00",
"Gender": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"MRN": "sample string 8",
"Vip": "sample string 9",
"Confidentiality": "sample string 10",
"DeceasedDateTime": "2025-12-12T20:51:35.4013176+00:00",
"SSN": "sample string 11",
"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-12T20:51:35.4015213+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:35.4015213+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:35.4017496+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:35.4017496+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"
}
}
},
{
"PatientId": "sample string 1",
"DisplayName": "sample string 2",
"LastName": "sample string 3",
"FirstName": "sample string 4",
"MiddleName": "sample string 5",
"Suffix": "sample string 6",
"Prefix": "sample string 7",
"BirthDateTime": "2025-12-12T20:51:35.4012982+00:00",
"Gender": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"MRN": "sample string 8",
"Vip": "sample string 9",
"Confidentiality": "sample string 10",
"DeceasedDateTime": "2025-12-12T20:51:35.4013176+00:00",
"SSN": "sample string 11",
"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-12T20:51:35.4015213+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:35.4015213+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:35.4017496+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:35.4017496+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"
}
}
}
]