GET Portal Accounts by Id

GET api/v1/{EMRSystem}/PortalAccounts/{PortalAccountId}

Verifies a login ID/password for a patient portal account and returns details of the account.

HTTP Method

GET

Applicable Emissary Products

Interactive

Allscripts

In Dev

Athena

In Dev

Cerner

In Dev

Epic

Released

Meditech

In Dev

Sandbox

In Dev

Don't see the data field you are looking for?

Request Information

URI Parameters

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

EMRSystem

The emr system.

EMRsystem

Required

PortalAccountId

The portal account identifier.

string

Required

UserId

Gets or sets the user identifier.

string

Required

UserType

Gets or sets the type of the user.

UserType

None

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing PortalAccount Response View Model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

Active

Gets or sets a value indicating whether this is active.

boolean

None.

Addresses

Gets or sets the addresses.

Collection of AddressViewModel

None.

BirthDateTime

Gets or sets the date of birth.

string

None.

EmailAddress

Gets or sets the email address.

string

None.

FirstName

Gets or sets the first name.

string

None.

Gender

Gets or sets the gender.

CodedObjectViewModel

None.

Phones

Gets or sets the phones.

Collection of PhoneViewModel

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 PortalAccountProxyViewModel

None.

 
Response Codes

Http Status Code 200 – Returns Sansoro.Shared.SansoroServiceBus.Models.PortalAccountResponseViewModel

Http Status Code 400 – Indicates that the request did not contain all the required fields.

Http Status Code 404 – Indicates that the resource to get could not be found.

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
Sample Message
Download Json Schema
{
  "Active": true,
  "Addresses": [
    {
      "AddressId": "sample string 1",
      "Address1": "sample string 2",
      "Address2": "sample string 3",
      "City": "sample string 4",
      "State": "sample string 5",
      "ZIP": "sample string 6",
      "Type": "sample string 7",
      "Country": "sample string 8"
    },
    {
      "AddressId": "sample string 1",
      "Address1": "sample string 2",
      "Address2": "sample string 3",
      "City": "sample string 4",
      "State": "sample string 5",
      "ZIP": "sample string 6",
      "Type": "sample string 7",
      "Country": "sample string 8"
    }
  ],
  "BirthDateTime": "sample string 1",
  "EmailAddress": "sample string 2",
  "FirstName": "sample string 3",
  "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"
    },
    {
      "PhoneId": "sample string 1",
      "Number": "sample string 2",
      "SequenceNumber": "sample string 3",
      "Type": "sample string 4"
    }
  ],
  "LastName": "sample string 4",
  "MiddleName": "sample string 5",
  "PasswordHint": "sample string 6",
  "PasswordResetQuestion": "sample string 7",
  "PatientId": "sample string 8",
  "PortalAccountId": "sample string 9",
  "PortalAccountName": "sample string 10",
  "PortalUserId": "sample string 11",
  "ReceiveEmailNotifications": true,
  "SSN": "sample string 12",
  "ProxyAccounts": [
    {
      "ProxyPortalAccountId": "sample string 1",
      "Relation": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "ValidFromDate": "2018-02-15T15:17:30.5920892Z",
      "ValidToDate": "2018-02-15T15:17:30.5920892Z",
      "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": "2018-02-15T15:17:30.5920892Z",
      "ValidToDate": "2018-02-15T15:17:30.5920892Z",
      "SecurityClass": {
        "SecurityClassId": "sample string 1",
        "SecurityClassName": "sample string 2"
      },
      "Status": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    }
  ]
}
Sample Message
<PortalAccountViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
  <Active>true</Active>
  <Addresses>
    <AddressViewModel>
      <Address1>sample string 2</Address1>
      <Address2>sample string 3</Address2>
      <AddressId>sample string 1</AddressId>
      <City>sample string 4</City>
      <Country>sample string 8</Country>
      <State>sample string 5</State>
      <Type>sample string 7</Type>
      <ZIP>sample string 6</ZIP>
    </AddressViewModel>
    <AddressViewModel>
      <Address1>sample string 2</Address1>
      <Address2>sample string 3</Address2>
      <AddressId>sample string 1</AddressId>
      <City>sample string 4</City>
      <Country>sample string 8</Country>
      <State>sample string 5</State>
      <Type>sample string 7</Type>
      <ZIP>sample string 6</ZIP>
    </AddressViewModel>
  </Addresses>
  <BirthDateTime>sample string 1</BirthDateTime>
  <EmailAddress>sample string 2</EmailAddress>
  <FirstName>sample string 3</FirstName>
  <Gender>
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
  </Gender>
  <LastName>sample string 4</LastName>
  <MiddleName>sample string 5</MiddleName>
  <PasswordHint>sample string 6</PasswordHint>
  <PasswordResetQuestion>sample string 7</PasswordResetQuestion>
  <PatientId>sample string 8</PatientId>
  <Phones>
    <PhoneViewModel>
      <Number>sample string 2</Number>
      <PhoneId>sample string 1</PhoneId>
      <SequenceNumber>sample string 3</SequenceNumber>
      <Type>sample string 4</Type>
    </PhoneViewModel>
    <PhoneViewModel>
      <Number>sample string 2</Number>
      <PhoneId>sample string 1</PhoneId>
      <SequenceNumber>sample string 3</SequenceNumber>
      <Type>sample string 4</Type>
    </PhoneViewModel>
  </Phones>
  <PortalAccountId>sample string 9</PortalAccountId>
  <PortalAccountName>sample string 10</PortalAccountName>
  <PortalUserId>sample string 11</PortalUserId>
  <ProxyAccounts>
    <PortalAccountProxyViewModel>
      <ProxyPortalAccountId>sample string 1</ProxyPortalAccountId>
      <Relation>
        <Id>sample string 1</Id>
        <Name>sample string 2</Name>
      </Relation>
      <SecurityClass>
        <SecurityClassId>sample string 1</SecurityClassId>
        <SecurityClassName>sample string 2</SecurityClassName>
      </SecurityClass>
      <Status>
        <Id>sample string 1</Id>
        <Name>sample string 2</Name>
      </Status>
      <ValidFromDate>2018-02-15T09:17:30.5920892-06:00</ValidFromDate>
      <ValidToDate>2018-02-15T09:17:30.5920892-06:00</ValidToDate>
    </PortalAccountProxyViewModel>
    <PortalAccountProxyViewModel>
      <ProxyPortalAccountId>sample string 1</ProxyPortalAccountId>
      <Relation>
        <Id>sample string 1</Id>
        <Name>sample string 2</Name>
      </Relation>
      <SecurityClass>
        <SecurityClassId>sample string 1</SecurityClassId>
        <SecurityClassName>sample string 2</SecurityClassName>
      </SecurityClass>
      <Status>
        <Id>sample string 1</Id>
        <Name>sample string 2</Name>
      </Status>
      <ValidFromDate>2018-02-15T09:17:30.5920892-06:00</ValidFromDate>
      <ValidToDate>2018-02-15T09:17:30.5920892-06:00</ValidToDate>
    </PortalAccountProxyViewModel>
  </ProxyAccounts>
  <ReceiveEmailNotifications>true</ReceiveEmailNotifications>
  <SSN>sample string 12</SSN>
</PortalAccountViewModel>

Submit a Comment

Your email address will not be published. Required fields are marked *

 

Don't see the data field you are looking for?