FHIR Tooling Extensions IG
0.2.0 - Release 0.2.0 International flag

This page is part of the HL7 Tools Extension IG (v0.2.0: Releases - Informative) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Extension: ValueSet Expansion Parameter

Official URL: http://hl7.org/fhir/tools/StructureDefinition/valueset-expansion-parameter Version: 0.2.0
Active as of 2024-04-26 Maturity Level: 3 Computable Name: ValueSetExpansionParameter
Other Identifiers: OID:2.16.840.1.113883.4.642.40.1.42.42

A default parameter to use when expanding this value set. A client may also pass a parameter with the same parameter name; servers should either overwrite this default parameter, or add to the list of identically named parameters, depending on which parameter is named

Context of Use

This extension may be used on the following element(s):

  • Element ID ImplementationGuide.definition

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

Formal Views of Extension Content

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

This structure is derived from Extension

Summary

Complex Extension: A default parameter to use when expanding this value set. A client may also pass a parameter with the same parameter name; servers should either overwrite this default parameter, or add to the list of identically named parameters, depending on which parameter is named

  • name: code: An Extension
  • value: string: An Extension

Maturity: 3

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension valueset-expansion-parameter
... extension:name 1..1 Extension The name of the parameter. The list of valid names is defined by the server, based on the list defined in the FHIR specification
.... extension 0..0
.... url 1..1 uri "name"
.... value[x] 0..1 code Value of extension
... extension:value 1..1 Extension The value for the parameter
.... extension 0..0
.... url 1..1 uri "value"
.... value[x] 1..1 string Value of extension
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/valueset-expansion-parameter"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension valueset-expansion-parameter
... id 0..1 id Unique id for inter-element referencing
... Slices for extension 2..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... extension:name 1..1 Extension The name of the parameter. The list of valid names is defined by the server, based on the list defined in the FHIR specification
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "name"
.... value[x] 0..1 code Value of extension
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "value"
.... value[x] 1..1 string Value of extension
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/valueset-expansion-parameter"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: A default parameter to use when expanding this value set. A client may also pass a parameter with the same parameter name; servers should either overwrite this default parameter, or add to the list of identically named parameters, depending on which parameter is named

  • name: code: An Extension
  • value: string: An Extension

Maturity: 3

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension valueset-expansion-parameter
... extension:name 1..1 Extension The name of the parameter. The list of valid names is defined by the server, based on the list defined in the FHIR specification
.... extension 0..0
.... url 1..1 uri "name"
.... value[x] 0..1 code Value of extension
... extension:value 1..1 Extension The value for the parameter
.... extension 0..0
.... url 1..1 uri "value"
.... value[x] 1..1 string Value of extension
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/valueset-expansion-parameter"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension valueset-expansion-parameter
... id 0..1 id Unique id for inter-element referencing
... Slices for extension 2..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... extension:name 1..1 Extension The name of the parameter. The list of valid names is defined by the server, based on the list defined in the FHIR specification
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "name"
.... value[x] 0..1 code Value of extension
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "value"
.... value[x] 1..1 string Value of extension
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/valueset-expansion-parameter"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()