POST api/ProviderService/AddPatient_Basic

Add Patient Basic

Request Information

URI Parameters

None.

Body Parameters

PatientInfoViewModel
NameDescriptionTypeAdditional information
PracticeID

globally unique identifier

None.

EntiyID

globally unique identifier

None.

Note

string

None.

CityId

integer

None.

RegionId

integer

None.

StateId

integer

None.

CountryId

integer

None.

DateCreated

date

None.

CaseNo

string

None.

FacilityCode

string

None.

ImageName

string

None.

Address

string

None.

OtherReferral

string

None.

CampaignID

globally unique identifier

None.

FacilityID

globally unique identifier

None.

RefferringPhyscianID

globally unique identifier

None.

MainPhysicianID

globally unique identifier

None.

MainPhysicianFullName

string

None.

HasUserAccount

boolean

None.

PatientAccountType

PatientAccountType

None.

PatientAccountType_Secondary

PatientAccountType

None.

EmergencyName

string

None.

ReferralTypeID

globally unique identifier

None.

PaperFileNumber

string

None.

Email

string

None.

Phone

string

None.

CanSaveSimilarMatch

boolean

None.

SaveSimilarMatch

boolean

None.

PatientId

globally unique identifier

None.

FullName

string

None.

BloodGroup

string

None.

TitleId

integer

None.

TitleName

string

None.

InterestedIn

string

None.

FirstName

string

None.

MiddleName

string

None.

SurName

string

None.

MRN_Seed

integer

None.

RefferringPhysician

string

None.

Mother_Name

string

None.

Maiden_Name

string

None.

TTPName

string

None.

MRN

string

None.

DOB

date

None.

GenderId

integer

None.

Gender

string

None.

Mobile

string

None.

EmergencyContact

string

None.

EmergencyRelationTypeId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "PracticeID": "6a203a2e-c1da-4a79-92fe-24bd3da4025c",
  "EntiyID": "f45f4049-bb7e-4ad4-bfbd-1ce27cc3e46d",
  "Note": "sample string 3",
  "CityId": 1,
  "RegionId": 1,
  "StateId": 1,
  "CountryId": 1,
  "DateCreated": "2025-06-08T02:21:34.4960969+00:00",
  "CaseNo": "sample string 4",
  "FacilityCode": "sample string 5",
  "ImageName": "sample string 6",
  "Address": "sample string 7",
  "OtherReferral": "sample string 8",
  "CampaignID": "cc35e2c0-36fd-47c5-badb-1aa2900aa150",
  "FacilityID": "4ed663d1-4306-4bbf-ab5f-75dd74d9fca5",
  "RefferringPhyscianID": "b8d71d18-c0f8-4d47-8e8e-130dbbf18bce",
  "MainPhysicianID": "27f965ab-426c-4860-bd4c-bf1f2bf4c67b",
  "MainPhysicianFullName": "sample string 9",
  "HasUserAccount": true,
  "PatientAccountType": {
    "PatientAccountTypeId": 1,
    "AccountHolder": "sample string 1",
    "MedicareNumber": "sample string 2",
    "MedicareExpiry": "2025-06-08T02:21:34.4960969+00:00",
    "HealthFundId": 1,
    "DVANumber": "sample string 3",
    "DVACardColorId": 1,
    "DVADisability": "sample string 4",
    "IHINo": "sample string 5",
    "HCCPensionNo": "sample string 6",
    "HCCPensionExpiry": "2025-06-08T02:21:34.4960969+00:00",
    "GAPOnly": true
  },
  "PatientAccountType_Secondary": {
    "PatientAccountTypeId": 1,
    "AccountHolder": "sample string 1",
    "MedicareNumber": "sample string 2",
    "MedicareExpiry": "2025-06-08T02:21:34.4960969+00:00",
    "HealthFundId": 1,
    "DVANumber": "sample string 3",
    "DVACardColorId": 1,
    "DVADisability": "sample string 4",
    "IHINo": "sample string 5",
    "HCCPensionNo": "sample string 6",
    "HCCPensionExpiry": "2025-06-08T02:21:34.4960969+00:00",
    "GAPOnly": true
  },
  "EmergencyName": "sample string 10",
  "ReferralTypeID": "b6534be2-b963-4f46-8b29-92b85656de78",
  "PaperFileNumber": "sample string 11",
  "Email": "sample string 12",
  "Phone": "sample string 13",
  "CanSaveSimilarMatch": true,
  "SaveSimilarMatch": true,
  "PatientId": "a85f59b5-7c2a-4e52-b762-9f10bffc3e70",
  "FullName": "sample string 16",
  "BloodGroup": "sample string 17",
  "TitleId": 1,
  "TitleName": "sample string 18",
  "InterestedIn": "sample string 19",
  "FirstName": "sample string 20",
  "MiddleName": "sample string 21",
  "SurName": "sample string 22",
  "MRN_Seed": 1,
  "RefferringPhysician": "sample string 23",
  "Mother_Name": "sample string 24",
  "Maiden_Name": "sample string 25",
  "TTPName": "sample string 26",
  "MRN": "sample string 27",
  "DOB": "2025-06-08T02:21:34.4960969+00:00",
  "GenderId": 1,
  "Gender": "sample string 28",
  "Mobile": "sample string 29",
  "EmergencyContact": "sample string 30",
  "EmergencyRelationTypeId": 1
}

application/xml, text/xml

Sample:
<PatientInfoViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbsoluteHealth.API.Models">
  <Address>sample string 7</Address>
  <BloodGroup>sample string 17</BloodGroup>
  <CampaignID>cc35e2c0-36fd-47c5-badb-1aa2900aa150</CampaignID>
  <CanSaveSimilarMatch>true</CanSaveSimilarMatch>
  <CaseNo>sample string 4</CaseNo>
  <CityId>1</CityId>
  <CountryId>1</CountryId>
  <DOB>2025-06-08T02:21:34.4960969+00:00</DOB>
  <DateCreated>2025-06-08T02:21:34.4960969+00:00</DateCreated>
  <Email>sample string 12</Email>
  <EmergencyContact>sample string 30</EmergencyContact>
  <EmergencyName>sample string 10</EmergencyName>
  <EmergencyRelationTypeId>1</EmergencyRelationTypeId>
  <EntiyID>f45f4049-bb7e-4ad4-bfbd-1ce27cc3e46d</EntiyID>
  <FacilityCode>sample string 5</FacilityCode>
  <FacilityID>4ed663d1-4306-4bbf-ab5f-75dd74d9fca5</FacilityID>
  <FirstName>sample string 20</FirstName>
  <FullName>sample string 16</FullName>
  <Gender>sample string 28</Gender>
  <GenderId>1</GenderId>
  <HasUserAccount>true</HasUserAccount>
  <ImageName>sample string 6</ImageName>
  <InterestedIn>sample string 19</InterestedIn>
  <MRN>sample string 27</MRN>
  <MRN_Seed>1</MRN_Seed>
  <Maiden_Name>sample string 25</Maiden_Name>
  <MainPhysicianFullName>sample string 9</MainPhysicianFullName>
  <MainPhysicianID>27f965ab-426c-4860-bd4c-bf1f2bf4c67b</MainPhysicianID>
  <MiddleName>sample string 21</MiddleName>
  <Mobile>sample string 29</Mobile>
  <Mother_Name>sample string 24</Mother_Name>
  <Note>sample string 3</Note>
  <OtherReferral>sample string 8</OtherReferral>
  <PaperFileNumber>sample string 11</PaperFileNumber>
  <PatientAccountType xmlns:d2p1="http://schemas.datacontract.org/2004/07/CSP.EMRContexts.Common.ViewModels">
    <d2p1:AccountHolder>sample string 1</d2p1:AccountHolder>
    <d2p1:DVACardColorId>1</d2p1:DVACardColorId>
    <d2p1:DVADisability>sample string 4</d2p1:DVADisability>
    <d2p1:DVANumber>sample string 3</d2p1:DVANumber>
    <d2p1:GAPOnly>true</d2p1:GAPOnly>
    <d2p1:HCCPensionExpiry>2025-06-08T02:21:34.4960969+00:00</d2p1:HCCPensionExpiry>
    <d2p1:HCCPensionNo>sample string 6</d2p1:HCCPensionNo>
    <d2p1:HealthFundId>1</d2p1:HealthFundId>
    <d2p1:IHINo>sample string 5</d2p1:IHINo>
    <d2p1:MedicareExpiry>2025-06-08T02:21:34.4960969+00:00</d2p1:MedicareExpiry>
    <d2p1:MedicareNumber>sample string 2</d2p1:MedicareNumber>
    <d2p1:PatientAccountTypeId>1</d2p1:PatientAccountTypeId>
  </PatientAccountType>
  <PatientAccountType_Secondary xmlns:d2p1="http://schemas.datacontract.org/2004/07/CSP.EMRContexts.Common.ViewModels">
    <d2p1:AccountHolder>sample string 1</d2p1:AccountHolder>
    <d2p1:DVACardColorId>1</d2p1:DVACardColorId>
    <d2p1:DVADisability>sample string 4</d2p1:DVADisability>
    <d2p1:DVANumber>sample string 3</d2p1:DVANumber>
    <d2p1:GAPOnly>true</d2p1:GAPOnly>
    <d2p1:HCCPensionExpiry>2025-06-08T02:21:34.4960969+00:00</d2p1:HCCPensionExpiry>
    <d2p1:HCCPensionNo>sample string 6</d2p1:HCCPensionNo>
    <d2p1:HealthFundId>1</d2p1:HealthFundId>
    <d2p1:IHINo>sample string 5</d2p1:IHINo>
    <d2p1:MedicareExpiry>2025-06-08T02:21:34.4960969+00:00</d2p1:MedicareExpiry>
    <d2p1:MedicareNumber>sample string 2</d2p1:MedicareNumber>
    <d2p1:PatientAccountTypeId>1</d2p1:PatientAccountTypeId>
  </PatientAccountType_Secondary>
  <PatientId>a85f59b5-7c2a-4e52-b762-9f10bffc3e70</PatientId>
  <Phone>sample string 13</Phone>
  <PracticeID>6a203a2e-c1da-4a79-92fe-24bd3da4025c</PracticeID>
  <ReferralTypeID>b6534be2-b963-4f46-8b29-92b85656de78</ReferralTypeID>
  <RefferringPhyscianID>b8d71d18-c0f8-4d47-8e8e-130dbbf18bce</RefferringPhyscianID>
  <RefferringPhysician>sample string 23</RefferringPhysician>
  <RegionId>1</RegionId>
  <SaveSimilarMatch>true</SaveSimilarMatch>
  <StateId>1</StateId>
  <SurName>sample string 22</SurName>
  <TTPName>sample string 26</TTPName>
  <TitleId>1</TitleId>
  <TitleName>sample string 18</TitleName>
</PatientInfoViewModel>

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 'PatientInfoViewModel'.

Response Information

Resource Description

DataContainerOfPatientMatchInfo
NameDescriptionTypeAdditional information
Data

Collection of PatientMatchInfo

None.

CanSave

boolean

None.

Success

boolean

None.

RecordExists

boolean

None.

PayLoad

Object

None.

Message

string

None.

Messages

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": [
    {
      "MatchTypeID": 1,
      "Patient_Id": "ef6c4936-32e5-41bd-b4ab-7738753385bd",
      "First_Name": "sample string 3",
      "Middle_Name": "sample string 4",
      "Sur_Name": "sample string 5",
      "Mother_Name": "sample string 6",
      "Maiden_Name": "sample string 7",
      "TitleName": "sample string 8",
      "DOB": "2025-06-08T02:21:34.5117765+00:00",
      "Gender": "sample string 9",
      "BloodGroup": "sample string 10",
      "BirthCountryName": "sample string 11",
      "Email": "sample string 12",
      "Mobile_Number": "sample string 13",
      "Home_Phone_Number": "sample string 14",
      "Work_Phone_Number": "sample string 15",
      "Fax_Number": "sample string 16",
      "MRN": "sample string 17",
      "OtherReferral": "sample string 18"
    },
    {
      "MatchTypeID": 1,
      "Patient_Id": "ef6c4936-32e5-41bd-b4ab-7738753385bd",
      "First_Name": "sample string 3",
      "Middle_Name": "sample string 4",
      "Sur_Name": "sample string 5",
      "Mother_Name": "sample string 6",
      "Maiden_Name": "sample string 7",
      "TitleName": "sample string 8",
      "DOB": "2025-06-08T02:21:34.5117765+00:00",
      "Gender": "sample string 9",
      "BloodGroup": "sample string 10",
      "BirthCountryName": "sample string 11",
      "Email": "sample string 12",
      "Mobile_Number": "sample string 13",
      "Home_Phone_Number": "sample string 14",
      "Work_Phone_Number": "sample string 15",
      "Fax_Number": "sample string 16",
      "MRN": "sample string 17",
      "OtherReferral": "sample string 18"
    }
  ],
  "CanSave": true,
  "Success": true,
  "RecordExists": true,
  "PayLoad": {},
  "Message": "sample string 5",
  "Messages": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<DataContainerOfPatientMatchInfoQn65DHhg xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EMR.Web.Screens.Models">
  <CanSave>true</CanSave>
  <Message>sample string 5</Message>
  <Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Messages>
  <PayLoad />
  <RecordExists>true</RecordExists>
  <Success>true</Success>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/CSP.EMRContexts.Common.ViewModels">
    <d2p1:PatientMatchInfo>
      <d2p1:BirthCountryName>sample string 11</d2p1:BirthCountryName>
      <d2p1:BloodGroup>sample string 10</d2p1:BloodGroup>
      <d2p1:DOB>2025-06-08T02:21:34.5117765+00:00</d2p1:DOB>
      <d2p1:Email>sample string 12</d2p1:Email>
      <d2p1:Fax_Number>sample string 16</d2p1:Fax_Number>
      <d2p1:First_Name>sample string 3</d2p1:First_Name>
      <d2p1:Gender>sample string 9</d2p1:Gender>
      <d2p1:Home_Phone_Number>sample string 14</d2p1:Home_Phone_Number>
      <d2p1:MRN>sample string 17</d2p1:MRN>
      <d2p1:Maiden_Name>sample string 7</d2p1:Maiden_Name>
      <d2p1:MatchTypeID>1</d2p1:MatchTypeID>
      <d2p1:Middle_Name>sample string 4</d2p1:Middle_Name>
      <d2p1:Mobile_Number>sample string 13</d2p1:Mobile_Number>
      <d2p1:Mother_Name>sample string 6</d2p1:Mother_Name>
      <d2p1:OtherReferral>sample string 18</d2p1:OtherReferral>
      <d2p1:Patient_Id>ef6c4936-32e5-41bd-b4ab-7738753385bd</d2p1:Patient_Id>
      <d2p1:Sur_Name>sample string 5</d2p1:Sur_Name>
      <d2p1:TitleName>sample string 8</d2p1:TitleName>
      <d2p1:Work_Phone_Number>sample string 15</d2p1:Work_Phone_Number>
    </d2p1:PatientMatchInfo>
    <d2p1:PatientMatchInfo>
      <d2p1:BirthCountryName>sample string 11</d2p1:BirthCountryName>
      <d2p1:BloodGroup>sample string 10</d2p1:BloodGroup>
      <d2p1:DOB>2025-06-08T02:21:34.5117765+00:00</d2p1:DOB>
      <d2p1:Email>sample string 12</d2p1:Email>
      <d2p1:Fax_Number>sample string 16</d2p1:Fax_Number>
      <d2p1:First_Name>sample string 3</d2p1:First_Name>
      <d2p1:Gender>sample string 9</d2p1:Gender>
      <d2p1:Home_Phone_Number>sample string 14</d2p1:Home_Phone_Number>
      <d2p1:MRN>sample string 17</d2p1:MRN>
      <d2p1:Maiden_Name>sample string 7</d2p1:Maiden_Name>
      <d2p1:MatchTypeID>1</d2p1:MatchTypeID>
      <d2p1:Middle_Name>sample string 4</d2p1:Middle_Name>
      <d2p1:Mobile_Number>sample string 13</d2p1:Mobile_Number>
      <d2p1:Mother_Name>sample string 6</d2p1:Mother_Name>
      <d2p1:OtherReferral>sample string 18</d2p1:OtherReferral>
      <d2p1:Patient_Id>ef6c4936-32e5-41bd-b4ab-7738753385bd</d2p1:Patient_Id>
      <d2p1:Sur_Name>sample string 5</d2p1:Sur_Name>
      <d2p1:TitleName>sample string 8</d2p1:TitleName>
      <d2p1:Work_Phone_Number>sample string 15</d2p1:Work_Phone_Number>
    </d2p1:PatientMatchInfo>
  </Data>
</DataContainerOfPatientMatchInfoQn65DHhg>