Service Request API reference · mansoq-core-teleicu

Declared route and availability

This resource is declared in mansoq-core-teleicu at /api/v1/facility/{facility_external_id}/service_request/. 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

list · GET

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

Path and deployment-context parameters:

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

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

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

Declared refusal/error evidence: ValidationError: Location or encounter is required; PermissionDenied: You do not have permission to view service requests for this location; PermissionDenied: You do not have permission to view service requests for 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/facility/{facility_external_id}/service_request/ — action create. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

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

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

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

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

Declared refusal/error evidence: ValidationError: Location or encounter is required; PermissionDenied: You do not have permission to view service requests for this location; PermissionDenied: You do not have permission to view service requests for this encounter; PermissionDenied: You do not have permission to create a service request for this encounter; ValidationError (dynamic detail; inspect source); ValidationError: Healthcare Service must be from the same facility; ValidationError: requester must be a member of the 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}/service_request/{external_id}/ — action retrieve. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

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

response: ServiceRequestRetrieveSpec. 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_list_location_service_request, can_view_service_request_for_encounter, can_read_service_request. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: Location or encounter is required; PermissionDenied: You do not have permission to view service requests for this location; PermissionDenied: You do not have permission to view service requests for this encounter; PermissionDenied: You do not have permission to read this service request.

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

Path and deployment-context parameters:

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

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

response: ServiceRequestRetrieveSpec. 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_list_location_service_request, can_view_service_request_for_encounter, can_write_service_request. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: Location or encounter is required; PermissionDenied: You do not have permission to view service requests for this location; PermissionDenied: You do not have permission to view service requests for this encounter; PermissionDenied: You do not have permission to update this service request; ValidationError: Service request is completed; ValidationError: Cannot update a cancelled service request; ValidationError: Use the cancel API to cancel the service request; ValidationError (dynamic detail; inspect source); ValidationError: Healthcare Service must be from 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.

partial_update · PATCH

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

Path and deployment-context parameters:

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

request: ServiceRequestUpdateSpec. 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: ServiceRequestRetrieveSpec. 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_list_location_service_request, can_view_service_request_for_encounter, can_write_service_request. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: Location or encounter is required; PermissionDenied: You do not have permission to view service requests for this location; PermissionDenied: You do not have permission to view service requests for this encounter; PermissionDenied: You do not have permission to update this service request; ValidationError: Service request is completed; ValidationError: Cannot update a cancelled service request; ValidationError: Use the cancel API to cancel the service request.

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.

set_tags · POST

POST /api/v1/facility/{facility_external_id}/service_request/{external_id}/set_tags/ — action set_tags. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

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

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

Observed authorization checks: can_list_location_service_request, can_view_service_request_for_encounter, can_write_service_request, can_read_service_request. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: Location or encounter is required; PermissionDenied: You do not have permission to view service requests for this location; PermissionDenied: You do not have permission to view service requests for this encounter; RestFrameworkValidationError (dynamic detail; inspect source); PermissionDenied: You do not have permission to update this service request; PermissionDenied: You do not have permission to read this service request.

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.

remove_tags · POST

POST /api/v1/facility/{facility_external_id}/service_request/{external_id}/remove_tags/ — action remove_tags. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

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

body validation: TagRequest. 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.

decorator request: TagRequest. 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_list_location_service_request, can_view_service_request_for_encounter, can_write_service_request, can_read_service_request. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: Location or encounter is required; PermissionDenied: You do not have permission to view service requests for this location; PermissionDenied: You do not have permission to view service requests for this encounter; PermissionDenied: You do not have permission to update this service request; PermissionDenied: You do not have permission to read this service request.

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.

complete · POST

POST /api/v1/facility/{facility_external_id}/service_request/{external_id}/complete/ — action complete. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

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

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

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

Declared refusal/error evidence: ValidationError: Service request is completed; ValidationError: Service request is cancelled; ValidationError: Location or encounter is required; PermissionDenied: You do not have permission to view service requests for this location; PermissionDenied: You do not have permission to view service requests for this encounter; PermissionDenied: You do not have permission to update this service request.

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.

cancel · POST

POST /api/v1/facility/{facility_external_id}/service_request/{external_id}/cancel/ — action cancel. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

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

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

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

Declared refusal/error evidence: ValidationError: Service request is completed; ValidationError: Service request is already in a cancelled state; ValidationError: Invalid status; ValidationError: Location or encounter is required; PermissionDenied: You do not have permission to view service requests for this location; PermissionDenied: You do not have permission to view service requests for this encounter; PermissionDenied: You do not have permission to update this service request.

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.

apply_activity_definition · POST

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

Path and deployment-context parameters:

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

body validation: ServiceRequestUpdateSpec. 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.

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

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

Declared refusal/error evidence: ValidationError: Location or encounter is required; PermissionDenied: You do not have permission to view service requests for this location; PermissionDenied: You do not have permission to view service requests for this encounter; PermissionDenied: You do not have permission to update this service request; ValidationError: Service request is completed; ValidationError: Cannot update a cancelled service request; ValidationError: Use the cancel API to cancel the service request; ValidationError (dynamic detail; inspect source); ValidationError: Healthcare Service must be from 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.

create_specimen · POST

POST /api/v1/facility/{facility_external_id}/service_request/{external_id}/create_specimen/ — action create_specimen. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

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

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

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

Declared refusal/error evidence: ValidationError: Location or encounter is required; PermissionDenied: You do not have permission to view service requests for this location; PermissionDenied: You do not have permission to view service requests for this encounter; PermissionDenied: You do not have permission to create a specimen for 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_specimen_from_definition · POST

POST /api/v1/facility/{facility_external_id}/service_request/{external_id}/create_specimen_from_definition/ — action create_specimen_from_definition. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

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

body validation: SpecimenUpdateSpec. Declared fields below; inherited fields are retained in the schema inventory.

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

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

Declared refusal/error evidence: ValidationError: Location or encounter is required; PermissionDenied: You do not have permission to view service requests for this location; PermissionDenied: You do not have permission to view service requests for this encounter; PermissionDenied: You do not have permission to create a specimen for 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.