{"openapi":"3.0.3","info":{"title":"National Imaging Registry (NIR) - MHD FHIR API","description":"## Overview\nThe National Imaging Registry (NIR) API allows authorised systems to view a patient's imaging history, including examinations, diagnostic reports, and imaging studies for use in direct care.\n\nKey features include:\n\n- querying and discovery of a patient's imaging history\n- retrieval of examinations, diagnostic reports, and imaging studies\n- a federated model underpinning the service. A consumer queries NIR once and then NIR forwards the query to participating imaging networks, returning an aggregated list of results\n\nThis page is about how to implement the API for the National Imaging Registry. To find out more about the wider vision and benefits of the service, please visit the [National Imaging Registry service page](https://digital.nhs.uk/services/national-imaging-registry).\n\n### NIR XCA Flow Diagram\n\n\n\n*High-level federated discovery and retrieval: a consumer queries NIR once, NIR queries multiple connected organisations, and the selected document is retrieved from the source organisation and returned to the consumer.*\n\n## Who can use this API\nThis API is for direct care use only. Make sure you have a valid use case before you go too far with your development. Demonstrating your eligibility with\na valid use case is one of the first activities you will complete as part of digital onboarding.\n\nFor more information on this, visit the [NIR onboarding guidance page](https://digital.nhs.uk/services/national-imaging-registry/nir-onboarding-guidance).\n\n## Related APIs\nThe following APIs are related to this API:\n\n- [Personal Demographics Service (PDS) API](https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir) - while the NIR does not integrate directly with PDS, organisations are expected to use the service to validate patient details before querying the NIR API\n- [National Record Locator (NRL) API](https://digital.nhs.uk/developer/api-catalogue/national-record-locator-fhir) - the NIR service team intends to investigate integrating with the National Record Locator (NRL) as a source where imaging document references could be stored and managed\n\n## API status and roadmap\nThis API is [in production (beta)](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses).\n\nOur roadmap can be found within our [NIR service space](https://digital.nhs.uk/services/national-imaging-registry/national-imaging-registry-roadmap).\n\n## Service level\nThis API is a bronze service, meaning it is operational and supported only during business hours (8am to 6pm), Monday to Friday excluding bank holidays.\n\nFor more details, see [service levels](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#service-levels).\n\n## Technology\nThis API is built on internationally recognised interoperability standards.\n\nIt uses IHE profiles such as [Cross-Community Access (XCA)](https://profiles.ihe.net/ITI/TF/Volume1/ch-18.html) and relies on established messaging frameworks ([SOAP](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#basic-soap) web services)\nto ensure consistent and reliable communication between systems.\n\nIn future, NIR intends to provide an endpoint aligned to the IHE [Mobile access to Health Documents (MHD)](https://profiles.ihe.net/ITI/MHD/index.html) profile. This will be [RESTful](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#basic-rest) and based on [FHIR R4 (v4.0.1)](https://www.hl7.org/fhir/R4/).\n\n### Cross-Community Access (XCA)\nThe IHE Cross-Community Access (XCA) profile provides a standardised way for health IT systems to query and retrieve medical imaging data including diagnostic reports and imaging manifests, across organisational and network boundaries.\nThe IHE Cross-Community Access for Imaging (XCA-I) profile extends XCA to support retrieval of the images contained in imaging manifests.\n\n### IHE profiles\n\n#### XCA endpoint\nThe NIR API XCA endpoint provides the following IHE transactions:\n\n- **ITI-38 Cross Gateway Query** - enables an imaging system supplier to issue a query across community boundaries to discover documents (for example, imaging study metadata and diagnostic reports) for a given patient\n- **ITI-39 Cross Gateway Retrieve** - enables the requesting system to retrieve selected documents (for example, imaging studies and reports) from a remote community once they have been located\n\n#### XCA-I endpoint\nThe NIR API XCA-I endpoint provides the following IHE transactions:\n\n- **RAD-75 Cross Gateway Retrieve Imaging Document Set** - enables the requesting system to retrieve the selected image from the respective community (through NIR)\n\nFor full details of these transactions, refer to the relevant endpoint documentation below.\n\n## Network access\nThe NIR API can be accessed either:\n\n- directly over the public internet using secure and authenticated connections, or\n- indirectly via the Health and Social Care Network ([HSCN](https://digital.nhs.uk/services/health-and-social-care-network)), where connectivity is provided through participating local imaging networks\n\nKey points:\n\n- imaging system suppliers must onboard through their customer organisation's approved access route (internet or HSCN via local network)\n- direct HSCN connectivity is not currently supported; access through HSCN is only available indirectly via connected local networks\n- all traffic must use secure, encrypted connections with approved certificates and endpoint protection\n- the same access model applies for both test and live environments\n\nInternet access is recommended for suppliers, while [HSCN access](https://digital.nhs.uk/services/health-and-social-care-network) is available indirectly for organisations connecting via their local networks.\n\n## Security and authorisation\nThis API has one access mode:\n\n- [application-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis) access\n\nThis means we authenticate the calling application but not the end user. However, we require the calling application to have done so 'locally' and to present this information within the relevant part of their request.\n\n### NIR Security Standards and Profiles\n- **Mutual TLS (mTLS)** - all connections require mTLS, where the client and server present certificates for authentication. Client certificates must chain to a certificate authority (CA) trusted by the NIR trust store, ensuring that only permitted gateways and systems can connect\n- **WS-Security with SAML assertions** - SOAP-based XCA messages include WS-Security headers carrying signed SAML assertions. These follow the [IHE Cross-Enterprise User Assertion (XUA) profile](https://profiles.ihe.net/ITI/TF/Volume1/ch-13.html), ensuring user identity, role, organisation, and purpose of use are securely conveyed. For further details, see: [XUA SAML and WS-Security requirements for XCA endpoints](https://digital.nhs.uk/developer/api-catalogue/national-imaging-registry-api/xca-saml-requirements-guide/xca-saml-and-ws-security-requirements)\n\n## Errors\nWe use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:\n\n- 200 to 299 if it succeeded\n- 400 to 499 if it failed because of a client error by your application\n- 500 to 599 if it failed because of an error on our server\n\nErrors specific to each API endpoint are shown in the Operations section, under Response.\n\nFor further details on XCA errors, see [XCA error handling](https://digital.nhs.uk/developer/api-catalogue/national-imaging-registry-api/xca-error-handling).\n\n## Environments and testing\n\n| Environment | Base URL |\n| ---------------- | ----------------------------------------- |\n| Sandbox | `https://sandbox.nir.national.nhs.uk` |\n| Integration test | `https://int.nir.national.nhs.uk` |\n| Production | `https://nir.national.nhs.uk` |\n\n### Sandbox testing\nOur sandbox environment:\n\n- is for early developer testing\n- only covers a limited set of scenarios\n- is stateless, so does not persist any updates\n- is open access, so does not allow you to test authorisation\n\nYou can try out the sandbox using our [Postman Collection](https://raw.githubusercontent.com/NHSDigital/nir-postman-collection/refs/heads/main/NIR_Sandbox.postman_collection.json).\n\n### Integration testing\nOur integration test environment:\n\n- is for formal integration testing\n- is stateful, so persists updates\n- includes authorisation\n\nYou can refer to our [test data page](https://digital.nhs.uk/developer/api-catalogue/national-imaging-registry-api/test-data) for documentation on the test cases available in the environment.\n\n### Production smoke testing\nYou must not use real patient data for smoke testing in the production environment. You must use 9 series NHS numbers created by [testdata@nhs.net](mailto:testdata@nhs.net).\n\n## Onboarding\nSuppliers can start their onboarding and product accreditation directly with NHS England through the [Digital Onboarding Service](https://digital.nhs.uk/services/digital-onboarding-service) (DOS). You do not need a Healthcare Organisation or End User Organisation (EUO) to start onboarding or to complete the Technical Conformance stage; a suitable test system for your product version is enough.\n\nTo preview the technical conformance questions required for accreditation, please visit the [NIR API assurance overview](https://onboarding.prod.api.platform.nhs.uk/Products/PreviewOverview?apiId=100).\n\n## Further information\n[National Imaging Registry (NIR)](https://digital.nhs.uk/services/national-imaging-registry)\n","version":"v0.32.0"},"servers":[{"url":"https://sandbox.nir.national.nhs.uk","description":"Sandbox environment."},{"url":"https://int.nir.national.nhs.uk","description":"Integration test environment."},{"url":"https://nir.national.nhs.uk","description":"Production environment."}],"paths":{"/health":{"get":{"summary":"Health","operationId":"health_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}}}}},"deprecated":false}},"/xca/iti-38":{"get":{"tags":["XCA"],"summary":"Retrieve WSDL for ITI-38","description":"Retrieves the WSDL file containing definitions for an Initiating Gateway Query.","operationId":"xca_iti38_wsdl_endpoint_xca_iti_38_get","parameters":[{"name":"wsdl","in":"query","description":"Optional wsdl query parameter (use ?wsdl to request the WSDL)","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"Successful Response","content":{"text/xml":{"schema":{"type":"string","format":"xml","xml":{"name":"definitions","namespace":"http://schemas.xmlsoap.org/wsdl/","attribute":false,"wrapped":false}},"examples":{"success":{"summary":"Successful retrieval of WSDL for ITI-38","value":"\n\n"}}}}}},"deprecated":false},"post":{"tags":["XCA"],"summary":"ITI-38 Cross Gateway Query endpoint","description":"Accepts SOAP requests (application/soap+xml) for ITI-38 Cross Gateway Query.","operationId":"xca_iti38_endpoint_xca_iti_38_post","requestBody":{"content":{"application/soap+xml; charset=utf-8":{"schema":{"title":"SOAP ITI-38 Request","type":"string","description":"A SOAP 1.2 Envelope containing a Cross Gateway Query (ITI-38) AdhocQueryRequest.","format":"xml","xml":{"name":"Envelope","namespace":"http://www.w3.org/2003/05/soap-envelope","attribute":false,"wrapped":false}},"examples":{"cross_gateway_query":{"summary":"Cross Gateway Query request","value":"\n\n \n urn:ihe:iti:2007:CrossGatewayQuery\n urn:uuid:a86a8107-0b68-452e-a29a-823b5b63efa4\n \n\n \n 2026-06-09T12:00:00Z\n 2026-06-09T12:05:00Z\n \n\n \n\n urn:your-org:sts\n\n \n \n \n \n \n \n \n \n \n \n \n ...\n \n \n ...\n ...\n \n\n \n user@example.nhs.uk\n \n \n \n \n\n \n \n https://example.nir.nhs.uk \n \n \n\n \n \n urn:oasis:names:tc:SAML:2.0:ac:classes:X509\n \n \n\n \n \n Dr Jane Smith \n \n\n \n Example NHS Trust \n \n \n urn:oid:1.2.826.0.1285.0.1.10\n \n\n \n \n \n \n \n\n \n TREATMENT\n \n\n \n urn:oid:1.2.826.0.1285.0.2.0.107\n \n \n \n\n \n \n \n \n \n ...\n ...\n ...\n \n ...\n ...\n \n\n \n \n http://www.w3.org/2005/08/addressing/anonymous\n \n https://example.nir.nhs.uk/xca/iti-38\n \n \n \n \n \n \n \n ('urn:oasis:names:tc:ebxml-regrep:StatusType:Approved')\n \n \n \n \n 'some-patient-nhs-number^^^&2.16.840.1.113883.2.1.4.1&ISO'\n \n \n \n \n \n"}}}},"required":true},"responses":{"200":{"description":"SOAP Envelope containing an ebXML AdhocQueryResponse with Registry Objects returned","content":{"application/soap+xml; charset=utf-8":{"schema":{"type":"string","format":"xml","xml":{"name":"Envelope","namespace":"http://www.w3.org/2003/05/soap-envelope","attribute":false,"wrapped":false}},"examples":{"success":{"summary":"Successful query response with results","value":"\n\n \n urn:ihe:iti:2007:CrossGatewayQueryResponse\n http://www.w3.org/2005/08/addressing/anonymous\n urn:uuid:some-example-id\n urn:uuid:a86a8107-0b68-452e-a29a-823b5b63efa4\n \n \n \n \n \n \n \n 20241022134100\n \n \n \n \n 20241022134100\n \n \n \n \n 25916\n \n \n \n \n 20241022134100\n \n \n \n \n 2.16.840.1.113883.2.1.3.20.5.1.1.1.2\n \n \n \n \n Joe Bloggs\n \n \n \n \n \n 91092169&PHT91092169^^^^urn:sectra:iti:xds:2015:accessionAndStudyId\n \n \n \n \n en-gb\n \n \n \n \n PID-3|some-patient-nhs-number^^^&2.16.840.1.113883.2.1.3.20.1.1&ISO\n PID-5|RTTW-RANCE^PATIENT NAME\n PID-7|19900101\n PID-8|M\n PID-11|3 TEST LANE^LONDON^^^SW2^2UP\n \n \n \n \n http://unknownhost//unknownpath\n \n \n \n \n C8A12DA7B02B2927099AA932C092687F62D9D3F6\n \n \n \n \n some-patient-nhs-number^^^&2.16.840.1.113883.2.1.3.20.1.1&ISO\n \n \n \n \n \n \n \n \n \n \n \n \n 2.16.840.1.113883.6.1\n \n \n \n \n \n \n \n \n \n \n 2.16.840.1.113883.5.25\n \n \n \n \n \n \n \n \n \n \n 1.3.6.1.4.1.19376.1.2.3\n \n \n \n \n \n \n \n \n \n \n 2.16.840.1.113883.5.10588\n \n \n \n \n \n \n \n \n \n \n 2.16.840.1.113883.2.1.6.8\n \n \n \n \n \n \n \n \n \n \n 2.16.840.1.113883.6.1\n \n \n \n \n \n \n \n \n \n \n Joe Bloggs\n \n \n \n \n TEST HOSPITAL\n \n \n \n \n Reporter\n \n \n \n \n \n \n \n \n \n \n \n \n Joe Bloggs\n \n \n \n \n TEST HOSPITAL\n \n \n \n \n Verifier\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n "},"partial_error":{"summary":"Partial success with downstream errors","value":"\n\n \n urn:ihe:iti:2007:CrossGatewayQueryResponse\n http://www.w3.org/2005/08/addressing/anonymous\n urn:uuid:some-message-id\n urn:uuid:a86a8107-0b68-452e-a29a-823b5b63efa4\n \n \n \n \n \n \n \n \n \n \n 20241022134200\n \n \n \n \n 20241022134200\n \n \n \n \n 24148\n \n \n \n \n some-patient-nhs-number^^^&2.16.840.1.1234.2.1.3.20.1.2&ISO\n \n \n \n \n \n \n \n \n \n \n \n \n Joe Bloggs\n \n \n \n \n TEST HOSPITAL\n \n \n \n \n Verifier\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n"}}}}},"400":{"description":"SOAP Envelope containing an ebXML AdhocQueryResponse with Registry Errors","content":{"application/soap+xml; charset=utf-8":{"schema":{"type":"string","format":"xml","xml":{"name":"Envelope","namespace":"http://www.w3.org/2003/05/soap-envelope","attribute":false,"wrapped":false}},"examples":{"unsupported_parameter":{"summary":"Client request contained an unsupported parameter","value":"\n\n \n urn:ihe:iti:2007:CrossGatewayQueryResponse\n http://www.w3.org/2005/08/addressing/anonymous\n \n \n \n \n \n \n \n \n \n\n"}}}}},"401":{"description":"SOAP Envelope containing a SOAP Fault regarding the client Security signature","content":{"application/soap+xml; charset=utf-8":{"schema":{"type":"string","format":"xml","xml":{"name":"Envelope","namespace":"http://www.w3.org/2003/05/soap-envelope","attribute":false,"wrapped":false}},"examples":{"invalid_signature":{"summary":"Client request signature invalid","value":"\n\n \n \n \n soap:Sender\n \n wsse:FailedCheck\n \n \n \n Invalid signature in request\n \n \n \n"}}}}}},"deprecated":false}},"/xca/iti-38/schema/{schema_file}":{"get":{"tags":["XCA"],"summary":"Retrieve XCA ITI-38 schema","description":"Retrieve an XML Schema Definition file using a given path","operationId":"xca_iti38_schema_endpoint_xca_iti_38_schema__schema_file__get","parameters":[{"name":"schema_file","in":"path","description":"The path to the schema file","required":true,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"title":"Schema File","type":"string","description":"The path to the schema file"}}],"responses":{"200":{"description":"Successful Response","content":{"text/xml":{"schema":{"type":"string","format":"xml","xml":{"name":"schema","namespace":"http://www.w3.org/2001/XMLSchema","attribute":false,"wrapped":false}},"examples":{"success":{"summary":"Successful retrieval of a schema definition","value":"\n\n"}}}}}},"deprecated":false}},"/xca/iti-39":{"get":{"tags":["XCA"],"summary":"Retrieve WSDL for ITI-39","description":"Obtains the WSDL file containing definitions for an Initiating Gateway Retrieve.","operationId":"xca_iti39_wsdl_endpoint_xca_iti_39_get","parameters":[{"name":"wsdl","in":"query","description":"Optional wsdl query parameter (use ?wsdl to request the WSDL)","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"Successful Response","content":{"text/xml":{"schema":{"type":"string","format":"xml","xml":{"name":"definitions","namespace":"http://schemas.xmlsoap.org/wsdl/","attribute":false,"wrapped":false}},"examples":{"success":{"summary":"Successful retrieval of WSDL for ITI-39","value":"\n\n"}}}}}},"deprecated":false},"post":{"tags":["XCA"],"summary":"ITI-39 Cross Gateway Retrieve endpoint","description":"Accepts MTOM/XOP requests (multipart/related) for ITI-39 Cross Gateway Retrieve. Returns MTOM/XOP multipart response containing the document attachment bytes. Errors regarding the SOAP envelope e.g. schema validation prior to the request being forwarded by NIR or a non-200 response from the downstream gateway will result in an application/soap+xml error response. You can refer to the top-level Errors section of our API page for more details on the downstream error handling.","operationId":"xca_iti39_endpoint_xca_iti_39_post","requestBody":{"content":{"multipart/related; type=\"application/xop+xml\"; start-info=\"application/soap+xml\"":{"schema":{"title":"MTOM/XOP ITI-39 Request","type":"string","description":"A multipart/related MTOM/XOP request containing a SOAP 1.2 Envelope with a Cross Gateway Retrieve (ITI-39) RetrieveDocumentSetRequest."},"examples":{"cross_gateway_retrieve":{"summary":"Cross Gateway Retrieve request","value":"--uuid:57f3493d-b1e1-4379-86f3-534a1e890983\nContent-Type: application/xop+xml; charset=UTF-8; type=\"application/soap+xml\"\nContent-Transfer-Encoding: binary\nContent-ID: \n\n\n \n urn:ihe:iti:2007:CrossGatewayRetrieve\n urn:uuid:afe4ec1a-ec8e-4556-b2b2-0ae5512d17f7\n \n\n \n 2026-06-09T12:00:00Z\n 2026-06-09T12:05:00Z\n \n\n \n\n urn:your-org:sts\n\n \n \n \n \n \n \n \n \n \n \n \n ...\n \n \n ...\n ...\n \n\n \n user@example.nhs.uk\n \n \n \n \n\n \n \n https://example.nir.nhs.uk \n \n \n\n \n \n urn:oasis:names:tc:SAML:2.0:ac:classes:X509\n \n \n\n \n \n Dr Jane Smith \n \n\n \n Example NHS Trust \n \n \n urn:oid:1.2.826.0.1285.0.1.10\n \n\n \n \n \n \n \n\n \n TREATMENT\n \n\n \n urn:oid:1.2.826.0.1285.0.2.0.107\n \n \n \n\n \n \n \n \n \n ...\n ...\n ...\n \n ...\n ...\n \n\n \n \n http://www.w3.org/2005/08/addressing/anonymous\n \n https://example.nir.nhs.uk/xca/iti-39\n \n \n \n \n urn:oid:1.2.3.4.5.6.7.8.9.1235.1\n 2.16.840.1.113883.2.1.3.20.5.1.1.1.2\n 1.8.4.7.8.2.0.2.7.2.2\n \n \n \n\n--uuid:57f3493d-b1e1-4379-86f3-534a1e890983--"}}}},"required":true},"responses":{"200":{"description":"MTOM/XOP multipart response containing a RetrieveDocumentSetResponse with document attachments.","content":{"multipart/related; type=\"application/xop+xml\"; start-info=\"application/soap+xml\"":{"schema":{"type":"string","format":"binary"},"examples":{"success":{"summary":"Successful retrieve response with document attachment","value":"--uuid:2602f62b-ed05-4f0f-a1c7-6703be6c1ed1\nContent-Type: application/xop+xml; charset=UTF-8; type=\"application/soap+xml\"\nContent-Transfer-Encoding: binary\nContent-ID: \n\n\n \n urn:ihe:iti:2007:CrossGatewayRetrieveResponse\n urn:uuid:02cc7451-11db-42a4-b0cb-826053242c45\n http://www.w3.org/2005/08/addressing/anonymous\n urn:uuid:afe4ec1a-ec8e-4556-b2b2-0ae5512d17f7\n \n \n \n \n \n urn:oid:1.2.3.4.5.6.7.8.9.1235.1\n 2.16.840.1.113883.2.1.3.20.5.1.1.1.2\n 1.8.4.7.8.2.0.2.7.2.2\n text/plain\n \n \n \n \n \n \n\n\n--uuid:2602f62b-ed05-4f0f-a1c7-6703be6c1ed1\nContent-Type: text/plain\nContent-Transfer-Encoding: binary\nContent-ID: \n\nThis is a text document!\n\n--uuid:2602f62b-ed05-4f0f-a1c7-6703be6c1ed1--"}}}}},"400":{"description":"SOAP Envelope containing a SOAP Fault regarding schema validation failure","content":{"application/soap+xml; charset=utf-8":{"schema":{"type":"string","format":"xml","xml":{"name":"Envelope","namespace":"http://www.w3.org/2003/05/soap-envelope","attribute":false,"wrapped":false}},"examples":{"schema_invalid":{"summary":"Client request signature invalid","value":"\n\n \n \n \n soap:Sender\n \n SchemaValidationError\n \n \n \n Schema validation failed\n \n \n \n"}}}}},"401":{"description":"SOAP Envelope containing a SOAP Fault regarding the client Security signature","content":{"application/soap+xml; charset=utf-8":{"schema":{"type":"string","format":"xml","xml":{"name":"Envelope","namespace":"http://www.w3.org/2003/05/soap-envelope","attribute":false,"wrapped":false}},"examples":{"invalid_signature":{"summary":"Client request signature invalid","value":"\n\n \n \n \n soap:Sender\n \n wsse:FailedCheck\n \n \n \n Invalid signature in request\n \n \n \n"}}}}}},"deprecated":false}},"/xca/iti-39/schema/{schema_file}":{"get":{"tags":["XCA"],"summary":"Retrieve XCA ITI-39 schema","description":"Retrieve an XML Schema Definition file using a given path","operationId":"xca_iti39_schema_endpoint_xca_iti_39_schema__schema_file__get","parameters":[{"name":"schema_file","in":"path","required":true,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"title":"Schema File","type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"text/xml":{"schema":{"type":"string","format":"xml","xml":{"name":"schema","namespace":"http://www.w3.org/2001/XMLSchema","attribute":false,"wrapped":false}},"examples":{"success":{"summary":"Successful retrieval of a schema definition","value":"\n\n"}}}}}},"deprecated":false}},"/xcai/rad-75":{"get":{"tags":["XCA-I"],"summary":"Retrieve WSDL for RAD-75 (XCA-I)","description":"Retrieves the WSDL file containing definitions for a Cross Gateway Retrieve Imaging Document Set transaction.","operationId":"xcai_rad75_wsdl_endpoint_xcai_rad_75_get","parameters":[{"name":"wsdl","in":"query","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"Successful Response","content":{"text/xml":{"schema":{"type":"string","format":"xml","xml":{"name":"definitions","namespace":"http://schemas.xmlsoap.org/wsdl/","attribute":false,"wrapped":false}},"examples":{"success":{"summary":"Successful retrieval of WSDL for RAD-75","value":"\n\n"}}}}}},"deprecated":false},"post":{"tags":["XCA-I"],"summary":"RAD-75 Cross Gateway Retrieve Imaging Document Set endpoint","description":"Accepts MTOM/XOP requests (multipart/related) for RAD-75 Cross Gateway Retrieve Imaging Document Set. Returns MTOM/XOP multipart response containing DICOM bytes. Errors regarding the SOAP envelope e.g. schema validation prior to the request being forwarded by NIR or a non-200 response from the downstream gateway will result in an application/soap+xml error response. You can refer to the top-level Errors section of our API page for more details on the downstream error handling.","operationId":"xcai_rad75_endpoint_xcai_rad_75_post","requestBody":{"content":{"multipart/related; type=\"application/xop+xml\"; start-info=\"application/soap+xml\"":{"schema":{"title":"MTOM/XOP RAD-75 request","type":"string","description":"A multipart/related MTOM/XOP request containing a SOAP 1.2 Envelope with a Cross Gateway Retrieve Imaging Document Set transaction (RAD-75)."},"examples":{"cross_gateway_retrieve_imaging_document_set":{"summary":"Cross Gateway Retrieve Imaging Document Set request","value":"--uuid:57f3493d-b1e1-4379-86f3-534a1e890983\nContent-Type: application/xop+xml; charset=UTF-8; type=\"application/soap+xml\"\nContent-Transfer-Encoding: binary\nContent-ID: \n\n\n \n urn:ihe:rad:2011:CrossGatewayRetrieveImagingDocumentSet\n urn:uuid:afe4ec1a-ec8e-4556-b2b2-0ae5512d17f7\n \n\n \n 2026-06-09T12:00:00Z\n 2026-06-09T12:05:00Z\n \n\n \n\n urn:your-org:sts\n\n \n \n \n \n \n \n \n \n \n \n \n ...\n \n \n ...\n ...\n \n\n \n user@example.nhs.uk\n \n \n \n \n\n \n \n https://example.nir.nhs.uk \n \n \n\n \n \n urn:oasis:names:tc:SAML:2.0:ac:classes:X509\n \n \n\n \n \n Dr Jane Smith \n \n\n \n Example NHS Trust \n \n \n urn:oid:1.2.826.0.1285.0.1.10\n \n\n \n \n \n \n \n\n \n TREATMENT\n \n\n \n urn:oid:1.2.826.0.1285.0.2.0.107\n \n \n \n\n \n \n \n \n \n ...\n ...\n ...\n \n ...\n ...\n \n\n \n \n http://www.w3.org/2005/08/addressing/anonymous\n \n https://example.nir.nhs.uk/xcai/rad-75\n \n \n \n \n \n \n urn:oid:1.2.34.567.8.1\n 1.3.6.1.4.1.21367.13.71.201.1\n 1.3.46.670589.11.0.4.1996082307380006\n \n \n \n \n 1.2.840.10008.1.2.1\n \n \n \n\n--uuid:57f3493d-b1e1-4379-86f3-534a1e890983--"}}}},"required":true},"responses":{"200":{"description":"MTOM/XOP multipart response containing a RetrieveDocumentSetResponse with the DICOM bytes.","content":{"multipart/related; type=\"application/xop+xml\"; start-info=\"application/soap+xml\"":{"schema":{"type":"string","format":"binary"},"examples":{"success":{"summary":"Successful retrieve response with DICOM bytes","value":"--uuid:2602f62b-ed05-4f0f-a1c7-6703be6c1ed1\nContent-Type: application/xop+xml; charset=UTF-8; type=\"application/soap+xml\"\nContent-Transfer-Encoding: binary\nContent-ID: \n\n\n \n urn:ihe:rad:2011:CrossGatewayRetrieveImagingDocumentSetResponse\n urn:uuid:02cc7451-11db-42a4-b0cb-826053242c45\n http://www.w3.org/2005/08/addressing/anonymous\n urn:uuid:afe4ec1a-ec8e-4556-b2b2-0ae5512d17f7\n \n \n \n \n \n urn:oid:1.2.34.567.8.1\n 1.3.6.1.4.1.21367.13.71.201.1\n 1.3.46.670589.11.0.4.1996082307380006\n application/dicom\n \n \"/>\n \n \n \n \n\n\n--uuid:2602f62b-ed05-4f0f-a1c7-6703be6c1ed1\nContent-Type: application/dicom\nContent-Transfer-Encoding: binary\nContent-ID: \n\nFAKE_DICOM_PAYLOAD (See sandbox for full example with imaging data).\n\n--uuid:2602f62b-ed05-4f0f-a1c7-6703be6c1ed1--"}}}}},"400":{"description":"SOAP Envelope containing a SOAP Fault regarding schema validation failure","content":{"application/soap+xml; charset=utf-8":{"schema":{"type":"string","format":"xml","xml":{"name":"Envelope","namespace":"http://www.w3.org/2003/05/soap-envelope","attribute":false,"wrapped":false}},"examples":{"schema_invalid":{"summary":"Client request signature invalid","value":"\n\n \n \n \n soap:Sender\n \n SchemaValidationError\n \n \n \n Schema validation failed\n \n \n \n"}}}}},"401":{"description":"SOAP Envelope containing a SOAP Fault regarding the client Security signature","content":{"application/soap+xml; charset=utf-8":{"schema":{"type":"string","format":"xml","xml":{"name":"Envelope","namespace":"http://www.w3.org/2003/05/soap-envelope","attribute":false,"wrapped":false}},"examples":{"invalid_signature":{"summary":"Client request signature invalid","value":"\n\n \n \n \n soap:Sender\n \n wsse:FailedCheck\n \n \n \n Invalid signature in request\n \n \n \n"}}}}}},"deprecated":false}},"/xcai/rad-75/schema/{schema_file}":{"get":{"tags":["XCA-I"],"summary":"Retrieve RAD-75 schema","description":"Endpoint to retrieve the RAD-75 schema.","operationId":"xcai_rad75_schema_endpoint_xcai_rad_75_schema__schema_file__get","parameters":[{"name":"schema_file","in":"path","required":true,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"title":"Schema File","type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"text/xml":{"schema":{"type":"string","format":"xml","xml":{"name":"schema","namespace":"http://www.w3.org/2001/XMLSchema","attribute":false,"wrapped":false}},"examples":{"success":{"summary":"Successful retrieval of a schema definition","value":"\n\n"}}}}}},"deprecated":false}}},"components":{"schemas":{"HTTPValidationError":{"title":"HTTPValidationError","type":"object","properties":{"detail":{"title":"Detail","type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"HealthResponse":{"title":"HealthResponse","required":["status","timestamp","version"],"type":"object","properties":{"status":{"title":"Status","type":"string","examples":["ok"]},"timestamp":{"title":"Timestamp","type":"string","format":"date-time","examples":["2026-06-01T09:00:00+00:00"]},"version":{"title":"Version","type":"string","examples":["v0.1.0"]}}},"ValidationError":{"title":"ValidationError","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Location","type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"}]}},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"},"input":{"title":"Input"},"ctx":{"title":"Context","type":"object"}}}},"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"}}},"x-spec-publication":{"try-this-api":{"disabled":true}}}