Backend resource · STATIC DECLARATIONS

Specimen Definition API reference · mansoq-core

Static source contract for Specimen Definition: 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 at /api/v1/facility/{facility_external_id}/specimen_definition/. 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/facility/{facility_external_id}/specimen_definition/`	list	declared/inherited method
POST	`/api/v1/facility/{facility_external_id}/specimen_definition/`	create	declared/inherited method
GET	`/api/v1/facility/{facility_external_id}/specimen_definition/{slug}/`	retrieve	declared/inherited method
PUT	`/api/v1/facility/{facility_external_id}/specimen_definition/{slug}/`	update	declared/inherited method
PATCH	`/api/v1/facility/{facility_external_id}/specimen_definition/{slug}/`	partial_update	declared/inherited method
POST	`/api/v1/facility/{facility_external_id}/specimen_definition/upsert/`	upsert	@action declaration

list · GET

GET /api/v1/facility/{facility_external_id}/specimen_definition/ — 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

response: SpecimenDefinitionReadSpec. 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
title	str	true	No extra constraint extracted
derived_from_uri	str \| None	false	No extra constraint extracted
status	SpecimenDefinitionStatusOptions	true	No extra constraint extracted
description	str	true	No extra constraint extracted
type_collected	ValueSetBoundCoding[SPECIMEN_TYPE_CODE_VALUESET.slug]	true	No extra constraint extracted
patient_preparation	list[ValueSetBoundCoding[PREPARE_PATIENT_PRIOR_SPECIMEN_CODE_VALUESET.slug]]	false	No extra constraint extracted
collection	ValueSetBoundCoding[SPECIMEN_COLLECTION_CODE_VALUESET.slug] \| None	false	No extra constraint extracted
type_tested	TypeTestedSpec \| None	false	No extra constraint extracted
version	int \| None	false	No extra constraint extracted
slug_config	dict	true	No extra constraint extracted
slug	str	true	No extra constraint extracted

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

Declared refusal/error evidence: PermissionDenied: Access Denied to Specimen Definition.

create · POST

POST /api/v1/facility/{facility_external_id}/specimen_definition/ — 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

request: SpecimenDefinitionWriteSpec. 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
title	str	true	No extra constraint extracted
derived_from_uri	str \| None	false	No extra constraint extracted
status	SpecimenDefinitionStatusOptions	true	No extra constraint extracted
description	str	true	No extra constraint extracted
type_collected	ValueSetBoundCoding[SPECIMEN_TYPE_CODE_VALUESET.slug]	true	No extra constraint extracted
patient_preparation	list[ValueSetBoundCoding[PREPARE_PATIENT_PRIOR_SPECIMEN_CODE_VALUESET.slug]]	false	No extra constraint extracted
collection	ValueSetBoundCoding[SPECIMEN_COLLECTION_CODE_VALUESET.slug] \| None	false	No extra constraint extracted
type_tested	TypeTestedSpec \| None	false	No extra constraint extracted
slug_value	SlugType	true	No extra constraint extracted

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

Declared refusal/error evidence: PermissionDenied: Access Denied to Specimen Definition; ValidationError: Specimen Definition with this slug already exists..

retrieve · GET

GET /api/v1/facility/{facility_external_id}/specimen_definition/{slug}/ — 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	slug	router lookup string; semantic ID validation requires handler/schema review	true

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

Declared refusal/error evidence: PermissionDenied: Access Denied to Specimen Definition.

update · PUT

PUT /api/v1/facility/{facility_external_id}/specimen_definition/{slug}/ — 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	slug	router lookup string; semantic ID validation requires handler/schema review	true

request: SpecimenDefinitionWriteSpec. 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: SpecimenDefinitionReadSpec. 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.

Declared refusal/error evidence: PermissionDenied: Access Denied to Specimen Definition; ValidationError: Specimen Definition with this slug already exists..

partial_update · PATCH

PATCH /api/v1/facility/{facility_external_id}/specimen_definition/{slug}/ — 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	slug	router lookup string; semantic ID validation requires handler/schema review	true

request: SpecimenDefinitionWriteSpec. 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: SpecimenDefinitionReadSpec. 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_facility_specimen_definition. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Access Denied to Specimen Definition; ValidationError: Specimen Definition with this slug already exists..

upsert · POST

POST /api/v1/facility/{facility_external_id}/specimen_definition/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

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; PermissionDenied: Access Denied to Specimen Definition; ValidationError: Specimen Definition with this slug already exists..

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

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.