POST api/v1/{providerTenantId}/clinical/encounters/import

Import a historical encounter into a new providerTenantId

Request Information

URI Parameters

NameDescriptionTypeAdditional information
providerTenantId

destination tenant

globally unique identifier

Required

Body Parameters

historical encounter to import

Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.EncounterVo
NameDescriptionTypeAdditional information
MedicationsPrescriptions

Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.MedicationPrescription

None.

EncounterId

Invoice identifier

globally unique identifier

None.

PatientId

string

None.

BranchXRef

string

None.

PracticeId

Practice identifier

globally unique identifier

None.

EncounterType

Encounter type (medical aid, cash claim, no charge)

string

None.

ConsultReason

string

None.

Provider

Provider details

Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.ProviderVo

None.

ReferringDoctorName

Referral doctor name

string

None.

ReferringDoctorPracticeNumber

Referral doctor practice number

string

None.

AssistingDoctorName

Assisting doctor name

string

None.

AssistingDoctorPracticeNumber

Assisting doctor practice number

string

None.

PatientEventDetails

Patient visit event details (who was the patient, when the the event occurred, accounting details)

Com.Healthbridge.Hhas.PatientEvent.Interface.ValueObjects.PatientEventVo

None.

Diagnosis

List of all diagnosed conditions during the encounter with the patient. All or some of these conditions may be applied to the billing instructions (e.g. claim to medical aid) and medicine order and medical certificate. Invoices, medicine orders and medical certificates may omit some of the diagnoses in consideration for the patient privacy (e.g. HIV condition)

Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.DiagnosisVo

None.

EncounterLineItems

Invoice line items - the specifications of services provided to the patient

Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.EncounterLineItemsVo

None.

MedicationsAdministered

List of medications (and consumables) that have been administered to the patient during the encounter (e.g. pain killer injection, needle, vial, cotton swabs)

Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.MedicationPrescription

None.

MedicationsDispensed

List of medications that have been dispensed by the PROVIDER to the patient during the encounter (and will be billed as the part of the encounter)

Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.MedicationPrescription

None.

MedicationsPrescribed

List of medications that have been prescribed to the patient that will be dispensed by a 3rd party (typically a pharmacy)

Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.MedicationPrescription

None.

MedicalCertificate

Medical certificate

Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.MedicalCertificate

None.

MedicalInsurance

Medical insurance

Com.Healthbridge.Hhas.PatientEvent.Interface.ValueObjects.MedicalInsuranceVo

None.

RequiresFollowUp

Indicates that the invoice require follow-up before it is posted for payment. Typically used in a situation when billing instructions have not been captured by the doctor in full and require additional information by the back office team (e.g. complex procedures, etc) before the invoice can be submitted for payment / claiming.

boolean

None.

Note

Additional instruction captured by doctor

string

None.

ClinicalNote

Additional instruction captured by clinical doctor

string

None.

EncounterFollowUp

Visit outcome information

Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.EncounterFollowUpVo

None.

Communications

Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.CommunicationVo

None.

ClinicalMetrics

Captured metrics during visit

Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.ClinicalMetricVo

None.

PatientDocuments

References to attached documents

Collection of Com.Healthbridge.Hhas.Billing.Interface.ValueObjects.LinkedPatientDocument

None.

Symptoms

Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.Symptom

None.

SymptomQuestions

Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.SymptomQuestion

None.

SymptomQuestionAnswers

Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.SymptomQuestionAnswer

None.

DiagnosisTokenItems

Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.EncounterDiagnosisTokenItemVo

None.

EncounterPlanOutcomes

Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.EncounterPlanOutcomeVo

None.

EncounterDiagrams

Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.EncounterDiagramVo

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

Response Information

Resource Description

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfSystem.Guid
NameDescriptionTypeAdditional information
Sucess

boolean

None.

ResponseCode

integer

None.

ResponseMessage

string

None.

Data

globally unique identifier

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": "8e58a0bb-acae-4f8f-8783-33ab7adc6dad",
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<RestApiResultOfguid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Data>8e58a0bb-acae-4f8f-8783-33ab7adc6dad</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>
</RestApiResultOfguid>