{"schemaVersion":"1.0","sourceCommit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca","sourceVisibility":"private","article":{"id":"api-mansoq-nhcx-insuranceplanquestionnaireviewset-85cb1398","title":"Insurance Plan Questionnaire API reference · mansoq-nhcx","summary":"Static source contract for Insurance Plan Questionnaire: 1 declared or inherited operation mappings, schema/field evidence and authorization/refusal references. Deployment and behavioral review remain explicit.","module":"RCM & insurance","roles":["IT administrator","Developer","Integration engineer"],"facilities":["All configured facility types"],"kind":"reference","minutes":3,"prerequisites":["Use the API contract from the installed deployment and an authorized synthetic test environment.","Confirm facility/organization scope, action permissions and optional app enablement.","This reference is static source evidence; complete payload, authorization, failure and end-to-end review remains recorded as pending."],"steps":[],"sections":[{"title":"Declared route and availability","body":"This resource is declared in **mansoq-nhcx** at `/api/{installed_plugin_prefix}/insurance-plan-questionnaire/`. 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."},{"title":"Operation map","body":"| Method | Path | Action | Evidence |\n| --- | --- | --- | --- |\n| GET | `/api/{installed_plugin_prefix}/insurance-plan-questionnaire/{external_id}/` | retrieve | declared/inherited method |"},{"title":"retrieve · GET","body":"**GET /api/{installed_plugin_prefix}/insurance-plan-questionnaire/{external_id}/** — action `retrieve`. static contract extracted; runtime/permission/payload behavior review pending.\n\nPath and deployment-context parameters:\n\n| Location | Parameter | Type | Required |\n| --- | --- | --- | --- |\n| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |\n| path | external_id | router lookup string; semantic ID validation requires handler/schema review | true |\n\n**response: InsurancePlanQuestionnaireDetailSpec**. Declared fields below; inherited fields are retained in the schema inventory.\n\n| Field | Type | Required | Constraints |\n| --- | --- | --- | --- |\n| meta | dict | false | No extra constraint extracted |\n| id | UUID4 \\| None | false | No extra constraint extracted |\n| fhir_id | str \\| None | false | No extra constraint extracted |\n| full_url | str \\| None | false | No extra constraint extracted |\n| url | str \\| None | false | No extra constraint extracted |\n| title | str \\| None | false | No extra constraint extracted |\n| status | str \\| None | false | No extra constraint extracted |\n| subject_type | list \\| None | false | No extra constraint extracted |\n| purpose | str \\| None | false | No extra constraint extracted |\n| items | list \\| None | false | No extra constraint extracted |\n\n**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."},{"title":"Integration review checklist","body":"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."}],"troubleshooting":[{"problem":"A declared route is unavailable or a request is rejected","solution":"Compare the installed revision, actual API schema, optional plugin mount, HTTP-method restrictions and recorded validation/permission evidence. Do not bypass a refusal or send a production transaction to test documentation."}],"sources":[{"path":"repositories/teleicu/mansoq-nhcx/nhcx/urls.py","line":41,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-nhcx/nhcx/viewsets/insurance_plan.py","line":320,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py","line":83,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-nhcx/nhcx/viewsets/insurance_plan.py","line":324,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py","line":80,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py","line":325,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py","line":77,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py","line":330,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/insurance_plan.py","line":240,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}],"related":["it-api-contract","it-api-auth","security-rcm-roles"],"verification":"Static API contract — behavior review pending","version":"f6e9f05f76d4","apiReferenceIds":["backend-resource-5727e16285cb1398","backend-resource-5727e16285cb1398:GET:retrieve"]},"backend":{"resources":[{"id":"backend-resource-5727e16285cb1398","localPrefix":"insurance-plan-questionnaire","viewset":"InsurancePlanQuestionnaireViewSet","classId":"repositories/teleicu/mansoq-nhcx:nhcx.viewsets.insurance_plan.InsurancePlanQuestionnaireViewSet","basename":"nhcx-insurance-plan-questionnaire","source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/urls.py","line":41,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"conditions":[],"repository":"repositories/teleicu/mansoq-nhcx","classSource":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/viewsets/insurance_plan.py","line":320,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"description":"","path":"/api/{installed_plugin_prefix}/insurance-plan-questionnaire/","mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","operationIds":["backend-resource-5727e16285cb1398:GET:retrieve"],"unresolvedViewset":false,"reviewStatus":"registered resource enumerated; behavioral review pending"}],"operations":[{"id":"backend-resource-5727e16285cb1398:GET:retrieve","resourceId":"backend-resource-5727e16285cb1398","repository":"repositories/teleicu/mansoq-nhcx","boundary":"optional-plugin/local-service","method":"GET","path":"/api/{installed_plugin_prefix}/insurance-plan-questionnaire/{external_id}/","declaredPattern":"/api/{installed_plugin_prefix}/insurance-plan-questionnaire/{external_id}/","action":"retrieve","viewset":"InsurancePlanQuestionnaireViewSet","classId":"repositories/teleicu/mansoq-nhcx:nhcx.viewsets.insurance_plan.InsurancePlanQuestionnaireViewSet","detail":true,"allowedByDeclaredHttpMethods":true,"mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","routeEvidence":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/urls.py","line":41,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py","line":83,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"registrationConditions":[],"evidenceKind":"declared/inherited method","methodEvidenceIds":["repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:83:retrieve","repositories/teleicu/mansoq-nhcx/nhcx/viewsets/insurance_plan.py:324:get_queryset","repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:80:authorize_retrieve","repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:325:get_retrieve_pydantic_model","repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:77:get_serializer_retrieve_context","repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:330:get_read_pydantic_model"],"schemaIds":{"response":"repositories/teleicu/mansoq-nhcx:nhcx.specs.insurance_plan.InsurancePlanQuestionnaireDetailSpec"},"classPermissionEvidence":[],"filterEvidence":[],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[{"name":"installed_plugin_prefix","in":"deployment mount","type":"deployment-selected mount prefix","required":true,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/urls.py","line":41,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"name":"external_id","in":"path","type":"router lookup string; semantic ID validation requires handler/schema review","required":true,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/urls.py","line":41,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]}],"methodEvidence":[{"id":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:83:retrieve","name":"retrieve","owner":"repositories/platform/mansoq-core:mansoq.emr.api.viewsets.base.EMRRetrieveMixin","summary":"","source":{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py","line":83,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[],"permissionChecks":[],"declaredErrors":[],"explicitResponseStatuses":[],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"},{"id":"repositories/teleicu/mansoq-nhcx/nhcx/viewsets/insurance_plan.py:324:get_queryset","name":"get_queryset","owner":"repositories/teleicu/mansoq-nhcx:nhcx.viewsets.insurance_plan.InsurancePlanQuestionnaireViewSet","summary":"","source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/viewsets/insurance_plan.py","line":324,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[],"permissionChecks":[],"declaredErrors":[],"explicitResponseStatuses":[],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"},{"id":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:80:authorize_retrieve","name":"authorize_retrieve","owner":"repositories/platform/mansoq-core:mansoq.emr.api.viewsets.base.EMRRetrieveMixin","summary":"","source":{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py","line":80,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[{"name":"model_instance","type":"unspecified","required":true,"source":{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py","line":80,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"parametersRead":[],"permissionChecks":[],"declaredErrors":[],"explicitResponseStatuses":[],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"},{"id":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:325:get_retrieve_pydantic_model","name":"get_retrieve_pydantic_model","owner":"repositories/platform/mansoq-core:mansoq.emr.api.viewsets.base.EMRBaseViewSet","summary":"","source":{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py","line":325,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[],"permissionChecks":[],"declaredErrors":[],"explicitResponseStatuses":[],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"},{"id":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:77:get_serializer_retrieve_context","name":"get_serializer_retrieve_context","owner":"repositories/platform/mansoq-core:mansoq.emr.api.viewsets.base.EMRRetrieveMixin","summary":"","source":{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py","line":77,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[],"permissionChecks":[],"declaredErrors":[],"explicitResponseStatuses":[],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"},{"id":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:330:get_read_pydantic_model","name":"get_read_pydantic_model","owner":"repositories/platform/mansoq-core:mansoq.emr.api.viewsets.base.EMRBaseViewSet","summary":"","source":{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py","line":330,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[],"permissionChecks":[],"declaredErrors":[],"explicitResponseStatuses":[],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"}],"schemas":[{"id":"repositories/teleicu/mansoq-nhcx:nhcx.specs.insurance_plan.InsurancePlanQuestionnaireDetailSpec","name":"InsurancePlanQuestionnaireDetailSpec","source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/insurance_plan.py","line":240,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"kind":"Python declared schema/model evidence","fields":[{"name":"meta","type":"dict","required":false,"hasDefault":true,"source":{"path":"repositories/platform/mansoq-core/mansoq/emr/resources/base.py","line":16,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"id","type":"UUID4 | None","required":false,"hasDefault":true,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/insurance_plan.py","line":244,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"fhir_id","type":"str | None","required":false,"hasDefault":true,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/insurance_plan.py","line":245,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"full_url","type":"str | None","required":false,"hasDefault":true,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/insurance_plan.py","line":246,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"url","type":"str | None","required":false,"hasDefault":true,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/insurance_plan.py","line":247,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"title","type":"str | None","required":false,"hasDefault":true,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/insurance_plan.py","line":248,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"status","type":"str | None","required":false,"hasDefault":true,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/insurance_plan.py","line":249,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"subject_type","type":"list | None","required":false,"hasDefault":true,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/insurance_plan.py","line":250,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"purpose","type":"str | None","required":false,"hasDefault":true,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/insurance_plan.py","line":251,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"items","type":"list | None","required":false,"hasDefault":true,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/insurance_plan.py","line":252,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}}],"validation":[],"baseTypes":["EMRResource"],"reviewStatus":"declared fields extracted; runtime validation review pending","referencedSchemaIds":[]}],"frameworkSettings":[{"name":"DEFAULT_AUTHENTICATION_CLASSES","value":["config.authentication.CustomJWTAuthentication","config.authentication.CustomBasicAuthentication","rest_framework.authentication.SessionAuthentication","rest_framework.authentication.TokenAuthentication"],"source":{"path":"repositories/platform/mansoq-core/config/settings/base.py","line":372,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"scope":"source default; deployment overrides and action-level policies may differ"},{"name":"DEFAULT_PERMISSION_CLASSES","value":["rest_framework.permissions.IsAuthenticated","mansoq.security.utils.permission_class.MansoqAuthentication"],"source":{"path":"repositories/platform/mansoq-core/config/settings/base.py","line":372,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"scope":"source default; deployment overrides and action-level policies may differ"},{"name":"DEFAULT_PAGINATION_CLASS","value":"mansoq.utils.pagination.mansoq_pagination.MansoqLimitOffsetPagination","source":{"path":"repositories/platform/mansoq-core/config/settings/base.py","line":372,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"scope":"source default; deployment overrides and action-level policies may differ"},{"name":"PAGE_SIZE","value":14,"source":{"path":"repositories/platform/mansoq-core/config/settings/base.py","line":372,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"scope":"source default; deployment overrides and action-level policies may differ"}]},"frontend":{"operations":[],"schemas":[]},"services":{"operations":[]},"boundaries":[]}