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

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.3.0-ballot-tc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

Extension: Artifact Status

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

The status of this artifact. Enables tracking the life-cycle of the content.

This extension is defined to support representing artifact metadata on resources that are not already canonical resources that have the corresponding element, and that behave in a definitional way. For example, it would not be appropriate to use this extension on a patient-specific resource such as MedicationRequest or CarePlan. For resources where this element was added in R5, the cross-version extension should be used rather than this extension (ClinicalUseDefinition,ConditionDefinition,ObservationDefinition,SpecimenDefinition,SubstanceDefinition,SubscriptionTopic).

Context of Use

This extension is a modifier extension.

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 Modifier Extension with the type code: The status of this artifact. Enables tracking the life-cycle of the content.

    Maturity: 2

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension ?! 0..1 Extension draft | active | retired | unknown
    This is a modifier extension
    ... extension 0..0 Extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-status"
    ... value[x] 1..1 code Value of extension
    Binding: PublicationStatus (required): The lifecycle status of an artifact.

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension ?! 0..1 Extension draft | active | retired | unknown
    This is a modifier extension
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0 Extension
    Slice: Unordered, Open by value:url
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-status"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Modifier Extension with the type code: The status of this artifact. Enables tracking the life-cycle of the content.

    Maturity: 2

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension ?! 0..1 Extension draft | active | retired | unknown
    This is a modifier extension
    ... extension 0..0 Extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-status"
    ... value[x] 1..1 code Value of extension
    Binding: PublicationStatus (required): The lifecycle status of an artifact.

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension ?! 0..1 Extension draft | active | retired | unknown
    This is a modifier extension
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0 Extension
    Slice: Unordered, Open by value:url
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-status"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Extension.value[x] Base required PublicationStatus 📦5.0.0 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must 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 draft | active | retired | unknown
    This is a modifier extension
    . . . extension 0 .. 0 Extension
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/artifact-status"
    . . . value[x] 1.. 1 code Value of extension
    Binding: PublicationStatus ( required ) : The lifecycle status of an artifact.

    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 draft | active | retired | unknown
    This is a modifier extension
    . . . extension 0 .. 0 Extension
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/artifact-status"
    . . . value[x] 1.. 1 code Value of extension
    Binding: PublicationStatus ( required ) : The lifecycle status of an artifact.

    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 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
    • 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 draft | active | retired | unknown
    This is a modifier extension
    . . . extension 0 .. 0 Extension
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/artifact-status"
    . . . value[x] 1.. 1 code Value of extension
    Binding: PublicationStatus ( required ) : The lifecycle status of an artifact.

    doco Documentation for this format

    Search Parameters for this Extension

    (none found)