PUT api/v1/{practiceId}/clinical/encounters/{encounterId}/finish

Based on provided encounter submit invoice (if required) and complete patient visit

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceId

Unique identifier of practice

 globally unique identifier

Required
encounterId

globally unique identifier

Required

Body Parameters

public domain model = Submitencounter

Com.Healthbridge.Hhas.Clinical.Interface.Commands.CompleteEncounter
NameDescriptionTypeAdditional information
EncounterVo

Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.EncounterVo

None.
CorrelationIds

Collection of string

None.
OriginatedSystem

string

None.

Request Formats

application/json

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.SymptomQuestion'. Path 'EncounterVo.SymptomQuestions[0].Questions'.

text/json

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.SymptomQuestion'. Path 'EncounterVo.SymptomQuestions[0].Questions'.

application/xml

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.SymptomQuestion' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.SymptomQuestion' contains cycles and cannot be serialized if reference tracking is disabled.

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

Response Information

Resource Description

Id the encounter

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfCom.Healthbridge.Hhas.Cloud.WebRole.Areas.Clinical.RestControllers.CompleteEncounterResult
NameDescriptionTypeAdditional information
Sucess

boolean

None.
ResponseCode

integer

None.
ResponseMessage

string

None.
Data

Com.Healthbridge.Hhas.Cloud.WebRole.Areas.Clinical.RestControllers.CompleteEncounterResult

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": {
    "EncounterId": "5c2cc7bf-de10-4365-b684-be278b19c485",
    "HealthIDViewed": "sample string 2"
  },
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<RestApiResultOfCompleteEncounterResultav9YLh8J 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.Areas.Clinical.RestControllers">
    <d2p1:EncounterId>5c2cc7bf-de10-4365-b684-be278b19c485</d2p1:EncounterId>
    <d2p1:HealthIDViewed>sample string 2</d2p1:HealthIDViewed>
  </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>
</RestApiResultOfCompleteEncounterResultav9YLh8J>