POST api/Patient/GetPatientsForBulkUpload

Request Information

URI Parameters

None.

Body Parameters

Collection of Object

None.

Request Formats

application/json, text/json, application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of BulkPatientInfo

Name	Type	Additional information
PatientID	integer	None.
VOPatientId	integer	None.
OrganizationID	integer	None.
OFAccountID	integer	None.
BatchNumber	string	None.
OFOrgName	string	None.
PhysicianName	string	None.
CaseType	string	None.
emr	string	None.
mrn	string	None.
Ethnicity	string	None.
Race	string	None.
createdby	string	None.
createddate	string	None.
lastmodifiedby	string	None.
lastmodifieddate	string	None.
status	string	None.
ssn	string	None.
firstname	string	None.
AccountName	string	None.
lastname	string	None.
middlename	string	None.
Suffix	string	None.
dob	date	None.
gender	string	None.
homephone	string	None.
workphone	string	None.
EmailId	string	None.
address1	string	None.
state	string	None.
city	string	None.
zip	string	None.
SexualOrientation	string	None.
HomeMobilePhone	string	None.
Guarantorfirstname	string	None.
Guarantorlastname	string	None.
GuarantorSuffix	string	None.
Guarantoraddress1	string	None.
Guarantorcity	string	None.
Guarantorstate	string	None.
Guarantorzip	string	None.
Guarantorhomephone	string	None.
relationship	string	None.
IPPayor	string	None.
IPrelationcode	string	None.
IPPayorlastname	string	None.
IPPayorfirstname	string	None.
IPPayormiddlename	string	None.
IPPayorSuffix	string	None.
IPPayorgender	string	None.
IPPayordob	string	None.
IPPayoraddress1	string	None.
IPPayorcity	string	None.
IPPayorstate	string	None.
IPPayorzip	string	None.
IPPolicyNumber	string	None.
IPgrouporplannumber	string	None.
IPgrouporplanname	string	None.
IPPatientpolicynumber	string	None.
IPPhoneNumber	string	None.
ISPayor	string	None.
ISrelationcode	string	None.
ISPayorlastname	string	None.
ISPayorfirstname	string	None.
ISPayormiddlename	string	None.
ISPayorSuffix	string	None.
ISPayorgender	string	None.
ISPayordob	string	None.
ISPayoraddress1	string	None.
ISPayorcity	string	None.
ISPayorstate	string	None.
ISPayorzip	string	None.
ISPolicyNumber	string	None.
ISgrouporplannumber	string	None.
ISgrouporplanname	string	None.
ISPatientpolicynumber	string	None.
ISPhoneNumber	string	None.
AdditionalDataJSON	AddInfo	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "PatientID": 1,
    "VOPatientId": 2,
    "OrganizationID": 3,
    "OFAccountID": 4,
    "BatchNumber": "sample string 5",
    "OFOrgName": "sample string 6",
    "PhysicianName": "sample string 7",
    "CaseType": "sample string 8",
    "emr": "sample string 9",
    "mrn": "sample string 10",
    "Ethnicity": "sample string 11",
    "Race": "sample string 12",
    "createdby": "sample string 13",
    "createddate": "sample string 14",
    "lastmodifiedby": "sample string 15",
    "lastmodifieddate": "sample string 16",
    "status": "sample string 17",
    "ssn": "sample string 18",
    "firstname": "sample string 19",
    "AccountName": "sample string 20",
    "lastname": "sample string 21",
    "middlename": "sample string 22",
    "Suffix": "sample string 23",
    "dob": "2025-12-06T01:13:55.51174-05:00",
    "gender": "sample string 25",
    "homephone": "sample string 26",
    "workphone": "sample string 27",
    "EmailId": "sample string 28",
    "address1": "sample string 29",
    "state": "sample string 30",
    "city": "sample string 31",
    "zip": "sample string 32",
    "SexualOrientation": "sample string 33",
    "HomeMobilePhone": "sample string 34",
    "Guarantorfirstname": "sample string 35",
    "Guarantorlastname": "sample string 36",
    "GuarantorSuffix": "sample string 37",
    "Guarantoraddress1": "sample string 38",
    "Guarantorcity": "sample string 39",
    "Guarantorstate": "sample string 40",
    "Guarantorzip": "sample string 41",
    "Guarantorhomephone": "sample string 42",
    "relationship": "sample string 43",
    "IPPayor": "sample string 44",
    "IPrelationcode": "sample string 45",
    "IPPayorlastname": "sample string 46",
    "IPPayorfirstname": "sample string 47",
    "IPPayormiddlename": "sample string 48",
    "IPPayorSuffix": "sample string 49",
    "IPPayorgender": "sample string 50",
    "IPPayordob": "sample string 51",
    "IPPayoraddress1": "sample string 52",
    "IPPayorcity": "sample string 53",
    "IPPayorstate": "sample string 54",
    "IPPayorzip": "sample string 55",
    "IPPolicyNumber": "sample string 56",
    "IPgrouporplannumber": "sample string 57",
    "IPgrouporplanname": "sample string 58",
    "IPPatientpolicynumber": "sample string 59",
    "IPPhoneNumber": "sample string 60",
    "ISPayor": "sample string 61",
    "ISrelationcode": "sample string 62",
    "ISPayorlastname": "sample string 63",
    "ISPayorfirstname": "sample string 64",
    "ISPayormiddlename": "sample string 65",
    "ISPayorSuffix": "sample string 66",
    "ISPayorgender": "sample string 67",
    "ISPayordob": "sample string 68",
    "ISPayoraddress1": "sample string 69",
    "ISPayorcity": "sample string 70",
    "ISPayorstate": "sample string 71",
    "ISPayorzip": "sample string 72",
    "ISPolicyNumber": "sample string 73",
    "ISgrouporplannumber": "sample string 74",
    "ISgrouporplanname": "sample string 75",
    "ISPatientpolicynumber": "sample string 76",
    "ISPhoneNumber": "sample string 77",
    "AdditionalDataJSON": {
      "version": "sample string 1",
      "data": [
        {
          "type": "sample string 1",
          "values": [
            {
              "fieldname": "sample string 1",
              "value": "sample string 2",
              "display": "sample string 3"
            },
            {
              "fieldname": "sample string 1",
              "value": "sample string 2",
              "display": "sample string 3"
            }
          ]
        },
        {
          "type": "sample string 1",
          "values": [
            {
              "fieldname": "sample string 1",
              "value": "sample string 2",
              "display": "sample string 3"
            },
            {
              "fieldname": "sample string 1",
              "value": "sample string 2",
              "display": "sample string 3"
            }
          ]
        }
      ]
    }
  },
  {
    "PatientID": 1,
    "VOPatientId": 2,
    "OrganizationID": 3,
    "OFAccountID": 4,
    "BatchNumber": "sample string 5",
    "OFOrgName": "sample string 6",
    "PhysicianName": "sample string 7",
    "CaseType": "sample string 8",
    "emr": "sample string 9",
    "mrn": "sample string 10",
    "Ethnicity": "sample string 11",
    "Race": "sample string 12",
    "createdby": "sample string 13",
    "createddate": "sample string 14",
    "lastmodifiedby": "sample string 15",
    "lastmodifieddate": "sample string 16",
    "status": "sample string 17",
    "ssn": "sample string 18",
    "firstname": "sample string 19",
    "AccountName": "sample string 20",
    "lastname": "sample string 21",
    "middlename": "sample string 22",
    "Suffix": "sample string 23",
    "dob": "2025-12-06T01:13:55.51174-05:00",
    "gender": "sample string 25",
    "homephone": "sample string 26",
    "workphone": "sample string 27",
    "EmailId": "sample string 28",
    "address1": "sample string 29",
    "state": "sample string 30",
    "city": "sample string 31",
    "zip": "sample string 32",
    "SexualOrientation": "sample string 33",
    "HomeMobilePhone": "sample string 34",
    "Guarantorfirstname": "sample string 35",
    "Guarantorlastname": "sample string 36",
    "GuarantorSuffix": "sample string 37",
    "Guarantoraddress1": "sample string 38",
    "Guarantorcity": "sample string 39",
    "Guarantorstate": "sample string 40",
    "Guarantorzip": "sample string 41",
    "Guarantorhomephone": "sample string 42",
    "relationship": "sample string 43",
    "IPPayor": "sample string 44",
    "IPrelationcode": "sample string 45",
    "IPPayorlastname": "sample string 46",
    "IPPayorfirstname": "sample string 47",
    "IPPayormiddlename": "sample string 48",
    "IPPayorSuffix": "sample string 49",
    "IPPayorgender": "sample string 50",
    "IPPayordob": "sample string 51",
    "IPPayoraddress1": "sample string 52",
    "IPPayorcity": "sample string 53",
    "IPPayorstate": "sample string 54",
    "IPPayorzip": "sample string 55",
    "IPPolicyNumber": "sample string 56",
    "IPgrouporplannumber": "sample string 57",
    "IPgrouporplanname": "sample string 58",
    "IPPatientpolicynumber": "sample string 59",
    "IPPhoneNumber": "sample string 60",
    "ISPayor": "sample string 61",
    "ISrelationcode": "sample string 62",
    "ISPayorlastname": "sample string 63",
    "ISPayorfirstname": "sample string 64",
    "ISPayormiddlename": "sample string 65",
    "ISPayorSuffix": "sample string 66",
    "ISPayorgender": "sample string 67",
    "ISPayordob": "sample string 68",
    "ISPayoraddress1": "sample string 69",
    "ISPayorcity": "sample string 70",
    "ISPayorstate": "sample string 71",
    "ISPayorzip": "sample string 72",
    "ISPolicyNumber": "sample string 73",
    "ISgrouporplannumber": "sample string 74",
    "ISgrouporplanname": "sample string 75",
    "ISPatientpolicynumber": "sample string 76",
    "ISPhoneNumber": "sample string 77",
    "AdditionalDataJSON": {
      "version": "sample string 1",
      "data": [
        {
          "type": "sample string 1",
          "values": [
            {
              "fieldname": "sample string 1",
              "value": "sample string 2",
              "display": "sample string 3"
            },
            {
              "fieldname": "sample string 1",
              "value": "sample string 2",
              "display": "sample string 3"
            }
          ]
        },
        {
          "type": "sample string 1",
          "values": [
            {
              "fieldname": "sample string 1",
              "value": "sample string 2",
              "display": "sample string 3"
            },
            {
              "fieldname": "sample string 1",
              "value": "sample string 2",
              "display": "sample string 3"
            }
          ]
        }
      ]
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfBulkPatientInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VitalOrder_v2_ServerApp.DTO">
  <BulkPatientInfo>
    <AccountName>sample string 20</AccountName>
    <AdditionalDataJSON>
      <data>
        <AdditionalDetails>
          <type>sample string 1</type>
          <values>
            <Values>
              <display>sample string 3</display>
              <fieldname>sample string 1</fieldname>
              <value>sample string 2</value>
            </Values>
            <Values>
              <display>sample string 3</display>
              <fieldname>sample string 1</fieldname>
              <value>sample string 2</value>
            </Values>
          </values>
        </AdditionalDetails>
        <AdditionalDetails>
          <type>sample string 1</type>
          <values>
            <Values>
              <display>sample string 3</display>
              <fieldname>sample string 1</fieldname>
              <value>sample string 2</value>
            </Values>
            <Values>
              <display>sample string 3</display>
              <fieldname>sample string 1</fieldname>
              <value>sample string 2</value>
            </Values>
          </values>
        </AdditionalDetails>
      </data>
      <version>sample string 1</version>
    </AdditionalDataJSON>
    <BatchNumber>sample string 5</BatchNumber>
    <CaseType>sample string 8</CaseType>
    <EmailId>sample string 28</EmailId>
    <Ethnicity>sample string 11</Ethnicity>
    <GuarantorSuffix>sample string 37</GuarantorSuffix>
    <Guarantoraddress1>sample string 38</Guarantoraddress1>
    <Guarantorcity>sample string 39</Guarantorcity>
    <Guarantorfirstname>sample string 35</Guarantorfirstname>
    <Guarantorhomephone>sample string 42</Guarantorhomephone>
    <Guarantorlastname>sample string 36</Guarantorlastname>
    <Guarantorstate>sample string 40</Guarantorstate>
    <Guarantorzip>sample string 41</Guarantorzip>
    <HomeMobilePhone>sample string 34</HomeMobilePhone>
    <IPPatientpolicynumber>sample string 59</IPPatientpolicynumber>
    <IPPayor>sample string 44</IPPayor>
    <IPPayorSuffix>sample string 49</IPPayorSuffix>
    <IPPayoraddress1>sample string 52</IPPayoraddress1>
    <IPPayorcity>sample string 53</IPPayorcity>
    <IPPayordob>sample string 51</IPPayordob>
    <IPPayorfirstname>sample string 47</IPPayorfirstname>
    <IPPayorgender>sample string 50</IPPayorgender>
    <IPPayorlastname>sample string 46</IPPayorlastname>
    <IPPayormiddlename>sample string 48</IPPayormiddlename>
    <IPPayorstate>sample string 54</IPPayorstate>
    <IPPayorzip>sample string 55</IPPayorzip>
    <IPPhoneNumber>sample string 60</IPPhoneNumber>
    <IPPolicyNumber>sample string 56</IPPolicyNumber>
    <IPgrouporplanname>sample string 58</IPgrouporplanname>
    <IPgrouporplannumber>sample string 57</IPgrouporplannumber>
    <IPrelationcode>sample string 45</IPrelationcode>
    <ISPatientpolicynumber>sample string 76</ISPatientpolicynumber>
    <ISPayor>sample string 61</ISPayor>
    <ISPayorSuffix>sample string 66</ISPayorSuffix>
    <ISPayoraddress1>sample string 69</ISPayoraddress1>
    <ISPayorcity>sample string 70</ISPayorcity>
    <ISPayordob>sample string 68</ISPayordob>
    <ISPayorfirstname>sample string 64</ISPayorfirstname>
    <ISPayorgender>sample string 67</ISPayorgender>
    <ISPayorlastname>sample string 63</ISPayorlastname>
    <ISPayormiddlename>sample string 65</ISPayormiddlename>
    <ISPayorstate>sample string 71</ISPayorstate>
    <ISPayorzip>sample string 72</ISPayorzip>
    <ISPhoneNumber>sample string 77</ISPhoneNumber>
    <ISPolicyNumber>sample string 73</ISPolicyNumber>
    <ISgrouporplanname>sample string 75</ISgrouporplanname>
    <ISgrouporplannumber>sample string 74</ISgrouporplannumber>
    <ISrelationcode>sample string 62</ISrelationcode>
    <OFAccountID>4</OFAccountID>
    <OFOrgName>sample string 6</OFOrgName>
    <OrganizationID>3</OrganizationID>
    <PatientID>1</PatientID>
    <PhysicianName>sample string 7</PhysicianName>
    <Race>sample string 12</Race>
    <SexualOrientation>sample string 33</SexualOrientation>
    <Suffix>sample string 23</Suffix>
    <VOPatientId>2</VOPatientId>
    <address1>sample string 29</address1>
    <city>sample string 31</city>
    <createdby>sample string 13</createdby>
    <createddate>sample string 14</createddate>
    <dob>2025-12-06T01:13:55.51174-05:00</dob>
    <emr>sample string 9</emr>
    <firstname>sample string 19</firstname>
    <gender>sample string 25</gender>
    <homephone>sample string 26</homephone>
    <lastmodifiedby>sample string 15</lastmodifiedby>
    <lastmodifieddate>sample string 16</lastmodifieddate>
    <lastname>sample string 21</lastname>
    <middlename>sample string 22</middlename>
    <mrn>sample string 10</mrn>
    <relationship>sample string 43</relationship>
    <ssn>sample string 18</ssn>
    <state>sample string 30</state>
    <status>sample string 17</status>
    <workphone>sample string 27</workphone>
    <zip>sample string 32</zip>
  </BulkPatientInfo>
  <BulkPatientInfo>
    <AccountName>sample string 20</AccountName>
    <AdditionalDataJSON>
      <data>
        <AdditionalDetails>
          <type>sample string 1</type>
          <values>
            <Values>
              <display>sample string 3</display>
              <fieldname>sample string 1</fieldname>
              <value>sample string 2</value>
            </Values>
            <Values>
              <display>sample string 3</display>
              <fieldname>sample string 1</fieldname>
              <value>sample string 2</value>
            </Values>
          </values>
        </AdditionalDetails>
        <AdditionalDetails>
          <type>sample string 1</type>
          <values>
            <Values>
              <display>sample string 3</display>
              <fieldname>sample string 1</fieldname>
              <value>sample string 2</value>
            </Values>
            <Values>
              <display>sample string 3</display>
              <fieldname>sample string 1</fieldname>
              <value>sample string 2</value>
            </Values>
          </values>
        </AdditionalDetails>
      </data>
      <version>sample string 1</version>
    </AdditionalDataJSON>
    <BatchNumber>sample string 5</BatchNumber>
    <CaseType>sample string 8</CaseType>
    <EmailId>sample string 28</EmailId>
    <Ethnicity>sample string 11</Ethnicity>
    <GuarantorSuffix>sample string 37</GuarantorSuffix>
    <Guarantoraddress1>sample string 38</Guarantoraddress1>
    <Guarantorcity>sample string 39</Guarantorcity>
    <Guarantorfirstname>sample string 35</Guarantorfirstname>
    <Guarantorhomephone>sample string 42</Guarantorhomephone>
    <Guarantorlastname>sample string 36</Guarantorlastname>
    <Guarantorstate>sample string 40</Guarantorstate>
    <Guarantorzip>sample string 41</Guarantorzip>
    <HomeMobilePhone>sample string 34</HomeMobilePhone>
    <IPPatientpolicynumber>sample string 59</IPPatientpolicynumber>
    <IPPayor>sample string 44</IPPayor>
    <IPPayorSuffix>sample string 49</IPPayorSuffix>
    <IPPayoraddress1>sample string 52</IPPayoraddress1>
    <IPPayorcity>sample string 53</IPPayorcity>
    <IPPayordob>sample string 51</IPPayordob>
    <IPPayorfirstname>sample string 47</IPPayorfirstname>
    <IPPayorgender>sample string 50</IPPayorgender>
    <IPPayorlastname>sample string 46</IPPayorlastname>
    <IPPayormiddlename>sample string 48</IPPayormiddlename>
    <IPPayorstate>sample string 54</IPPayorstate>
    <IPPayorzip>sample string 55</IPPayorzip>
    <IPPhoneNumber>sample string 60</IPPhoneNumber>
    <IPPolicyNumber>sample string 56</IPPolicyNumber>
    <IPgrouporplanname>sample string 58</IPgrouporplanname>
    <IPgrouporplannumber>sample string 57</IPgrouporplannumber>
    <IPrelationcode>sample string 45</IPrelationcode>
    <ISPatientpolicynumber>sample string 76</ISPatientpolicynumber>
    <ISPayor>sample string 61</ISPayor>
    <ISPayorSuffix>sample string 66</ISPayorSuffix>
    <ISPayoraddress1>sample string 69</ISPayoraddress1>
    <ISPayorcity>sample string 70</ISPayorcity>
    <ISPayordob>sample string 68</ISPayordob>
    <ISPayorfirstname>sample string 64</ISPayorfirstname>
    <ISPayorgender>sample string 67</ISPayorgender>
    <ISPayorlastname>sample string 63</ISPayorlastname>
    <ISPayormiddlename>sample string 65</ISPayormiddlename>
    <ISPayorstate>sample string 71</ISPayorstate>
    <ISPayorzip>sample string 72</ISPayorzip>
    <ISPhoneNumber>sample string 77</ISPhoneNumber>
    <ISPolicyNumber>sample string 73</ISPolicyNumber>
    <ISgrouporplanname>sample string 75</ISgrouporplanname>
    <ISgrouporplannumber>sample string 74</ISgrouporplannumber>
    <ISrelationcode>sample string 62</ISrelationcode>
    <OFAccountID>4</OFAccountID>
    <OFOrgName>sample string 6</OFOrgName>
    <OrganizationID>3</OrganizationID>
    <PatientID>1</PatientID>
    <PhysicianName>sample string 7</PhysicianName>
    <Race>sample string 12</Race>
    <SexualOrientation>sample string 33</SexualOrientation>
    <Suffix>sample string 23</Suffix>
    <VOPatientId>2</VOPatientId>
    <address1>sample string 29</address1>
    <city>sample string 31</city>
    <createdby>sample string 13</createdby>
    <createddate>sample string 14</createddate>
    <dob>2025-12-06T01:13:55.51174-05:00</dob>
    <emr>sample string 9</emr>
    <firstname>sample string 19</firstname>
    <gender>sample string 25</gender>
    <homephone>sample string 26</homephone>
    <lastmodifiedby>sample string 15</lastmodifiedby>
    <lastmodifieddate>sample string 16</lastmodifieddate>
    <lastname>sample string 21</lastname>
    <middlename>sample string 22</middlename>
    <mrn>sample string 10</mrn>
    <relationship>sample string 43</relationship>
    <ssn>sample string 18</ssn>
    <state>sample string 30</state>
    <status>sample string 17</status>
    <workphone>sample string 27</workphone>
    <zip>sample string 32</zip>
  </BulkPatientInfo>
</ArrayOfBulkPatientInfo>