haau3 FHIR Implementation Guide (HFIG)
0.1.0 - ci-build
haau3 FHIR Implementation Guide (HFIG)
0.1.0 - ci-build
haau3 FHIR Implementation Guide (HFIG), published by haau3. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/haau3/fhir-ig/ and changes regularly. See the Directory of published versions
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
These define constraints on FHIR resources for systems conforming to this implementation guide.
| CareTeam |
A group of individuals, both formal healthcare professionals and informal family and friends, that provide care for an individual patient. |
| Coverage |
Coverage information for haau3, primarily sourced from CARIN Blue Button / Blue Button APIs and payer feeds. Builds on US Core Coverage and is designed to stay aligned with Da Vinci use cases (e.g., payer-to-payer, member data sharing) over time. |
| Organization |
Organizations relevant to haau3, including payers, providers, and plan sponsors imported from Blue Button / payer APIs. |
| Patient |
A care recipient. |
| Patient Shared DocumentReference |
A DocumentReference representing a patient-shared health summary PDF. This profile is used within the SHL Bundle to represent the human-readable summary that a patient chooses to share. The document is embedded directly in the resource as a base64-encoded PDF. The Patient is both the subject of the document and one of the authors, reflecting patient-mediated sharing of health information. This profile aligns with the CMS Kill the Clipboard PatientSharedDocumentReference pattern and is intended to support portable, patient-directed exchange. |
| Person |
An individual who manages care for one or more patients, but can also manage their own care. |
| Practitioner |
An individual healthcare professional / practitioner that formally provides care for a patient. |
| Questionnaire |
A questionnaire or form |
| Questionnaire Response |
An individual's response to a questionnaire/form. |
| Related Person |
Individuals related to the patient like caregivers, family members, or guardians. |
| SHL Bundle |
A FHIR Bundle containing the patient summary, DocumentReference with the PDF, and optional FHIR resources a patient wants to share. This aligns with the CMS Kill The Clipboard Spec. |
These define new code systems used by systems conforming to this implementation guide.
| haau3 Enrichment Tags |
Tags indicating that haau3 has enriched or derived data based on external knowledge or processing. |
| haau3 Source System Codes |
Codes that indicate which source system a resource or data element originated from (e.g., Blue Button, Epic). |
These define identifier and/or code system identities used by systems conforming to this implementation guide.
| Clerk identifier for an haau3 user |
Stable Clerk user id for haau3 users. Used only on Person resources. |
| Epic patient MRN |
Epic MRN identifier namespace. |
| Epic patient identifier |
Patient identifiers assigned by Epic systems (MyChart, Epic FHIR). |
| haau3 coverage identifier |
Stable haau3 coverage id used for normalized Coverage.identifier.system. Format: {payorCode}-{group}-{plan}-{subscriberId}. |
| haau3 patient identifier |
Stable haau3 patient id. Used on Patient.identifier only. |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
| Coverage: Medicare Part C |
Example CMS Medicare Advantage (Part C) coverage imported from Blue Button, normalized with a haau3 coverage identifier and tagged with source-system and enrichment metadata. |
| GOFSH-GENERATED-ID-0 | |
| Organization: Centers for Medicare & Medicaid Services |
Centers for Medicare & Medicaid Services (CMS) as the payer/administrator for Medicare fee-for-service. Seeded as a canonical payer organization in haau3. |
| Patient: Grandma Fung |
Example haau3 patient with required canonical identifier. |
| Questionnaire: Patient Demographics |
Example questionnaire for patient demographics |
| RelatedPerson: Brian Fung as a caregiver |
Example RelatedPerson representing Brian, caring for Grandma Fung as her grandchild. |
| haau3-shl-bundle |