Retrieve Encounter

4 min

access data on patient encounters with healthcare providers retrieve details on appointments, consultations, and interactions with healthcare professionals useful for understanding a patient's healthcare journey and treatment history to access this clinical data you'll need the patient identifier, obtainable through the docid 8opknnbmtaz47rk5hkdd3 interaction interaction retrieving the list of encounters can be done by sending a get request the request is sent to the encounter endpoint https //api \<region> founda com/1/organizations/\<org x>/fhir/4/encounter?\<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 encounters the full encounter resource can be retrieved with the identifier of the selected encounter 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 encounter 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 /encounter? 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/encounter html resource, can be used as well parameters combination type required description patient reference the patient to search data for patient + date reference + date the patient to search data for + the date of creation of the resource at least one of the combinations has to be supported example api call curl location 'https //api eu founda com/1/health/organizations/org 4c5739ba994d4ce9b5255d3f84a2d367/fhir/4/encounter?patient=2078& profile=https%3a%2f%2fprofiles ihe net%2fiti%2fqedm%2f' \\ \ header 'authorization bearer ory at t sx5ceqgi37wtaptekgav9ggsg4uczrzoc4xe29sto jfqrulkteevvwumpd6djkd2lawdh5vrmfif0pkpnqsu' \\ \ data ''{ "resourcetype" "bundle", "id" "7ad54e5d 3102 440a b41b cf817bdf2d20", "meta" { "lastupdated" "2023 10 17t09 16 18 943+00 00" }, "type" "searchset", "total" 1, "link" \[ { "relation" "self", "url" "https //api eu founda com/1/health/organizations/org 4c5739ba994d4ce9b5255d3f84a2d367/fhir/4/encounter?patient=2078& profile=https //profiles ihe net/iti/qedm/" } ], "entry" \[ { "fullurl" "https //api eu founda com/1/health/organizations/org 4c5739ba994d4ce9b5255d3f84a2d367/fhir/4/encounter/2153", "resource" { "resourcetype" "encounter", "id" "2153", "meta" { "versionid" "1", "lastupdated" "2023 10 05t14 29 17 597+00 00", "source" "#cciimjhheuitegf1", "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\ f203\\\identifier\ encounter roel 20130311 (temp)\\\status\ finished\\<h3>statushistories\</h3>\<table>\<tr>\<td> \</td>\<td>\status\\</td>\<td>\period\\</td>\</tr>\<tr>\<td> \</td>\<td>arrived\</td>\<td>08/03/2013 \> (ongoing)\</td>\</tr>\</table>\\class\ inpatient encounter (details http //terminology hl7 org/codesystem/v3 actcode code imp = 'inpatient encounter', stated as 'inpatient encounter')\\\type\ inpatient stay for nine days \(details {snomed ct code '183807002' = 'inpatient stay 9 days', given as 'inpatient stay for nine days'})\\\\priority\ high priority \(details {snomed ct code '394849002' = 'high priority', given as 'high priority'})\\\\subject\ \<a>roel\</a>\\\episodeofcare\ \<a>episodeofcare/example\</a>\\\basedon\ \<a>servicerequest/myringotomy\</a>\\<h3>participants\</h3>\<table>\<tr>\<td> \</td>\<td>\type\\</td>\<td>\individual\\</td>\</tr>\<tr>\<td> \</td>\<td>participation \(details {http //terminology hl7 org/codesystem/v3 participationtype code 'part' = 'participation)\\</td>\<td>\<a>practitioner/f201\</a>\</td>\</tr>\</table>\\appointment\ \<a>appointment/example\</a>\\\period\ 11/03/2013 \> 20/03/2013\\\reasoncode\ the patient seems to suffer from bilateral pneumonia and renal insufficiency, most likely due to chemotherapy \(details )\\\<blockquote>\\diagnosis\\\\condition\ \<a>condition/stroke\</a>\\\use\ admission diagnosis \(details {http //terminology hl7 org/codesystem/diagnosis role code 'ad' = 'admission diagnosis', given as 'admission diagnosis'})\\\\rank\ 1\\</blockquote>\<blockquote>\\diagnosis\\\\condition\ \<a>condition/f201\</a>\\\use\ discharge diagnosis \(details {http //terminology hl7 org/codesystem/diagnosis role code 'dd' = 'discharge diagnosis', given as 'discharge diagnosis'})\\\</blockquote>\\account\ \<a>account/example\</a>\\<h3>hospitalizations\</h3>\<table>\<tr>\<td> \</td>\<td>\origin\\</td>\<td>\admitsource\\</td>\<td>\readmission\\</td>\<td>\dietpreference\\</td>\<td>\specialcourtesy\\</td>\<td>\specialarrangement\\</td>\<td>\destination\\</td>\</tr>\<tr>\<td> \</td>\<td>\<a>location/2\</a>\</td>\<td>clinical oncology department \(details {snomed ct code '309902002' = 'clinical oncology department', given as 'clinical oncology department'})\\</td>\<td>readmitted \(details {\[not stated] code 'null' = 'null', given as 'readmitted'})\\</td>\<td>fluid balance regulation \(details {snomed ct code '276026009' = 'fluid balance regulation', given as 'fluid balance regulation'})\\</td>\<td>normal courtesy \(details {http //terminology hl7 org/codesystem/v3 encounterspecialcourtesy code 'nrm' = 'normal courtesy', given as 'normal courtesy'})\\</td>\<td>wheelchair \(details {http //terminology hl7 org/codesystem/encounter special arrangements code 'wheel' = 'wheelchair', given as 'wheelchair'})\\</td>\<td>\<a>location/2\</a>\</td>\</tr>\</table>\\serviceprovider\ \<a>organization/2\</a>\\\partof\ \<a>encounter/f203\</a>\\</div>" }, "identifier" \[ { "use" "temp", "value" "encounter roel 20130311" } ], "status" "finished", "statushistory" \[ { "status" "arrived", "period" { "start" "2013 03 08" } } ], "class" { "system" "http //terminology hl7 org/codesystem/v3 actcode", "code" "imp", "display" "inpatient encounter" }, "type" \[ { "coding" \[ { "system" "http //snomed info/sct", "code" "183807002", "display" "inpatient stay for nine days" } ] } ], "priority" { "coding" \[ { "system" "http //snomed info/sct", "code" "394849002", "display" "high priority" } ] }, "subject" { "reference" "patient/2078", "display" "roel" }, "episodeofcare" \[ { "reference" "episodeofcare/2152" } ], "participant" \[ { "type" \[ { "coding" \[ { "system" "http //terminology hl7 org/codesystem/v3 participationtype", "code" "part" } ] } ], "individual" { "reference" "practitioner/2079" } } ], "appointment" \[ { "reference" "appointment/2095" } ], "period" { "start" "2013 03 11", "end" "2013 03 20" }, "reasoncode" \[ { "text" "the patient seems to suffer from bilateral pneumonia and renal insufficiency, most likely due to chemotherapy " } ], "diagnosis" \[ { "use" { "coding" \[ { "system" "http //terminology hl7 org/codesystem/diagnosis role", "code" "ad", "display" "admission diagnosis" } ] }, "rank" 1 }, { "use" { "coding" \[ { "system" "http //terminology hl7 org/codesystem/diagnosis role", "code" "dd", "display" "discharge diagnosis" } ] } } ], "hospitalization" { "origin" { "reference" "location/2074" }, "admitsource" { "coding" \[ { "system" "http //snomed info/sct", "code" "309902002", "display" "clinical oncology department" } ] }, "readmission" { "coding" \[ { "display" "readmitted" } ] }, "dietpreference" \[ { "coding" \[ { "system" "http //snomed info/sct", "code" "276026009", "display" "fluid balance regulation" } ] } ], "specialcourtesy" \[ { "coding" \[ { "system" "http //terminology hl7 org/codesystem/v3 encounterspecialcourtesy", "code" "nrm", "display" "normal courtesy" } ] } ], "specialarrangement" \[ { "coding" \[ { "system" "http //terminology hl7 org/codesystem/encounter special arrangements", "code" "wheel", "display" "wheelchair" } ] } ], "destination" { "reference" "location/2074" } }, "serviceprovider" { "reference" "organization/2072" } }, "search" { "mode" "match" } } ] }