← Technical API reference

Backend resource · STATIC DECLARATIONS

Dispense Order API reference · mansoq-core-teleicu

Static source contract for Dispense Order: 6 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/facility/{facility_external_id}/order/dispense/. 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/facility/{facility_external_id}/order/dispense/ list declared/inherited method
POST /api/v1/facility/{facility_external_id}/order/dispense/ create declared/inherited method
GET /api/v1/facility/{facility_external_id}/order/dispense/{external_id}/ retrieve declared/inherited method
PUT /api/v1/facility/{facility_external_id}/order/dispense/{external_id}/ update declared/inherited method
PATCH /api/v1/facility/{facility_external_id}/order/dispense/{external_id}/ partial_update declared/inherited method
POST /api/v1/facility/{facility_external_id}/order/dispense/upsert/ upsert @action declaration

list · GET

GET /api/v1/facility/{facility_external_id}/order/dispense/ — action list. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

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

response: MedicationDispenseOrderReadSpec. 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 MedicationDispenseOrderStatusOptions true No extra constraint extracted
name str | None false No extra constraint extracted
note str | None false No extra constraint extracted
patient dict false No extra constraint extracted
location dict true 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_as_pharmacist, can_list_facility_supply_delivery. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: Location is required for non-pharmacists; PermissionDenied: You do not have permission to read dispense order.

create · POST

POST /api/v1/facility/{facility_external_id}/order/dispense/ — action create. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

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

request: MedicationDispenseOrderWriteSpec. 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 MedicationDispenseOrderStatusOptions true No extra constraint extracted
name str | None false No extra constraint extracted
note str | None false No extra constraint extracted
patient UUID4 true No extra constraint extracted
location UUID4 true No extra constraint extracted

response: MedicationDispenseOrderRetrieveSpec. 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 MedicationDispenseOrderStatusOptions true No extra constraint extracted
name str | None false No extra constraint extracted
note str | None false No extra constraint extracted
patient dict false No extra constraint extracted
location dict true No extra constraint extracted
created_date datetime.datetime true No extra constraint extracted
modified_date datetime.datetime true No extra constraint extracted
created_by dict | None false No extra constraint extracted
updated_by dict | None false No extra constraint extracted

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

Declared refusal/error evidence: ValidationError: Location is required for non-pharmacists; PermissionDenied: You do not have permission to read dispense order; PermissionDenied: You do not have permission to create dispense order; ValidationError: Location must be in the same facility.

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/facility/{facility_external_id}/order/dispense/{external_id}/ — action retrieve. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

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

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

Declared refusal/error evidence: ValidationError: Location is required for non-pharmacists; PermissionDenied: You do not have permission to read dispense order.

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/facility/{facility_external_id}/order/dispense/{external_id}/ — action update. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

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

request: BaseMedicationDispenseOrderSpec. 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 MedicationDispenseOrderStatusOptions true No extra constraint extracted
name str | None false No extra constraint extracted
note str | None false No extra constraint extracted

response: MedicationDispenseOrderRetrieveSpec. 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_as_pharmacist, can_list_facility_supply_delivery, can_write_facility_supply_delivery. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: Location is required for non-pharmacists; PermissionDenied: You do not have permission to read dispense order; PermissionDenied: You do not have permission to update dispense order; ValidationError: Dispense order already abandoned or entered in error; ValidationError: Completed dispense order can only be cancelled.

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/facility/{facility_external_id}/order/dispense/{external_id}/ — action partial_update. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

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

request: BaseMedicationDispenseOrderSpec. 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: MedicationDispenseOrderRetrieveSpec. 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_as_pharmacist, can_list_facility_supply_delivery. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: Location is required for non-pharmacists; PermissionDenied: You do not have permission to read dispense order; PermissionDenied: You do not have permission to update dispense order; ValidationError: Dispense order already abandoned or entered in error; ValidationError: Completed dispense order can only be cancelled.

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.

upsert · POST

POST /api/v1/facility/{facility_external_id}/order/dispense/upsert/ — action upsert. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
path facility_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
body datapoints not declared at read site not established
query location not declared at read site direct indexing; validation may be upstream
query include_children not declared at read site not established

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

Explicit response statuses in observed code: 400. Other branches/framework exception handling may differ.

Declared refusal/error evidence: RestFrameworkValidationError: Invalid request data; RestFrameworkValidationError: No datapoints provided; RestFrameworkValidationError: Too many datapoints provided; ValidationError: Location is required for non-pharmacists; PermissionDenied: You do not have permission to read dispense order; PermissionDenied: You do not have permission to update dispense order; ValidationError: Dispense order already abandoned or entered in error; ValidationError: Completed dispense order can only be cancelled; PermissionDenied: You do not have permission to create dispense order; ValidationError: Location must be in the same facility.

Conditional gates: conditional/computed expression; inspect pinned declaration comparison settings.MAX_DATAPOINTS_PER_UPSERT.

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.