FHIR Extensions Pack
5.1.0 - 5.1.0 (April 2024) International flag

This page is part of the FHIR Core Extensions Registry (v5.1.0: Release 5.1) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Extension: ModelInfo Is Included

Official URL: http://hl7.org/fhir/StructureDefinition/cqf-modelInfo-isIncluded Version: 5.1.0
Standards status: Trial-use Maturity Level: 1 Responsible: HL7 International / Clinical Decision Support Computable Name: ModelInfoIsIncluded
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1505

Specifies whether the profile should be included in the model info constructed for an artifact collection such as an implementation guide. If this extension is not present, included is true by default for resources and profiles, but not data types (unless they are indirectly referenced by included resources or profiles). Note that even if isIncluded is false for a resource or profile, it will still be included in model info if it is a required dependency of some other included resource, profile, or data type.

An artifact author must be able to control which profiles are included in the model info for an artifact collection.

Context of Use

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

  • Element ID StructureDefinition

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 boolean: Specifies whether the profile should be included in the model info constructed for an artifact collection such as an implementation guide. If this extension is not present, included is true by default for resources and profiles, but not data types (unless they are indirectly referenced by included resources or profiles). Note that even if isIncluded is false for a resource or profile, it will still be included in model info if it is a required dependency of some other included resource, profile, or data type.

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Include in model info
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-modelInfo-isIncluded"
    ... value[x] 1..1 boolean Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Include in model info
    ... 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-modelInfo-isIncluded"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension of type boolean: Specifies whether the profile should be included in the model info constructed for an artifact collection such as an implementation guide. If this extension is not present, included is true by default for resources and profiles, but not data types (unless they are indirectly referenced by included resources or profiles). Note that even if isIncluded is false for a resource or profile, it will still be included in model info if it is a required dependency of some other included resource, profile, or data type.

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Include in model info
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-modelInfo-isIncluded"
    ... value[x] 1..1 boolean Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Include in model info
    ... 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-modelInfo-isIncluded"

    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)