MANSOQ Knowledge
← Technical API reference

Backend resource · STATIC DECLARATIONS

Form Submission API reference · mansoq-core

Static source contract for Form Submission: 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/form_submission/. 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/form_submission/ list declared/inherited method
POST /api/v1/form_submission/ create declared/inherited method
GET /api/v1/form_submission/{external_id}/ retrieve declared/inherited method
PUT /api/v1/form_submission/{external_id}/ update declared/inherited method
PATCH /api/v1/form_submission/{external_id}/ partial_update declared/inherited method

list · GET

GET /api/v1/form_submission/ — action list. static contract extracted; runtime/permission/payload behavior review pending.

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 direct indexing; validation may be upstream
query patient not declared at read site direct indexing; validation may be upstream

response: FormSubmissionReadSpec. 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
status FormSubmissionStatusChoices true No extra constraint extracted
response_dump dict true No extra constraint extracted
created_date datetime.datetime true No extra constraint extracted
modified_date datetime.datetime | None false No extra constraint extracted
created_by UserSpec | None false No extra constraint extracted
updated_by UserSpec | None false No extra constraint extracted

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

Declared refusal/error evidence: ValidationError: Patient or encounter is required; PermissionDenied: You do not have permission to view this patient; PermissionDenied: You do not have permission to view this encounter.

Direct refusal present: the handler/helper contains a top-level raise. Review whether the operation is intentionally disabled or only performs validation before relying on it.

create · POST

POST /api/v1/form_submission/ — action create. static contract extracted; runtime/permission/payload behavior review pending.

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 direct indexing; validation may be upstream
query patient not declared at read site direct indexing; validation may be upstream
body form_submission not declared at read site not established

request: FormSubmissionWriteSpec. 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
status FormSubmissionStatusChoices true No extra constraint extracted
response_dump dict true No extra constraint extracted
questionnaire str true No extra constraint extracted
patient UUID4 true No extra constraint extracted
encounter UUID4 | None false No extra constraint extracted

response: FormSubmissionReadSpec. 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_submit_questionnaire_patient_obj, can_submit_encounter_questionnaire_obj. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: Patient or encounter is required; PermissionDenied: You do not have permission to view this patient; PermissionDenied: You do not have permission to view this encounter.

Direct refusal present: the handler/helper contains a top-level raise. Review whether the operation is intentionally disabled or only performs validation before relying on it.

retrieve · GET

GET /api/v1/form_submission/{external_id}/ — action retrieve. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
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 direct indexing; validation may be upstream
query patient not declared at read site direct indexing; validation may be upstream

response: FormSubmissionReadSpec. 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_submit_questionnaire_patient_obj, can_submit_encounter_questionnaire_obj. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: Patient or encounter is required; PermissionDenied: You do not have permission to view this patient; PermissionDenied: You do not have permission to view this encounter.

Direct refusal present: the handler/helper contains a top-level raise. Review whether the operation is intentionally disabled or only performs validation before relying on it.

update · PUT

PUT /api/v1/form_submission/{external_id}/ — action update. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
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 direct indexing; validation may be upstream
query patient not declared at read site direct indexing; validation may be upstream

request: FormSubmissionUpdateSpec. 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
status FormSubmissionStatusChoices true No extra constraint extracted
response_dump dict true No extra constraint extracted

response: FormSubmissionReadSpec. 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_submit_questionnaire_patient_obj, can_submit_encounter_questionnaire_obj. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: Patient or encounter is required; PermissionDenied: You do not have permission to view this patient; PermissionDenied: You do not have permission to view this encounter.

Direct refusal present: the handler/helper contains a top-level raise. Review whether the operation is intentionally disabled or only performs validation before relying on it.

partial_update · PATCH

PATCH /api/v1/form_submission/{external_id}/ — action partial_update. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
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 direct indexing; validation may be upstream
query patient not declared at read site direct indexing; validation may be upstream

request: FormSubmissionUpdateSpec. 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: FormSubmissionReadSpec. 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_submit_questionnaire_patient_obj, can_submit_encounter_questionnaire_obj. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: Patient or encounter is required; PermissionDenied: You do not have permission to view this patient; PermissionDenied: You do not have permission to view this encounter.

Direct refusal present: the handler/helper contains a top-level raise. Review whether the operation is intentionally disabled or only performs validation before relying on it.

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.