Retrieve Appointment

4 min

access a patient's upcoming and past appointments from their electronic health record (ehr) this data is pivotal for applications in streamlining scheduling processes, ensuring timely care delivery, and optimizing healthcare provider resources by understanding appointment history, applications can enhance patient engagement and improve overall healthcare efficiency to access this clinical data you'll need the patient identifier, obtainable through the docid 8opknnbmtaz47rk5hkdd3 interaction interaction retrieving the list of allergies and/or intolerances can be done by sending a get to the appointment endpoint https //api \<region> founda com/1/health/organizations/\<org x>/fhir/4/appointment?\<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 appointments the full appointment resource can be retrieved with the identifier of the selected appointment 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 appointment interaction with the founda platform is based on the ihe fhir scheduling profile's https //build fhir org/ig/ihe/iti scheduling/iti 117 html parameters to fetch scheduled appointments for a patient, the following search parameters are available parameter type required description id token logical id of the appointment patient reference y the patient to retrieve the allergy and intolerance overview for date date or date range a date range for the appointment start date status string value from https //hl7 org/fhir/valueset appointmentstatus html example api calls curl location 'https //api eu founda com/1/health/organizations/org 4c5739ba994d4ce9b5255d3f84a2d367/fhir/4/appointment?patient=2078' \\ \ header 'authorization bearer ory at lxkm9xwna ir270xfyrdtgiot7hvaaqg6 fgbtceb5w\ 65shdrnoqkdlbvh ufxc9oaozom63jefpx 7ybeb m'{ "resourcetype" "bundle", "id" "346c53d4 db77 4748 895c af1e0f1938cc", "meta" { "lastupdated" "2023 10 16t13 57 26 796+00 00" }, "type" "searchset", "total" 1, "link" \[ { "relation" "self", "url" "https //api eu founda com/1/health/organizations/org 4c5739ba994d4ce9b5255d3f84a2d367/fhir/4/appointment?patient=2078" } ], "entry" \[ { "fullurl" "https //api eu founda com/1/health/organizations/org 4c5739ba994d4ce9b5255d3f84a2d367/fhir/4/appointment/2095", "resource" { "resourcetype" "appointment", "id" "2095", "meta" { "versionid" "1", "lastupdated" "2023 10 05t14 29 15 606+00 00", "source" "#yppujshqwa645exi", "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\\">brian mri results discussion\</div>" }, "status" "booked", "servicecategory" \[ { "coding" \[ { "system" "http //example org/service category", "code" "gp", "display" "general practice" } ] } ], "servicetype" \[ { "coding" \[ { "code" "52", "display" "general discussion" } ] } ], "specialty" \[ { "coding" \[ { "system" "http //snomed info/sct", "code" "394814009", "display" "general practice" } ] } ], "appointmenttype" { "coding" \[ { "system" "http //terminology hl7 org/codesystem/v2 0276", "code" "followup", "display" "a follow up visit from a previous appointment" } ] }, "priority" 5, "description" "discussion on the results of your recent mri", "start" "2013 12 10t09 00 00z", "end" "2013 12 10t11 00 00z", "created" "2013 10 10", "comment" "further expand on the results of the mri and determine the next actions that may be appropriate ", "participant" \[ { "actor" { "reference" "patient/2078", "display" "peter james chalmers" }, "required" "required", "status" "accepted" }, { "type" \[ { "coding" \[ { "system" "http //terminology hl7 org/codesystem/v3 participationtype", "code" "atnd" } ] } ], "actor" { "reference" "practitioner/2079", "display" "dr adam careful" }, "required" "required", "status" "accepted" }, { "actor" { "reference" "location/2074", "display" "south wing, second floor" }, "required" "required", "status" "accepted" } ] }, "search" { "mode" "match" } } ] }