Retrieve Immunization

4 min

retrieve a patient's immunization records from the ehr access details on vaccinations, including vaccine types, dates administered, and dosage information essential for tracking a patient's immunization history and ensuring they receive appropriate vaccinations to access this clinical data you'll need the patient identifier, obtainable through the docid 8opknnbmtaz47rk5hkdd3 interaction interaction retrieving the list of immunizations can be done by sending a get request the request is sent to the immunization endpoint https //api \<region> founda com/1/organizations/\<org x>/fhir/4/immunization?\<parameters> where \<region> should be defined according to the different founda docid\ ncff15xnu1wglst2wnm p and \<org x> should be replaced with the healthcare provider's organization id that you are integrated with the response contains a bundle with 0, 1 or n matching immunizations the full immunization resource can be retrieved with the identifier of the selected immunization from the result set profile founda adheres to recognized standards (ihe, hl7 fhir) to ensure compatibility and harmonization among diverse systems if there is a profile available for an interaction, it is recommended and preferred to follow the prescribed transactions the retrieve immunization interaction with the founda platform is based on the https //www ihe net/uploadedfiles/documents/pcc/ihe pcc suppl qedm pdf to indicate that the request and response should comply with pcc 44, the profile parameter should be included to the search set /immunization? profile=https //profiles ihe net/iti/qedm parameters in order to comply with the pcc 44 transaction, the interaction should at least support the parameter in the table below additional search parameters, as defined in the http //hl7 org/fhir/immunization html resource, can be used as well parameters combination type required description patient reference yes the patient to search data for example api call curl location 'https //api eu founda com/1/health/organizations/org 4c5739ba994d4ce9b5255d3f84a2d367/fhir/4/immunization?patient=2078& profile=https%3a%2f%2fprofiles ihe net%2fiti%2fqedm%2f' \\ \ header 'authorization bearer ory at t sx5ceqgi37wtaptekgav9ggsg4uczrzoc4xe29sto jfqrulkteevvwumpd6djkd2lawdh5vrmfif0pkpnqsu' \\ \ data ''{ "resourcetype" "bundle", "id" "76f4bd79 b179 400d bc8a c07e712b0406", "meta" { "lastupdated" "2023 10 17t09 19 35 913+00 00" }, "type" "searchset", "total" 1, "link" \[ { "relation" "self", "url" "https //api eu founda com/1/health/organizations/org 4c5739ba994d4ce9b5255d3f84a2d367/fhir/4/immunization?patient=2078& profile=https //profiles ihe net/iti/qedm/" } ], "entry" \[ { "fullurl" "https //api eu founda com/1/health/organizations/org 4c5739ba994d4ce9b5255d3f84a2d367/fhir/4/immunization/2207", "resource" { "resourcetype" "immunization", "id" "2207", "meta" { "versionid" "1", "lastupdated" "2023 10 05t14 29 20 382+00 00", "source" "#ry1mqynnzjm6zrrx", "tag" \[ { "system" "http //terminology hl7 org/codesystem/v3 actreason", "code" "htest", "display" "test health data" } ] }, "text" { "status" "generated", "div" "\<div xmlns=\\"http //www w3 org/1999/xhtml\\">\\generated narrative with details\\\\id\ example\\\identifier\ urn\ oid 1 3 6 1 4 1 21367 2005 3 7 1234\\\status\ completed\\\vaccinecode\ fluvax (influenza) \(details {urn\ oid 1 2 36 1 2001 1005 17 code 'fluvax' = 'fluvax)\\\\patient\ \<a>patient/example\</a>\\\encounter\ \<a>encounter/example\</a>\\\occurrence\ 10/01/2013\\\primarysource\ true\\\location\ \<a>location/1\</a>\\\manufacturer\ \<a>organization/hl7\</a>\\\lotnumber\ aajn11k\\\expirationdate\ 15/02/2015\\\site\ left arm \(details {http //terminology hl7 org/codesystem/v3 actsite code 'la' = 'left arm', given as 'left arm'})\\\\route\ injection, intramuscular \(details {http //terminology hl7 org/codesystem/v3 routeofadministration code 'im' = 'injection, intramuscular', given as 'injection, intramuscular'})\\\\dosequantity\ 5 mg\ (details ucum code mg = 'mg')\\\<blockquote>\\performer\\\\function\ ordering provider \(details {http //terminology hl7 org/codesystem/v2 0443 code 'op' = 'ordering provider)\\\\actor\ \<a>practitioner/example\</a>\\</blockquote>\<blockquote>\\performer\\\\function\ administering provider \(details {http //terminology hl7 org/codesystem/v2 0443 code 'ap' = 'administering provider)\\\\actor\ \<a>practitioner/example\</a>\\</blockquote>\\note\ notes on adminstration of vaccine\\\reasoncode\ procedure to meet occupational requirement \(details {snomed ct code '429060002' = 'procedure to meet occupational requirement)\\\\issubpotent\ true\\<h3>educations\</h3>\<table>\<tr>\<td> \</td>\<td>\documenttype\\</td>\<td>\publicationdate\\</td>\<td>\presentationdate\\</td>\</tr>\<tr>\<td> \</td>\<td>253088698300010311120702\</td>\<td>02/07/2012\</td>\<td>10/01/2013\</td>\</tr>\</table>\\programeligibility\ not eligible \(details {http //terminology hl7 org/codesystem/immunization program eligibility code 'ineligible' = 'not eligible)\\\\fundingsource\ private \(details {http //terminology hl7 org/codesystem/immunization funding source code 'private' = 'private)\\\</div>" }, "identifier" \[ { "system" "urn\ ietf\ rfc 3986", "value" "urn\ oid 1 3 6 1 4 1 21367 2005 3 7 1234" } ], "status" "completed", "vaccinecode" { "coding" \[ { "system" "urn\ oid 1 2 36 1 2001 1005 17", "code" "fluvax" } ], "text" "fluvax (influenza)" }, "patient" { "reference" "patient/2078" }, "encounter" { "reference" "encounter/2153" }, "occurrencedatetime" "2013 01 10", "primarysource" true, "location" { "reference" "location/2074" }, "manufacturer" { "reference" "organization/2072" }, "lotnumber" "aajn11k", "expirationdate" "2015 02 15", "site" { "coding" \[ { "system" "http //terminology hl7 org/codesystem/v3 actsite", "code" "la", "display" "left arm" } ] }, "route" { "coding" \[ { "system" "http //terminology hl7 org/codesystem/v3 routeofadministration", "code" "im", "display" "injection, intramuscular" } ] }, "dosequantity" { "value" 5, "system" "http //unitsofmeasure org", "code" "mg" }, "performer" \[ { "function" { "coding" \[ { "system" "http //terminology hl7 org/codesystem/v2 0443", "code" "op" } ] }, "actor" { "reference" "practitioner/2079" } }, { "function" { "coding" \[ { "system" "http //terminology hl7 org/codesystem/v2 0443", "code" "ap" } ] }, "actor" { "reference" "practitioner/2079" } } ], "note" \[ { "text" "notes on adminstration of vaccine" } ], "reasoncode" \[ { "coding" \[ { "system" "http //snomed info/sct", "code" "429060002" } ] } ], "issubpotent" true, "education" \[ { "documenttype" "253088698300010311120702", "publicationdate" "2012 07 02", "presentationdate" "2013 01 10" } ], "programeligibility" \[ { "coding" \[ { "system" "http //terminology hl7 org/codesystem/immunization program eligibility", "code" "ineligible" } ] } ], "fundingsource" { "coding" \[ { "system" "http //terminology hl7 org/codesystem/immunization funding source", "code" "private" } ] } }, "search" { "mode" "match" } } ] }