MANSOQ Knowledge
← Technical API reference

Backend resource · STATIC DECLARATIONS

Insurance Plan Benefit API reference · mansoq-nhcx

Static source contract for Insurance Plan Benefit: 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-nhcx at /api/{installed_plugin_prefix}/insurance-plan-benefit/. 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-benefit/ list declared/inherited method
GET /api/{installed_plugin_prefix}/insurance-plan-benefit/{external_id}/ retrieve declared/inherited method
GET /api/{installed_plugin_prefix}/insurance-plan-benefit/{external_id}/extensions/ extensions @action declaration
GET /api/{installed_plugin_prefix}/insurance-plan-benefit/{external_id}/requirements/ requirements @action declaration
GET /api/{installed_plugin_prefix}/insurance-plan-benefit/{external_id}/questionnaires/ questionnaires @action declaration
POST /api/{installed_plugin_prefix}/insurance-plan-benefit/lookup/ lookup @action declaration

list · GET

GET /api/{installed_plugin_prefix}/insurance-plan-benefit/ — 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: InsurancePlanBenefitListSpec. 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
type_code str | None false No extra constraint extracted
type_display str | None false No extra constraint extracted
coverage_type_code str | None false No extra constraint extracted
coverage_type_display str | None false No extra constraint extracted
plan_type_code str | None false No extra constraint extracted
plan_type_display str | None false No extra constraint extracted
plan_id UUID4 | None false No extra constraint extracted
specialty_category_code str | None false No extra constraint extracted
specialty_category_display str | None false No extra constraint extracted
min_cost Decimal | None false No extra constraint extracted
max_cost Decimal | None false No extra constraint extracted
max_limit_amount Decimal | None false No extra constraint extracted
cost_count int | None false No extra constraint extracted
qualifier_count int | None false No extra constraint extracted
authorization_required bool | None false No extra constraint extracted
is_day_care bool | None false No extra constraint extracted
implant_applicable bool | None false No extra constraint extracted
stratification_allowed bool | None false No extra constraint extracted
procedure_type str | None false No extra constraint extracted
has_stratification_qualifier bool | None false No extra constraint extracted
has_implant_qualifier bool | None false No extra constraint extracted
has_consumable_qualifier bool | None false No extra constraint extracted
has_questionnaire bool | None false No extra constraint extracted
requires_supporting_info bool | None false No extra constraint extracted
supporting_info_count int | None false No extra constraint extracted
condition_count int | None false No extra constraint extracted
exclusion_count 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.

retrieve · GET

GET /api/{installed_plugin_prefix}/insurance-plan-benefit/{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: InsurancePlanBenefitDetailSpec. 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
type_code str | None false No extra constraint extracted
type_display str | None false No extra constraint extracted
coverage_type_code str | None false No extra constraint extracted
coverage_type_display str | None false No extra constraint extracted
plan_type_code str | None false No extra constraint extracted
plan_type_display str | None false No extra constraint extracted
plan_id UUID4 | None false No extra constraint extracted
specialty_category_code str | None false No extra constraint extracted
specialty_category_display str | None false No extra constraint extracted
min_cost Decimal | None false No extra constraint extracted
max_cost Decimal | None false No extra constraint extracted
max_limit_amount Decimal | None false No extra constraint extracted
cost_count int | None false No extra constraint extracted
qualifier_count int | None false No extra constraint extracted
authorization_required bool | None false No extra constraint extracted
is_day_care bool | None false No extra constraint extracted
implant_applicable bool | None false No extra constraint extracted
stratification_allowed bool | None false No extra constraint extracted
procedure_type str | None false No extra constraint extracted
has_stratification_qualifier bool | None false No extra constraint extracted
has_implant_qualifier bool | None false No extra constraint extracted
has_consumable_qualifier bool | None false No extra constraint extracted
has_questionnaire bool | None false No extra constraint extracted
requires_supporting_info bool | None false No extra constraint extracted
supporting_info_count int | None false No extra constraint extracted
condition_count int | None false No extra constraint extracted
exclusion_count int | None false No extra constraint extracted
coverage_id UUID4 | None false No extra constraint extracted
specific_cost_benefit_id UUID4 | None false No extra constraint extracted
coverage_benefit_fhir_ids list[str] false No extra constraint extracted
questionnaire_fhir_ids list[str] false No extra constraint extracted
costs list[InsurancePlanCostSpec] false No extra constraint extracted
limits list[InsurancePlanCoverageBenefitLimitSpec] false No extra constraint extracted
conditions list[ClaimConditionSpec] false No extra constraint extracted
exclusions list[ClaimExclusionSpec] false No extra constraint extracted
supporting_info_requirements list[ClaimSupportingInfoRequirementSpec] false No extra constraint extracted
questionnaires list[InsurancePlanQuestionnaireListSpec] 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-benefit/{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.

requirements · GET

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

lookup · POST

Resolve the priced benefit row by (insurance_plan, plan_tier?, coverage_type_code?, type_code). When plan_tier is omitted on a multi-plan IP the first match is returned.

POST /api/{installed_plugin_prefix}/insurance-plan-benefit/lookup/ — action lookup. 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: BenefitLookupBody. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
insurance_plan UUID4 true No extra constraint extracted
plan_tier UUID4 | None false No extra constraint extracted
coverage_type_code str | None false No extra constraint extracted
type_code str true No extra constraint extracted

decorator responses: InsurancePlanBenefitDetailSpec. 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.

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.