GET Patients

Developer Tools

GET api/v1/{EMRSystem}/Patients

Returns Patient demographic information given a set of search parameters (e.g. MRN, account number, last name, first name, gender, DOB, etc.).

HTTP Method

GET

Applicable Emissary Products

Chart Retrieval
Clinical Analytics
Interactive Workflow

Allscripts

Released

Athena

Released

Cerner

Released

Meditech

Released

Sandbox

Released

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

Request Information

URI Parameters
One of the following parameters must have a value specified: FirstName, LastName, MRN, DOB, FinancialNumber

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

EMRSystem

The emr system.

EMRsystem

Required

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.

date

None

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

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing a collection of patients.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

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.

string

None.

Gender

Gets or sets the gender.

CodedObjectViewModel

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.

string

None.

SSN

Gets or sets the social security number.

string

None.

ExtendedInfo

Gets or sets the extended object.

ExtendedInfoViewModel

None.

 
Response Codes

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

Http Status Code 204 – Indicates that there were Zero records found.

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
[
  {
    "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": "sample string 8",
    "Gender": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "MRN": "sample string 9",
    "Vip": "sample string 10",
    "Confidentiality": "sample string 11",
    "DeceasedDateTime": "sample string 12",
    "SSN": "sample string 13",
    "ExtendedInfo": {
      "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"
        }
      ],
      "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"
        }
      ],
      "Ethnicity": "sample string 1",
      "Language": "sample string 2",
      "Race": "sample string 3",
      "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
        }
      ]
    }
  },
  {
    "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": "sample string 8",
    "Gender": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "MRN": "sample string 9",
    "Vip": "sample string 10",
    "Confidentiality": "sample string 11",
    "DeceasedDateTime": "sample string 12",
    "SSN": "sample string 13",
    "ExtendedInfo": {
      "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"
        }
      ],
      "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"
        }
      ],
      "Ethnicity": "sample string 1",
      "Language": "sample string 2",
      "Race": "sample string 3",
      "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
        }
      ]
    }
  }
]
Sample Message
<ArrayOfPatientViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
  <PatientViewModel>
    <BirthDateTime>sample string 8</BirthDateTime>
    <Confidentiality>sample string 11</Confidentiality>
    <DeceasedDateTime>sample string 12</DeceasedDateTime>
    <DisplayName>sample string 2</DisplayName>
    <ExtendedInfo>
      <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>
      <Email>sample string 6</Email>
      <Ethnicity>sample string 1</Ethnicity>
      <Language>sample string 2</Language>
      <MaritalStatus>sample string 5</MaritalStatus>
      <NeedsInterpreter>true</NeedsInterpreter>
      <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>
      <PreferredPharmacies>
        <PharmacyViewModel>
          <IsIntegratedRetail>true</IsIntegratedRetail>
          <NCPDP>sample string 3</NCPDP>
          <PharmacyId>sample string 1</PharmacyId>
          <PharmacyName>sample string 2</PharmacyName>
        </PharmacyViewModel>
        <PharmacyViewModel>
          <IsIntegratedRetail>true</IsIntegratedRetail>
          <NCPDP>sample string 3</NCPDP>
          <PharmacyId>sample string 1</PharmacyId>
          <PharmacyName>sample string 2</PharmacyName>
        </PharmacyViewModel>
      </PreferredPharmacies>
      <Race>sample string 3</Race>
      <Religion>sample string 4</Religion>
    </ExtendedInfo>
    <FirstName>sample string 4</FirstName>
    <Gender>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </Gender>
    <LastName>sample string 3</LastName>
    <MRN>sample string 9</MRN>
    <MiddleName>sample string 5</MiddleName>
    <PatientId>sample string 1</PatientId>
    <Prefix>sample string 7</Prefix>
    <SSN>sample string 13</SSN>
    <Suffix>sample string 6</Suffix>
    <Vip>sample string 10</Vip>
  </PatientViewModel>
  <PatientViewModel>
    <BirthDateTime>sample string 8</BirthDateTime>
    <Confidentiality>sample string 11</Confidentiality>
    <DeceasedDateTime>sample string 12</DeceasedDateTime>
    <DisplayName>sample string 2</DisplayName>
    <ExtendedInfo>
      <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>
      <Email>sample string 6</Email>
      <Ethnicity>sample string 1</Ethnicity>
      <Language>sample string 2</Language>
      <MaritalStatus>sample string 5</MaritalStatus>
      <NeedsInterpreter>true</NeedsInterpreter>
      <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>
      <PreferredPharmacies>
        <PharmacyViewModel>
          <IsIntegratedRetail>true</IsIntegratedRetail>
          <NCPDP>sample string 3</NCPDP>
          <PharmacyId>sample string 1</PharmacyId>
          <PharmacyName>sample string 2</PharmacyName>
        </PharmacyViewModel>
        <PharmacyViewModel>
          <IsIntegratedRetail>true</IsIntegratedRetail>
          <NCPDP>sample string 3</NCPDP>
          <PharmacyId>sample string 1</PharmacyId>
          <PharmacyName>sample string 2</PharmacyName>
        </PharmacyViewModel>
      </PreferredPharmacies>
      <Race>sample string 3</Race>
      <Religion>sample string 4</Religion>
    </ExtendedInfo>
    <FirstName>sample string 4</FirstName>
    <Gender>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </Gender>
    <LastName>sample string 3</LastName>
    <MRN>sample string 9</MRN>
    <MiddleName>sample string 5</MiddleName>
    <PatientId>sample string 1</PatientId>
    <Prefix>sample string 7</Prefix>
    <SSN>sample string 13</SSN>
    <Suffix>sample string 6</Suffix>
    <Vip>sample string 10</Vip>
  </PatientViewModel>
</ArrayOfPatientViewModel>

Submit a Comment

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

 

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