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

Initiate capturing encounter workflow (checkin visit if not created, mark as in progress and then encounter will be created)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceId

practice unique identifier

 globally unique identifier

Required
patientId

patient unique identifier

 globally unique identifier

Required

Body Parameters

Com.Healthbridge.Hhas.Cloud.WebRole.Areas.PatientEvent.Model.CaptureEncounterRequest
NameDescriptionTypeAdditional information
ConsultReason

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "ConsultReason": "sample string 1"
}

application/xml, text/xml

Sample: 
<CaptureEncounterRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Cloud.WebRole.Areas.PatientEvent.Model">
  <ConsultReason>sample string 1</ConsultReason>
</CaptureEncounterRequest>

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

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": "a36c132d-20c6-4b81-952a-f86913d4344b",
    "PatientEventId": "efb74167-6b8c-44e0-b5ba-82fd3d5bd7fb",
    "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>efb74167-6b8c-44e0-b5ba-82fd3d5bd7fb</d2p1:PatientEventId>
    <d2p1:PatientId>a36c132d-20c6-4b81-952a-f86913d4344b</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>