FHIR Extensions Pack
5.1.0-ballot1 - Ballot for Release 5.1.0 International flag

This page is part of the FHIR Core Extensions Registry (v5.1.0-ballot: Releases Ballot 4) based on FHIR (HL7® FHIR® Standard) v5.0.0. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

Extension: Artifact URL

Official URL: http://hl7.org/fhir/StructureDefinition/artifact-url Version: 5.1.0-ballot1
Standards status: Trial-use Maturity Level: 2 Responsible: HL7 International / Clinical Decision Support Computable Name: ArtifactUrl

An absolute URI that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this {{title}} is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the {{title}} is stored on different servers.

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.

Context of Use

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

  • Element ID Resource

Usage info

Usage:

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

Changes since version 1.0.0:

  • The resource metadata has changed (status, publisher)

    • 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 of type uri: An absolute URI that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this {{title}} is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the {{title}} is stored on different servers.

    Maturity: 2

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1ExtensionCanonical identifier for this {{title}}, represented as a URI (globally unique)
    ... extension 0..0
    ... url 1..1uri"http://hl7.org/fhir/StructureDefinition/artifact-url"
    ... value[x] 1..1uriValue of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1ExtensionCanonical identifier for this {{title}}, represented as a URI (globally unique)
    ... id 0..1idUnique id for inter-element referencing
    ... extension 0..0
    ... url 1..1uri"http://hl7.org/fhir/StructureDefinition/artifact-url"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension of type uri: An absolute URI that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this {{title}} is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the {{title}} is stored on different servers.

    Maturity: 2

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1ExtensionCanonical identifier for this {{title}}, represented as a URI (globally unique)
    ... extension 0..0
    ... url 1..1uri"http://hl7.org/fhir/StructureDefinition/artifact-url"
    ... value[x] 1..1uriValue of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1ExtensionCanonical identifier for this {{title}}, represented as a URI (globally unique)
    ... id 0..1idUnique id for inter-element referencing
    ... extension 0..0
    ... url 1..1uri"http://hl7.org/fhir/StructureDefinition/artifact-url"

    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()

    Search Parameters for this Extension

    (none found)