STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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

Extension: When the value set version should no longer be used

(No assigned work group)

Maturity Level : 0

Context: Any

URL for this extension:


http://hl7.org/fhir/StructureDefinition/codesystem-expirationDate

Status: draft. Extension maintained by: HL7

The date when the value set version is no longer expected to be used to create new content. This is the first date-time when the value set version becomes Inactive, so this value MUST present on all Inactive value set versions. The start Date_time is expected to be as of 0001 UTC of the Expiration Date.

Context of Use: Use on element: CodeSystem

usage info: insert a list of places where this extension is used

Summary

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	date	URL = http://hl7.org/fhir/StructureDefinition/codesystem-expirationDate When the value set version should no longer be used: The date when the value set version is no longer expected to be used to create new content. This is the first date-time when the value set version becomes Inactive, so this value MUST present on all Inactive value set versions. The start Date_time is expected to be as of 0001 UTC of the Expiration Date. Use on element: CodeSystem
Documentation for this format

Fulle Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/codesystem-expirationDate When the value set version should no longer be used: The date when the value set version is no longer expected to be used to create new content. This is the first date-time when the value set version becomes Inactive, so this value MUST present on all Inactive value set versions. The start Date_time is expected to be as of 0001 UTC of the Expiration Date. Use on element: CodeSystem
extension	0 .. 0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/codesystem-expirationDate"
valueDate	1..1	date	Value of extension
Documentation for this format

XML Template

<!-- When the value set version should no longer be used -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/codesystem-expirationDate" >
  <!-- from Element: extension -->
 <valueDate value="[date]"/><!-- 1..1 Value of extension -->
</extension>

JSON Template

{ // When the value set version should no longer be used
  // from Element: extension
    "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-expirationDate", // R! 
    "valueDate" : "<date>" // R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	date	URL = http://hl7.org/fhir/StructureDefinition/codesystem-expirationDate When the value set version should no longer be used: The date when the value set version is no longer expected to be used to create new content. This is the first date-time when the value set version becomes Inactive, so this value MUST present on all Inactive value set versions. The start Date_time is expected to be as of 0001 UTC of the Expiration Date. Use on element: CodeSystem
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/codesystem-expirationDate When the value set version should no longer be used: The date when the value set version is no longer expected to be used to create new content. This is the first date-time when the value set version becomes Inactive, so this value MUST present on all Inactive value set versions. The start Date_time is expected to be as of 0001 UTC of the Expiration Date. Use on element: CodeSystem
extension	0 .. 0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/codesystem-expirationDate"
valueDate	1..1	date	Value of extension
Documentation for this format

XML Template

<!-- When the value set version should no longer be used -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/codesystem-expirationDate" >
  <!-- from Element: extension -->
 <valueDate value="[date]"/><!-- 1..1 Value of extension -->
</extension>

JSON Template

{ // When the value set version should no longer be used
  // from Element: extension
    "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-expirationDate", // R! 
    "valueDate" : "<date>" // 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')]) )