FHIR Extensions Pack
5.2.0 - February 2025 International flag

This page is part of the FHIR Core Extensions Registry (v5.2.0: Release 5.2) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Extension: Value Set Effective Date

Official URL: http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate Version: 5.2.0
Standards status: Deprecated Maturity Level: 1 Responsible: HL7 International / Terminology Infrastructure Computable Name: ValueSetEffectiveDate

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

This extension is deprecated and should no longer be used

Replaced by the extension Artifact Effective Period prior to R5, and the element ValueSet in R5

This extension may be used on the following element(s):

Usage info

Usage:

  • Search Parameters using this Extension: Effective
  • This Extension is not used by any profiles in this Implementation Guide

Changes since version 1.0.0:

  • New Content

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Simple Extension of type dateTime: 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.

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension When the value set version becomes Active and is available for use
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate"
    ... value[x] 1..1 dateTime Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension When the value set version becomes Active and is available for use
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension of type dateTime: 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.

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension When the value set version becomes Active and is available for use
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate"
    ... value[x] 1..1 dateTime Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension When the value set version becomes Active and is available for use
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Search Parameters for this Extension