By demographics

interaction a patient can be queried for based on the known demographics of that patient by sending a get or a post request to the patient endpoint, depending on your docid\ ncff15xnu1wglst2wnm p \<region> founda com/1/health/organizations/\<org x>/fhir/4/patient the amount of patients that are returned in the response depends on the amount of matching patients that result from the api call 0, 1 or n in the case of n matches, the application can implement a heuristic to select the correct patient once the right patient is identified, its unique identifier can be used to retrieve the patient resource as explained in the docid ieqa7s2qquvwrzx tw37 section parameters a combination of the parameters listed below can be used as search parameters parameter type required description id string resource (logical) identifier for the patient active boolean search for active (true) or inactive (false) patients family string family name or last name of the patient given string given name of the patient identifier token a patient identifier, formatted as \<system>|\<value> multiple identifiers can be added telecom token telecommunication details birthdate date patient's birthday, e g "2000 10 01" address string a known address for the patient address city string the city the patient lives in address country string the country the patient lives in address postalcode string the postal code of the patient's address address state string the state the patient lives in gender token the patient's gender, from value set http //hl7 org/fhir/r4/valueset administrative gender html mothersmaidenname string the patient's mother's maiden name profile yes the profile transaction url that the request is for, e g https //profiles ihe net/iti/pdqm profile the retrieve patient interaction with the founda platform is based on the https //profiles ihe net/iti/pdqm/index html to indicate that the request and response should comply with iti 78, the profile parameter should be included to the search set /patient? profile=https //profiles ihe net/iti/pdqm example api call curl location 'https //api eu founda com/1/health/organizations/org 4c5739ba994d4ce9b5255d3f84a2d367/fhir/4/patient?given=duck\&family=donald\&birthdate=1924 06 09& profile=https%3a%2f%2fprofiles ihe net%2fiti%2fpdqm%2f' \\ \ header 'authorization bearer ory at rsh9asri m5wv6ivohlorgo1lavfi4 kg9dplwosdjm nrsredmwdezbonxaoykkosawexahzdxuuey5aanavku'{ "resourcetype" "bundle", "id" "eae206f2 1b2d 4b9b acea 6727cab3e351", "meta" { "lastupdated" "2023 10 05t14 34 11 283+00 00" }, "type" "searchset", "total" 1, "link" \[ { "relation" "self", "url" "https //api eu founda com/1/health/organizations/org 4c5739ba994d4ce9b5255d3f84a2d367/fhir/4/patient?given=duck\&family=donald\&birthdate=1924 06 09& profile=https //profiles ihe net/iti/pdqm/" } ], "entry" \[ { "fullurl" "https //api eu founda com/1/health/organizations/org 4c5739ba994d4ce9b5255d3f84a2d367/fhir/4/patient/2078", "resource" { "resourcetype" "patient", "id" "2078", "meta" { "versionid" "1", "lastupdated" "2023 10 05t14 29 14 124+00 00", "source" "#o1vjx8q904hvvemp", "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\\">\n \n \<p>patient donald duck @ acme healthcare, inc mr = 654321\</p>\n \n \</div>" }, "identifier" \[ { "use" "usual", "type" { "coding" \[ { "system" "http //terminology hl7 org/codesystem/v2 0203", "code" "mr" } ] }, "system" "urn\ oid 0 1 2 3 4 5 6 7", "value" "654321" } ], "active" true, "name" \[ { "use" "official", "family" "donald", "given" \[ "duck" ] } ], "gender" "male", "birthdate" "1924 06 09", "photo" \[ { "contenttype" "image/gif", "data" "r0lgodlhewarapcaaaaaaaaa/+9aao+1ap/wap/eap/ecp/eep/egp/nap/ncp/nep/nif/nkf/nuv/nwv/vap/vcp/vep/vgp/vif/vkf/vmf/vof/vwv/vy//va//vjp/3c//3lp/3np//tf//vf///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////yh5baeaaaealaaaaaatabeaaai+aamiddcgymgbcbmsvmcq4qcfcqcwdbgca4cldyegecdxaoaqhjxwykhqamegiuosjjjrpiagds5wcdly4aalflyoghlbwwosnydm0amzwygjbi8ihwotgqyorg8qigdawakhesi8hidgwqardi1wxxahk9mbbzz8/xdxqoufzc9iicbh6wehgz6ibnuwqospwxegylcxl8o/ganylnlw6auebril7og3kwqiicxb9hszqoieuzujneianmkaaaa7" } ], "contact" \[ { "relationship" \[ { "coding" \[ { "system" "http //terminology hl7 org/codesystem/v2 0131", "code" "e" } ] } ], "organization" { "reference" "organization/2072", "display" "walt disney corporation" } } ], "managingorganization" { "reference" "organization/2072", "display" "acme healthcare, inc" } }, "search" { "mode" "match" } } ] } curl location 'https //api eu founda com/1/health/organizations/org 4c5739ba994d4ce9b5255d3f84a2d367/fhir/4/patient/ search? profile=https%3a%2f%2fprofiles ihe net%2fiti%2fpdqm%2f' \\ \ header 'content type application/x www form urlencoded' \\ \ header 'authorization bearer ory at rsh9asri m5wv6ivohlorgo1lavfi4 kg9dplwosdjm nrsredmwdezbonxaoykkosawexahzdxuuey5aanavku' \\ \ data urlencode 'given=duck' \\ \ data urlencode 'family=donald' \\ \ data urlencode 'birthdate=1924 06 09'{ "resourcetype" "bundle", "id" "eae206f2 1b2d 4b9b acea 6727cab3e351", "meta" { "lastupdated" "2023 10 05t14 34 11 283+00 00" }, "type" "searchset", "total" 1, "link" \[ { "relation" "self", "url" "https //api eu founda com/1/health/organizations/org 4c5739ba994d4ce9b5255d3f84a2d367/fhir/4/patient/ search? profile=https //profiles ihe net/iti/pdqm/" } ], "entry" \[ { "fullurl" "https //api eu founda com/1/health/organizations/org 4c5739ba994d4ce9b5255d3f84a2d367/fhir/4/patient/2078", "resource" { "resourcetype" "patient", "id" "2078", "meta" { "versionid" "1", "lastupdated" "2023 10 05t14 29 14 124+00 00", "source" "#o1vjx8q904hvvemp", "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\\">\n \n \<p>patient donald duck @ acme healthcare, inc mr = 654321\</p>\n \n \</div>" }, "identifier" \[ { "use" "usual", "type" { "coding" \[ { "system" "http //terminology hl7 org/codesystem/v2 0203", "code" "mr" } ] }, "system" "urn\ oid 0 1 2 3 4 5 6 7", "value" "654321" } ], "active" true, "name" \[ { "use" "official", "family" "donald", "given" \[ "duck" ] } ], "gender" "male", "birthdate" "1924 06 09", "photo" \[ { "contenttype" "image/gif", "data" "r0lgodlhewarapcaaaaaaaaa/+9aao+1ap/wap/eap/ecp/eep/egp/nap/ncp/nep/nif/nkf/nuv/nwv/vap/vcp/vep/vgp/vif/vkf/vmf/vof/vwv/vy//va//vjp/3c//3lp/3np//tf//vf///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////yh5baeaaaealaaaaaatabeaaai+aamiddcgymgbcbmsvmcq4qcfcqcwdbgca4cldyegecdxaoaqhjxwykhqamegiuosjjjrpiagds5wcdly4aalflyoghlbwwosnydm0amzwygjbi8ihwotgqyorg8qigdawakhesi8hidgwqardi1wxxahk9mbbzz8/xdxqoufzc9iicbh6wehgz6ibnuwqospwxegylcxl8o/ganylnlw6auebril7og3kwqiicxb9hszqoieuzujneianmkaaaa7" } ], "contact" \[ { "relationship" \[ { "coding" \[ { "system" "http //terminology hl7 org/codesystem/v2 0131", "code" "e" } ] } ], "organization" { "reference" "organization/2072", "display" "walt disney corporation" } } ], "managingorganization" { "reference" "organization/2072", "display" "acme healthcare, inc" } }, "search" { "mode" "match" } } ] }