Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot). 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.

Comment:

The effective period for a resource determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 would be published in 2015.

Context of Use: Use on Element ID StructureDefinition, Element ID StructureMap, Element ID CapabilityStatement, Element ID OperationDefinition, Element ID SearchParameter, Element ID CompartmentDefinition, Element ID ImplementationGuide, Element ID CodeSystem, Element ID ValueSet, Element ID ConceptMap or Element ID NamingSystem

Summary

Name	Flags	Card.	Type	Description & Constraints
effectivePeriod		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 ID StructureDefinition, Element ID StructureMap, Element ID CapabilityStatement, Element ID OperationDefinition, Element ID SearchParameter, Element ID CompartmentDefinition, Element ID ImplementationGuide, Element ID CodeSystem, Element ID ValueSet, Element ID ConceptMap or Element ID 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 ID StructureDefinition, Element ID StructureMap, Element ID CapabilityStatement, Element ID OperationDefinition, Element ID SearchParameter, Element ID CompartmentDefinition, Element ID ImplementationGuide, Element ID CodeSystem, Element ID ValueSet, Element ID ConceptMap or Element ID NamingSystem
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod"
value[x]	1..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><!--  1..1 Period Value of extension --></valuePeriod>
</extension>

JSON Template

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

Summary

Name	Flags	Card.	Type	Description & Constraints
effectivePeriod		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 ID StructureDefinition, Element ID StructureMap, Element ID CapabilityStatement, Element ID OperationDefinition, Element ID SearchParameter, Element ID CompartmentDefinition, Element ID ImplementationGuide, Element ID CodeSystem, Element ID ValueSet, Element ID ConceptMap or Element ID 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 ID StructureDefinition, Element ID StructureMap, Element ID CapabilityStatement, Element ID OperationDefinition, Element ID SearchParameter, Element ID CompartmentDefinition, Element ID ImplementationGuide, Element ID CodeSystem, Element ID ValueSet, Element ID ConceptMap or Element ID NamingSystem
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod"
value[x]	1..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><!--  1..1 Period Value of extension --></valuePeriod>
</extension>

JSON Template

{ // effectivePeriod
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod", // R! 
    "valuePeriod" : { Period } // C? 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')]))
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)