POST api/v1/{practiceid}/clinical/medicalcertificate/report/pdf
Generate sick notes report for provided encounter in pdf format
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
practiceid |
practice id |
globally unique identifier |
Required |
Body Parameters
encounter object for which we need to generate sick note
Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.EncounterVoName | Description | Type | Additional 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
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Response Information
Resource Description
System.Net.Http.HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | System.Version |
None. |
|
Content | System.Net.Http.HttpContent |
None. |
|
StatusCode | System.Net.HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | System.Net.Http.HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |