Backend resource · STATIC DECLARATIONS

Note Message API reference · mansoq-core

Static source contract for Note Message: 5 declared or inherited operation mappings, schema/field evidence and authorization/refusal references. Deployment and behavioral review remain explicit.

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.

Declared route and availability

This resource is declared in mansoq-core at /api/v1/patient/{patient_external_id}/thread/{thread_external_id}/note/. verified core mount in config/urls.py A registered path and an indexed handler do not prove deployment availability, user permission or production readiness.

Operation map

Method	Path	Action	Evidence
GET	`/api/v1/patient/{patient_external_id}/thread/{thread_external_id}/note/`	list	declared/inherited method
POST	`/api/v1/patient/{patient_external_id}/thread/{thread_external_id}/note/`	create	declared/inherited method
GET	`/api/v1/patient/{patient_external_id}/thread/{thread_external_id}/note/{external_id}/`	retrieve	declared/inherited method
PUT	`/api/v1/patient/{patient_external_id}/thread/{thread_external_id}/note/{external_id}/`	update	declared/inherited method
PATCH	`/api/v1/patient/{patient_external_id}/thread/{thread_external_id}/note/{external_id}/`	partial_update	declared/inherited method

list · GET

GET /api/v1/patient/{patient_external_id}/thread/{thread_external_id}/note/ — action list. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location	Parameter	Type	Required
path	patient_external_id	router lookup string; semantic ID validation requires handler/schema review	true
path	thread_external_id	router lookup string; semantic ID validation requires handler/schema review	true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location	Field	Declared/inferred read type	Requiredness evidence
query	`encounter`	not declared at read site	not established

response: NoteMessageReadSpec. Declared fields below; inherited fields are retained in the schema inventory.

Field	Type	Required	Constraints
meta	dict	false	No extra constraint extracted
id	UUID4 \| None	false	No extra constraint extracted
message	str	true	No extra constraint extracted
message_history	dict	true	No extra constraint extracted
created_by	dict \| None	false	No extra constraint extracted
updated_by	dict \| None	false	No extra constraint extracted
created_date	datetime.datetime	true	No extra constraint extracted
modified_date	datetime.datetime	true	No extra constraint extracted

Observed authorization checks: can_view_clinical_data, can_view_encounter_clinical_data. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Permission denied to user; ValidationError: Thread does not belong to the patient.

create · POST

POST /api/v1/patient/{patient_external_id}/thread/{thread_external_id}/note/ — action create. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location	Parameter	Type	Required
path	patient_external_id	router lookup string; semantic ID validation requires handler/schema review	true
path	thread_external_id	router lookup string; semantic ID validation requires handler/schema review	true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location	Field	Declared/inferred read type	Requiredness evidence
query	`encounter`	not declared at read site	not established
body	`encounter`	not declared at read site	not established

request: NoteMessageCreateSpec. Declared fields below; inherited fields are retained in the schema inventory.

Field	Type	Required	Constraints
meta	dict	false	No extra constraint extracted
id	UUID4 \| None	false	No extra constraint extracted
message	str	true	No extra constraint extracted

response: NoteMessageReadSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

Observed authorization checks: can_view_clinical_data, can_view_encounter_clinical_data, can_update_encounter_clinical_data, can_write_patient_obj. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Permission denied to user; ValidationError: Thread does not belong to the patient; PermissionDenied: You do not have permission for this action; ValidationError: Patient Mismatch.

retrieve · GET

GET /api/v1/patient/{patient_external_id}/thread/{thread_external_id}/note/{external_id}/ — action retrieve. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location	Parameter	Type	Required
path	patient_external_id	router lookup string; semantic ID validation requires handler/schema review	true
path	thread_external_id	router lookup string; semantic ID validation requires handler/schema review	true
path	external_id	router lookup string; semantic ID validation requires handler/schema review	true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location	Field	Declared/inferred read type	Requiredness evidence
query	`encounter`	not declared at read site	not established

response: NoteMessageReadSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

Observed authorization checks: can_view_clinical_data, can_view_encounter_clinical_data. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Permission denied to user; ValidationError: Message does not belong to the thread; ValidationError: Thread does not belong to the patient.

update · PUT

PUT /api/v1/patient/{patient_external_id}/thread/{thread_external_id}/note/{external_id}/ — action update. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location	Parameter	Type	Required
path	patient_external_id	router lookup string; semantic ID validation requires handler/schema review	true
path	thread_external_id	router lookup string; semantic ID validation requires handler/schema review	true
path	external_id	router lookup string; semantic ID validation requires handler/schema review	true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location	Field	Declared/inferred read type	Requiredness evidence
query	`encounter`	not declared at read site	not established

request: NoteMessageUpdateSpec. Declared fields below; inherited fields are retained in the schema inventory.

Field	Type	Required	Constraints
meta	dict	false	No extra constraint extracted
id	UUID4 \| None	false	No extra constraint extracted
message	str	true	No extra constraint extracted

response: NoteMessageReadSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

Declared refusal/error evidence: PermissionDenied: Permission denied to user; PermissionDenied: Cannot Update Message Created by Other User; ValidationError: Message does not belong to the thread; ValidationError: Thread does not belong to the patient; PermissionDenied: You do not have permission for this action.

partial_update · PATCH

PATCH /api/v1/patient/{patient_external_id}/thread/{thread_external_id}/note/{external_id}/ — action partial_update. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location	Parameter	Type	Required
path	patient_external_id	router lookup string; semantic ID validation requires handler/schema review	true
path	thread_external_id	router lookup string; semantic ID validation requires handler/schema review	true
path	external_id	router lookup string; semantic ID validation requires handler/schema review	true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location	Field	Declared/inferred read type	Requiredness evidence
query	`encounter`	not declared at read site	not established

request: NoteMessageUpdateSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

response: NoteMessageReadSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

Observed authorization checks: can_view_clinical_data, can_view_encounter_clinical_data. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Permission denied to user; ValidationError: Thread does not belong to the patient; PermissionDenied: Cannot Update Message Created by Other User; ValidationError: Message does not belong to the thread.

Integration review checklist

Confirm the installed route and full schema; review authentication, organization/facility scoping, all accepted fields, value-state and date/time semantics, idempotency, pagination, response/exception branches and the allowed correction/reversal workflow. Test positive and negative cases with synthetic data. This source reference does not establish external certification or replace an illustrated user procedure.

Pinned source evidence

Links require access to the private source repository.