Release 4B Snapshot 3: Connectathon 32 Base

This page is part of the Snapshot #3 for FHIR Specification (v4.3.0: R4B - STU ). The current version which supercedes this version is 5.0.0 R5 , released to support Connectathon 32 . For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3

Extension: effectivePeriod Resource Effective Period

FHIR Infrastructure Work Group   Maturity Level : 1 Informative Trial Use Use Context : Any
Official URL for this extension: : http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod Version : 5.0.0-snapshot3
draft as of 2020-12-28 Computable Name : ResourceEffectivePeriod
Flags : Non-Modifier OID : 2.16.840.1.113883.4.642.5.1430

Status: draft. Extension maintained by: HL7 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

Definition

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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . effectivePeriod ResourceEffectivePeriod 0..1 Period URL = http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
effectivePeriod: ResourceEffectivePeriod: 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

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
effectivePeriod: ResourceEffectivePeriod: 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

doco Documentation for this format

XML Template 

<!-- effectivePeriod -->

<!-- ResourceEffectivePeriod -->doco


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

 <valuePeriod><!-- I 1..1 Period Value of extension --></valuePeriod>

</extension>

JSON Template 

{ // 

{ // ResourceEffectivePeriod

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

    "valuePeriod" : { Period } // I R! Value of extension

  }

Summary

Name Flags Card. Type Description & Constraints doco
. . effectivePeriod ResourceEffectivePeriod 0..1 Period URL = http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
effectivePeriod: ResourceEffectivePeriod: 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

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
effectivePeriod: ResourceEffectivePeriod: 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

doco Documentation for this format

XML Template 

<!-- effectivePeriod -->

<!-- ResourceEffectivePeriod -->doco


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

 <valuePeriod><!-- I 1..1 Period Value of extension --></valuePeriod>

</extension>

JSON Template 

{ // 

{ // ResourceEffectivePeriod

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

    "valuePeriod" : { Period } // 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 hasValue() or (children().count() > id.count()) )
  • ext-1 : Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) extension.exists() != value.exists() )
  • ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • 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")]) extension.exists() != value.exists() )
  • ele-1 : On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div hasValue() or (children().count() > id.count()) )

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.