Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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 R2

Extension: deprecated

Vocabulary Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/valueset-deprecated

Version: 5.0.0-ballot

Name: deprecated

Title: null

Modifier: This extension is not a modifier extension

Status: draft

Definition: if ture, indicates that the concept is deprecated from the value set - that is, it should not be used, and is planned to be withdrawn.

Committee: Vocabulary Work Group

Status: draft. Extension maintained by: HL7

if ture, indicates that the concept is deprecated from the value set - that is, it should not be used, and is planned to be withdrawn.

Comment:

Ths status relates to a concept's inclusion in the value set, and might be different to the underlying status of the concept itself.

Context of Use: Use on Element ID ValueSet.compose.include.concept

Summary

Name	Flags	Card.	Type	Description & Constraints
deprecated		0..1	boolean	URL = http://hl7.org/fhir/StructureDefinition/valueset-deprecated deprecated: if ture, indicates that the concept is deprecated from the value set - that is, it should not be used, and is planned to be withdrawn. Use on Element ID ValueSet.compose.include.concept
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-deprecated deprecated: if ture, indicates that the concept is deprecated from the value set - that is, it should not be used, and is planned to be withdrawn. Use on Element ID ValueSet.compose.include.concept
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-deprecated"
value[x]	1..1	boolean	Value of extension
Documentation for this format

XML Template

<!-- deprecated -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/valueset-deprecated" >
  <!-- from Element: extension -->
 <valueBoolean value="[boolean]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

{ // deprecated
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-deprecated", // R! 
    "valueBoolean" : <boolean> // I R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
deprecated		0..1	boolean	URL = http://hl7.org/fhir/StructureDefinition/valueset-deprecated deprecated: if ture, indicates that the concept is deprecated from the value set - that is, it should not be used, and is planned to be withdrawn. Use on Element ID ValueSet.compose.include.concept
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-deprecated deprecated: if ture, indicates that the concept is deprecated from the value set - that is, it should not be used, and is planned to be withdrawn. Use on Element ID ValueSet.compose.include.concept
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-deprecated"
value[x]	1..1	boolean	Value of extension
Documentation for this format

XML Template

<!-- deprecated -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/valueset-deprecated" >
  <!-- from Element: extension -->
 <valueBoolean value="[boolean]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

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

Search

No Search Extensions defined for this resource

Examples of this extension

SearchEntryMode