HotBeverage FHIR Implementation Guide
1.4.2024 - release International flag

HotBeverage FHIR Implementation Guide, published by Dave Pyke & John Moehrke. This guide is not an authorized publication; it is the continuous build for version 1.4.2024 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/DavidPyke/HotBeverage/ and changes regularly. See the Directory of published versions

Artifacts Summary

Contents:

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.

hbbrew

The brew operation sends the BrewedBeverage resource to the Coffee/Tea brewing Device
hbstop

The stop operation sends the Device a direction to stop the brew of the beverage (primarily tea) to check for doneness. Used in combination with the Start operation to make the tea just right
hbwhen

When coffee is poured, and milk is offered, it is necessary for the holder of the recipient of milk to say "when" at the time when sufficient milk has been introduced into the coffee. For this purpose, the "WHEN" operation has been added to FHIR.

Structures: Resource Profiles

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

The AuditEvent for a successful Brewed Hot Beverage

An AuditEvent profile for when request to brew a Hot Beverage action happens successfully.
The Hot Beverage to Brew

The parameters to be given to the device to make the requested Hot Beverage.

  • The Machine to make the beverage (optional)
  • The Beverage to be made (required)
  • The type of Milk to be included (optional)
  • The type of Syrup to be included (optional)
  • The type of Alcohol to be included (optional)
  • The type of Sweetener to be included (optional)
  • The type of Spice to be included (optional)
  • Is Coffee to be decaffeinated (shall be NoDecaf)

Terminology: Value Sets

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

Alcohol Additive Value Set

Alcohol liquids for use in coffee
Decaf is for the weak

No, Just No
Hot Beverages Value Set

All beverages allowed to be made via Hot Beverage
Milk Additive Value Set

Milk and milk-like liquids for use in coffee
Size of Beverage to be Consumed

You want how much?
Spice Additive Value Set

Spice liquids for use in coffee
Sweeteners Additive Value Set

Sweeteners liquids for use in coffee
Syrup Additive Value Set

Syrups for use in coffee

Terminology: Code Systems

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

Alcohol List

Alcohols to be added, if desired
Drink Size

How much did you want?
Hot Beverage List

Legal Beverages to be made in coffee pot
Milks List

Milks to be added, if desired
Spice List

Spice to be added, if desired
Sweeteners List

Sweeteners to be added, if desired
Syrups List

Syrups to be added, if desired

Terminology: Concept Maps

These define transformations to convert between codes by systems conforming with this implementation guide.

$tarBucks sizes vs HB Drink Sizes

map between commonly understood drink sizes and the formal drink size codes.

Example: Example Instances

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

Audit Example of a basic brew

Audit Example for a brewed coffee

  • Using the Nespresso VertuoNext device
  • Requesting Espresso
Make me Espresso

Request to make Espresso.

  • Using the Nespresso VertuoNext device
  • Requesting Espresso
Vertuo Next

Nespresso introduces the VERTUO NEXT CLASSIC, the latest VERTUO Nespresso coffee maker with an all-new design and colors for the ultimate brewing experience. In addition to its original espressos, NESPRESSO VERTUO NEXT produces an extraordinary cup of coffee with a smooth layer of crema, the signature of a truly great cup of coffee. The VERTUO coffee and espresso coffee machine conveniently makes 5, 8, 14, 18 oz Coffee and single and double Espresso. Nespresso brings together the know-how of all its coffee experts, who have carefully chosen the origin and roasting of each coffee blend and created a brewing system using Centrifusion technology, a patented extraction technology developed by Nespresso. Just insert a Vertuo capsule and close the lever — when activated, the capsule spins, blending ground coffee with water and extracting every drop of flavor. Its precision brewing system recognizes each capsule and automatically adjusts its brewing parameters to consistently deliver the best in cup result. Bundled with Nespresso's Aeroccino3, provides smooth hot or cold milk froth for your coffee recipes with one touch. It froths all types of milk in a few seconds, without noise or vibration. Each machine includes a complimentary welcome set with a range of Nespresso Vertuo capsules with unique aroma profiles. Order your Nespresso capsules, receive personalized advice, and obtain technical support or repair for your machine through the Nespresso Club via mobile app, by telephone or in one of our Boutiques. This coffee machine is compatible exclusively with Nespresso Vertuo Line pods. Input power (W): 1260. Intelligent extraction system recognizes each coffee blend.