FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). 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: R3 R2

Extension: effective-period

Orders and Observations Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/11179-de-effective-period

Status: draft. Extension maintained by: Health Level Seven International (Orders and Observations)

Identifies the date on which the element became (or is expected to become) active and the date on which the element became (or is expected to become) retired.

Context of Use: Use on element: DataElement

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

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1PeriodURL = http://hl7.org/fhir/StructureDefinition/11179-de-effective-period
effective-period: Identifies the date on which the element became (or is expected to become) active and the date on which the element became (or is expected to become) retired.
Use on element: DataElement

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/11179-de-effective-period
effective-period: Identifies the date on which the element became (or is expected to become) active and the date on which the element became (or is expected to become) retired.
Use on element: DataElement
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/11179-de-effective-period"
... valuePeriod 0..1PeriodValue of extension

doco Documentation for this format

XML Template

<!-- effective-period -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/11179-de-effective-period" >
  <!-- from Element: extension -->
 <valuePeriod><!-- 0..1 Period Value of extension --></valuePeriod>
</extension>

JSON Template

{ // effective-period
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified orderOpen
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/11179-de-effective-period", // R! 
    "valuePeriod" : { Period } //Value of extension
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1PeriodURL = http://hl7.org/fhir/StructureDefinition/11179-de-effective-period
effective-period: Identifies the date on which the element became (or is expected to become) active and the date on which the element became (or is expected to become) retired.
Use on element: DataElement

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/11179-de-effective-period
effective-period: Identifies the date on which the element became (or is expected to become) active and the date on which the element became (or is expected to become) retired.
Use on element: DataElement
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/11179-de-effective-period"
... valuePeriod 0..1PeriodValue of extension

doco Documentation for this format

XML Template

<!-- effective-period -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/11179-de-effective-period" >
  <!-- from Element: extension -->
 <valuePeriod><!-- 0..1 Period Value of extension --></valuePeriod>
</extension>

JSON Template

{ // effective-period
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified orderOpen
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/11179-de-effective-period", // R! 
    "valuePeriod" : { Period } //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')]))