Frontend module · STATIC DECLARATIONS

Encounter Api client API reference · mansoq-web-teleicu

9 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 9 declarations come from repositories/teleicu/mansoq-web-teleicu/src/types/emr/encounter/encounterApi.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/encounter/`	literal
default.create	POST	`/api/v1/encounter/`	literal
default.get	GET	`/api/v1/encounter/{id}/`	literal
default.update	PUT	`/api/v1/encounter/{id}/`	literal
default.restart	POST	`/api/v1/encounter/{id}/restart/`	literal
default.addOrganization	POST	`/api/v1/encounter/{encounterId}/organizations_add/`	literal
default.removeOrganization	DELETE	`/api/v1/encounter/{encounterId}/organizations_remove/`	literal
default.setTags	POST	`/api/v1/encounter/{external_id}/set_tags/`	literal
default.removeTags	POST	`/api/v1/encounter/{external_id}/remove_tags/`	literal

default.list

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

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

PaginatedResponse declared fields:

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

EncounterListRead declared fields:

Field	Type	Required	Description
id	string	true	—
patient	PatientListRead	true	—
facility	FacilityBareMinimum	true	—
status_history	StatusHistory	true	—
created_date	string	true	—
modified_date	string	true	—
tags	TagConfig[]	true	—
current_location	LocationMinSpec \| null	true	—
care_team	CareTeamResponse[]	true	—
encounter_class	EncounterClass	true	—

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

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

POST /api/v1/encounter/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

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

EncounterCreate declared fields:

Field	Type	Required	Description
patient	string	true	—
facility	string	true	—
organizations	string[]	true	—
tags	string[]	false	—
appointment	string	false	—
external_identifier	string	false	—
discharge_summary_advice	string	false	—
encounter_class	EncounterClass	true	—

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

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

EncounterRead declared fields:

Field	Type	Required	Description
appointment	AppointmentRead \| null	true	—
patient	PatientRead	true	—
organizations	FacilityOrganizationRead[]	true	—
current_location	LocationRead \| null	true	—
location_history	LocationAssociationRead[]	true	—
care_team	CareTeamResponse[]	true	—
tags	TagConfig[]	true	—
created_by	UserReadMinimal	true	—
updated_by	UserReadMinimal	true	—

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

default.get

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

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

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

default.update

PUT /api/v1/encounter/{id}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

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

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

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

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

default.restart

POST /api/v1/encounter/{id}/restart/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

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

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

default.addOrganization

POST /api/v1/encounter/{encounterId}/organizations_add/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

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

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

default.addOrganization.request declared fields:

Field	Type	Required	Description
organization	string	true	—

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

default.removeOrganization

DELETE /api/v1/encounter/{encounterId}/organizations_remove/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

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

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

default.removeOrganization.request declared fields:

Field	Type	Required	Description
organization	string	true	—

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

default.setTags

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

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

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

default.setTags.request declared fields:

Field	Type	Required	Description
tags	string[]	true	—

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

default.removeTags

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

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

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

default.removeTags.request declared fields:

Field	Type	Required	Description
tags	string[]	true	—

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

Pinned source evidence

Links require access to the private source repository.