added note on 'POST /Immunization/_search' (#811)

JamesW1-NHS · web-flow · commit 5d3555a767c8 · 2025-09-11T10:03:43.000+01:00
diff --git a/specification/immunisation-fhir-api.json b/specification/immunisation-fhir-api.json
@@ -875,7 +875,7 @@
         "get": {
           "summary": "Search for a patient's immunisation records",
           "operationId": "searchImmunization",
-          "description": "## Overview\nUse this interaction to search for a patient's vaccination records using their NHS number and DiseaseType. You can request the patient's vaccination history for one or more specified 'disease types'. You may limit the vaccination records by specifying date criteria, for example if you only need to know about vaccinations administered in the last 12 months. \n Location related data items are included. Patient location sensitivity indicators (such as flags for sensitive patient records) should be used to apply data filtering as appropriate. The response will not include contained resources for patient or practitioner within each immunization resource it returns. A single, separate patient resource will be included in the bundle and referenced by each immunization. \nVaccination events submitted without an NHS Number will not be available for retrieval via this interaction. Also, where a patient has a change of NHS Number some or all records may be unavailable via this interaction for a short period of time while records are updated. \nYou must be authorised for the search interaction and the disease type(s) specified in your search in order to access the records. \n \n### Search using POST\n \nA POST search interaction is supported in accordance with [FHIR guidance](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#fhir) as an alternative to a search with the GET verb. A POST search allows you to supply some or all parameters in the body of the request should you need to do so. It offers the same search functionality as the GET search interaction.\n\n## Sandbox testing\nYou can test the following scenarios in our sandbox environment:\n\n| Scenario                                | Request                                                                                                                                                         | Response                                                                |\n| ----------------------------------------| ----------------------------------------------------------------------------------------------------------------------------------------------------------------| ------------------------------------------------------------------------|\n|                                         |                                                                                                                                                                 |                                                                         |\n|  Immunisation history found             | `patient.identifier`=`https://fhir.nhs.uk/Id/nhs-number|9000000009`                                                                                            | HTTP Status 200 with immunisation data in response body                 |\n|  Bad Request                            | Didn't pass required fields `patient.identifier`  or  `-immunization.target`          | HTTP Status 400 Bad Request               |\n",
+          "description": "## Overview\nUse this interaction to search for a patient's vaccination records using their NHS number and DiseaseType. You can request the patient's vaccination history for one or more specified 'disease types'. You may limit the vaccination records by specifying date criteria, for example if you only need to know about vaccinations administered in the last 12 months. \n Location related data items are included. Patient location sensitivity indicators (such as flags for sensitive patient records) should be used to apply data filtering as appropriate. The response will not include contained resources for patient or practitioner within each immunization resource it returns. A single, separate patient resource will be included in the bundle and referenced by each immunization. \nVaccination events submitted without an NHS Number will not be available for retrieval via this interaction. Also, where a patient has a change of NHS Number some or all records may be unavailable via this interaction for a short period of time while records are updated. \nYou must be authorised for the search interaction and the disease type(s) specified in your search in order to access the records. \n \n### Search using POST\n \nA POST search interaction is supported in accordance with [FHIR guidance](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#fhir) as an alternative to a search with the GET verb. A POST search allows you to supply some or all parameters in the body of the request should you need to do so. It offers the same search functionality as the GET search interaction. \n\nNote that the API call for the POST search is different: \n\n`POST /Immunization/_search`\n\n## Sandbox testing\nYou can test the following scenarios in our sandbox environment:\n\n| Scenario                                | Request                                                                                                                                                         | Response                                                                |\n| ----------------------------------------| ----------------------------------------------------------------------------------------------------------------------------------------------------------------| ------------------------------------------------------------------------|\n|                                         |                                                                                                                                                                 |                                                                         |\n|  Immunisation history found             | `patient.identifier`=`https://fhir.nhs.uk/Id/nhs-number|9000000009`                                                                                            | HTTP Status 200 with immunisation data in response body                 |\n|  Bad Request                            | Didn't pass required fields `patient.identifier`  or  `-immunization.target`          | HTTP Status 400 Bad Request               |\n",
           "parameters": [
             {
               "$ref": "#/components/parameters/CorrelationID"

Original file line number	Diff line number	Diff line change
`@@ -875,7 +875,7 @@`
`875`	`875`	`"get": {`
`876`	`876`	`"summary": "Search for a patient's immunisation records",`
`877`	`877`	`"operationId": "searchImmunization",`
`878`		- "description": "## Overview\nUse this interaction to search for a patient's vaccination records using their NHS number and DiseaseType. You can request the patient's vaccination history for one or more specified 'disease types'. You may limit the vaccination records by specifying date criteria, for example if you only need to know about vaccinations administered in the last 12 months. \n Location related data items are included. Patient location sensitivity indicators (such as flags for sensitive patient records) should be used to apply data filtering as appropriate. The response will not include contained resources for patient or practitioner within each immunization resource it returns. A single, separate patient resource will be included in the bundle and referenced by each immunization. \nVaccination events submitted without an NHS Number will not be available for retrieval via this interaction. Also, where a patient has a change of NHS Number some or all records may be unavailable via this interaction for a short period of time while records are updated. \nYou must be authorised for the search interaction and the disease type(s) specified in your search in order to access the records. \n \n### Search using POST\n \nA POST search interaction is supported in accordance with [FHIR guidance](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#fhir) as an alternative to a search with the GET verb. A POST search allows you to supply some or all parameters in the body of the request should you need to do so. It offers the same search functionality as the GET search interaction.\n\n## Sandbox testing\nYou can test the following scenarios in our sandbox environment:\n\n\| Scenario \| Request \| Response \|\n\| ----------------------------------------\| ----------------------------------------------------------------------------------------------------------------------------------------------------------------\| ------------------------------------------------------------------------\|\n\| \| \| \|\n\| Immunisation history found \| `patient.identifier`=`https://fhir.nhs.uk/Id/nhs-number\|9000000009` \| HTTP Status 200 with immunisation data in response body \|\n\| Bad Request \| Didn't pass required fields `patient.identifier` or `-immunization.target` \| HTTP Status 400 Bad Request \|\n",
	`878`	+ "description": "## Overview\nUse this interaction to search for a patient's vaccination records using their NHS number and DiseaseType. You can request the patient's vaccination history for one or more specified 'disease types'. You may limit the vaccination records by specifying date criteria, for example if you only need to know about vaccinations administered in the last 12 months. \n Location related data items are included. Patient location sensitivity indicators (such as flags for sensitive patient records) should be used to apply data filtering as appropriate. The response will not include contained resources for patient or practitioner within each immunization resource it returns. A single, separate patient resource will be included in the bundle and referenced by each immunization. \nVaccination events submitted without an NHS Number will not be available for retrieval via this interaction. Also, where a patient has a change of NHS Number some or all records may be unavailable via this interaction for a short period of time while records are updated. \nYou must be authorised for the search interaction and the disease type(s) specified in your search in order to access the records. \n \n### Search using POST\n \nA POST search interaction is supported in accordance with [FHIR guidance](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#fhir) as an alternative to a search with the GET verb. A POST search allows you to supply some or all parameters in the body of the request should you need to do so. It offers the same search functionality as the GET search interaction. \n\nNote that the API call for the POST search is different: \n\n`POST /Immunization/_search`\n\n## Sandbox testing\nYou can test the following scenarios in our sandbox environment:\n\n\| Scenario \| Request \| Response \|\n\| ----------------------------------------\| ----------------------------------------------------------------------------------------------------------------------------------------------------------------\| ------------------------------------------------------------------------\|\n\| \| \| \|\n\| Immunisation history found \| `patient.identifier`=`https://fhir.nhs.uk/Id/nhs-number\|9000000009` \| HTTP Status 200 with immunisation data in response body \|\n\| Bad Request \| Didn't pass required fields `patient.identifier` or `-immunization.target` \| HTTP Status 400 Bad Request \|\n",
`879`	`879`	`"parameters": [`
`880`	`880`	`{`
`881`	`881`	`"$ref": "#/components/parameters/CorrelationID"`