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 R2

Extension: When the value set version becomes Active and is available for use

(No assigned work group) Maturity Level: 0Context: Any

URL for this extension: 

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

Status: draft. Extension maintained by: HL7

This is the first date-time when the value set version becomes active, so this value is present on Inactive value set versions as well. The start Date_time is expected to be as of 0001 UTC of the Effective Date.

Context of Use: Use on element: ValueSet

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

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1dateURL = http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate
When the value set version becomes Active and is available for use: This is the first date-time when the value set version becomes active, so this value is present on Inactive value set versions as well. The start Date_time is expected to be as of 0001 UTC of the Effective Date.
Use on element: ValueSet

doco Documentation for this format

Fulle Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate
When the value set version becomes Active and is available for use: This is the first date-time when the value set version becomes active, so this value is present on Inactive value set versions as well. The start Date_time is expected to be as of 0001 UTC of the Effective Date.
Use on element: ValueSet
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate"
... valueDate 1..1dateValue of extension

doco Documentation for this format

XML Template

<!-- When the value set version becomes Active and is available for use -->doco

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

JSON Template

{ // When the value set version becomes Active and is available for use
  // from Element: extension
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate", // R! 
    "valueDate" : "<date>" // R! Value of extension
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1dateURL = http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate
When the value set version becomes Active and is available for use: This is the first date-time when the value set version becomes active, so this value is present on Inactive value set versions as well. The start Date_time is expected to be as of 0001 UTC of the Effective Date.
Use on element: ValueSet

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate
When the value set version becomes Active and is available for use: This is the first date-time when the value set version becomes active, so this value is present on Inactive value set versions as well. The start Date_time is expected to be as of 0001 UTC of the Effective Date.
Use on element: ValueSet
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate"
... valueDate 1..1dateValue of extension

doco Documentation for this format

XML Template

<!-- When the value set version becomes Active and is available for use -->doco

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

JSON Template

{ // When the value set version becomes Active and is available for use
  // from Element: extension
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate", // 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')]))