MANSOQ Backend resource · STATIC DECLARATIONS
Gateway API reference · mansoq-nhcx
Static source contract for Gateway: 4 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}/gateway/. 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 |
|---|---|---|---|
| POST | /api/{installed_plugin_prefix}/gateway/get_policies/ |
get_policies | @action declaration |
| POST | /api/{installed_plugin_prefix}/gateway/participants/ |
fetch_participants | @action declaration |
| POST | /api/{installed_plugin_prefix}/gateway/abha-biometric-auth-init/ |
abha__biometric__auth__init | @action declaration |
| POST | /api/{installed_plugin_prefix}/gateway/abha-biometric-auth-verify/ |
abha__biometric__auth__verify | @action declaration |
get_policies · POST
POST /api/{installed_plugin_prefix}/gateway/get_policies/ — action get_policies. 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: GetPoliciesBody. Declared fields below; inherited fields are retained in the schema inventory.
| Field | Type | Required | Constraints |
|---|---|---|---|
| identifiertype | Literal['AbhaNumber', 'MemberId', 'MobileNo'] | true | No extra constraint extracted |
| identifiervalue | str | true | No extra constraint extracted |
decorator responses: GetPoliciesResponse. No statically declared scalar field list was resolved; inspect the schema graph and pinned source.
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.
fetch_participants · POST
POST /api/{installed_plugin_prefix}/gateway/participants/ — action fetch_participants. 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: FetchParticipantsBody. Declared fields below; inherited fields are retained in the schema inventory.
| Field | Type | Required | Constraints |
|---|---|---|---|
| role | Literal['PAYER', 'PROVIDER', 'TPA'] | true | No extra constraint extracted |
| fromdate | str | true | No extra constraint extracted |
| todate | str | true | No extra constraint extracted |
| entitytype | Literal['GOV', 'PVT', 'ALL'] | false | No extra constraint extracted |
decorator responses: FetchParticipantsResponse. Declared fields below; inherited fields are retained in the schema inventory.
| Field | Type | Required | Constraints |
|---|---|---|---|
| participantdetails | list[ParticipantSummary] | 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.
Explicit response statuses in observed code: status.HTTP_200_OK. Other branches/framework exception handling may differ.
abha__biometric__auth__init · POST
POST /api/{installed_plugin_prefix}/gateway/abha-biometric-auth-init/ — action abha__biometric__auth__init. 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: AbhaBiometricAuthInitApiBody. Declared fields below; inherited fields are retained in the schema inventory.
| Field | Type | Required | Constraints |
|---|---|---|---|
| authMode | Literal['FINGERPRINT', 'IRIS', 'FACE_AUTH'] | false | No extra constraint extracted |
| abhaNumber | str | true | No extra constraint extracted |
| payerId | str | true | No extra constraint extracted |
| process | Literal['Preauth', 'Discharge'] | false | No extra constraint extracted |
decorator responses: AbhaBiometricAuthInitResponse. Declared fields below; inherited fields are retained in the schema inventory.
| Field | Type | Required | Constraints |
|---|---|---|---|
| txnId | str | true | No extra constraint extracted |
| authMode | Literal['FINGERPRINT', 'IRIS', 'FACE_AUTH'] | None | true | No extra constraint extracted |
| message | str | true | No extra constraint extracted |
| status | Literal['success', 'error'] | None | 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.
abha__biometric__auth__verify · POST
POST /api/{installed_plugin_prefix}/gateway/abha-biometric-auth-verify/ — action abha__biometric__auth__verify. 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: AbhaBiometricAuthVerifyApiBody. Declared fields below; inherited fields are retained in the schema inventory.
| Field | Type | Required | Constraints |
|---|---|---|---|
| txnId | str | true | No extra constraint extracted |
| authMode | Literal['FINGERPRINT', 'IRIS', 'FACE_AUTH'] | false | No extra constraint extracted |
| authData | str | true | No extra constraint extracted |
| payerId | str | true | No extra constraint extracted |
| process | Literal['Preauth', 'Discharge'] | false | No extra constraint extracted |
| encounter | UUID4 | true | No extra constraint extracted |
| claim | UUID4 | 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.
Explicit response statuses in observed code: status.HTTP_200_OK. 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.
- repositories/teleicu/mansoq-nhcx/nhcx/urls.py:21
- repositories/teleicu/mansoq-nhcx/nhcx/viewsets/gateway.py:56
- repositories/teleicu/mansoq-nhcx/nhcx/viewsets/gateway.py:62
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:322
- repositories/teleicu/mansoq-nhcx/nhcx/services/types/participant.py:6
- repositories/teleicu/mansoq-nhcx/nhcx/services/types/participant.py:46
- repositories/teleicu/mansoq-nhcx/nhcx/viewsets/gateway.py:72
- repositories/teleicu/mansoq-nhcx/nhcx/services/types/participant.py:11
- repositories/teleicu/mansoq-nhcx/nhcx/services/types/participant.py:25
- repositories/teleicu/mansoq-nhcx/nhcx/viewsets/gateway.py:82
- repositories/teleicu/mansoq-nhcx/nhcx/services/types/abha_biometric.py:51
- repositories/teleicu/mansoq-nhcx/nhcx/services/types/abha_biometric.py:13
- repositories/teleicu/mansoq-nhcx/nhcx/viewsets/gateway.py:102
- repositories/teleicu/mansoq-nhcx/nhcx/services/types/abha_biometric.py:55