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 Retrievable

Official URL: http://hl7.org/fhir/StructureDefinition/cqf-modelInfo-isRetrievable Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 1 Computable Name: ModelInfoIsRetrievable

Specifies whether the class constructed for the profile should be marked as retrievable in the model info (meaning whether or not it can appear as the target of a retrieve expression). If this value is not specified, retrievable is true for resources and false for data types.

An artifact author must be able to control which classes in the resulting model info are retrievable.

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 class constructed for the profile should be marked as retrievable in the model info (meaning whether or not it can appear as the target of a retrieve expression). If this value is not specified, retrievable is true for resources and false for data types.

Maturity: 1

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionWhether the resources can be retrieved
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-modelInfo-isRetrievable"
... value[x] 0..1booleanValue of extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionWhether the resources can be retrieved
... 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-isRetrievable"

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension of type boolean: Specifies whether the class constructed for the profile should be marked as retrievable in the model info (meaning whether or not it can appear as the target of a retrieve expression). If this value is not specified, retrievable is true for resources and false for data types.

Maturity: 1

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionWhether the resources can be retrieved
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-modelInfo-isRetrievable"
... value[x] 0..1booleanValue of extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionWhether the resources can be retrieved
... 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-isRetrievable"

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