{"openapi":"3.0.3","info":{"title":"Demographics Workspace Application Adaptor - HL7 V3 API","description":"\n
\n
\n
\n
\n \n \"\"\n \n
\n
\n
\n

This API is retired and not available for use.

\n
\n
\n
\n\n## Overview\nThis API enables interaction between Service Now and PDS Spine. The API performs compression/decompression depending on request type.\n\n## Who can use this API\nEndpoint users (ServiceNow) use this API to make request to Spine [PDS HL7 V3](https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-hl7-v3#interactions).\n\n## Related APIs\n[Personal Demographics Service - HL7 V3 API](https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-hl7-v3#top) is related to this API.\n\n## API status and roadmap\nThis API is [in development](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses).\nTo see our roadmap, or to suggest, comment or vote on features for this API, see our [interactive product backlog](https://nhs-digital-api-management.featureupvote.com/suggestions/578925/dwa-middle-service-api).\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.\nFor more details, see [service levels](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#service-levels).\n\n## Technology\nThis API is [HL7 V3](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#hl7-v3).\n\n## Network access\nThis API is available on the internet and, indirectly, on the [Health and Social Care Network (HSCN)](https://digital.nhs.uk/services/health-and-social-care-network).\nFor more details see [Network access for APIs](https://digital.nhs.uk/developer/guides-and-documentation/network-access-for-apis).\n\n## Security and authorisation\nThis API is [application-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis), meaning we authenticate the calling application but not the end user.\n\nIn particular, it uses [signed JWT authentication](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis).\nTo use this access mode, use the following security pattern:\n - [Application-restricted RESTful API - signed JWT authentication](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-signed-jwt-authentication)\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, including code 202 if it was accepted by an API that needs to wait for further action\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\nError List for the API:\n\n| Status Code | Error Message | Description |\n| ---- | ---- | ---- |\n| 200 | Message is dependant on Spine response. | Any HTTP code can be expected in response body. |\n| 500 | \"Internal server error: An unexpected error occurred\" | An unexpected error occurred while processing the request.|\n\nSee our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#http-status-codes) for more on errors.\n\n## Environments and testing\nYou can test this API using our [Path to Live environments](https://digital.nhs.uk/services/path-to-live-environments).\n\n| Environment | Base URL |\n| ------------------- | ---------------------------------------------------------------- |\n| Integration | `https://int.api.service.nhs.uk/dwa-middle-service-api` |\n| Production | `https://api.service.nhs.uk/dwa-middle-service-api` |\n\n## Onboarding\nThis API is currently private.\n\n## Interactions\nThe API inspects the SOAPAction header to identify which PDS HL7 V3 interaction is being requested. Based on the interaction, the request will be processed accordingly.\nIntegration environment details can be found [here](https://digital.nhs.uk/services/path-to-live-environments/integration-environment).\n","contact":{"name":"DWA Middle Service Support","url":"https://digital.nhs.uk/developer/help-and-support","email":"api.management@nhs.net"},"version":"0.0.1"},"servers":[{"url":"https://int.api.service.nhs.uk/dwa-middle-service-api","description":"Integration test environment."},{"url":"https://api.service.nhs.uk/dwa-middle-service-api","description":"Production environment."}],"paths":{"/v1":{"post":{"summary":"Receives request from ServiceNow and forwards to Lambda function","parameters":[{"name":"SOAPAction","in":"header","description":"API inspects SOAPAction header to identify which HL7 V3 interaction is being requested.\nExample Routing Table:\n\n| SOAPAction Header | HL7 V3 Interaction | Request Type\n| ---- | ---- | ----\n| urn:nhs:names:services:pds/PRPA_IN000200SM03 | PRPA_IN000200SM03 | NHS Number Allocation\n| urn:nhs:names:services:pds/PRPA_IN999000UK01 | PRPA_IN999000UK01 | Patient Record Update\n| urn:nhs:names:services:pdsquery/QUPA_IN000006SM02 | QUPA_IN000006SM02 | Patient Trace Query\n| urn:nhs:names:services:pdsquery/QUPA_IN000008SM05 | QUPA_IN000008SM05 | Patient Get Query\n","required":true,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/xml":{"schema":{"type":"string","description":"XML payload from ServiceNow (structure as required)"}}},"required":true},"responses":{"200":{"description":"Request forwarded successfully."},"400":{"description":"Invalid request format or data."},"500":{"description":"Any other failure."}},"deprecated":false,"security":[{"app-level3":[]}]}}},"components":{"securitySchemes":{"app-level3":{"$ref":"https://proxygen.prod.api.platform.nhs.uk/components/securitySchemes/app-level3"}}},"security":[{"app-level3":[]}]}