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: R4B R4 R3

Extension: effectivePeriod

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod

Status: draft. Extension maintained by: HL7

The period during which the resource content was or is planned to be effective.

Context of Use: Use on element: StructureDefinition, StructureMap, DataElement, CapabilityStatement, OperationDefinition, SearchParameter, CompartmentDefinition, ImplementationGuide, CodeSystem, ValueSet, ConceptMap, ExpansionProfile, NamingSystem

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

Summary

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Period	URL = http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod effectivePeriod: The period during which the resource content was or is planned to be effective. Use on element: StructureDefinition, StructureMap, DataElement, CapabilityStatement, OperationDefinition, SearchParameter, CompartmentDefinition, ImplementationGuide, CodeSystem, ValueSet, ConceptMap, ExpansionProfile, NamingSystem
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod effectivePeriod: The period during which the resource content was or is planned to be effective. Use on element: StructureDefinition, StructureMap, DataElement, CapabilityStatement, OperationDefinition, SearchParameter, CompartmentDefinition, ImplementationGuide, CodeSystem, ValueSet, ConceptMap, ExpansionProfile, NamingSystem
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod"
valuePeriod	0..1	Period	Value of extension
Documentation for this format

XML Template

<!-- effectivePeriod -->

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

JSON Template

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

Summary

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Period	URL = http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod effectivePeriod: The period during which the resource content was or is planned to be effective. Use on element: StructureDefinition, StructureMap, DataElement, CapabilityStatement, OperationDefinition, SearchParameter, CompartmentDefinition, ImplementationGuide, CodeSystem, ValueSet, ConceptMap, ExpansionProfile, NamingSystem
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod effectivePeriod: The period during which the resource content was or is planned to be effective. Use on element: StructureDefinition, StructureMap, DataElement, CapabilityStatement, OperationDefinition, SearchParameter, CompartmentDefinition, ImplementationGuide, CodeSystem, ValueSet, ConceptMap, ExpansionProfile, NamingSystem
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod"
valuePeriod	0..1	Period	Value of extension
Documentation for this format

XML Template

<!-- effectivePeriod -->

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

JSON Template

{ // effectivePeriod
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified orderOpen
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod", // 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')]))