Release 5 Preview #1

This page is part of the FHIR Specification (v4.2.0: R5 Preview #1). 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

Extension: reference

Vocabulary Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

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

Status: draft. Extension maintained by: HL7

A logical reference (e.g. a reference to ValueSet.url) that identifies the value set/version that identifies the set of possible coded values this coding was chosen from or constrained by.

Comment:

If this extension is used with an extensible binding, and the concept comes from outside the bound valueset, the value set SHALL be different from the bound valueset.

Context of Use: Use on Element ID Coding

Summary

Name	Flags	Card.	Type	Description & Constraints
reference		0..1	uri	URL = http://hl7.org/fhir/StructureDefinition/valueset-reference reference: A logical reference (e.g. a reference to ValueSet.url) that identifies the value set/version that identifies the set of possible coded values this coding was chosen from or constrained by. Use on Element ID Coding
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-reference reference: A logical reference (e.g. a reference to ValueSet.url) that identifies the value set/version that identifies the set of possible coded values this coding was chosen from or constrained by. Use on Element ID Coding
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-reference"
value[x]	I	1..1	uri	Value of extension
Documentation for this format

XML Template

<!-- reference -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/valueset-reference" >
  <!-- from Element: extension -->
 <valueUri value="[uri]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

{ // reference
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-reference", // R! 
    "valueUri" : "<uri>" // C? R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
reference		0..1	uri	URL = http://hl7.org/fhir/StructureDefinition/valueset-reference reference: A logical reference (e.g. a reference to ValueSet.url) that identifies the value set/version that identifies the set of possible coded values this coding was chosen from or constrained by. Use on Element ID Coding
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-reference reference: A logical reference (e.g. a reference to ValueSet.url) that identifies the value set/version that identifies the set of possible coded values this coding was chosen from or constrained by. Use on Element ID Coding
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-reference"
value[x]	I	1..1	uri	Value of extension
Documentation for this format

XML Template

<!-- reference -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/valueset-reference" >
  <!-- from Element: extension -->
 <valueUri value="[uri]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

{ // reference
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-reference", // R! 
    "valueUri" : "<uri>" // C? R! Value of extension
  }

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.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)