POST api/v1/{practiceId}/patientevent/waitingroom/{patientId}/checkin

Use to checkin provided patient to waiting room, if patient already checked in do nothing and just return patientVisitId

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceId

practice unique identifier

 globally unique identifier

Required
patientId

patient unique identifier

 globally unique identifier

Required

Body Parameters

None.

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": "59022113-9aba-4983-8c7b-fae363fc9b5c",
    "PatientEventId": "e8d5d514-f27b-4cdb-8c8d-0e8c0f204854",
    "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>e8d5d514-f27b-4cdb-8c8d-0e8c0f204854</d2p1:PatientEventId>
    <d2p1:PatientId>59022113-9aba-4983-8c7b-fae363fc9b5c</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>