GET api/ProviderService/GetPatientDetails?patientId={patientId}&practiceID={practiceID}

Get Patient Details

Request Information

URI Parameters

Name	Description	Type	Additional information
patientId		globally unique identifier	Required
practiceID		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

PatientDetailsViewModel

Name	Type	Additional information
PatientId	globally unique identifier	None.
PaperFileNumber	string	None.
Practice_Id	globally unique identifier	None.
FacilityID	globally unique identifier	None.
TitleId	integer	None.
FirstName	string	None.
MiddleName	string	None.
SurName	string	None.
MaidenName	string	None.
DOB	date	None.
GenderId	integer	None.
MaritalStatusId	integer	None.
PreferredContactMethodId	integer	None.
SubscribeSMS	boolean	None.
SubscribeEmail	boolean	None.
GeneralPractitionerId	globally unique identifier	None.
Address	string	None.
CountryId	integer	None.
StateId	integer	None.
RegionId	integer	None.
CountryName	string	None.
StateName	string	None.
RegionName	string	None.
InterestedIn	string	None.
PostalCode	string	None.
WorkPhone	string	None.
HomePhone	string	None.
MobilePhone	string	None.
Email	string	None.
UniversityId	integer	None.
FacultyId	integer	None.
StudentId	string	None.
BirthCountryId	integer	None.
LanguageId	integer	None.
JobTitleId	integer	None.
PartnerName	string	None.
PartnerContact	string	None.
EmergencyName	string	None.
EmergencyContact	string	None.
EmergencyRelationTypeId	integer	None.
GuardianName	string	None.
GuardianContact	string	None.
PatientAccountType	PatientAccountType	None.
PatientAccountType_Secondary	PatientAccountType	None.
MRN	string	None.
EmployerId	globally unique identifier	None.
EmployerName	string	None.
EmployerAddress	string	None.
EmployerRegionId	integer	None.
EmployerCountryId	integer	None.
EmployerStateId	integer	None.
EmployerPostalCode	string	None.
HealthChecks	Collection of PatientHealthCheckViewModel	None.
ImageName	string	None.
SSN	string	None.
Blacklist_Reason	string	None.
Is_Blacklisted	boolean	None.
PatientStatusID	integer	None.
Blood_Group_Id	integer	None.
OtherReferral	string	None.
ReferralTypeID	globally unique identifier	None.
CampaignID	globally unique identifier	None.
MainPhysicianID	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

{
  "PatientId": "af8c22da-5921-4287-bb65-474a5ee5971a",
  "PaperFileNumber": "sample string 2",
  "Practice_Id": "2258d8ed-f635-43ab-8a5f-4e3d7bd0de2c",
  "FacilityID": "1a74b541-65e5-40cd-a2fe-1e773aea8c32",
  "TitleId": 1,
  "FirstName": "sample string 3",
  "MiddleName": "sample string 4",
  "SurName": "sample string 5",
  "MaidenName": "sample string 6",
  "DOB": "2026-02-04T02:00:18.9551262+00:00",
  "GenderId": 1,
  "MaritalStatusId": 1,
  "PreferredContactMethodId": 1,
  "SubscribeSMS": true,
  "SubscribeEmail": true,
  "GeneralPractitionerId": "8bbfe3fc-d88c-4212-9fd0-dc42bb857104",
  "Address": "sample string 7",
  "CountryId": 1,
  "StateId": 1,
  "RegionId": 1,
  "CountryName": "sample string 8",
  "StateName": "sample string 9",
  "RegionName": "sample string 10",
  "InterestedIn": "sample string 11",
  "PostalCode": "sample string 12",
  "WorkPhone": "samplestring13",
  "HomePhone": "samplestring14",
  "MobilePhone": "samplestring15",
  "Email": "sample string 16",
  "UniversityId": 1,
  "FacultyId": 1,
  "StudentId": "sample string 17",
  "BirthCountryId": 1,
  "LanguageId": 1,
  "JobTitleId": 1,
  "PartnerName": "sample string 18",
  "PartnerContact": "samplestring19",
  "EmergencyName": "sample string 20",
  "EmergencyContact": "samplestring21",
  "EmergencyRelationTypeId": 1,
  "GuardianName": "sample string 22",
  "GuardianContact": "samplestring23",
  "PatientAccountType": {
    "PatientAccountTypeId": 1,
    "AccountHolder": "sample string 1",
    "MedicareNumber": "sample string 2",
    "MedicareExpiry": "2026-02-04T02:00:18.9551262+00:00",
    "HealthFundId": 1,
    "DVANumber": "sample string 3",
    "DVACardColorId": 1,
    "DVADisability": "sample string 4",
    "IHINo": "sample string 5",
    "HCCPensionNo": "sample string 6",
    "HCCPensionExpiry": "2026-02-04T02:00:18.9551262+00:00",
    "GAPOnly": true
  },
  "PatientAccountType_Secondary": {
    "PatientAccountTypeId": 1,
    "AccountHolder": "sample string 1",
    "MedicareNumber": "sample string 2",
    "MedicareExpiry": "2026-02-04T02:00:18.9551262+00:00",
    "HealthFundId": 1,
    "DVANumber": "sample string 3",
    "DVACardColorId": 1,
    "DVADisability": "sample string 4",
    "IHINo": "sample string 5",
    "HCCPensionNo": "sample string 6",
    "HCCPensionExpiry": "2026-02-04T02:00:18.9551262+00:00",
    "GAPOnly": true
  },
  "MRN": "sample string 24",
  "EmployerId": "9dae7e03-6491-45be-b64d-0ff8c27782fe",
  "EmployerName": "sample string 26",
  "EmployerAddress": "sample string 27",
  "EmployerRegionId": 1,
  "EmployerCountryId": 1,
  "EmployerStateId": 1,
  "EmployerPostalCode": "sample string 28",
  "HealthChecks": [
    {
      "HealthCheckId": 1,
      "HealthCheckName": "sample string 2",
      "Value": true
    },
    {
      "HealthCheckId": 1,
      "HealthCheckName": "sample string 2",
      "Value": true
    }
  ],
  "ImageName": "sample string 29",
  "SSN": "sample string 30",
  "Blacklist_Reason": "sample string 31",
  "Is_Blacklisted": true,
  "PatientStatusID": 1,
  "Blood_Group_Id": 1,
  "OtherReferral": "sample string 33",
  "ReferralTypeID": "0329ac1b-4e30-47c6-ac28-6def3b65bc41",
  "CampaignID": "9fe408dd-677e-4d4e-83b1-2a04e7e51cc5",
  "MainPhysicianID": "c88483ea-532e-405a-b446-34873c36d1a6"
}

application/xml, text/xml

Sample:

<PatientDetailsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSP.EMRContexts.Common.ViewModels">
  <Address>sample string 7</Address>
  <BirthCountryId>1</BirthCountryId>
  <Blacklist_Reason>sample string 31</Blacklist_Reason>
  <Blood_Group_Id>1</Blood_Group_Id>
  <CampaignID>9fe408dd-677e-4d4e-83b1-2a04e7e51cc5</CampaignID>
  <CountryId>1</CountryId>
  <CountryName>sample string 8</CountryName>
  <DOB>2026-02-04T02:00:18.9551262+00:00</DOB>
  <Email>sample string 16</Email>
  <EmergencyContact>samplestring21</EmergencyContact>
  <EmergencyName>sample string 20</EmergencyName>
  <EmergencyRelationTypeId>1</EmergencyRelationTypeId>
  <EmployerAddress>sample string 27</EmployerAddress>
  <EmployerCountryId>1</EmployerCountryId>
  <EmployerId>9dae7e03-6491-45be-b64d-0ff8c27782fe</EmployerId>
  <EmployerName>sample string 26</EmployerName>
  <EmployerPostalCode>sample string 28</EmployerPostalCode>
  <EmployerRegionId>1</EmployerRegionId>
  <EmployerStateId>1</EmployerStateId>
  <FacilityID>1a74b541-65e5-40cd-a2fe-1e773aea8c32</FacilityID>
  <FacultyId>1</FacultyId>
  <FirstName>sample string 3</FirstName>
  <GenderId>1</GenderId>
  <GeneralPractitionerId>8bbfe3fc-d88c-4212-9fd0-dc42bb857104</GeneralPractitionerId>
  <GuardianContact>samplestring23</GuardianContact>
  <GuardianName>sample string 22</GuardianName>
  <HealthChecks>
    <PatientHealthCheckViewModel>
      <HealthCheckId>1</HealthCheckId>
      <HealthCheckName>sample string 2</HealthCheckName>
      <Value>true</Value>
    </PatientHealthCheckViewModel>
    <PatientHealthCheckViewModel>
      <HealthCheckId>1</HealthCheckId>
      <HealthCheckName>sample string 2</HealthCheckName>
      <Value>true</Value>
    </PatientHealthCheckViewModel>
  </HealthChecks>
  <HomePhone>samplestring14</HomePhone>
  <ImageName>sample string 29</ImageName>
  <InterestedIn>sample string 11</InterestedIn>
  <Is_Blacklisted>true</Is_Blacklisted>
  <JobTitleId>1</JobTitleId>
  <LanguageId>1</LanguageId>
  <MRN>sample string 24</MRN>
  <MaidenName>sample string 6</MaidenName>
  <MainPhysicianID>c88483ea-532e-405a-b446-34873c36d1a6</MainPhysicianID>
  <MaritalStatusId>1</MaritalStatusId>
  <MiddleName>sample string 4</MiddleName>
  <MobilePhone>samplestring15</MobilePhone>
  <OtherReferral>sample string 33</OtherReferral>
  <PaperFileNumber>sample string 2</PaperFileNumber>
  <PartnerContact>samplestring19</PartnerContact>
  <PartnerName>sample string 18</PartnerName>
  <PatientAccountType>
    <AccountHolder>sample string 1</AccountHolder>
    <DVACardColorId>1</DVACardColorId>
    <DVADisability>sample string 4</DVADisability>
    <DVANumber>sample string 3</DVANumber>
    <GAPOnly>true</GAPOnly>
    <HCCPensionExpiry>2026-02-04T02:00:18.9551262+00:00</HCCPensionExpiry>
    <HCCPensionNo>sample string 6</HCCPensionNo>
    <HealthFundId>1</HealthFundId>
    <IHINo>sample string 5</IHINo>
    <MedicareExpiry>2026-02-04T02:00:18.9551262+00:00</MedicareExpiry>
    <MedicareNumber>sample string 2</MedicareNumber>
    <PatientAccountTypeId>1</PatientAccountTypeId>
  </PatientAccountType>
  <PatientAccountType_Secondary>
    <AccountHolder>sample string 1</AccountHolder>
    <DVACardColorId>1</DVACardColorId>
    <DVADisability>sample string 4</DVADisability>
    <DVANumber>sample string 3</DVANumber>
    <GAPOnly>true</GAPOnly>
    <HCCPensionExpiry>2026-02-04T02:00:18.9551262+00:00</HCCPensionExpiry>
    <HCCPensionNo>sample string 6</HCCPensionNo>
    <HealthFundId>1</HealthFundId>
    <IHINo>sample string 5</IHINo>
    <MedicareExpiry>2026-02-04T02:00:18.9551262+00:00</MedicareExpiry>
    <MedicareNumber>sample string 2</MedicareNumber>
    <PatientAccountTypeId>1</PatientAccountTypeId>
  </PatientAccountType_Secondary>
  <PatientId>af8c22da-5921-4287-bb65-474a5ee5971a</PatientId>
  <PatientStatusID>1</PatientStatusID>
  <PostalCode>sample string 12</PostalCode>
  <Practice_Id>2258d8ed-f635-43ab-8a5f-4e3d7bd0de2c</Practice_Id>
  <PreferredContactMethodId>1</PreferredContactMethodId>
  <ReferralTypeID>0329ac1b-4e30-47c6-ac28-6def3b65bc41</ReferralTypeID>
  <RegionId>1</RegionId>
  <RegionName>sample string 10</RegionName>
  <SSN>sample string 30</SSN>
  <StateId>1</StateId>
  <StateName>sample string 9</StateName>
  <StudentId>sample string 17</StudentId>
  <SubscribeEmail>true</SubscribeEmail>
  <SubscribeSMS>true</SubscribeSMS>
  <SurName>sample string 5</SurName>
  <TitleId>1</TitleId>
  <UniversityId>1</UniversityId>
  <WorkPhone>samplestring13</WorkPhone>
</PatientDetailsViewModel>