← Technical API reference

Backend resource · STATIC DECLARATIONS

HIPCallback API reference · mansoq-abdm-teleicu

Static source contract for HIPCallback: 8 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-abdm-teleicu at /api/{installed_plugin_prefix}/api/v3/. 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}/api/v3/hip/token/on-generate-token/ hip__token__on_generate_token @action declaration
POST /api/{installed_plugin_prefix}/api/v3/link/on_carecontext/ link__on_carecontext @action declaration
POST /api/{installed_plugin_prefix}/api/v3/hip/patient/care-context/discover/ hip__patient__care_context__discover @action declaration
POST /api/{installed_plugin_prefix}/api/v3/hip/link/care-context/init/ hip__link__care_context__init @action declaration
POST /api/{installed_plugin_prefix}/api/v3/hip/link/care-context/confirm/ hip__link__care_context__confirm @action declaration
POST /api/{installed_plugin_prefix}/api/v3/consent/request/hip/notify/ consent__request__hip__notify @action declaration
POST /api/{installed_plugin_prefix}/api/v3/hip/health-information/request/ hip__health_information__request @action declaration
POST /api/{installed_plugin_prefix}/api/v3/hip/patient/share/ hip__patient__share @action declaration

hip__token__on_generate_token · POST

POST /api/{installed_plugin_prefix}/api/v3/hip/token/on-generate-token/ — action hip__token__on_generate_token. 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

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.

Class policy declarations: permission_classes: IsAuthenticated; authentication_classes: ABDMAuthentication.

link__on_carecontext · POST

POST /api/{installed_plugin_prefix}/api/v3/link/on_carecontext/ — action link__on_carecontext. 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

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.

Class policy declarations: permission_classes: IsAuthenticated; authentication_classes: ABDMAuthentication.

hip__patient__care_context__discover · POST

POST /api/{installed_plugin_prefix}/api/v3/hip/patient/care-context/discover/ — action hip__patient__care_context__discover. 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

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.

Class policy declarations: permission_classes: IsAuthenticated; authentication_classes: ABDMAuthentication.

hip__link__care_context__init · POST

POST /api/{installed_plugin_prefix}/api/v3/hip/link/care-context/init/ — action hip__link__care_context__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

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.

Class policy declarations: permission_classes: IsAuthenticated; authentication_classes: ABDMAuthentication.

hip__link__care_context__confirm · POST

POST /api/{installed_plugin_prefix}/api/v3/hip/link/care-context/confirm/ — action hip__link__care_context__confirm. 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

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.

Class policy declarations: permission_classes: IsAuthenticated; authentication_classes: ABDMAuthentication.

consent__request__hip__notify · POST

POST /api/{installed_plugin_prefix}/api/v3/consent/request/hip/notify/ — action consent__request__hip__notify. 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

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.

Class policy declarations: permission_classes: IsAuthenticated; authentication_classes: ABDMAuthentication.

hip__health_information__request · POST

POST /api/{installed_plugin_prefix}/api/v3/hip/health-information/request/ — action hip__health_information__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

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.

Class policy declarations: permission_classes: IsAuthenticated; authentication_classes: ABDMAuthentication.

hip__patient__share · POST

POST /api/{installed_plugin_prefix}/api/v3/hip/patient/share/ — action hip__patient__share. 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

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location Field Declared/inferred read type Requiredness evidence
header REQUEST-ID not declared at read site not established

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.

Class policy declarations: permission_classes: IsAuthenticated; authentication_classes: ABDMAuthentication.

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.