This page is part of the FHIR Specification (v4.5.0: R5 Preview #3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3 R2

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Extension: usage

URL for this extension:

http://hl7.org/fhir/StructureDefinition/valueset-usage

Status: draft. Extension maintained by: HL7

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.

Context of Use: Use on Element ID ValueSet

Extension Content

• Summary
• Full Structure
• XML
• JSON
• All

Summary

Name	Flags	Card.	Type	Description & Constraints
usage		0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-usage 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	This is most likely to be an organization but can be an individual. It would not be a program, that information should be recorded in the usage.use.
use		1..1	string	A descriptive name of the project or standard in which the value set is used.
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-usage 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
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:user	I	1..1	Extension	A consumer of or client for the value set
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"user"
value[x]	I	1..1	string	Value of extension
extension:use	I	1..1	Extension	Implementation/project/standard that uses value set
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"use"
value[x]	I	1..1	string	Value of extension
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-usage"
value[x]	I	0..0
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueInteger64			integer64
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
Documentation for this format

XML Template

<!-- 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">  1..1 Extension  <!--  1..1 A consumer of or client for the value set -->
  <valueString value="[string]"/><!--  1..1 Value of extension -->
 </extension>
 <extension url="use">  1..1 Extension  <!--  1..1 Implementation/project/standard that uses value set -->
  <valueString value="[string]"/><!--  1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // usage
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // A consumer of or client for the value set // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "user", // R! 
        "valueString" : "<string>" // C? R! Value of extension
      },
      { // Implementation/project/standard that uses value set // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "use", // R! 
        "valueString" : "<string>" // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-usage", // R! 
// value[x]: Value of extension. One of these 51:
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
usage		0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-usage 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	This is most likely to be an organization but can be an individual. It would not be a program, that information should be recorded in the usage.use.
use		1..1	string	A descriptive name of the project or standard in which the value set is used.
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-usage 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
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:user	I	1..1	Extension	A consumer of or client for the value set
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"user"
value[x]	I	1..1	string	Value of extension
extension:use	I	1..1	Extension	Implementation/project/standard that uses value set
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"use"
value[x]	I	1..1	string	Value of extension
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-usage"
value[x]	I	0..0
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueInteger64			integer64
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
Documentation for this format

XML Template

<!-- 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">  1..1 Extension  <!--  1..1 A consumer of or client for the value set -->
  <valueString value="[string]"/><!--  1..1 Value of extension -->
 </extension>
 <extension url="use">  1..1 Extension  <!--  1..1 Implementation/project/standard that uses value set -->
  <valueString value="[string]"/><!--  1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // usage
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // A consumer of or client for the value set // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "user", // R! 
        "valueString" : "<string>" // C? R! Value of extension
      },
      { // Implementation/project/standard that uses value set // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "use", // R! 
        "valueString" : "<string>" // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-usage", // R! 
// value[x]: Value of extension. One of these 51:
  }

Constraints

• ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
• ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
• ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
• ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
• ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
• ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
• ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
• ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
• ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
• ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
• ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
• ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
• ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
• ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
• ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)