GET api/patients/{patientId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| patientId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
ItemResponseOfPatient| Name | Description | Type | Additional information |
|---|---|---|---|
| Item | Patient |
None. |
|
| Result | Result |
None. |
Response Formats
application/json, text/json
Sample:
{
"Item": {
"PatientId": 1,
"Prefix": "sample string 1",
"FirstName": "sample string 2",
"MiddleName": "sample string 3",
"LastName": "sample string 4",
"Suffix": "sample string 5",
"DateOfBirth": "2025-12-14T05:53:06.1305714+00:00",
"Gender": 1,
"Email": "sample string 7",
"Address1": "sample string 8",
"Address2": "sample string 9",
"City": "sample string 10",
"State": "sample string 11",
"ZipCode": "sample string 12",
"PhoneAdditional1": "sample string 13",
"PhoneAdditional2": "sample string 14",
"PhoneAdditionalType1": 0,
"PhoneAdditionalType2": 0,
"PrimaryPhone": "sample string 15",
"PrimaryPhoneType": 0,
"Weight": 1.1,
"WeightMetric": 1,
"Height": 1.1,
"HeightMetric": 1,
"NonDoseSpotMedicalRecordNumber": "sample string 16",
"Active": true,
"Encounter": "sample string 17",
"IsHospice": true
},
"Result": {
"ResultCode": "sample string 1",
"ResultDescription": "sample string 2"
}
}
application/xml, text/xml
Sample:
<ItemResponseOfPatient8Vkccj_Sk xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13">
<Result>
<ResultCode>sample string 1</ResultCode>
<ResultDescription>sample string 2</ResultDescription>
</Result>
<Item>
<Active>true</Active>
<Address1>sample string 8</Address1>
<Address2>sample string 9</Address2>
<City>sample string 10</City>
<DateOfBirth>2025-12-14T05:53:06.1305714+00:00</DateOfBirth>
<Email>sample string 7</Email>
<Encounter>sample string 17</Encounter>
<FirstName>sample string 2</FirstName>
<Gender>Male</Gender>
<Height>1.1</Height>
<HeightMetric>inch</HeightMetric>
<IsHospice>true</IsHospice>
<LastName>sample string 4</LastName>
<MiddleName>sample string 3</MiddleName>
<NonDoseSpotMedicalRecordNumber>sample string 16</NonDoseSpotMedicalRecordNumber>
<PatientId>1</PatientId>
<PhoneAdditional1>sample string 13</PhoneAdditional1>
<PhoneAdditional2>sample string 14</PhoneAdditional2>
<PhoneAdditionalType1>Undefined</PhoneAdditionalType1>
<PhoneAdditionalType2>Undefined</PhoneAdditionalType2>
<Prefix>sample string 1</Prefix>
<PrimaryPhone>sample string 15</PrimaryPhone>
<PrimaryPhoneType>Undefined</PrimaryPhoneType>
<State>sample string 11</State>
<Suffix>sample string 5</Suffix>
<Weight>1.1</Weight>
<WeightMetric>lb</WeightMetric>
<ZipCode>sample string 12</ZipCode>
</Item>
</ItemResponseOfPatient8Vkccj_Sk>