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: expirationDate

Vocabulary Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/valueset-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 SHALL present on all Inactive value set versions. The start Date_time is expected to be as of 0001 UTC of the Expiration Date.

Comment:

Upon reaching the Expiration Date, the value set Activity Status should be consdiered as inactive. An Inactive value set version may no longer be used to create new content, but it may be used to evaluate content created prior to the Expiration Date.

Context of Use: Use on Element ID ValueSet

Summary

Name	Flags	Card.	Type	Description & Constraints
expirationDate		0..1	date	URL = http://hl7.org/fhir/StructureDefinition/valueset-expirationDate expirationDate: 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 SHALL 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 ID ValueSet
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-expirationDate expirationDate: 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 SHALL 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 ID ValueSet
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-expirationDate"
value[x]	1..1	date	Value of extension
Documentation for this format

XML Template

<!-- expirationDate -->

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

JSON Template

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

Summary

Name	Flags	Card.	Type	Description & Constraints
expirationDate		0..1	date	URL = http://hl7.org/fhir/StructureDefinition/valueset-expirationDate expirationDate: 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 SHALL 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 ID ValueSet
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-expirationDate expirationDate: 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 SHALL 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 ID ValueSet
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-expirationDate"
value[x]	1..1	date	Value of extension
Documentation for this format

XML Template

<!-- expirationDate -->

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

JSON Template

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