Building on the Platform
...
Solutions
Access to Clinical Data
Retrieve Observation
4 min
access patient observation data recorded during healthcare encounters retrieve vital signs, laboratory results, and other clinical measurements useful for monitoring a patient's health status and analyzing trends in their clinical data to access this clinical data you'll need the patient identifier, obtainable through the retrieve patient docid 8opknnbmtaz47rk5hkdd3 interaction interaction retrieving the list of observations can be done by sending a get request the request is sent to the observation endpoint https //api \<region> founda com/1/organizations/\<org x>/fhir/4/observation?\<parameters> where \<region> should be defined according to the different founda sandbox testing 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 observations the full observation resource can be retrieved with the identifier of the selected observation 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 ihe qedm profile to indicate that the request and response should comply with pcc 44, the profile parameter should be included to the search set /observation? 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 fhir observation resource, can be used as well parameters combination type required description patient + category reference + token the patient to search data for + the category name of the resource patient + category + code reference + token + token the patient to search data for + the category name of the resource + the code of the resource patient + category + date reference + token + date the patient to search data for + the category name of the resource + the date of creation of the resource patient + category + code + date reference + token + token + date the patient to search data for + the category name of the resource + the code of the resource + 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/observation?patient=2078\&category=survey& profile=https%3a%2f%2fprofiles ihe net%2fiti%2fqedm%2f' \\ \ header 'authorization bearer ory at gvkkad 68mkpycwat ps92ckkhcudsmdbmp4o29reyc kislrcpazgwtdp5q nuoa3w1lyrf514q59qquop3eeu'{ "resourcetype" "bundle", "id" "99acf5b8 4b54 4a60 ad4e 0e110e27642a", "meta" { "lastupdated" "2023 11 14t08 34 31 814+00 00" }, "type" "searchset", "total" 1, "link" \[ { "relation" "self", "url" "https //api eu founda com/1/health/organizations/org 4c5739ba994d4ce9b5255d3f84a2d367/fhir/4/observation?patient=2078\&category=survey& profile=https //profiles ihe net/iti/qedm/" } ], "entry" \[ { "fullurl" "https //api eu founda com/1/health/organizations/org 4c5739ba994d4ce9b5255d3f84a2d367/fhir/4/observation/2139", "resource" { "resourcetype" "observation", "id" "2139", "meta" { "versionid" "3", "lastupdated" "2023 10 17t09 32 17 906+00 00", "source" "#8243b825a7656e55", "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\\">\<p>\<b>generated narrative with details\</b>\</p>\<p>\<b>id\</b> 1minute apgar score\</p>\<p>\<b>contained\</b> \</p>\<p>\<b>status\</b> final\</p>\<p>\<b>category\</b> survey \<span>(details {http //terminology hl7 org/codesystem/observation category code 'survey' = 'survey', given as 'survey'})\</span>\</p>\<p>\<b>code\</b> 1 minute apgar score \<span>(details {loinc code '9272 6' = '1 minute apgar score', given as '1 minute apgar score'}; {snomed ct code '169895004' = 'apgar at 1 minute', given as 'apgar at 1 minute'})\</span>\</p>\<p>\<b>subject\</b> id newborn; 12345; active; peter james chalmers ; gender male; birthdate 18/05/2016\</p>\<p>\<b>effective\</b> 18/05/2016 10 33 22 pm\</p>\<p>\<b>performer\</b> \<a>practitioner/example\</a>\</p>\<p>\<b>value\</b> 0 {score}\<span> (details ucum code {score} = '{score}')\</span>\</p>\<blockquote>\<p>\<b>component\</b>\</p>\<p>\<b>code\</b> apgar color score \<span>(details {loinc code '32406 1' = '1 minute apgar color', given as '1 minute apgar color'}; {snomed ct code '249227004' = 'apgar color score', given as 'apgar color score'})\</span>\</p>\<p>\<b>value\</b> 0 the baby's whole body is completely bluish gray or pale \<span>(details {loinc code 'la6722 8' = 'the baby's whole body is completely bluish gray or pale', given as 'the baby's whole body is completely bluish gray or pale'}; {http //acme ped/apgarcolor code '0' = '0)\</span>\</p>\</blockquote>\<blockquote>\<p>\<b>component\</b>\</p>\<p>\<b>code\</b> apgar respiratory effort score \<span>(details {loinc code '32407 9' = '1 minute apgar heart rate', given as '1 minute apgar heart rate'}; {snomed ct code '249223000' = 'apgar heart rate score', given as 'apgar heart rate score'})\</span>\</p>\<p>\<b>value\</b> 0 no heart rate \<span>(details {loinc code 'la6716 0' = 'no heart rate', given as 'no heart rate'}; {http //acme ped/apgarheartrate code '0' = '0)\</span>\</p>\</blockquote>\<blockquote>\<p>\<b>component\</b>\</p>\<p>\<b>code\</b> apgar response to stimulus score \<span>(details {loinc code '32409 5' = '1 minute apgar reflex irritability', given as '1 minute apgar reflex irritability'}; {snomed ct code '249226008' = 'apgar response to stimulus score', given as 'apgar response to stimulus score'})\</span>\</p>\<p>\<b>value\</b> 0 no response to airways being suctioned \<span>(details {loinc code 'la6719 4' = 'no response to airways being suctioned', given as 'no response to airways being suctioned'}; {http //acme ped/apgarreflexirritability code '0' = '0)\</span>\</p>\</blockquote>\<blockquote>\<p>\<b>component\</b>\</p>\<p>\<b>code\</b> apgar muscle tone score \<span>(details {loinc code '32408 7' = '1 minute apgar muscle tone', given as '1 minute apgar muscle tone'}; {snomed ct code '249225007' = 'apgar muscle tone score', given as 'apgar muscle tone score'})\</span>\</p>\<p>\<b>value\</b> 0 limp; no movement \<span>(details {loinc code 'la6713 7' = 'limp; no movement', given as 'limp; no movement'}; {http //acme ped/apgarmuscletone code '0' = '0)\</span>\</p>\</blockquote>\<blockquote>\<p>\<b>component\</b>\</p>\<p>\<b>code\</b> apgar respiratory effort score \<span>(details {loinc code '32410 3' = '1 minute apgar respiratory effort', given as '1 minute apgar respiratory effort'}; {snomed ct code '249224006' = 'apgar respiratory effort score', given as 'apgar respiratory effort score'})\</span>\</p>\<p>\<b>value\</b> 0 not breathing \<span>(details {loinc code 'la6725 1' = 'not breathing', given as 'not breathing'}; {http //acme ped/apgarrespiratoryeffort code '0' = '0)\</span>\</p>\</blockquote>\</div>" }, "status" "final", "category" \[ { "coding" \[ { "system" "http //terminology hl7 org/codesystem/observation category", "code" "survey", "display" "survey" } ], "text" "survey" } ], "code" { "coding" \[ { "system" "http //loinc org", "code" "9272 6", "display" "1 minute apgar score" }, { "system" "http //snomed info/sct", "code" "169895004", "display" "apgar at 1 minute" } ], "text" "1 minute apgar score" }, "subject" { "reference" "patient/2078" }, "effectivedatetime" "2016 05 18t22 33 22z", "performer" \[ { "reference" "practitioner/2079" } ], "valuequantity" { "value" 0, "system" "http //unitsofmeasure org", "code" "{score}" }, "component" \[ { "code" { "coding" \[ { "system" "http //loinc org", "code" "32406 1", "display" "1 minute apgar color" }, { "system" "http //snomed info/sct", "code" "249227004", "display" "apgar color score" } ], "text" "apgar color score" }, "valuecodeableconcept" { "coding" \[ { "extension" \[ { "url" "http //hl7 org/fhir/structuredefinition/ordinalvalue", "valuedecimal" 0 } ], "system" "http //loinc org", "code" "la6722 8", "display" "the baby's whole body is completely bluish gray or pale" }, { "system" "http //acme ped/apgarcolor", "code" "0" } ], "text" "0 the baby's whole body is completely bluish gray or pale" } }, { "code" { "coding" \[ { "system" "http //loinc org", "code" "32407 9", "display" "1 minute apgar heart rate" }, { "system" "http //snomed info/sct", "code" "249223000", "display" "apgar heart rate score" } ], "text" "apgar respiratory effort score" }, "valuecodeableconcept" { "coding" \[ { "extension" \[ { "url" "http //hl7 org/fhir/structuredefinition/ordinalvalue", "valuedecimal" 0 } ], "system" "http //loinc org", "code" "la6716 0", "display" "no heart rate" }, { "system" "http //acme ped/apgarheartrate", "code" "0" } ], "text" "0 no heart rate" } }, { "code" { "coding" \[ { "system" "http //loinc org", "code" "32409 5", "display" "1 minute apgar reflex irritability" }, { "system" "http //snomed info/sct", "code" "249226008", "display" "apgar response to stimulus score" } ], "text" "apgar response to stimulus score" }, "valuecodeableconcept" { "coding" \[ { "extension" \[ { "url" "http //hl7 org/fhir/structuredefinition/ordinalvalue", "valuedecimal" 0 } ], "system" "http //loinc org", "code" "la6719 4", "display" "no response to airways being suctioned" }, { "system" "http //acme ped/apgarreflexirritability", "code" "0" } ], "text" "0 no response to airways being suctioned" } }, { "code" { "coding" \[ { "system" "http //loinc org", "code" "32408 7", "display" "1 minute apgar muscle tone" }, { "system" "http //snomed info/sct", "code" "249225007", "display" "apgar muscle tone score" } ], "text" "apgar muscle tone score" }, "valuecodeableconcept" { "coding" \[ { "extension" \[ { "url" "http //hl7 org/fhir/structuredefinition/ordinalvalue", "valuedecimal" 0 } ], "system" "http //loinc org", "code" "la6713 7", "display" "limp; no movement" }, { "system" "http //acme ped/apgarmuscletone", "code" "0" } ], "text" "0 limp; no movement" } }, { "code" { "coding" \[ { "system" "http //loinc org", "code" "32410 3", "display" "1 minute apgar respiratory effort" }, { "system" "http //snomed info/sct", "code" "249224006", "display" "apgar respiratory effort score" } ], "text" "apgar respiratory effort score" }, "valuecodeableconcept" { "coding" \[ { "extension" \[ { "url" "http //hl7 org/fhir/structuredefinition/ordinalvalue", "valuedecimal" 0 } ], "system" "http //loinc org", "code" "la6725 1", "display" "not breathing" }, { "system" "http //acme ped/apgarrespiratoryeffort", "code" "0" } ], "text" "0 not breathing" } } ] }, "search" { "mode" "match" } } ] }