POST api/Patient/PatientLookup
Request Information
URI Parameters
None.
Body Parameters
Collection of ObjectNone.
Request Formats
application/json, text/json, application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
PatientChartLookUp| Name | Description | Type | Additional information |
|---|---|---|---|
| PatientInfo | Collection of Patient_Info |
None. |
|
| SubscriberInfo | Collection of Insurance_Info |
None. |
|
| DocumentsInfo | Collection of patient_orders_attachments |
None. |
Response Formats
application/json, text/json
Sample:
{
"PatientInfo": [
{
"PatientID": 1,
"VOPatientId": 2,
"OrganizationID": 3,
"OFAccountID": 4,
"OFUserID": 5,
"firstname": "sample string 6",
"lastname": "sample string 7",
"middlename": "sample string 8",
"Suffix": "sample string 9",
"dob": "2025-12-06T01:16:51.8592357-05:00",
"gender": "sample string 11",
"EMR": "sample string 12",
"PMSPWS": "sample string 13",
"SSN": "sample string 14",
"Ethnicity": "sample string 15",
"SexualOrientation": "sample string 16",
"Race": "sample string 17",
"Status": "sample string 18",
"rfirstname": "sample string 19",
"rlastname": "sample string 20",
"rmiddlename": "sample string 21",
"rSuffix": "sample string 22",
"relationship": "sample string 23",
"PreferredContact": "sample string 24",
"Photograph": "sample string 25",
"DisplayName": "sample string 26",
"ReportDisplayName": "sample string 27",
"ModeOfCommunication": "sample string 28",
"PreferredPhone": "sample string 29",
"PreferredEmail": "sample string 30",
"address1": "sample string 31",
"city": "sample string 32",
"state": "sample string 33",
"zip": "sample string 34",
"EmailId": "sample string 35",
"homephone": "sample string 36",
"HomeMobilePhone": "sample string 37",
"HomePhoneExt": "sample string 38",
"WorkAddress": "sample string 39",
"WorkCity": "sample string 40",
"WorkState": "sample string 41",
"WorkZipCode": "sample string 42",
"WorkEmail": "sample string 43",
"WorkMobilePhone": "sample string 44",
"workphone": "sample string 45",
"WorkPhoneExt": "sample string 46",
"raddress1": "sample string 47",
"rcity": "sample string 48",
"rstate": "sample string 49",
"rzip": "sample string 50",
"rEmail": "sample string 51",
"rMobilePhone": "sample string 52",
"rhomephone": "sample string 53",
"rworkphone": "sample string 54",
"rPhoneExt": "sample string 55",
"rgender": "sample string 56",
"rdob": "sample string 57",
"rSSN": "sample string 58"
},
{
"PatientID": 1,
"VOPatientId": 2,
"OrganizationID": 3,
"OFAccountID": 4,
"OFUserID": 5,
"firstname": "sample string 6",
"lastname": "sample string 7",
"middlename": "sample string 8",
"Suffix": "sample string 9",
"dob": "2025-12-06T01:16:51.8592357-05:00",
"gender": "sample string 11",
"EMR": "sample string 12",
"PMSPWS": "sample string 13",
"SSN": "sample string 14",
"Ethnicity": "sample string 15",
"SexualOrientation": "sample string 16",
"Race": "sample string 17",
"Status": "sample string 18",
"rfirstname": "sample string 19",
"rlastname": "sample string 20",
"rmiddlename": "sample string 21",
"rSuffix": "sample string 22",
"relationship": "sample string 23",
"PreferredContact": "sample string 24",
"Photograph": "sample string 25",
"DisplayName": "sample string 26",
"ReportDisplayName": "sample string 27",
"ModeOfCommunication": "sample string 28",
"PreferredPhone": "sample string 29",
"PreferredEmail": "sample string 30",
"address1": "sample string 31",
"city": "sample string 32",
"state": "sample string 33",
"zip": "sample string 34",
"EmailId": "sample string 35",
"homephone": "sample string 36",
"HomeMobilePhone": "sample string 37",
"HomePhoneExt": "sample string 38",
"WorkAddress": "sample string 39",
"WorkCity": "sample string 40",
"WorkState": "sample string 41",
"WorkZipCode": "sample string 42",
"WorkEmail": "sample string 43",
"WorkMobilePhone": "sample string 44",
"workphone": "sample string 45",
"WorkPhoneExt": "sample string 46",
"raddress1": "sample string 47",
"rcity": "sample string 48",
"rstate": "sample string 49",
"rzip": "sample string 50",
"rEmail": "sample string 51",
"rMobilePhone": "sample string 52",
"rhomephone": "sample string 53",
"rworkphone": "sample string 54",
"rPhoneExt": "sample string 55",
"rgender": "sample string 56",
"rdob": "sample string 57",
"rSSN": "sample string 58"
}
],
"SubscriberInfo": [
{
"PatientID": 1,
"SubscriberID": 2,
"VOSubscriberID": 3,
"VOPatientID": 4,
"type": "sample string 5",
"effectivedate": "sample string 6",
"ExpirationDate": "sample string 7",
"Patientpolicynumber": "sample string 8",
"PolicyNumber": "sample string 9",
"grouporplannumber": "sample string 10",
"grouporplanname": "sample string 11",
"gender": "sample string 12",
"dob": "2025-12-06T01:16:51.8592357-05:00",
"payor": "sample string 14",
"payorid": 15,
"lastname": "sample string 16",
"firstname": "sample string 17",
"middlename": "sample string 18",
"Suffix": "sample string 19",
"IsOrganization": 20,
"EligibilityStatus": "sample string 21",
"relationcode": "sample string 22",
"zip": "sample string 23",
"address1": "sample string 24",
"address2": "sample string 25",
"city": "sample string 26",
"state": "sample string 27",
"PlanType": "sample string 28",
"InsuredDisplayName": "sample string 29",
"RelationshipToInsuredID": "sample string 30",
"insurancetypecode": "sample string 31",
"PhoneNumber": "sample string 32"
},
{
"PatientID": 1,
"SubscriberID": 2,
"VOSubscriberID": 3,
"VOPatientID": 4,
"type": "sample string 5",
"effectivedate": "sample string 6",
"ExpirationDate": "sample string 7",
"Patientpolicynumber": "sample string 8",
"PolicyNumber": "sample string 9",
"grouporplannumber": "sample string 10",
"grouporplanname": "sample string 11",
"gender": "sample string 12",
"dob": "2025-12-06T01:16:51.8592357-05:00",
"payor": "sample string 14",
"payorid": 15,
"lastname": "sample string 16",
"firstname": "sample string 17",
"middlename": "sample string 18",
"Suffix": "sample string 19",
"IsOrganization": 20,
"EligibilityStatus": "sample string 21",
"relationcode": "sample string 22",
"zip": "sample string 23",
"address1": "sample string 24",
"address2": "sample string 25",
"city": "sample string 26",
"state": "sample string 27",
"PlanType": "sample string 28",
"InsuredDisplayName": "sample string 29",
"RelationshipToInsuredID": "sample string 30",
"insurancetypecode": "sample string 31",
"PhoneNumber": "sample string 32"
}
],
"DocumentsInfo": [
{
"ID": 1,
"DocumentID": 2,
"DocumentName": "sample string 3",
"DocumentType": "sample string 4",
"FileName": "sample string 5",
"DocumentStatus": "sample string 6",
"Description": "sample string 7",
"Comments": "sample string 8",
"Tags": "sample string 9",
"FileSize": 10,
"OrganizationID": 11,
"OFAccountID": 12,
"PatientID": 13,
"IsDeleted": 14,
"Category": "sample string 15",
"IsPrinted": 16,
"RecordedBy": 17,
"AddedOn": "sample string 18",
"SubCategory": "sample string 19",
"StorageFileID": "sample string 20"
},
{
"ID": 1,
"DocumentID": 2,
"DocumentName": "sample string 3",
"DocumentType": "sample string 4",
"FileName": "sample string 5",
"DocumentStatus": "sample string 6",
"Description": "sample string 7",
"Comments": "sample string 8",
"Tags": "sample string 9",
"FileSize": 10,
"OrganizationID": 11,
"OFAccountID": 12,
"PatientID": 13,
"IsDeleted": 14,
"Category": "sample string 15",
"IsPrinted": 16,
"RecordedBy": 17,
"AddedOn": "sample string 18",
"SubCategory": "sample string 19",
"StorageFileID": "sample string 20"
}
]
}
application/xml, text/xml
Sample:
<PatientChartLookUp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VitalOrder_v2_ServerApp.DTO">
<DocumentsInfo>
<patient_orders_attachments>
<AddedOn>sample string 18</AddedOn>
<Category>sample string 15</Category>
<Comments>sample string 8</Comments>
<Description>sample string 7</Description>
<DocumentID>2</DocumentID>
<DocumentName>sample string 3</DocumentName>
<DocumentStatus>sample string 6</DocumentStatus>
<DocumentType>sample string 4</DocumentType>
<FileName>sample string 5</FileName>
<FileSize>10</FileSize>
<ID>1</ID>
<IsDeleted>14</IsDeleted>
<IsPrinted>16</IsPrinted>
<OFAccountID>12</OFAccountID>
<OrganizationID>11</OrganizationID>
<PatientID>13</PatientID>
<RecordedBy>17</RecordedBy>
<StorageFileID>sample string 20</StorageFileID>
<SubCategory>sample string 19</SubCategory>
<Tags>sample string 9</Tags>
</patient_orders_attachments>
<patient_orders_attachments>
<AddedOn>sample string 18</AddedOn>
<Category>sample string 15</Category>
<Comments>sample string 8</Comments>
<Description>sample string 7</Description>
<DocumentID>2</DocumentID>
<DocumentName>sample string 3</DocumentName>
<DocumentStatus>sample string 6</DocumentStatus>
<DocumentType>sample string 4</DocumentType>
<FileName>sample string 5</FileName>
<FileSize>10</FileSize>
<ID>1</ID>
<IsDeleted>14</IsDeleted>
<IsPrinted>16</IsPrinted>
<OFAccountID>12</OFAccountID>
<OrganizationID>11</OrganizationID>
<PatientID>13</PatientID>
<RecordedBy>17</RecordedBy>
<StorageFileID>sample string 20</StorageFileID>
<SubCategory>sample string 19</SubCategory>
<Tags>sample string 9</Tags>
</patient_orders_attachments>
</DocumentsInfo>
<PatientInfo>
<Patient_Info>
<DisplayName>sample string 26</DisplayName>
<EMR>sample string 12</EMR>
<EmailId>sample string 35</EmailId>
<Ethnicity>sample string 15</Ethnicity>
<HomeMobilePhone>sample string 37</HomeMobilePhone>
<HomePhoneExt>sample string 38</HomePhoneExt>
<ModeOfCommunication>sample string 28</ModeOfCommunication>
<OFAccountID>4</OFAccountID>
<OFUserID>5</OFUserID>
<OrganizationID>3</OrganizationID>
<PMSPWS>sample string 13</PMSPWS>
<PatientID>1</PatientID>
<Photograph>sample string 25</Photograph>
<PreferredContact>sample string 24</PreferredContact>
<PreferredEmail>sample string 30</PreferredEmail>
<PreferredPhone>sample string 29</PreferredPhone>
<Race>sample string 17</Race>
<ReportDisplayName>sample string 27</ReportDisplayName>
<SSN>sample string 14</SSN>
<SexualOrientation>sample string 16</SexualOrientation>
<Status>sample string 18</Status>
<Suffix>sample string 9</Suffix>
<VOPatientId>2</VOPatientId>
<WorkAddress>sample string 39</WorkAddress>
<WorkCity>sample string 40</WorkCity>
<WorkEmail>sample string 43</WorkEmail>
<WorkMobilePhone>sample string 44</WorkMobilePhone>
<WorkPhoneExt>sample string 46</WorkPhoneExt>
<WorkState>sample string 41</WorkState>
<WorkZipCode>sample string 42</WorkZipCode>
<address1>sample string 31</address1>
<city>sample string 32</city>
<dob>2025-12-06T01:16:51.8592357-05:00</dob>
<firstname>sample string 6</firstname>
<gender>sample string 11</gender>
<homephone>sample string 36</homephone>
<lastname>sample string 7</lastname>
<middlename>sample string 8</middlename>
<rEmail>sample string 51</rEmail>
<rMobilePhone>sample string 52</rMobilePhone>
<rPhoneExt>sample string 55</rPhoneExt>
<rSSN>sample string 58</rSSN>
<rSuffix>sample string 22</rSuffix>
<raddress1>sample string 47</raddress1>
<rcity>sample string 48</rcity>
<rdob>sample string 57</rdob>
<relationship>sample string 23</relationship>
<rfirstname>sample string 19</rfirstname>
<rgender>sample string 56</rgender>
<rhomephone>sample string 53</rhomephone>
<rlastname>sample string 20</rlastname>
<rmiddlename>sample string 21</rmiddlename>
<rstate>sample string 49</rstate>
<rworkphone>sample string 54</rworkphone>
<rzip>sample string 50</rzip>
<state>sample string 33</state>
<workphone>sample string 45</workphone>
<zip>sample string 34</zip>
</Patient_Info>
<Patient_Info>
<DisplayName>sample string 26</DisplayName>
<EMR>sample string 12</EMR>
<EmailId>sample string 35</EmailId>
<Ethnicity>sample string 15</Ethnicity>
<HomeMobilePhone>sample string 37</HomeMobilePhone>
<HomePhoneExt>sample string 38</HomePhoneExt>
<ModeOfCommunication>sample string 28</ModeOfCommunication>
<OFAccountID>4</OFAccountID>
<OFUserID>5</OFUserID>
<OrganizationID>3</OrganizationID>
<PMSPWS>sample string 13</PMSPWS>
<PatientID>1</PatientID>
<Photograph>sample string 25</Photograph>
<PreferredContact>sample string 24</PreferredContact>
<PreferredEmail>sample string 30</PreferredEmail>
<PreferredPhone>sample string 29</PreferredPhone>
<Race>sample string 17</Race>
<ReportDisplayName>sample string 27</ReportDisplayName>
<SSN>sample string 14</SSN>
<SexualOrientation>sample string 16</SexualOrientation>
<Status>sample string 18</Status>
<Suffix>sample string 9</Suffix>
<VOPatientId>2</VOPatientId>
<WorkAddress>sample string 39</WorkAddress>
<WorkCity>sample string 40</WorkCity>
<WorkEmail>sample string 43</WorkEmail>
<WorkMobilePhone>sample string 44</WorkMobilePhone>
<WorkPhoneExt>sample string 46</WorkPhoneExt>
<WorkState>sample string 41</WorkState>
<WorkZipCode>sample string 42</WorkZipCode>
<address1>sample string 31</address1>
<city>sample string 32</city>
<dob>2025-12-06T01:16:51.8592357-05:00</dob>
<firstname>sample string 6</firstname>
<gender>sample string 11</gender>
<homephone>sample string 36</homephone>
<lastname>sample string 7</lastname>
<middlename>sample string 8</middlename>
<rEmail>sample string 51</rEmail>
<rMobilePhone>sample string 52</rMobilePhone>
<rPhoneExt>sample string 55</rPhoneExt>
<rSSN>sample string 58</rSSN>
<rSuffix>sample string 22</rSuffix>
<raddress1>sample string 47</raddress1>
<rcity>sample string 48</rcity>
<rdob>sample string 57</rdob>
<relationship>sample string 23</relationship>
<rfirstname>sample string 19</rfirstname>
<rgender>sample string 56</rgender>
<rhomephone>sample string 53</rhomephone>
<rlastname>sample string 20</rlastname>
<rmiddlename>sample string 21</rmiddlename>
<rstate>sample string 49</rstate>
<rworkphone>sample string 54</rworkphone>
<rzip>sample string 50</rzip>
<state>sample string 33</state>
<workphone>sample string 45</workphone>
<zip>sample string 34</zip>
</Patient_Info>
</PatientInfo>
<SubscriberInfo>
<Insurance_Info>
<EligibilityStatus>sample string 21</EligibilityStatus>
<ExpirationDate>sample string 7</ExpirationDate>
<InsuredDisplayName>sample string 29</InsuredDisplayName>
<IsOrganization>20</IsOrganization>
<PatientID>1</PatientID>
<Patientpolicynumber>sample string 8</Patientpolicynumber>
<PhoneNumber>sample string 32</PhoneNumber>
<PlanType>sample string 28</PlanType>
<PolicyNumber>sample string 9</PolicyNumber>
<RelationshipToInsuredID>sample string 30</RelationshipToInsuredID>
<SubscriberID>2</SubscriberID>
<Suffix>sample string 19</Suffix>
<VOPatientID>4</VOPatientID>
<VOSubscriberID>3</VOSubscriberID>
<address1>sample string 24</address1>
<address2>sample string 25</address2>
<city>sample string 26</city>
<dob>2025-12-06T01:16:51.8592357-05:00</dob>
<effectivedate>sample string 6</effectivedate>
<firstname>sample string 17</firstname>
<gender>sample string 12</gender>
<grouporplanname>sample string 11</grouporplanname>
<grouporplannumber>sample string 10</grouporplannumber>
<insurancetypecode>sample string 31</insurancetypecode>
<lastname>sample string 16</lastname>
<middlename>sample string 18</middlename>
<payor>sample string 14</payor>
<payorid>15</payorid>
<relationcode>sample string 22</relationcode>
<state>sample string 27</state>
<type>sample string 5</type>
<zip>sample string 23</zip>
</Insurance_Info>
<Insurance_Info>
<EligibilityStatus>sample string 21</EligibilityStatus>
<ExpirationDate>sample string 7</ExpirationDate>
<InsuredDisplayName>sample string 29</InsuredDisplayName>
<IsOrganization>20</IsOrganization>
<PatientID>1</PatientID>
<Patientpolicynumber>sample string 8</Patientpolicynumber>
<PhoneNumber>sample string 32</PhoneNumber>
<PlanType>sample string 28</PlanType>
<PolicyNumber>sample string 9</PolicyNumber>
<RelationshipToInsuredID>sample string 30</RelationshipToInsuredID>
<SubscriberID>2</SubscriberID>
<Suffix>sample string 19</Suffix>
<VOPatientID>4</VOPatientID>
<VOSubscriberID>3</VOSubscriberID>
<address1>sample string 24</address1>
<address2>sample string 25</address2>
<city>sample string 26</city>
<dob>2025-12-06T01:16:51.8592357-05:00</dob>
<effectivedate>sample string 6</effectivedate>
<firstname>sample string 17</firstname>
<gender>sample string 12</gender>
<grouporplanname>sample string 11</grouporplanname>
<grouporplannumber>sample string 10</grouporplannumber>
<insurancetypecode>sample string 31</insurancetypecode>
<lastname>sample string 16</lastname>
<middlename>sample string 18</middlename>
<payor>sample string 14</payor>
<payorid>15</payorid>
<relationcode>sample string 22</relationcode>
<state>sample string 27</state>
<type>sample string 5</type>
<zip>sample string 23</zip>
</Insurance_Info>
</SubscriberInfo>
</PatientChartLookUp>