GET api/Patient/{PatientId}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
PatientId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
PatientDetailResponseName | Description | Type | Additional information |
---|---|---|---|
RequestID | string |
None. |
|
Success | string |
None. |
|
Error | string |
None. |
|
ErrorCode | string |
None. |
|
PatientDetail | PatientRequest |
None. |
Response Formats
application/json, text/json
Sample:
{ "RequestID": "sample string 1", "Success": "sample string 2", "Error": "sample string 3", "ErrorCode": "sample string 4", "PatientDetail": { "CommunicationPreference": "A", "EligiblityCommercial": true, "EligiblityFederal": true, "EligiblityRetiree": true, "EligiblityCondition": true, "EligiblityConditionCode": "sample string 6", "EligiblityAge": true, "EligiblityLocation": true, "PatientID": 9, "PatientFirstName": "sample string 10", "PatientMiddleInitial": "sample string 11", "PatientLastName": "sample string 12", "PatientEmail": "sample string 13", "PatientDOB": "sample string 14", "PatientGender": "A", "PatientAddress1": "sample string 16", "PatientAddress2": "sample string 17", "PatientCity": "sample string 18", "PatientState": "sample string 19", "PatientZipCode": "sample string 20", "PatientHomePhone": "sample string 21", "PatientCellPhone": "sample string 22", "MobileOptIn": "A", "PayorPrimarySubscriber": true, "PayorName": "sample string 25", "PayorGroupID": "sample string 26", "PayorMemberID": "sample string 27", "PayorProviderServicesPhone": "sample string 28", "PhysicianID": 29, "Physician": { "PhysicianID": 1, "PatientID": 2, "PhysicianFirstName": "sample string 3", "PhysicianMiddleName": "sample string 4", "PhysicianLastName": "sample string 5", "PhysicianAddress1": "sample string 6", "PhysicianAddress2": "sample string 7", "PhysicianCity": "sample string 8", "PhysicianState": "sample string 9", "PhysicianZipCode": "sample string 10", "PhysicianPhone": "sample string 11", "PhysicianFax": "sample string 12", "PhysicianEmail": "sample string 13", "PhysicianNPI": "sample string 14", "PhysicianTitle": "sample string 15", "PhysicianSpecialty": "sample string 16" }, "TherapeuticUse": "sample string 30", "ReturningBotox": true, "LastTreatmentDate": "sample string 32", "NextTreatmentDate": "sample string 33", "OtherTreatment": "sample string 34", "OtherTreatmentType": "sample string 35", "PhysicianType": "sample string 36", "PatientCertify": "sample string 37", "ExternalCampaignID": "sample string 38", "EnrollmentSource": "sample string 39", "NeedReEnrollment": true, "ReEnrollmentDate": "sample string 41", "MemberId": "sample string 42", "GroupNumber": "sample string 43", "SuspiciousActivityFlag": true, "PatientCaregiver": { "PatientID": 1, "CaregiverFirstName": "sample string 2", "CaregiverLastName": "sample string 3", "CaregiverDOB": "sample string 4", "Relationship": "sample string 5" } } }
application/xml, text/xml
Sample:
<PatientDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/botox.webapi.Models.RequestReponse"> <Error>sample string 3</Error> <ErrorCode>sample string 4</ErrorCode> <PatientDetail> <CommunicationPreference>65</CommunicationPreference> <EligiblityAge>true</EligiblityAge> <EligiblityCommercial>true</EligiblityCommercial> <EligiblityCondition>true</EligiblityCondition> <EligiblityConditionCode>sample string 6</EligiblityConditionCode> <EligiblityFederal>true</EligiblityFederal> <EligiblityLocation>true</EligiblityLocation> <EligiblityRetiree>true</EligiblityRetiree> <EnrollmentSource>sample string 39</EnrollmentSource> <ExternalCampaignID>sample string 38</ExternalCampaignID> <GroupNumber>sample string 43</GroupNumber> <LastTreatmentDate>sample string 32</LastTreatmentDate> <MemberId>sample string 42</MemberId> <MobileOptIn>65</MobileOptIn> <NeedReEnrollment>true</NeedReEnrollment> <NextTreatmentDate>sample string 33</NextTreatmentDate> <OtherTreatment>sample string 34</OtherTreatment> <OtherTreatmentType>sample string 35</OtherTreatmentType> <PatientAddress1>sample string 16</PatientAddress1> <PatientAddress2>sample string 17</PatientAddress2> <PatientCaregiver> <CaregiverDOB>sample string 4</CaregiverDOB> <CaregiverFirstName>sample string 2</CaregiverFirstName> <CaregiverLastName>sample string 3</CaregiverLastName> <PatientID>1</PatientID> <Relationship>sample string 5</Relationship> </PatientCaregiver> <PatientCellPhone>sample string 22</PatientCellPhone> <PatientCertify>sample string 37</PatientCertify> <PatientCity>sample string 18</PatientCity> <PatientDOB>sample string 14</PatientDOB> <PatientEmail>sample string 13</PatientEmail> <PatientFirstName>sample string 10</PatientFirstName> <PatientGender>65</PatientGender> <PatientHomePhone>sample string 21</PatientHomePhone> <PatientID>9</PatientID> <PatientLastName>sample string 12</PatientLastName> <PatientMiddleInitial>sample string 11</PatientMiddleInitial> <PatientState>sample string 19</PatientState> <PatientZipCode>sample string 20</PatientZipCode> <PayorGroupID>sample string 26</PayorGroupID> <PayorMemberID>sample string 27</PayorMemberID> <PayorName>sample string 25</PayorName> <PayorPrimarySubscriber>true</PayorPrimarySubscriber> <PayorProviderServicesPhone>sample string 28</PayorProviderServicesPhone> <Physician> <PatientID>2</PatientID> <PhysicianAddress1>sample string 6</PhysicianAddress1> <PhysicianAddress2>sample string 7</PhysicianAddress2> <PhysicianCity>sample string 8</PhysicianCity> <PhysicianEmail>sample string 13</PhysicianEmail> <PhysicianFax>sample string 12</PhysicianFax> <PhysicianFirstName>sample string 3</PhysicianFirstName> <PhysicianID>1</PhysicianID> <PhysicianLastName>sample string 5</PhysicianLastName> <PhysicianMiddleName>sample string 4</PhysicianMiddleName> <PhysicianNPI>sample string 14</PhysicianNPI> <PhysicianPhone>sample string 11</PhysicianPhone> <PhysicianSpecialty>sample string 16</PhysicianSpecialty> <PhysicianState>sample string 9</PhysicianState> <PhysicianTitle>sample string 15</PhysicianTitle> <PhysicianZipCode>sample string 10</PhysicianZipCode> </Physician> <PhysicianID>29</PhysicianID> <PhysicianType>sample string 36</PhysicianType> <ReEnrollmentDate>sample string 41</ReEnrollmentDate> <ReturningBotox>true</ReturningBotox> <SuspiciousActivityFlag>true</SuspiciousActivityFlag> <TherapeuticUse>sample string 30</TherapeuticUse> </PatientDetail> <RequestID>sample string 1</RequestID> <Success>sample string 2</Success> </PatientDetailResponse>