POST api/v1/Patient/InterfacePatient

Request Information

URI Parameters

None.

Body Parameters

PatientInterfaceRequest
NameDescriptionTypeAdditional information
LocationCode

string

None.

PatientKey

string

None.

FirstName

string

None.

LastName

string

None.

MiddleName

string

None.

Address1

string

None.

Address2

string

None.

Address3

string

None.

City

string

None.

State

string

None.

Zip

string

None.

HomePhone

string

None.

WorkPhone

string

None.

CellPhone

string

None.

DateOfBirth

date

None.

Gender

string

None.

Last4SsNumber

string

None.

EmailAddress

string

None.

Ethnicity

string

None.

PreferredLanguage

string

None.

Race

string

None.

MethodOfContact

string

None.

MaritalStatus

string

None.

EmergencyContactName

string

None.

EmergencyContactPhone

string

None.

Status

string

None.

NoInsurance

boolean

None.

IsDeceased

boolean

None.

DeceasedDate

date

None.

ThirdPartyConsent

boolean

None.

ElectronicConsent

boolean

None.

MaidenName

string

None.

NickName

string

None.

LegalGuardianName

string

None.

LegalGuardianPhone

string

None.

LegalGuardianRelationship

string

None.

PreferredMethodOfContact

string

None.

PracticeEmrId

string

None.

PatientId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "LocationCode": "sample string 1",
  "PatientKey": "sample string 2",
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "MiddleName": "sample string 5",
  "Address1": "sample string 6",
  "Address2": "sample string 7",
  "Address3": "sample string 8",
  "City": "sample string 9",
  "State": "sample string 10",
  "Zip": "sample string 11",
  "HomePhone": "sample string 12",
  "WorkPhone": "sample string 13",
  "CellPhone": "sample string 14",
  "DateOfBirth": "2026-04-14T06:05:02.7483202+00:00",
  "Gender": "sample string 15",
  "Last4SsNumber": "sample string 16",
  "EmailAddress": "sample string 17",
  "Ethnicity": "sample string 18",
  "PreferredLanguage": "sample string 19",
  "Race": "sample string 20",
  "MethodOfContact": "sample string 21",
  "MaritalStatus": "sample string 22",
  "EmergencyContactName": "sample string 23",
  "EmergencyContactPhone": "sample string 24",
  "Status": "sample string 25",
  "NoInsurance": true,
  "IsDeceased": true,
  "DeceasedDate": "2026-04-14T06:05:02.7483202+00:00",
  "ThirdPartyConsent": true,
  "ElectronicConsent": true,
  "MaidenName": "sample string 26",
  "NickName": "sample string 27",
  "LegalGuardianName": "sample string 28",
  "LegalGuardianPhone": "sample string 29",
  "LegalGuardianRelationship": "sample string 30",
  "PreferredMethodOfContact": "sample string 31",
  "PracticeEmrId": "sample string 32",
  "PatientId": 33
}

application/xml, text/xml

Sample:
<PatientInterfaceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AimsApi.ViewModels.Patient">
  <Address1>sample string 6</Address1>
  <Address2>sample string 7</Address2>
  <Address3>sample string 8</Address3>
  <CellPhone>sample string 14</CellPhone>
  <City>sample string 9</City>
  <DateOfBirth>2026-04-14T06:05:02.7483202+00:00</DateOfBirth>
  <DeceasedDate>2026-04-14T06:05:02.7483202+00:00</DeceasedDate>
  <ElectronicConsent>true</ElectronicConsent>
  <EmailAddress>sample string 17</EmailAddress>
  <EmergencyContactName>sample string 23</EmergencyContactName>
  <EmergencyContactPhone>sample string 24</EmergencyContactPhone>
  <Ethnicity>sample string 18</Ethnicity>
  <FirstName>sample string 3</FirstName>
  <Gender>sample string 15</Gender>
  <HomePhone>sample string 12</HomePhone>
  <IsDeceased>true</IsDeceased>
  <Last4SsNumber>sample string 16</Last4SsNumber>
  <LastName>sample string 4</LastName>
  <LegalGuardianName>sample string 28</LegalGuardianName>
  <LegalGuardianPhone>sample string 29</LegalGuardianPhone>
  <LegalGuardianRelationship>sample string 30</LegalGuardianRelationship>
  <LocationCode>sample string 1</LocationCode>
  <MaidenName>sample string 26</MaidenName>
  <MaritalStatus>sample string 22</MaritalStatus>
  <MethodOfContact>sample string 21</MethodOfContact>
  <MiddleName>sample string 5</MiddleName>
  <NickName>sample string 27</NickName>
  <NoInsurance>true</NoInsurance>
  <PatientId>33</PatientId>
  <PatientKey>sample string 2</PatientKey>
  <PracticeEmrId>sample string 32</PracticeEmrId>
  <PreferredLanguage>sample string 19</PreferredLanguage>
  <PreferredMethodOfContact>sample string 31</PreferredMethodOfContact>
  <Race>sample string 20</Race>
  <State>sample string 10</State>
  <Status>sample string 25</Status>
  <ThirdPartyConsent>true</ThirdPartyConsent>
  <WorkPhone>sample string 13</WorkPhone>
  <Zip>sample string 11</Zip>
</PatientInterfaceRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PatientInterfaceRequest'.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.