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

Extension: authoritativeSource

Vocabulary Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

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

Status: draft. Extension maintained by: HL7

A reference to the authoritative accessible, persisted source of truth of the entire Value Set Definition, including textual information and available versions.

Comment:

If this extension is not present, then the canonical URL (ValueSet.url) also serves the purpose of specifying the authoritative source. A difference between the canonical URL and the authoritiative source might arise in some cases due to ongoing organization restructuring, etc., and in those cases this extension may be used. The URL of the authoritative source is intended to be resolvable but that cannot be guaranteed. The designated "authoritative source" is normally expected to be able to generate a valid expansion of the value set, and if for some reason it cannot then the valueset-trusted-expansion should be used.

Context of Use: Use on Element ID ValueSet

Summary

Name	Flags	Card.	Type	Description & Constraints
authoritativeSource		0..1	uri	URL = http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource authoritativeSource: A reference to the authoritative accessible, persisted source of truth of the entire Value Set Definition, including textual information and available versions. Use on Element ID ValueSet
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource authoritativeSource: A reference to the authoritative accessible, persisted source of truth of the entire Value Set Definition, including textual information and available versions. Use on Element ID ValueSet
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource"
value[x]	1..1	uri	Value of extension
Documentation for this format

XML Template

<!-- authoritativeSource -->

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

JSON Template

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

Summary

Name	Flags	Card.	Type	Description & Constraints
authoritativeSource		0..1	uri	URL = http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource authoritativeSource: A reference to the authoritative accessible, persisted source of truth of the entire Value Set Definition, including textual information and available versions. Use on Element ID ValueSet
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource authoritativeSource: A reference to the authoritative accessible, persisted source of truth of the entire Value Set Definition, including textual information and available versions. Use on Element ID ValueSet
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource"
value[x]	1..1	uri	Value of extension
Documentation for this format

XML Template

<!-- authoritativeSource -->

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

JSON Template

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