FHIR Tooling Extensions IG
0.5.0 - Release 0.2.0 International flag

This page is part of the HL7 Tools Extension IG (v0.5.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 Parameter Declaration (Experimental)

Official URL: http://hl7.org/fhir/tools/StructureDefinition/valueset-parameter Version: 0.5.0
Standards status: Informative Maturity Level: 0 Computable Name: ValueSetParameterDeclaration
Other Identifiers: OID:2.16.840.1.113883.4.642.40.1.42.67

This extension declares a parameter that can be passed along with an $expand or $validate-code invocation to further narrow the value set. See Parameterised ValueSets for further details.

Context of Use

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

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension ValueSet parameter declaration
... Slices for extension Content/Rules for all slices
.... extension:name 1..1 Extension The name of the parameter
..... extension 0..0
..... url 1..1 uri "name"
..... value[x] 1..1 code A token (A-Z, a-z, _, -) with no whitespace. SHOULD start with p-
.... extension:documentation 0..1 Extension Explanation of the effect of the parameter, including valid values
..... extension 0..0
..... url 1..1 uri "documentation"
..... value[x] 1..1 markdown Value of extension
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/valueset-parameter"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension ValueSet parameter declaration
... id 0..1 id Unique id for inter-element referencing
... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:name 1..1 Extension The name of the parameter
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "name"
..... value[x] 1..1 code A token (A-Z, a-z, _, -) with no whitespace. SHOULD start with p-
.... extension:documentation 0..1 Extension Explanation of the effect of the parameter, including valid values
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "documentation"
..... value[x] 1..1 markdown Value of extension
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/valueset-parameter"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This extension declares a parameter that can be passed along with an $expand or $validate-code invocation to further narrow the value set. See Parameterised ValueSets for further details.

  • name: code: An Extension
  • documentation: markdown: An Extension

Maturity: 0

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension ValueSet parameter declaration
... Slices for extension Content/Rules for all slices
.... extension:name 1..1 Extension The name of the parameter
..... extension 0..0
..... url 1..1 uri "name"
..... value[x] 1..1 code A token (A-Z, a-z, _, -) with no whitespace. SHOULD start with p-
.... extension:documentation 0..1 Extension Explanation of the effect of the parameter, including valid values
..... extension 0..0
..... url 1..1 uri "documentation"
..... value[x] 1..1 markdown Value of extension
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/valueset-parameter"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension ValueSet parameter declaration
... id 0..1 id Unique id for inter-element referencing
... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:name 1..1 Extension The name of the parameter
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "name"
..... value[x] 1..1 code A token (A-Z, a-z, _, -) with no whitespace. SHOULD start with p-
.... extension:documentation 0..1 Extension Explanation of the effect of the parameter, including valid values
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "documentation"
..... value[x] 1..1 markdown Value of extension
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/valueset-parameter"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This extension declares a parameter that can be passed along with an $expand or $validate-code invocation to further narrow the value set. See Parameterised ValueSets for further details.

  • name: code: An Extension
  • documentation: markdown: An Extension

Maturity: 0

 

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()