{"openapi":"3.0.0","x-nhs-api-spec-guid":"1b22efff-7b41-4fa0-9146-dc87686a7b5c","info":{"version":"v1.0.498-alpha","title":"Immunisation History - 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":"## Overview\nUse this API to access a patient's immunisation history.\n\nYou can:\n\n- get a patient's coronavirus (`COVID-19`) immunisation history, based on their NHS number\n- get a patient's influenza (`FLU`) immunisation history, based on their NHS number\n- get a patient's human papillomavirus (`HPV`) immunisation history, based on their NHS number\n\nYou cannot currently use this API to:\n\n- get details of other types of immunisation\n\nYou get the following data:\n\n- immunisation event details\n- patient demographic details, as captured at the point of immunisation\n\nThe patient demographic details might differ from those held in the Personal Demographics Service (PDS). To get demographic details from PDS, use the [Personal Demographics FHIR API](https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir).\n\n### Data availability, timing and quality\nAll immunisation 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 immunisation event, 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 immunisation record available at all.\n\nThe `COVID-19` data store is limited to vaccinations from England, Wales and The Isle of Man for the last 4 years. It has been approved to be used for clinical use cases.\n\nThe `FLU` data store is not yet populated and is planned to contain vaccination events captured through a point of care system in England for the last year. It has been approved to be used for clinical use cases.\n\nThe `HPV` data store is not yet populated and is planned to be limited at first with vaccinations captured by the NHAIS system and in England only. It has been approved for use in clinical use cases.\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. \n\nYou must demonstrate you have a valid use case as part of digital onboarding.\n\nYou must do this before you can go live (see 'Onboarding' below).\n\n### Who can access immunisation history records\nHealth and care organisations in England and the Isle of Man can access immunisation history records. \n\nLegitimate direct care examples include NHS organisations delivering healthcare, local authorities delivering care, third sector and private sector health and care organisations, and developers delivering systems to health and care organisations.\n\nHealth and care organisations in Scotland, Northern Ireland and the Channel Islands access their own equivalents of this API.\n\nPatients who receive health and social care or make use of NHS services in England, Wales and the Isle of Man. \n\n## API status and roadmap\nThis API is [in production](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses).\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=immunisation-history-api).\n\nIf you have any other queries, [contact us](https://digital.nhs.uk/developer/help-and-support).\n\n## Service level\n\nThis API is a platinum service, meaning it is operational and supported 24 x 7 x 365.\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 [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 conform 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 `/Immunization` not `/immunisations`\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\n\nThis API has two access modes: \n* application-restricted access\n* user-restricted access\n\n### Application-restricted access\n\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\n\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/immunisation-history/FHIR/R4/`     |\n| Integration test  | `https://int.api.service.nhs.uk/immunisation-history/FHIR/R4/`         |\n| Production        | `https://api.service.nhs.uk/immunisation-history/FHIR/R4/`             |\n\n### Sandbox testing\nOur [sandbox environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#sandbox-testing):\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[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/b7dfde415e5726658d09)\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\nIt also includes ready-to-use [immunisation history test data](https://digital.nhs.uk/developer/api-catalogue/immunisation-history-fhir/immunisation-history-fhir-api-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## Onboarding\nYou need to get your software approved by us before it can go live with this API. We call this onboarding. The onboarding process can sometimes be quite long, so it’s worth planning well ahead.  \n\nAs part of this process, you need to demonstrate that you can manage risks and that your software conforms technically with the requirements for this API. \n\nInformation on this page might impact the design of your software. For details, see [Onboarding support information](https://digital.nhs.uk/developer/api-catalogue/immunisation-history-fhir/onboarding-support-information). \n\nTo understand how our online digital onboarding process works, see [digital onboarding](https://digital.nhs.uk/developer/guides-and-documentation/digital-onboarding#using-the-digital-onboarding-portal). \n\n<div class=\"nhsd-m-emphasis-box nhsd-m-emphasis-box--emphasis nhsd-!t-margin-bottom-6\" aria-label=\"Highlighted Information\">\n    <div class=\"nhsd-a-box nhsd-a-box--border-blue\">\n        <div class=\"nhsd-m-emphasis-box__image-box\">\n            <figure class=\"nhsd-a-image\">\n                <picture class=\"nhsd-a-image__picture\">\n                    <img src=\"http://digital.nhs.uk/binaries/content/gallery/icons/play-circle.svg?colour=231f20\" alt=\"\" style=\"object-fit:fill\">\n                </picture>\n            </figure>\n        </div>\n        <div class=\"nhsd-m-emphasis-box__content-box\">\n            <div data-uipath=\"website.contentblock.emphasis.content\" class=\"nhsd-t-word-break\"><p class=\"nhsd-t-body\">To get started, sign in or create a <a href=\"http://onboarding.prod.api.platform.nhs.uk/\">developer account</a>, then select 'product onboarding'.</p></div>            \n        </div>\n    </div>\n</div> \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/immunisation-history/FHIR/R4","description":"Sandbox environment."},{"url":"https://int.api.service.nhs.uk/immunisation-history/FHIR/R4","description":"Integration test environment."},{"url":"https://api.service.nhs.uk/immunisation-history/FHIR/R4","description":"Production environment."}],"paths":{"/Immunization":{"get":{"summary":"Get immunisation history","operationId":"get-immunisation-history","description":"Given an NHS number, get the patient's immunisation history.\nAlso returns the patient's demographic details, as captured at the point of immunisation.\n\n## Sandbox testing\nYou can test the following scenarios in our sandbox environment:\n\n| Scenario                      | Request                                                              | Response                                                |\n| ----------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------- |\n| Immunisation history found    | `patient.identifier`=`https://fhir.nhs.uk/Id/nhs-number\\|9000000009` | HTTP Status 200 with immunisation data in response body |\n| No immunisations found        | `patient.identifier`=`https://fhir.nhs.uk/Id/nhs-number\\|9000000033` | HTTP Status 200 with empty bundle in response body      |\n| Bad Request                   | `patient.identifier`= anything else                                  | HTTP Status 400 Bad Request                             |\n\n\nYou can try out the sandbox using the 'Try this API' feature on this page.\n\nAlternatively, you can try out the sandbox using our Postman collection:\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/b7dfde415e5726658d09)\n","parameters":[{"name":"patient.identifier","in":"query","description":"The patient's NHS number.\nExpressed as `<type>|<value>` where `<type>` must be `https://fhir.nhs.uk/Id/nhs-number` and `<value>` must be a [valid NHS number](https://www.datadictionary.nhs.uk/attributes/nhs_number.html).\n","required":true,"schema":{"type":"string","example":"https://fhir.nhs.uk/Id/nhs-number|9000000009"}},{"name":"procedure-code:below","deprecated":true,"in":"query","description":"Parent SNOMED immunisation procedure code.\nFor example, `90640007`, which is the parent code for all COVID-19 vaccinations.\nThis parameter has been deprecated and will be replaced by the `immunization.target` parameter.\n","required":false,"schema":{"type":"string","description":"Parent SNOMED code for all COVID-19 vaccinations."}},{"name":"immunization.target","in":"query","description":"Immunization History is segmented into multiple Data Stores, which may target specific procedures, disorders, diseases, infections or organisms.\n","schema":{"type":"string","example":"COVID19","enum":["COVID19","HPV","FLU"]}},{"name":"date.from","in":"query","description":"The earliest date to be included (e.g. 2020-01-01)\n","schema":{"type":"string","format":"date","default":"1900-01-01"}},{"name":"date.to","in":"query","description":"The latest date to be included (e.g. 2020-12-31)\n","schema":{"type":"string","format":"date","default":"9999-12-31"}},{"name":"_include","in":"query","description":"Specifies other resources to be included in the response along with the immunisations.\nMust be `Immunization:patient`, which will include patient demographic details.\n","required":true,"schema":{"type":"string","example":"Immunization:patient"}},{"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","required":true,"schema":{"type":"string","format":"^Bearer\\ [[:ascii:]]+$","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","example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA"}},{"name":"Accept","in":"header","required":false,"description":"Optional header to select the version of the api. Version number will follow semver.\n","schema":{"type":"string","example":"version=1.0, version=2.0"}}],"responses":{"200":{"description":"The request was valid, and the response contains immunisation history and associated patient details.\nIf there are no immunisations 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":{"description":"FHIR Bundle containing the query results - a list of matching immunisations and associated patients.","type":"object","required":["resourceType","type","total","entry"],"properties":{"resourceType":{"description":"FHIR resource type. Always `Bundle`.","type":"string","example":"Bundle"},"type":{"description":"Indicates how the bundle is intended to be used. Always `searchset`.","type":"string","example":"searchset"},"total":{"description":"Number of matching immunisations found.","type":"integer","example":2},"entry":{"description":"List of matching immunisations and associated patients. If there were no matching immunisations, this is an empty list.","type":"array","items":{"type":"object","required":["fullUrl","resource","search"],"properties":{"fullUrl":{"description":"URI for the Immunization or Patient resource.","type":"string","example":"urn:uuid:edea022a-2d81-11eb-adc1-0242ac120001"},"resource":{"description":"The Immunization or Patient resource.","oneOf":[{"description":"A matching immunisation, formatted as a FHIR Immunization resource.","type":"object","required":["resourceType","extension","identifier","status","vaccineCode","patient","occurrenceDateTime","primarySource","performer"],"properties":{"resourceType":{"description":"FHIR resource type. Always `Immunization`.","type":"string","example":"Immunization"},"extension":{"description":"FHIR extension wrapper for the vaccination procedure performed. Always contains exactly one object.","type":"array","minItems":1,"maxItems":1,"items":{"type":"object","required":["url","valueCodeableConcept"],"properties":{"url":{"description":"URI for the type of extension - in this case a vaccination procedure.","type":"string","example":"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure"},"valueCodeableConcept":{"description":"Wrapper for the vaccination procedure details.","type":"object","required":["coding"],"properties":{"coding":{"description":"Wrapper for the vaccination procedure details.","type":"array","items":{"type":"object","required":["system","code","display"],"properties":{"system":{"description":"Coding system used for the vaccination procedure. Always SNOMED.","type":"string","example":"http://snomed.info/sct"},"code":{"description":"SNOMED code for the vaccination procedure.","type":"string","example":"1324681000000101"},"display":{"description":"Description of the vaccination procedure.","type":"string","example":"Administration of first dose of severe acute respiratory syndrome coronavirus 2 vaccine (procedure)"}}}}}}}}},"identifier":{"description":"Unique identifier for this immunisation record, as generated by the source system.","type":"array","minItems":1,"maxItems":1,"items":{"type":"object","required":["use","system","value"],"properties":{"use":{"description":"Identifier use as defined by https://www.hl7.org/fhir/valueset-identifier-use.html.","type":"string","enum":["usual","official","temp","secondary","old"],"example":"secondary"},"system":{"description":"URI of the namespace of this identifier.","type":"string","example":"https://supplierABC/identifiers/vacc"},"value":{"description":"Identifier value within `system`.","type":"string","example":"1324761000000100"}}}},"status":{"description":"Status of the immunisation event. This is *not* an indication of patient immunity, only whether the immunisation was completed or not. Currently we only return details of completed immunisations.","type":"string","enum":["completed"],"example":"completed"},"vaccineCode":{"description":"Vaccine product administered.","type":"object","required":["coding"],"properties":{"coding":{"description":"Wrapper for the vaccine product details.","type":"array","minItems":1,"maxItems":1,"items":{"type":"object","required":["system","code","display"],"properties":{"system":{"description":"Coding system for type of administered vaccine. Always SNOMED.","type":"string","example":"http://snomed.info/sct"},"code":{"description":"SNOMED code for the vaccine product.","type":"string","example":"39114911000001105"},"display":{"description":"Description of the vaccine product.","type":"string","example":"COVID-19 Vaccine AstraZeneca (ChAdOx1 S [recombinant]) 5x10,000,000,000 viral particles/0.5ml dose solution for injection multidose vials (AstraZeneca UK Ltd) (product)"}}}}}},"patient":{"description":"The patient who was immunised.","type":"object","required":["reference","type","identifier"],"properties":{"reference":{"description":"URI for the associated Patient resource in the bundle.","type":"string","example":"urn:uuid:edea022a-2d81-11eb-adc1-0242ac120002"},"type":{"description":"Type of resource this reference refers to. Always `Patient`.","type":"string","example":"Patient"},"identifier":{"description":"Business identifier for linked Patient. Always an NHS number.","type":"object","required":["system","value"],"properties":{"system":{"description":"URI of coding system used to identify linked patient.","type":"string","example":"https://fhir.nhs.uk/Id/nhs-number"},"value":{"description":"Value in coding system representing linked patient.","type":"string","example":"9000000009"}}}}},"occurrenceDateTime":{"description":"Date and time of immunisation.","type":"string","example":"2020-12-23T13:00:08.476000+00:00"},"recorded":{"description":"The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.","type":"string","example":"2020-12-23"},"primarySource":{"description":"An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.","type":"boolean","example":true},"reportOrigin":{"description":"Origin of the vaccination report, if not from the primary source. Only present if `primarySource`=`false`.","type":"object","required":["text"],"properties":{"text":{"description":"Text description of the origin of the vaccination report.","type":"string","example":"RR8 - LEEDS TEACHING HOSPITALS NHS TRUST"}}},"manufacturer":{"description":"Vaccine manufacturer details.","type":"object","required":["display"],"properties":{"display":{"description":"Decsription of the vaccine manufacturer.","type":"string","example":"AstraZeneca Ltd"}}},"lotNumber":{"description":"Lot number of the vaccine product. Present if and only if `status`=`completed`.","type":"string","example":"R04X"},"expirationDate":{"description":"Date vaccine batch expires.","type":"string","example":"2021-04-29"},"route":{"description":"The path by which the vaccine product is taken into the body.","type":"object","required":["coding"],"properties":{"coding":{"description":"Wrapper for the vaccination route details.","type":"array","minItems":1,"items":{"type":"object","required":["system","code","display"],"properties":{"system":{"description":"Coding system used to describe vaccination route. Always SNOMED.","type":"string","example":"http://snomed.info/sct"},"code":{"description":"Code for the vaccination route.","type":"string","example":"78421000"},"display":{"description":"Description of the vaccination route.","type":"string","example":"Intramuscular route (qualifier value)"}}}}}},"doseQuantity":{"description":"The quantity of vaccine product that was administered.","type":"object","required":["unit","system","code"],"properties":{"value":{"description":"Number of units administered.","type":"number","example":1},"unit":{"description":"Description of unit.","type":"string","example":"pre-filled disposable injection"},"system":{"description":"System that defines coded unit form.","type":"string","example":"http://snomed.info/sct"},"code":{"description":"Code describing the unit.","type":"string","example":"3318611000001103"}}},"performer":{"description":"Details of the organisation that performed the immunisation.","type":"array","minItems":1,"maxItems":1,"items":{"type":"object","required":["actor"],"properties":{"actor":{"description":"Organisation that performed the immunisation.","type":"object","required":["type","identifier"],"properties":{"type":{"description":"Type of actor. Always `Organisation`.","type":"string","example":"Organisation"},"identifier":{"description":"Organisation identifier.","type":"object","required":["system","value"],"properties":{"system":{"description":"Coding system used for the organisation identifier. Always `https://fhir.nhs.uk/Id/ods-organization-code`.","type":"string","example":"https://fhir.nhs.uk/Id/ods-organization-code"},"value":{"description":"Organisation's ODS code.","type":"string","example":"RX809"}}}}}}}},"reasonCode":{"description":"Reasons why the vaccine was administered.","type":"array","minItems":1,"items":{"type":"object","required":["coding"],"properties":{"coding":{"description":"Wrapper for the reason code details.","type":"array","minItems":1,"items":{"type":"object","required":["system","code","display"],"properties":{"system":{"description":"Coding system used to describe the reason for administration of vaccine. Always SNOMED.","type":"string","example":"http://snomed.info/sct"},"code":{"description":"SNOMED code for the vaccination reason.","type":"string","example":"443684005"},"display":{"description":"Description of the vaccination reason.","type":"string","example":"Disease outbreak (event)"}}}}}}},"protocolApplied":{"description":"The protocol (set of recommendations) being followed by the provider who administered the dose. Present only if it contains any elements.","type":"array","minItems":1,"items":{"type":"object","required":["doseNumberPositiveInt"],"properties":{"doseNumberPositiveInt":{"description":"Dose number within a series of doses.","type":"integer","example":1}}}}}},{"description":"Demographic information about the patient receiving an immunisation.","type":"object","required":["resourceType","identifier","birthDate"],"properties":{"resourceType":{"description":"FHIR resource type. Always `Patient`.","type":"string","example":"Patient"},"identifier":{"description":"Unique identifier for this patient. Always an NHS number.","type":"array","minItems":1,"items":{"type":"object","required":["system","value"],"properties":{"system":{"description":"Coding system used to identify patients.","type":"string","example":"https://fhir.nhs.uk/Id/nhs-number"},"value":{"description":"Code identifying the patient.","type":"string","example":"9000000009"}}}},"birthDate":{"description":"Patient's date of birth.","type":"string","example":"1965-02-28"}}}]},"search":{"description":"Search-related information for the Immunization or Patient resource.","type":"object","required":["mode"],"properties":{"mode":{"description":"Indicates why this resource is in the result set. For Immunization resources this is always `match` and for Patient resources it is always `include`.","enum":["match","include"]}}}}}}}},"example":{"resourceType":"Bundle","type":"searchset","total":2,"entry":[{"fullUrl":"urn:uuid:d11c69d8-7a50-4a54-a848-7648121e995f","resource":{"id":"90640007.747583-127","resourceType":"Immunization","extension":[{"url":"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure","valueCodeableConcept":{"coding":[{"system":"http://snomed.info/sct","code":"1324681000000101","display":"Administration of first dose of severe acute respiratory syndrome coronavirus 2 vaccine (procedure)"}]}}],"identifier":[{"use":"secondary","system":"https://supplierABC/identifiers/vacc","value":"1324761000000100"}],"status":"completed","vaccineCode":{"coding":[{"system":"http://snomed.info/sct","code":"39114911000001105","display":"COVID-19 Vaccine AstraZeneca (ChAdOx1 S [recombinant]) 5x10,000,000,000 viral particles/0.5ml dose solution for injection multidose vials (AstraZeneca UK Ltd) (product)"}]},"patient":{"reference":"urn:uuid:124fcb63-669c-4a3c-af2b-caf55de167ec","type":"Patient","identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}},"occurrenceDateTime":"2020-12-10T13:00:08.476000+00:00","recorded":"2020-12-10T00:00:00+00:00","primarySource":true,"manufacturer":{"display":"AstraZeneca Ltd"},"lotNumber":"R04X","expirationDate":"2021-04-29","site":{"coding":[{"system":"http://snomed.info/sct","code":"368208006","display":"Left upper arm structure (body structure)"}]},"route":{"coding":[{"system":"http://snomed.info/sct","code":"78421000","display":"Intramuscular route (qualifier value)"}]},"doseQuantity":{"system":"http://snomed.info/sct","value":1,"unit":"pre-filled disposable injection","code":"3318611000001103"},"performer":[{"actor":{"type":"Organization","identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"RX809"},"display":"TEST-SITE"}}],"reasonCode":[{"coding":[{"system":"http://snomed.info/sct","code":"443684005","display":"Disease outbreak (event)"}]}],"protocolApplied":[{"doseNumberPositiveInt":1}],"location":{"identifier":{"system":"urn:iso:std:iso:3166","value":"GB"}}},"search":{"mode":"match"}},{"fullUrl":"urn:uuid:8da02505-db94-40b6-a8ed-d5af5628e28c","resource":{"id":"90640007.747583-128","resourceType":"Immunization","extension":[{"url":"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure","valueCodeableConcept":{"coding":[{"system":"http://snomed.info/sct","code":"1324681000000102","display":"Administration of first dose of severe acute respiratory syndrome coronavirus 2 vaccine (procedure)"}]}}],"identifier":[{"use":"secondary","system":"https://supplierABC/identifiers/vacc","value":"1324761000000102"}],"status":"completed","vaccineCode":{"coding":[{"system":"http://snomed.info/sct","code":"39114911000001105","display":"COVID-19 Vaccine AstraZeneca (ChAdOx1 S [recombinant]) 5x10,000,000,000 viral particles/0.5ml dose solution for injection multidose vials (AstraZeneca UK Ltd) (product)"}]},"patient":{"reference":"urn:uuid:124fcb63-669c-4a3c-af2b-caf55de167ec","type":"Patient","identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}},"occurrenceDateTime":"2020-12-31T13:00:08.476000+00:00","recorded":"2020-12-31T00:00:00+00:00","primarySource":true,"manufacturer":{"display":"AstraZeneca Ltd"},"lotNumber":"R04X","expirationDate":"2021-04-29","site":{"coding":[{"system":"http://snomed.info/sct","code":"368208006","display":"Left upper arm structure (body structure)"}]},"route":{"coding":[{"system":"http://snomed.info/sct","code":"78421000","display":"Intramuscular route (qualifier value)"}]},"doseQuantity":{"system":"http://snomed.info/sct","value":1,"unit":"pre-filled disposable injection","code":"3318611000001103"},"performer":[{"actor":{"type":"Organization","identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"RX809"},"display":"TEST-SITE"}}],"reasonCode":[{"coding":[{"system":"http://snomed.info/sct","code":"443684005","display":"Disease outbreak (event)"}]}],"protocolApplied":[{"doseNumberPositiveInt":1}],"location":{"identifier":{"system":"urn:iso:std:iso:3166","value":"GB"}}},"search":{"mode":"match"}},{"fullUrl":"urn:uuid:124fcb63-669c-4a3c-af2b-caf55de167ec","resource":{"id":"9000000009","resourceType":"Patient","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}],"birthDate":"1965-02-28"},"search":{"mode":"include"}}]}}}},"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, invalid or conflicting parent SNOMED code / Target         |\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 'codeing' for resource type 'Immunization'."}]}}}}}}}},"components":{"parameters":{"Dummy":{"name":"dummy","in":"path","description":"Dummy.","required":true,"schema":{"type":"string","example":"DUMMY"}}},"schemas":{"Patient":{"description":"Demographic information about the patient receiving an immunisation.","type":"object","required":["resourceType","identifier","birthDate"],"properties":{"resourceType":{"description":"FHIR resource type. Always `Patient`.","type":"string","example":"Patient"},"identifier":{"description":"Unique identifier for this patient. Always an NHS number.","type":"array","minItems":1,"items":{"type":"object","required":["system","value"],"properties":{"system":{"description":"Coding system used to identify patients.","type":"string","example":"https://fhir.nhs.uk/Id/nhs-number"},"value":{"description":"Code identifying the patient.","type":"string","example":"9000000009"}}}},"birthDate":{"description":"Patient's date of birth.","type":"string","example":"1965-02-28"}}}},"examples":{"Dummy":{"summary":"Dummy example","value":{"resourceType":"Dummy","issue":[{"severity":"error","code":"value","details":{"coding":[{"system":"https://fhir.nhs.uk/R4/CodeSystem/Spine-ErrorOrWarningCode","version":"1","code":"INVALID_RESOURCE_ID","display":"Resource Id is invalid"}]}}]}}}}}