← Technical API reference

Backend resource · STATIC DECLARATIONS

Questionnaire Response API reference · mansoq-core-teleicu

Static source contract for Questionnaire Response: 4 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-teleicu at /api/v1/patient/{patient_external_id}/questionnaire_response/. verified core mount in config/urls.py This is an alternative core contract, not proof that the primary core uses the same behavior. 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}/questionnaire_response/ list declared/inherited method
GET /api/v1/patient/{patient_external_id}/questionnaire_response/{external_id}/ retrieve declared/inherited method
PUT /api/v1/patient/{patient_external_id}/questionnaire_response/{external_id}/ update declared/inherited method
PATCH /api/v1/patient/{patient_external_id}/questionnaire_response/{external_id}/ partial_update declared/inherited method

list · GET

GET /api/v1/patient/{patient_external_id}/questionnaire_response/ — 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

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

Location Field Declared/inferred read type Requiredness evidence
query questionnaire_slugs not declared at read site not established
query encounter not declared at read site direct indexing; validation may be upstream

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

Field Type Required Constraints
meta dict false No extra constraint extracted
id UUID4 true No extra constraint extracted
status str true No extra constraint extracted
questionnaire QuestionnaireReadSpec true No extra constraint extracted
subject_id str true No extra constraint extracted
responses list true No extra constraint extracted
encounter str | None false No extra constraint extracted
structured_responses dict true No extra constraint extracted
structured_response_type str true No extra constraint extracted
created_by UserSpec false No extra constraint extracted
updated_by UserSpec false No extra constraint extracted
created_date datetime | None false No extra constraint extracted
modified_date datetime | None false No extra constraint extracted

Observed authorization checks: can_view_patient_questionnaire_responses, 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: You do not have permission to view questionnaire responses.

retrieve · GET

GET /api/v1/patient/{patient_external_id}/questionnaire_response/{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 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 questionnaire_slugs not declared at read site not established
query encounter not declared at read site direct indexing; validation may be upstream

response: QuestionnaireResponseReadSpec. 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_patient_questionnaire_responses, 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: You do not have permission to view questionnaire responses.

update · PUT

PUT /api/v1/patient/{patient_external_id}/questionnaire_response/{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 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 questionnaire_slugs not declared at read site not established
query encounter not declared at read site direct indexing; validation may be upstream

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

Field Type Required Constraints
meta dict false No extra constraint extracted
status QuestionnaireResponseStatusChoices false No extra constraint extracted

response: QuestionnaireResponseReadSpec. 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_patient_questionnaire_responses, can_view_clinical_data, can_view_encounter_clinical_data, can_submit_encounter_questionnaire_obj, can_submit_questionnaire_patient_obj. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: You do not have permission to view questionnaire responses; PermissionDenied: Questionnaire Response cannot be edited; PermissionDenied: Permission Denied to update encounter questionnaire; PermissionDenied: Permission Denied to update patient questionnaire.

partial_update · PATCH

PATCH /api/v1/patient/{patient_external_id}/questionnaire_response/{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 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 questionnaire_slugs not declared at read site not established
query encounter not declared at read site direct indexing; validation may be upstream

request: QuestionnaireResponseUpdate. 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: QuestionnaireResponseReadSpec. 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_patient_questionnaire_responses, can_view_clinical_data, can_view_encounter_clinical_data, can_submit_encounter_questionnaire_obj, can_submit_questionnaire_patient_obj. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: You do not have permission to view questionnaire responses; PermissionDenied: Questionnaire Response cannot be edited; PermissionDenied: Permission Denied to update encounter questionnaire; PermissionDenied: Permission Denied to update patient questionnaire.

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.