From 9a2b6f7996b7174fac562250ac363a145b597607 Mon Sep 17 00:00:00 2001 From: jhadfield-NHS Date: Thu, 19 Jun 2025 10:41:14 +0100 Subject: [PATCH 1/5] Update eligibility-signposting-api.yaml Updating actionTypes to align with VitA request: Scenarios 1& 4 (Actionable with booking, actionable with existing national booking) we would like to have actionType = ButtonWithAuthLink instead of ButtonAuthLink and CardWithAuthButton Scenarios 2 & 3 - we would like to have actionType=InfoText instead of CareCardWithText Scenario 5 (existing local booking) - please keep actionType=CardWithText Scenario 14 (NotEligible) - we would like to have actionType=InfoText instead of CardWithText --- specification/eligibility-signposting-api.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/specification/eligibility-signposting-api.yaml b/specification/eligibility-signposting-api.yaml index fcb9fd3..6144ebe 100644 --- a/specification/eligibility-signposting-api.yaml +++ b/specification/eligibility-signposting-api.yaml @@ -232,7 +232,7 @@ paths: cohortStatus: "Actionable" suitabilityRules: [] actions: - - actionType: "ButtonAuthLink" + - actionType: "ButtonWithAuthLink" actionCode: "BookNBS" description: "" urlLink: "http://www.nhs.uk/book-rsv" @@ -253,7 +253,7 @@ paths: cohortStatus: "Actionable" suitabilityRules: [] actions: - - actionType: "CareCardWithText" + - actionType: "InfoText" actionCode: "BookLocal" description: "##Getting the vaccine\nYou can get an RSV vaccination at your GP surgery.\nYour GP surgery may contact you about getting the RSV vaccine. This may be by letter, text, phone call, email or through the NHS App. You do not need to wait to be contacted before booking your vaccination." example_50000000003: @@ -272,7 +272,7 @@ paths: cohortStatus: "Actionable" suitabilityRules: [] actions: - - actionType: "CareCardWithText" + - actionType: "InfoText" actionCode: "BookLocal" description: "##Getting the vaccine\nYou can get an RSV vaccination at your GP surgery.\nYour GP surgery may contact you about getting the RSV vaccine. This may be by letter, text, phone call, email or through the NHS App. You do not need to wait to be contacted before booking your vaccination." example_50000000004: @@ -288,7 +288,7 @@ paths: eligibilityCohorts: [] suitabilityRules: [] actions: - - actionType: "CardWithAuthButton" + - actionType: "ButtonWithAuthLink" actionCode: "AmendNBS" description: "##You have an RSV vaccination appointment\nYou can view, change or cancel your appointment below." urlLink: "http://www.nhs.uk/book-rsv" @@ -462,7 +462,7 @@ paths: cohortStatus: "NotEligible" suitabilityRules: [] actions: - - actionType: "CardWithText" + - actionType: "InfoText" actionCode: "HealtchareProInfo" description: "##If you think you need this vaccine\nSpeak to your healthcare professional if you think you should be offered this vaccination." '400': From 94baaab6370e48efe3986261b7baea8327f3cabe Mon Sep 17 00:00:00 2001 From: jhadfield-NHS Date: Thu, 19 Jun 2025 11:57:23 +0100 Subject: [PATCH 2/5] Update eligibility-signposting-api.yaml Small spelling correction --- specification/eligibility-signposting-api.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/eligibility-signposting-api.yaml b/specification/eligibility-signposting-api.yaml index 6144ebe..8d26622 100644 --- a/specification/eligibility-signposting-api.yaml +++ b/specification/eligibility-signposting-api.yaml @@ -463,7 +463,7 @@ paths: suitabilityRules: [] actions: - actionType: "InfoText" - actionCode: "HealtchareProInfo" + actionCode: "HealthcareProInfo" description: "##If you think you need this vaccine\nSpeak to your healthcare professional if you think you should be offered this vaccination." '400': description: Invalid input data. From 5e1d9b44a9d40ca06b6ac5ccd9a5e25a8b99ca2e Mon Sep 17 00:00:00 2001 From: jhadfield-NHS Date: Tue, 24 Jun 2025 12:54:50 +0100 Subject: [PATCH 3/5] Update eligibility-signposting-api.yaml Incrementing version number --- specification/eligibility-signposting-api.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/eligibility-signposting-api.yaml b/specification/eligibility-signposting-api.yaml index 8d26622..d33de9b 100644 --- a/specification/eligibility-signposting-api.yaml +++ b/specification/eligibility-signposting-api.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Patient Eligibility Signposting API - version: 1.0.13-alpha + version: 1.0.14-alpha description: "## Overview\nUse this API to access the [Patient Eligibility Signposting Data Product](https://digital.nhs.uk/services/eligibility-data-product-elid) - the nationally curated single source of eligibility status and signposted actions for individuals. For example, you can request eligibility for one or more vaccination types to understand if NHS England holds information which suggest that the person could or should take further steps toward receiving those vaccinations, and optionally, a list of the steps NHS England would recommend.\nWhere someone is deemed eligible, they will also be classified as actionable or not actionable. When deemed not actionable, one or more reasons will be returned. These reasons can range from personal care setting impacts to current lack of availability of vaccines and more.\nThe API returns most of its data in both code and text form. Unless agreed in writing with NHS England, where text is provided it should be displayed to the user as-is.\nUse this API to request: \n* eligibility for all supported categories and conditions\n* eligibility for specified supported categories and/or conditions \n* request that actions be included in the response\n* request that actions not be included in the response\nYou cannot currently use this API to: \n* request eligibility for proxy people (familial relations etc.)\n* request actions for people considered ineligible\nThis API is read-only and can return a list of processed suggestions, each relating to a 'condition' (e.g. COVID, RSV, BOWEL, EYE, BREAST etc.), including the following information for each: \n* a code representing the condition (COVID, RSV, BOWEL, EYE, BREAST)\n* an overall status (NotEligible, NotActionable, Actionable) \n* a list of eligibility cohort groups to which the person belongs (when eligible)\n* a list of the cohort groups that could have made the person eligible (when not eligible) \n* a list of rules/reasons that deem a person to be NotActionable\n* a list of actions that should be shown to the consumer\n#### Definitions of overall status\nThe overall status values indicate the following:\n* NotEligible - the individual does not currently meet eligibility criteria\n* NotActionable - the individual is eligible but does not need to take any further action at this time \n* Actionable - the individual is eligible and should follow one of the recommended actions provided\n### Patients included in the Patient Eligibility Signposting API\nThe API will return data for all patients who are in the NHS PDS system that are registered with an English GP practice (or one administered by England) or who we believe to be resident in England.\nPatients who are deceased (or thought to be), marked as invalid or sensitive will not be processed by this API.\n## Who can use this API\nThis API can only be used where there is a [legal basis](https://digital.nhs.uk/services/eligibility-data-product-elid#who-this-service-is-for) to do so. Make sure you have a valid use case before you go too far with your development. You must demonstrate you have a [valid use case](https://digital.nhs.uk/services/eligibility-data-product-elid#who-this-service-is-for) as part of digital onboarding.\nYou must do this before you can go live (see 'Onboarding' below).\n### Who can access Eligibility Signposting Information\nPatients who receive health and social care or make use of NHS services in England, Wales and the Isle of Man can access their own Eligibility Signposting data through onboarded services.\nHealth and care organisations in England and the Isle of Man can access our information for legitimate direct care purposes. Legitimate 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### Existing API users\nTo find out which healthcare software development organisations and products are already using this API, see [Patient Eligibility Signposting API - integrated products](https://digital.nhs.uk/services/eligibility-data-product-elid).\n## Access modes This API currently has only one access mode:\n* patient access (user-restricted)\nWe are considering the possibility of adding other modes in the future: \n* healthcare worker access\n* application restricted access\n### Patient access\nIf the end user is a patient then you must use this access mode. Use this access mode to obtain data for that patient.\nThis access mode is [user-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis), meaning an end user must be present, authenticated and authorised.\nThe end user must be:\n* a patient who receives health and social care or makes use of NHS services \n* strongly authenticated, using [NHS login](https://digital.nhs.uk/services/nhs-login)\nTo use this access mode, you must currently use the following security pattern:\n|\tSecurity pattern\t\t |\tTechnical details\t |\tAdvantages\t | Disadvantages |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| ----------------------------------------------------| ------------------------------------------------------------|---------------------------------------------------------| |[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) |OAuth 2.0 token exchange with signed JWT |Gives access to user information. |Need to integrate and onboard separately with NHS login. |\nPatient access mode users must be authenticated to a high proofing level (P9) and to one of the following [vectors of trust](https://nhsconnect.github.io/nhslogin/vectors-of-trust/):\n* P9.Cp.Cd \n* P9.Cp.Ck\n* P9.Cm\nThis access mode is available in production ([beta](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#api-status)).\n### Restricted access This access mode is not yet available, if you believe this mode would benefit your use-case, please let us know.\nThis access mode is [application-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis), meaning we authenticate and authorise the calling application but not the end user.\nThis access mode is not designed to be accessed by an end user. You might use this access mode as part of a back-end process to:\n* retrieve eligibility signposting information into a system in advance of a clinic \n* retrieve eligibility signposting information into a system to be used in a disconnected manner\nTo use this access mode, use this 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## Roadmap\nThe [Patient Eligibility Signposting API](https://digital.nhs.uk/services/eligibility-data-product-elid/eligibility-data-product-elid-roadmap) roadmap shows the planned changes for the API.\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/612352/eligibility-signposting-api-vaccinations).\nIf you have any other queries, please [contact us](https://digital.nhs.uk/developer/help-and-support).\n## Service level\nThis API is a silver service, meaning it is operational 24 hours a day, 365 days a year and supported 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## Rate limits\nThe default rate limit is 25TPS (Transactions Per Second), per app. If you require a higher rate limit please [contact us](https://digital.nhs.uk/developer/help-and-support). or raise this during the onboarding process.\n## Technology\nThis API is [RESTful](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#basic-rest).\nThe error messages returned by this API conform to the FHIR global standard for health care data exchange, specifically to FHIR R4 (v4.0.1). This is to aid consumers that integrate to FHIR based APIS and are in any case not overly complex.\nThere are [libraries and SDKs](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#fhir-libraries-and-sdks) available to help with FHIR API integration.\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## Errors\nWe use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:\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\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.\nYour API-calling application should have a mechanism to automatically try again, for example by giving status information to your end user, before giving up. See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#error-handling) for more information about error handling.\n## Open source\nYou might find the following [open source](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#open-source) resources useful:\n| Resource | Description | Links |\n|---------------------------|----------------------------------------------------------------------|--------------------------------------------------------------------------------| | Patient Eligibility Signposting API| Source code including API proxy, sandbox and specification and code. | [GitHub repo](https://github.com/NHSDigital/eligibility-signposting-api) |\nWe currently don't have any open source client libraries or sample code for this API. If you think this would be useful, you can [upvote the suggestion on our Interactive Product Backlog](https://nhs-digital-api-management.featureupvote.com/suggestions/107439/client-libraries-and-reference-implementations).\n\n## Environments and testing\n| Environment | Base URL | | ----------------- | ---------------------------------------------------------------------- |\n| Sandbox | `https://sandbox.api.service.nhs.uk/eligibility-signposting-api/patient-check/{id}` | | Integration test | `https://int.api.service.nhs.uk/eligibility-signposting-api/patient-check/{id}` |\n| Production | `https://api.service.nhs.uk/eligibility-signposting-api/patient-check/{id}` |\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\nFor details of sandbox test scenarios, or to try out the sandbox using our 'Try this API' feature, see the documentation for each endpoint.\nAlternatively, you can try out the sandbox using our Postman collection:\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/eligibility-signposting-api/eligibility-signposting-api)\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, with options for user-restricted access (NHS Login)\n### Production smoke testing\nYou must not use real patient data for smoke testing in the production environment.\nRather, use our [production test patient](https://digital.nhs.uk/services/eligibility-signposting/api-test-data#production-smoke-testing).\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 is worth planning well ahead.\nAs part of this process, you need to demonstrate your technical conformance to the requirements for this API.\nYou also need to demonstrate that you can manage risks. This might impact the design of your software. For details, see [Onboarding support information](https://digital.nhs.uk/services/eligibility-data-product-elid#how-to-access-this-service).\nTo understand how our online digital onboarding process works, see [digital onboarding](https://digital.nhs.uk/developer/guides-and-documentation/digital-onboarding).\n## Related APIs\nThe following APIs are related to this API:\n" contact: url: https://developer.nhs.uk/apis/eligibility-signposting-api From 4a7fd10fdc718cdad5fc1875b86e8619addd90c1 Mon Sep 17 00:00:00 2001 From: jhadfield-NHS Date: Tue, 24 Jun 2025 13:00:03 +0100 Subject: [PATCH 4/5] Update collection.json to latest generated --- specification/postman/collection.json | 3606 +++++++++++-------------- 1 file changed, 1591 insertions(+), 2015 deletions(-) diff --git a/specification/postman/collection.json b/specification/postman/collection.json index 4b6997d..771a3dd 100644 --- a/specification/postman/collection.json +++ b/specification/postman/collection.json @@ -1,2017 +1,1593 @@ { - "_": { - "postman_id": "ec1841da-e76e-458f-9f4d-81007d427ec4" - }, - "item": [ - { - "id": "c641f85f-fd9d-46b3-bf39-c6660c81b8d5", - "name": "Eligibility", - "description": { - "content": "", - "type": "text/plain" - }, - "item": [], - "event": [] - }, - { - "id": "4b9cb5a2-23b0-4b6a-8c5a-6acffd405bd3", - "name": "Signposting", - "description": { - "content": "", - "type": "text/plain" - }, - "item": [], - "event": [] - }, - { - "id": "658af195-e7ef-42c7-91d1-fce191e09ef0", - "name": "NextActions", - "description": { - "content": "", - "type": "text/plain" - }, - "item": [], - "event": [] - }, - { - "id": "eb46cf37-1cd0-4a79-8ee2-46c2abc13a6e", - "name": "Check Eligibility", - "request": { - "name": "Check Eligibility", - "description": { - "content": "Determines which suggestions a person is eligible for and which they are not, including reasons and next steps.", - "type": "text/plain" - }, - "url": { - "path": [ - "patient-check", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "type": "text/plain" - }, - "key": "category", - "value": "VACCINATIONS" - }, - { - "disabled": true, - "description": { - "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "type": "text/plain" - }, - "key": "conditions", - "value": "FLU,RSV" - }, - { - "disabled": true, - "description": { - "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "type": "text/plain" - }, - "key": "includeActions", - "value": "Y" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) The NHS number of the person to check eligibility for. The primary identifier of a patient, unique within NHS England and Wales. Always 10 digits and must be a [valid NHS number](https://www.datadictionary.nhs.uk/attributes/nhs_number.html).", - "type": "text/plain" - }, - "type": "any", - "value": "9000000009", - "key": "id" - } - ] - }, - "header": [ - { - "disabled": true, - "description": { - "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "type": "text/plain" - }, - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" - }, - { - "disabled": true, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" - }, - { - "disabled": true, - "description": { - "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "type": "text/plain" - }, - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {}, - "auth": { - "type": "apikey", - "apikey": [ - { - "type": "any", - "value": "apikey", - "key": "key" - }, - { - "type": "any", - "value": "{{apiKey}}", - "key": "value" - }, - { - "type": "any", - "value": "header", - "key": "in" - } - ] - } - }, - "response": [ - { - "_": { - "postman_previewlanguage": "json" - }, - "id": "b7a25394-6b39-430c-942b-8245dcf4f2c4", - "name": "RSV - Actionable due to membership of an Age Cohort including suggested national booking action (actions requested)", - "originalRequest": { - "url": { - "path": [ - "patient-check", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "type": "text/plain" - }, - "key": "category", - "value": "VACCINATIONS" - }, - { - "disabled": true, - "description": { - "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "type": "text/plain" - }, - "key": "conditions", - "value": "FLU,RSV" - }, - { - "disabled": true, - "description": { - "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "type": "text/plain" - }, - "key": "includeActions", - "value": "Y" - } - ], - "variable": [] - }, - "header": [ - { - "disabled": true, - "description": { - "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "type": "text/plain" - }, - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" - }, - { - "disabled": true, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" - }, - { - "disabled": true, - "description": { - "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "type": "text/plain" - }, - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345" - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "apikey", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"Actionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"Actionable\"\n }\n ],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"ButtonAuthLink\",\n \"actionCode\": \"BookNBS\",\n \"description\": \"\",\n \"urlLink\": \"http://www.nhs.uk/book-rsv\",\n \"urlLabel\": \"Continue to booking\"\n }\n ]\n }\n ]\n}", - "cookie": [] - }, - { - "_": { - "postman_previewlanguage": "json" - }, - "id": "c9afb38b-e412-4d30-b6df-1acb19af0acb", - "name": "RSV - Actionable due to membership of an Age Cohort including suggested action (not national booking)", - "originalRequest": { - "url": { - "path": [ - "patient-check", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "type": "text/plain" - }, - "key": "category", - "value": "VACCINATIONS" - }, - { - "disabled": true, - "description": { - "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "type": "text/plain" - }, - "key": "conditions", - "value": "FLU,RSV" - }, - { - "disabled": true, - "description": { - "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "type": "text/plain" - }, - "key": "includeActions", - "value": "Y" - } - ], - "variable": [] - }, - "header": [ - { - "disabled": true, - "description": { - "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "type": "text/plain" - }, - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" - }, - { - "disabled": true, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" - }, - { - "disabled": true, - "description": { - "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "type": "text/plain" - }, - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345" - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "apikey", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"Actionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"Actionable\"\n }\n ],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"CareCardWithText\",\n \"actionCode\": \"BookLocal\",\n \"description\": \"##Getting the vaccine\\nYou can get an RSV vaccination at your GP surgery.\\nYour GP surgery may contact you about getting the RSV vaccine. This may be by letter, text, phone call, email or through the NHS App. You do not need to wait to be contacted before booking your vaccination.\"\n }\n ]\n }\n ]\n}", - "cookie": [] - }, - { - "_": { - "postman_previewlanguage": "json" - }, - "id": "a2502693-d537-489c-8e14-a355c63d5be9", - "name": "RSV - Actionable due to membership of an alternative Age Cohort including suggested action (not national booking)", - "originalRequest": { - "url": { - "path": [ - "patient-check", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "type": "text/plain" - }, - "key": "category", - "value": "VACCINATIONS" - }, - { - "disabled": true, - "description": { - "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "type": "text/plain" - }, - "key": "conditions", - "value": "FLU,RSV" - }, - { - "disabled": true, - "description": { - "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "type": "text/plain" - }, - "key": "includeActions", - "value": "Y" - } - ], - "variable": [] - }, - "header": [ - { - "disabled": true, - "description": { - "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "type": "text/plain" - }, - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" - }, - { - "disabled": true, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" - }, - { - "disabled": true, - "description": { - "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "type": "text/plain" - }, - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345" - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "apikey", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"Actionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_catchup\",\n \"cohortText\": \"You turned 80 between 2nd September 2024 and 31st August 2025\",\n \"cohortStatus\": \"Actionable\"\n }\n ],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"CareCardWithText\",\n \"actionCode\": \"BookLocal\",\n \"description\": \"##Getting the vaccine\\nYou can get an RSV vaccination at your GP surgery.\\nYour GP surgery may contact you about getting the RSV vaccine. This may be by letter, text, phone call, email or through the NHS App. You do not need to wait to be contacted before booking your vaccination.\"\n }\n ]\n }\n ]\n}", - "cookie": [] - }, - { - "_": { - "postman_previewlanguage": "json" - }, - "id": "bfd5a860-7458-4d6b-b704-85ac78391cbd", - "name": "RSV - Actionable due to membership of an Age Cohort including suggested action (future national booking)", - "originalRequest": { - "url": { - "path": [ - "patient-check", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "type": "text/plain" - }, - "key": "category", - "value": "VACCINATIONS" - }, - { - "disabled": true, - "description": { - "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "type": "text/plain" - }, - "key": "conditions", - "value": "FLU,RSV" - }, - { - "disabled": true, - "description": { - "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "type": "text/plain" - }, - "key": "includeActions", - "value": "Y" - } - ], - "variable": [] - }, - "header": [ - { - "disabled": true, - "description": { - "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "type": "text/plain" - }, - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" - }, - { - "disabled": true, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" - }, - { - "disabled": true, - "description": { - "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "type": "text/plain" - }, - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345" - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "apikey", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"Actionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"CardWithAuthButton\",\n \"actionCode\": \"AmendNBS\",\n \"description\": \"##You have an RSV vaccination appointment\\nYou can view, change or cancel your appointment below.\",\n \"urlLink\": \"http://www.nhs.uk/book-rsv\",\n \"urlLabel\": \"Manage your appointment\"\n }\n ]\n }\n ]\n}", - "cookie": [] - }, - { - "_": { - "postman_previewlanguage": "json" - }, - "id": "b6da5adc-75af-4376-908e-b03c9e9efebd", - "name": "RSV - Actionable due to membership of an Age Cohort including suggested actions (with future local booking)", - "originalRequest": { - "url": { - "path": [ - "patient-check", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "type": "text/plain" - }, - "key": "category", - "value": "VACCINATIONS" - }, - { - "disabled": true, - "description": { - "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "type": "text/plain" - }, - "key": "conditions", - "value": "FLU,RSV" - }, - { - "disabled": true, - "description": { - "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "type": "text/plain" - }, - "key": "includeActions", - "value": "Y" - } - ], - "variable": [] - }, - "header": [ - { - "disabled": true, - "description": { - "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "type": "text/plain" - }, - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" - }, - { - "disabled": true, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" - }, - { - "disabled": true, - "description": { - "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "type": "text/plain" - }, - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345" - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "apikey", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"Actionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"CardWithText\",\n \"actionCode\": \"ManageLocal\",\n \"description\": \"##You have an RSV vaccination appointment\\nContact your healthcare provider to change or cancel your appointment.\"\n }\n ]\n }\n ]\n}", - "cookie": [] - }, - { - "_": { - "postman_previewlanguage": "json" - }, - "id": "4c799b75-d825-4c70-92ab-02bd80306bbc", - "name": "RSV - Not Actionable despite to membership of an Age Cohort with reasoning of already vaccinated (cohorts hidden)", - "originalRequest": { - "url": { - "path": [ - "patient-check", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "type": "text/plain" - }, - "key": "category", - "value": "VACCINATIONS" - }, - { - "disabled": true, - "description": { - "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "type": "text/plain" - }, - "key": "conditions", - "value": "FLU,RSV" - }, - { - "disabled": true, - "description": { - "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "type": "text/plain" - }, - "key": "includeActions", - "value": "Y" - } - ], - "variable": [] - }, - "header": [ - { - "disabled": true, - "description": { - "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "type": "text/plain" - }, - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" - }, - { - "disabled": true, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" - }, - { - "disabled": true, - "description": { - "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "type": "text/plain" - }, - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345" - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "apikey", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"AlreadyVaccinated\",\n \"ruleText\": \"##You've had your RSV vaccination\\nBased on our records, you recently had this vaccination. You do not need to do anything.\"\n }\n ],\n \"actions\": []\n }\n ]\n}", - "cookie": [] - }, - { - "_": { - "postman_previewlanguage": "json" - }, - "id": "ee3bd124-a23c-41b8-9df0-4756e738381f", - "name": "RSV - Not Actionable despite to membership of an Age Cohort with reasoning of no available vaccinations (not available type 1)", - "originalRequest": { - "url": { - "path": [ - "patient-check", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "type": "text/plain" - }, - "key": "category", - "value": "VACCINATIONS" - }, - { - "disabled": true, - "description": { - "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "type": "text/plain" - }, - "key": "conditions", - "value": "FLU,RSV" - }, - { - "disabled": true, - "description": { - "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "type": "text/plain" - }, - "key": "includeActions", - "value": "Y" - } - ], - "variable": [] - }, - "header": [ - { - "disabled": true, - "description": { - "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "type": "text/plain" - }, - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" - }, - { - "disabled": true, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" - }, - { - "disabled": true, - "description": { - "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "type": "text/plain" - }, - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345" - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "apikey", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"NotActionable\"\n }\n ],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"NotAvailable\",\n \"ruleText\": \"Vaccinations are not currently available\"\n }\n ],\n \"actions\": []\n }\n ]\n}", - "cookie": [] - }, - { - "_": { - "postman_previewlanguage": "json" - }, - "id": "47311563-37bd-4762-8598-0589720969a1", - "name": "RSV - No RSV response as no active campaign (not available type 2)", - "originalRequest": { - "url": { - "path": [ - "patient-check", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "type": "text/plain" - }, - "key": "category", - "value": "VACCINATIONS" - }, - { - "disabled": true, - "description": { - "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "type": "text/plain" - }, - "key": "conditions", - "value": "FLU,RSV" - }, - { - "disabled": true, - "description": { - "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "type": "text/plain" - }, - "key": "includeActions", - "value": "Y" - } - ], - "variable": [] - }, - "header": [ - { - "disabled": true, - "description": { - "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "type": "text/plain" - }, - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" - }, - { - "disabled": true, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" - }, - { - "disabled": true, - "description": { - "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "type": "text/plain" - }, - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345" - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "apikey", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": []\n}", - "cookie": [] - }, - { - "_": { - "postman_previewlanguage": "json" - }, - "id": "a09fffde-562a-4c86-9b5e-3dfe0d8d77af", - "name": "RSV - Not Actionable despite to membership of an Age Cohort with reasoning of dose not yet due", - "originalRequest": { - "url": { - "path": [ - "patient-check", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "type": "text/plain" - }, - "key": "category", - "value": "VACCINATIONS" - }, - { - "disabled": true, - "description": { - "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "type": "text/plain" - }, - "key": "conditions", - "value": "FLU,RSV" - }, - { - "disabled": true, - "description": { - "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "type": "text/plain" - }, - "key": "includeActions", - "value": "Y" - } - ], - "variable": [] - }, - "header": [ - { - "disabled": true, - "description": { - "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "type": "text/plain" - }, - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" - }, - { - "disabled": true, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" - }, - { - "disabled": true, - "description": { - "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "type": "text/plain" - }, - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345" - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "apikey", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"NotActionable\"\n }\n ],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"NotYetDue\",\n \"ruleText\": \"Your next dose is not yet due.\"\n }\n ],\n \"actions\": []\n }\n ]\n}", - "cookie": [] - }, - { - "_": { - "postman_previewlanguage": "json" - }, - "id": "ca0f2b1a-d935-455e-b1cb-ba4bc325347a", - "name": "RSV - Not Actionable despite to membership of an Age Cohort with reasoning of dose not far enough apart", - "originalRequest": { - "url": { - "path": [ - "patient-check", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "type": "text/plain" - }, - "key": "category", - "value": "VACCINATIONS" - }, - { - "disabled": true, - "description": { - "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "type": "text/plain" - }, - "key": "conditions", - "value": "FLU,RSV" - }, - { - "disabled": true, - "description": { - "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "type": "text/plain" - }, - "key": "includeActions", - "value": "Y" - } - ], - "variable": [] - }, - "header": [ - { - "disabled": true, - "description": { - "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "type": "text/plain" - }, - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" - }, - { - "disabled": true, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" - }, - { - "disabled": true, - "description": { - "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "type": "text/plain" - }, - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345" - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "apikey", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"NotActionable\"\n }\n ],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"TooClose\",\n \"ruleText\": \"Your previous vaccination was less than 91 days ago.\"\n }\n ],\n \"actions\": []\n }\n ]\n}", - "cookie": [] - }, - { - "_": { - "postman_previewlanguage": "json" - }, - "id": "d6c54325-bfba-4c1a-85df-cb35bb5bbaaf", - "name": "RSV - Not Actionable despite to membership of an Age Cohort with reasoning of vaccination given in other setting (e.g. care home)", - "originalRequest": { - "url": { - "path": [ - "patient-check", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "type": "text/plain" - }, - "key": "category", - "value": "VACCINATIONS" - }, - { - "disabled": true, - "description": { - "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "type": "text/plain" - }, - "key": "conditions", - "value": "FLU,RSV" - }, - { - "disabled": true, - "description": { - "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "type": "text/plain" - }, - "key": "includeActions", - "value": "Y" - } - ], - "variable": [] - }, - "header": [ - { - "disabled": true, - "description": { - "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "type": "text/plain" - }, - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" - }, - { - "disabled": true, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" - }, - { - "disabled": true, - "description": { - "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "type": "text/plain" - }, - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345" - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "apikey", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"NotActionable\"\n }\n ],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"OtherSetting\",\n \"ruleText\": \"##Getting the vaccine\\nOur record show you're living in a setting where care is provided.\\nIf you think you should have the RSV vaccine, speak to a member of staff where you live.\"\n }\n ],\n \"actions\": []\n }\n ]\n}", - "cookie": [] - }, - { - "_": { - "postman_previewlanguage": "json" - }, - "id": "40f476fd-3202-402c-8719-a2b71798ab16", - "name": "RSV - Not Actionable despite no cohort membership with reasoning of already vaccinated (type 1 includes unknown cohort)", - "originalRequest": { - "url": { - "path": [ - "patient-check", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "type": "text/plain" - }, - "key": "category", - "value": "VACCINATIONS" - }, - { - "disabled": true, - "description": { - "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "type": "text/plain" - }, - "key": "conditions", - "value": "FLU,RSV" - }, - { - "disabled": true, - "description": { - "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "type": "text/plain" - }, - "key": "includeActions", - "value": "Y" - } - ], - "variable": [] - }, - "header": [ - { - "disabled": true, - "description": { - "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "type": "text/plain" - }, - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" - }, - { - "disabled": true, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" - }, - { - "disabled": true, - "description": { - "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "type": "text/plain" - }, - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345" - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "apikey", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"unknown_cohort_membership\",\n \"cohortText\": \"Our records do not say why you are eligible\",\n \"cohortStatus\": \"NotActionable\"\n }\n ],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"AlreadyVaccinated\",\n \"ruleText\": \"##You've had your RSV vaccination\\nBased on our records, you recently had this vaccination.You do not need to do anything.\"\n }\n ],\n \"actions\": []\n }\n ]\n}", - "cookie": [] - }, - { - "_": { - "postman_previewlanguage": "json" - }, - "id": "85f9fa04-7733-4b49-b514-a51a48e347d5", - "name": "RSV - Not Actionable despite no cohort membership with reasoning of already vaccinated (type 2 includes no cohorts)", - "originalRequest": { - "url": { - "path": [ - "patient-check", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "type": "text/plain" - }, - "key": "category", - "value": "VACCINATIONS" - }, - { - "disabled": true, - "description": { - "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "type": "text/plain" - }, - "key": "conditions", - "value": "FLU,RSV" - }, - { - "disabled": true, - "description": { - "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "type": "text/plain" - }, - "key": "includeActions", - "value": "Y" - } - ], - "variable": [] - }, - "header": [ - { - "disabled": true, - "description": { - "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "type": "text/plain" - }, - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" - }, - { - "disabled": true, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" - }, - { - "disabled": true, - "description": { - "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "type": "text/plain" - }, - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345" - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "apikey", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"AlreadyVaccinated\",\n \"ruleText\": \"##You've had your RSV vaccination\\nBased on our records, you recently had this vaccination. You do not need to do anything.\"\n }\n ],\n \"actions\": []\n }\n ]\n}", - "cookie": [] - }, - { - "_": { - "postman_previewlanguage": "json" - }, - "id": "0d1206f0-e2e3-42a9-b748-b39eecb7df29", - "name": "RSV - Not Eligible", - "originalRequest": { - "url": { - "path": [ - "patient-check", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "type": "text/plain" - }, - "key": "category", - "value": "VACCINATIONS" - }, - { - "disabled": true, - "description": { - "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "type": "text/plain" - }, - "key": "conditions", - "value": "FLU,RSV" - }, - { - "disabled": true, - "description": { - "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "type": "text/plain" - }, - "key": "includeActions", - "value": "Y" - } - ], - "variable": [] - }, - "header": [ - { - "disabled": true, - "description": { - "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "type": "text/plain" - }, - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" - }, - { - "disabled": true, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" - }, - { - "disabled": true, - "description": { - "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "type": "text/plain" - }, - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345" - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "apikey", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotEligible\",\n \"statusText\": \"We do not believe you should have this vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are not aged 75 to 79 years old.\",\n \"cohortStatus\": \"NotEligible\"\n },\n {\n \"cohortCode\": \"rsv_age_catchup\",\n \"cohortText\": \"You did not turn 80 between 2nd September 2024 and 31st August 2025\",\n \"cohortStatus\": \"NotEligible\"\n }\n ],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"CardWithText\",\n \"actionCode\": \"HealtchareProInfo\",\n \"description\": \"##If you think you need this vaccine\\nSpeak to your healthcare professional if you think you should be offered this vaccination.\"\n }\n ]\n }\n ]\n}", - "cookie": [] - }, - { - "_": { - "postman_previewlanguage": "json" - }, - "id": "62a3f342-a792-4d74-9bbc-8e22625b0763", - "name": "Invalid input data.", - "originalRequest": { - "url": { - "path": [ - "patient-check", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "type": "text/plain" - }, - "key": "category", - "value": "VACCINATIONS" - }, - { - "disabled": true, - "description": { - "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "type": "text/plain" - }, - "key": "conditions", - "value": "FLU,RSV" - }, - { - "disabled": true, - "description": { - "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "type": "text/plain" - }, - "key": "includeActions", - "value": "Y" - } - ], - "variable": [] - }, - "header": [ - { - "disabled": true, - "description": { - "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "type": "text/plain" - }, - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" - }, - { - "disabled": true, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" - }, - { - "disabled": true, - "description": { - "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "type": "text/plain" - }, - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345" - }, - { - "key": "Accept", - "value": "application/fhir+json" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "apikey", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Bad Request", - "code": 400, - "header": [ - { - "key": "Content-Type", - "value": "application/fhir+json" - } - ], - "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"id\": \"rrt-2959959087381887325-c-geu2-24001-77777777-1\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"value\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\",\n \"code\": \"VALIDATION_ERROR\",\n \"display\": \"The given conditions were not in the expected format.\"\n }\n ]\n },\n \"diagnostics\": \"FLU&COVID should be a single or comma separated list of condition strings with no other punctuation or special characters\",\n \"location\": [\n \"parameters/conditions\"\n ]\n }\n ]\n}", - "cookie": [] - }, - { - "_": { - "postman_previewlanguage": "json" - }, - "id": "830b1f89-2a4a-4785-ad22-b6d0f2c9b096", - "name": "Person not found.", - "originalRequest": { - "url": { - "path": [ - "patient-check", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "type": "text/plain" - }, - "key": "category", - "value": "VACCINATIONS" - }, - { - "disabled": true, - "description": { - "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "type": "text/plain" - }, - "key": "conditions", - "value": "FLU,RSV" - }, - { - "disabled": true, - "description": { - "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "type": "text/plain" - }, - "key": "includeActions", - "value": "Y" - } - ], - "variable": [] - }, - "header": [ - { - "disabled": true, - "description": { - "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "type": "text/plain" - }, - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" - }, - { - "disabled": true, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" - }, - { - "disabled": true, - "description": { - "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "type": "text/plain" - }, - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345" - }, - { - "key": "Accept", - "value": "application/fhir+json" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "apikey", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Not Found", - "code": 404, - "header": [ - { - "key": "Content-Type", - "value": "application/fhir+json" - } - ], - "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"id\": \"rrt-2959959087381887325-c-geu2-24001-77777777-1\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"processing\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\",\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"display\": \"The given NHS number was not found in our datasets. This could be because the number is incorrect or some other reason we cannot process that number.\"\n }\n ]\n },\n \"diagnostics\": \"NHS Number 9000000404 was not recognised by the Eligibility Signposting API\",\n \"location\": [\n \"parameters/id\"\n ]\n }\n ]\n}", - "cookie": [] - }, - { - "_": { - "postman_previewlanguage": "json" - }, - "id": "15fa5a01-e1ee-496c-b840-b96221df6e79", - "name": "Unrecognised input data. (Unprocessable Content)", - "originalRequest": { - "url": { - "path": [ - "patient-check", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "type": "text/plain" - }, - "key": "category", - "value": "VACCINATIONS" - }, - { - "disabled": true, - "description": { - "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "type": "text/plain" - }, - "key": "conditions", - "value": "FLU,RSV" - }, - { - "disabled": true, - "description": { - "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "type": "text/plain" - }, - "key": "includeActions", - "value": "Y" - } - ], - "variable": [] - }, - "header": [ - { - "disabled": true, - "description": { - "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "type": "text/plain" - }, - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" - }, - { - "disabled": true, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" - }, - { - "disabled": true, - "description": { - "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "type": "text/plain" - }, - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345" - }, - { - "key": "Accept", - "value": "application/fhir+json" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "apikey", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Unprocessable Entity (WebDAV) (RFC 4918)", - "code": 422, - "header": [ - { - "key": "Content-Type", - "value": "application/fhir+json" - } - ], - "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"id\": \"rrt-2959959087381887325-c-geu2-24001-77777777-1\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"value\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\",\n \"code\": \"VALIDATION_ERROR\",\n \"display\": \"The supplied category was not recognised by the API.\"\n }\n ]\n },\n \"diagnostics\": \"HEALTHCHECKS is not a category that is supported by the API\",\n \"location\": [\n \"parameters/category\"\n ]\n }\n ]\n}", - "cookie": [] - }, - { - "_": { - "postman_previewlanguage": "json" - }, - "id": "a7907ae9-2142-401f-8078-1bbd67ccadb4", - "name": "Internal server error.", - "originalRequest": { - "url": { - "path": [ - "patient-check", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": true, - "description": { - "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "type": "text/plain" - }, - "key": "category", - "value": "VACCINATIONS" - }, - { - "disabled": true, - "description": { - "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "type": "text/plain" - }, - "key": "conditions", - "value": "FLU,RSV" - }, - { - "disabled": true, - "description": { - "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "type": "text/plain" - }, - "key": "includeActions", - "value": "Y" - } - ], - "variable": [] - }, - "header": [ - { - "disabled": true, - "description": { - "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "type": "text/plain" - }, - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" - }, - { - "disabled": true, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" - }, - { - "disabled": true, - "description": { - "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "type": "text/plain" - }, - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345" - }, - { - "key": "Accept", - "value": "application/fhir+json" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "apikey", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "key": "Content-Type", - "value": "application/fhir+json" - } - ], - "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"id\": \"rrt-2959959087381887325-c-geu2-24001-77777777-1\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"processing\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\",\n \"code\": \"SERVICE_ERROR\",\n \"display\": \"An unknown error occurred processing this request. Contact us for assistance diagnosing this issue: https://digital.nhs.uk/developer/help-and-support quoting the id included in this message\"\n }\n ]\n },\n \"diagnostics\": \"No diagnostics available\",\n \"location\": [\n \"parameters/category\"\n ]\n }\n ]\n}", - "cookie": [] - } - ], - "event": [ - { - "listen": "test", - "script": { - "id": "78d55bc9-70eb-48fe-a194-8e683daabbe7", - "type": "text/javascript", - "exec": [ - "// Validate status 2xx \npm.test(\"[GET]::/patient-check/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", - "// Validate if response header has matching content-type\npm.test(\"[GET]::/patient-check/:id - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", - "// Validate if response has JSON Body \npm.test(\"[GET]::/patient-check/:id - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"responseId\":{\"type\":\"string\",\"description\":\"GUID assigned when the decisioning evaluation is carried out. This will be useful if you ever need to request support for a particular request. This will not change if you receive a cached response.\"},\"meta\":{\"type\":\"object\",\"properties\":{\"lastUpdated\":{\"type\":\"string\",\"description\":\"Timestamp of when the decisioning evaluation is carried out. This will not change if you receive a cached response.\"}}},\"processedSuggestions\":{\"type\":\"array\",\"description\":\"List of suggestions the person is eligible for.\",\"items\":{\"type\":\"object\",\"properties\":{\"condition\":{\"type\":\"string\",\"description\":\"String representing the vaccine target disease, screening target or other scenario requiring decision based suggestions, that this suggestion relates to\"},\"status\":{\"type\":\"string\",\"description\":\"String representing an overall summary of the persons status for this processedSuggestion\",\"enum\":[\"NotEligible\",\"NotActionable\",\"Actionable\"]},\"statusText\":{\"type\":\"string\"},\"eligibilityCohorts\":{\"type\":\"array\",\"description\":\"Cohorts that drove the eligibility status returned.\",\"items\":{\"type\":\"object\",\"properties\":{\"cohortCode\":{\"type\":\"string\",\"description\":\"Machine readable code signifying the cohort/cohort group that lead to a person's eligibility for this suggestion\"},\"cohortText\":{\"type\":\"string\",\"description\":\"Human readable (render-able) text describing the meaning of a cohort/cohort group that lead to a person's eligibility for this suggestion\"},\"cohortStatus\":{\"type\":\"string\",\"description\":\"String representing the persons status for this processedSuggestion in respect of this particular cohort or cohort group\",\"enum\":[\"NotEligible\",\"NotActionable\",\"Actionable\"]}}}},\"suitabilityRules\":{\"type\":\"array\",\"description\":\"Reasons that the eligibility status was changed from the base eligibility to result in it's status to not be eligible or to be acted on\",\"items\":{\"type\":\"object\",\"properties\":{\"ruleType\":{\"type\":\"string\",\"description\":\"The type of a rule that triggered to amend the status of the suggestion\",\"enum\":[\"F\",\"S\"]},\"ruleCode\":{\"type\":\"string\",\"description\":\"Machine readable code signifying a rule that amended the status of the suggestion\"},\"ruleText\":{\"type\":\"string\",\"description\":\"Human readable (render-able) text describing a rule that amended the status of the suggestion (optionally GFM Markdown)\"}}}},\"actions\":{\"type\":\"array\",\"description\":\"List of actions to be shown to the person.\",\"items\":{\"type\":\"object\",\"properties\":{\"actionType\":{\"type\":\"string\",\"description\":\"Type of action to render. E.g. A primary button, a link, text etc\"},\"actionCode\":{\"type\":\"string\",\"description\":\"Code representing the action to be taken\"},\"description\":{\"type\":\"string\",\"description\":\"Human readable (render-able) text describing the suggested action (optionally GFM Markdown)\"},\"urlLink\":{\"type\":\"string\",\"description\":\"URL to invoke if action selected.\"},\"urlLabel\":{\"type\":\"string\",\"description\":\"Lable to use for the URL (or button) used to display the link\"}}}}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/patient-check/:id - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" - ] - } - } - ], - "protocolProfileBehavior": { - "disableBodyPruning": true - } - } - ], - "event": [], - "variable": [ - { - "type": "any", - "value": "https://sandbox.api.service.nhs.uk/eligibility-signposting-api", - "key": "baseUrl" - } - ], - "info": { - "_postman_id": "ec1841da-e76e-458f-9f4d-81007d427ec4", - "name": "Patient Eligibility Signposting API", - "version": { - "raw": "1.0.13-alpha", - "major": 1, - "minor": 0, - "patch": 13, - "prerelease": "alpha", - "build": [], - "string": "1.0.13-alpha" - }, - "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "description": { - "content": "## Overview\nUse this API to access the [Patient Eligibility Signposting Data Product](https://digital.nhs.uk/services/eligibility-data-product-elid) - the nationally curated single source of eligibility status and signposted actions for individuals. For example, you can request eligibility for one or more vaccination types to understand if NHS England holds information which suggest that the person could or should take further steps toward receiving those vaccinations, and optionally, a list of the steps NHS England would recommend.\nWhere someone is deemed eligible, they will also be classified as actionable or not actionable. When deemed not actionable, one or more reasons will be returned. These reasons can range from personal care setting impacts to current lack of availability of vaccines and more.\nThe API returns most of its data in both code and text form. Unless agreed in writing with NHS England, where text is provided it should be displayed to the user as-is.\nUse this API to request: \n* eligibility for all supported categories and conditions\n* eligibility for specified supported categories and/or conditions \n* request that actions be included in the response\n* request that actions not be included in the response\nYou cannot currently use this API to: \n* request eligibility for proxy people (familial relations etc.)\n* request actions for people considered ineligible\nThis API is read-only and can return a list of processed suggestions, each relating to a 'condition' (e.g. COVID, RSV, BOWEL, EYE, BREAST etc.), including the following information for each: \n* a code representing the condition (COVID, RSV, BOWEL, EYE, BREAST)\n* an overall status (NotEligible, NotActionable, Actionable) \n* a list of eligibility cohort groups to which the person belongs (when eligible)\n* a list of the cohort groups that could have made the person eligible (when not eligible) \n* a list of rules/reasons that deem a person to be NotActionable\n* a list of actions that should be shown to the consumer\n#### Definitions of overall status\nThe overall status values indicate the following:\n* NotEligible - the individual does not currently meet eligibility criteria\n* NotActionable - the individual is eligible but does not need to take any further action at this time \n* Actionable - the individual is eligible and should follow one of the recommended actions provided\n### Patients included in the Patient Eligibility Signposting API\nThe API will return data for all patients who are in the NHS PDS system that are registered with an English GP practice (or one administered by England) or who we believe to be resident in England.\nPatients who are deceased (or thought to be), marked as invalid or sensitive will not be processed by this API.\n## Who can use this API\nThis API can only be used where there is a [legal basis](https://digital.nhs.uk/services/eligibility-data-product-elid#who-this-service-is-for) to do so. Make sure you have a valid use case before you go too far with your development. You must demonstrate you have a [valid use case](https://digital.nhs.uk/services/eligibility-data-product-elid#who-this-service-is-for) as part of digital onboarding.\nYou must do this before you can go live (see 'Onboarding' below).\n### Who can access Eligibility Signposting Information\nPatients who receive health and social care or make use of NHS services in England, Wales and the Isle of Man can access their own Eligibility Signposting data through onboarded services.\nHealth and care organisations in England and the Isle of Man can access our information for legitimate direct care purposes. Legitimate 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### Existing API users\nTo find out which healthcare software development organisations and products are already using this API, see [Patient Eligibility Signposting API - integrated products](https://digital.nhs.uk/services/eligibility-data-product-elid).\n## Access modes This API currently has only one access mode:\n* patient access (user-restricted)\nWe are considering the possibility of adding other modes in the future: \n* healthcare worker access\n* application restricted access\n### Patient access\nIf the end user is a patient then you must use this access mode. Use this access mode to obtain data for that patient.\nThis access mode is [user-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis), meaning an end user must be present, authenticated and authorised.\nThe end user must be:\n* a patient who receives health and social care or makes use of NHS services \n* strongly authenticated, using [NHS login](https://digital.nhs.uk/services/nhs-login)\nTo use this access mode, you must currently use the following security pattern:\n|\tSecurity pattern\t\t |\tTechnical details\t |\tAdvantages\t | Disadvantages |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| ----------------------------------------------------| ------------------------------------------------------------|---------------------------------------------------------| |[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) |OAuth 2.0 token exchange with signed JWT |Gives access to user information. |Need to integrate and onboard separately with NHS login. |\nPatient access mode users must be authenticated to a high proofing level (P9) and to one of the following [vectors of trust](https://nhsconnect.github.io/nhslogin/vectors-of-trust/):\n* P9.Cp.Cd \n* P9.Cp.Ck\n* P9.Cm\nThis access mode is available in production ([beta](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#api-status)).\n### Restricted access This access mode is not yet available, if you believe this mode would benefit your use-case, please let us know.\nThis access mode is [application-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis), meaning we authenticate and authorise the calling application but not the end user.\nThis access mode is not designed to be accessed by an end user. You might use this access mode as part of a back-end process to:\n* retrieve eligibility signposting information into a system in advance of a clinic \n* retrieve eligibility signposting information into a system to be used in a disconnected manner\nTo use this access mode, use this 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## Roadmap\nThe [Patient Eligibility Signposting API](https://digital.nhs.uk/services/eligibility-data-product-elid/eligibility-data-product-elid-roadmap) roadmap shows the planned changes for the API.\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/612352/eligibility-signposting-api-vaccinations).\nIf you have any other queries, please [contact us](https://digital.nhs.uk/developer/help-and-support).\n## Service level\nThis API is a silver service, meaning it is operational 24 hours a day, 365 days a year and supported 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## Rate limits\nThe default rate limit is 25TPS (Transactions Per Second), per app. If you require a higher rate limit please [contact us](https://digital.nhs.uk/developer/help-and-support). or raise this during the onboarding process.\n## Technology\nThis API is [RESTful](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#basic-rest).\nThe error messages returned by this API conform to the FHIR global standard for health care data exchange, specifically to FHIR R4 (v4.0.1). This is to aid consumers that integrate to FHIR based APIS and are in any case not overly complex.\nThere are [libraries and SDKs](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#fhir-libraries-and-sdks) available to help with FHIR API integration.\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## Errors\nWe use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:\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\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.\nYour API-calling application should have a mechanism to automatically try again, for example by giving status information to your end user, before giving up. See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#error-handling) for more information about error handling.\n## Open source\nYou might find the following [open source](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#open-source) resources useful:\n| Resource | Description | Links |\n|---------------------------|----------------------------------------------------------------------|--------------------------------------------------------------------------------| | Patient Eligibility Signposting API| Source code including API proxy, sandbox and specification and code. | [GitHub repo](https://github.com/NHSDigital/eligibility-signposting-api) |\nWe currently don't have any open source client libraries or sample code for this API. If you think this would be useful, you can [upvote the suggestion on our Interactive Product Backlog](https://nhs-digital-api-management.featureupvote.com/suggestions/107439/client-libraries-and-reference-implementations).\n\n## Environments and testing\n| Environment | Base URL | | ----------------- | ---------------------------------------------------------------------- |\n| Sandbox | `https://sandbox.api.service.nhs.uk/eligibility-signposting-api/patient-check/{id}` | | Integration test | `https://int.api.service.nhs.uk/eligibility-signposting-api/patient-check/{id}` |\n| Production | `https://api.service.nhs.uk/eligibility-signposting-api/patient-check/{id}` |\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\nFor details of sandbox test scenarios, or to try out the sandbox using our 'Try this API' feature, see the documentation for each endpoint.\nAlternatively, you can try out the sandbox using our Postman collection:\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/eligibility-signposting-api/eligibility-signposting-api)\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, with options for user-restricted access (NHS Login)\n### Production smoke testing\nYou must not use real patient data for smoke testing in the production environment.\nRather, use our [production test patient](https://digital.nhs.uk/services/eligibility-signposting/api-test-data#production-smoke-testing).\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 is worth planning well ahead.\nAs part of this process, you need to demonstrate your technical conformance to the requirements for this API.\nYou also need to demonstrate that you can manage risks. This might impact the design of your software. For details, see [Onboarding support information](https://digital.nhs.uk/services/eligibility-data-product-elid#how-to-access-this-service).\nTo understand how our online digital onboarding process works, see [digital onboarding](https://digital.nhs.uk/developer/guides-and-documentation/digital-onboarding).\n## Related APIs\nThe following APIs are related to this API:\n", - "type": "text/plain" - } - } + "info": { + "_postman_id": "bd83cf40-7af6-46f1-a071-4b36813b7939", + "name": "Patient Eligibility Signposting API", + "description": "## Overview\nUse this API to access the [Patient Eligibility Signposting Data Product](https://digital.nhs.uk/services/eligibility-data-product-elid) - the nationally curated single source of eligibility status and signposted actions for individuals. For example, you can request eligibility for one or more vaccination types to understand if NHS England holds information which suggest that the person could or should take further steps toward receiving those vaccinations, and optionally, a list of the steps NHS England would recommend.\nWhere someone is deemed eligible, they will also be classified as actionable or not actionable. When deemed not actionable, one or more reasons will be returned. These reasons can range from personal care setting impacts to current lack of availability of vaccines and more.\nThe API returns most of its data in both code and text form. Unless agreed in writing with NHS England, where text is provided it should be displayed to the user as-is.\nUse this API to request: \n* eligibility for all supported categories and conditions\n* eligibility for specified supported categories and/or conditions \n* request that actions be included in the response\n* request that actions not be included in the response\nYou cannot currently use this API to: \n* request eligibility for proxy people (familial relations etc.)\n* request actions for people considered ineligible\nThis API is read-only and can return a list of processed suggestions, each relating to a 'condition' (e.g. COVID, RSV, BOWEL, EYE, BREAST etc.), including the following information for each: \n* a code representing the condition (COVID, RSV, BOWEL, EYE, BREAST)\n* an overall status (NotEligible, NotActionable, Actionable) \n* a list of eligibility cohort groups to which the person belongs (when eligible)\n* a list of the cohort groups that could have made the person eligible (when not eligible) \n* a list of rules/reasons that deem a person to be NotActionable\n* a list of actions that should be shown to the consumer\n#### Definitions of overall status\nThe overall status values indicate the following:\n* NotEligible - the individual does not currently meet eligibility criteria\n* NotActionable - the individual is eligible but does not need to take any further action at this time \n* Actionable - the individual is eligible and should follow one of the recommended actions provided\n### Patients included in the Patient Eligibility Signposting API\nThe API will return data for all patients who are in the NHS PDS system that are registered with an English GP practice (or one administered by England) or who we believe to be resident in England.\nPatients who are deceased (or thought to be), marked as invalid or sensitive will not be processed by this API.\n## Who can use this API\nThis API can only be used where there is a [legal basis](https://digital.nhs.uk/services/eligibility-data-product-elid#who-this-service-is-for) to do so. Make sure you have a valid use case before you go too far with your development. You must demonstrate you have a [valid use case](https://digital.nhs.uk/services/eligibility-data-product-elid#who-this-service-is-for) as part of digital onboarding.\nYou must do this before you can go live (see 'Onboarding' below).\n### Who can access Eligibility Signposting Information\nPatients who receive health and social care or make use of NHS services in England, Wales and the Isle of Man can access their own Eligibility Signposting data through onboarded services.\nHealth and care organisations in England and the Isle of Man can access our information for legitimate direct care purposes. Legitimate 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### Existing API users\nTo find out which healthcare software development organisations and products are already using this API, see [Patient Eligibility Signposting API - integrated products](https://digital.nhs.uk/services/eligibility-data-product-elid).\n## Access modes This API currently has only one access mode:\n* patient access (user-restricted)\nWe are considering the possibility of adding other modes in the future: \n* healthcare worker access\n* application restricted access\n### Patient access\nIf the end user is a patient then you must use this access mode. Use this access mode to obtain data for that patient.\nThis access mode is [user-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis), meaning an end user must be present, authenticated and authorised.\nThe end user must be:\n* a patient who receives health and social care or makes use of NHS services \n* strongly authenticated, using [NHS login](https://digital.nhs.uk/services/nhs-login)\nTo use this access mode, you must currently use the following security pattern:\n|\tSecurity pattern\t\t |\tTechnical details\t |\tAdvantages\t | Disadvantages |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| ----------------------------------------------------| ------------------------------------------------------------|---------------------------------------------------------| |[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) |OAuth 2.0 token exchange with signed JWT |Gives access to user information. |Need to integrate and onboard separately with NHS login. |\nPatient access mode users must be authenticated to a high proofing level (P9) and to one of the following [vectors of trust](https://nhsconnect.github.io/nhslogin/vectors-of-trust/):\n* P9.Cp.Cd \n* P9.Cp.Ck\n* P9.Cm\nThis access mode is available in production ([beta](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#api-status)).\n### Restricted access This access mode is not yet available, if you believe this mode would benefit your use-case, please let us know.\nThis access mode is [application-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis), meaning we authenticate and authorise the calling application but not the end user.\nThis access mode is not designed to be accessed by an end user. You might use this access mode as part of a back-end process to:\n* retrieve eligibility signposting information into a system in advance of a clinic \n* retrieve eligibility signposting information into a system to be used in a disconnected manner\nTo use this access mode, use this 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## Roadmap\nThe [Patient Eligibility Signposting API](https://digital.nhs.uk/services/eligibility-data-product-elid/eligibility-data-product-elid-roadmap) roadmap shows the planned changes for the API.\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/612352/eligibility-signposting-api-vaccinations).\nIf you have any other queries, please [contact us](https://digital.nhs.uk/developer/help-and-support).\n## Service level\nThis API is a silver service, meaning it is operational 24 hours a day, 365 days a year and supported 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## Rate limits\nThe default rate limit is 25TPS (Transactions Per Second), per app. If you require a higher rate limit please [contact us](https://digital.nhs.uk/developer/help-and-support). or raise this during the onboarding process.\n## Technology\nThis API is [RESTful](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#basic-rest).\nThe error messages returned by this API conform to the FHIR global standard for health care data exchange, specifically to FHIR R4 (v4.0.1). This is to aid consumers that integrate to FHIR based APIS and are in any case not overly complex.\nThere are [libraries and SDKs](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#fhir-libraries-and-sdks) available to help with FHIR API integration.\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## Errors\nWe use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:\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\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.\nYour API-calling application should have a mechanism to automatically try again, for example by giving status information to your end user, before giving up. See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#error-handling) for more information about error handling.\n## Open source\nYou might find the following [open source](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#open-source) resources useful:\n| Resource | Description | Links |\n|---------------------------|----------------------------------------------------------------------|--------------------------------------------------------------------------------| | Patient Eligibility Signposting API| Source code including API proxy, sandbox and specification and code. | [GitHub repo](https://github.com/NHSDigital/eligibility-signposting-api) |\nWe currently don't have any open source client libraries or sample code for this API. If you think this would be useful, you can [upvote the suggestion on our Interactive Product Backlog](https://nhs-digital-api-management.featureupvote.com/suggestions/107439/client-libraries-and-reference-implementations).\n\n## Environments and testing\n| Environment | Base URL | | ----------------- | ---------------------------------------------------------------------- |\n| Sandbox | `https://sandbox.api.service.nhs.uk/eligibility-signposting-api/patient-check/{id}` | | Integration test | `https://int.api.service.nhs.uk/eligibility-signposting-api/patient-check/{id}` |\n| Production | `https://api.service.nhs.uk/eligibility-signposting-api/patient-check/{id}` |\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\nFor details of sandbox test scenarios, or to try out the sandbox using our 'Try this API' feature, see the documentation for each endpoint.\nAlternatively, you can try out the sandbox using our Postman collection:\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/eligibility-signposting-api/eligibility-signposting-api)\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, with options for user-restricted access (NHS Login)\n### Production smoke testing\nYou must not use real patient data for smoke testing in the production environment.\nRather, use our [production test patient](https://digital.nhs.uk/services/eligibility-signposting/api-test-data#production-smoke-testing).\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 is worth planning well ahead.\nAs part of this process, you need to demonstrate your technical conformance to the requirements for this API.\nYou also need to demonstrate that you can manage risks. This might impact the design of your software. For details, see [Onboarding support information](https://digital.nhs.uk/services/eligibility-data-product-elid#how-to-access-this-service).\nTo understand how our online digital onboarding process works, see [digital onboarding](https://digital.nhs.uk/developer/guides-and-documentation/digital-onboarding).\n## Related APIs\nThe following APIs are related to this API:\n", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "_exporter_id": "44595835", + "_collection_link": "https://www.postman.com/eligibility-signposting-api/eligibility-signposting-api/collection/4nurb90/patient-eligibility-signposting-api?action=share&source=collection_link&creator=44595835" + }, + "item": [ + { + "name": "Eligibility", + "item": [] + }, + { + "name": "Signposting", + "item": [] + }, + { + "name": "NextActions", + "item": [] + }, + { + "name": "Check Eligibility", + "event": [ + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "// Validate status 2xx \npm.test(\"[GET]::/patient-check/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", + "// Validate if response header has matching content-type\npm.test(\"[GET]::/patient-check/:id - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", + "// Validate if response has JSON Body \npm.test(\"[GET]::/patient-check/:id - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", + "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"responseId\":{\"type\":\"string\",\"description\":\"GUID assigned when the decisioning evaluation is carried out. This will be useful if you ever need to request support for a particular request. This will not change if you receive a cached response.\"},\"meta\":{\"type\":\"object\",\"properties\":{\"lastUpdated\":{\"type\":\"string\",\"description\":\"Timestamp of when the decisioning evaluation is carried out. This will not change if you receive a cached response.\"}}},\"processedSuggestions\":{\"type\":\"array\",\"description\":\"List of suggestions the person is eligible for.\",\"items\":{\"type\":\"object\",\"properties\":{\"condition\":{\"type\":\"string\",\"description\":\"String representing the vaccine target disease, screening target or other scenario requiring decision based suggestions, that this suggestion relates to\"},\"status\":{\"type\":\"string\",\"description\":\"String representing an overall summary of the persons status for this processedSuggestion\",\"enum\":[\"NotEligible\",\"NotActionable\",\"Actionable\"]},\"statusText\":{\"type\":\"string\"},\"eligibilityCohorts\":{\"type\":\"array\",\"description\":\"Cohorts that drove the eligibility status returned.\",\"items\":{\"type\":\"object\",\"properties\":{\"cohortCode\":{\"type\":\"string\",\"description\":\"Machine readable code signifying the cohort/cohort group that lead to a person's eligibility for this suggestion\"},\"cohortText\":{\"type\":\"string\",\"description\":\"Human readable (render-able) text describing the meaning of a cohort/cohort group that lead to a person's eligibility for this suggestion\"},\"cohortStatus\":{\"type\":\"string\",\"description\":\"String representing the persons status for this processedSuggestion in respect of this particular cohort or cohort group\",\"enum\":[\"NotEligible\",\"NotActionable\",\"Actionable\"]}}}},\"suitabilityRules\":{\"type\":\"array\",\"description\":\"Reasons that the eligibility status was changed from the base eligibility to result in it's status to not be eligible or to be acted on\",\"items\":{\"type\":\"object\",\"properties\":{\"ruleType\":{\"type\":\"string\",\"description\":\"The type of a rule that triggered to amend the status of the suggestion\",\"enum\":[\"F\",\"S\"]},\"ruleCode\":{\"type\":\"string\",\"description\":\"Machine readable code signifying a rule that amended the status of the suggestion\"},\"ruleText\":{\"type\":\"string\",\"description\":\"Human readable (render-able) text describing a rule that amended the status of the suggestion (optionally GFM Markdown)\"}}}},\"actions\":{\"type\":\"array\",\"description\":\"List of actions to be shown to the person.\",\"items\":{\"type\":\"object\",\"properties\":{\"actionType\":{\"type\":\"string\",\"description\":\"Type of action to render. E.g. A primary button, a link, text etc\"},\"actionCode\":{\"type\":\"string\",\"description\":\"Code representing the action to be taken\"},\"description\":{\"type\":\"string\",\"description\":\"Human readable (render-able) text describing the suggested action (optionally GFM Markdown)\"},\"urlLink\":{\"type\":\"string\",\"description\":\"URL to invoke if action selected.\"},\"urlLabel\":{\"type\":\"string\",\"description\":\"Lable to use for the URL (or button) used to display the link\"}}}}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/patient-check/:id - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + ] + } + } + ], + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "apikey", + "type": "string" + }, + { + "key": "value", + "value": "{{apiKey}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + }, + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", + "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "disabled": true + }, + { + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", + "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", + "disabled": true + }, + { + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345", + "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "disabled": true + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/patient-check/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "patient-check", + ":id" + ], + "query": [ + { + "key": "category", + "value": "VACCINATIONS", + "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "disabled": true + }, + { + "key": "conditions", + "value": "FLU,RSV", + "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "disabled": true + }, + { + "key": "includeActions", + "value": "Y", + "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "disabled": true + } + ], + "variable": [ + { + "key": "id", + "value": "9000000009", + "description": "(Required) The NHS number of the person to check eligibility for. The primary identifier of a patient, unique within NHS England and Wales. Always 10 digits and must be a [valid NHS number](https://www.datadictionary.nhs.uk/attributes/nhs_number.html)." + } + ] + }, + "description": "Determines which suggestions a person is eligible for and which they are not, including reasons and next steps." + }, + "response": [ + { + "name": "RSV - Actionable due to membership of an Age Cohort including suggested national booking action (actions requested)", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", + "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "disabled": true + }, + { + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", + "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", + "disabled": true + }, + { + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345", + "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "disabled": true + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "apikey", + "value": "", + "description": "Added as a part of security scheme: apikey" + } + ], + "url": { + "raw": "{{baseUrl}}/patient-check/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "patient-check", + ":id" + ], + "query": [ + { + "key": "category", + "value": "VACCINATIONS", + "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "disabled": true + }, + { + "key": "conditions", + "value": "FLU,RSV", + "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "disabled": true + }, + { + "key": "includeActions", + "value": "Y", + "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "disabled": true + } + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"Actionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"Actionable\"\n }\n ],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"ButtonWithAuthLink\",\n \"actionCode\": \"BookNBS\",\n \"description\": \"\",\n \"urlLink\": \"http://www.nhs.uk/book-rsv\",\n \"urlLabel\": \"Continue to booking\"\n }\n ]\n }\n ]\n}" + }, + { + "name": "RSV - Actionable due to membership of an Age Cohort including suggested action (not national booking)", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", + "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "disabled": true + }, + { + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", + "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", + "disabled": true + }, + { + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345", + "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "disabled": true + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "apikey", + "value": "", + "description": "Added as a part of security scheme: apikey" + } + ], + "url": { + "raw": "{{baseUrl}}/patient-check/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "patient-check", + ":id" + ], + "query": [ + { + "key": "category", + "value": "VACCINATIONS", + "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "disabled": true + }, + { + "key": "conditions", + "value": "FLU,RSV", + "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "disabled": true + }, + { + "key": "includeActions", + "value": "Y", + "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "disabled": true + } + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"Actionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"Actionable\"\n }\n ],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"InfoText\",\n \"actionCode\": \"BookLocal\",\n \"description\": \"##Getting the vaccine\\nYou can get an RSV vaccination at your GP surgery.\\nYour GP surgery may contact you about getting the RSV vaccine. This may be by letter, text, phone call, email or through the NHS App. You do not need to wait to be contacted before booking your vaccination.\"\n }\n ]\n }\n ]\n}" + }, + { + "name": "RSV - Actionable due to membership of an alternative Age Cohort including suggested action (not national booking)", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", + "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "disabled": true + }, + { + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", + "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", + "disabled": true + }, + { + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345", + "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "disabled": true + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "apikey", + "value": "", + "description": "Added as a part of security scheme: apikey" + } + ], + "url": { + "raw": "{{baseUrl}}/patient-check/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "patient-check", + ":id" + ], + "query": [ + { + "key": "category", + "value": "VACCINATIONS", + "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "disabled": true + }, + { + "key": "conditions", + "value": "FLU,RSV", + "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "disabled": true + }, + { + "key": "includeActions", + "value": "Y", + "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "disabled": true + } + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"Actionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_catchup\",\n \"cohortText\": \"You turned 80 between 2nd September 2024 and 31st August 2025\",\n \"cohortStatus\": \"Actionable\"\n }\n ],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"InfoText\",\n \"actionCode\": \"BookLocal\",\n \"description\": \"##Getting the vaccine\\nYou can get an RSV vaccination at your GP surgery.\\nYour GP surgery may contact you about getting the RSV vaccine. This may be by letter, text, phone call, email or through the NHS App. You do not need to wait to be contacted before booking your vaccination.\"\n }\n ]\n }\n ]\n}" + }, + { + "name": "RSV - Actionable due to membership of an Age Cohort including suggested action (future national booking)", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", + "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "disabled": true + }, + { + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", + "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", + "disabled": true + }, + { + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345", + "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "disabled": true + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "apikey", + "value": "", + "description": "Added as a part of security scheme: apikey" + } + ], + "url": { + "raw": "{{baseUrl}}/patient-check/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "patient-check", + ":id" + ], + "query": [ + { + "key": "category", + "value": "VACCINATIONS", + "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "disabled": true + }, + { + "key": "conditions", + "value": "FLU,RSV", + "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "disabled": true + }, + { + "key": "includeActions", + "value": "Y", + "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "disabled": true + } + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"Actionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"ButtonWithAuthLink\",\n \"actionCode\": \"AmendNBS\",\n \"description\": \"##You have an RSV vaccination appointment\\nYou can view, change or cancel your appointment below.\",\n \"urlLink\": \"http://www.nhs.uk/book-rsv\",\n \"urlLabel\": \"Manage your appointment\"\n }\n ]\n }\n ]\n}" + }, + { + "name": "RSV - Actionable due to membership of an Age Cohort including suggested actions (with future local booking)", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", + "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "disabled": true + }, + { + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", + "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", + "disabled": true + }, + { + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345", + "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "disabled": true + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "apikey", + "value": "", + "description": "Added as a part of security scheme: apikey" + } + ], + "url": { + "raw": "{{baseUrl}}/patient-check/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "patient-check", + ":id" + ], + "query": [ + { + "key": "category", + "value": "VACCINATIONS", + "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "disabled": true + }, + { + "key": "conditions", + "value": "FLU,RSV", + "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "disabled": true + }, + { + "key": "includeActions", + "value": "Y", + "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "disabled": true + } + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"Actionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"CardWithText\",\n \"actionCode\": \"ManageLocal\",\n \"description\": \"##You have an RSV vaccination appointment\\nContact your healthcare provider to change or cancel your appointment.\"\n }\n ]\n }\n ]\n}" + }, + { + "name": "RSV - Not Actionable despite to membership of an Age Cohort with reasoning of already vaccinated (cohorts hidden)", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", + "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "disabled": true + }, + { + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", + "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", + "disabled": true + }, + { + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345", + "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "disabled": true + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "apikey", + "value": "", + "description": "Added as a part of security scheme: apikey" + } + ], + "url": { + "raw": "{{baseUrl}}/patient-check/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "patient-check", + ":id" + ], + "query": [ + { + "key": "category", + "value": "VACCINATIONS", + "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "disabled": true + }, + { + "key": "conditions", + "value": "FLU,RSV", + "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "disabled": true + }, + { + "key": "includeActions", + "value": "Y", + "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "disabled": true + } + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"AlreadyVaccinated\",\n \"ruleText\": \"##You've had your RSV vaccination\\nBased on our records, you recently had this vaccination. You do not need to do anything.\"\n }\n ],\n \"actions\": []\n }\n ]\n}" + }, + { + "name": "RSV - Not Actionable despite to membership of an Age Cohort with reasoning of no available vaccinations (not available type 1)", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", + "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "disabled": true + }, + { + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", + "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", + "disabled": true + }, + { + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345", + "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "disabled": true + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "apikey", + "value": "", + "description": "Added as a part of security scheme: apikey" + } + ], + "url": { + "raw": "{{baseUrl}}/patient-check/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "patient-check", + ":id" + ], + "query": [ + { + "key": "category", + "value": "VACCINATIONS", + "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "disabled": true + }, + { + "key": "conditions", + "value": "FLU,RSV", + "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "disabled": true + }, + { + "key": "includeActions", + "value": "Y", + "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "disabled": true + } + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"NotActionable\"\n }\n ],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"NotAvailable\",\n \"ruleText\": \"Vaccinations are not currently available\"\n }\n ],\n \"actions\": []\n }\n ]\n}" + }, + { + "name": "RSV - No RSV response as no active campaign (not available type 2)", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", + "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "disabled": true + }, + { + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", + "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", + "disabled": true + }, + { + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345", + "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "disabled": true + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "apikey", + "value": "", + "description": "Added as a part of security scheme: apikey" + } + ], + "url": { + "raw": "{{baseUrl}}/patient-check/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "patient-check", + ":id" + ], + "query": [ + { + "key": "category", + "value": "VACCINATIONS", + "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "disabled": true + }, + { + "key": "conditions", + "value": "FLU,RSV", + "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "disabled": true + }, + { + "key": "includeActions", + "value": "Y", + "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "disabled": true + } + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": []\n}" + }, + { + "name": "RSV - Not Actionable despite to membership of an Age Cohort with reasoning of dose not yet due", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", + "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "disabled": true + }, + { + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", + "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", + "disabled": true + }, + { + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345", + "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "disabled": true + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "apikey", + "value": "", + "description": "Added as a part of security scheme: apikey" + } + ], + "url": { + "raw": "{{baseUrl}}/patient-check/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "patient-check", + ":id" + ], + "query": [ + { + "key": "category", + "value": "VACCINATIONS", + "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "disabled": true + }, + { + "key": "conditions", + "value": "FLU,RSV", + "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "disabled": true + }, + { + "key": "includeActions", + "value": "Y", + "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "disabled": true + } + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"NotActionable\"\n }\n ],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"NotYetDue\",\n \"ruleText\": \"Your next dose is not yet due.\"\n }\n ],\n \"actions\": []\n }\n ]\n}" + }, + { + "name": "RSV - Not Actionable despite to membership of an Age Cohort with reasoning of dose not far enough apart", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", + "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "disabled": true + }, + { + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", + "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", + "disabled": true + }, + { + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345", + "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "disabled": true + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "apikey", + "value": "", + "description": "Added as a part of security scheme: apikey" + } + ], + "url": { + "raw": "{{baseUrl}}/patient-check/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "patient-check", + ":id" + ], + "query": [ + { + "key": "category", + "value": "VACCINATIONS", + "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "disabled": true + }, + { + "key": "conditions", + "value": "FLU,RSV", + "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "disabled": true + }, + { + "key": "includeActions", + "value": "Y", + "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "disabled": true + } + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"NotActionable\"\n }\n ],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"TooClose\",\n \"ruleText\": \"Your previous vaccination was less than 91 days ago.\"\n }\n ],\n \"actions\": []\n }\n ]\n}" + }, + { + "name": "RSV - Not Actionable despite to membership of an Age Cohort with reasoning of vaccination given in other setting (e.g. care home)", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", + "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "disabled": true + }, + { + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", + "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", + "disabled": true + }, + { + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345", + "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "disabled": true + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "apikey", + "value": "", + "description": "Added as a part of security scheme: apikey" + } + ], + "url": { + "raw": "{{baseUrl}}/patient-check/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "patient-check", + ":id" + ], + "query": [ + { + "key": "category", + "value": "VACCINATIONS", + "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "disabled": true + }, + { + "key": "conditions", + "value": "FLU,RSV", + "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "disabled": true + }, + { + "key": "includeActions", + "value": "Y", + "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "disabled": true + } + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"NotActionable\"\n }\n ],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"OtherSetting\",\n \"ruleText\": \"##Getting the vaccine\\nOur record show you're living in a setting where care is provided.\\nIf you think you should have the RSV vaccine, speak to a member of staff where you live.\"\n }\n ],\n \"actions\": []\n }\n ]\n}" + }, + { + "name": "RSV - Not Actionable despite no cohort membership with reasoning of already vaccinated (type 1 includes unknown cohort)", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", + "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "disabled": true + }, + { + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", + "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", + "disabled": true + }, + { + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345", + "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "disabled": true + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "apikey", + "value": "", + "description": "Added as a part of security scheme: apikey" + } + ], + "url": { + "raw": "{{baseUrl}}/patient-check/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "patient-check", + ":id" + ], + "query": [ + { + "key": "category", + "value": "VACCINATIONS", + "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "disabled": true + }, + { + "key": "conditions", + "value": "FLU,RSV", + "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "disabled": true + }, + { + "key": "includeActions", + "value": "Y", + "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "disabled": true + } + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"unknown_cohort_membership\",\n \"cohortText\": \"Our records do not say why you are eligible\",\n \"cohortStatus\": \"NotActionable\"\n }\n ],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"AlreadyVaccinated\",\n \"ruleText\": \"##You've had your RSV vaccination\\nBased on our records, you recently had this vaccination.You do not need to do anything.\"\n }\n ],\n \"actions\": []\n }\n ]\n}" + }, + { + "name": "RSV - Not Actionable despite no cohort membership with reasoning of already vaccinated (type 2 includes no cohorts)", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", + "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "disabled": true + }, + { + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", + "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", + "disabled": true + }, + { + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345", + "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "disabled": true + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "apikey", + "value": "", + "description": "Added as a part of security scheme: apikey" + } + ], + "url": { + "raw": "{{baseUrl}}/patient-check/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "patient-check", + ":id" + ], + "query": [ + { + "key": "category", + "value": "VACCINATIONS", + "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "disabled": true + }, + { + "key": "conditions", + "value": "FLU,RSV", + "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "disabled": true + }, + { + "key": "includeActions", + "value": "Y", + "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "disabled": true + } + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"AlreadyVaccinated\",\n \"ruleText\": \"##You've had your RSV vaccination\\nBased on our records, you recently had this vaccination. You do not need to do anything.\"\n }\n ],\n \"actions\": []\n }\n ]\n}" + }, + { + "name": "RSV - Not Eligible", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", + "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "disabled": true + }, + { + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", + "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", + "disabled": true + }, + { + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345", + "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "disabled": true + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "apikey", + "value": "", + "description": "Added as a part of security scheme: apikey" + } + ], + "url": { + "raw": "{{baseUrl}}/patient-check/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "patient-check", + ":id" + ], + "query": [ + { + "key": "category", + "value": "VACCINATIONS", + "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "disabled": true + }, + { + "key": "conditions", + "value": "FLU,RSV", + "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "disabled": true + }, + { + "key": "includeActions", + "value": "Y", + "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "disabled": true + } + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotEligible\",\n \"statusText\": \"We do not believe you should have this vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are not aged 75 to 79 years old.\",\n \"cohortStatus\": \"NotEligible\"\n },\n {\n \"cohortCode\": \"rsv_age_catchup\",\n \"cohortText\": \"You did not turn 80 between 2nd September 2024 and 31st August 2025\",\n \"cohortStatus\": \"NotEligible\"\n }\n ],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"InfoText\",\n \"actionCode\": \"HealthcareProInfo\",\n \"description\": \"##If you think you need this vaccine\\nSpeak to your healthcare professional if you think you should be offered this vaccination.\"\n }\n ]\n }\n ]\n}" + }, + { + "name": "Invalid input data.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", + "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "disabled": true + }, + { + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", + "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", + "disabled": true + }, + { + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345", + "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "disabled": true + }, + { + "key": "Accept", + "value": "application/fhir+json" + }, + { + "key": "apikey", + "value": "", + "description": "Added as a part of security scheme: apikey" + } + ], + "url": { + "raw": "{{baseUrl}}/patient-check/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "patient-check", + ":id" + ], + "query": [ + { + "key": "category", + "value": "VACCINATIONS", + "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "disabled": true + }, + { + "key": "conditions", + "value": "FLU,RSV", + "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "disabled": true + }, + { + "key": "includeActions", + "value": "Y", + "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "disabled": true + } + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/fhir+json" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"id\": \"rrt-2959959087381887325-c-geu2-24001-77777777-1\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"value\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\",\n \"code\": \"VALIDATION_ERROR\",\n \"display\": \"The given conditions were not in the expected format.\"\n }\n ]\n },\n \"diagnostics\": \"FLU&COVID should be a single or comma separated list of condition strings with no other punctuation or special characters\",\n \"location\": [\n \"parameters/conditions\"\n ]\n }\n ]\n}" + }, + { + "name": "Person not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", + "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "disabled": true + }, + { + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", + "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", + "disabled": true + }, + { + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345", + "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "disabled": true + }, + { + "key": "Accept", + "value": "application/fhir+json" + }, + { + "key": "apikey", + "value": "", + "description": "Added as a part of security scheme: apikey" + } + ], + "url": { + "raw": "{{baseUrl}}/patient-check/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "patient-check", + ":id" + ], + "query": [ + { + "key": "category", + "value": "VACCINATIONS", + "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "disabled": true + }, + { + "key": "conditions", + "value": "FLU,RSV", + "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "disabled": true + }, + { + "key": "includeActions", + "value": "Y", + "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "disabled": true + } + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/fhir+json" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"id\": \"rrt-2959959087381887325-c-geu2-24001-77777777-1\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"processing\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\",\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"display\": \"The given NHS number was not found in our datasets. This could be because the number is incorrect or some other reason we cannot process that number.\"\n }\n ]\n },\n \"diagnostics\": \"NHS Number 9000000404 was not recognised by the Eligibility Signposting API\",\n \"location\": [\n \"parameters/id\"\n ]\n }\n ]\n}" + }, + { + "name": "Unrecognised input data. (Unprocessable Content)", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", + "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "disabled": true + }, + { + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", + "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", + "disabled": true + }, + { + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345", + "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "disabled": true + }, + { + "key": "Accept", + "value": "application/fhir+json" + }, + { + "key": "apikey", + "value": "", + "description": "Added as a part of security scheme: apikey" + } + ], + "url": { + "raw": "{{baseUrl}}/patient-check/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "patient-check", + ":id" + ], + "query": [ + { + "key": "category", + "value": "VACCINATIONS", + "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "disabled": true + }, + { + "key": "conditions", + "value": "FLU,RSV", + "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "disabled": true + }, + { + "key": "includeActions", + "value": "Y", + "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "disabled": true + } + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/fhir+json" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"id\": \"rrt-2959959087381887325-c-geu2-24001-77777777-1\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"value\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\",\n \"code\": \"VALIDATION_ERROR\",\n \"display\": \"The supplied category was not recognised by the API.\"\n }\n ]\n },\n \"diagnostics\": \"HEALTHCHECKS is not a category that is supported by the API\",\n \"location\": [\n \"parameters/category\"\n ]\n }\n ]\n}" + }, + { + "name": "Internal server error.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", + "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "disabled": true + }, + { + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", + "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", + "disabled": true + }, + { + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345", + "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "disabled": true + }, + { + "key": "Accept", + "value": "application/fhir+json" + }, + { + "key": "apikey", + "value": "", + "description": "Added as a part of security scheme: apikey" + } + ], + "url": { + "raw": "{{baseUrl}}/patient-check/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "patient-check", + ":id" + ], + "query": [ + { + "key": "category", + "value": "VACCINATIONS", + "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "disabled": true + }, + { + "key": "conditions", + "value": "FLU,RSV", + "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "disabled": true + }, + { + "key": "includeActions", + "value": "Y", + "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "disabled": true + } + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/fhir+json" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"id\": \"rrt-2959959087381887325-c-geu2-24001-77777777-1\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"processing\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\",\n \"code\": \"SERVICE_ERROR\",\n \"display\": \"An unknown error occurred processing this request. Contact us for assistance diagnosing this issue: https://digital.nhs.uk/developer/help-and-support quoting the id included in this message\"\n }\n ]\n },\n \"diagnostics\": \"No diagnostics available\",\n \"location\": [\n \"parameters/category\"\n ]\n }\n ]\n}" + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://sandbox.api.service.nhs.uk/eligibility-signposting-api", + "type": "any" + } + ] } From acbda3454e8a2db66a2dd1438d49bb05c5c65bb0 Mon Sep 17 00:00:00 2001 From: jhadfield-NHS Date: Tue, 24 Jun 2025 13:16:09 +0100 Subject: [PATCH 5/5] Update collection.json Import regenerated file --- specification/postman/collection.json | 3606 ++++++++++++++----------- 1 file changed, 2015 insertions(+), 1591 deletions(-) diff --git a/specification/postman/collection.json b/specification/postman/collection.json index 771a3dd..09a9511 100644 --- a/specification/postman/collection.json +++ b/specification/postman/collection.json @@ -1,1593 +1,2017 @@ { - "info": { - "_postman_id": "bd83cf40-7af6-46f1-a071-4b36813b7939", - "name": "Patient Eligibility Signposting API", - "description": "## Overview\nUse this API to access the [Patient Eligibility Signposting Data Product](https://digital.nhs.uk/services/eligibility-data-product-elid) - the nationally curated single source of eligibility status and signposted actions for individuals. For example, you can request eligibility for one or more vaccination types to understand if NHS England holds information which suggest that the person could or should take further steps toward receiving those vaccinations, and optionally, a list of the steps NHS England would recommend.\nWhere someone is deemed eligible, they will also be classified as actionable or not actionable. When deemed not actionable, one or more reasons will be returned. These reasons can range from personal care setting impacts to current lack of availability of vaccines and more.\nThe API returns most of its data in both code and text form. Unless agreed in writing with NHS England, where text is provided it should be displayed to the user as-is.\nUse this API to request: \n* eligibility for all supported categories and conditions\n* eligibility for specified supported categories and/or conditions \n* request that actions be included in the response\n* request that actions not be included in the response\nYou cannot currently use this API to: \n* request eligibility for proxy people (familial relations etc.)\n* request actions for people considered ineligible\nThis API is read-only and can return a list of processed suggestions, each relating to a 'condition' (e.g. COVID, RSV, BOWEL, EYE, BREAST etc.), including the following information for each: \n* a code representing the condition (COVID, RSV, BOWEL, EYE, BREAST)\n* an overall status (NotEligible, NotActionable, Actionable) \n* a list of eligibility cohort groups to which the person belongs (when eligible)\n* a list of the cohort groups that could have made the person eligible (when not eligible) \n* a list of rules/reasons that deem a person to be NotActionable\n* a list of actions that should be shown to the consumer\n#### Definitions of overall status\nThe overall status values indicate the following:\n* NotEligible - the individual does not currently meet eligibility criteria\n* NotActionable - the individual is eligible but does not need to take any further action at this time \n* Actionable - the individual is eligible and should follow one of the recommended actions provided\n### Patients included in the Patient Eligibility Signposting API\nThe API will return data for all patients who are in the NHS PDS system that are registered with an English GP practice (or one administered by England) or who we believe to be resident in England.\nPatients who are deceased (or thought to be), marked as invalid or sensitive will not be processed by this API.\n## Who can use this API\nThis API can only be used where there is a [legal basis](https://digital.nhs.uk/services/eligibility-data-product-elid#who-this-service-is-for) to do so. Make sure you have a valid use case before you go too far with your development. You must demonstrate you have a [valid use case](https://digital.nhs.uk/services/eligibility-data-product-elid#who-this-service-is-for) as part of digital onboarding.\nYou must do this before you can go live (see 'Onboarding' below).\n### Who can access Eligibility Signposting Information\nPatients who receive health and social care or make use of NHS services in England, Wales and the Isle of Man can access their own Eligibility Signposting data through onboarded services.\nHealth and care organisations in England and the Isle of Man can access our information for legitimate direct care purposes. Legitimate 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### Existing API users\nTo find out which healthcare software development organisations and products are already using this API, see [Patient Eligibility Signposting API - integrated products](https://digital.nhs.uk/services/eligibility-data-product-elid).\n## Access modes This API currently has only one access mode:\n* patient access (user-restricted)\nWe are considering the possibility of adding other modes in the future: \n* healthcare worker access\n* application restricted access\n### Patient access\nIf the end user is a patient then you must use this access mode. Use this access mode to obtain data for that patient.\nThis access mode is [user-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis), meaning an end user must be present, authenticated and authorised.\nThe end user must be:\n* a patient who receives health and social care or makes use of NHS services \n* strongly authenticated, using [NHS login](https://digital.nhs.uk/services/nhs-login)\nTo use this access mode, you must currently use the following security pattern:\n|\tSecurity pattern\t\t |\tTechnical details\t |\tAdvantages\t | Disadvantages |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| ----------------------------------------------------| ------------------------------------------------------------|---------------------------------------------------------| |[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) |OAuth 2.0 token exchange with signed JWT |Gives access to user information. |Need to integrate and onboard separately with NHS login. |\nPatient access mode users must be authenticated to a high proofing level (P9) and to one of the following [vectors of trust](https://nhsconnect.github.io/nhslogin/vectors-of-trust/):\n* P9.Cp.Cd \n* P9.Cp.Ck\n* P9.Cm\nThis access mode is available in production ([beta](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#api-status)).\n### Restricted access This access mode is not yet available, if you believe this mode would benefit your use-case, please let us know.\nThis access mode is [application-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis), meaning we authenticate and authorise the calling application but not the end user.\nThis access mode is not designed to be accessed by an end user. You might use this access mode as part of a back-end process to:\n* retrieve eligibility signposting information into a system in advance of a clinic \n* retrieve eligibility signposting information into a system to be used in a disconnected manner\nTo use this access mode, use this 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## Roadmap\nThe [Patient Eligibility Signposting API](https://digital.nhs.uk/services/eligibility-data-product-elid/eligibility-data-product-elid-roadmap) roadmap shows the planned changes for the API.\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/612352/eligibility-signposting-api-vaccinations).\nIf you have any other queries, please [contact us](https://digital.nhs.uk/developer/help-and-support).\n## Service level\nThis API is a silver service, meaning it is operational 24 hours a day, 365 days a year and supported 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## Rate limits\nThe default rate limit is 25TPS (Transactions Per Second), per app. If you require a higher rate limit please [contact us](https://digital.nhs.uk/developer/help-and-support). or raise this during the onboarding process.\n## Technology\nThis API is [RESTful](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#basic-rest).\nThe error messages returned by this API conform to the FHIR global standard for health care data exchange, specifically to FHIR R4 (v4.0.1). This is to aid consumers that integrate to FHIR based APIS and are in any case not overly complex.\nThere are [libraries and SDKs](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#fhir-libraries-and-sdks) available to help with FHIR API integration.\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## Errors\nWe use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:\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\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.\nYour API-calling application should have a mechanism to automatically try again, for example by giving status information to your end user, before giving up. See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#error-handling) for more information about error handling.\n## Open source\nYou might find the following [open source](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#open-source) resources useful:\n| Resource | Description | Links |\n|---------------------------|----------------------------------------------------------------------|--------------------------------------------------------------------------------| | Patient Eligibility Signposting API| Source code including API proxy, sandbox and specification and code. | [GitHub repo](https://github.com/NHSDigital/eligibility-signposting-api) |\nWe currently don't have any open source client libraries or sample code for this API. If you think this would be useful, you can [upvote the suggestion on our Interactive Product Backlog](https://nhs-digital-api-management.featureupvote.com/suggestions/107439/client-libraries-and-reference-implementations).\n\n## Environments and testing\n| Environment | Base URL | | ----------------- | ---------------------------------------------------------------------- |\n| Sandbox | `https://sandbox.api.service.nhs.uk/eligibility-signposting-api/patient-check/{id}` | | Integration test | `https://int.api.service.nhs.uk/eligibility-signposting-api/patient-check/{id}` |\n| Production | `https://api.service.nhs.uk/eligibility-signposting-api/patient-check/{id}` |\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\nFor details of sandbox test scenarios, or to try out the sandbox using our 'Try this API' feature, see the documentation for each endpoint.\nAlternatively, you can try out the sandbox using our Postman collection:\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/eligibility-signposting-api/eligibility-signposting-api)\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, with options for user-restricted access (NHS Login)\n### Production smoke testing\nYou must not use real patient data for smoke testing in the production environment.\nRather, use our [production test patient](https://digital.nhs.uk/services/eligibility-signposting/api-test-data#production-smoke-testing).\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 is worth planning well ahead.\nAs part of this process, you need to demonstrate your technical conformance to the requirements for this API.\nYou also need to demonstrate that you can manage risks. This might impact the design of your software. For details, see [Onboarding support information](https://digital.nhs.uk/services/eligibility-data-product-elid#how-to-access-this-service).\nTo understand how our online digital onboarding process works, see [digital onboarding](https://digital.nhs.uk/developer/guides-and-documentation/digital-onboarding).\n## Related APIs\nThe following APIs are related to this API:\n", - "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "_exporter_id": "44595835", - "_collection_link": "https://www.postman.com/eligibility-signposting-api/eligibility-signposting-api/collection/4nurb90/patient-eligibility-signposting-api?action=share&source=collection_link&creator=44595835" - }, - "item": [ - { - "name": "Eligibility", - "item": [] - }, - { - "name": "Signposting", - "item": [] - }, - { - "name": "NextActions", - "item": [] - }, - { - "name": "Check Eligibility", - "event": [ - { - "listen": "test", - "script": { - "type": "text/javascript", - "exec": [ - "// Validate status 2xx \npm.test(\"[GET]::/patient-check/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", - "// Validate if response header has matching content-type\npm.test(\"[GET]::/patient-check/:id - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", - "// Validate if response has JSON Body \npm.test(\"[GET]::/patient-check/:id - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"responseId\":{\"type\":\"string\",\"description\":\"GUID assigned when the decisioning evaluation is carried out. This will be useful if you ever need to request support for a particular request. This will not change if you receive a cached response.\"},\"meta\":{\"type\":\"object\",\"properties\":{\"lastUpdated\":{\"type\":\"string\",\"description\":\"Timestamp of when the decisioning evaluation is carried out. This will not change if you receive a cached response.\"}}},\"processedSuggestions\":{\"type\":\"array\",\"description\":\"List of suggestions the person is eligible for.\",\"items\":{\"type\":\"object\",\"properties\":{\"condition\":{\"type\":\"string\",\"description\":\"String representing the vaccine target disease, screening target or other scenario requiring decision based suggestions, that this suggestion relates to\"},\"status\":{\"type\":\"string\",\"description\":\"String representing an overall summary of the persons status for this processedSuggestion\",\"enum\":[\"NotEligible\",\"NotActionable\",\"Actionable\"]},\"statusText\":{\"type\":\"string\"},\"eligibilityCohorts\":{\"type\":\"array\",\"description\":\"Cohorts that drove the eligibility status returned.\",\"items\":{\"type\":\"object\",\"properties\":{\"cohortCode\":{\"type\":\"string\",\"description\":\"Machine readable code signifying the cohort/cohort group that lead to a person's eligibility for this suggestion\"},\"cohortText\":{\"type\":\"string\",\"description\":\"Human readable (render-able) text describing the meaning of a cohort/cohort group that lead to a person's eligibility for this suggestion\"},\"cohortStatus\":{\"type\":\"string\",\"description\":\"String representing the persons status for this processedSuggestion in respect of this particular cohort or cohort group\",\"enum\":[\"NotEligible\",\"NotActionable\",\"Actionable\"]}}}},\"suitabilityRules\":{\"type\":\"array\",\"description\":\"Reasons that the eligibility status was changed from the base eligibility to result in it's status to not be eligible or to be acted on\",\"items\":{\"type\":\"object\",\"properties\":{\"ruleType\":{\"type\":\"string\",\"description\":\"The type of a rule that triggered to amend the status of the suggestion\",\"enum\":[\"F\",\"S\"]},\"ruleCode\":{\"type\":\"string\",\"description\":\"Machine readable code signifying a rule that amended the status of the suggestion\"},\"ruleText\":{\"type\":\"string\",\"description\":\"Human readable (render-able) text describing a rule that amended the status of the suggestion (optionally GFM Markdown)\"}}}},\"actions\":{\"type\":\"array\",\"description\":\"List of actions to be shown to the person.\",\"items\":{\"type\":\"object\",\"properties\":{\"actionType\":{\"type\":\"string\",\"description\":\"Type of action to render. E.g. A primary button, a link, text etc\"},\"actionCode\":{\"type\":\"string\",\"description\":\"Code representing the action to be taken\"},\"description\":{\"type\":\"string\",\"description\":\"Human readable (render-able) text describing the suggested action (optionally GFM Markdown)\"},\"urlLink\":{\"type\":\"string\",\"description\":\"URL to invoke if action selected.\"},\"urlLabel\":{\"type\":\"string\",\"description\":\"Lable to use for the URL (or button) used to display the link\"}}}}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/patient-check/:id - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" - ] - } - } - ], - "request": { - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "key", - "value": "apikey", - "type": "string" - }, - { - "key": "value", - "value": "{{apiKey}}", - "type": "string" - }, - { - "key": "in", - "value": "header", - "type": "string" - } - ] - }, - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", - "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "disabled": true - }, - { - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", - "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", - "disabled": true - }, - { - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345", - "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "disabled": true - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/patient-check/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "patient-check", - ":id" - ], - "query": [ - { - "key": "category", - "value": "VACCINATIONS", - "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "disabled": true - }, - { - "key": "conditions", - "value": "FLU,RSV", - "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "disabled": true - }, - { - "key": "includeActions", - "value": "Y", - "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "disabled": true - } - ], - "variable": [ - { - "key": "id", - "value": "9000000009", - "description": "(Required) The NHS number of the person to check eligibility for. The primary identifier of a patient, unique within NHS England and Wales. Always 10 digits and must be a [valid NHS number](https://www.datadictionary.nhs.uk/attributes/nhs_number.html)." - } - ] - }, - "description": "Determines which suggestions a person is eligible for and which they are not, including reasons and next steps." - }, - "response": [ - { - "name": "RSV - Actionable due to membership of an Age Cohort including suggested national booking action (actions requested)", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", - "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "disabled": true - }, - { - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", - "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", - "disabled": true - }, - { - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345", - "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "disabled": true - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "key": "apikey", - "value": "", - "description": "Added as a part of security scheme: apikey" - } - ], - "url": { - "raw": "{{baseUrl}}/patient-check/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "patient-check", - ":id" - ], - "query": [ - { - "key": "category", - "value": "VACCINATIONS", - "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "disabled": true - }, - { - "key": "conditions", - "value": "FLU,RSV", - "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "disabled": true - }, - { - "key": "includeActions", - "value": "Y", - "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "disabled": true - } - ], - "variable": [ - { - "key": "id" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"Actionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"Actionable\"\n }\n ],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"ButtonWithAuthLink\",\n \"actionCode\": \"BookNBS\",\n \"description\": \"\",\n \"urlLink\": \"http://www.nhs.uk/book-rsv\",\n \"urlLabel\": \"Continue to booking\"\n }\n ]\n }\n ]\n}" - }, - { - "name": "RSV - Actionable due to membership of an Age Cohort including suggested action (not national booking)", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", - "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "disabled": true - }, - { - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", - "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", - "disabled": true - }, - { - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345", - "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "disabled": true - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "key": "apikey", - "value": "", - "description": "Added as a part of security scheme: apikey" - } - ], - "url": { - "raw": "{{baseUrl}}/patient-check/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "patient-check", - ":id" - ], - "query": [ - { - "key": "category", - "value": "VACCINATIONS", - "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "disabled": true - }, - { - "key": "conditions", - "value": "FLU,RSV", - "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "disabled": true - }, - { - "key": "includeActions", - "value": "Y", - "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "disabled": true - } - ], - "variable": [ - { - "key": "id" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"Actionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"Actionable\"\n }\n ],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"InfoText\",\n \"actionCode\": \"BookLocal\",\n \"description\": \"##Getting the vaccine\\nYou can get an RSV vaccination at your GP surgery.\\nYour GP surgery may contact you about getting the RSV vaccine. This may be by letter, text, phone call, email or through the NHS App. You do not need to wait to be contacted before booking your vaccination.\"\n }\n ]\n }\n ]\n}" - }, - { - "name": "RSV - Actionable due to membership of an alternative Age Cohort including suggested action (not national booking)", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", - "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "disabled": true - }, - { - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", - "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", - "disabled": true - }, - { - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345", - "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "disabled": true - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "key": "apikey", - "value": "", - "description": "Added as a part of security scheme: apikey" - } - ], - "url": { - "raw": "{{baseUrl}}/patient-check/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "patient-check", - ":id" - ], - "query": [ - { - "key": "category", - "value": "VACCINATIONS", - "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "disabled": true - }, - { - "key": "conditions", - "value": "FLU,RSV", - "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "disabled": true - }, - { - "key": "includeActions", - "value": "Y", - "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "disabled": true - } - ], - "variable": [ - { - "key": "id" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"Actionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_catchup\",\n \"cohortText\": \"You turned 80 between 2nd September 2024 and 31st August 2025\",\n \"cohortStatus\": \"Actionable\"\n }\n ],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"InfoText\",\n \"actionCode\": \"BookLocal\",\n \"description\": \"##Getting the vaccine\\nYou can get an RSV vaccination at your GP surgery.\\nYour GP surgery may contact you about getting the RSV vaccine. This may be by letter, text, phone call, email or through the NHS App. You do not need to wait to be contacted before booking your vaccination.\"\n }\n ]\n }\n ]\n}" - }, - { - "name": "RSV - Actionable due to membership of an Age Cohort including suggested action (future national booking)", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", - "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "disabled": true - }, - { - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", - "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", - "disabled": true - }, - { - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345", - "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "disabled": true - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "key": "apikey", - "value": "", - "description": "Added as a part of security scheme: apikey" - } - ], - "url": { - "raw": "{{baseUrl}}/patient-check/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "patient-check", - ":id" - ], - "query": [ - { - "key": "category", - "value": "VACCINATIONS", - "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "disabled": true - }, - { - "key": "conditions", - "value": "FLU,RSV", - "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "disabled": true - }, - { - "key": "includeActions", - "value": "Y", - "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "disabled": true - } - ], - "variable": [ - { - "key": "id" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"Actionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"ButtonWithAuthLink\",\n \"actionCode\": \"AmendNBS\",\n \"description\": \"##You have an RSV vaccination appointment\\nYou can view, change or cancel your appointment below.\",\n \"urlLink\": \"http://www.nhs.uk/book-rsv\",\n \"urlLabel\": \"Manage your appointment\"\n }\n ]\n }\n ]\n}" - }, - { - "name": "RSV - Actionable due to membership of an Age Cohort including suggested actions (with future local booking)", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", - "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "disabled": true - }, - { - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", - "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", - "disabled": true - }, - { - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345", - "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "disabled": true - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "key": "apikey", - "value": "", - "description": "Added as a part of security scheme: apikey" - } - ], - "url": { - "raw": "{{baseUrl}}/patient-check/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "patient-check", - ":id" - ], - "query": [ - { - "key": "category", - "value": "VACCINATIONS", - "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "disabled": true - }, - { - "key": "conditions", - "value": "FLU,RSV", - "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "disabled": true - }, - { - "key": "includeActions", - "value": "Y", - "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "disabled": true - } - ], - "variable": [ - { - "key": "id" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"Actionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"CardWithText\",\n \"actionCode\": \"ManageLocal\",\n \"description\": \"##You have an RSV vaccination appointment\\nContact your healthcare provider to change or cancel your appointment.\"\n }\n ]\n }\n ]\n}" - }, - { - "name": "RSV - Not Actionable despite to membership of an Age Cohort with reasoning of already vaccinated (cohorts hidden)", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", - "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "disabled": true - }, - { - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", - "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", - "disabled": true - }, - { - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345", - "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "disabled": true - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "key": "apikey", - "value": "", - "description": "Added as a part of security scheme: apikey" - } - ], - "url": { - "raw": "{{baseUrl}}/patient-check/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "patient-check", - ":id" - ], - "query": [ - { - "key": "category", - "value": "VACCINATIONS", - "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "disabled": true - }, - { - "key": "conditions", - "value": "FLU,RSV", - "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "disabled": true - }, - { - "key": "includeActions", - "value": "Y", - "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "disabled": true - } - ], - "variable": [ - { - "key": "id" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"AlreadyVaccinated\",\n \"ruleText\": \"##You've had your RSV vaccination\\nBased on our records, you recently had this vaccination. You do not need to do anything.\"\n }\n ],\n \"actions\": []\n }\n ]\n}" - }, - { - "name": "RSV - Not Actionable despite to membership of an Age Cohort with reasoning of no available vaccinations (not available type 1)", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", - "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "disabled": true - }, - { - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", - "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", - "disabled": true - }, - { - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345", - "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "disabled": true - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "key": "apikey", - "value": "", - "description": "Added as a part of security scheme: apikey" - } - ], - "url": { - "raw": "{{baseUrl}}/patient-check/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "patient-check", - ":id" - ], - "query": [ - { - "key": "category", - "value": "VACCINATIONS", - "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "disabled": true - }, - { - "key": "conditions", - "value": "FLU,RSV", - "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "disabled": true - }, - { - "key": "includeActions", - "value": "Y", - "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "disabled": true - } - ], - "variable": [ - { - "key": "id" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"NotActionable\"\n }\n ],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"NotAvailable\",\n \"ruleText\": \"Vaccinations are not currently available\"\n }\n ],\n \"actions\": []\n }\n ]\n}" - }, - { - "name": "RSV - No RSV response as no active campaign (not available type 2)", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", - "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "disabled": true - }, - { - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", - "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", - "disabled": true - }, - { - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345", - "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "disabled": true - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "key": "apikey", - "value": "", - "description": "Added as a part of security scheme: apikey" - } - ], - "url": { - "raw": "{{baseUrl}}/patient-check/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "patient-check", - ":id" - ], - "query": [ - { - "key": "category", - "value": "VACCINATIONS", - "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "disabled": true - }, - { - "key": "conditions", - "value": "FLU,RSV", - "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "disabled": true - }, - { - "key": "includeActions", - "value": "Y", - "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "disabled": true - } - ], - "variable": [ - { - "key": "id" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": []\n}" - }, - { - "name": "RSV - Not Actionable despite to membership of an Age Cohort with reasoning of dose not yet due", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", - "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "disabled": true - }, - { - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", - "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", - "disabled": true - }, - { - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345", - "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "disabled": true - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "key": "apikey", - "value": "", - "description": "Added as a part of security scheme: apikey" - } - ], - "url": { - "raw": "{{baseUrl}}/patient-check/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "patient-check", - ":id" - ], - "query": [ - { - "key": "category", - "value": "VACCINATIONS", - "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "disabled": true - }, - { - "key": "conditions", - "value": "FLU,RSV", - "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "disabled": true - }, - { - "key": "includeActions", - "value": "Y", - "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "disabled": true - } - ], - "variable": [ - { - "key": "id" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"NotActionable\"\n }\n ],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"NotYetDue\",\n \"ruleText\": \"Your next dose is not yet due.\"\n }\n ],\n \"actions\": []\n }\n ]\n}" - }, - { - "name": "RSV - Not Actionable despite to membership of an Age Cohort with reasoning of dose not far enough apart", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", - "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "disabled": true - }, - { - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", - "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", - "disabled": true - }, - { - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345", - "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "disabled": true - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "key": "apikey", - "value": "", - "description": "Added as a part of security scheme: apikey" - } - ], - "url": { - "raw": "{{baseUrl}}/patient-check/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "patient-check", - ":id" - ], - "query": [ - { - "key": "category", - "value": "VACCINATIONS", - "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "disabled": true - }, - { - "key": "conditions", - "value": "FLU,RSV", - "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "disabled": true - }, - { - "key": "includeActions", - "value": "Y", - "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "disabled": true - } - ], - "variable": [ - { - "key": "id" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"NotActionable\"\n }\n ],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"TooClose\",\n \"ruleText\": \"Your previous vaccination was less than 91 days ago.\"\n }\n ],\n \"actions\": []\n }\n ]\n}" - }, - { - "name": "RSV - Not Actionable despite to membership of an Age Cohort with reasoning of vaccination given in other setting (e.g. care home)", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", - "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "disabled": true - }, - { - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", - "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", - "disabled": true - }, - { - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345", - "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "disabled": true - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "key": "apikey", - "value": "", - "description": "Added as a part of security scheme: apikey" - } - ], - "url": { - "raw": "{{baseUrl}}/patient-check/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "patient-check", - ":id" - ], - "query": [ - { - "key": "category", - "value": "VACCINATIONS", - "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "disabled": true - }, - { - "key": "conditions", - "value": "FLU,RSV", - "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "disabled": true - }, - { - "key": "includeActions", - "value": "Y", - "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "disabled": true - } - ], - "variable": [ - { - "key": "id" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"NotActionable\"\n }\n ],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"OtherSetting\",\n \"ruleText\": \"##Getting the vaccine\\nOur record show you're living in a setting where care is provided.\\nIf you think you should have the RSV vaccine, speak to a member of staff where you live.\"\n }\n ],\n \"actions\": []\n }\n ]\n}" - }, - { - "name": "RSV - Not Actionable despite no cohort membership with reasoning of already vaccinated (type 1 includes unknown cohort)", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", - "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "disabled": true - }, - { - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", - "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", - "disabled": true - }, - { - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345", - "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "disabled": true - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "key": "apikey", - "value": "", - "description": "Added as a part of security scheme: apikey" - } - ], - "url": { - "raw": "{{baseUrl}}/patient-check/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "patient-check", - ":id" - ], - "query": [ - { - "key": "category", - "value": "VACCINATIONS", - "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "disabled": true - }, - { - "key": "conditions", - "value": "FLU,RSV", - "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "disabled": true - }, - { - "key": "includeActions", - "value": "Y", - "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "disabled": true - } - ], - "variable": [ - { - "key": "id" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"unknown_cohort_membership\",\n \"cohortText\": \"Our records do not say why you are eligible\",\n \"cohortStatus\": \"NotActionable\"\n }\n ],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"AlreadyVaccinated\",\n \"ruleText\": \"##You've had your RSV vaccination\\nBased on our records, you recently had this vaccination.You do not need to do anything.\"\n }\n ],\n \"actions\": []\n }\n ]\n}" - }, - { - "name": "RSV - Not Actionable despite no cohort membership with reasoning of already vaccinated (type 2 includes no cohorts)", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", - "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "disabled": true - }, - { - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", - "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", - "disabled": true - }, - { - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345", - "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "disabled": true - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "key": "apikey", - "value": "", - "description": "Added as a part of security scheme: apikey" - } - ], - "url": { - "raw": "{{baseUrl}}/patient-check/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "patient-check", - ":id" - ], - "query": [ - { - "key": "category", - "value": "VACCINATIONS", - "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "disabled": true - }, - { - "key": "conditions", - "value": "FLU,RSV", - "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "disabled": true - }, - { - "key": "includeActions", - "value": "Y", - "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "disabled": true - } - ], - "variable": [ - { - "key": "id" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"AlreadyVaccinated\",\n \"ruleText\": \"##You've had your RSV vaccination\\nBased on our records, you recently had this vaccination. You do not need to do anything.\"\n }\n ],\n \"actions\": []\n }\n ]\n}" - }, - { - "name": "RSV - Not Eligible", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", - "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "disabled": true - }, - { - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", - "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", - "disabled": true - }, - { - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345", - "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "disabled": true - }, - { - "key": "Accept", - "value": "application/json" - }, - { - "key": "apikey", - "value": "", - "description": "Added as a part of security scheme: apikey" - } - ], - "url": { - "raw": "{{baseUrl}}/patient-check/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "patient-check", - ":id" - ], - "query": [ - { - "key": "category", - "value": "VACCINATIONS", - "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "disabled": true - }, - { - "key": "conditions", - "value": "FLU,RSV", - "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "disabled": true - }, - { - "key": "includeActions", - "value": "Y", - "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "disabled": true - } - ], - "variable": [ - { - "key": "id" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotEligible\",\n \"statusText\": \"We do not believe you should have this vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are not aged 75 to 79 years old.\",\n \"cohortStatus\": \"NotEligible\"\n },\n {\n \"cohortCode\": \"rsv_age_catchup\",\n \"cohortText\": \"You did not turn 80 between 2nd September 2024 and 31st August 2025\",\n \"cohortStatus\": \"NotEligible\"\n }\n ],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"InfoText\",\n \"actionCode\": \"HealthcareProInfo\",\n \"description\": \"##If you think you need this vaccine\\nSpeak to your healthcare professional if you think you should be offered this vaccination.\"\n }\n ]\n }\n ]\n}" - }, - { - "name": "Invalid input data.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", - "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "disabled": true - }, - { - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", - "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", - "disabled": true - }, - { - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345", - "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "disabled": true - }, - { - "key": "Accept", - "value": "application/fhir+json" - }, - { - "key": "apikey", - "value": "", - "description": "Added as a part of security scheme: apikey" - } - ], - "url": { - "raw": "{{baseUrl}}/patient-check/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "patient-check", - ":id" - ], - "query": [ - { - "key": "category", - "value": "VACCINATIONS", - "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "disabled": true - }, - { - "key": "conditions", - "value": "FLU,RSV", - "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "disabled": true - }, - { - "key": "includeActions", - "value": "Y", - "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "disabled": true - } - ], - "variable": [ - { - "key": "id" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/fhir+json" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"id\": \"rrt-2959959087381887325-c-geu2-24001-77777777-1\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"value\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\",\n \"code\": \"VALIDATION_ERROR\",\n \"display\": \"The given conditions were not in the expected format.\"\n }\n ]\n },\n \"diagnostics\": \"FLU&COVID should be a single or comma separated list of condition strings with no other punctuation or special characters\",\n \"location\": [\n \"parameters/conditions\"\n ]\n }\n ]\n}" - }, - { - "name": "Person not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", - "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "disabled": true - }, - { - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", - "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", - "disabled": true - }, - { - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345", - "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "disabled": true - }, - { - "key": "Accept", - "value": "application/fhir+json" - }, - { - "key": "apikey", - "value": "", - "description": "Added as a part of security scheme: apikey" - } - ], - "url": { - "raw": "{{baseUrl}}/patient-check/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "patient-check", - ":id" - ], - "query": [ - { - "key": "category", - "value": "VACCINATIONS", - "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "disabled": true - }, - { - "key": "conditions", - "value": "FLU,RSV", - "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "disabled": true - }, - { - "key": "includeActions", - "value": "Y", - "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "disabled": true - } - ], - "variable": [ - { - "key": "id" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/fhir+json" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"id\": \"rrt-2959959087381887325-c-geu2-24001-77777777-1\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"processing\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\",\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"display\": \"The given NHS number was not found in our datasets. This could be because the number is incorrect or some other reason we cannot process that number.\"\n }\n ]\n },\n \"diagnostics\": \"NHS Number 9000000404 was not recognised by the Eligibility Signposting API\",\n \"location\": [\n \"parameters/id\"\n ]\n }\n ]\n}" - }, - { - "name": "Unrecognised input data. (Unprocessable Content)", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", - "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "disabled": true - }, - { - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", - "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", - "disabled": true - }, - { - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345", - "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "disabled": true - }, - { - "key": "Accept", - "value": "application/fhir+json" - }, - { - "key": "apikey", - "value": "", - "description": "Added as a part of security scheme: apikey" - } - ], - "url": { - "raw": "{{baseUrl}}/patient-check/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "patient-check", - ":id" - ], - "query": [ - { - "key": "category", - "value": "VACCINATIONS", - "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "disabled": true - }, - { - "key": "conditions", - "value": "FLU,RSV", - "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "disabled": true - }, - { - "key": "includeActions", - "value": "Y", - "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "disabled": true - } - ], - "variable": [ - { - "key": "id" - } - ] - } - }, - "status": "Unprocessable Entity (WebDAV) (RFC 4918)", - "code": 422, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/fhir+json" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"id\": \"rrt-2959959087381887325-c-geu2-24001-77777777-1\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"value\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\",\n \"code\": \"VALIDATION_ERROR\",\n \"display\": \"The supplied category was not recognised by the API.\"\n }\n ]\n },\n \"diagnostics\": \"HEALTHCHECKS is not a category that is supported by the API\",\n \"location\": [\n \"parameters/category\"\n ]\n }\n ]\n}" - }, - { - "name": "Internal server error.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068", - "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", - "disabled": true - }, - { - "key": "X-Correlation-ID", - "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA", - "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", - "disabled": true - }, - { - "key": "NHSD-End-User-Organisation-ODS", - "value": "Y12345", - "description": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", - "disabled": true - }, - { - "key": "Accept", - "value": "application/fhir+json" - }, - { - "key": "apikey", - "value": "", - "description": "Added as a part of security scheme: apikey" - } - ], - "url": { - "raw": "{{baseUrl}}/patient-check/:id", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "patient-check", - ":id" - ], - "query": [ - { - "key": "category", - "value": "VACCINATIONS", - "description": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", - "disabled": true - }, - { - "key": "conditions", - "value": "FLU,RSV", - "description": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", - "disabled": true - }, - { - "key": "includeActions", - "value": "Y", - "description": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", - "disabled": true - } - ], - "variable": [ - { - "key": "id" - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/fhir+json" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"id\": \"rrt-2959959087381887325-c-geu2-24001-77777777-1\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"processing\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\",\n \"code\": \"SERVICE_ERROR\",\n \"display\": \"An unknown error occurred processing this request. Contact us for assistance diagnosing this issue: https://digital.nhs.uk/developer/help-and-support quoting the id included in this message\"\n }\n ]\n },\n \"diagnostics\": \"No diagnostics available\",\n \"location\": [\n \"parameters/category\"\n ]\n }\n ]\n}" - } - ] - } - ], - "variable": [ - { - "key": "baseUrl", - "value": "https://sandbox.api.service.nhs.uk/eligibility-signposting-api", - "type": "any" - } - ] + "_": { + "postman_id": "95c82c32-cef6-438a-8e6d-caff920cb44b" + }, + "item": [ + { + "id": "315fa366-52af-4551-9055-819620e2a997", + "name": "Eligibility", + "description": { + "content": "", + "type": "text/plain" + }, + "item": [], + "event": [] + }, + { + "id": "0ad45ea6-b80e-4973-beef-c750ca6a094e", + "name": "Signposting", + "description": { + "content": "", + "type": "text/plain" + }, + "item": [], + "event": [] + }, + { + "id": "dd844d7f-df2d-4c40-ae35-9a96cdd9b2ad", + "name": "NextActions", + "description": { + "content": "", + "type": "text/plain" + }, + "item": [], + "event": [] + }, + { + "id": "a074f30a-967a-438b-ac4a-06d4650b6473", + "name": "Check Eligibility", + "request": { + "name": "Check Eligibility", + "description": { + "content": "Determines which suggestions a person is eligible for and which they are not, including reasons and next steps.", + "type": "text/plain" + }, + "url": { + "path": [ + "patient-check", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "type": "text/plain" + }, + "key": "category", + "value": "VACCINATIONS" + }, + { + "disabled": true, + "description": { + "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "type": "text/plain" + }, + "key": "conditions", + "value": "FLU,RSV" + }, + { + "disabled": true, + "description": { + "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "type": "text/plain" + }, + "key": "includeActions", + "value": "Y" + } + ], + "variable": [ + { + "disabled": false, + "description": { + "content": "(Required) The NHS number of the person to check eligibility for. The primary identifier of a patient, unique within NHS England and Wales. Always 10 digits and must be a [valid NHS number](https://www.datadictionary.nhs.uk/attributes/nhs_number.html).", + "type": "text/plain" + }, + "type": "any", + "value": "9000000009", + "key": "id" + } + ] + }, + "header": [ + { + "disabled": true, + "description": { + "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "type": "text/plain" + }, + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" + }, + { + "disabled": true, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" + }, + { + "disabled": true, + "description": { + "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "type": "text/plain" + }, + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": { + "type": "apikey", + "apikey": [ + { + "type": "any", + "value": "apikey", + "key": "key" + }, + { + "type": "any", + "value": "{{apiKey}}", + "key": "value" + }, + { + "type": "any", + "value": "header", + "key": "in" + } + ] + } + }, + "response": [ + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "151b3704-a358-4d23-acd2-2a46cab74d2a", + "name": "RSV - Actionable due to membership of an Age Cohort including suggested national booking action (actions requested)", + "originalRequest": { + "url": { + "path": [ + "patient-check", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "type": "text/plain" + }, + "key": "category", + "value": "VACCINATIONS" + }, + { + "disabled": true, + "description": { + "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "type": "text/plain" + }, + "key": "conditions", + "value": "FLU,RSV" + }, + { + "disabled": true, + "description": { + "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "type": "text/plain" + }, + "key": "includeActions", + "value": "Y" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": true, + "description": { + "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "type": "text/plain" + }, + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" + }, + { + "disabled": true, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" + }, + { + "disabled": true, + "description": { + "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "type": "text/plain" + }, + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "apikey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"Actionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"Actionable\"\n }\n ],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"ButtonWithAuthLink\",\n \"actionCode\": \"BookNBS\",\n \"description\": \"\",\n \"urlLink\": \"http://www.nhs.uk/book-rsv\",\n \"urlLabel\": \"Continue to booking\"\n }\n ]\n }\n ]\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "673b7dcd-58b3-4e4d-9d61-2c4309202672", + "name": "RSV - Actionable due to membership of an Age Cohort including suggested action (not national booking)", + "originalRequest": { + "url": { + "path": [ + "patient-check", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "type": "text/plain" + }, + "key": "category", + "value": "VACCINATIONS" + }, + { + "disabled": true, + "description": { + "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "type": "text/plain" + }, + "key": "conditions", + "value": "FLU,RSV" + }, + { + "disabled": true, + "description": { + "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "type": "text/plain" + }, + "key": "includeActions", + "value": "Y" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": true, + "description": { + "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "type": "text/plain" + }, + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" + }, + { + "disabled": true, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" + }, + { + "disabled": true, + "description": { + "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "type": "text/plain" + }, + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "apikey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"Actionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"Actionable\"\n }\n ],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"InfoText\",\n \"actionCode\": \"BookLocal\",\n \"description\": \"##Getting the vaccine\\nYou can get an RSV vaccination at your GP surgery.\\nYour GP surgery may contact you about getting the RSV vaccine. This may be by letter, text, phone call, email or through the NHS App. You do not need to wait to be contacted before booking your vaccination.\"\n }\n ]\n }\n ]\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "b275bfea-5a44-4ddb-b9dd-cf773b857adb", + "name": "RSV - Actionable due to membership of an alternative Age Cohort including suggested action (not national booking)", + "originalRequest": { + "url": { + "path": [ + "patient-check", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "type": "text/plain" + }, + "key": "category", + "value": "VACCINATIONS" + }, + { + "disabled": true, + "description": { + "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "type": "text/plain" + }, + "key": "conditions", + "value": "FLU,RSV" + }, + { + "disabled": true, + "description": { + "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "type": "text/plain" + }, + "key": "includeActions", + "value": "Y" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": true, + "description": { + "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "type": "text/plain" + }, + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" + }, + { + "disabled": true, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" + }, + { + "disabled": true, + "description": { + "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "type": "text/plain" + }, + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "apikey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"Actionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_catchup\",\n \"cohortText\": \"You turned 80 between 2nd September 2024 and 31st August 2025\",\n \"cohortStatus\": \"Actionable\"\n }\n ],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"InfoText\",\n \"actionCode\": \"BookLocal\",\n \"description\": \"##Getting the vaccine\\nYou can get an RSV vaccination at your GP surgery.\\nYour GP surgery may contact you about getting the RSV vaccine. This may be by letter, text, phone call, email or through the NHS App. You do not need to wait to be contacted before booking your vaccination.\"\n }\n ]\n }\n ]\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "a154f9bd-3279-47af-8f8b-8c227ab3acd9", + "name": "RSV - Actionable due to membership of an Age Cohort including suggested action (future national booking)", + "originalRequest": { + "url": { + "path": [ + "patient-check", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "type": "text/plain" + }, + "key": "category", + "value": "VACCINATIONS" + }, + { + "disabled": true, + "description": { + "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "type": "text/plain" + }, + "key": "conditions", + "value": "FLU,RSV" + }, + { + "disabled": true, + "description": { + "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "type": "text/plain" + }, + "key": "includeActions", + "value": "Y" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": true, + "description": { + "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "type": "text/plain" + }, + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" + }, + { + "disabled": true, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" + }, + { + "disabled": true, + "description": { + "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "type": "text/plain" + }, + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "apikey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"Actionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"ButtonWithAuthLink\",\n \"actionCode\": \"AmendNBS\",\n \"description\": \"##You have an RSV vaccination appointment\\nYou can view, change or cancel your appointment below.\",\n \"urlLink\": \"http://www.nhs.uk/book-rsv\",\n \"urlLabel\": \"Manage your appointment\"\n }\n ]\n }\n ]\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "a74ce4c4-b223-4393-b31b-330fdfd81ad6", + "name": "RSV - Actionable due to membership of an Age Cohort including suggested actions (with future local booking)", + "originalRequest": { + "url": { + "path": [ + "patient-check", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "type": "text/plain" + }, + "key": "category", + "value": "VACCINATIONS" + }, + { + "disabled": true, + "description": { + "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "type": "text/plain" + }, + "key": "conditions", + "value": "FLU,RSV" + }, + { + "disabled": true, + "description": { + "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "type": "text/plain" + }, + "key": "includeActions", + "value": "Y" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": true, + "description": { + "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "type": "text/plain" + }, + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" + }, + { + "disabled": true, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" + }, + { + "disabled": true, + "description": { + "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "type": "text/plain" + }, + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "apikey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"Actionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"CardWithText\",\n \"actionCode\": \"ManageLocal\",\n \"description\": \"##You have an RSV vaccination appointment\\nContact your healthcare provider to change or cancel your appointment.\"\n }\n ]\n }\n ]\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "c9c2f69e-2496-485c-8c50-b1fb076e74bf", + "name": "RSV - Not Actionable despite to membership of an Age Cohort with reasoning of already vaccinated (cohorts hidden)", + "originalRequest": { + "url": { + "path": [ + "patient-check", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "type": "text/plain" + }, + "key": "category", + "value": "VACCINATIONS" + }, + { + "disabled": true, + "description": { + "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "type": "text/plain" + }, + "key": "conditions", + "value": "FLU,RSV" + }, + { + "disabled": true, + "description": { + "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "type": "text/plain" + }, + "key": "includeActions", + "value": "Y" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": true, + "description": { + "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "type": "text/plain" + }, + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" + }, + { + "disabled": true, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" + }, + { + "disabled": true, + "description": { + "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "type": "text/plain" + }, + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "apikey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"AlreadyVaccinated\",\n \"ruleText\": \"##You've had your RSV vaccination\\nBased on our records, you recently had this vaccination. You do not need to do anything.\"\n }\n ],\n \"actions\": []\n }\n ]\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "7348139c-e205-4352-9460-4d7023d28cfa", + "name": "RSV - Not Actionable despite to membership of an Age Cohort with reasoning of no available vaccinations (not available type 1)", + "originalRequest": { + "url": { + "path": [ + "patient-check", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "type": "text/plain" + }, + "key": "category", + "value": "VACCINATIONS" + }, + { + "disabled": true, + "description": { + "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "type": "text/plain" + }, + "key": "conditions", + "value": "FLU,RSV" + }, + { + "disabled": true, + "description": { + "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "type": "text/plain" + }, + "key": "includeActions", + "value": "Y" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": true, + "description": { + "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "type": "text/plain" + }, + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" + }, + { + "disabled": true, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" + }, + { + "disabled": true, + "description": { + "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "type": "text/plain" + }, + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "apikey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"NotActionable\"\n }\n ],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"NotAvailable\",\n \"ruleText\": \"Vaccinations are not currently available\"\n }\n ],\n \"actions\": []\n }\n ]\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "b88eb083-a8fc-4f4f-8c28-f46f9c3e58ae", + "name": "RSV - No RSV response as no active campaign (not available type 2)", + "originalRequest": { + "url": { + "path": [ + "patient-check", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "type": "text/plain" + }, + "key": "category", + "value": "VACCINATIONS" + }, + { + "disabled": true, + "description": { + "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "type": "text/plain" + }, + "key": "conditions", + "value": "FLU,RSV" + }, + { + "disabled": true, + "description": { + "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "type": "text/plain" + }, + "key": "includeActions", + "value": "Y" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": true, + "description": { + "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "type": "text/plain" + }, + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" + }, + { + "disabled": true, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" + }, + { + "disabled": true, + "description": { + "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "type": "text/plain" + }, + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "apikey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": []\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "3bafe99e-468a-4bbc-a84a-725ed0760e9a", + "name": "RSV - Not Actionable despite to membership of an Age Cohort with reasoning of dose not yet due", + "originalRequest": { + "url": { + "path": [ + "patient-check", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "type": "text/plain" + }, + "key": "category", + "value": "VACCINATIONS" + }, + { + "disabled": true, + "description": { + "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "type": "text/plain" + }, + "key": "conditions", + "value": "FLU,RSV" + }, + { + "disabled": true, + "description": { + "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "type": "text/plain" + }, + "key": "includeActions", + "value": "Y" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": true, + "description": { + "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "type": "text/plain" + }, + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" + }, + { + "disabled": true, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" + }, + { + "disabled": true, + "description": { + "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "type": "text/plain" + }, + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "apikey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"NotActionable\"\n }\n ],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"NotYetDue\",\n \"ruleText\": \"Your next dose is not yet due.\"\n }\n ],\n \"actions\": []\n }\n ]\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "ce18948a-7136-4f87-86ea-50a8b2f37ea0", + "name": "RSV - Not Actionable despite to membership of an Age Cohort with reasoning of dose not far enough apart", + "originalRequest": { + "url": { + "path": [ + "patient-check", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "type": "text/plain" + }, + "key": "category", + "value": "VACCINATIONS" + }, + { + "disabled": true, + "description": { + "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "type": "text/plain" + }, + "key": "conditions", + "value": "FLU,RSV" + }, + { + "disabled": true, + "description": { + "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "type": "text/plain" + }, + "key": "includeActions", + "value": "Y" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": true, + "description": { + "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "type": "text/plain" + }, + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" + }, + { + "disabled": true, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" + }, + { + "disabled": true, + "description": { + "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "type": "text/plain" + }, + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "apikey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"NotActionable\"\n }\n ],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"TooClose\",\n \"ruleText\": \"Your previous vaccination was less than 91 days ago.\"\n }\n ],\n \"actions\": []\n }\n ]\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "c35aeffd-11b0-47ad-8fd4-d30e2fb69920", + "name": "RSV - Not Actionable despite to membership of an Age Cohort with reasoning of vaccination given in other setting (e.g. care home)", + "originalRequest": { + "url": { + "path": [ + "patient-check", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "type": "text/plain" + }, + "key": "category", + "value": "VACCINATIONS" + }, + { + "disabled": true, + "description": { + "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "type": "text/plain" + }, + "key": "conditions", + "value": "FLU,RSV" + }, + { + "disabled": true, + "description": { + "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "type": "text/plain" + }, + "key": "includeActions", + "value": "Y" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": true, + "description": { + "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "type": "text/plain" + }, + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" + }, + { + "disabled": true, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" + }, + { + "disabled": true, + "description": { + "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "type": "text/plain" + }, + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "apikey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are aged 75 to 79 years old.\",\n \"cohortStatus\": \"NotActionable\"\n }\n ],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"OtherSetting\",\n \"ruleText\": \"##Getting the vaccine\\nOur record show you're living in a setting where care is provided.\\nIf you think you should have the RSV vaccine, speak to a member of staff where you live.\"\n }\n ],\n \"actions\": []\n }\n ]\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "24891936-a956-4433-bc7b-bf6395ca819b", + "name": "RSV - Not Actionable despite no cohort membership with reasoning of already vaccinated (type 1 includes unknown cohort)", + "originalRequest": { + "url": { + "path": [ + "patient-check", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "type": "text/plain" + }, + "key": "category", + "value": "VACCINATIONS" + }, + { + "disabled": true, + "description": { + "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "type": "text/plain" + }, + "key": "conditions", + "value": "FLU,RSV" + }, + { + "disabled": true, + "description": { + "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "type": "text/plain" + }, + "key": "includeActions", + "value": "Y" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": true, + "description": { + "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "type": "text/plain" + }, + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" + }, + { + "disabled": true, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" + }, + { + "disabled": true, + "description": { + "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "type": "text/plain" + }, + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "apikey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"unknown_cohort_membership\",\n \"cohortText\": \"Our records do not say why you are eligible\",\n \"cohortStatus\": \"NotActionable\"\n }\n ],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"AlreadyVaccinated\",\n \"ruleText\": \"##You've had your RSV vaccination\\nBased on our records, you recently had this vaccination.You do not need to do anything.\"\n }\n ],\n \"actions\": []\n }\n ]\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "472fa0eb-a949-47a4-9595-081e5a8d2343", + "name": "RSV - Not Actionable despite no cohort membership with reasoning of already vaccinated (type 2 includes no cohorts)", + "originalRequest": { + "url": { + "path": [ + "patient-check", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "type": "text/plain" + }, + "key": "category", + "value": "VACCINATIONS" + }, + { + "disabled": true, + "description": { + "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "type": "text/plain" + }, + "key": "conditions", + "value": "FLU,RSV" + }, + { + "disabled": true, + "description": { + "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "type": "text/plain" + }, + "key": "includeActions", + "value": "Y" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": true, + "description": { + "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "type": "text/plain" + }, + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" + }, + { + "disabled": true, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" + }, + { + "disabled": true, + "description": { + "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "type": "text/plain" + }, + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "apikey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotActionable\",\n \"statusText\": \"You should have the RSV vaccine\",\n \"eligibilityCohorts\": [],\n \"suitabilityRules\": [\n {\n \"ruleType\": \"S\",\n \"ruleCode\": \"AlreadyVaccinated\",\n \"ruleText\": \"##You've had your RSV vaccination\\nBased on our records, you recently had this vaccination. You do not need to do anything.\"\n }\n ],\n \"actions\": []\n }\n ]\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "69bcaa10-17f2-40c9-8c60-24f22a3a43f0", + "name": "RSV - Not Eligible", + "originalRequest": { + "url": { + "path": [ + "patient-check", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "type": "text/plain" + }, + "key": "category", + "value": "VACCINATIONS" + }, + { + "disabled": true, + "description": { + "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "type": "text/plain" + }, + "key": "conditions", + "value": "FLU,RSV" + }, + { + "disabled": true, + "description": { + "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "type": "text/plain" + }, + "key": "includeActions", + "value": "Y" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": true, + "description": { + "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "type": "text/plain" + }, + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" + }, + { + "disabled": true, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" + }, + { + "disabled": true, + "description": { + "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "type": "text/plain" + }, + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "apikey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"responseId\": \"1a233ba5-e1eb-4080-a086-2962f6fc3473\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"processedSuggestions\": [\n {\n \"condition\": \"RSV\",\n \"status\": \"NotEligible\",\n \"statusText\": \"We do not believe you should have this vaccine\",\n \"eligibilityCohorts\": [\n {\n \"cohortCode\": \"rsv_age_rolling\",\n \"cohortText\": \"You are not aged 75 to 79 years old.\",\n \"cohortStatus\": \"NotEligible\"\n },\n {\n \"cohortCode\": \"rsv_age_catchup\",\n \"cohortText\": \"You did not turn 80 between 2nd September 2024 and 31st August 2025\",\n \"cohortStatus\": \"NotEligible\"\n }\n ],\n \"suitabilityRules\": [],\n \"actions\": [\n {\n \"actionType\": \"InfoText\",\n \"actionCode\": \"HealthcareProInfo\",\n \"description\": \"##If you think you need this vaccine\\nSpeak to your healthcare professional if you think you should be offered this vaccination.\"\n }\n ]\n }\n ]\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "0603dca0-edce-4ebd-a37d-2af9b8ea261d", + "name": "Invalid input data.", + "originalRequest": { + "url": { + "path": [ + "patient-check", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "type": "text/plain" + }, + "key": "category", + "value": "VACCINATIONS" + }, + { + "disabled": true, + "description": { + "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "type": "text/plain" + }, + "key": "conditions", + "value": "FLU,RSV" + }, + { + "disabled": true, + "description": { + "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "type": "text/plain" + }, + "key": "includeActions", + "value": "Y" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": true, + "description": { + "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "type": "text/plain" + }, + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" + }, + { + "disabled": true, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" + }, + { + "disabled": true, + "description": { + "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "type": "text/plain" + }, + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345" + }, + { + "key": "Accept", + "value": "application/fhir+json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "apikey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/fhir+json" + } + ], + "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"id\": \"rrt-2959959087381887325-c-geu2-24001-77777777-1\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"value\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\",\n \"code\": \"VALIDATION_ERROR\",\n \"display\": \"The given conditions were not in the expected format.\"\n }\n ]\n },\n \"diagnostics\": \"FLU&COVID should be a single or comma separated list of condition strings with no other punctuation or special characters\",\n \"location\": [\n \"parameters/conditions\"\n ]\n }\n ]\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "5bcb49f1-9157-4ebc-8e26-b4833265991b", + "name": "Person not found.", + "originalRequest": { + "url": { + "path": [ + "patient-check", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "type": "text/plain" + }, + "key": "category", + "value": "VACCINATIONS" + }, + { + "disabled": true, + "description": { + "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "type": "text/plain" + }, + "key": "conditions", + "value": "FLU,RSV" + }, + { + "disabled": true, + "description": { + "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "type": "text/plain" + }, + "key": "includeActions", + "value": "Y" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": true, + "description": { + "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "type": "text/plain" + }, + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" + }, + { + "disabled": true, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" + }, + { + "disabled": true, + "description": { + "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "type": "text/plain" + }, + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345" + }, + { + "key": "Accept", + "value": "application/fhir+json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "apikey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Not Found", + "code": 404, + "header": [ + { + "key": "Content-Type", + "value": "application/fhir+json" + } + ], + "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"id\": \"rrt-2959959087381887325-c-geu2-24001-77777777-1\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"processing\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\",\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"display\": \"The given NHS number was not found in our datasets. This could be because the number is incorrect or some other reason we cannot process that number.\"\n }\n ]\n },\n \"diagnostics\": \"NHS Number 9000000404 was not recognised by the Eligibility Signposting API\",\n \"location\": [\n \"parameters/id\"\n ]\n }\n ]\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "ebdc7523-1835-44f9-823e-cebef7567cd5", + "name": "Unrecognised input data. (Unprocessable Content)", + "originalRequest": { + "url": { + "path": [ + "patient-check", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "type": "text/plain" + }, + "key": "category", + "value": "VACCINATIONS" + }, + { + "disabled": true, + "description": { + "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "type": "text/plain" + }, + "key": "conditions", + "value": "FLU,RSV" + }, + { + "disabled": true, + "description": { + "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "type": "text/plain" + }, + "key": "includeActions", + "value": "Y" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": true, + "description": { + "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "type": "text/plain" + }, + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" + }, + { + "disabled": true, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" + }, + { + "disabled": true, + "description": { + "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "type": "text/plain" + }, + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345" + }, + { + "key": "Accept", + "value": "application/fhir+json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "apikey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "header": [ + { + "key": "Content-Type", + "value": "application/fhir+json" + } + ], + "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"id\": \"rrt-2959959087381887325-c-geu2-24001-77777777-1\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"value\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\",\n \"code\": \"VALIDATION_ERROR\",\n \"display\": \"The supplied category was not recognised by the API.\"\n }\n ]\n },\n \"diagnostics\": \"HEALTHCHECKS is not a category that is supported by the API\",\n \"location\": [\n \"parameters/category\"\n ]\n }\n ]\n}", + "cookie": [] + }, + { + "_": { + "postman_previewlanguage": "json" + }, + "id": "cb72d26d-7678-40fb-bfc2-1a952293767c", + "name": "Internal server error.", + "originalRequest": { + "url": { + "path": [ + "patient-check", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "The category for which the caller is checking eligibility suggestions. If not provided, eligibility for all supported categories will be checked.", + "type": "text/plain" + }, + "key": "category", + "value": "VACCINATIONS" + }, + { + "disabled": true, + "description": { + "content": "The diseases or conditions for which the caller is checking eligibility suggestions in a comma separated list. If not provided, eligibility for all supported diseases will be checked.", + "type": "text/plain" + }, + "key": "conditions", + "value": "FLU,RSV" + }, + { + "disabled": true, + "description": { + "content": "When Y is passed in, the API response will include zero or more actions as applicable. Passing in N will result in no actions being calculated or returned.", + "type": "text/plain" + }, + "key": "includeActions", + "value": "Y" + } + ], + "variable": [] + }, + "header": [ + { + "disabled": true, + "description": { + "content": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n", + "type": "text/plain" + }, + "key": "X-Request-ID", + "value": "60E0B220-8136-4CA5-AE46-1D97EF59D068" + }, + { + "disabled": true, + "description": { + "content": "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", + "type": "text/plain" + }, + "key": "X-Correlation-ID", + "value": "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA" + }, + { + "disabled": true, + "description": { + "content": "The ODS code of the user.\n\nMandatory for client applications which service multiple end user organisations (EUO). This will allow the calls to be attributed to the correct EUO.\n", + "type": "text/plain" + }, + "key": "NHSD-End-User-Organisation-ODS", + "value": "Y12345" + }, + { + "key": "Accept", + "value": "application/fhir+json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "apikey", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/fhir+json" + } + ], + "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"id\": \"rrt-2959959087381887325-c-geu2-24001-77777777-1\",\n \"meta\": {\n \"lastUpdated\": \"2025-02-12T16:11:22Z\"\n },\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"processing\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\",\n \"code\": \"SERVICE_ERROR\",\n \"display\": \"An unknown error occurred processing this request. Contact us for assistance diagnosing this issue: https://digital.nhs.uk/developer/help-and-support quoting the id included in this message\"\n }\n ]\n },\n \"diagnostics\": \"No diagnostics available\",\n \"location\": [\n \"parameters/category\"\n ]\n }\n ]\n}", + "cookie": [] + } + ], + "event": [ + { + "listen": "test", + "script": { + "id": "08c6e73d-56ef-4da3-b717-0c4943d4ec4e", + "type": "text/javascript", + "exec": [ + "// Validate status 2xx \npm.test(\"[GET]::/patient-check/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", + "// Validate if response header has matching content-type\npm.test(\"[GET]::/patient-check/:id - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", + "// Validate if response has JSON Body \npm.test(\"[GET]::/patient-check/:id - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", + "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"responseId\":{\"type\":\"string\",\"description\":\"GUID assigned when the decisioning evaluation is carried out. This will be useful if you ever need to request support for a particular request. This will not change if you receive a cached response.\"},\"meta\":{\"type\":\"object\",\"properties\":{\"lastUpdated\":{\"type\":\"string\",\"description\":\"Timestamp of when the decisioning evaluation is carried out. This will not change if you receive a cached response.\"}}},\"processedSuggestions\":{\"type\":\"array\",\"description\":\"List of suggestions the person is eligible for.\",\"items\":{\"type\":\"object\",\"properties\":{\"condition\":{\"type\":\"string\",\"description\":\"String representing the vaccine target disease, screening target or other scenario requiring decision based suggestions, that this suggestion relates to\"},\"status\":{\"type\":\"string\",\"description\":\"String representing an overall summary of the persons status for this processedSuggestion\",\"enum\":[\"NotEligible\",\"NotActionable\",\"Actionable\"]},\"statusText\":{\"type\":\"string\"},\"eligibilityCohorts\":{\"type\":\"array\",\"description\":\"Cohorts that drove the eligibility status returned.\",\"items\":{\"type\":\"object\",\"properties\":{\"cohortCode\":{\"type\":\"string\",\"description\":\"Machine readable code signifying the cohort/cohort group that lead to a person's eligibility for this suggestion\"},\"cohortText\":{\"type\":\"string\",\"description\":\"Human readable (render-able) text describing the meaning of a cohort/cohort group that lead to a person's eligibility for this suggestion\"},\"cohortStatus\":{\"type\":\"string\",\"description\":\"String representing the persons status for this processedSuggestion in respect of this particular cohort or cohort group\",\"enum\":[\"NotEligible\",\"NotActionable\",\"Actionable\"]}}}},\"suitabilityRules\":{\"type\":\"array\",\"description\":\"Reasons that the eligibility status was changed from the base eligibility to result in it's status to not be eligible or to be acted on\",\"items\":{\"type\":\"object\",\"properties\":{\"ruleType\":{\"type\":\"string\",\"description\":\"The type of a rule that triggered to amend the status of the suggestion\",\"enum\":[\"F\",\"S\"]},\"ruleCode\":{\"type\":\"string\",\"description\":\"Machine readable code signifying a rule that amended the status of the suggestion\"},\"ruleText\":{\"type\":\"string\",\"description\":\"Human readable (render-able) text describing a rule that amended the status of the suggestion (optionally GFM Markdown)\"}}}},\"actions\":{\"type\":\"array\",\"description\":\"List of actions to be shown to the person.\",\"items\":{\"type\":\"object\",\"properties\":{\"actionType\":{\"type\":\"string\",\"description\":\"Type of action to render. E.g. A primary button, a link, text etc\"},\"actionCode\":{\"type\":\"string\",\"description\":\"Code representing the action to be taken\"},\"description\":{\"type\":\"string\",\"description\":\"Human readable (render-able) text describing the suggested action (optionally GFM Markdown)\"},\"urlLink\":{\"type\":\"string\",\"description\":\"URL to invoke if action selected.\"},\"urlLabel\":{\"type\":\"string\",\"description\":\"Lable to use for the URL (or button) used to display the link\"}}}}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/patient-check/:id - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + ] + } + } + ], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ], + "event": [], + "variable": [ + { + "type": "any", + "value": "https://sandbox.api.service.nhs.uk/eligibility-signposting-api", + "key": "baseUrl" + } + ], + "info": { + "_postman_id": "95c82c32-cef6-438a-8e6d-caff920cb44b", + "name": "Patient Eligibility Signposting API", + "version": { + "raw": "1.0.14-alpha", + "major": 1, + "minor": 0, + "patch": 14, + "prerelease": "alpha", + "build": [], + "string": "1.0.14-alpha" + }, + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "description": { + "content": "## Overview\nUse this API to access the [Patient Eligibility Signposting Data Product](https://digital.nhs.uk/services/eligibility-data-product-elid) - the nationally curated single source of eligibility status and signposted actions for individuals. For example, you can request eligibility for one or more vaccination types to understand if NHS England holds information which suggest that the person could or should take further steps toward receiving those vaccinations, and optionally, a list of the steps NHS England would recommend.\nWhere someone is deemed eligible, they will also be classified as actionable or not actionable. When deemed not actionable, one or more reasons will be returned. These reasons can range from personal care setting impacts to current lack of availability of vaccines and more.\nThe API returns most of its data in both code and text form. Unless agreed in writing with NHS England, where text is provided it should be displayed to the user as-is.\nUse this API to request: \n* eligibility for all supported categories and conditions\n* eligibility for specified supported categories and/or conditions \n* request that actions be included in the response\n* request that actions not be included in the response\nYou cannot currently use this API to: \n* request eligibility for proxy people (familial relations etc.)\n* request actions for people considered ineligible\nThis API is read-only and can return a list of processed suggestions, each relating to a 'condition' (e.g. COVID, RSV, BOWEL, EYE, BREAST etc.), including the following information for each: \n* a code representing the condition (COVID, RSV, BOWEL, EYE, BREAST)\n* an overall status (NotEligible, NotActionable, Actionable) \n* a list of eligibility cohort groups to which the person belongs (when eligible)\n* a list of the cohort groups that could have made the person eligible (when not eligible) \n* a list of rules/reasons that deem a person to be NotActionable\n* a list of actions that should be shown to the consumer\n#### Definitions of overall status\nThe overall status values indicate the following:\n* NotEligible - the individual does not currently meet eligibility criteria\n* NotActionable - the individual is eligible but does not need to take any further action at this time \n* Actionable - the individual is eligible and should follow one of the recommended actions provided\n### Patients included in the Patient Eligibility Signposting API\nThe API will return data for all patients who are in the NHS PDS system that are registered with an English GP practice (or one administered by England) or who we believe to be resident in England.\nPatients who are deceased (or thought to be), marked as invalid or sensitive will not be processed by this API.\n## Who can use this API\nThis API can only be used where there is a [legal basis](https://digital.nhs.uk/services/eligibility-data-product-elid#who-this-service-is-for) to do so. Make sure you have a valid use case before you go too far with your development. You must demonstrate you have a [valid use case](https://digital.nhs.uk/services/eligibility-data-product-elid#who-this-service-is-for) as part of digital onboarding.\nYou must do this before you can go live (see 'Onboarding' below).\n### Who can access Eligibility Signposting Information\nPatients who receive health and social care or make use of NHS services in England, Wales and the Isle of Man can access their own Eligibility Signposting data through onboarded services.\nHealth and care organisations in England and the Isle of Man can access our information for legitimate direct care purposes. Legitimate 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### Existing API users\nTo find out which healthcare software development organisations and products are already using this API, see [Patient Eligibility Signposting API - integrated products](https://digital.nhs.uk/services/eligibility-data-product-elid).\n## Access modes This API currently has only one access mode:\n* patient access (user-restricted)\nWe are considering the possibility of adding other modes in the future: \n* healthcare worker access\n* application restricted access\n### Patient access\nIf the end user is a patient then you must use this access mode. Use this access mode to obtain data for that patient.\nThis access mode is [user-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis), meaning an end user must be present, authenticated and authorised.\nThe end user must be:\n* a patient who receives health and social care or makes use of NHS services \n* strongly authenticated, using [NHS login](https://digital.nhs.uk/services/nhs-login)\nTo use this access mode, you must currently use the following security pattern:\n|\tSecurity pattern\t\t |\tTechnical details\t |\tAdvantages\t | Disadvantages |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| ----------------------------------------------------| ------------------------------------------------------------|---------------------------------------------------------| |[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) |OAuth 2.0 token exchange with signed JWT |Gives access to user information. |Need to integrate and onboard separately with NHS login. |\nPatient access mode users must be authenticated to a high proofing level (P9) and to one of the following [vectors of trust](https://nhsconnect.github.io/nhslogin/vectors-of-trust/):\n* P9.Cp.Cd \n* P9.Cp.Ck\n* P9.Cm\nThis access mode is available in production ([beta](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#api-status)).\n### Restricted access This access mode is not yet available, if you believe this mode would benefit your use-case, please let us know.\nThis access mode is [application-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis), meaning we authenticate and authorise the calling application but not the end user.\nThis access mode is not designed to be accessed by an end user. You might use this access mode as part of a back-end process to:\n* retrieve eligibility signposting information into a system in advance of a clinic \n* retrieve eligibility signposting information into a system to be used in a disconnected manner\nTo use this access mode, use this 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## Roadmap\nThe [Patient Eligibility Signposting API](https://digital.nhs.uk/services/eligibility-data-product-elid/eligibility-data-product-elid-roadmap) roadmap shows the planned changes for the API.\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/612352/eligibility-signposting-api-vaccinations).\nIf you have any other queries, please [contact us](https://digital.nhs.uk/developer/help-and-support).\n## Service level\nThis API is a silver service, meaning it is operational 24 hours a day, 365 days a year and supported 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## Rate limits\nThe default rate limit is 25TPS (Transactions Per Second), per app. If you require a higher rate limit please [contact us](https://digital.nhs.uk/developer/help-and-support). or raise this during the onboarding process.\n## Technology\nThis API is [RESTful](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#basic-rest).\nThe error messages returned by this API conform to the FHIR global standard for health care data exchange, specifically to FHIR R4 (v4.0.1). This is to aid consumers that integrate to FHIR based APIS and are in any case not overly complex.\nThere are [libraries and SDKs](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#fhir-libraries-and-sdks) available to help with FHIR API integration.\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## Errors\nWe use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:\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\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.\nYour API-calling application should have a mechanism to automatically try again, for example by giving status information to your end user, before giving up. See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#error-handling) for more information about error handling.\n## Open source\nYou might find the following [open source](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#open-source) resources useful:\n| Resource | Description | Links |\n|---------------------------|----------------------------------------------------------------------|--------------------------------------------------------------------------------| | Patient Eligibility Signposting API| Source code including API proxy, sandbox and specification and code. | [GitHub repo](https://github.com/NHSDigital/eligibility-signposting-api) |\nWe currently don't have any open source client libraries or sample code for this API. If you think this would be useful, you can [upvote the suggestion on our Interactive Product Backlog](https://nhs-digital-api-management.featureupvote.com/suggestions/107439/client-libraries-and-reference-implementations).\n\n## Environments and testing\n| Environment | Base URL | | ----------------- | ---------------------------------------------------------------------- |\n| Sandbox | `https://sandbox.api.service.nhs.uk/eligibility-signposting-api/patient-check/{id}` | | Integration test | `https://int.api.service.nhs.uk/eligibility-signposting-api/patient-check/{id}` |\n| Production | `https://api.service.nhs.uk/eligibility-signposting-api/patient-check/{id}` |\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\nFor details of sandbox test scenarios, or to try out the sandbox using our 'Try this API' feature, see the documentation for each endpoint.\nAlternatively, you can try out the sandbox using our Postman collection:\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/eligibility-signposting-api/eligibility-signposting-api)\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, with options for user-restricted access (NHS Login)\n### Production smoke testing\nYou must not use real patient data for smoke testing in the production environment.\nRather, use our [production test patient](https://digital.nhs.uk/services/eligibility-signposting/api-test-data#production-smoke-testing).\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 is worth planning well ahead.\nAs part of this process, you need to demonstrate your technical conformance to the requirements for this API.\nYou also need to demonstrate that you can manage risks. This might impact the design of your software. For details, see [Onboarding support information](https://digital.nhs.uk/services/eligibility-data-product-elid#how-to-access-this-service).\nTo understand how our online digital onboarding process works, see [digital onboarding](https://digital.nhs.uk/developer/guides-and-documentation/digital-onboarding).\n## Related APIs\nThe following APIs are related to this API:\n", + "type": "text/plain" + } + } }