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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: 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)

Usage:

• Examples for this Resource Profile: Parameters/MakeCoffee

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Parameters

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	Parameters	Operation Request or Response
Slices for parameter		2..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name
parameter:device	S	0..1	BackboneElement	Operation Parameter
name		1..1	string	Machine to make the beverage Fixed Value: device
value[x]	S	0..1	Reference(Device)	If parameter is a data type
parameter:beverageType	S	1..1	BackboneElement	Operation Parameter
name		1..1	string	Beverage to be made Fixed Value: beverageType
value[x]	S	1..1	code	If parameter is a data type Binding: Hot Beverages Value Set (example)
parameter:milkType	S	0..1	BackboneElement	Operation Parameter
name		1..1	string	Milk to be included Fixed Value: milkType
value[x]	S	0..1	code	If parameter is a data type Binding: Milk Additive Value Set (example)
parameter:syrupType	S	0..*	BackboneElement	Operation Parameter
name		1..1	string	Syrup to be included Fixed Value: syrupType
value[x]	S	0..1	code	If parameter is a data type Binding: Syrup Additive Value Set (example)
parameter:alcoholType	S	0..*	BackboneElement	Operation Parameter
name		1..1	string	Alcohol to be included Fixed Value: alcoholType
value[x]	S	0..1	code	If parameter is a data type Binding: Alcohol Additive Value Set (example)
parameter:sweetenerType	S	0..*	BackboneElement	Operation Parameter
name		1..1	string	Sweetener to be included Fixed Value: sweetenerType
value[x]	S	0..1	code	If parameter is a data type Binding: Sweeteners Additive Value Set (example)
parameter:spiceType	S	0..*	BackboneElement	Operation Parameter
name		1..1	string	Spice to be included Fixed Value: spiceType
value[x]	S	0..1	code	If parameter is a data type Binding: Spice Additive Value Set (example)
parameter:drinkSize	S	1..1	BackboneElement	Operation Parameter
name		1..1	string	Size of Drink requested Fixed Value: drinkSize
value[x]	S	1..1	code	If parameter is a data type Binding: Size of Beverage to be Consumed (example)
parameter:decaffeinated	S	0..1	BackboneElement	Operation Parameter
name		1..1	string	Is Coffee to be decaffeinated Fixed Value: decaffeinated
value[x]	S	1..1	code	If parameter is a data type Binding: Decaf is for the weak (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Parameters.parameter:beverageType.value[x]	example	HBBeverageVS (a valid code from Hot Beverage List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBBeverageVS from this IG
Parameters.parameter:milkType.value[x]	example	HBMilkVS (a valid code from Milks List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBMilkVS from this IG
Parameters.parameter:syrupType.value[x]	example	HBSyrupVS (a valid code from Syrups List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBSyrupVS from this IG
Parameters.parameter:alcoholType.value[x]	example	HBAlcoholVS (a valid code from Alcohol List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBAlcoholVS from this IG
Parameters.parameter:sweetenerType.value[x]	example	HBSweetenersVS (a valid code from Sweeteners List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBSweetenersVS from this IG
Parameters.parameter:spiceType.value[x]	example	HBSpiceVS (a valid code from Spice List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBSpiceVS from this IG
Parameters.parameter:drinkSize.value[x]	example	HBDrinkSizeVS (a valid code from Drink Size) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBDrinkSizeVS from this IG
Parameters.parameter:decaffeinated.value[x]	required	NoDecaf http://fhir.org/guides/acme/HotBeverage/ValueSet/NoDecaf from this IG

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	Parameters	Operation Request or Response
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for parameter	ΣC	2..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name inv-1: A parameter must have one and only one of (value, resource, part)
parameter:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition
parameter:device	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Machine to make the beverage Fixed Value: device
value[x]	SΣC	0..1	Reference(Device)	If parameter is a data type
parameter:beverageType	SΣC	1..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Beverage to be made Fixed Value: beverageType
value[x]	SΣC	1..1	code	If parameter is a data type Binding: Hot Beverages Value Set (example)
parameter:milkType	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Milk to be included Fixed Value: milkType
value[x]	SΣC	0..1	code	If parameter is a data type Binding: Milk Additive Value Set (example)
parameter:syrupType	SΣC	0..*	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Syrup to be included Fixed Value: syrupType
value[x]	SΣC	0..1	code	If parameter is a data type Binding: Syrup Additive Value Set (example)
parameter:alcoholType	SΣC	0..*	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Alcohol to be included Fixed Value: alcoholType
value[x]	SΣC	0..1	code	If parameter is a data type Binding: Alcohol Additive Value Set (example)
parameter:sweetenerType	SΣC	0..*	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Sweetener to be included Fixed Value: sweetenerType
value[x]	SΣC	0..1	code	If parameter is a data type Binding: Sweeteners Additive Value Set (example)
parameter:spiceType	SΣC	0..*	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Spice to be included Fixed Value: spiceType
value[x]	SΣC	0..1	code	If parameter is a data type Binding: Spice Additive Value Set (example)
parameter:drinkSize	SΣC	1..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Size of Drink requested Fixed Value: drinkSize
value[x]	SΣC	1..1	code	If parameter is a data type Binding: Size of Beverage to be Consumed (example)
parameter:decaffeinated	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Is Coffee to be decaffeinated Fixed Value: decaffeinated
value[x]	SΣC	1..1	code	If parameter is a data type Binding: Decaf is for the weak (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Parameters.parameter:beverageType.value[x]	example	HBBeverageVS (a valid code from Hot Beverage List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBBeverageVS from this IG
Parameters.parameter:milkType.value[x]	example	HBMilkVS (a valid code from Milks List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBMilkVS from this IG
Parameters.parameter:syrupType.value[x]	example	HBSyrupVS (a valid code from Syrups List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBSyrupVS from this IG
Parameters.parameter:alcoholType.value[x]	example	HBAlcoholVS (a valid code from Alcohol List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBAlcoholVS from this IG
Parameters.parameter:sweetenerType.value[x]	example	HBSweetenersVS (a valid code from Sweeteners List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBSweetenersVS from this IG
Parameters.parameter:spiceType.value[x]	example	HBSpiceVS (a valid code from Spice List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBSpiceVS from this IG
Parameters.parameter:drinkSize.value[x]	example	HBDrinkSizeVS (a valid code from Drink Size) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBDrinkSizeVS from this IG
Parameters.parameter:decaffeinated.value[x]	required	NoDecaf http://fhir.org/guides/acme/HotBeverage/ValueSet/NoDecaf from this IG

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	Parameters	Operation Request or Response
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Slices for parameter	ΣC	2..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name inv-1: A parameter must have one and only one of (value, resource, part)
parameter:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition
value[x]	ΣC	0..1		If parameter is a data type
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:device	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Machine to make the beverage Fixed Value: device
value[x]	SΣC	0..1	Reference(Device)	If parameter is a data type
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:beverageType	SΣC	1..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Beverage to be made Fixed Value: beverageType
value[x]	SΣC	1..1	code	If parameter is a data type Binding: Hot Beverages Value Set (example)
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:milkType	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Milk to be included Fixed Value: milkType
value[x]	SΣC	0..1	code	If parameter is a data type Binding: Milk Additive Value Set (example)
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:syrupType	SΣC	0..*	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Syrup to be included Fixed Value: syrupType
value[x]	SΣC	0..1	code	If parameter is a data type Binding: Syrup Additive Value Set (example)
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:alcoholType	SΣC	0..*	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Alcohol to be included Fixed Value: alcoholType
value[x]	SΣC	0..1	code	If parameter is a data type Binding: Alcohol Additive Value Set (example)
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:sweetenerType	SΣC	0..*	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Sweetener to be included Fixed Value: sweetenerType
value[x]	SΣC	0..1	code	If parameter is a data type Binding: Sweeteners Additive Value Set (example)
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:spiceType	SΣC	0..*	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Spice to be included Fixed Value: spiceType
value[x]	SΣC	0..1	code	If parameter is a data type Binding: Spice Additive Value Set (example)
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:drinkSize	SΣC	1..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Size of Drink requested Fixed Value: drinkSize
value[x]	SΣC	1..1	code	If parameter is a data type Binding: Size of Beverage to be Consumed (example)
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:decaffeinated	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Is Coffee to be decaffeinated Fixed Value: decaffeinated
value[x]	SΣC	1..1	code	If parameter is a data type Binding: Decaf is for the weak (required)
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Parameters.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Parameters.parameter:beverageType.value[x]	example	HBBeverageVS (a valid code from Hot Beverage List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBBeverageVS from this IG
Parameters.parameter:milkType.value[x]	example	HBMilkVS (a valid code from Milks List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBMilkVS from this IG
Parameters.parameter:syrupType.value[x]	example	HBSyrupVS (a valid code from Syrups List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBSyrupVS from this IG
Parameters.parameter:alcoholType.value[x]	example	HBAlcoholVS (a valid code from Alcohol List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBAlcoholVS from this IG
Parameters.parameter:sweetenerType.value[x]	example	HBSweetenersVS (a valid code from Sweeteners List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBSweetenersVS from this IG
Parameters.parameter:spiceType.value[x]	example	HBSpiceVS (a valid code from Spice List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBSpiceVS from this IG
Parameters.parameter:drinkSize.value[x]	example	HBDrinkSizeVS (a valid code from Drink Size) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBDrinkSizeVS from this IG
Parameters.parameter:decaffeinated.value[x]	required	NoDecaf http://fhir.org/guides/acme/HotBeverage/ValueSet/NoDecaf from this IG

This structure is derived from Parameters

Summary

Mandatory: 4 elements(1 nested mandatory element)
Must-Support: 18 elements
Fixed: 9 elements

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Parameters.parameter

Differential View

This structure is derived from Parameters

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	Parameters	Operation Request or Response
Slices for parameter		2..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name
parameter:device	S	0..1	BackboneElement	Operation Parameter
name		1..1	string	Machine to make the beverage Fixed Value: device
value[x]	S	0..1	Reference(Device)	If parameter is a data type
parameter:beverageType	S	1..1	BackboneElement	Operation Parameter
name		1..1	string	Beverage to be made Fixed Value: beverageType
value[x]	S	1..1	code	If parameter is a data type Binding: Hot Beverages Value Set (example)
parameter:milkType	S	0..1	BackboneElement	Operation Parameter
name		1..1	string	Milk to be included Fixed Value: milkType
value[x]	S	0..1	code	If parameter is a data type Binding: Milk Additive Value Set (example)
parameter:syrupType	S	0..*	BackboneElement	Operation Parameter
name		1..1	string	Syrup to be included Fixed Value: syrupType
value[x]	S	0..1	code	If parameter is a data type Binding: Syrup Additive Value Set (example)
parameter:alcoholType	S	0..*	BackboneElement	Operation Parameter
name		1..1	string	Alcohol to be included Fixed Value: alcoholType
value[x]	S	0..1	code	If parameter is a data type Binding: Alcohol Additive Value Set (example)
parameter:sweetenerType	S	0..*	BackboneElement	Operation Parameter
name		1..1	string	Sweetener to be included Fixed Value: sweetenerType
value[x]	S	0..1	code	If parameter is a data type Binding: Sweeteners Additive Value Set (example)
parameter:spiceType	S	0..*	BackboneElement	Operation Parameter
name		1..1	string	Spice to be included Fixed Value: spiceType
value[x]	S	0..1	code	If parameter is a data type Binding: Spice Additive Value Set (example)
parameter:drinkSize	S	1..1	BackboneElement	Operation Parameter
name		1..1	string	Size of Drink requested Fixed Value: drinkSize
value[x]	S	1..1	code	If parameter is a data type Binding: Size of Beverage to be Consumed (example)
parameter:decaffeinated	S	0..1	BackboneElement	Operation Parameter
name		1..1	string	Is Coffee to be decaffeinated Fixed Value: decaffeinated
value[x]	S	1..1	code	If parameter is a data type Binding: Decaf is for the weak (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Parameters.parameter:beverageType.value[x]	example	HBBeverageVS (a valid code from Hot Beverage List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBBeverageVS from this IG
Parameters.parameter:milkType.value[x]	example	HBMilkVS (a valid code from Milks List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBMilkVS from this IG
Parameters.parameter:syrupType.value[x]	example	HBSyrupVS (a valid code from Syrups List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBSyrupVS from this IG
Parameters.parameter:alcoholType.value[x]	example	HBAlcoholVS (a valid code from Alcohol List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBAlcoholVS from this IG
Parameters.parameter:sweetenerType.value[x]	example	HBSweetenersVS (a valid code from Sweeteners List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBSweetenersVS from this IG
Parameters.parameter:spiceType.value[x]	example	HBSpiceVS (a valid code from Spice List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBSpiceVS from this IG
Parameters.parameter:drinkSize.value[x]	example	HBDrinkSizeVS (a valid code from Drink Size) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBDrinkSizeVS from this IG
Parameters.parameter:decaffeinated.value[x]	required	NoDecaf http://fhir.org/guides/acme/HotBeverage/ValueSet/NoDecaf from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	Parameters	Operation Request or Response
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for parameter	ΣC	2..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name inv-1: A parameter must have one and only one of (value, resource, part)
parameter:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition
parameter:device	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Machine to make the beverage Fixed Value: device
value[x]	SΣC	0..1	Reference(Device)	If parameter is a data type
parameter:beverageType	SΣC	1..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Beverage to be made Fixed Value: beverageType
value[x]	SΣC	1..1	code	If parameter is a data type Binding: Hot Beverages Value Set (example)
parameter:milkType	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Milk to be included Fixed Value: milkType
value[x]	SΣC	0..1	code	If parameter is a data type Binding: Milk Additive Value Set (example)
parameter:syrupType	SΣC	0..*	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Syrup to be included Fixed Value: syrupType
value[x]	SΣC	0..1	code	If parameter is a data type Binding: Syrup Additive Value Set (example)
parameter:alcoholType	SΣC	0..*	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Alcohol to be included Fixed Value: alcoholType
value[x]	SΣC	0..1	code	If parameter is a data type Binding: Alcohol Additive Value Set (example)
parameter:sweetenerType	SΣC	0..*	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Sweetener to be included Fixed Value: sweetenerType
value[x]	SΣC	0..1	code	If parameter is a data type Binding: Sweeteners Additive Value Set (example)
parameter:spiceType	SΣC	0..*	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Spice to be included Fixed Value: spiceType
value[x]	SΣC	0..1	code	If parameter is a data type Binding: Spice Additive Value Set (example)
parameter:drinkSize	SΣC	1..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Size of Drink requested Fixed Value: drinkSize
value[x]	SΣC	1..1	code	If parameter is a data type Binding: Size of Beverage to be Consumed (example)
parameter:decaffeinated	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Is Coffee to be decaffeinated Fixed Value: decaffeinated
value[x]	SΣC	1..1	code	If parameter is a data type Binding: Decaf is for the weak (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Parameters.parameter:beverageType.value[x]	example	HBBeverageVS (a valid code from Hot Beverage List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBBeverageVS from this IG
Parameters.parameter:milkType.value[x]	example	HBMilkVS (a valid code from Milks List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBMilkVS from this IG
Parameters.parameter:syrupType.value[x]	example	HBSyrupVS (a valid code from Syrups List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBSyrupVS from this IG
Parameters.parameter:alcoholType.value[x]	example	HBAlcoholVS (a valid code from Alcohol List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBAlcoholVS from this IG
Parameters.parameter:sweetenerType.value[x]	example	HBSweetenersVS (a valid code from Sweeteners List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBSweetenersVS from this IG
Parameters.parameter:spiceType.value[x]	example	HBSpiceVS (a valid code from Spice List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBSpiceVS from this IG
Parameters.parameter:drinkSize.value[x]	example	HBDrinkSizeVS (a valid code from Drink Size) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBDrinkSizeVS from this IG
Parameters.parameter:decaffeinated.value[x]	required	NoDecaf http://fhir.org/guides/acme/HotBeverage/ValueSet/NoDecaf from this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	Parameters	Operation Request or Response
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Slices for parameter	ΣC	2..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name inv-1: A parameter must have one and only one of (value, resource, part)
parameter:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition
value[x]	ΣC	0..1		If parameter is a data type
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:device	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Machine to make the beverage Fixed Value: device
value[x]	SΣC	0..1	Reference(Device)	If parameter is a data type
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:beverageType	SΣC	1..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Beverage to be made Fixed Value: beverageType
value[x]	SΣC	1..1	code	If parameter is a data type Binding: Hot Beverages Value Set (example)
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:milkType	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Milk to be included Fixed Value: milkType
value[x]	SΣC	0..1	code	If parameter is a data type Binding: Milk Additive Value Set (example)
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:syrupType	SΣC	0..*	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Syrup to be included Fixed Value: syrupType
value[x]	SΣC	0..1	code	If parameter is a data type Binding: Syrup Additive Value Set (example)
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:alcoholType	SΣC	0..*	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Alcohol to be included Fixed Value: alcoholType
value[x]	SΣC	0..1	code	If parameter is a data type Binding: Alcohol Additive Value Set (example)
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:sweetenerType	SΣC	0..*	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Sweetener to be included Fixed Value: sweetenerType
value[x]	SΣC	0..1	code	If parameter is a data type Binding: Sweeteners Additive Value Set (example)
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:spiceType	SΣC	0..*	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Spice to be included Fixed Value: spiceType
value[x]	SΣC	0..1	code	If parameter is a data type Binding: Spice Additive Value Set (example)
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:drinkSize	SΣC	1..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Size of Drink requested Fixed Value: drinkSize
value[x]	SΣC	1..1	code	If parameter is a data type Binding: Size of Beverage to be Consumed (example)
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:decaffeinated	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Is Coffee to be decaffeinated Fixed Value: decaffeinated
value[x]	SΣC	1..1	code	If parameter is a data type Binding: Decaf is for the weak (required)
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Parameters.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Parameters.parameter:beverageType.value[x]	example	HBBeverageVS (a valid code from Hot Beverage List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBBeverageVS from this IG
Parameters.parameter:milkType.value[x]	example	HBMilkVS (a valid code from Milks List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBMilkVS from this IG
Parameters.parameter:syrupType.value[x]	example	HBSyrupVS (a valid code from Syrups List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBSyrupVS from this IG
Parameters.parameter:alcoholType.value[x]	example	HBAlcoholVS (a valid code from Alcohol List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBAlcoholVS from this IG
Parameters.parameter:sweetenerType.value[x]	example	HBSweetenersVS (a valid code from Sweeteners List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBSweetenersVS from this IG
Parameters.parameter:spiceType.value[x]	example	HBSpiceVS (a valid code from Spice List) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBSpiceVS from this IG
Parameters.parameter:drinkSize.value[x]	example	HBDrinkSizeVS (a valid code from Drink Size) http://fhir.org/guides/acme/HotBeverage/ValueSet/HBDrinkSizeVS from this IG
Parameters.parameter:decaffeinated.value[x]	required	NoDecaf http://fhir.org/guides/acme/HotBeverage/ValueSet/NoDecaf from this IG

This structure is derived from Parameters

Summary

Mandatory: 4 elements(1 nested mandatory element)
Must-Support: 18 elements
Fixed: 9 elements

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Parameters.parameter

Other representations of profile: CSV, Excel, Schematron