haau3 FHIR Implementation Guide (HFIG)
1.0.0 - ci-build
haau3 FHIR Implementation Guide (HFIG) - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
One of the core use cases for Patient Facing Apps is Kill the Clipboard. It's aimed at eliminating manual check-in forms and fragmented data collection. In the April 2026 MVP, this requirement was defined using an initial KTC Patient-Shared Health Documents via SMART Health Links specification that largely conformed to sharing data that represented available USCDI data or a summary of elements specified by the International Patient Summary (IPS). As we're progressing towards the July 2026 milestone, discussions around additional requirements have surfaced that have been defined in the newer KTC Patient-Shared Health Documents via SMART Health Links Specification that includes the concept of a patient story (both PDF and discrete FHIR resources), but also some wording that describes an optional workflow for Ahead-of-Time Check-In. That optional workflow has led to discussions around strengthening the shared FHIR bundle to align more closely with the IPS specification and the usage of questionnaires to collect data.
This page is intended to convey the following:
This page intentionally does not address the following:
Questionnaires are ubiquitous in healthcare and are often organization and use-case specific. Some flavors of questionnaires include, but are not limited to:
To minimize restrictions, it'd be ideal to use questionnaires that have flexible terms and usage and avoiding any that do (e.g. PHQ-9, GAD-7, PROMIS-10)
Not necessarily a recommendation, but some examples of some that may be considered include two instruments that have been vetted by the Gravity Project that are described in the Social Risk Terminology Value Sets as many are readily accessible in LOINC and the NLM's LHC FHIR Tools. Two examples enumerated in this FHIR IG include:
A programmatic way that can be used to filter for candidates is to use the APIs from LOINC and NLM to determine if there are any copyright comments populated for a given standard questionnaire. Note This should NOT be considered a definitive answer, but rather a way to specifically filter on candidate questionnaires that could be considered.
Query a LOINC term for copyright-related properties:
GET https://fhir.loinc.org/CodeSystem/$lookup?system=http://loinc.org&code={LOINC_CODE}&property=EXTERNAL_COPYRIGHT_NOTICE&property=EXTERNAL_COPYRIGHT_LINK
Example:
GET https://fhir.loinc.org/CodeSystem/$lookup?system=http://loinc.org&code=69737-5&property=EXTERNAL_COPYRIGHT_NOTICE&property=EXTERNAL_COPYRIGHT_LINK
Expected response excerpt:
{
"name": "property",
"part": [
{
"name": "code",
"valueCode": "EXTERNAL_COPYRIGHT_NOTICE"
},
{
"name": "value",
"valueString": "Copyright © Pfizer Inc..."
}
]
}
Query the same copyright metadata using the NLM Clinical Tables API:
GET https://clinicaltables.nlm.nih.gov/api/loinc_items/v3/search?terms={LOINC_CODE}&sf=LOINC_NUM&df=LOINC_NUM,LONG_COMMON_NAME,isCopyrighted,containsCopyrighted&ef=EXTERNAL_COPYRIGHT_NOTICE,EXTERNAL_COPYRIGHT_LINK
Example:
GET https://clinicaltables.nlm.nih.gov/api/loinc_items/v3/search?terms=69737-5&sf=LOINC_NUM&df=LOINC_NUM,LONG_COMMON_NAME,isCopyrighted,containsCopyrighted&ef=EXTERNAL_COPYRIGHT_NOTICE,EXTERNAL_COPYRIGHT_LINK
Expected response excerpt:
{
"EXTERNAL_COPYRIGHT_NOTICE": [
"Copyright © Pfizer Inc..."
],
"EXTERNAL_COPYRIGHT_LINK": [
"Pfizer"
]
}
| Instrument | LOINC | isCopyrighted | Copyright Notice |
|---|---|---|---|
| TSI-6 | 106423-7 | false | None |
| eHEALS | 107619-9 | false | None |
| GAD-7 | 69737-5 | true | Pfizer notice |
| PHQ-9 | 44249-1 | true | Pfizer notice |
| PROMIS-10 Global Health | 85524-7 | true | PROMIS terms and conditions |