Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot). 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: trusted-expansion

Vocabulary Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion

Status: draft. Extension maintained by: HL7

Indicates an authoritative source for performing value set expansions.

Comment:

If the designated "authoritative source" (as specified in the valueset-authoritativeSource extension, if present) is unable to provide a valid expansion, this extension indicates the base URL of a FHIR server that is an alternate trusted source where the value set expansion may be obtained. This may be via a ValueSet $expand operation request (if supported by the server), or via the ValueSet endpoint directly which will return an instance of the ValueSet resource containing a persisted expansion (and the parameters that expansion is based on).

This extension should only be used if the "authoritative source" (valueset-authoritativeSource extension) does not have a FHIR service which is capable of generating or returning a valid FHIR value set expansion.

Context of Use: Use on Element ID ValueSet

Summary

Name	Flags	Card.	Type	Description & Constraints
trusted-expansion		0..*	url	URL = http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion trusted-expansion: Indicates an authoritative source for performing value set expansions. Use on Element ID ValueSet
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion trusted-expansion: Indicates an authoritative source for performing value set expansions. Use on Element ID ValueSet
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion"
value[x]	1..1	url	Value of extension
Documentation for this format

XML Template

<!-- trusted-expansion -->

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

JSON Template

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

Summary

Name	Flags	Card.	Type	Description & Constraints
trusted-expansion		0..*	url	URL = http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion trusted-expansion: Indicates an authoritative source for performing value set expansions. Use on Element ID ValueSet
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion trusted-expansion: Indicates an authoritative source for performing value set expansions. Use on Element ID ValueSet
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion"
value[x]	1..1	url	Value of extension
Documentation for this format

XML Template

<!-- trusted-expansion -->

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

JSON Template

{ // trusted-expansion
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion", // R! 
    "valueUrl" : "<url>" // 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)