Extension: ValueSet Usage

Vocabulary Work Group

Maturity Level: 1

Trial Use

Use Context: Any

Official URL: `http://hl7.org/fhir/StructureDefinition/valueset-usage`				Version: 5.0.0-snapshot3
draft as of 2020-12-28				Computable Name: VS Usage
Flags: Non-Modifier				OID: 2.16.840.1.113883.4.642.5.1184

Context of Use: Use on Element ID ValueSet

Definition

Consumers of the value set and the implementations, projects or standards that the author has utilized the value set in.

Comment:

This is likely to be a point-in-time view and should not be considered an authoritative listing of all uses of the value set.

Summary

Name	Card.	Type	Description & Constraints
VS Usage	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-usage VS Usage: Consumers of the value set and the implementations, projects or standards that the author has utilized the value set in. Use on Element ID ValueSet
user	1..1	string	A consumer of or client for the value set
use	1..1	string	Implementation/project/standard that uses value set
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-usage VS Usage: Consumers of the value set and the implementations, projects or standards that the author has utilized the value set in. Use on Element ID ValueSet
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:user	1..1	Extension	A consumer of or client for the value set
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"user"
value[x]	1..1	string	Value of extension
extension:use	1..1	Extension	Implementation/project/standard that uses value set
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"use"
value[x]	1..1	string	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-usage"
value[x]	0..0
Documentation for this format

XML Template

<!-- VS Usage -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/valueset-usage" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="user"> I 1..1 Extension  <!-- I 1..1 A consumer of or client for the value set -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="use"> I 1..1 Extension  <!-- I 1..1 Implementation/project/standard that uses value set -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // VS Usage
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // A consumer of or client for the value set // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "user", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // Implementation/project/standard that uses value set // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "use", // R! 
        "valueString" : "<string>" // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! A consumer of or client for the value set
    "extension" : { Extension }, // I R! Implementation/project/standard that uses value set
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-usage" // R! 
  // value[x]: Value of extension: Prohibited
  }

Summary

Name	Card.	Type	Description & Constraints
VS Usage	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-usage VS Usage: Consumers of the value set and the implementations, projects or standards that the author has utilized the value set in. Use on Element ID ValueSet
user	1..1	string	A consumer of or client for the value set
use	1..1	string	Implementation/project/standard that uses value set
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-usage VS Usage: Consumers of the value set and the implementations, projects or standards that the author has utilized the value set in. Use on Element ID ValueSet
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:user	1..1	Extension	A consumer of or client for the value set
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"user"
value[x]	1..1	string	Value of extension
extension:use	1..1	Extension	Implementation/project/standard that uses value set
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"use"
value[x]	1..1	string	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-usage"
value[x]	0..0
Documentation for this format

XML Template

<!-- VS Usage -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/valueset-usage" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="user"> I 1..1 Extension  <!-- I 1..1 A consumer of or client for the value set -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="use"> I 1..1 Extension  <!-- I 1..1 Implementation/project/standard that uses value set -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // VS Usage
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // A consumer of or client for the value set // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "user", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // Implementation/project/standard that uses value set // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "use", // R! 
        "valueString" : "<string>" // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! A consumer of or client for the value set
    "extension" : { Extension }, // I R! Implementation/project/standard that uses value set
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-usage" // R! 
  // value[x]: Value of extension: Prohibited
  }

Constraints

ele-1: All FHIR elements must have a @value or children (xpath: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (xpath: extension.exists() != value.exists())
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: hasValue() or (children().count() > id.count()))

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.