FHIR Extensions Pack
5.2.0-ballot - 5.2.0 Ballot - September 2024) 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.2.0-ballot 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: Scope

Official URL: http://hl7.org/fhir/StructureDefinition/cqf-scope Version: 5.2.0-ballot
Standards status: Trial-use Maturity Level: 1 Responsible: HL7 International / Clinical Decision Support Computable Name: Scope
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1734

Defines the scope of an artifact as a string of the form {namespace-name}[@{namespace-uri}]. Namespace name shall be a valid NPM package id, and namespace uri shall be a valid uri. For FHIR implementation guides, scope is inferred using the package id and the base canonical. e.g. fhir.cqf.common@http://fhir.org/guides/cqf/common. This extension can be used on Implementation Guides, Libraries, on any knowledge artifact, to declare the scope of the artifact. In the absence of an explicit scope declaration, the scope of an artifact is inferred based on the IG in which the artifact is defined.

To allow artifacts to declare the scope in which they are defined and intended to be evaluated. Scope typically corresponds to the implementation guide in which the artifact is packaged. However, to support the use of non-IG-packaged content, this extension allows artifacts to declare their intended scope so that evaluation environments can correctly resolve namespaces and dependencies.

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:

  • No changes

    • 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 string: Defines the scope of an artifact as a string of the form {namespace-name}[@{namespace-uri}]. Namespace name shall be a valid NPM package id, and namespace uri shall be a valid uri. For FHIR implementation guides, scope is inferred using the package id and the base canonical. e.g. fhir.cqf.common@http://fhir.org/guides/cqf/common. This extension can be used on Implementation Guides, Libraries, on any knowledge artifact, to declare the scope of the artifact. In the absence of an explicit scope declaration, the scope of an artifact is inferred based on the IG in which the artifact is defined.

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension What scope the artifact is defined in
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-scope"
    ... value[x] 0..1 string Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension What scope the artifact is defined in
    ... 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/cqf-scope"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension of type string: Defines the scope of an artifact as a string of the form {namespace-name}[@{namespace-uri}]. Namespace name shall be a valid NPM package id, and namespace uri shall be a valid uri. For FHIR implementation guides, scope is inferred using the package id and the base canonical. e.g. fhir.cqf.common@http://fhir.org/guides/cqf/common. This extension can be used on Implementation Guides, Libraries, on any knowledge artifact, to declare the scope of the artifact. In the absence of an explicit scope declaration, the scope of an artifact is inferred based on the IG in which the artifact is defined.

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension What scope the artifact is defined in
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-scope"
    ... value[x] 0..1 string Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension What scope the artifact is defined in
    ... 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/cqf-scope"

    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)