Table of Contents

Class ApiRoutes.ClinicalDocuments

Namespace
Core.CliniCore.Api
Assembly
Core.CliniCore.dll

Routes for Clinical Documents API (/api/clinicaldocuments)

public static class ApiRoutes.ClinicalDocuments
Inheritance
ApiRoutes.ClinicalDocuments
Inherited Members

Fields

AssessmentById

Route segment for a specific assessment by entry ID.

public const string AssessmentById = "{docId}/assessments/{entryId}"

Field Value

string

Assessments

Route segment for assessments within a clinical document.

public const string Assessments = "{docId}/assessments"

Field Value

string

BasePath

Represents the base path for clinical documents endpoints, combining the base route and controller name.

public const string BasePath = "api/clinicaldocuments"

Field Value

string

ByAppointment

Route segment for retrieving clinical documents by appointment.

public const string ByAppointment = "appointment/{appointmentId}"

Field Value

string

ById

Route segment used to identify a clinical document by its unique identifier.

public const string ById = "{id}"

Field Value

string

ByPatient

Route segment for retrieving clinical documents by patient.

public const string ByPatient = "patient/{patientId}"

Field Value

string

ByPhysician

Route segment for retrieving clinical documents by physician.

public const string ByPhysician = "physician/{physicianId}"

Field Value

string

Complete

Route segment for completing a clinical document.

public const string Complete = "{id}/complete"

Field Value

string

Controller

Represents the route segment used for clinical documents-related controllers.

public const string Controller = "clinicaldocuments"

Field Value

string

Diagnoses

Route segment for diagnoses within a clinical document.

public const string Diagnoses = "{docId}/diagnoses"

Field Value

string

DiagnosisById

Route segment for a specific diagnosis by entry ID.

public const string DiagnosisById = "{docId}/diagnoses/{entryId}"

Field Value

string

ObservationById

Route segment for a specific observation by entry ID.

public const string ObservationById = "{docId}/observations/{entryId}"

Field Value

string

Observations

Route segment for observations within a clinical document.

public const string Observations = "{docId}/observations"

Field Value

string

PlanById

Route segment for a specific plan by entry ID.

public const string PlanById = "{docId}/plans/{entryId}"

Field Value

string

Plans

Route segment for plans within a clinical document.

public const string Plans = "{docId}/plans"

Field Value

string

PrescriptionById

Route segment for a specific prescription by entry ID.

public const string PrescriptionById = "{docId}/prescriptions/{entryId}"

Field Value

string

Prescriptions

Route segment for prescriptions within a clinical document.

public const string Prescriptions = "{docId}/prescriptions"

Field Value

string

SearchDiagnosis

Route segment for diagnosis search.

public const string SearchDiagnosis = "search/diagnosis"

Field Value

string

SearchMedication

Route segment for medication search.

public const string SearchMedication = "search/medication"

Field Value

string

SoapNote

Route segment for retrieving a SOAP note for a clinical document.

public const string SoapNote = "{id}/soap-note"

Field Value

string

Statistics

Route segment for clinical document statistics.

public const string Statistics = "statistics"

Field Value

string

Methods

CompleteDocument(Guid)

Returns the path to mark a clinical document as complete.

public static string CompleteDocument(Guid id)

Parameters

id Guid

The clinical document identifier.

Returns

string

The full path to complete the document.

GetAll()

Gets the base route for accessing all clinical documents.

public static string GetAll()

Returns

string

The base path for clinical documents.

GetAssessment(Guid, Guid)

Returns the path to retrieve a specific assessment by entry ID.

public static string GetAssessment(Guid docId, Guid entryId)

Parameters

docId Guid

The clinical document identifier.

entryId Guid

The assessment entry identifier.

Returns

string

The full path for the specified assessment.

GetAssessments(Guid)

Returns the path to retrieve assessments for a clinical document.

public static string GetAssessments(Guid docId)

Parameters

docId Guid

The clinical document identifier.

Returns

string

The full path for assessments.

GetByAppointment(Guid)

Returns the path to retrieve clinical documents by appointment.

public static string GetByAppointment(Guid appointmentId)

Parameters

appointmentId Guid

The appointment identifier.

Returns

string

The full path for documents by appointment.

GetByDateRange(DateTime, DateTime)

Returns the path to retrieve clinical documents in a date range.

public static string GetByDateRange(DateTime start, DateTime end)

Parameters

start DateTime

Start date (inclusive).

end DateTime

End date (inclusive).

Returns

string

The full path with date range query parameters.

GetById(Guid)

Returns the path to retrieve a clinical document by its unique identifier.

public static string GetById(Guid id)

Parameters

id Guid

The clinical document identifier.

Returns

string

The full path for the specified clinical document.

GetByPatient(Guid)

Returns the path to retrieve clinical documents by patient.

public static string GetByPatient(Guid patientId)

Parameters

patientId Guid

The patient identifier.

Returns

string

The full path for documents by patient.

GetByPhysician(Guid)

Returns the path to retrieve clinical documents by physician.

public static string GetByPhysician(Guid physicianId)

Parameters

physicianId Guid

The physician identifier.

Returns

string

The full path for documents by physician.

GetDiagnoses(Guid)

Returns the path to retrieve diagnoses for a clinical document.

public static string GetDiagnoses(Guid docId)

Parameters

docId Guid

The clinical document identifier.

Returns

string

The full path for diagnoses.

GetDiagnosis(Guid, Guid)

Returns the path to retrieve a specific diagnosis by entry ID.

public static string GetDiagnosis(Guid docId, Guid entryId)

Parameters

docId Guid

The clinical document identifier.

entryId Guid

The diagnosis entry identifier.

Returns

string

The full path for the specified diagnosis.

GetIncomplete()

Returns the path to retrieve incomplete clinical documents.

public static string GetIncomplete()

Returns

string

The full path filtered to incomplete documents.

GetObservation(Guid, Guid)

Returns the path to retrieve a specific observation by entry ID.

public static string GetObservation(Guid docId, Guid entryId)

Parameters

docId Guid

The clinical document identifier.

entryId Guid

The observation entry identifier.

Returns

string

The full path for the specified observation.

GetObservations(Guid)

Returns the path to retrieve observations for a clinical document.

public static string GetObservations(Guid docId)

Parameters

docId Guid

The clinical document identifier.

Returns

string

The full path for observations.

GetPlan(Guid, Guid)

Returns the path to retrieve a specific plan by entry ID.

public static string GetPlan(Guid docId, Guid entryId)

Parameters

docId Guid

The clinical document identifier.

entryId Guid

The plan entry identifier.

Returns

string

The full path for the specified plan.

GetPlans(Guid)

Returns the path to retrieve plans for a clinical document.

public static string GetPlans(Guid docId)

Parameters

docId Guid

The clinical document identifier.

Returns

string

The full path for plans.

GetPrescription(Guid, Guid)

Returns the path to retrieve a specific prescription by entry ID.

public static string GetPrescription(Guid docId, Guid entryId)

Parameters

docId Guid

The clinical document identifier.

entryId Guid

The prescription entry identifier.

Returns

string

The full path for the specified prescription.

GetPrescriptions(Guid)

Returns the path to retrieve prescriptions for a clinical document.

public static string GetPrescriptions(Guid docId)

Parameters

docId Guid

The clinical document identifier.

Returns

string

The full path for prescriptions.

GetSoapNote(Guid)

Returns the path to retrieve the SOAP note for a clinical document.

public static string GetSoapNote(Guid id)

Parameters

id Guid

The clinical document identifier.

Returns

string

The full path to the SOAP note endpoint.

SearchByDiagnosis(string)

Returns the path to search clinical documents by diagnosis code.

public static string SearchByDiagnosis(string code)

Parameters

code string

The diagnosis code to search.

Returns

string

The full path including the encoded diagnosis code.

SearchByMedication(string)

Returns the path to search clinical documents by medication name.

public static string SearchByMedication(string name)

Parameters

name string

The medication name to search.

Returns

string

The full path including the encoded medication name.

SearchByQuery(string)

Returns the path to search clinical documents by a free-text query.

public static string SearchByQuery(string query)

Parameters

query string

The search query string.

Returns

string

The full path including the encoded query string.

Edit this page