{"schemaVersion":"1.0","sourceCommit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca","sourceVisibility":"private","article":{"id":"api-mansoq-radiology-dicomviewset-47e68ae2","title":"Dicom API reference · mansoq-radiology","summary":"Static source contract for Dicom: 4 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":4,"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-radiology** at `/api/{installed_plugin_prefix}/dicom/`. 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}/dicom/authenticate/` | authenticate | @action declaration |\n| POST | `/api/{installed_plugin_prefix}/dicom/upload/` | upload | @action declaration |\n| GET | `/api/{installed_plugin_prefix}/dicom/studies/` | get_studies | @action declaration |\n| GET | `/api/{installed_plugin_prefix}/dicom/service-requests/` | get_servicerequests | @action declaration |"},{"title":"authenticate · GET","body":"**GET /api/{installed_plugin_prefix}/dicom/authenticate/** — action `authenticate`. 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**Explicit response statuses in observed code:** 200. Other branches/framework exception handling may differ."},{"title":"upload · POST","body":"**POST /api/{installed_plugin_prefix}/dicom/upload/** — action `upload`. 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| file | `file` | not declared at read site | not established |\n| body | `patient_id` | not declared at read site | not established |\n\n**Observed authorization checks:** `can_write_patient_obj`. Helper/queryset evidence is included; this is not proof of complete security review.\n\n**Explicit response statuses in observed code:** 400, 201, 502, 500. Other branches/framework exception handling may differ.\n\n**Declared refusal/error evidence:** PermissionDenied (dynamic detail; inspect source)."},{"title":"get_studies · GET","body":"**GET /api/{installed_plugin_prefix}/dicom/studies/** — action `get_studies`. 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 | `patientId` | not declared at read site | not established |\n\n**Observed authorization checks:** `can_view_patient_obj`. Helper/queryset evidence is included; this is not proof of complete security review.\n\n**Explicit response statuses in observed code:** 200. Other branches/framework exception handling may differ.\n\n**Declared refusal/error evidence:** PermissionDenied (dynamic detail; inspect source)."},{"title":"get_servicerequests · GET","body":"**GET /api/{installed_plugin_prefix}/dicom/service-requests/** — action `get_servicerequests`. 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 | `serviceRequestId` | not declared at read site | not established |\n\n**Observed authorization checks:** `can_write_service_request`. Helper/queryset evidence is included; this is not proof of complete security review.\n\n**Explicit response statuses in observed code:** 200. Other branches/framework exception handling may differ.\n\n**Declared refusal/error evidence:** PermissionDenied (dynamic detail; inspect source)."},{"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-radiology/src/mansoq_radiology/urls.py","line":17,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":47,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":51,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":56,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":124,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":153,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}],"related":["it-api-contract","it-api-auth","security-rcm-roles"],"verification":"Static API contract — behavior review pending","version":"f6e9f05f76d4","apiReferenceIds":["backend-resource-1aeb6f9047e68ae2","backend-resource-1aeb6f9047e68ae2:GET:authenticate","backend-resource-1aeb6f9047e68ae2:POST:upload","backend-resource-1aeb6f9047e68ae2:GET:get_studies","backend-resource-1aeb6f9047e68ae2:GET:get_servicerequests"]},"backend":{"resources":[{"id":"backend-resource-1aeb6f9047e68ae2","localPrefix":"dicom","viewset":"DicomViewSet","classId":"repositories/teleicu/mansoq-radiology:mansoq_radiology.api.dicom.DicomViewSet","basename":"radiology","source":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/urls.py","line":17,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"conditions":[],"repository":"repositories/teleicu/mansoq-radiology","classSource":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":47,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"description":"","path":"/api/{installed_plugin_prefix}/dicom/","mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","operationIds":["backend-resource-1aeb6f9047e68ae2:GET:authenticate","backend-resource-1aeb6f9047e68ae2:POST:upload","backend-resource-1aeb6f9047e68ae2:GET:get_studies","backend-resource-1aeb6f9047e68ae2:GET:get_servicerequests"],"unresolvedViewset":false,"reviewStatus":"registered resource enumerated; behavioral review pending"}],"operations":[{"id":"backend-resource-1aeb6f9047e68ae2:GET:authenticate","resourceId":"backend-resource-1aeb6f9047e68ae2","repository":"repositories/teleicu/mansoq-radiology","boundary":"optional-plugin/local-service","method":"GET","path":"/api/{installed_plugin_prefix}/dicom/authenticate/","declaredPattern":"/api/{installed_plugin_prefix}/dicom/authenticate/","action":"authenticate","viewset":"DicomViewSet","classId":"repositories/teleicu/mansoq-radiology:mansoq_radiology.api.dicom.DicomViewSet","detail":false,"allowedByDeclaredHttpMethods":true,"mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","routeEvidence":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/urls.py","line":17,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":51,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"registrationConditions":[],"evidenceKind":"@action declaration","methodEvidenceIds":["repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py:51:authenticate"],"schemaIds":{},"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-radiology/src/mansoq_radiology/urls.py","line":17,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]},{"id":"backend-resource-1aeb6f9047e68ae2:POST:upload","resourceId":"backend-resource-1aeb6f9047e68ae2","repository":"repositories/teleicu/mansoq-radiology","boundary":"optional-plugin/local-service","method":"POST","path":"/api/{installed_plugin_prefix}/dicom/upload/","declaredPattern":"/api/{installed_plugin_prefix}/dicom/upload/","action":"upload","viewset":"DicomViewSet","classId":"repositories/teleicu/mansoq-radiology:mansoq_radiology.api.dicom.DicomViewSet","detail":false,"allowedByDeclaredHttpMethods":true,"mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","routeEvidence":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/urls.py","line":17,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":56,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"registrationConditions":[],"evidenceKind":"@action declaration","methodEvidenceIds":["repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py:56:upload"],"schemaIds":{},"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-radiology/src/mansoq_radiology/urls.py","line":17,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]},{"id":"backend-resource-1aeb6f9047e68ae2:GET:get_studies","resourceId":"backend-resource-1aeb6f9047e68ae2","repository":"repositories/teleicu/mansoq-radiology","boundary":"optional-plugin/local-service","method":"GET","path":"/api/{installed_plugin_prefix}/dicom/studies/","declaredPattern":"/api/{installed_plugin_prefix}/dicom/studies/","action":"get_studies","viewset":"DicomViewSet","classId":"repositories/teleicu/mansoq-radiology:mansoq_radiology.api.dicom.DicomViewSet","detail":false,"allowedByDeclaredHttpMethods":true,"mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","routeEvidence":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/urls.py","line":17,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":124,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"registrationConditions":[],"evidenceKind":"@action declaration","methodEvidenceIds":["repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py:124:get_studies"],"schemaIds":{},"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-radiology/src/mansoq_radiology/urls.py","line":17,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]},{"id":"backend-resource-1aeb6f9047e68ae2:GET:get_servicerequests","resourceId":"backend-resource-1aeb6f9047e68ae2","repository":"repositories/teleicu/mansoq-radiology","boundary":"optional-plugin/local-service","method":"GET","path":"/api/{installed_plugin_prefix}/dicom/service-requests/","declaredPattern":"/api/{installed_plugin_prefix}/dicom/service-requests/","action":"get_servicerequests","viewset":"DicomViewSet","classId":"repositories/teleicu/mansoq-radiology:mansoq_radiology.api.dicom.DicomViewSet","detail":false,"allowedByDeclaredHttpMethods":true,"mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","routeEvidence":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/urls.py","line":17,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":153,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"registrationConditions":[],"evidenceKind":"@action declaration","methodEvidenceIds":["repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py:153:get_servicerequests"],"schemaIds":{},"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-radiology/src/mansoq_radiology/urls.py","line":17,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]}],"methodEvidence":[{"id":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py:51:authenticate","name":"authenticate","owner":"repositories/teleicu/mansoq-radiology:mansoq_radiology.api.dicom.DicomViewSet","summary":"","source":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":51,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[{"name":"_","type":"unspecified","required":true,"source":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":51,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"parametersRead":[],"permissionChecks":[],"declaredErrors":[],"explicitResponseStatuses":[{"value":200,"symbol":null,"source":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":52,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"},{"id":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py:56:upload","name":"upload","owner":"repositories/teleicu/mansoq-radiology:mansoq_radiology.api.dicom.DicomViewSet","summary":"","source":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":56,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[{"name":"file","in":"file","type":"not declared at read site","required":"not established","readStyle":"get","dynamicName":false,"source":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":58,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"name":"patient_id","in":"body","type":"not declared at read site","required":"not established","readStyle":"get","dynamicName":false,"source":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":57,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"permissionChecks":[{"permission":"can_write_patient_obj","source":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":60,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"declaredErrors":[{"exception":"PermissionDenied","message":null,"dynamicMessage":true,"source":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":61,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"explicitResponseStatuses":[{"value":400,"symbol":null,"source":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":64,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"value":201,"symbol":null,"source":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":99,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"value":502,"symbol":null,"source":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":109,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"value":500,"symbol":null,"source":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":118,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"},{"id":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py:124:get_studies","name":"get_studies","owner":"repositories/teleicu/mansoq-radiology:mansoq_radiology.api.dicom.DicomViewSet","summary":"","source":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":124,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[{"name":"patientId","in":"query","type":"not declared at read site","required":"not established","readStyle":"get","dynamicName":false,"source":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":125,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"permissionChecks":[{"permission":"can_view_patient_obj","source":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":128,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"declaredErrors":[{"exception":"PermissionDenied","message":null,"dynamicMessage":true,"source":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":129,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"explicitResponseStatuses":[{"value":200,"symbol":null,"source":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":144,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"},{"id":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py:153:get_servicerequests","name":"get_servicerequests","owner":"repositories/teleicu/mansoq-radiology:mansoq_radiology.api.dicom.DicomViewSet","summary":"","source":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":153,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[{"name":"serviceRequestId","in":"query","type":"not declared at read site","required":"not established","readStyle":"get","dynamicName":false,"source":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":154,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"permissionChecks":[{"permission":"can_write_service_request","source":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":157,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"declaredErrors":[{"exception":"PermissionDenied","message":null,"dynamicMessage":true,"source":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":158,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"explicitResponseStatuses":[{"value":200,"symbol":null,"source":{"path":"repositories/teleicu/mansoq-radiology/src/mansoq_radiology/api/dicom.py","line":175,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"}],"schemas":[],"frameworkSettings":[]},"frontend":{"operations":[],"schemas":[]},"services":{"operations":[]},"boundaries":[]}