GET api/v1/external/patients?IncludeInactive={IncludeInactive}&ExternalId={ExternalId}&FirstName={FirstName}&LastName={LastName}&BirthDate={BirthDate}&Gender={Gender}&MedicalRecordNumber={MedicalRecordNumber}&SocialSecurityNumber={SocialSecurityNumber}&SocialSecuritySerialNumber={SocialSecuritySerialNumber}&City={City}&State={State}&Zip={Zip}

Get a list of patients

Request Information

Parameters

Name Description Additional information
patientSearch
Filter object for the patient list
Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

[
  {
    "Id": "57fc6b10-0180-4e59-b362-1f1b09391259",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "ExternalId": "sample string 4",
    "MedicalRecordNumber": "sample string 5",
    "BirthDate": "sample string 6",
    "DeathDate": "sample string 7",
    "Gender": "sample string 8",
    "SSN": "sample string 9",
    "Phone1Type": "sample string 10",
    "Phone1Number": "sample string 11",
    "PhotoId": "abda1e83-323b-4f56-9475-15805aa1ad2a",
    "IsMale": true,
    "IsFemale": true,
    "Inactive": true,
    "Condition": {
      "Name": "sample string 1",
      "Color": "sample string 2",
      "Id": "f8dd10c8-c919-42df-89ef-11bf42178859"
    },
    "SuperbillId": "65d73539-23ee-4fbb-888b-39095f520bb4",
    "ProviderId": "44c631f8-6605-4ed9-ad57-f15ac45a5285"
  },
  {
    "Id": "57fc6b10-0180-4e59-b362-1f1b09391259",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "ExternalId": "sample string 4",
    "MedicalRecordNumber": "sample string 5",
    "BirthDate": "sample string 6",
    "DeathDate": "sample string 7",
    "Gender": "sample string 8",
    "SSN": "sample string 9",
    "Phone1Type": "sample string 10",
    "Phone1Number": "sample string 11",
    "PhotoId": "abda1e83-323b-4f56-9475-15805aa1ad2a",
    "IsMale": true,
    "IsFemale": true,
    "Inactive": true,
    "Condition": {
      "Name": "sample string 1",
      "Color": "sample string 2",
      "Id": "f8dd10c8-c919-42df-89ef-11bf42178859"
    },
    "SuperbillId": "65d73539-23ee-4fbb-888b-39095f520bb4",
    "ProviderId": "44c631f8-6605-4ed9-ad57-f15ac45a5285"
  }
]

application/xml, text/xml

Sample:

<ArrayOfPatientDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AppService.Core.Models.Patients">
  <PatientDto>
    <BirthDate>sample string 6</BirthDate>
    <Condition xmlns:d3p1="http://schemas.datacontract.org/2004/07/AppService.Core.Models.Common">
      <d3p1:Color>sample string 2</d3p1:Color>
      <d3p1:Id>f8dd10c8-c919-42df-89ef-11bf42178859</d3p1:Id>
      <d3p1:Name>sample string 1</d3p1:Name>
    </Condition>
    <DeathDate>sample string 7</DeathDate>
    <ExternalId>sample string 4</ExternalId>
    <FirstName>sample string 2</FirstName>
    <Gender>sample string 8</Gender>
    <Id>57fc6b10-0180-4e59-b362-1f1b09391259</Id>
    <Inactive>true</Inactive>
    <IsFemale>true</IsFemale>
    <IsMale>true</IsMale>
    <LastName>sample string 3</LastName>
    <MedicalRecordNumber>sample string 5</MedicalRecordNumber>
    <Phone1Number>sample string 11</Phone1Number>
    <Phone1Type>sample string 10</Phone1Type>
    <PhotoId>abda1e83-323b-4f56-9475-15805aa1ad2a</PhotoId>
    <ProviderId>44c631f8-6605-4ed9-ad57-f15ac45a5285</ProviderId>
    <SSN>sample string 9</SSN>
    <SuperbillId>65d73539-23ee-4fbb-888b-39095f520bb4</SuperbillId>
  </PatientDto>
  <PatientDto>
    <BirthDate>sample string 6</BirthDate>
    <Condition xmlns:d3p1="http://schemas.datacontract.org/2004/07/AppService.Core.Models.Common">
      <d3p1:Color>sample string 2</d3p1:Color>
      <d3p1:Id>f8dd10c8-c919-42df-89ef-11bf42178859</d3p1:Id>
      <d3p1:Name>sample string 1</d3p1:Name>
    </Condition>
    <DeathDate>sample string 7</DeathDate>
    <ExternalId>sample string 4</ExternalId>
    <FirstName>sample string 2</FirstName>
    <Gender>sample string 8</Gender>
    <Id>57fc6b10-0180-4e59-b362-1f1b09391259</Id>
    <Inactive>true</Inactive>
    <IsFemale>true</IsFemale>
    <IsMale>true</IsMale>
    <LastName>sample string 3</LastName>
    <MedicalRecordNumber>sample string 5</MedicalRecordNumber>
    <Phone1Number>sample string 11</Phone1Number>
    <Phone1Type>sample string 10</Phone1Type>
    <PhotoId>abda1e83-323b-4f56-9475-15805aa1ad2a</PhotoId>
    <ProviderId>44c631f8-6605-4ed9-ad57-f15ac45a5285</ProviderId>
    <SSN>sample string 9</SSN>
    <SuperbillId>65d73539-23ee-4fbb-888b-39095f520bb4</SuperbillId>
  </PatientDto>
</ArrayOfPatientDto>