Release 4B 5 Ballot

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-ballot: R5 Ballot - STU 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 R3 R2

Extension: effectiveDate

Vocabulary Work Group   Maturity Level : 1 Informative Use Context : Any

URL for this extension: http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate
Version: 5.0.0-ballot
Name: effectiveDate
Title: null
Modifier: This extension is not a modifier extension
Status: draft
Definition: 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. (deprecated)
Committee: Vocabulary Work Group

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. (deprecated)

Comment :

This extension is deprecated, use the effectivePeriod.low element of the ValueSet resource instead.

Context of Use: Use on Element ID ValueSet

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . effectiveDate 0..1 dateTime URL = http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate
effectiveDate: 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. (deprecated)


Use on Element ID ValueSet

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate
effectiveDate: 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. (deprecated)


Use on Element ID ValueSet
. . . 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

XML Template

<!-- effectiveDate -->doco

< xmlns="http://hl7.org/fhir"

<extension xmlns="http://hl7.org/fhir"

     url="http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate" >
  <!-- from Element: extension -->
 <

 <valueDateTime value="[dateTime]"/><!-- I 1..1 Value of extension -->

</extension>

JSON Template

{ // effectiveDate
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate", // R! 
    "

    "valueDateTime" : "<dateTime>" // I R! Value of extension

  }

Summary

Name Flags Card. Type Description & Constraints doco
. . effectiveDate 0..1 dateTime URL = http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate
effectiveDate: 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. (deprecated)


Use on Element ID ValueSet

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate
effectiveDate: 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. (deprecated)


Use on Element ID ValueSet
. . . 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

XML Template

<!-- effectiveDate -->doco

< xmlns="http://hl7.org/fhir"

<extension xmlns="http://hl7.org/fhir"

     url="http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate" >
  <!-- from Element: extension -->
 <

 <valueDateTime value="[dateTime]"/><!-- I 1..1 Value of extension -->

</extension>

JSON Template

{ // effectiveDate
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate", // R! 
    "

    "valueDateTime" : "<dateTime>" // I R! Value of extension

  }

 

Constraints

  • ele-1 : All FHIR elements must have a @value or children unless an empty Parameters resource (xpath: @value|f:*|h:div|self::f:Parameters @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

effective date Optional Extensions Element
Expression: CodeSystem.extension('http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate').value

Examples of this extension

No examples found.