{"openapi":"3.0.0","x-nhs-api-spec-guid":"1b22efff-7b41-4fa0-9146-dc87686a7b5c","info":{"version":"v1.0.125-alpha","title":"Covid Medical Exemption - FHIR API","license":{"name":"MIT"},"contact":{"name":"NHS Digital API Management","url":"https://digital.nhs.uk/developer/help-and-support","email":"api.management@nhs.net"},"description":"
\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\nUse this API to access a patient’s coronavirus (COVID-19) medical exemption status.\n\nYou can:\n- get a patient's COVID-19 medical exemption status, based on their NHS number\n\nYou get the following data:\n- current COVID-19 medical exemption status\n- embedded Patient demographic details, including date of birth.\n\nThe patient demographic details might differ from those held in the [Personal Demographics Service (PDS)](https://digital.nhs.uk/services/demographics).\nTo get demographic details from PDS, use the [Personal Demographics Service FHIR API](https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir).\n\n### Data standards\n\nThis API uses the FHIR standard, and includes the resources:\n * [Bundle](https://www.hl7.org/fhir/bundle.html)\n * [Patient](https://www.hl7.org/fhir/patient.html)\n * [QuestionnaireResponse](https://www.hl7.org/fhir/questionnaireresponse.html)\n\nIt references resources:\n * [Questionnaire](https://www.hl7.org/fhir/questionnaire.html) specifically [COVID-19 Vaccination Medical Exemption Questionnaire](https://simplifier.net/resolve?target=simplifier&scope=uk.nhsdigital.r4&canonical=https://fhir.nhs.uk/Questionnaire/COVIDVaccinationMedicalExemption)\n\n### Data availability, timing and quality\nAll exemption records are verified to ensure the NHS number is correct before making them available via the API.\n\nIn most cases this is automatic, and the record is available within 48 hours of the exemption being recorded, sometimes sooner.\n\nWhere automated NHS number verification fails, we verify the NHS number manually, which can take longer.\n\nIn a very small number of cases, we are unable to verify the NHS number, and we do not make the medical exemption available at all.\n\n## Who can use this API\nThis API:\n- is only for use by patient-facing applications\n- is only for non-clinical use\n- can only be used where there is a legal basis to do so\n\nMake sure you have a valid use case before you go too far with your development.\nTo do this, [contact us](https://digital.nhs.uk/developer/help-and-support).\n\nYou 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\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/?tag=covid-medical-exemptions-api).\n\n## Technology\nThis API is [RESTful](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#basic-rest).\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\nIt includes some country-specific FHIR extensions, which conforms to [FHIR UK Core](https://digital.nhs.uk/services/fhir-uk-core), specifically [fhir.r4.ukcore.stu1 0.5.1](https://simplifier.net/packages/fhir.r4.ukcore.stu1/0.5.1).\n\nYou do not need to know much about FHIR to use this API - FHIR APIs are just RESTful APIs that follow specific rules.\nIn particular:\n- resource names are capitalised and singular, and use US spellings, for example `/QuestionnaireResponse` not `/questionnaireresponse`\n- array names are singular, for example `entry` not `entries` for address lines\n- data items that are country-specific and thus not included in the FHIR global base resources are usually wrapped in an `extension` object\n\nThere are [libraries and SDKs available](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#fhir-libraries-and-sdks) to help with FHIR API integration.\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).\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\nThis API has two access modes: \n* application-restricted access\n* user-restricted access\n\n### Application-restricted access\nThis access mode 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\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### User-restricted access\nUse this [user-restricted access mode](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis) if the end user is a patient:\n* the end user must have their identity verified to 'high' (P9) level\n* the NHS number in the request must match the NHS number in the NHS login account\n\nTo use this access mode, use the following security pattern:\n* [User-restricted RESTful APIs - NHS login separate authentication and authorisation](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/user-restricted-restful-apis-nhs-login-separate-authentication-and-authorisation)\n\n## Environments and testing\n| Environment | Base URL |\n| ----------------- | ----------------------------------------------------------------------- |\n| Sandbox | `https://sandbox.api.service.nhs.uk/covid-medical-exemptions/FHIR/R4` |\n| Integration test | `https://int.api.service.nhs.uk/covid-medical-exemptions/FHIR/R4` |\n| Production | `https://api.service.nhs.uk/covid-medical-exemptions/FHIR/R4` |\n\n### Sandbox testing\n\nOur [sandbox environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#sandbox-testing):\n\n* is for early developer testing\n* only covers a limited set of scenarios\n* is open access, so does not allow you to test authorisation\n\nFor details of sandbox test scenarios, or to try out the sandbox using our 'Try this API' feature, see the documentation for each endpoint.\n\nAlternatively, you can try out the sandbox using our Postman collection:\n\n### Integration testing\nOur [integration test environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing):\n* is for formal integration testing\n* includes authorisation\n\nCurrently, the integration test environment returns a single static response, the same one as the sandbox environment - regardless of what request parameters you send.\nIn due course we will change it to support more scenarios.\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## Onboarding\n\nThis API is [retired](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses) and not available for use.\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"},"servers":[{"url":"https://sandbox.api.service.nhs.uk/covid-medical-exemptions/FHIR/R4","description":"Sandbox environment."},{"url":"https://int.api.service.nhs.uk/covid-medical-exemptions/FHIR/R4","description":"Integration test environment."},{"url":"https://api.service.nhs.uk/covid-medical-exemptions/FHIR/R4","description":"Production environment."}],"paths":{"/QuestionnaireResponse":{"get":{"summary":"Get current COVID-19 medical exemption status","operationId":"get-covid-medical-exemption","description":"Given an NHS number, get the patient's current COVID-19 medical exemption status.\nAlso returns the patient's demographic details, as captured at the point of the exemption decision being made.\n\n## Sandbox testing\nYou can test the following scenarios in our sandbox environment:\n\nSample outputs are generated using any patient.identifer where the remainder of dividing by 5. (i.e. id % 5 == X)\n\n| Scenario | Request | Response |\n| ------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------- |\n| No Current Exemption | `patient.identifier` = https://fhir.nhs.uk/Id/nhs-number| | HTTP Status 200 with empty bundle in response body |\n| Exempt from Vaccination | `patient.identifier` = https://fhir.nhs.uk/Id/nhs-number| | HTTP Status 200 with exemption data in response body |\n| Exempt from Vaccination and Testing | `patient.identifier` = https://fhir.nhs.uk/Id/nhs-number| | HTTP Status 200 with exemption data in response body |\n| Declined for Vaccination | `patient.identifier` = https://fhir.nhs.uk/Id/nhs-number| | HTTP Status 200 with exemption data in response body |\n| Declined for Vaccination and Testing | `patient.identifier` = https://fhir.nhs.uk/Id/nhs-number| | HTTP Status 200 with exemption data in response body |\n\nYou can try out the sandbox using the 'Try this API' feature on this page.\n","parameters":[{"name":"patient.identifier","in":"query","description":"The patient's NHS number.\nExpressed as `|` where `` must be `https://fhir.nhs.uk/Id/nhs-number` and `` must be a [valid NHS number](https://www.datadictionary.nhs.uk/attributes/nhs_number.html).\n","required":true,"schema":{"type":"string","pattern":"^https:\\/\\/fhir\\.nhs\\.uk\\/Id\\/nhs-number\\|[0-9]+$","example":"https://fhir.nhs.uk/Id/nhs-number|9912003888"}},{"name":"questionnaire","in":"query","description":"The questionnaire to be consumed\n","schema":{"type":"string","example":"https://fhir.nhs.uk/Questionnaire/COVIDVaccinationMedicalExemption"}},{"name":"Authorization","in":"header","description":"An OAuth 2.0 bearer token, obtained using our [NHS login pattern](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/user-restricted-restful-apis-nhs-login-separate-authentication-and-authorisation).\n","schema":{"type":"string","pattern":"^Bearer\\ .+$","example":"Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM"}},{"name":"X-Correlation-ID","in":"header","required":false,"description":"An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters.\n\nMirrored back in a response header.\n","schema":{"type":"string","format":"uuid","example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA"}}],"responses":{"200":{"description":"The request was valid, and the response contains a current exemption and associated patient details.\nIf there are no exemptions for the given NHS number, the response bundle will be empty.\n","headers":{"X-Correlation-Id":{"schema":{"type":"string","example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA"},"description":"The X-Correlation-ID from the request header, if supplied, mirrored back.\n"}},"content":{"application/fhir+json":{"schema":{"type":"object","properties":{"resourceType":{"type":"string","enum":["Bundle"]},"type":{"type":"string","enum":["searchset"]},"entry":{"type":"array","items":{"type":"object","properties":{"fullUrl":{"type":"string"},"resource":{"type":"object","description":"A structured set of questions and their answers. The questions are ordered \nand grouped into coherent subsets, corresponding to the structure of the \ngrouping of the questionnaire being responded to.\n","properties":{"resourceType":{"description":"This is a QuestionnaireResponse resource\n","type":"string"},"id":{"description":"The logical id of the resource, as used in the URL for the resource. Once\nassigned, this value never changes.\n","type":"string"},"questionnaire":{"description":"The Questionnaire that defines and organizes the questions for which \nanswers are being provided.\n","type":"string"},"status":{"type":"string","enum":["in-progress","completed","amended","entered-in-error","stopped"]},"subject":{"type":"object","description":"The subject of the questionnaire response. This could be a patient, \norganization, practitioner, device, etc. This is who/what the answers \napply to, but is not necessarily the source of information.\n","properties":{"reference":{"type":"string"},"identifier":{"type":"object","properties":{"system":{"type":"string"},"value":{"type":"string"}}},"display":{"type":"string"}},"additionalProperties":false,"required":["identifier","display"]},"contained":{"type":"object","description":"These resources do not have an independent existence apart from the resource \nthat contains them - they cannot be identified independently, and nor can they\nhave their own independent transaction scope.\n","properties":{"id":{"type":"string"},"resourceType":{"type":"string","enum":["Patient"]},"birthDate":{"type":"string"}},"additionalProperties":false,"required":["id","resourceType","birthDate"]},"item":{"type":"array","items":{"type":"object","description":"A structured set of questions and their answers. The questions are ordered and\ngrouped into coherent subsets, corresponding to the structure of the grouping\nof the questionnaire being responded to.\n","properties":{"linkId":{"description":"The item from the Questionnaire that corresponds to this item in the\nQuestionnaireResponse resource.\n","type":"string"},"answer":{"type":"array","description":"The respondent\\u0027s answer(s) to the question.\n","items":{"type":"object","description":"A structured set of questions and their answers. The questions are ordered and\ngrouped into coherent subsets, corresponding to the structure of the grouping\nof the questionnaire being responded to.\n","properties":{"valueDateTime":{"type":"string","description":"The answer (or one of the answers) provided by the respondent to the\nquestion.\n","pattern":"^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$"},"valueCoding":{"type":"object","description":"The value of the input parameter as a basic type.\n","properties":{"code":{"description":"A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax \ndefined by the coding system (e.g. post-coordination).\n","type":"string"},"display":{"description":"A representation of the meaning of the code in the system, following\nthe rules of the system.\n","type":"string"}}}}}}},"additionalProperties":false,"required":["linkId","answer"]}}},"additionalProperties":false}},"additionalProperties":false}}},"additionalProperties":false,"required":["resourceType","type"]},"example":{"resourceType":"Bundle","type":"searchset","entry":[{"fullUrl":"QuestionnaireResponse/106218-1.1","resource":{"resourceType":"QuestionnaireResponse","id":"106218-1.1","questionnaire":"https://fhir.nhs.uk/Questionnaire/COVIDVaccinationMedicalExemption","status":"completed","subject":{"reference":"#p1","identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"6077782459"},"display":"Ivor Fritagelse"},"contained":[{"id":"p1","resourceType":"Patient","birthDate":"1965-02-28"}],"item":[{"linkId":"exemptionStatus","answer":[{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/covid-vaccination-medical-exemption","code":"2","display":"Approved: Exemption from COVID vaccination and testing"}}]},{"linkId":"exemptionPeriodStart","answer":[{"valueDateTime":"2021-09-29T12:58:01+00:00"}]},{"linkId":"exemptionPeriodEnd","answer":[{"valueDateTime":"2021-11-12T12:59:01+00:00"}]}]}}]}}}},"4XX":{"description":"An error occurred as follows:\n\n| HTTP status | Error code | Description |\n| ----------- | -------------------------- | -------------------------------------------------------------------- |\n| 400 | `processing` | Missing or invalid NHS number |\n| 400 | `processing` | Missing or invalid questionnaire |\n| 401 | `processing` | Missing or invalid ID token |\n| 401 | `processing` | Missing or invalid OAuth 2.0 bearer token |\n| 401 | `processing` | NHS number in request doesn't match NHS number in NHS login account |\n\nFor details see the `diagnostics` field.\n","content":{"application/fhir+json":{"schema":{"type":"object","description":"Outcome of an operation that does not result in a resource or bundle being returned, for example an error or an async/batch submission.\nThere are a number of possible error codes that can be returned along with a more detailed description in the `diagnostics` field.\n","required":["resourceType","issue"],"properties":{"resourceType":{"type":"string","description":"FHIR Resource Type.","default":"OperationOutcome"},"issue":{"type":"array","description":"List of issues that have occurred.","minItems":1,"items":{"type":"object","required":["severity","code"],"properties":{"severity":{"type":"string","enum":["fatal","error","warning","information"],"description":"Severity of the error.","example":"error"},"code":{"type":"string","description":"FHIR error code.","example":"invalid","enum":["processing"]},"diagnostics":{"type":"string","description":"Additional diagnostic information about the issue.","example":"Unknown search parameter 'codeing' for resource type 'Immunization'."}}}}}},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"processing","diagnostics":"Unknown search parameter 'coding' for resource type 'QuestionnaireResponse'."}]}}}}}}}},"components":{"schemas":{"Bundle":{"type":"object","properties":{"resourceType":{"type":"string","enum":["Bundle"]},"type":{"type":"string","enum":["searchset"]},"entry":{"type":"array","items":{"type":"object","properties":{"fullUrl":{"type":"string"},"resource":{"type":"object","description":"A structured set of questions and their answers. The questions are ordered \nand grouped into coherent subsets, corresponding to the structure of the \ngrouping of the questionnaire being responded to.\n","properties":{"resourceType":{"description":"This is a QuestionnaireResponse resource\n","type":"string"},"id":{"description":"The logical id of the resource, as used in the URL for the resource. Once\nassigned, this value never changes.\n","type":"string"},"questionnaire":{"description":"The Questionnaire that defines and organizes the questions for which \nanswers are being provided.\n","type":"string"},"status":{"type":"string","enum":["in-progress","completed","amended","entered-in-error","stopped"]},"subject":{"type":"object","description":"The subject of the questionnaire response. This could be a patient, \norganization, practitioner, device, etc. This is who/what the answers \napply to, but is not necessarily the source of information.\n","properties":{"reference":{"type":"string"},"identifier":{"type":"object","properties":{"system":{"type":"string"},"value":{"type":"string"}}},"display":{"type":"string"}},"additionalProperties":false,"required":["identifier","display"]},"contained":{"type":"object","description":"These resources do not have an independent existence apart from the resource \nthat contains them - they cannot be identified independently, and nor can they\nhave their own independent transaction scope.\n","properties":{"id":{"type":"string"},"resourceType":{"type":"string","enum":["Patient"]},"birthDate":{"type":"string"}},"additionalProperties":false,"required":["id","resourceType","birthDate"]},"item":{"type":"array","items":{"type":"object","description":"A structured set of questions and their answers. The questions are ordered and\ngrouped into coherent subsets, corresponding to the structure of the grouping\nof the questionnaire being responded to.\n","properties":{"linkId":{"description":"The item from the Questionnaire that corresponds to this item in the\nQuestionnaireResponse resource.\n","type":"string"},"answer":{"type":"array","description":"The respondent\\u0027s answer(s) to the question.\n","items":{"type":"object","description":"A structured set of questions and their answers. The questions are ordered and\ngrouped into coherent subsets, corresponding to the structure of the grouping\nof the questionnaire being responded to.\n","properties":{"valueDateTime":{"type":"string","description":"The answer (or one of the answers) provided by the respondent to the\nquestion.\n","pattern":"^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$"},"valueCoding":{"type":"object","description":"The value of the input parameter as a basic type.\n","properties":{"code":{"description":"A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax \ndefined by the coding system (e.g. post-coordination).\n","type":"string"},"display":{"description":"A representation of the meaning of the code in the system, following\nthe rules of the system.\n","type":"string"}}}}}}},"additionalProperties":false,"required":["linkId","answer"]}}},"additionalProperties":false}},"additionalProperties":false}}},"additionalProperties":false,"required":["resourceType","type"]},"QuestionnaireResponse":{"type":"object","description":"A structured set of questions and their answers. The questions are ordered \nand grouped into coherent subsets, corresponding to the structure of the \ngrouping of the questionnaire being responded to.\n","properties":{"resourceType":{"description":"This is a QuestionnaireResponse resource\n","type":"string"},"id":{"description":"The logical id of the resource, as used in the URL for the resource. Once\nassigned, this value never changes.\n","type":"string"},"questionnaire":{"description":"The Questionnaire that defines and organizes the questions for which \nanswers are being provided.\n","type":"string"},"status":{"type":"string","enum":["in-progress","completed","amended","entered-in-error","stopped"]},"subject":{"type":"object","description":"The subject of the questionnaire response. This could be a patient, \norganization, practitioner, device, etc. This is who/what the answers \napply to, but is not necessarily the source of information.\n","properties":{"reference":{"type":"string"},"identifier":{"type":"object","properties":{"system":{"type":"string"},"value":{"type":"string"}}},"display":{"type":"string"}},"additionalProperties":false,"required":["identifier","display"]},"contained":{"type":"object","description":"These resources do not have an independent existence apart from the resource \nthat contains them - they cannot be identified independently, and nor can they\nhave their own independent transaction scope.\n","properties":{"id":{"type":"string"},"resourceType":{"type":"string","enum":["Patient"]},"birthDate":{"type":"string"}},"additionalProperties":false,"required":["id","resourceType","birthDate"]},"item":{"type":"array","items":{"type":"object","description":"A structured set of questions and their answers. The questions are ordered and\ngrouped into coherent subsets, corresponding to the structure of the grouping\nof the questionnaire being responded to.\n","properties":{"linkId":{"description":"The item from the Questionnaire that corresponds to this item in the\nQuestionnaireResponse resource.\n","type":"string"},"answer":{"type":"array","description":"The respondent\\u0027s answer(s) to the question.\n","items":{"type":"object","description":"A structured set of questions and their answers. The questions are ordered and\ngrouped into coherent subsets, corresponding to the structure of the grouping\nof the questionnaire being responded to.\n","properties":{"valueDateTime":{"type":"string","description":"The answer (or one of the answers) provided by the respondent to the\nquestion.\n","pattern":"^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$"},"valueCoding":{"type":"object","description":"The value of the input parameter as a basic type.\n","properties":{"code":{"description":"A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax \ndefined by the coding system (e.g. post-coordination).\n","type":"string"},"display":{"description":"A representation of the meaning of the code in the system, following\nthe rules of the system.\n","type":"string"}}}}}}},"additionalProperties":false,"required":["linkId","answer"]}}},"additionalProperties":false},"OperationOutcome":{"type":"object","description":"Outcome of an operation that does not result in a resource or bundle being returned, for example an error or an async/batch submission.\nThere are a number of possible error codes that can be returned along with a more detailed description in the `diagnostics` field.\n","required":["resourceType","issue"],"properties":{"resourceType":{"type":"string","description":"FHIR Resource Type.","default":"OperationOutcome"},"issue":{"type":"array","description":"List of issues that have occurred.","minItems":1,"items":{"type":"object","required":["severity","code"],"properties":{"severity":{"type":"string","enum":["fatal","error","warning","information"],"description":"Severity of the error.","example":"error"},"code":{"type":"string","description":"FHIR error code.","example":"invalid","enum":["processing"]},"diagnostics":{"type":"string","description":"Additional diagnostic information about the issue.","example":"Unknown search parameter 'codeing' for resource type 'Immunization'."}}}}}}}}}