Skip to content

Commit 2ed218b

Browse files
Akol125Akol125
committed
docs: search immunisation by identifier
1 parent 574518e commit 2ed218b

File tree

1 file changed

+186
-0
lines changed

1 file changed

+186
-0
lines changed

‎specification/immunisation-fhir-api.json‎

Lines changed: 186 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1688,6 +1688,182 @@
16881688
}
16891689
}
16901690
},
1691+
"/Immunization/$search-by-identifier": {
1692+
"get": {
1693+
"summary": "Search immunisations by record identifier",
1694+
"operationId": "searchImmunizationByIdentifier",
1695+
"description": "Use this interaction to find Immunization records by their unique identifier assigned by the submitting system. Provide the composite FHIR search parameter `identifier` as `<system>|<value>`, for example: `identifier=https://supplierABC/identifiers/vacc|e2154d29-1ead-4830-a513-0d59705078fa`. This returns a Bundle of matching Immunization resources",
1696+
"parameters": [
1697+
{ "$ref": "#/components/parameters/CorrelationID" },
1698+
{ "$ref": "#/components/parameters/RequestID" },
1699+
{ "$ref": "#/components/parameters/Identifier" },
1700+
{ "$ref": "#/components/parameters/Include" }
1701+
],
1702+
"responses": {
1703+
"200": {
1704+
"description": "Search immunisation operation successful",
1705+
"content": {
1706+
"application/fhir+json": {
1707+
"example": {
1708+
"resourceType": "Bundle",
1709+
"type": "searchset",
1710+
"link": [
1711+
{
1712+
"relation": "self",
1713+
"url": "https://sandbox.api.service.nhs.uk/immunisation-fhir-api/Immunization?identifier=https%3A%2F%2FsupplierABC%2Fidentifiers%2Fvacc%7Ce2154d29-1ead-4830-a513-0d59705078fa&_include=Immunization%3Apatient"
1714+
}
1715+
],
1716+
"entry": [
1717+
{
1718+
"fullUrl": "https://sandbox.api.service.nhs.uk/immunisation-fhir-api/Immunization/191f288a-17f3-4cd5-a33c-a52aade6473c",
1719+
"resource": {
1720+
"resourceType": "Immunization",
1721+
"id": "191f288a-17f3-4cd5-a33c-a52aade6473c",
1722+
"meta": { "versionId": "1" },
1723+
"extension": [
1724+
{
1725+
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure",
1726+
"valueCodeableConcept": {
1727+
"coding": [
1728+
{
1729+
"system": "http://snomed.info/sct",
1730+
"code": "1303503001",
1731+
"display": "Administration of RSV (respiratory syncytial virus) vaccine"
1732+
}
1733+
]
1734+
}
1735+
}
1736+
],
1737+
"identifier": [
1738+
{
1739+
"use": "official",
1740+
"system": "https://supplierABC/identifiers/vacc",
1741+
"value": "e2154d29-1ead-4830-a513-0d59705078fa"
1742+
}
1743+
],
1744+
"status": "completed",
1745+
"vaccineCode": {
1746+
"coding": [
1747+
{
1748+
"system": "http://snomed.info/sct",
1749+
"code": "42605811000001109",
1750+
"display": "Abrysvo vaccine powder and solvent for solution for injection 0.5ml vials (Pfizer Ltd)"
1751+
}
1752+
]
1753+
},
1754+
"patient": {
1755+
"reference": "urn:uuid:a7a5bc28-5831-4158-8a73-0d3e6e43c1ac",
1756+
"type": "Patient",
1757+
"identifier": {
1758+
"system": "https://fhir.nhs.uk/Id/nhs-number",
1759+
"value": "9449306206"
1760+
}
1761+
},
1762+
"occurrenceDateTime": "2021-02-07T13:28:17.271000+00:00",
1763+
"recorded": "2021-02-07T13:28:17.271000+00:00",
1764+
"primarySource": true,
1765+
"location": {
1766+
"identifier": {
1767+
"system": "urn:iso:std:iso:3166",
1768+
"value": "GB"
1769+
}
1770+
},
1771+
"manufacturer": { "display": "AstraZeneca Ltd" },
1772+
"lotNumber": "4120Z001",
1773+
"expirationDate": "2021-07-02",
1774+
"site": {
1775+
"coding": [
1776+
{
1777+
"system": "http://snomed.info/sct",
1778+
"code": "368208006",
1779+
"display": "Left upper arm structure (body structure)"
1780+
}
1781+
]
1782+
},
1783+
"route": {
1784+
"coding": [
1785+
{
1786+
"system": "http://snomed.info/sct",
1787+
"code": "78421000",
1788+
"display": "Intramuscular route (qualifier value)"
1789+
}
1790+
]
1791+
},
1792+
"doseQuantity": {
1793+
"value": 0.5,
1794+
"unit": "milliliter",
1795+
"system": "http://unitsofmeasure.org",
1796+
"code": "ml"
1797+
},
1798+
"performer": [
1799+
{
1800+
"actor": {
1801+
"type": "Organization",
1802+
"identifier": {
1803+
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
1804+
"value": "B0C4P"
1805+
},
1806+
"display": "UNIVERSITY HOSPITAL OF WALES"
1807+
}
1808+
}
1809+
],
1810+
"reasonCode": [
1811+
{
1812+
"coding": [
1813+
{
1814+
"system": "http://snomed.info/sct",
1815+
"code": "443684005",
1816+
"display": "Disease outbreak (event)"
1817+
}
1818+
]
1819+
}
1820+
],
1821+
"protocolApplied": [
1822+
{
1823+
"targetDisease": [
1824+
{
1825+
"coding": [
1826+
{
1827+
"system": "http://snomed.info/sct",
1828+
"code": "55735004",
1829+
"display": "Respiratory syncytial virus infection (disorder)"
1830+
}
1831+
]
1832+
}
1833+
],
1834+
"doseNumberPositiveInt": 1
1835+
}
1836+
]
1837+
},
1838+
"search": { "mode": "match" }
1839+
},
1840+
{
1841+
"fullUrl": "urn:uuid:a7a5bc28-5831-4158-8a73-0d3e6e43c1ac",
1842+
"resource": {
1843+
"resourceType": "Patient",
1844+
"id": "9449306206",
1845+
"identifier": [
1846+
{
1847+
"system": "https://fhir.nhs.uk/Id/nhs-number",
1848+
"value": "9449306206"
1849+
}
1850+
],
1851+
"birthDate": "2014-03-25"
1852+
},
1853+
"search": { "mode": "include" }
1854+
}
1855+
],
1856+
"total": 1
1857+
}
1858+
}
1859+
}
1860+
},
1861+
"4XX": {
1862+
"$ref": "#/components/responses/4XX-imms-search"
1863+
}
1864+
}
1865+
}
1866+
},
16911867
"/Immunization/{id}": {
16921868
"get": {
16931869
"summary": "Retrieve a record of an immunisation by its unique identifier",
@@ -3725,6 +3901,16 @@
37253901
"default": "Immunization:patient"
37263902
}
37273903
},
3904+
"Identifier": {
3905+
"in": "query",
3906+
"name": "identifier",
3907+
"description": "Search by Immunization resource identifier. Expressed as `<system>|<value>` per FHIR search, for example `https://supplierABC/identifiers/vacc|e2154d29-1ead-4830-a513-0d59705078fa`. When using this parameter, other search parameters such as `patient.identifier` and `-immunization.target` are not required.",
3908+
"required": true,
3909+
"schema": {
3910+
"type": "string",
3911+
"example": "https://supplierABC/identifiers/vacc|e2154d29-1ead-4830-a513-0d59705078fa"
3912+
}
3913+
},
37283914
"E-Tag": {
37293915
"in": "header",
37303916
"name": "E-Tag",

0 commit comments

Comments
 (0)