MANSOQ Backend resource · STATIC DECLARATIONS
Insurance Plan API reference · mansoq-nhcx
Static source contract for Insurance Plan: 7 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-nhcx at /api/{installed_plugin_prefix}/insurance-plan/. plugin/local mount; actual prefix and enablement require deployment verification 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/{installed_plugin_prefix}/insurance-plan/ |
list | declared/inherited method |
| GET | /api/{installed_plugin_prefix}/insurance-plan/{external_id}/ |
retrieve | declared/inherited method |
| POST | /api/{installed_plugin_prefix}/insurance-plan/request/ |
request | @action declaration |
| GET | /api/{installed_plugin_prefix}/insurance-plan/{external_id}/plans/ |
plans | @action declaration |
| GET | /api/{installed_plugin_prefix}/insurance-plan/{external_id}/coverages/ |
coverages | @action declaration |
| GET | /api/{installed_plugin_prefix}/insurance-plan/{external_id}/extensions/ |
extensions | @action declaration |
| GET | /api/{installed_plugin_prefix}/insurance-plan/{external_id}/questionnaires/ |
questionnaires | @action declaration |
list · GET
GET /api/{installed_plugin_prefix}/insurance-plan/ — action list. static contract extracted; runtime/permission/payload behavior review pending.
Path and deployment-context parameters:
| Location | Parameter | Type | Required |
|---|---|---|---|
| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |
response: InsurancePlanListSpec. 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 |
| fhir_id | str | None | false | No extra constraint extracted |
| identifier_system | str | None | false | No extra constraint extracted |
| identifier_value | str | None | false | No extra constraint extracted |
| status | str | None | false | No extra constraint extracted |
| type | list | dict | None | false | No extra constraint extracted |
| type_code | str | None | false | No extra constraint extracted |
| name | str | None | false | No extra constraint extracted |
| period_start | date | None | false | No extra constraint extracted |
| period_end | date | None | false | No extra constraint extracted |
| owned_by_name | str | None | false | No extra constraint extracted |
| administered_by_name | str | None | false | No extra constraint extracted |
| n_plans | int | None | false | No extra constraint extracted |
| n_coverages | int | None | false | No extra constraint extracted |
| n_benefits | int | None | false | No extra constraint extracted |
| n_questionnaires | int | None | false | No extra constraint extracted |
| created_date | datetime | None | false | No extra constraint extracted |
| modified_date | datetime | 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.
retrieve · GET
GET /api/{installed_plugin_prefix}/insurance-plan/{external_id}/ — action retrieve. static contract extracted; runtime/permission/payload behavior review pending.
Path and deployment-context parameters:
| Location | Parameter | Type | Required |
|---|---|---|---|
| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |
| path | external_id | router lookup string; semantic ID validation requires handler/schema review | true |
response: InsurancePlanRetrieveSpec. 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 |
| fhir_id | str | None | false | No extra constraint extracted |
| identifier_system | str | None | false | No extra constraint extracted |
| identifier_value | str | None | false | No extra constraint extracted |
| status | str | None | false | No extra constraint extracted |
| type | list | dict | None | false | No extra constraint extracted |
| type_code | str | None | false | No extra constraint extracted |
| name | str | None | false | No extra constraint extracted |
| period_start | date | None | false | No extra constraint extracted |
| period_end | date | None | false | No extra constraint extracted |
| owned_by_name | str | None | false | No extra constraint extracted |
| administered_by_name | str | None | false | No extra constraint extracted |
| n_plans | int | None | false | No extra constraint extracted |
| n_coverages | int | None | false | No extra constraint extracted |
| n_benefits | int | None | false | No extra constraint extracted |
| n_questionnaires | int | None | false | No extra constraint extracted |
| created_date | datetime | None | false | No extra constraint extracted |
| modified_date | datetime | None | false | No extra constraint extracted |
| additional_identifiers | list | None | false | No extra constraint extracted |
| alias | list | None | false | No extra constraint extracted |
| owned_by | dict | None | false | No extra constraint extracted |
| administered_by | dict | None | false | No extra constraint extracted |
| contact | list | None | false | No extra constraint extracted |
| plans | list[InsurancePlanPlanSpec] | false | No extra constraint extracted |
| n_conditions | int | None | false | No extra constraint extracted |
| n_exclusions | int | None | false | No extra constraint extracted |
| n_supporting_info_requirements | int | None | false | No extra constraint extracted |
| latest_request | UUID4 | None | false | No extra constraint extracted |
| latest_request_date | datetime | 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.
request · POST
POST /api/{installed_plugin_prefix}/insurance-plan/request/ — action request. static contract extracted; runtime/permission/payload behavior review pending.
Path and deployment-context parameters:
| Location | Parameter | Type | Required |
|---|---|---|---|
| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |
decorator request: InsurancePlanRequestBody. Declared fields below; inherited fields are retained in the schema inventory.
| Field | Type | Required | Constraints |
|---|---|---|---|
| policy | Policy | true | No extra constraint extracted |
| facility | str | true | 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.
Explicit response statuses in observed code: status.HTTP_200_OK. Other branches/framework exception handling may differ.
plans · GET
GET /api/{installed_plugin_prefix}/insurance-plan/{external_id}/plans/ — action plans. static contract extracted; runtime/permission/payload behavior review pending.
Path and deployment-context parameters:
| Location | Parameter | Type | Required |
|---|---|---|---|
| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |
| path | external_id | 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.
coverages · GET
GET /api/{installed_plugin_prefix}/insurance-plan/{external_id}/coverages/ — action coverages. static contract extracted; runtime/permission/payload behavior review pending.
Path and deployment-context parameters:
| Location | Parameter | Type | Required |
|---|---|---|---|
| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |
| path | external_id | 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.
extensions · GET
GET /api/{installed_plugin_prefix}/insurance-plan/{external_id}/extensions/ — action extensions. static contract extracted; runtime/permission/payload behavior review pending.
Path and deployment-context parameters:
| Location | Parameter | Type | Required |
|---|---|---|---|
| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |
| path | external_id | 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.
questionnaires · GET
GET /api/{installed_plugin_prefix}/insurance-plan/{external_id}/questionnaires/ — action questionnaires. static contract extracted; runtime/permission/payload behavior review pending.
Path and deployment-context parameters:
| Location | Parameter | Type | Required |
|---|---|---|---|
| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |
| path | external_id | 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/teleicu/mansoq-nhcx/nhcx/urls.py:30
- repositories/teleicu/mansoq-nhcx/nhcx/viewsets/insurance_plan.py:95
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:168
- repositories/teleicu/mansoq-nhcx/nhcx/viewsets/insurance_plan.py:103
- 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/teleicu/mansoq-nhcx/nhcx/specs/insurance_plan.py:315
- 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:325
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:77
- repositories/teleicu/mansoq-nhcx/nhcx/specs/insurance_plan.py:358
- repositories/teleicu/mansoq-nhcx/nhcx/viewsets/insurance_plan.py:108
- repositories/teleicu/mansoq-nhcx/nhcx/specs/insurance_plan.py:25
- repositories/teleicu/mansoq-nhcx/nhcx/viewsets/insurance_plan.py:176
- repositories/teleicu/mansoq-nhcx/nhcx/viewsets/insurance_plan.py:183
- repositories/teleicu/mansoq-nhcx/nhcx/viewsets/insurance_plan.py:192
- repositories/teleicu/mansoq-nhcx/nhcx/viewsets/insurance_plan.py:198