← Technical API reference

Backend resource · STATIC DECLARATIONS

Activity Definition API reference · mansoq-core-teleicu

Static source contract for Activity Definition: 11 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}/activity_definition/. 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}/activity_definition/ list declared/inherited method
POST /api/v1/facility/{facility_external_id}/activity_definition/ create declared/inherited method
GET /api/v1/facility/{facility_external_id}/activity_definition/{slug}/ retrieve declared/inherited method
PUT /api/v1/facility/{facility_external_id}/activity_definition/{slug}/ update declared/inherited method
PATCH /api/v1/facility/{facility_external_id}/activity_definition/{slug}/ partial_update declared/inherited method
GET /api/v1/facility/{facility_external_id}/activity_definition/favorite_lists/ favorite_lists @action declaration
POST /api/v1/facility/{facility_external_id}/activity_definition/{slug}/add_favorite/ add_favorite @action declaration
POST /api/v1/facility/{facility_external_id}/activity_definition/{slug}/remove_favorite/ remove_favorite @action declaration
POST /api/v1/facility/{facility_external_id}/activity_definition/upsert/ upsert @action declaration
POST /api/v1/facility/{facility_external_id}/activity_definition/{slug}/set_tags/ set_tags @action declaration
POST /api/v1/facility/{facility_external_id}/activity_definition/{slug}/remove_tags/ remove_tags @action declaration

list · GET

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

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

Location Field Declared/inferred read type Requiredness evidence
query category not declared at read site not established
query include_children not declared at read site not established

response: ActivityDefinitionReadSpec. 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 ActivityDefinitionStatusOptions true No extra constraint extracted
description str false No extra constraint extracted
usage str false No extra constraint extracted
classification ActivityDefinitionCategoryOptions true No extra constraint extracted
kind ActivityDefinitionKindOptions true No extra constraint extracted
code ValueSetBoundCoding[ACTIVITY_DEFINITION_PROCEDURE_CODE_VALUESET.slug] true No extra constraint extracted
body_site ValueSetBoundCoding[MANSOQ_BODY_SITE_VALUESET.slug] | None false No extra constraint extracted
diagnostic_report_codes list[ValueSetBoundCoding[MANSOQ_OBSERVATION_VALUSET.slug]] false No extra constraint extracted
version int | None false No extra constraint extracted
tags list[dict] false No extra constraint extracted
category dict | 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_activity_definition. Helper/queryset evidence is included; this is not proof of complete security review.

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

create · POST

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

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

Location Field Declared/inferred read type Requiredness evidence
query category not declared at read site not established
query include_children not declared at read site not established

request: ActivityDefinitionWriteSpec. 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 ActivityDefinitionStatusOptions true No extra constraint extracted
description str false No extra constraint extracted
usage str false No extra constraint extracted
classification ActivityDefinitionCategoryOptions true No extra constraint extracted
kind ActivityDefinitionKindOptions true No extra constraint extracted
code ValueSetBoundCoding[ACTIVITY_DEFINITION_PROCEDURE_CODE_VALUESET.slug] true No extra constraint extracted
body_site ValueSetBoundCoding[MANSOQ_BODY_SITE_VALUESET.slug] | None false No extra constraint extracted
diagnostic_report_codes list[ValueSetBoundCoding[MANSOQ_OBSERVATION_VALUSET.slug]] false No extra constraint extracted
locations list[UUID4] true No extra constraint extracted
specimen_requirements list[ExtendedSlugType] true No extra constraint extracted
observation_result_requirements list[ExtendedSlugType] true No extra constraint extracted
healthcare_service UUID4 | None true No extra constraint extracted
charge_item_definitions list[ExtendedSlugType] true No extra constraint extracted
category ExtendedSlugType | None true No extra constraint extracted
slug_value SlugType true No extra constraint extracted

response: ActivityDefinitionRetrieveSpec. 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 ActivityDefinitionStatusOptions true No extra constraint extracted
description str false No extra constraint extracted
usage str false No extra constraint extracted
classification ActivityDefinitionCategoryOptions true No extra constraint extracted
kind ActivityDefinitionKindOptions true No extra constraint extracted
code ValueSetBoundCoding[ACTIVITY_DEFINITION_PROCEDURE_CODE_VALUESET.slug] true No extra constraint extracted
body_site ValueSetBoundCoding[MANSOQ_BODY_SITE_VALUESET.slug] | None false No extra constraint extracted
diagnostic_report_codes list[ValueSetBoundCoding[MANSOQ_OBSERVATION_VALUSET.slug]] false No extra constraint extracted
version int | None false No extra constraint extracted
tags list[dict] false No extra constraint extracted
category dict | None false No extra constraint extracted
slug_config dict true No extra constraint extracted
slug str true No extra constraint extracted
specimen_requirements list[dict] true No extra constraint extracted
observation_result_requirements list[dict] true No extra constraint extracted
locations list[dict] true No extra constraint extracted
healthcare_service dict | None false No extra constraint extracted
charge_item_definitions list[dict] true No extra constraint extracted

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

Declared refusal/error evidence: PermissionDenied: Access Denied to Activity Definition; ValidationError: Activity Definition with this slug already exists.; ValidationError (dynamic detail; inspect source); ValidationError: Healthcare Service must be from the same facility.

retrieve · GET

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

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

Location Field Declared/inferred read type Requiredness evidence
query category not declared at read site not established
query include_children not declared at read site not established

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

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

update · PUT

PUT /api/v1/facility/{facility_external_id}/activity_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

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

Location Field Declared/inferred read type Requiredness evidence
query category not declared at read site not established
query include_children not declared at read site not established

request: ActivityDefinitionWriteSpec. 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: ActivityDefinitionRetrieveSpec. 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_activity_definition, can_write_facility_activity_definition. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Access Denied to Activity Definition; ValidationError: Activity Definition with this slug already exists.; ValidationError (dynamic detail; inspect source); ValidationError: Healthcare Service must be from the same facility.

partial_update · PATCH

PATCH /api/v1/facility/{facility_external_id}/activity_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

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

Location Field Declared/inferred read type Requiredness evidence
query category not declared at read site not established
query include_children not declared at read site not established

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

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

favorite_lists · GET

GET /api/v1/facility/{facility_external_id}/activity_definition/favorite_lists/ — action favorite_lists. 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 facility not declared at read site not established
query category not declared at read site not established
query include_children not declared at read site not established

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

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

add_favorite · POST

POST /api/v1/facility/{facility_external_id}/activity_definition/{slug}/add_favorite/ — action add_favorite. 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

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

Location Field Declared/inferred read type Requiredness evidence
query category not declared at read site not established
query include_children not declared at read site not established

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

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

remove_favorite · POST

POST /api/v1/facility/{facility_external_id}/activity_definition/{slug}/remove_favorite/ — action remove_favorite. 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

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

Location Field Declared/inferred read type Requiredness evidence
query category not declared at read site not established
query include_children not declared at read site not established

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

Declared refusal/error evidence: ValidationError: Favorite List not found; PermissionDenied: Access Denied to Activity Definition.

upsert · POST

POST /api/v1/facility/{facility_external_id}/activity_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
query category not declared at read site not established
query include_children not declared at read site not established

Observed authorization checks: can_list_facility_activity_definition, can_write_facility_activity_definition. 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; PermissionDenied: Access Denied to Activity Definition; ValidationError: Activity Definition with this slug already exists.; ValidationError (dynamic detail; inspect source); ValidationError: Healthcare Service must be from the same facility.

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

set_tags · POST

POST /api/v1/facility/{facility_external_id}/activity_definition/{slug}/set_tags/ — action set_tags. 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

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

Location Field Declared/inferred read type Requiredness evidence
query category not declared at read site not established
query include_children not declared at read site not established

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

Field Type Required Constraints
tags list[UUID4] false No extra constraint extracted

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

Declared refusal/error evidence: PermissionDenied: Access Denied to Activity Definition; RestFrameworkValidationError (dynamic detail; inspect source).

remove_tags · POST

POST /api/v1/facility/{facility_external_id}/activity_definition/{slug}/remove_tags/ — action remove_tags. 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

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

Location Field Declared/inferred read type Requiredness evidence
query category not declared at read site not established
query include_children not declared at read site not established

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_facility_activity_definition, can_write_facility_activity_definition. Helper/queryset evidence is included; this is not proof of complete security review.

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

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.