Class ClinicalDocumentsController
- Namespace
- API.CliniCore.Controllers
- Assembly
- API.CliniCore.dll
[ApiController]
[Route("api/clinicaldocuments")]
public class ClinicalDocumentsController : ControllerBase- Inheritance
-
ClinicalDocumentsController
- Inherited Members
Constructors
ClinicalDocumentsController(ClinicalDocumentService, ProfileService, SchedulerService)
public ClinicalDocumentsController(ClinicalDocumentService documentService, ProfileService profileService, SchedulerService schedulerService)Parameters
documentServiceClinicalDocumentServiceprofileServiceProfileServiceschedulerServiceSchedulerService
Methods
AddAssessment(Guid, CreateAssessmentRequest)
Add an assessment to a clinical document
[HttpPost("{id}/assessments")]
public ActionResult<ClinicalDocumentDto> AddAssessment(Guid id, CreateAssessmentRequest request)Parameters
idGuidrequestCreateAssessmentRequest
Returns
AddDiagnosis(Guid, CreateDiagnosisRequest)
Add a diagnosis to a clinical document
[HttpPost("{id}/diagnoses")]
public ActionResult<ClinicalDocumentDto> AddDiagnosis(Guid id, CreateDiagnosisRequest request)Parameters
idGuidrequestCreateDiagnosisRequest
Returns
AddObservation(Guid, CreateObservationRequest)
Add an observation to a clinical document
[HttpPost("{id}/observations")]
public ActionResult<ClinicalDocumentDto> AddObservation(Guid id, CreateObservationRequest request)Parameters
idGuidrequestCreateObservationRequest
Returns
AddPlan(Guid, CreatePlanRequest)
Add a plan entry to a clinical document
[HttpPost("{id}/plans")]
public ActionResult<ClinicalDocumentDto> AddPlan(Guid id, CreatePlanRequest request)Parameters
idGuidrequestCreatePlanRequest
Returns
AddPrescription(Guid, CreatePrescriptionRequest)
Add a prescription to a clinical document
[HttpPost("{id}/prescriptions")]
public ActionResult<ClinicalDocumentDto> AddPrescription(Guid id, CreatePrescriptionRequest request)Parameters
idGuidrequestCreatePrescriptionRequest
Returns
Complete(Guid)
Complete a clinical document
[HttpPost("{id}/complete")]
public ActionResult<ClinicalDocumentDto> Complete(Guid id)Parameters
idGuid
Returns
Create(CreateClinicalDocumentRequest)
Create a new clinical document
[HttpPost("")]
public ActionResult<ClinicalDocumentDto> Create(CreateClinicalDocumentRequest request)Parameters
requestCreateClinicalDocumentRequest
Returns
Delete(Guid)
Delete a clinical document
[HttpDelete("{id}")]
public IActionResult Delete(Guid id)Parameters
idGuid
Returns
DeleteAssessment(Guid, Guid)
[HttpDelete("{docId}/assessments/{entryId}")]
public IActionResult DeleteAssessment(Guid docId, Guid entryId)Parameters
Returns
DeleteDiagnosis(Guid, Guid)
[HttpDelete("{docId}/diagnoses/{entryId}")]
public IActionResult DeleteDiagnosis(Guid docId, Guid entryId)Parameters
Returns
DeleteObservation(Guid, Guid)
[HttpDelete("{docId}/observations/{entryId}")]
public IActionResult DeleteObservation(Guid docId, Guid entryId)Parameters
Returns
DeletePlan(Guid, Guid)
[HttpDelete("{docId}/plans/{entryId}")]
public IActionResult DeletePlan(Guid docId, Guid entryId)Parameters
Returns
DeletePrescription(Guid, Guid)
[HttpDelete("{docId}/prescriptions/{entryId}")]
public IActionResult DeletePrescription(Guid docId, Guid entryId)Parameters
Returns
GetAll(DateTime?, DateTime?, bool?)
Get all clinical documents
[HttpGet]
public ActionResult<IEnumerable<ClinicalDocumentSummaryDto>> GetAll(DateTime? fromDate = null, DateTime? toDate = null, bool? completed = null)Parameters
Returns
GetAssessment(Guid, Guid)
[HttpGet("{docId}/assessments/{entryId}")]
public ActionResult<AssessmentDto> GetAssessment(Guid docId, Guid entryId)Parameters
Returns
GetByAppointment(Guid)
Get document for a specific appointment
[HttpGet("appointment/{appointmentId}")]
public ActionResult<ClinicalDocumentDto> GetByAppointment(Guid appointmentId)Parameters
appointmentIdGuid
Returns
GetById(Guid)
Get a clinical document by ID
[HttpGet("{id}")]
public ActionResult<ClinicalDocumentDto> GetById(Guid id)Parameters
idGuid
Returns
GetByPatient(Guid)
Get documents for a patient
[HttpGet("patient/{patientId}")]
public ActionResult<IEnumerable<ClinicalDocumentSummaryDto>> GetByPatient(Guid patientId)Parameters
patientIdGuid
Returns
GetByPhysician(Guid)
Get documents created by a physician
[HttpGet("physician/{physicianId}")]
public ActionResult<IEnumerable<ClinicalDocumentSummaryDto>> GetByPhysician(Guid physicianId)Parameters
physicianIdGuid
Returns
GetDiagnosis(Guid, Guid)
[HttpGet("{docId}/diagnoses/{entryId}")]
public ActionResult<DiagnosisDto> GetDiagnosis(Guid docId, Guid entryId)Parameters
Returns
GetObservation(Guid, Guid)
[HttpGet("{docId}/observations/{entryId}")]
public ActionResult<ObservationDto> GetObservation(Guid docId, Guid entryId)Parameters
Returns
GetPlan(Guid, Guid)
[HttpGet("{docId}/plans/{entryId}")]
public ActionResult<PlanDto> GetPlan(Guid docId, Guid entryId)Parameters
Returns
GetPrescription(Guid, Guid)
[HttpGet("{docId}/prescriptions/{entryId}")]
public ActionResult<PrescriptionDto> GetPrescription(Guid docId, Guid entryId)Parameters
Returns
GetSOAPNote(Guid)
Get SOAP note for a document
[HttpGet("{id}/soap-note")]
public ActionResult<string> GetSOAPNote(Guid id)Parameters
idGuid
Returns
GetStatistics()
Get document statistics
[HttpGet("statistics")]
public ActionResult<object> GetStatistics()Returns
SearchByDiagnosis(string)
Search documents by diagnosis
[HttpGet("search/diagnosis")]
public ActionResult<IEnumerable<ClinicalDocumentSummaryDto>> SearchByDiagnosis(string q)Parameters
qstring
Returns
SearchByMedication(string)
Search documents by medication
[HttpGet("search/medication")]
public ActionResult<IEnumerable<ClinicalDocumentSummaryDto>> SearchByMedication(string q)Parameters
qstring
Returns
Update(Guid, UpdateClinicalDocumentRequest)
Update a clinical document
[HttpPut("{id}")]
public ActionResult<ClinicalDocumentDto> Update(Guid id, UpdateClinicalDocumentRequest request)Parameters
idGuidrequestUpdateClinicalDocumentRequest
Returns
UpdateAssessment(Guid, Guid, AssessmentDto)
[HttpPut("{docId}/assessments/{entryId}")]
public ActionResult<AssessmentDto> UpdateAssessment(Guid docId, Guid entryId, AssessmentDto dto)Parameters
docIdGuidentryIdGuiddtoAssessmentDto
Returns
UpdateDiagnosis(Guid, Guid, DiagnosisDto)
[HttpPut("{docId}/diagnoses/{entryId}")]
public ActionResult<DiagnosisDto> UpdateDiagnosis(Guid docId, Guid entryId, DiagnosisDto dto)Parameters
docIdGuidentryIdGuiddtoDiagnosisDto
Returns
UpdateObservation(Guid, Guid, ObservationDto)
[HttpPut("{docId}/observations/{entryId}")]
public ActionResult<ObservationDto> UpdateObservation(Guid docId, Guid entryId, ObservationDto dto)Parameters
docIdGuidentryIdGuiddtoObservationDto
Returns
UpdatePlan(Guid, Guid, PlanDto)
[HttpPut("{docId}/plans/{entryId}")]
public ActionResult<PlanDto> UpdatePlan(Guid docId, Guid entryId, PlanDto dto)Parameters
Returns
UpdatePrescription(Guid, Guid, PrescriptionDto)
[HttpPut("{docId}/prescriptions/{entryId}")]
public ActionResult<PrescriptionDto> UpdatePrescription(Guid docId, Guid entryId, PrescriptionDto dto)Parameters
docIdGuidentryIdGuiddtoPrescriptionDto