Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot - Ballot International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . 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: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 1 Computable Name: ModelInfoIsIncluded

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:

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..1ExtensionInclude in model info
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-modelInfo-isIncluded"
... value[x] 0..1booleanValue of extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionInclude in model info
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... url 1..1uri"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..1ExtensionInclude in model info
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-modelInfo-isIncluded"
... value[x] 0..1booleanValue of extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionInclude in model info
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... url 1..1uri"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()