You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: specification/immunisation-fhir-api.json
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@
20
20
"post": {
21
21
"summary": "Record a vaccination given to a patient",
22
22
"operationId": "createImmunization",
23
-
"description": "## Overview\nUse this interaction to record the administration of a vaccination. The immunization resource must include a targetDisease(s) matching the disease types enabled in this interaction and represented by the correct SNOMED concept(s) for that disease type. A code list will be provided for supported disease types. \nYou must be authorised for the create interaction and the disease type associated with the vaccination event in order to submit a new record. \n\n## Sandbox testing\nYou can test the following scenarios in our sandbox environment:\n\n| Scenario | Request | Response |\n| ----------------------------------------| ----------------------------------------------------------------------------------------------------------------------------------------------------------------| ------------------------------------------------------------------------|\n| | | |\n | Record a vaccination event | Valid request as per schema | HTTP Status 201 with immunisation id in response header (location) |\n| Bad Request (missing/invalid required element in request body) | Didn't pass `resourceType` in request body | HTTP Status 400 Bad Request |\n",
23
+
"description": "## Overview\nUse this interaction to record the administration of a vaccination. The immunization resource must include a targetDisease(s) matching the disease types enabled in this interaction and represented by the correct SNOMED concept(s) for that disease type. A [code list](https://digital.nhs.uk/developer/guides-and-documentation/building-healthcare-software/vaccinations/coding-for-vaccination-disease-types#how-this-applies-to-vaccinations-submitted-to-the-api) is provided for supported disease types. \nYou must be authorised for the create interaction and the disease type associated with the vaccination event in order to submit a new record. \n\n## Sandbox testing\nYou can test the following scenarios in our sandbox environment:\n\n| Scenario | Request | Response |\n| ----------------------------------------| ----------------------------------------------------------------------------------------------------------------------------------------------------------------| ------------------------------------------------------------------------|\n| | | |\n | Record a vaccination event | Valid request as per schema | HTTP Status 201 with immunisation id in response header (location) |\n| Bad Request (missing/invalid required element in request body) | Didn't pass `resourceType` in request body | HTTP Status 400 Bad Request |\n",
24
24
"parameters": [
25
25
{
26
26
"$ref": "#/components/parameters/CorrelationID"
@@ -638,7 +638,7 @@
638
638
"properties": {
639
639
"targetDisease": {
640
640
"type": "array",
641
-
"description": "The vaccine preventable disease the dose is being administered against. \nThis SHALL be populated with the appropriate SNOMED CT concept. A code list will be provided for each supported type of vaccination. A valid code or code combination SHALL be provided. \nFor vaccines which provide immunity for more than one target disease there SHALL be one instance of targetDisease for each and no more.",
641
+
"description": "The vaccine preventable disease the dose is being administered against. \nThis SHALL be populated with the appropriate SNOMED CT concept. See the provided [code list](https://digital.nhs.uk/developer/guides-and-documentation/building-healthcare-software/vaccinations/coding-for-vaccination-disease-types#how-this-applies-to-vaccinations-submitted-to-the-api) for each supported type of vaccination. A valid code or code combination SHALL be provided. \nFor vaccines which provide immunity for more than one target disease there SHALL be one instance of targetDisease for each and no more.",
642
642
"items": {
643
643
"type": "object",
644
644
"required": [
@@ -3315,7 +3315,7 @@
3315
3315
"properties": {
3316
3316
"targetDisease": {
3317
3317
"type": "array",
3318
-
"description": "The vaccine preventable disease the dose is being administered against. \nThis SHALL be populated with the appropriate SNOMED CT concept. A code list will be provided for each supported type of vaccination. A valid code or code combination SHALL be provided. \nFor vaccines which provide immunity for more than one target disease there SHALL be one instance of targetDisease for each and no more.",
3318
+
"description": "The vaccine preventable disease the dose is being administered against. \nThis SHALL be populated with the appropriate SNOMED CT concept. See the provided [code list](https://digital.nhs.uk/developer/guides-and-documentation/building-healthcare-software/vaccinations/coding-for-vaccination-disease-types#how-this-applies-to-vaccinations-submitted-to-the-api) for each supported type of vaccination. A valid code or code combination SHALL be provided. \nFor vaccines which provide immunity for more than one target disease there SHALL be one instance of targetDisease for each and no more.",
0 commit comments