haau3 FHIR Implementation Guide (HFIG)
1.0.0 - ci-build United States of America flag

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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

Check providers against a plan's network

For each NPI, whether the CMS National Provider Directory lists the provider in a network this plan names, for the plan's year.

Counties of a state

Lists a state's counties, each with the FIPS code the coverage-area-county search takes.

Reconcile medications

Reconciles one patient's medication records into one clean medication list, returned as a collection of reconciled MedicationRequests with a Provenance for each.

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

InsurancePlan coverage area county

Plans sold in a US county.

InsurancePlan coverage area state

Plans sold in a US state.

InsurancePlan sold to

Plans a person can buy on their own, or plans sold only to employer and union groups.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

KTC Patient-Shared Bundle

The decrypted payload is a FHIR Bundle. This profile aligns with the KTC specification for a Patient Shared Bundle at https://ktc-spec.github.io/#fhir-bundle-profile-patientsharedbundle

KTC Patient-Shared DocumentReference

This profile aligns with https://ktc-spec.github.io/#documentreference-profile-patientshareddocumentreference that is part of the CMS Health Tech Ecosystem Kill the Clipboard use case.

Payor Organization

Example of a payor organization with a required type

haau3 AllergyIntolerance

An allergy or intolerance recorded about a care recipient. Where the source system supplied no code for the allergen, the delivered code restates the substance the record's own reaction detail names — or states the value is unknown when nothing on the record names it. Nothing is invented.

haau3 CarePlan

A plan of care recorded about a care recipient. The required assessment-and-plan category is present on every delivered record - added by haau3 when the source system did not state one, always keeping any category the source did state - and activities are described inline, commonly with an unknown status, exactly as the source stated them.

haau3 CareTeam

A care team a health system recorded about a care recipient. The people on the team and the role each one holds are the source system's own. Every delivered record carries the identifier naming the source record it came from. A participant may state that its member is unknown, when the source named a role but not who fills it, or named someone whose record was not delivered.

haau3 Communication

A record that information was communicated about a care recipient. Delivered exactly as it arrived, and current sources send very little: the records seen so far carry only a status and a subject, with no message content, sender, recipient or time. Treat the presence of a record as the fact, not as a message to read.

haau3 Composition

A clinical summary document delivered for a care recipient — a continuity-of-care document or a progress note, as the practice that produced it wrote it up. Every delivered record says who it is about, what kind of document it is, when it was written and by whom. Its sections state what they contain; the records they list are delivered as ordinary records of their own type, and a section lists only those haau3 holds.

haau3 Condition

A health problem recorded about a care recipient — a diagnosis, a concern, an item on a problem list. Every delivered record states which list it belongs to in a recognized vocabulary; anything the source system stated is always preserved alongside. Where no code for the problem could be read from the source, the record states the code is unknown rather than carrying an invented one.

haau3 Consent

A consent or advance directive as the source system recorded it. Delivered as it arrived: current sources state the consent category as unknown rather than naming one, and send no provision detail. Nothing here is derived by haau3.

haau3 Coverage

An insurance plan delivered for a care recipient. Every delivered record names the person it covers, says how they relate to the subscriber or states plainly that the relationship is unknown, and names a payer. Where a source system named more than one payer, the additional payers are delivered on the same record rather than dropped.

haau3 Diagnostic Report

A diagnostic report delivered about a care recipient — laboratory results, imaging, cardiology, pathology — grouping the individual results it is based on, or carrying the written report itself. Every delivered record says what kind of report it is, or states plainly that the kind is unknown; every delivered record names the person it belongs to.

haau3 DocumentReference

A clinical document or note about a care recipient. The document's content is delivered as an address naming a file held on the same server, and haau3 delivers that file with it; a document commonly carries several renderings of one note, one per attachment.

haau3 Encounter

A visit recorded about a care recipient, delivered exactly as the source system stated it: the visit class carries the source's own vocabulary rather than a translated one, the visit type may state that the value is unknown when the source never gave one, and the practitioners the source recorded on the visit are preserved.

haau3 Explanation of Benefit

An insurance claim delivered for a care recipient — what was billed against a plan and what the plan said about it. Every delivered record names the person it belongs to, the plan it was billed against, and the provider who billed it.

haau3 FamilyMemberHistory

A relative's health history as the source system recorded it — which relative, and what they were diagnosed with. Delivered exactly as it arrived: relationships are properly coded, conditions carry coded diagnoses, and no age or birth date for the relative is sent. Nothing here is derived by haau3.

haau3 Goal

A goal recorded about a care recipient, delivered as the source system stated it. The goal itself is commonly carried in the description's text rather than a code, and haau3 delivers both exactly as they arrived.

haau3 Immunization

A vaccination recorded about a care recipient. Delivered exactly as the source system stated it, including dose-protocol details; the occurrence may arrive as a date or as the source's own free-text form.

haau3 Insurance Plan (Plan Benefits)

What a Medicare Advantage or ACA Marketplace plan covers and what a member pays, from the files CMS publishes, as haau3's Plan Benefits API serves it on api.haau3.com. Every Plan Benefits InsurancePlan also conforms to the SBC InsurancePlan profile of the CARIN Digital Insurance Card guide, 2.0.0-ballot, and names both profiles in meta.profile.

haau3 Medication

A medication — the drug that prescriptions, statements and dispenses reference. Delivered exactly as the source system stated it: every vocabulary's coding is preserved, and a readable name is always present in the code's text even where individual codings carry no display.

haau3 MedicationAdministration

A dose of medication actually administered to a care recipient. Delivered exactly as the source system stated it; an organization-performed administration names a PractitionerRole carrying that organization, which is how R4 expresses the shape.

haau3 MedicationDispense

A pharmacy dispense recorded about a care recipient — a fill or refill handed over. Delivered exactly as the source system stated it, naming both the medication and the prescription it filled; hand-over time and quantity are present, preparation time and days-supply are not sent by current sources.

haau3 MedicationRequest

A prescription or medication order recorded about a care recipient. Delivered exactly as the source system stated it: the medication may be a reference to a delivered Medication or an inline code, the order date is frequently absent because the source never stated one, and the requester is most often an organization.

haau3 MedicationStatement

A medication a care recipient is or was taking, as the source system recorded it. Delivered exactly as it arrived: assertion dates are never sent by current sources, effective dates rarely, and dosage is predominantly the source's own free text. Read together with haau3 MedicationRequests when assembling a medication list.

haau3 Observation

Something measured or recorded about a care recipient — a lab result, a vital sign, a survey answer, an exam finding. Delivered records always state who they are about and what kind of record they are; where the kind could not be determined it is stated as unknown rather than invented. Categories the source system supplied are always preserved.

haau3 Organization

The organization for a care recipient.

haau3 Patient

A care recipient.

haau3 Patient Story Observation

A patient's self-reported answer to one of the three haau3 'My Story' prompts. Each Observation represents a single (patient, prompt) pair, identifiable by a stable haau3 namespace key for deterministic upsert via conditional update on Identifier. Mirrors PACIO ADI's ADI-CareExperiencePreference constraints; instances additionally claim PACIO conformance via meta.profile.

haau3 Practitioner

A practitioner involved in a care recipient's care. Conforms to US Core 6.1.0 Practitioner; NPI is the anchor for haau3 practitioner identity resolution.

haau3 Procedure

A procedure recorded about a care recipient, delivered exactly as the source system stated it: the procedure code may state that the value is unknown when the source never gave one, and the performed date is absent when the source never stated it.

haau3 Questionnaire

A questionnaire or form

haau3 QuestionnaireResponse

An individual's response to a questionnaire/form.

haau3 Reconciled Medication Additions Provenance

What haau3 added to one reconciled medication entry: data no source record stated, such as the RxNorm clinical drug coding, or the RxNorm name used as the entry's text when no source named the medication in words. Each target is the entry, narrowed to one added element by the targetElement extension (the element's id) or the targetPath extension (a simple FHIRPath). haau3 is the author, the activity is append, and the rule-set version and RxNorm release are those the entry was reconciled against. Present only when haau3 added something to the entry.

haau3 Reconciled Medication Bundle

The response of the reconcile-medications operation: a collection holding one reconciled MedicationRequest per clinical drug, one Provenance for each naming its source records, a second Provenance for each entry haau3 added data to, and an OperationOutcome only when a source record was skipped or the records named more than one patient. Entries are identified by urn:uuid, every reconciled MedicationRequest and Provenance names its haau3 profile in meta.profile, and the collection holds no Medication or List resources. A collection with no entries is a valid answer.

haau3 Reconciled Medication Provenance

Where one reconciled medication entry came from: the source records it was built from, haau3 as the software that assembled it, when it was produced and the date it was evaluated as of, and the rule-set version and RxNorm release it was reconciled against. What haau3 added to the entry, if anything, is named by a second Provenance, a haau3 Reconciled Medication Additions Provenance.

haau3 Reconciled MedicationRequest

One entry in a reconciled medication list: one clinical drug (its ingredients, strengths and dose form) for one patient, computed by software from that patient's medication records rather than curated by a person. Two strengths of the same medication are two entries. Every coding a source stated is kept, the RxNorm clinical-drug coding is added and marked when no source carried it, and any evidence codes it carries say why it has its status. The source records behind the entry are named in its Provenance, and anything haau3 added to it in a second, additions Provenance.

haau3 RelatedPerson

Individuals related to the patient like caregivers, family members, or guardians. Records created by haau3 carry no source identifier; records delivered from a source system carry the identifier naming the record they came from. The active flag may state that the value is unknown, since source systems do not send it.

haau3 ServiceRequest

An order or referral recorded about a care recipient, delivered exactly as the source system stated it: the timing may be a date, a period, a schedule, or absent, and the order code may state that the value is unknown when the source never gave one.

haau3 Specimen

A sample collected from a care recipient that a test was performed on. Where the source system did not state what kind of sample it was, the record says the value is unknown rather than carrying an invented one.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

MedList Added Coding

Marks a coding that haau3 added to a reconciled medication entry. Every coding without this mark came from a source record, exactly as the source stated it. The value names the kind of coding that was added.

MedList Evidence

A signal found in a patient's medication records that bears on one reconciled medication entry: why the entry has its status, or how its medication was coded. An entry carries the signals that apply as repeating extensions, and never a numeric confidence score. The codes and what each one means are in the MedList Evidence code system.

MedList Rule-set Version

The version of the rules haau3 used to reconcile this entry, in the form YYYY-MM-DD.vN. The same source records, reconciled as of the same date under the same rule-set version and the same RxNorm release, give the same entry. A different version means the rules changed.

MedList RxNorm Release

The RxNorm release this entry was reconciled against, as the haau3 terminology service names it in the version it reports for RxNorm (for example 09082026). Any RxNorm coding haau3 added to the entry comes from this release.

Plan Benefits Additional Benefit

A service CMS's files price that has no code in the SBC benefit categories, such as lab tests, home health care, hospital observation and a visit to a nurse or physician assistant, with its costs. Its parts mirror plan.specificCost.benefit and its cost, so the service reads like any other. The SBC benefit categories bind plan.specificCost as required, so these services cannot appear there; haau3 publishes this extension until the SBC guide codes them.

Plan Benefits Cost Range

The lowest and the highest of a cost the plan files as a range, as Medicare Advantage plans file every copay and coinsurance. The cost's value carries the highest with the comparator <=. Present only when the lowest and the highest differ. The SBC profile allows one value per cost; haau3 publishes this extension until the SBC guide carries a range.

Plan Benefits Cost Scope

Which network a deductible or out-of-pocket maximum belongs to, whom it covers (one member, each person in a family, or the whole family) and what it applies to (medical care, drugs, or both). generalCost.type says whether it is a deductible or a maximum, in the SBC guide's words. The SBC profile writes these as text only; haau3 publishes this extension until the SBC guide codes them.

Plan Benefits Day Range

The days of a stay a per-day cost covers, as Medicare Advantage plans file hospital and skilled nursing costs by day range ($550 a day for days 1 to 5, then $0 a day for days 6 to 90). The cost carries the per-day qualifier. The SBC profile has no element for days; haau3 publishes this extension until the SBC guide does.

Plan Benefits Medicare-Defined Amount

A Medicare Advantage plan files this amount as Original Medicare's own, with no number of its own: a deductible, or hospital or skilled nursing cost sharing. The part says which. Where haau3 holds Original Medicare's published amounts, they come with the year they belong to and their source. If that year is not the plan's year (CMS publishes each year's amounts in mid-November of the year before), the cost's value carries a data-absent reason and the amounts here are the latest published, which may change. The SBC profile has no way to say an amount is Medicare's; haau3 publishes this extension until the SBC guide does.

Plan Benefits Plan Facts

Facts about a Plan Benefits plan that CMS's files state and InsurancePlan has no element for: the facts each program files about its plans. Each part is present only where it applies to the plan's program, which InsurancePlan.type names. The SBC guide has no elements for these; haau3 publishes this extension until it does.

Plan Benefits Source Release

The CMS release a Plan Benefits plan was read from: the release's name, and for each of CMS's files in it, the address CMS publishes it at, the date CMS last changed it and its SHA-256, so anyone can fetch the same file and check it. The SBC guide has no element for the source of a plan's data; haau3 publishes this extension until it does.

Plan Benefits Source Text

The cell of CMS's Marketplace file that a cost, deductible or maximum was read from, exactly as the file writes it ("$850.00 Copay per Stay after deductible", "$4000 per group", "Not Applicable"). The amount beside it is haau3's reading of this text. The SBC profile has no element for source text; haau3 publishes this extension until the SBC guide does.

Self-reported Communication

A language the person communicates in, and whether it is the one they prefer, as the person states it or as a caregiver states it on their behalf. It has the same shape as communication and is kept apart from it: communication carries what source systems said about the person, and this extension carries what the person says. A record carries one instance per language, and preferred appears on at most one of them.

Shared Medications

What "Medications" carries when this person's records are shared through haau3: haau3's reconciled medication list or the medication records as received. Absent, the reconciled list. The person or their caregiver chooses it in haau3, and a shared bundle never carries it.

Unaligned primitive extension

The id and extensions a source sent for one entry of a repeating primitive (such as HumanName.given or Address.line) without saying which entry they belong to, because the source's list of values and its list of extensions had different lengths. Kept on the element that holds the list, with the position the source sent it at, instead of being attached to a value by guess. The source's own extensions are nested inside unchanged, under their own URLs. A record carries one instance per such entry.

haau3 Additional Payor

A payer named by the source system beyond the first. US Core allows a Coverage to name one payer; where a source named several, the first is delivered in Coverage.payor and every other is delivered here, exactly as the source expressed it, so that no payer the source named is lost.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

CMS Marketplace Benefit Name

Every CMS Marketplace benefit name this guide hosts.

CMS PBP Service Category

Every CMS PBP service category this guide hosts.

KTC Patient-Shared Document Type ValueSet

ValueSet for DocumentReference.type for patient-shared documents in the KTC use

MedList Added Coding Kind

Every kind of coding haau3 adds to a reconciled medication entry.

MedList Evidence

Every MedList evidence code, for the evidence extension on a reconciled medication entry.

MedList Reconciled Intent

The intents a reconciled medication entry can carry, as US Core's medication list guidance uses them: order when an order backs the entry, and plan when the entry rests only on reported use.

MedList Reconciled Status

The statuses a reconciled medication entry can carry: a subset of FHIR's MedicationRequest status. An entry is never draft or entered-in-error.

Payor Identifier Types ValueSet

Value set for payor identifier types.

Plan Benefits Cost Qualifier

Every Plan Benefits cost qualifier.

Plan Benefits Cost Scope: Applies To

What a deductible or out-of-pocket maximum applies to.

Plan Benefits Cost Scope: Member

Whom a deductible or out-of-pocket maximum covers: HL7's individual and family (the whole family), and haau3's family-per-person.

Plan Benefits Cost Scope: Network

Which network a deductible or out-of-pocket maximum belongs to: HL7's in and out (in is the first tier for a plan with two in-network tiers), and haau3's codes for the rest.

Plan Benefits Cost Type

Every Plan Benefits cost type: HL7's benefit-type codes for a copay, a coinsurance (copay-percent) and a per-service deductible, and haau3's for the rest.

Plan Benefits General Cost Type

Every Plan Benefits general cost type.

Plan Benefits Medicare Amount

The Original Medicare amounts haau3 supplies for a Medicare-defined amount.

Plan Benefits Medicare Part

The parts of Original Medicare a Medicare-defined amount refers to.

Plan Benefits Metal Level

The Marketplace metal levels: HL7's platinum, gold, silver, bronze and catastrophic, and haau3's expanded-bronze.

Plan Benefits Network Status

The status codes of the $in-network operation on InsurancePlan.

Plan Benefits No Network Data Reason

The reason codes of the $in-network operation on InsurancePlan.

RxNorm Current Prescribable Content

The RxNorm concepts in one NLM Current Prescribable Content release, which the version names. NLM describes that release as holding active RxNorm normalized names, codes (RxCUIs), attributes and relationships, and as excluding suppressed and obsolete data, drugs that are exclusively non-US or foreign, and drugs for exclusive veterinary use. Membership is therefore a statement about a dated release rather than about RxNorm as a whole: a code absent from this value set may still be a valid RxNorm code outside that release.

Shared Medications Mode

Both things "Medications" can carry in a share.

haau3 Derived By

Every haau3 software that computes records from other records.

haau3 Patient Story Question Codes

The three LOINC codes corresponding to the MVP haau3 'My Story' questions. Strict subset of the PACIO Care Experience Preferences Grouping value set (http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1115.11).

haau3 Questionnaires ValueSet

LOINC panel codes for the questionnaires haau3 can administer.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

CMS Marketplace Benefit Name

The benefit names (BenefitName) of CMS's 2026 Health Insurance Exchange Benefits and Cost Sharing public use file for the services Plan Benefits serves. Each code is the name exactly as the file writes it. An ACA Marketplace benefit in Plan Benefits carries one of these beside its SBC benefit category, as the fixed reference to CMS's file. CMS publishes no code system for them; haau3 hosts them, verbatim, until CMS or the SBC guide does.

CMS PBP Service Category

The Medicare-covered service categories of CMS's Plan Benefit Package (PBP) Benefits 2027 files, with their codes and labels as CMS's data dictionary gives them. A Medicare Advantage benefit in Plan Benefits carries one of these beside its SBC benefit category, as the fixed reference to CMS's files. CMS publishes no code system for them; haau3 hosts them, verbatim, until CMS or the SBC guide does. The supplemental categories are not yet included.

MedList Added Coding Kind

The kinds of coding haau3 adds to a reconciled medication entry, named by the MedList Added Coding extension on each added coding.

MedList Evidence

Signals haau3 records on a reconciled medication entry to say why the entry has its status and how its medication was coded. Each code names what was found in the patient's records and what it means for the entry. An entry carries every code that applies.

Payor Identifier Types CodeSystem

Code system for payor identifier types.

Plan Benefits Cost Qualifier

Facts that describe a Plan Benefits cost entry: which in-network tier it is, how it is charged, and how it relates to the deductible and the out-of-pocket maximum. haau3 publishes these until the SBC guide codes them.

Plan Benefits Cost Scope

The parts of a deductible's or out-of-pocket maximum's scope HL7's benefit-network and benefit-unit have no code for: the networks other than in and out, each person in a family, and what the amount applies to. haau3 publishes these until the SBC guide codes them.

Plan Benefits Cost Type

The kinds of Plan Benefits cost entry HL7's benefit-type has no code for: the per-visit cap on coinsurance, and, for an entry with no amount, why it has none. A copay, a coinsurance and a per-service deductible use HL7's benefit-type. haau3 publishes these until the SBC guide codes cost types.

Plan Benefits General Cost Type

Plan-level costs other than deductibles and out-of-pocket maximums. haau3 publishes these until the SBC guide codes them.

Plan Benefits Medicare

The parts of Original Medicare a Medicare Advantage plan's Medicare-defined amount refers to, and the Original Medicare amounts haau3 supplies for one. haau3 publishes these until the SBC guide codes them.

Plan Benefits Metal Level

The Marketplace metal level HL7's insuranceplan-plan-type has no code for. haau3 publishes this until HL7 codes it.

Plan Benefits Network Status

What the CMS National Provider Directory says about one provider and the networks of one plan, for the plan's year: the status codes of the $in-network operation on InsurancePlan. A directory listing is not a statement of a contract, which is why HL7's applicability codes, defined by a contract with the insurer, are not used.

Plan Benefits No Network Data Reason

Why the CMS National Provider Directory holds no network data for a plan in the plan's year: the reason codes of the $in-network operation on InsurancePlan.

Plan Benefits Sold To

Who can buy a Plan Benefits plan: the codes of the sold-to search on InsurancePlan.

Shared Medications Mode

What "Medications" carries when a person's records are shared through haau3: haau3's reconciled medication list, or the medication records as received. A share carries one or the other.

haau3 Derived By

The haau3 software that computed a record from other records, rather than receiving it from a source system. Carried in meta.tag on the computed record and on each of its Provenances.

Terminology: Naming Systems

These define identifier and/or code system identities used by systems conforming to this implementation guide.

CMS Medicare Advantage contract number

A Medicare Advantage contract number as CMS assigns it.

CMS Medicare Advantage plan ID

CMS's own identifier system for a Medicare Advantage plan.

CMS PBP bid_id

A Medicare Advantage plan's key in CMS's Plan Benefit Package files, as the files write it.

HIOS issuer ID

A Marketplace issuer's five-digit HIOS issuer ID.

HIOS plan ID

A Marketplace plan's 17-character HIOS plan ID, including its cost-sharing reduction variant.

HIOS standard component ID

A Marketplace plan's 14-character HIOS standard component ID, shared by all its variants.

haau3 patient identifier

Stable haau3 patient id. Used on Patient.identifier only.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

$in-network: a Marketplace plan

The answer for an ACA Marketplace plan: the directory holds no network data for it, so the reason says why and the plan's own provider directory is given. The NPI is illustrative.

$in-network: a Medicare Advantage plan with network data

The answer for a Medicare Advantage plan the directory holds for the plan's year: one network checked, and three providers, one listed in it, one the directory holds but the network does not list, and one the directory does not hold. The NPIs and the directory records are illustrative.

6-item Transportation Security Index

The 6-item Transportation Security Index is an abbreviated version of the 16-item Transportation Security Index. It captures the lived experiences of people experiencing transportation insecurity, and it has been validated using a nationally representative survey. The index can be used to assign respondents a continuous score representing their level of transportation insecurity or to categorize respondents as experiencing no insecurity or insecurity that is marginal, low, moderate, or high.

6-item Transportation Security Index Questionnaire Response

Example of a QuestionnaireResponse for the 6-item Transportation Security Index questionnaire (LOINC code 106423-7).

Commercial Insurance Coverage

Example haau3 Coverage instance representing a commercial insurance plan.

Example C4BB Commercial Organization

Example organization that conforms to C4BB Commercial Organization.

Example C4BB Medicaid HMO Organization

Example organization that conforms to C4BB Organization, representing a Medicaid HMO payer.

Example FHIR Rendered PDF

Example LOINC 60591-5 for a FHIR-rendered PDF.

Example Haau3 Patient

Example patient that conforms to Haau3 Patient.

Example Haau3 Practitioner

Example practitioner that conforms to Haau3 Practitioner (US Core 6.1.0 Practitioner) with additional fields to align with CMS National Provider Directory.

Example Haau3 RelatedPerson

Example caregiver that conforms to Haau3 RelatedPerson, with the relationship the haau3 app writes and the languages the caregiver states, beside the communication entries an older record carries.

Example Patient Story PDF

Example LOINC 51855-5 patient story PDF.

Example US Core AllergyIntolerance

Example patient-reported AllergyIntolerance demonstrating an additional clinical content entry in a Patient-Shared Bundle.

Example US Core Condition for Problems and Health Concerns

Example Condition demonstrating an additional clinical content entry alongside the patient-shared DocumentReferences.

Example US Core Immunization

Example patient-reported Immunization demonstrating an additional clinical content entry in a Patient-Shared Bundle.

Example US Core Lab

Example US Core Lab Result Observation — Hemoglobin A1c result of 7.1% for the example patient.

Example US Core MedicationRequest

Example patient-reported MedicationRequest demonstrating an additional clinical content entry in a Patient-Shared Bundle.

Example US Core Patient

Example patient that conforms to US Core 6.1.0 Patient.

Example US Core Vital Signs

Example US Core Vital Signs Observation — blood pressure panel 120/78 mmHg for the example patient.

ExamplePayorOrganization
KTC Patient-Shared Bundle example: haau3's reconciled medication list

Worked example of a patient-shared Bundle whose medications are haau3's reconciled medication list: one reconciled MedicationRequest, tagged derived-by medlist, and its Provenance, which carries haau3 as a contained Organization and names the record the entry was built from in words. The records as received are not in the bundle. Note: this rendered example shows meta.profile on its entries because IG tooling stamps it on examples; bundles haau3 issues do not carry meta.profile, and receivers must not require it.

KTC Patient-Shared Bundle example: medication records as received

Worked example of a patient-shared Bundle containing the patient subject, the two patient-shared PDFs, clinical content and one self-reported Patient Story observation. Its medications are the records as received: a MedicationRequest, a MedicationStatement and the Medication the statement names, so the reference resolves inside the bundle. Note: this rendered example shows meta.profile on its entries because IG tooling stamps it on examples; bundles haau3 issues do not carry meta.profile, and receivers must not require it.

MedList request: one patient's records from an order and two statements

A request to the reconcile-medications operation: a collection of one patient's medication records. A Janumet order, the patient's own statement that they take Janumet, their statement that they take lisinopril, and an order that names no medication, which the response reports as skipped. Every record is synthetic.

MedList request: the Parameters form, with asOf

A request to the reconcile-medications operation in the Parameters form: one resource part per medication record, and an asOf part that sets the date and time the list is evaluated as of. Every record is synthetic.

Medicaid HMO Insurance Coverage

Example haau3 Coverage instance representing a Medicaid HMO plan.

Patient Story — care experience preferences

Example haau3 Patient Story Observation answering 'Are there things that are important to you about how you receive care?'

Patient Story — preferred location for final days

Example haau3 Patient Story Observation answering 'If it were possible to choose, where would you like to spend your final days?'

Patient Story — religious or cultural beliefs

Example haau3 Patient Story Observation answering 'What do you want caregivers to know about your religious beliefs?'

Plan Benefits: ACA Marketplace plan 19898FL0340001-01

AvMed Entrust Gold 125 (2026), a 2026 ACA Marketplace plan with two in-network tiers, as Plan Benefits serves it: read from CMS's PY2026 Marketplace public use files, release aca-2026-2026-08-10.

Plan Benefits: Medicare Advantage plan H2406-013-000

UnitedHealthcare's AARP Medicare Advantage from UHC FL-0021 (PPO), a 2027 Medicare Advantage plan, as Plan Benefits serves it: read from CMS's PBP Benefits 2027 files, release ma-2027-2026-10-01.

eHealth Literacy Scale

The eHealth Literacy Scale (eHEALS) is an 8-item measure developed to measure consumers' combined knowledge, comfort, and perceived skills at finding, evaluating, and applying electronic health information to health problems. The objective of the study was to psychometrically evaluate the properties of the eHEALS within a population context.

eHealth Literacy Scale Questionnaire Response

Example of a QuestionnaireResponse for the eHealth Literacy Scale questionnaire (LOINC code 107619-9).

haau3 AllergyIntolerance — code restated from the reaction detail

An allergy whose source system supplied no code for the allergen. The delivered code restates the substance the record's own reaction detail names, with a tag recording the completion; the reaction detail is preserved unchanged.

haau3 CarePlan — a plan whose category haau3 supplied

An active plan of care carrying the required assessment-and-plan category, which the source system did not state, with its activity described inline and that activity's status stated as unknown.

haau3 CareTeam: a team as a health system sent it

An active care team a health system recorded about a care recipient, delivered as sent: it carries the identifier naming its source record, and its participant carries the role the source stated and the practitioner who fills it.

haau3 Communication — a record that says only that something was communicated

A completed communication about the care recipient, delivered exactly as it arrived: no content, sender, recipient or time accompanies it. Treat the record as the fact that a communication occurred rather than as a message to read.

haau3 Composition — a continuity-of-care document

A clinical summary document as it is commonly delivered: the practice that produced it, the clinician who attested to it, the span of care it covers, and its headings — with entries delivered only for the records haau3 also holds.

haau3 Condition — category completed in a recognized vocabulary

A health problem whose source system stated its kind only in its own vocabularies. The delivered record carries the recognized problem-list value ahead of the source's own codings, which are preserved unchanged, and a tag recording the completion.

haau3 Consent — an advance directive whose category the source left unknown

An active advance-directive consent delivered as it arrived. The category states that the kind of consent is unknown, which is what the source system sent rather than anything haau3 derived, and no provision detail accompanies it.

haau3 Coverage — a plan naming a second payer

An insurance plan as it is commonly delivered: a primary payer identified by a reference, a second payer the source named in words alone and which is carried on the record rather than dropped, and a relationship stated in the source system's own terms.

haau3 Diagnostic Report — a laboratory panel with its results

A laboratory report as it is commonly delivered: the kind stated in the source system's own terms, a period rather than a single time, no issued time, the individual results named as separate records, and the report itself carried inside the record for a person to read.

haau3 Diagnostic Report — the kind stated as unknown

A report whose source system did not say what kind of report it is. The delivered record states that the kind is unknown, in the standard shape for a value that is expected but not known, and carries a tag recording that the statement was supplied rather than sent.

haau3 DocumentReference — a note delivered in two renderings

A clinical note delivered as two renderings of one document, each naming a file held on the same server, with the custodian stated by name as the source sent it.

haau3 Encounter — a visit classed in the source's own vocabulary

An office visit whose class carries the CPT code the source system sent rather than a translated standard code, and whose status the source left as unknown. Delivered exactly as stated.

haau3 Explanation of Benefit — an outpatient claim

An insurance claim as it is commonly delivered: the source system's own CARIN profile left in place, the billing provider carried inside the claim, the payer named by an identifier, and the plan it was billed against named as a delivered record.

haau3 FamilyMemberHistory — a mother's history, with no age given

A completed family history for the care recipient's mother, carrying two coded conditions. Delivered as it arrived, with no age or birth date for the relative, because current sources send neither.

haau3 Goal — stated in text rather than a code

An active goal whose meaning the source system carried in the description's text, with a coding that states only that no code was available.

haau3 Immunization — dose-protocol detail preserved

A vaccination delivered exactly as the source stated it, including dose-protocol detail. The occurrence is the machine-usable date; the tag records that a duplicative source text form was set aside.

haau3 Medication — coded without display, named by text

A medication whose RxNorm coding arrived without display text, as most production codings do. The code's text carries the readable name a consumer can always rely on.

haau3 MedicationAdministration — a dose actually given

A completed medication administration: the drug by reference, the care recipient, and the administration time, exactly as the source stated them.

haau3 MedicationDispense — a refill naming its drug and its order

A completed pharmacy refill: hand-over time and quantity present, preparation time and days-supply absent as current sources send them, referencing both the delivered Medication and the delivered MedicationRequest it filled.

haau3 MedicationRequest — an order the source never dated

A completed medication order delivered without an authoredOn date, because the source system never stated one. The medication is a reference to a delivered haau3 Medication, as most production records' are; VA and eClinicalWorks records carry the inline code instead.

haau3 MedicationStatement — a statement of use the source never dated

An active medication-use statement delivered without an assertion date or effective dates, because the source system stated neither. The dosage is the source's own free text, delivered as it arrived.

haau3 Observation — kind not stated in a standard vocabulary

A measurement whose kind the source system stated only in its own private vocabulary. The record states that its standard kind is unknown rather than carrying an invented one, and the source's own category is preserved unchanged.

haau3 Procedure — code not stated by the source

A completed procedure where the source system never said what was done. The code states that the value is unknown rather than carrying an invented one; the performed date and the order it fulfilled are delivered as stated.

haau3 QuestionnaireResponse — social-history answers with no date given

An in-progress set of questionnaire answers delivered as they arrived. The authoring date states that it is unknown rather than carrying a value, because the source system sent none and haau3 invents nothing. The questionnaire it answers is named by a URL on the source system.

haau3 Reconciled Medication Additions Provenance: the Janumet entry's added coding

What haau3 added to the Janumet entry: the generic clinical-drug coding, from the RxNorm release named here, pointed at by the id the entry gives that coding. haau3 is the author, carried as a contained Organization.

haau3 Reconciled Medication Bundle: the response to the example request

The reconciled list for the example request: a Janumet entry built from an order and a statement, a lisinopril entry built from a statement alone, a Provenance for each, a second Provenance naming the coding haau3 added to the Janumet entry, and an OperationOutcome reporting the order that named no medication as skipped. Every record is synthetic.

haau3 Reconciled Medication Provenance in a shared bundle

Where the shared entry came from, as a shared bundle carries it: tagged derived-by medlist, haau3 as a contained Organization, and the source record named in words with its type, since the records as received do not travel with the reconciled list.

haau3 Reconciled Medication Provenance: a reported medication's one source

Where the lisinopril entry came from: the patient's statement. haau3 is the assembler, carried as a contained Organization.

haau3 Reconciled Medication Provenance: the Janumet entry's two sources

Where the Janumet entry came from: the order and the patient's statement. haau3 is the assembler, carried as a contained Organization.

haau3 Reconciled MedicationRequest in a shared bundle

A reconciled entry as a shared bundle carries it: tagged derived-by medlist, built from one undated statement of use that named no reporter, so its intent is plan and reportedBoolean is true. The statement already carried the RxNorm clinical drug, so haau3 added nothing.

haau3 Reconciled MedicationRequest: a branded order and a statement, one entry

A reconciled entry built from a Janumet order and the patient's own statement that they take it. The branded RxNorm coding both sources stated is kept, and the generic clinical-drug coding is added and marked because no source carried it; a second Provenance names that addition.

haau3 Reconciled MedicationRequest: a reported medication with no order

A reconciled entry built from the patient's own statement alone. Its intent is plan and it names the patient as the reporter and the requester, as US Core's medication list guidance asks for reported medications. The statement already carried the RxNorm clinical drug, so haau3 added no coding.

haau3 ServiceRequest — a dated referral order

An active referral order with the date the source stated and the order described in the source's own words.

haau3 Specimen — type not stated by the source

A sample a lab result was run on, where the source system did not say what kind of sample it was. The type states that the value is unknown rather than carrying an invented one.