FHIR Extensions Pack
5.3.0-ballot-tc1 - (September 2025 Ballot) International flag

This page is part of the FHIR Core Extensions Registry (v5.3.0-ballot-tc1: Release 5.3) based on FHIR (HL7® FHIR® Standard) v5.0.0. This version is a pre-release. The current official version is 5.2.0. For a full list of available versions, see the Directory of published versions

Extension: Artifact Effective Period

Official URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod Version: 5.3.0-ballot-tc1
Standards status: Trial-use Maturity Level: 1 Responsible: HL7 International / Clinical Decision Support Computable Name: ArtifactEffectivePeriod
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1737

When the artifact is expected to be used.

To provide an effective period for an artifact when the artifact is represented using a FHIR resource that does not declare the effectivePeriod element. For resources where this element was added in R5, the cross-version extension should be used rather than this extension (CodeSystem,ConceptMap,NamingSystem,ObservationDefinition,SpecimenDefinition,SubscriptionTopic,ValueSet).

Context of Use

This extension may be used on the following element(s)

Usage info

Usages:

  • This Extension is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Changes since version 5.2.0:

  • The resource metadata has changed (purpose)

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Simple Extension with the type Period: When the artifact is expected to be used.

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension When the artifact is expected to be used
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod"
    ... value[x] 1..1 Period Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension When the artifact is expected to be used
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension with the type Period: When the artifact is expected to be used.

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension When the artifact is expected to be used
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod"
    ... value[x] 1..1 Period Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension When the artifact is expected to be used
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    R4B

    The extension is represented a little differently in R4B:

    • Adjust the extension context ArtifactAssessment to Basic
    • Adjust the extension context ConditionDefinition to Basic
    • Note: Extensions that have been modified for R4B are still draft while real-world experience is collected
    Name Flags Card. Type Description & Constraints      Filter: Filters doco
    . . Extension 0..1 Extension When the artifact is expected to be used
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod"
    . . . value[x] 1.. 1 Period Value of extension

    doco Documentation for this format

    R4

    The extension is represented a little differently in R4:

    • Adjust the extension context ArtifactAssessment to Basic
    • Adjust the extension context ClinicalUseDefinition to Basic
    • Adjust the extension context ConditionDefinition to Basic
    • Adjust the extension context SubstanceDefinition to Basic
    • Adjust the extension context SubscriptionTopic to Basic
    • Note: Extensions that have been modified for R4 are still draft while real-world experience is collected
    Name Flags Card. Type Description & Constraints      Filter: Filters doco
    . . Extension 0..1 Extension When the artifact is expected to be used
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod"
    . . . value[x] 1.. 1 Period Value of extension

    doco Documentation for this format

    R3

    The extension is represented a little differently in R3:

    • Adjust the extension context ArtifactAssessment to Basic
    • Adjust the extension context ClinicalUseDefinition to Basic
    • Adjust the extension context ConditionDefinition to Basic
    • Adjust the extension context DeviceDefinition to Basic
    • Adjust the extension context ExampleScenario to Basic
    • Adjust the extension context MedicationKnowledge to Basic
    • Adjust the extension context ObservationDefinition to Basic
    • Adjust the extension context SpecimenDefinition to Basic
    • Adjust the extension context SubstanceDefinition to Basic
    • Adjust the extension context SubscriptionTopic to Basic
    • Adjust the extension context TerminologyCapabilities to Basic
    • Note: Extensions that have been modified for R3 are still draft while real-world experience is collected
    Name Flags Card. Type Description & Constraints      Filter: Filters doco
    . . Extension 0..1 Extension When the artifact is expected to be used
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod"
    . . . value[x] 1.. 1 Period Value of extension

    doco Documentation for this format

    Search Parameters for this Extension

    (none found)