{"schemaVersion":"1.0","sourceCommit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca","sourceVisibility":"private","article":{"id":"api-mansoq-abdm-teleicu-hipviewset-533adc32","title":"HIP API reference · mansoq-abdm-teleicu","summary":"Static source contract for HIP: 2 declared or inherited operation mappings, schema/field evidence and authorization/refusal references. Deployment and behavioral review remain explicit.","module":"IT & integrations","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-abdm-teleicu** at `/api/{installed_plugin_prefix}/v3/hip/`. 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| POST | `/api/{installed_plugin_prefix}/v3/hip/link_care_context/` | link__carecontext | @action declaration |\n| GET | `/api/{installed_plugin_prefix}/v3/hip/patient/fetch-by-token/` | patient__fetch_by_token | @action declaration |"},{"title":"link__carecontext · POST","body":"**POST /api/{installed_plugin_prefix}/v3/hip/link_care_context/** — action `link__carecontext`. 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\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.\n\n**Class policy declarations:** permission_classes: IsAuthenticated.\n\n**Explicit response statuses in observed code:** status.HTTP_202_ACCEPTED. Other branches/framework exception handling may differ."},{"title":"patient__fetch_by_token · GET","body":"**GET /api/{installed_plugin_prefix}/v3/hip/patient/fetch-by-token/** — action `patient__fetch_by_token`. 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\nDirectly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):\n\n| Location | Field | Declared/inferred read type | Requiredness evidence |\n| --- | --- | --- | --- |\n| query | `token` | not declared at read site | not established |\n| query | `facility_id` | not declared at read site | not established |\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.\n\n**Class policy declarations:** permission_classes: IsAuthenticated.\n\n**Explicit response statuses in observed code:** status.HTTP_200_OK, status.HTTP_400_BAD_REQUEST, status.HTTP_404_NOT_FOUND. Other branches/framework exception handling may differ."},{"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-abdm-teleicu/abdm/urls.py","line":35,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/v3/viewsets/hip.py","line":32,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/v3/viewsets/hip.py","line":36,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/v3/viewsets/hip.py","line":49,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}],"related":["it-api-contract","it-api-auth","security-rcm-roles"],"verification":"Static API contract — behavior review pending","version":"f6e9f05f76d4","apiReferenceIds":["backend-resource-486766af533adc32","backend-resource-486766af533adc32:POST:link__carecontext","backend-resource-486766af533adc32:GET:patient__fetch_by_token"]},"backend":{"resources":[{"id":"backend-resource-486766af533adc32","localPrefix":"v3/hip","viewset":"HIPViewSet","classId":"repositories/teleicu/mansoq-abdm-teleicu:abdm.api.v3.viewsets.hip.HIPViewSet","basename":"abdm__v3__hip","source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/urls.py","line":35,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"conditions":[],"repository":"repositories/teleicu/mansoq-abdm-teleicu","classSource":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/v3/viewsets/hip.py","line":32,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"description":"","path":"/api/{installed_plugin_prefix}/v3/hip/","mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","operationIds":["backend-resource-486766af533adc32:POST:link__carecontext","backend-resource-486766af533adc32:GET:patient__fetch_by_token"],"unresolvedViewset":false,"reviewStatus":"registered resource enumerated; behavioral review pending"}],"operations":[{"id":"backend-resource-486766af533adc32:POST:link__carecontext","resourceId":"backend-resource-486766af533adc32","repository":"repositories/teleicu/mansoq-abdm-teleicu","boundary":"optional-plugin/local-service","method":"POST","path":"/api/{installed_plugin_prefix}/v3/hip/link_care_context/","declaredPattern":"/api/{installed_plugin_prefix}/v3/hip/link_care_context/","action":"link__carecontext","viewset":"HIPViewSet","classId":"repositories/teleicu/mansoq-abdm-teleicu:abdm.api.v3.viewsets.hip.HIPViewSet","detail":false,"allowedByDeclaredHttpMethods":true,"mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","routeEvidence":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/urls.py","line":35,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/v3/viewsets/hip.py","line":36,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"registrationConditions":[],"evidenceKind":"@action declaration","methodEvidenceIds":["repositories/teleicu/mansoq-abdm-teleicu/abdm/api/v3/viewsets/hip.py:36:link__carecontext"],"schemaIds":{},"classPermissionEvidence":[{"kind":"permission_classes","declaration":["IsAuthenticated"],"source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/v3/viewsets/hip.py","line":33,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"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-abdm-teleicu/abdm/urls.py","line":35,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]},{"id":"backend-resource-486766af533adc32:GET:patient__fetch_by_token","resourceId":"backend-resource-486766af533adc32","repository":"repositories/teleicu/mansoq-abdm-teleicu","boundary":"optional-plugin/local-service","method":"GET","path":"/api/{installed_plugin_prefix}/v3/hip/patient/fetch-by-token/","declaredPattern":"/api/{installed_plugin_prefix}/v3/hip/patient/fetch-by-token/","action":"patient__fetch_by_token","viewset":"HIPViewSet","classId":"repositories/teleicu/mansoq-abdm-teleicu:abdm.api.v3.viewsets.hip.HIPViewSet","detail":false,"allowedByDeclaredHttpMethods":true,"mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","routeEvidence":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/urls.py","line":35,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/v3/viewsets/hip.py","line":49,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"registrationConditions":[],"evidenceKind":"@action declaration","methodEvidenceIds":["repositories/teleicu/mansoq-abdm-teleicu/abdm/api/v3/viewsets/hip.py:49:patient__fetch_by_token"],"schemaIds":{},"classPermissionEvidence":[{"kind":"permission_classes","declaration":["IsAuthenticated"],"source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/v3/viewsets/hip.py","line":33,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"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-abdm-teleicu/abdm/urls.py","line":35,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]}],"methodEvidence":[{"id":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/v3/viewsets/hip.py:36:link__carecontext","name":"link__carecontext","owner":"repositories/teleicu/mansoq-abdm-teleicu:abdm.api.v3.viewsets.hip.HIPViewSet","summary":"","source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/v3/viewsets/hip.py","line":36,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[],"permissionChecks":[],"declaredErrors":[],"explicitResponseStatuses":[{"value":null,"symbol":"status.HTTP_202_ACCEPTED","source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/v3/viewsets/hip.py","line":37,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"},{"id":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/v3/viewsets/hip.py:49:patient__fetch_by_token","name":"patient__fetch_by_token","owner":"repositories/teleicu/mansoq-abdm-teleicu:abdm.api.v3.viewsets.hip.HIPViewSet","summary":"","source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/v3/viewsets/hip.py","line":49,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[{"name":"token","in":"query","type":"not declared at read site","required":"not established","readStyle":"get","dynamicName":false,"source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/v3/viewsets/hip.py","line":50,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"name":"facility_id","in":"query","type":"not declared at read site","required":"not established","readStyle":"get","dynamicName":false,"source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/v3/viewsets/hip.py","line":51,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"permissionChecks":[],"declaredErrors":[],"explicitResponseStatuses":[{"value":null,"symbol":"status.HTTP_200_OK","source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/v3/viewsets/hip.py","line":85,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"value":null,"symbol":"status.HTTP_400_BAD_REQUEST","source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/v3/viewsets/hip.py","line":54,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"value":null,"symbol":"status.HTTP_404_NOT_FOUND","source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/v3/viewsets/hip.py","line":69,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"value":null,"symbol":"status.HTTP_404_NOT_FOUND","source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/v3/viewsets/hip.py","line":79,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"value":null,"symbol":"status.HTTP_400_BAD_REQUEST","source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/v3/viewsets/hip.py","line":62,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"}],"schemas":[],"frameworkSettings":[]},"frontend":{"operations":[],"schemas":[]},"services":{"operations":[]},"boundaries":[]}