POST api/v1/{practiceXRef}/patientevent/patientevents/schedule

Schedule patient visit

Request Information

URI Parameters

Name	Description	Type	Additional information
practiceXRef	practice external id	string	Required

Body Parameters

public domain-model = SchedulePatientVisit

Com.Healthbridge.Hhas.PatientEvent.Interface.Commands.SchedulePatientVisit

Name	Type	Additional information
PatientEventDetails	Com.Healthbridge.Hhas.PatientEvent.Interface.ValueObjects.PatientEventVo	None.
CorrelationIds	Collection of string	None.
OriginatedSystem	string	None.

Request Formats

application/json, text/json

Sample:

{
  "PatientEventDetails": {
    "PatientEventId": "9cb18e15-2ef7-4dd0-9c47-8ae08a076bc4",
    "PatientEventXRef": "sample string 2",
    "BranchXRef": "sample string 3",
    "BranchName": "sample string 4",
    "PracticeId": "cfd490c7-3439-46c5-acc1-21f4e80dccaf",
    "Patient": {
      "PatientId": "a04f09e6-1256-46eb-a758-dcc0c6c5a650",
      "PatientXRef": "sample string 2",
      "PracticeId": "4d28d660-01ee-4d73-8725-aeac281e09d6",
      "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-04-21T12:00:05Z",
        "IdentityNo": "sample string 5",
        "Gender": "sample string 6",
        "ContactNo": "sample string 7",
        "EmailAddress": "sample string 8"
      },
      "PatientAccountDetails": {
        "AccountId": "3e4bf697-b805-4b0f-846c-1a25313739f5",
        "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-04-21T12:00:05Z",
          "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
    },
    "ScheduledTime": "2025-04-21T12:00:05Z",
    "CheckInTime": "2025-04-21T12:00:05Z",
    "Status": 0,
    "Type": "sample string 6",
    "MedicalInsurance": {
      "MedicalInsurer": {
        "Id": "5b2ea821-1b59-4755-892d-093f7eeff6b4",
        "InsurerXRef": "sample string 2",
        "Name": "sample string 3",
        "AccountNo": "sample string 4",
        "Email": "sample string 5",
        "Phone1": "sample string 6",
        "Phone2": "sample string 7",
        "AddressLine1": "sample string 8",
        "AddressLine2": "sample string 9",
        "AddressLine3": "sample string 10",
        "PostalCode": "sample string 11"
      },
      "Broker": "sample string 1",
      "PolicyNo": "sample string 2",
      "PatientIdentityNo": "sample string 3"
    },
    "CompletedTime": "2025-04-21T12:00:05Z",
    "Completed": true,
    "Cancelled": true,
    "CheckedIn": true,
    "BenefitCheckStatus": "sample string 10",
    "VideoChatLink": "sample string 11",
    "BenefitCheckPdfLink": "sample string 12",
    "AccountBalance": "sample string 13",
    "ProviderNote": "sample string 14",
    "QuoteXRef": "sample string 15"
  },
  "CorrelationIds": [
    "sample string 1",
    "sample string 2"
  ],
  "OriginatedSystem": "sample string 1"
}

application/xml, text/xml

Sample:

<SchedulePatientVisit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.PatientEvent.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 1</OriginatedSystem>
  <PatientEventDetails xmlns:d2p1="http://mpsapi.healthbridge.com/clinical/patientevent/v1/patientevent/">
    <d2p1:AccountBalance>sample string 13</d2p1:AccountBalance>
    <d2p1:BenefitCheckPdfLink>sample string 12</d2p1:BenefitCheckPdfLink>
    <d2p1:BenefitCheckStatus>sample string 10</d2p1:BenefitCheckStatus>
    <d2p1:BranchName>sample string 4</d2p1:BranchName>
    <d2p1:BranchXRef>sample string 3</d2p1:BranchXRef>
    <d2p1:Cancelled>true</d2p1:Cancelled>
    <d2p1:CheckInTime>2025-04-21T12:00:05.2117945+02:00</d2p1:CheckInTime>
    <d2p1:CheckedIn>true</d2p1:CheckedIn>
    <d2p1:Completed>true</d2p1:Completed>
    <d2p1:CompletedTime>2025-04-21T12:00:05.2117945+02:00</d2p1:CompletedTime>
    <d2p1:MedicalInsurance xmlns:d3p1="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.PatientEvent.Interface.ValueObjects">
      <d3p1:Broker>sample string 1</d3p1:Broker>
      <d3p1:MedicalInsurer>
        <d3p1:AccountNo>sample string 4</d3p1:AccountNo>
        <d3p1:AddressLine1>sample string 8</d3p1:AddressLine1>
        <d3p1:AddressLine2>sample string 9</d3p1:AddressLine2>
        <d3p1:AddressLine3>sample string 10</d3p1:AddressLine3>
        <d3p1:Email>sample string 5</d3p1:Email>
        <d3p1:Id>5b2ea821-1b59-4755-892d-093f7eeff6b4</d3p1:Id>
        <d3p1:InsurerXRef>sample string 2</d3p1:InsurerXRef>
        <d3p1:Name>sample string 3</d3p1:Name>
        <d3p1:Phone1>sample string 6</d3p1:Phone1>
        <d3p1:Phone2>sample string 7</d3p1:Phone2>
        <d3p1:PostalCode>sample string 11</d3p1:PostalCode>
      </d3p1:MedicalInsurer>
      <d3p1:PatientIdentityNo>sample string 3</d3p1:PatientIdentityNo>
      <d3p1:PolicyNo>sample string 2</d3p1:PolicyNo>
    </d2p1:MedicalInsurance>
    <d2p1:Patient xmlns:d3p1="http://mpsapi.healthbridge.com/clinical/patient/v1/patient/">
      <d3p1:Deceased>true</d3p1:Deceased>
      <d3p1:Employer>sample string 7</d3p1:Employer>
      <d3p1:FileNo>sample string 4</d3p1:FileNo>
      <d3p1:KnownAs>sample string 5</d3p1:KnownAs>
      <d3p1:MaritalStatus>sample string 9</d3p1:MaritalStatus>
      <d3p1:Occupation>sample string 6</d3p1:Occupation>
      <d3p1:PatientAccountDetails>
        <d3p1:AccountId>3e4bf697-b805-4b0f-846c-1a25313739f5</d3p1:AccountId>
        <d3p1:AccountNo>sample string 2</d3p1:AccountNo>
        <d3p1:IsCashAccount>true</d3p1:IsCashAccount>
        <d3p1:MedicalAidDependentCode>sample string 8</d3p1:MedicalAidDependentCode>
        <d3p1:MedicalAidMainMemberDetails>
          <d3p1:ContactNo>sample string 7</d3p1:ContactNo>
          <d3p1:DateOfBirth>2025-04-21T12:00:05.2117945+02:00</d3p1:DateOfBirth>
          <d3p1:EmailAddress>sample string 8</d3p1:EmailAddress>
          <d3p1:FirstName>sample string 2</d3p1:FirstName>
          <d3p1:Gender>sample string 6</d3p1:Gender>
          <d3p1:IdentityNo>sample string 5</d3p1:IdentityNo>
          <d3p1:Surname>sample string 3</d3p1:Surname>
          <d3p1:Title>sample string 1</d3p1:Title>
        </d3p1:MedicalAidMainMemberDetails>
        <d3p1:MedicalAidMembershipNumber>sample string 7</d3p1:MedicalAidMembershipNumber>
        <d3p1:MedicalAidName>sample string 4</d3p1:MedicalAidName>
        <d3p1:MedicalAidOptionCode>sample string 10</d3p1:MedicalAidOptionCode>
        <d3p1:MedicalAidPlan>sample string 5</d3p1:MedicalAidPlan>
        <d3p1:MedicalAidPlanCode>sample string 12</d3p1:MedicalAidPlanCode>
        <d3p1:MedicalAidPlanOption>sample string 6</d3p1:MedicalAidPlanOption>
        <d3p1:MedicalAidRoutingCode>sample string 9</d3p1:MedicalAidRoutingCode>
        <d3p1:MedicalAidSchemeCode>sample string 11</d3p1:MedicalAidSchemeCode>
      </d3p1:PatientAccountDetails>
      <d3p1:PatientDetails>
        <d3p1:ContactNo>sample string 7</d3p1:ContactNo>
        <d3p1:DateOfBirth>2025-04-21T12:00:05.2117945+02:00</d3p1:DateOfBirth>
        <d3p1:EmailAddress>sample string 8</d3p1:EmailAddress>
        <d3p1:FirstName>sample string 2</d3p1:FirstName>
        <d3p1:Gender>sample string 6</d3p1:Gender>
        <d3p1:IdentityNo>sample string 5</d3p1:IdentityNo>
        <d3p1:Surname>sample string 3</d3p1:Surname>
        <d3p1:Title>sample string 1</d3p1:Title>
      </d3p1:PatientDetails>
      <d3p1:PatientId>a04f09e6-1256-46eb-a758-dcc0c6c5a650</d3p1:PatientId>
      <d3p1:PatientXRef>sample string 2</d3p1:PatientXRef>
      <d3p1:PhysicalAddress>
        <d3p1:Code>sample string 4</d3p1:Code>
        <d3p1:Line1>sample string 1</d3p1:Line1>
        <d3p1:Line2>sample string 2</d3p1:Line2>
        <d3p1:Line3>sample string 3</d3p1:Line3>
      </d3p1:PhysicalAddress>
      <d3p1:PostalAddress>
        <d3p1:Code>sample string 4</d3p1:Code>
        <d3p1:Line1>sample string 1</d3p1:Line1>
        <d3p1:Line2>sample string 2</d3p1:Line2>
        <d3p1:Line3>sample string 3</d3p1:Line3>
      </d3p1:PostalAddress>
      <d3p1:PracticeId>4d28d660-01ee-4d73-8725-aeac281e09d6</d3p1:PracticeId>
      <d3p1:PreferredLanguage>sample string 8</d3p1:PreferredLanguage>
    </d2p1:Patient>
    <d2p1:PatientEventId>9cb18e15-2ef7-4dd0-9c47-8ae08a076bc4</d2p1:PatientEventId>
    <d2p1:PatientEventXRef>sample string 2</d2p1:PatientEventXRef>
    <d2p1:PracticeId>cfd490c7-3439-46c5-acc1-21f4e80dccaf</d2p1:PracticeId>
    <d2p1:ProviderNote>sample string 14</d2p1:ProviderNote>
    <d2p1:QuoteXRef>sample string 15</d2p1:QuoteXRef>
    <d2p1:ScheduledTime>2025-04-21T12:00:05.2117945+02:00</d2p1:ScheduledTime>
    <d2p1:Status>Scheduled</d2p1:Status>
    <d2p1:Type>sample string 6</d2p1:Type>
    <d2p1:VideoChatLink>sample string 11</d2p1:VideoChatLink>
  </PatientEventDetails>
</SchedulePatientVisit>

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

Response Information

Resource Description

Accepted HTTP status if checked in

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

Name	Type	Additional 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": "8d4f8e6c-2385-4c64-8d50-c9df73bd85a9",
    "PatientEventId": "37243b9d-4c9e-41bc-bff7-c7f21f7bc579",
    "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>37243b9d-4c9e-41bc-bff7-c7f21f7bc579</d2p1:PatientEventId>
    <d2p1:PatientId>8d4f8e6c-2385-4c64-8d50-c9df73bd85a9</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>

URI parameters

Headers | Add header

Body

Status

Headers

Body

POST api/v1/{practiceXRef}/patientevent/patientevents/schedule

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/xml, text/xml

application/x-www-form-urlencoded

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml