← Technical API reference

Frontend module · STATIC DECLARATIONS

Symptom Api client API reference · mansoq-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/platform/mansoq-web/src/types/emr/symptom/symptomApi.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.listSymptoms GET /api/v1/patient/{patientId}/symptom/ literal
default.retrieveSymptom GET /api/v1/patient/{patientId}/symptom/{symptomId}/ literal
default.upsertSymptoms POST /api/v1/patient/{patientId}/symptom/upsert/ literal

default.listSymptoms

GET /api/v1/patient/{patientId}/symptom/. 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.

Declared default query fields: ordering (string). These are defaults observed at this route object, not an exhaustive query allowlist.

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

PaginatedResponse declared fields:

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

Symptom declared fields:

Field Type Required Description
id string true —
code Code true —
clinical_status SymptomClinicalStatus true —
verification_status SymptomVerificationStatus true —
severity SymptomSeverity true —
onset Onset false —
recorded_date string false —
note string false —
created_by UserReadMinimal true —
updated_by UserReadMinimal true —
category string true —
encounter string true —
created_date string true —
updated_date string false —

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.retrieveSymptom

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

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

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

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.upsertSymptoms

POST /api/v1/patient/{patientId}/symptom/upsert/. 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: object. client-side declaration; not proof of accepted server payload.

SymptomRequest declared fields:

Field Type Required Description
id string false —
clinical_status SymptomClinicalStatus true —
verification_status SymptomVerificationStatus true —
code Code true —
severity SymptomSeverity true —
onset Onset false —
recorded_date string false —
note string false —
encounter string true —
category string true —
created_date string false —
updated_date string false —
created_by UserReadMinimal false —

default.upsertSymptoms.request declared fields:

Field Type Required Description
datapoints SymptomRequest[] true —

response type: Symptom[]. client-side declaration; not proof of accepted server payload.

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.

Pinned source evidence

Links require access to the private source repository.