MANSOQ Backend resource · STATIC DECLARATIONS
Value Set API reference · mansoq-core
Static source contract for Value Set: 19 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/valueset/. 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/valueset/ |
list | declared/inherited method |
| POST | /api/v1/valueset/ |
create | declared/inherited method |
| GET | /api/v1/valueset/{slug}/ |
retrieve | declared/inherited method |
| PUT | /api/v1/valueset/{slug}/ |
update | declared/inherited method |
| PATCH | /api/v1/valueset/{slug}/ |
partial_update | declared/inherited method |
| DELETE | /api/v1/valueset/{slug}/ |
destroy | declared/inherited method |
| POST | /api/v1/valueset/upsert/ |
upsert | @action declaration |
| POST | /api/v1/valueset/{slug}/expand/ |
expand | @action declaration |
| POST | /api/v1/valueset/preview_search/ |
preview_search | @action declaration |
| POST | /api/v1/valueset/{slug}/validate_code/ |
validate_code | @action declaration |
| POST | /api/v1/valueset/lookup_code/ |
lookup_code | @action declaration |
| GET | /api/v1/valueset/{slug}/favourites/ |
favourites | @action declaration |
| POST | /api/v1/valueset/{slug}/add_favourite/ |
add_favourite | @action declaration |
| POST | /api/v1/valueset/{slug}/remove_favourite/ |
remove_favourite | @action declaration |
| POST | /api/v1/valueset/{slug}/clear_favourites/ |
clear_favourites | @action declaration |
| POST | /api/v1/valueset/{slug}/add_recent_view/ |
add_recent_view | @action declaration |
| POST | /api/v1/valueset/{slug}/remove_recent_view/ |
remove_recent_view | @action declaration |
| GET | /api/v1/valueset/{slug}/recent_views/ |
recent_views | @action declaration |
| POST | /api/v1/valueset/{slug}/clear_recent_views/ |
clear_recent_views | @action declaration |
list · GET
GET /api/v1/valueset/ — action list. static contract extracted; runtime/permission/payload behavior review pending.
response: ValueSetReadSpec. Declared fields below; inherited fields are retained in the schema inventory.
| Field | Type | Required | Constraints |
|---|---|---|---|
| meta | dict | false | No extra constraint extracted |
| id | UUID4 | false | No extra constraint extracted |
| slug | SlugType | true | No extra constraint extracted |
| name | str | true | No extra constraint extracted |
| description | str | true | No extra constraint extracted |
| compose | ValueSetCompose | true | No extra constraint extracted |
| status | ValueSetStatusOptions | true | No extra constraint extracted |
| is_system_defined | bool | false | No extra constraint extracted |
| created_by | dict | None | false | No extra constraint extracted |
| updated_by | dict | None | false | No extra constraint extracted |
Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.
create · POST
POST /api/v1/valueset/ — action create. static contract extracted; runtime/permission/payload behavior review pending.
Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):
| Location | Field | Declared/inferred read type | Requiredness evidence |
|---|---|---|---|
| body | form_submission |
not declared at read site | not established |
request: ValueSetSpec. Declared fields below; inherited fields are retained in the schema inventory.
| Field | Type | Required | Constraints |
|---|---|---|---|
| meta | dict | false | No extra constraint extracted |
| id | UUID4 | false | No extra constraint extracted |
| slug | SlugType | true | No extra constraint extracted |
| name | str | true | No extra constraint extracted |
| description | str | true | No extra constraint extracted |
| compose | ValueSetCompose | true | No extra constraint extracted |
| status | ValueSetStatusOptions | true | No extra constraint extracted |
| is_system_defined | bool | false | No extra constraint extracted |
response: ValueSetReadSpec. 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.
Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.
retrieve · GET
GET /api/v1/valueset/{slug}/ — action retrieve. static contract extracted; runtime/permission/payload behavior review pending.
Path and deployment-context parameters:
| Location | Parameter | Type | Required |
|---|---|---|---|
| path | slug | router lookup string; semantic ID validation requires handler/schema review | true |
response: ValueSetReadSpec. 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.
Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.
update · PUT
PUT /api/v1/valueset/{slug}/ — action update. static contract extracted; runtime/permission/payload behavior review pending.
Path and deployment-context parameters:
| Location | Parameter | Type | Required |
|---|---|---|---|
| path | slug | router lookup string; semantic ID validation requires handler/schema review | true |
request: ValueSetSpec. 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: ValueSetReadSpec. 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.
Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.
partial_update · PATCH
PATCH /api/v1/valueset/{slug}/ — action partial_update. static contract extracted; runtime/permission/payload behavior review pending.
Path and deployment-context parameters:
| Location | Parameter | Type | Required |
|---|---|---|---|
| path | slug | router lookup string; semantic ID validation requires handler/schema review | true |
request: ValueSetSpec. 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: ValueSetReadSpec. 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.
Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.
destroy · DELETE
DELETE /api/v1/valueset/{slug}/ — action destroy. static contract extracted; runtime/permission/payload behavior review pending.
Path and deployment-context parameters:
| Location | Parameter | Type | Required |
|---|---|---|---|
| path | slug | router lookup string; semantic ID validation requires handler/schema review | true |
Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.
Explicit response statuses in observed code: status.HTTP_204_NO_CONTENT. Other branches/framework exception handling may differ.
upsert · POST
POST /api/v1/valueset/upsert/ — action upsert. static contract extracted; runtime/permission/payload behavior review pending.
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 |
| body | form_submission |
not declared at read site | not established |
Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.
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.
Conditional gates: conditional/computed expression; inspect pinned declaration comparison settings.MAX_DATAPOINTS_PER_UPSERT.
expand · POST
POST /api/v1/valueset/{slug}/expand/ — action expand. static contract extracted; runtime/permission/payload behavior review pending.
Path and deployment-context parameters:
| Location | Parameter | Type | Required |
|---|---|---|---|
| path | slug | router lookup string; semantic ID validation requires handler/schema review | true |
decorator request: ExpandRequest. Declared fields below; inherited fields are retained in the schema inventory.
| Field | Type | Required | Constraints |
|---|---|---|---|
| search | str | false | No extra constraint extracted |
| count | int | false | gt: 0; lt: 100 |
| display_language | str | false | No extra constraint extracted |
Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.
preview_search · POST
POST /api/v1/valueset/preview_search/ — action preview_search. static contract extracted; runtime/permission/payload behavior review pending.
Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):
| Location | Field | Declared/inferred read type | Requiredness evidence |
|---|---|---|---|
| query | search |
not declared at read site | not established |
| query | count |
not declared at read site | not established |
decorator request: ValueSetSpec. 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.
Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.
validate_code · POST
POST /api/v1/valueset/{slug}/validate_code/ — action validate_code. static contract extracted; runtime/permission/payload behavior review pending.
Path and deployment-context parameters:
| Location | Parameter | Type | Required |
|---|---|---|---|
| path | slug | router lookup string; semantic ID validation requires handler/schema review | true |
decorator request: Coding. Declared fields below; inherited fields are retained in the schema inventory.
| Field | Type | Required | Constraints |
|---|---|---|---|
| system | str | None | false | No extra constraint extracted |
| version | str | None | false | No extra constraint extracted |
| code | str | true | No extra constraint extracted |
| display | str | None | false | No extra constraint extracted |
Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.
lookup_code · POST
POST /api/v1/valueset/lookup_code/ — action lookup_code. static contract extracted; runtime/permission/payload behavior review pending.
Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):
| Location | Field | Declared/inferred read type | Requiredness evidence |
|---|---|---|---|
| body | code |
not declared at read site | direct indexing; validation may be upstream |
| body | system |
not declared at read site | direct indexing; validation may be upstream |
decorator request: Coding. 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.
Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.
Explicit response statuses in observed code: 404. Other branches/framework exception handling may differ.
favourites · GET
GET /api/v1/valueset/{slug}/favourites/ — action favourites. static contract extracted; runtime/permission/payload behavior review pending.
Path and deployment-context parameters:
| Location | Parameter | Type | Required |
|---|---|---|---|
| path | slug | router lookup string; semantic ID validation requires handler/schema review | true |
Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.
add_favourite · POST
POST /api/v1/valueset/{slug}/add_favourite/ — action add_favourite. static contract extracted; runtime/permission/payload behavior review pending.
Path and deployment-context parameters:
| Location | Parameter | Type | Required |
|---|---|---|---|
| path | slug | router lookup string; semantic ID validation requires handler/schema review | true |
Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.
Declared refusal/error evidence: ValidationError: Invalid code value.
remove_favourite · POST
POST /api/v1/valueset/{slug}/remove_favourite/ — action remove_favourite. static contract extracted; runtime/permission/payload behavior review pending.
Path and deployment-context parameters:
| Location | Parameter | Type | Required |
|---|---|---|---|
| path | slug | router lookup string; semantic ID validation requires handler/schema review | true |
Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.
clear_favourites · POST
POST /api/v1/valueset/{slug}/clear_favourites/ — action clear_favourites. static contract extracted; runtime/permission/payload behavior review pending.
Path and deployment-context parameters:
| Location | Parameter | Type | Required |
|---|---|---|---|
| path | slug | router lookup string; semantic ID validation requires handler/schema review | true |
Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.
add_recent_view · POST
POST /api/v1/valueset/{slug}/add_recent_view/ — action add_recent_view. static contract extracted; runtime/permission/payload behavior review pending.
Path and deployment-context parameters:
| Location | Parameter | Type | Required |
|---|---|---|---|
| path | slug | router lookup string; semantic ID validation requires handler/schema review | true |
decorator request: MinimalCodeConcept. Declared fields below; inherited fields are retained in the schema inventory.
| Field | Type | Required | Constraints |
|---|---|---|---|
| display | str | true | No extra constraint extracted |
| system | str | true | No extra constraint extracted |
| code | str | true | No extra constraint extracted |
| designation | list | None | false | No extra constraint extracted |
Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.
Declared refusal/error evidence: ValidationError: Invalid code value.
remove_recent_view · POST
POST /api/v1/valueset/{slug}/remove_recent_view/ — action remove_recent_view. static contract extracted; runtime/permission/payload behavior review pending.
Path and deployment-context parameters:
| Location | Parameter | Type | Required |
|---|---|---|---|
| path | slug | router lookup string; semantic ID validation requires handler/schema review | true |
decorator request: MinimalCodeConcept. 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.
Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.
recent_views · GET
GET /api/v1/valueset/{slug}/recent_views/ — action recent_views. static contract extracted; runtime/permission/payload behavior review pending.
Path and deployment-context parameters:
| Location | Parameter | Type | Required |
|---|---|---|---|
| path | slug | router lookup string; semantic ID validation requires handler/schema review | true |
Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.
clear_recent_views · POST
POST /api/v1/valueset/{slug}/clear_recent_views/ — action clear_recent_views. static contract extracted; runtime/permission/payload behavior review pending.
Path and deployment-context parameters:
| Location | Parameter | Type | Required |
|---|---|---|---|
| path | slug | router lookup string; semantic ID validation requires handler/schema review | true |
Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.
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.
- repositories/platform/mansoq-core/config/api_router.py:220
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/valueset.py:36
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:168
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/valueset.py:65
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:161
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:330
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:158
- repositories/platform/mansoq-core/mansoq/emr/resources/valueset/spec.py:61
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:136
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:133
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:142
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:130
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:346
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:98
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:139
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:325
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:352
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:349
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:95
- repositories/platform/mansoq-core/mansoq/emr/resources/valueset/spec.py:30
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:83
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:80
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:77
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:214
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:225
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:228
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:201
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:335
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:180
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:222
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:218
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:261
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:250
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:258
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:253
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:271
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/valueset.py:76
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/valueset.py:25
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/valueset.py:83
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/valueset.py:98
- repositories/platform/mansoq-core/mansoq/emr/resources/common/coding.py:4
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/valueset.py:105
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/valueset.py:127
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/valueset.py:71
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/valueset.py:144
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/valueset.py:169
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/valueset.py:190
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/valueset.py:208
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/valueset.py:68
- repositories/platform/mansoq-core/mansoq/emr/fhir/resources/code_concept.py:24
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/valueset.py:221
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/valueset.py:230
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/valueset.py:237