GET api/v1/{EMRSystem}/PortalAccounts
Returns a list of patient Portal Accounts that match the given search criteria.
Status: Released
One of the following parameters must have a value specified: PortalUserId, PatientId, EmailAddress
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
| PortalUserId |
Gets or sets the user identifier. |
string |
None. |
| PatientId |
Gets or sets the patient identifier. |
string |
None. |
| EmailAddress |
Gets or sets the email address. |
string |
None. |
| FirstName |
Gets or sets the first name. |
string |
None. |
| LastName |
Gets or sets the last name. |
string |
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 PortalAccount| Name | Description | Type | Additional information |
|---|---|---|---|
| Active |
Gets or sets a value indicating whether this PortalAccount is active. |
boolean |
None. |
| Addresses |
Gets or sets the addresses. |
Collection of Address |
None. |
| BirthDateTime |
Gets or sets the date of birth. |
datetime |
Date only |
| EmailAddress |
Gets or sets the email address. |
string |
None. |
| FirstName |
Gets or sets the first name. |
string |
None. |
| Gender |
Gets or sets the gender. |
CodedObject |
None. |
| Phones |
Gets or sets the phones. |
Collection of Phone |
None. |
| LastName |
Gets or sets the last name. |
string |
None. |
| MiddleName |
Gets or sets the name of the middle. |
string |
None. |
| PasswordHint |
Gets or sets the password hint. |
string |
None. |
| PasswordResetQuestion |
Gets or sets the password reset question. |
string |
None. |
| PatientId |
Gets or sets the patient identifier. |
string |
None. |
| PortalAccountId |
Gets or sets the portal account identifier. |
string |
None. |
| PortalAccountName |
Gets or sets the name of the portal account. |
string |
None. |
| PortalUserId |
Gets or sets the portal user identifier. |
string |
None. |
| ReceiveEmailNotifications |
Gets or sets a value indicating whether [receive email notifications]. |
boolean |
None. |
| SSN |
Gets or sets the SSN. |
string |
None. |
| ProxyAccounts |
List of portal accounts that have proxy access to this account |
Collection of PortalAccountProxy |
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
[
{
"Active": true,
"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:47.5129829+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:47.5129829+00:00"
}
],
"BirthDateTime": "2025-12-12T21:08:47.5174351+00:00",
"EmailAddress": "sample string 1",
"FirstName": "sample string 2",
"Gender": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"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:47.5179033+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:47.5179033+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"LastName": "sample string 3",
"MiddleName": "sample string 4",
"PasswordHint": "sample string 5",
"PasswordResetQuestion": "sample string 6",
"PatientId": "sample string 7",
"PortalAccountId": "sample string 8",
"PortalAccountName": "sample string 9",
"PortalUserId": "sample string 10",
"ReceiveEmailNotifications": true,
"SSN": "sample string 11",
"ProxyAccounts": [
{
"ProxyPortalAccountId": "sample string 1",
"Relation": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"ValidFromDate": "2025-12-12T21:08:47.5285031+00:00",
"ValidToDate": "2025-12-12T21:08:47.5286137+00:00",
"SecurityClass": {
"SecurityClassId": "sample string 1",
"SecurityClassName": "sample string 2"
},
"Status": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"ProxyPortalAccountId": "sample string 1",
"Relation": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"ValidFromDate": "2025-12-12T21:08:47.5285031+00:00",
"ValidToDate": "2025-12-12T21:08:47.5286137+00:00",
"SecurityClass": {
"SecurityClassId": "sample string 1",
"SecurityClassName": "sample string 2"
},
"Status": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
]
},
{
"Active": true,
"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:47.5129829+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:47.5129829+00:00"
}
],
"BirthDateTime": "2025-12-12T21:08:47.5174351+00:00",
"EmailAddress": "sample string 1",
"FirstName": "sample string 2",
"Gender": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"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:47.5179033+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:47.5179033+00:00",
"Format": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
],
"LastName": "sample string 3",
"MiddleName": "sample string 4",
"PasswordHint": "sample string 5",
"PasswordResetQuestion": "sample string 6",
"PatientId": "sample string 7",
"PortalAccountId": "sample string 8",
"PortalAccountName": "sample string 9",
"PortalUserId": "sample string 10",
"ReceiveEmailNotifications": true,
"SSN": "sample string 11",
"ProxyAccounts": [
{
"ProxyPortalAccountId": "sample string 1",
"Relation": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"ValidFromDate": "2025-12-12T21:08:47.5285031+00:00",
"ValidToDate": "2025-12-12T21:08:47.5286137+00:00",
"SecurityClass": {
"SecurityClassId": "sample string 1",
"SecurityClassName": "sample string 2"
},
"Status": {
"Id": "sample string 1",
"Name": "sample string 2"
}
},
{
"ProxyPortalAccountId": "sample string 1",
"Relation": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"ValidFromDate": "2025-12-12T21:08:47.5285031+00:00",
"ValidToDate": "2025-12-12T21:08:47.5286137+00:00",
"SecurityClass": {
"SecurityClassId": "sample string 1",
"SecurityClassName": "sample string 2"
},
"Status": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
]
}
]