POST api/v1/{practiceid}/patientevent/patientevents/importpatientandcheckin

Import patient to the local database and automatically add it to the waiting room

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceid

practice id

 globally unique identifier

Required

Body Parameters

patient details

Com.Healthbridge.Hhas.Patient.Interface.Commands.CreatePatient
NameDescriptionTypeAdditional information
LooseValidation

boolean

None.
PatientVo

Com.Healthbridge.Hhas.Patient.Interface.ValueObjects.PatientVo

None.
UpdateOtherPatientsAccountDetails

boolean

None.
CorrelationIds

Collection of string

None.
OriginatedSystem

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "LooseValidation": true,
  "PatientVo": {
    "PatientId": "61f2c6ed-05ed-4967-8071-ac36db448501",
    "PatientXRef": "sample string 2",
    "PracticeId": "4b65eec2-eb8f-45b3-9db0-6668198bee0a",
    "FileNo": "sample string 4",
    "KnownAs": "sample string 5",
    "Occupation": "sample string 6",
    "Employer": "sample string 7",
    "PreferredLanguage": "sample string 8",
    "MaritalStatus": "sample string 9",
    "PatientDetails": {
      "Title": "sample string 1",
      "FirstName": "sample string 2",
      "Surname": "sample string 3",
      "DateOfBirth": "2025-12-11T22:38:14Z",
      "IdentityNo": "sample string 5",
      "Gender": "sample string 6",
      "ContactNo": "sample string 7",
      "EmailAddress": "sample string 8"
    },
    "PatientAccountDetails": {
      "AccountId": "050dc793-859a-40a1-b25a-383c5f11372a",
      "AccountNo": "sample string 2",
      "IsCashAccount": true,
      "MedicalAidName": "sample string 4",
      "MedicalAidPlan": "sample string 5",
      "MedicalAidPlanOption": "sample string 6",
      "MedicalAidMembershipNumber": "sample string 7",
      "MedicalAidDependentCode": "sample string 8",
      "MedicalAidMainMemberDetails": {
        "Title": "sample string 1",
        "FirstName": "sample string 2",
        "Surname": "sample string 3",
        "DateOfBirth": "2025-12-11T22:38:14Z",
        "IdentityNo": "sample string 5",
        "Gender": "sample string 6",
        "ContactNo": "sample string 7",
        "EmailAddress": "sample string 8"
      },
      "MedicalAidRoutingCode": "sample string 9",
      "MedicalAidOptionCode": "sample string 10",
      "MedicalAidSchemeCode": "sample string 11",
      "MedicalAidPlanCode": "sample string 12"
    },
    "PhysicalAddress": {
      "Line1": "sample string 1",
      "Line2": "sample string 2",
      "Line3": "sample string 3",
      "Code": "sample string 4"
    },
    "PostalAddress": {
      "Line1": "sample string 1",
      "Line2": "sample string 2",
      "Line3": "sample string 3",
      "Code": "sample string 4"
    },
    "Deceased": true
  },
  "UpdateOtherPatientsAccountDetails": true,
  "CorrelationIds": [
    "sample string 1",
    "sample string 2"
  ],
  "OriginatedSystem": "sample string 3"
}

application/xml, text/xml

Sample: 
<CreatePatient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Patient.Interface.Commands">
  <CorrelationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://mpsapi.healthbridge.com/platform/core/v1/command/">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CorrelationIds>
  <OriginatedSystem xmlns="http://mpsapi.healthbridge.com/platform/core/v1/command/">sample string 3</OriginatedSystem>
  <LooseValidation>true</LooseValidation>
  <PatientVo xmlns:d2p1="http://mpsapi.healthbridge.com/clinical/patient/v1/patient/">
    <d2p1:Deceased>true</d2p1:Deceased>
    <d2p1:Employer>sample string 7</d2p1:Employer>
    <d2p1:FileNo>sample string 4</d2p1:FileNo>
    <d2p1:KnownAs>sample string 5</d2p1:KnownAs>
    <d2p1:MaritalStatus>sample string 9</d2p1:MaritalStatus>
    <d2p1:Occupation>sample string 6</d2p1:Occupation>
    <d2p1:PatientAccountDetails>
      <d2p1:AccountId>050dc793-859a-40a1-b25a-383c5f11372a</d2p1:AccountId>
      <d2p1:AccountNo>sample string 2</d2p1:AccountNo>
      <d2p1:IsCashAccount>true</d2p1:IsCashAccount>
      <d2p1:MedicalAidDependentCode>sample string 8</d2p1:MedicalAidDependentCode>
      <d2p1:MedicalAidMainMemberDetails>
        <d2p1:ContactNo>sample string 7</d2p1:ContactNo>
        <d2p1:DateOfBirth>2025-12-11T22:38:14.0296609+02:00</d2p1:DateOfBirth>
        <d2p1:EmailAddress>sample string 8</d2p1:EmailAddress>
        <d2p1:FirstName>sample string 2</d2p1:FirstName>
        <d2p1:Gender>sample string 6</d2p1:Gender>
        <d2p1:IdentityNo>sample string 5</d2p1:IdentityNo>
        <d2p1:Surname>sample string 3</d2p1:Surname>
        <d2p1:Title>sample string 1</d2p1:Title>
      </d2p1:MedicalAidMainMemberDetails>
      <d2p1:MedicalAidMembershipNumber>sample string 7</d2p1:MedicalAidMembershipNumber>
      <d2p1:MedicalAidName>sample string 4</d2p1:MedicalAidName>
      <d2p1:MedicalAidOptionCode>sample string 10</d2p1:MedicalAidOptionCode>
      <d2p1:MedicalAidPlan>sample string 5</d2p1:MedicalAidPlan>
      <d2p1:MedicalAidPlanCode>sample string 12</d2p1:MedicalAidPlanCode>
      <d2p1:MedicalAidPlanOption>sample string 6</d2p1:MedicalAidPlanOption>
      <d2p1:MedicalAidRoutingCode>sample string 9</d2p1:MedicalAidRoutingCode>
      <d2p1:MedicalAidSchemeCode>sample string 11</d2p1:MedicalAidSchemeCode>
    </d2p1:PatientAccountDetails>
    <d2p1:PatientDetails>
      <d2p1:ContactNo>sample string 7</d2p1:ContactNo>
      <d2p1:DateOfBirth>2025-12-11T22:38:14.0296609+02:00</d2p1:DateOfBirth>
      <d2p1:EmailAddress>sample string 8</d2p1:EmailAddress>
      <d2p1:FirstName>sample string 2</d2p1:FirstName>
      <d2p1:Gender>sample string 6</d2p1:Gender>
      <d2p1:IdentityNo>sample string 5</d2p1:IdentityNo>
      <d2p1:Surname>sample string 3</d2p1:Surname>
      <d2p1:Title>sample string 1</d2p1:Title>
    </d2p1:PatientDetails>
    <d2p1:PatientId>61f2c6ed-05ed-4967-8071-ac36db448501</d2p1:PatientId>
    <d2p1:PatientXRef>sample string 2</d2p1:PatientXRef>
    <d2p1:PhysicalAddress>
      <d2p1:Code>sample string 4</d2p1:Code>
      <d2p1:Line1>sample string 1</d2p1:Line1>
      <d2p1:Line2>sample string 2</d2p1:Line2>
      <d2p1:Line3>sample string 3</d2p1:Line3>
    </d2p1:PhysicalAddress>
    <d2p1:PostalAddress>
      <d2p1:Code>sample string 4</d2p1:Code>
      <d2p1:Line1>sample string 1</d2p1:Line1>
      <d2p1:Line2>sample string 2</d2p1:Line2>
      <d2p1:Line3>sample string 3</d2p1:Line3>
    </d2p1:PostalAddress>
    <d2p1:PracticeId>4b65eec2-eb8f-45b3-9db0-6668198bee0a</d2p1:PracticeId>
    <d2p1:PreferredLanguage>sample string 8</d2p1:PreferredLanguage>
  </PatientVo>
  <UpdateOtherPatientsAccountDetails>true</UpdateOtherPatientsAccountDetails>
</CreatePatient>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'CreatePatient'.

Response Information

Resource Description

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfCom.Healthbridge.Hhas.Cloud.WebRole.Models.ApiModels.CheckinPatientVisitResult
NameDescriptionTypeAdditional information
Sucess

boolean

None.
ResponseCode

integer

None.
ResponseMessage

string

None.
Data

Com.Healthbridge.Hhas.Cloud.WebRole.Models.ApiModels.CheckinPatientVisitResult

None.
Links

Collection of Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiLink

None.

Response Formats

application/json, text/json

Sample: 
{
  "Sucess": true,
  "ResponseCode": 2,
  "ResponseMessage": "sample string 3",
  "Data": {
    "PatientId": "eed7d2eb-f1c6-4880-93b9-55fe28d33735",
    "PatientEventId": "a74af9af-cd1a-4498-92a0-67fe57149647",
    "PatientDetailsIncomplete": true,
    "PatientAlreadyCheckedIn": true,
    "Description": "sample string 5"
  },
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<RestApiResultOfCheckinPatientVisitResultahoq3Wrf xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Cloud.WebRole.Models.ApiModels">
    <d2p1:Description>sample string 5</d2p1:Description>
    <d2p1:PatientAlreadyCheckedIn>true</d2p1:PatientAlreadyCheckedIn>
    <d2p1:PatientDetailsIncomplete>true</d2p1:PatientDetailsIncomplete>
    <d2p1:PatientEventId>a74af9af-cd1a-4498-92a0-67fe57149647</d2p1:PatientEventId>
    <d2p1:PatientId>eed7d2eb-f1c6-4880-93b9-55fe28d33735</d2p1:PatientId>
  </Data>
  <Links>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
  </Links>
  <ResponseCode>2</ResponseCode>
  <ResponseMessage>sample string 3</ResponseMessage>
  <Sucess>true</Sucess>
</RestApiResultOfCheckinPatientVisitResultahoq3Wrf>