Skip to content

Commit fb7972f

Browse files
Akol125Akol125
authored
VED-109-OAS (#406)
OAS s-flag/pds changes
1 parent 9611e59 commit fb7972f

File tree

2 files changed

+7160
-2891
lines changed

2 files changed

+7160
-2891
lines changed

‎sandbox/immunisation-fhir-api.json‎

Lines changed: 50 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -871,7 +871,7 @@
871871
"get": {
872872
"summary": "Search (GET) for a patient's immunisation records",
873873
"operationId": "searchViaGetImmunization",
874-
"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. \nVaccination event details may be obfuscated for sensitive information. 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 whilst 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## 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",
874+
"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 obtained by connecting systems from the [Personal Demographics Service (PDS)](https://digital.nhs.uk/services/personal-demographics-service) and 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 whilst 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## 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",
875875
"parameters": [
876876
{
877877
"$ref": "#/components/parameters/CorrelationID"
@@ -1545,8 +1545,7 @@
15451545
"type": "object",
15461546
"required": [
15471547
"resourceType",
1548-
"id",
1549-
"birthDate"
1548+
"id"
15501549
],
15511550
"properties": {
15521551
"resourceType": {
@@ -1582,11 +1581,6 @@
15821581
}
15831582
}
15841583
}
1585-
},
1586-
"birthDate": {
1587-
"description": "Patient's date of birth.",
1588-
"type": "string",
1589-
"example": "1965-02-28"
15901584
}
15911585
}
15921586
}
@@ -1764,8 +1758,7 @@
17641758
"system": "https://fhir.nhs.uk/Id/nhs-number",
17651759
"value": "9000000009"
17661760
}
1767-
],
1768-
"birthDate": "2014-03-25"
1761+
]
17691762
},
17701763
"search": {
17711764
"mode": "include"
@@ -2706,7 +2699,7 @@
27062699
"get": {
27072700
"summary": "Retrieve a record of an immunisation by its unique identifier",
27082701
"operationId": "readImmunization",
2709-
"description": "## Overview\nThis interaction allows you to retrieve the record of a single vaccination by our assigned id. We will return the full immunization resource as submitted, except vaccination event details may be obfuscated for sensitive information. \nThe response will include an eTag for the version of the record which has been returned. If you intend to update a record, it is recommended that you use this interaction to obtain the latest version (and eTag for the version). \nTo retrieve a full vaccination history for a patient, see the search interaction. \nYou must be authorised for the read interaction and the disease type associated with the vaccination event in order to access the record. \n\n## Sandbox testing\nYou can test the following scenarios in our sandbox environment:\n\n| Scenario | Request | Response |\n| ----------------------------------------| ----------------------------------------------------------------------------------------------------------------------------------------------------------------| ------------------------------------------------------------------------|\n| | | |\n| Immunisation record found | `id`=`12a33650-6f94-4e8f-a971-1c5c41da5b22` | HTTP Status 200 with immunisation data in response body |\n| Bad Request | Didn't pass Required fields `id` | HTTP Status 400 Bad Request |\n",
2702+
"description": "## Overview\nThis interaction allows you to retrieve the record of a single vaccination by our assigned id. We will return the full immunization resource as submitted. \nThe response will include an eTag for the version of the record which has been returned. If you intend to update a record, it is recommended that you use this interaction to obtain the latest version (and eTag for the version). \nTo retrieve a full vaccination history for a patient, see the search interaction. \nYou must be authorised for the read interaction and the disease type associated with the vaccination event in order to access the record. \n\n## Sandbox testing\nYou can test the following scenarios in our sandbox environment:\n\n| Scenario | Request | Response |\n| ----------------------------------------| ----------------------------------------------------------------------------------------------------------------------------------------------------------------| ------------------------------------------------------------------------|\n| | | |\n| Immunisation record found | `id`=`12a33650-6f94-4e8f-a971-1c5c41da5b22` | HTTP Status 200 with immunisation data in response body |\n| Bad Request | Didn't pass Required fields `id` | HTTP Status 400 Bad Request |\n",
27102703
"parameters": [
27112704
{
27122705
"$ref": "#/components/parameters/CorrelationID"
@@ -2741,6 +2734,7 @@
27412734
"resourceType",
27422735
"contained",
27432736
"extension",
2737+
"identifier",
27442738
"status",
27452739
"vaccineCode",
27462740
"patient",
@@ -2940,7 +2934,6 @@
29402934
"identifier",
29412935
"name",
29422936
"gender",
2943-
"birthDate",
29442937
"address"
29452938
]
29462939
}
@@ -3005,6 +2998,43 @@
30052998
}
30062999
}
30073000
},
3001+
"identifier": {
3002+
"description": "Unique identifier for this immunisation record, as generated by the source system.",
3003+
"type": "array",
3004+
"minItems": 1,
3005+
"maxItems": 1,
3006+
"items": {
3007+
"type": "object",
3008+
"required": [
3009+
"system",
3010+
"value"
3011+
],
3012+
"properties": {
3013+
"use": {
3014+
"description": "Identifier use as defined by https://www.hl7.org/fhir/valueset-identifier-use.html.",
3015+
"type": "string",
3016+
"enum": [
3017+
"usual",
3018+
"official",
3019+
"temp",
3020+
"secondary",
3021+
"old"
3022+
],
3023+
"example": "official"
3024+
},
3025+
"system": {
3026+
"description": "URI of the namespace of this identifier.",
3027+
"type": "string",
3028+
"example": "https://supplierABC/identifiers/vacc"
3029+
},
3030+
"value": {
3031+
"description": "Identifier value within `system`.",
3032+
"type": "string",
3033+
"example": "e2154d29-1ead-4830-a513-0d59705078fa"
3034+
}
3035+
}
3036+
}
3037+
},
30083038
"status": {
30093039
"description": "Status of the immunisation event. This is *not* an indication of patient immunity, only whether the immunisation was completed or not. Currently we only return details of completed immunisations.",
30103040
"type": "string",
@@ -3431,7 +3461,7 @@
34313461
"birthDate": "1965-02-28",
34323462
"address": [
34333463
{
3434-
"postalCode": "ZZ99 3CZ"
3464+
"postalCode": "EC1A 1BB"
34353465
}
34363466
]
34373467
}
@@ -3450,6 +3480,13 @@
34503480
}
34513481
}
34523482
],
3483+
"identifier": [
3484+
{
3485+
"use": "official",
3486+
"system": "https://supplierABC/identifiers/vacc",
3487+
"value": "e2154d29-1ead-4830-a513-0d59705078fa"
3488+
}
3489+
],
34533490
"status": "completed",
34543491
"vaccineCode": {
34553492
"coding": [

0 commit comments

Comments
 (0)