Frontend module · STATIC DECLARATIONS

Observation Api client API reference · mansoq-hmis-web

3 client route/call declarations with path parameters, named payload/response types and source references. Exact server acceptance and permissions require the matched backend contract.

Static API contract — behavior review pending. Source baseline f6e9f05f76d4.

Enable JavaScript to inspect structured operation, parameter, schema and permission evidence. Download this reference and its evidence.

Client contract scope

These 3 declarations come from repositories/teleicu/mansoq-hmis-web/src/types/emr/observation/observationApi.ts. Client types and noAuth flags describe the caller; they do not authorize a server action. Dynamic paths and missing backend matches are retained as review work, not repaired into invented endpoints.

Operation map

Client method	HTTP method	Path pattern	Resolution
default.analyse	POST	`/api/v1/patient/{patientId}/observation/analyse/`	literal
default.list	GET	`/api/v1/patient/{patientId}/observation/`	literal
default.upsertObservations	POST	`/api/v1/patient/{patient_external_id}/diagnostic_report/{external_id}/upsert_observations/`	literal

default.analyse

POST /api/v1/patient/{patientId}/observation/analyse/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: patientId. Transport strings are declared here; semantic identifier types require the server contract.

request type: ObservationAnalyzeRequest. client-side declaration; not proof of accepted server payload.

ObservationAnalyzeRequest declared fields:

Field	Type	Required	Description
codes	Code[]	true	—
page_size	number	false	—

response type: ObservationAnalyzeResponse. client-side declaration; not proof of accepted server payload.

ObservationAnalyzeResponse declared fields:

Field	Type	Required	Description
results	ObservationAnalyzeGroup[]	true	—

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.list

GET /api/v1/patient/{patientId}/observation/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: patientId. Transport strings are declared here; semantic identifier types require the server contract.

response type: PaginatedResponse<ObservationListRead>. client-side declaration; not proof of accepted server payload.

PaginatedResponse declared fields:

Field	Type	Required	Description
count	number	true	—
results	TItem[]	true	—

ObservationListRead declared fields:

Field	Type	Required	Description
created_by	UserReadMinimal	true	—
updated_by	UserReadMinimal	true	—
data_entered_by	UserReadMinimal \| null	false	—

Composed/inherited schema references: ObservationBase. Exact generic composition is retained in the structured reference and requires server-side confirmation.

default.upsertObservations

POST /api/v1/patient/{patient_external_id}/diagnostic_report/{external_id}/upsert_observations/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: patient_external_id, external_id. Transport strings are declared here; semantic identifier types require the server contract.

request type: ObservationBatchUpsertRequest. client-side declaration; not proof of accepted server payload.

ObservationBatchUpsertRequest declared fields:

Field	Type	Required	Description
observations	ObservationUpsertRequest[]	true	—

response type: ObservationBatchUpsertResponse. client-side declaration; not proof of accepted server payload.

ObservationBatchUpsertResponse declared fields:

Field	Type	Required	Description
message	string	true	—

Pinned source evidence

Links require access to the private source repository.