\n\n## Overview\nUse this API to convert resource types `MedicationRequest` and `MedicationStatements` from STU3 to FHIR R4 and vice versa.\n\nYou can:\n - post either a `MedicationRequest` or `MedicationStatement`\n\nYou cannot:\n - convert between any other resource types\n\nTo use this API:\n1. Send your source payload to this API.\n2. This API converts your source payload to the target version.\n3. You receive the converted payload in the response.\n\n## Who can use this API\nThis API can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development. You must do this before you can go live (see ‘Onboarding’ below).\n\n## API status and roadmap\nThis API is [retired](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses) and not available for use.\n\nIf you have any other queries, please [contact us](https://digital.nhs.uk/developer/help-and-support).\n\n### Roadmap\n\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/?order=popular&filter=allexceptdone&tag=fhir-converter&deleted=0#controls).\n\nIf you have any other queries, [contact us](https://digital.nhs.uk/developer/help-and-support).\n\n## Technology\nThis API is [RESTful](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#basic-rest) and uses HTTP POST to submit data. It is synchronous - you receive your converted resource in the response body.\n\nIt conforms to the [FHIR](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#fhir) global standard for health care data exchange, specifically to [FHIR R4 (v4.0.1)](https://hl7.org/fhir/r4/), except that it does not support the [capabilities](http://hl7.org/fhir/R4/http.html#capabilities) interaction.\n\n## Network access\nThis API is available on the internet.\n\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\n### Application-restricted access\nThis access mode is [application-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis),\nmeaning we authenticate the calling application but not the end user.\n\nThis access mode uses 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## Supported FHIR resources and extensions\nThis service supports conversion from STU3 to R4 and vice versa for following FHIR resources:\n- Bundle\n- MedicationRequest\n- MedicationStatement\n\nFor STU3 to R4 conversion, this service can convert various extensions as listed in the version \n[v0.1.0](https://github.com/NHSDigital/fhir-transforms/tree/a60eac0ea4e0ce62075378b36fac00eff7f0ce82) of the [fhir-transform](https://github.com/NHSDigital/fhir-transforms) repository. This \nrepository contains the mapping definitions for various [UK Core](https://digital.nhs.uk/developer/api-catalogue/fhir-uk-core-standards) and [Care Connect](https://digital.nhs.uk/developer/api-catalogue/care-connect-fhir-standards) extensions.\n\n\n## Environments and testing\n\n| Environment | Base URL |\n| ----------------- | ---------------------------------------------------------------------- |\n| Integration test | `https://int.api.service.nhs.uk/fhir-converter` |\n| Production | Not yet available |\n\nOur [integration test environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing):\n- is for formal integration testing\n- is for receiving data quality reports of test data\n\nFor more details see [integration testing with our RESTful APIs](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing-with-our-restful-apis).\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\nErrors specific to each API are shown in the Endpoints section, under Response. See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#http-status-codes) for more on errors. \n","title":"FHIR Converter","version":"v1.0.288-alpha"},"servers":[{"description":"Sandbox environment.","url":"https://sandbox.api.service.nhs.uk/fhir-converter"},{"description":"Integration test environment.","url":"https://int.api.service.nhs.uk/fhir-converter"},{"description":"Production environment.","url":"https://api.service.nhs.uk/fhir-converter"}],"tags":[{"name":"FHIR Converter"}],"paths":{"/$convert":{"post":{"description":"## Overview\nUse this endpoint to convert resource types `MedicationRequest` and `MedicationStatements` from FHIR STU3 to FHIR R4 and vice versa.\n","operationId":"convert","requestBody":{"content":{"application/fhir+json; fhirVersion=3.0":{"examples":{"MedicationRequest":{"value":"{\n \"resourceType\": \"MedicationRequest\",\n \"text\": {\n \"status\": \"generated\",\n \"div\": \"
![\"\"](\"http://digital.nhs.uk/binaries/content/gallery/icons/info.svg?colour=231f20\")
\n