MANSOQ Knowledge
← Technical API reference

Backend resource · STATIC DECLARATIONS

Observation API reference · mansoq-core-teleicu

Static source contract for Observation: 3 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}/observation/. 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}/observation/ list declared/inherited method
GET /api/v1/patient/{patient_external_id}/observation/{external_id}/ retrieve declared/inherited method
POST /api/v1/patient/{patient_external_id}/observation/analyse/ analyse @action declaration

list · GET

GET /api/v1/patient/{patient_external_id}/observation/ — 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 encounter not declared at read site not established

response: ObservationReadSpec. 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 description: Unique ID in the system
status ObservationStatus true description: Status of the observation (final or amended)
category Coding | None false No extra constraint extracted
main_code Coding | None false No extra constraint extracted
alternate_coding CodeableConcept | None false No extra constraint extracted
subject_type SubjectType false No extra constraint extracted
encounter UUID4 | None false No extra constraint extracted
effective_datetime datetime true No extra constraint extracted
performer Performer | None false No extra constraint extracted
value_type QuestionType true No extra constraint extracted
value QuestionnaireSubmitResultValue true No extra constraint extracted
note str | None false No extra constraint extracted
body_site ValueSetBoundCoding[MANSOQ_BODY_SITE_VALUESET.slug] | None false No extra constraint extracted
method ValueSetBoundCoding[MANSOQ_OBSERVATION_COLLECTION_METHOD.slug] | None false No extra constraint extracted
reference_range list[ReferenceRange] false No extra constraint extracted
interpretation dict false No extra constraint extracted
parent UUID4 | None false No extra constraint extracted
questionnaire_response UUID4 | None false No extra constraint extracted
component list[Component] false No extra constraint extracted
created_by UserSpec false No extra constraint extracted
updated_by UserSpec false No extra constraint extracted
data_entered_by UserSpec | None false 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.

retrieve · GET

GET /api/v1/patient/{patient_external_id}/observation/{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 encounter not declared at read site not established

response: ObservationRetrieveSpec. 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 description: Unique ID in the system
status ObservationStatus true description: Status of the observation (final or amended)
category Coding | None false No extra constraint extracted
main_code Coding | None false No extra constraint extracted
alternate_coding CodeableConcept | None false No extra constraint extracted
subject_type SubjectType false No extra constraint extracted
encounter UUID4 | None false No extra constraint extracted
effective_datetime datetime true No extra constraint extracted
performer Performer | None false No extra constraint extracted
value_type QuestionType true No extra constraint extracted
value QuestionnaireSubmitResultValue true No extra constraint extracted
note str | None false No extra constraint extracted
body_site ValueSetBoundCoding[MANSOQ_BODY_SITE_VALUESET.slug] | None false No extra constraint extracted
method ValueSetBoundCoding[MANSOQ_OBSERVATION_COLLECTION_METHOD.slug] | None false No extra constraint extracted
reference_range list[ReferenceRange] false No extra constraint extracted
interpretation dict false No extra constraint extracted
parent UUID4 | None false No extra constraint extracted
questionnaire_response UUID4 | None false No extra constraint extracted
component list[Component] false No extra constraint extracted
created_by UserSpec false No extra constraint extracted
updated_by UserSpec false No extra constraint extracted
data_entered_by UserSpec | None false No extra constraint extracted
observation_definition dict | None false 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.

analyse · POST

POST /api/v1/patient/{patient_external_id}/observation/analyse/ — action analyse. 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 encounter not declared at read site not established

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

Field Type Required Constraints
codes list[Coding] true min_length: 1; max_length: 20
page_size int false le: 30

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.

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.