MANSOQ Knowledge
← Technical API reference

Backend resource · STATIC DECLARATIONS

Insurance Plan Coverage API reference · mansoq-nhcx

Static source contract for Insurance Plan Coverage: 3 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-coverage/. 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-coverage/{external_id}/ retrieve declared/inherited method
GET /api/{installed_plugin_prefix}/insurance-plan-coverage/{external_id}/extensions/ extensions @action declaration
GET /api/{installed_plugin_prefix}/insurance-plan-coverage/{external_id}/benefits/ benefits @action declaration

retrieve · GET

GET /api/{installed_plugin_prefix}/insurance-plan-coverage/{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: InsurancePlanCoverageDetailSpec. 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_element_id str | None false No extra constraint extracted
type dict | None false No extra constraint extracted
type_code str | None false No extra constraint extracted
type_display str | None false No extra constraint extracted
n_benefits int | None 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

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-coverage/{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.

benefits · GET

GET /api/{installed_plugin_prefix}/insurance-plan-coverage/{external_id}/benefits/ — action benefits. 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.