← Technical API reference

Frontend module · STATIC DECLARATIONS

Medication Administration Api client API reference · mansoq-hmis-web

2 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 2 declarations come from repositories/teleicu/mansoq-hmis-web/src/types/emr/medicationAdministration/medicationAdministrationApi.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.list GET /api/v1/patient/{patientId}/medication/administration/ literal
default.upsert POST /api/v1/patient/{patientId}/medication/administration/upsert/ literal

default.list

GET /api/v1/patient/{patientId}/medication/administration/. 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<MedicationAdministrationRead>. client-side declaration; not proof of accepted server payload.

PaginatedResponse declared fields:

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

MedicationAdministrationRead declared fields:

Field Type Required Description
id string true —
status MedicationAdministrationStatus true —
status_reason Code false —
medication Code false —
administered_product ProductKnowledgeBase false —
occurrence_period_start string true —
occurrence_period_end string false —
recorded string false —
encounter string true —
request string true —
note string false —
dosage object false —
created_by UserReadMinimal true —
updated_by UserReadMinimal 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.upsert

POST /api/v1/patient/{patientId}/medication/administration/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.

response type: not statically declared. manual contract review required.

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.