Using CQL with FHIR
2.0.0-ballot - STU2Ballot International flag

Using CQL with FHIR, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cql-ig/ and changes regularly. See the Directory of published versions

Resource Profile: CQL Model Info Settings

Official URL: http://hl7.org/fhir/uv/cql/StructureDefinition/cql-modelinfosettings Version: 2.0.0-ballot
Standards status: Trial-use Maturity Level: 1 Computable Name: CQLModelInfoSettings
Other Identifiers: OID:2.16.840.1.113883.4.642.40.37.42.11

CQL ModelInfo settings expressed using FHIR Parameters

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters Operation Request or Response
... Slices for parameter 0..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:modelName 1..1 BackboneElement What model
..... name 1..1 string Name from the definition
Fixed Value: modelName
..... value[x] 1..1 string If parameter is a data type
.... parameter:modelNamespace 0..1 BackboneElement What namespace
..... name 1..1 string Name from the definition
Fixed Value: modelNamespace
..... value[x] 1..1 string If parameter is a data type
.... parameter:modelUrl 1..1 BackboneElement What url
..... name 1..1 string Name from the definition
Fixed Value: modelUrl
..... value[x] 1..1 string If parameter is a data type
.... parameter:patientClassName 0..1 BackboneElement Name of the patient class in the model
..... name 1..1 string Name from the definition
Fixed Value: patientClassName
..... value[x] 1..1 string If parameter is a data type
.... parameter:patientBirthDatePropertyName 0..1 BackboneElement Name of the birthdate property of the Patient class in the model
..... name 1..1 string Name from the definition
Fixed Value: patientBirthDatePropertyName
..... value[x] 1..1 string If parameter is a data type
.... parameter:targetQualifier 0..1 BackboneElement Model target qualifier
..... name 1..1 string Name from the definition
Fixed Value: targetQualifier
..... value[x] 1..1 string If parameter is a data type
.... parameter:targetUrl 0..1 BackboneElement Model target url
..... name 1..1 string Name from the definition
Fixed Value: targetUrl
..... value[x] 1..1 string If parameter is a data type

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters Operation Request or Response
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for parameter ΣC 0..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
ele-1: All FHIR elements must have a @value or children
inv-1: A parameter must have one and only one of (value, resource, part)
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name Σ 1..1 string Name from the definition
ele-1: All FHIR elements must have a @value or children
.... parameter:modelName ΣC 1..1 BackboneElement What model
ele-1: All FHIR elements must have a @value or children
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name Σ 1..1 string Name from the definition
ele-1: All FHIR elements must have a @value or children
Fixed Value: modelName
..... value[x] ΣC 1..1 string If parameter is a data type
ele-1: All FHIR elements must have a @value or children
.... parameter:modelNamespace ΣC 0..1 BackboneElement What namespace
ele-1: All FHIR elements must have a @value or children
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name Σ 1..1 string Name from the definition
ele-1: All FHIR elements must have a @value or children
Fixed Value: modelNamespace
..... value[x] ΣC 1..1 string If parameter is a data type
ele-1: All FHIR elements must have a @value or children
.... parameter:modelUrl ΣC 1..1 BackboneElement What url
ele-1: All FHIR elements must have a @value or children
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name Σ 1..1 string Name from the definition
ele-1: All FHIR elements must have a @value or children
Fixed Value: modelUrl
..... value[x] ΣC 1..1 string If parameter is a data type
ele-1: All FHIR elements must have a @value or children
.... parameter:patientClassName ΣC 0..1 BackboneElement Name of the patient class in the model
ele-1: All FHIR elements must have a @value or children
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name Σ 1..1 string Name from the definition
ele-1: All FHIR elements must have a @value or children
Fixed Value: patientClassName
..... value[x] ΣC 1..1 string If parameter is a data type
ele-1: All FHIR elements must have a @value or children
.... parameter:patientBirthDatePropertyName ΣC 0..1 BackboneElement Name of the birthdate property of the Patient class in the model
ele-1: All FHIR elements must have a @value or children
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name Σ 1..1 string Name from the definition
ele-1: All FHIR elements must have a @value or children
Fixed Value: patientBirthDatePropertyName
..... value[x] ΣC 1..1 string If parameter is a data type
ele-1: All FHIR elements must have a @value or children
.... parameter:targetQualifier ΣC 0..1 BackboneElement Model target qualifier
ele-1: All FHIR elements must have a @value or children
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name Σ 1..1 string Name from the definition
ele-1: All FHIR elements must have a @value or children
Fixed Value: targetQualifier
..... value[x] ΣC 1..1 string If parameter is a data type
ele-1: All FHIR elements must have a @value or children
.... parameter:targetUrl ΣC 0..1 BackboneElement Model target url
ele-1: All FHIR elements must have a @value or children
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name Σ 1..1 string Name from the definition
ele-1: All FHIR elements must have a @value or children
Fixed Value: targetUrl
..... value[x] ΣC 1..1 string If parameter is a data type
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

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()
inv-1errorParameters.parameter, Parameters.parameter:modelName, Parameters.parameter:modelNamespace, Parameters.parameter:modelUrl, Parameters.parameter:patientClassName, Parameters.parameter:patientBirthDatePropertyName, Parameters.parameter:targetQualifier, Parameters.parameter:targetUrlA parameter must have one and only one of (value, resource, part)
: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters Operation Request or Response
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 0..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
inv-1: A parameter must have one and only one of (value, resource, part)
.... parameter:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:modelName ΣC 1..1 BackboneElement What model
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: modelName
..... value[x] ΣC 1..1 string If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:modelNamespace ΣC 0..1 BackboneElement What namespace
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: modelNamespace
..... value[x] ΣC 1..1 string If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:modelUrl ΣC 1..1 BackboneElement What url
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: modelUrl
..... value[x] ΣC 1..1 string If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:patientClassName ΣC 0..1 BackboneElement Name of the patient class in the model
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: patientClassName
..... value[x] ΣC 1..1 string If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:patientBirthDatePropertyName ΣC 0..1 BackboneElement Name of the birthdate property of the Patient class in the model
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: patientBirthDatePropertyName
..... value[x] ΣC 1..1 string If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:targetQualifier ΣC 0..1 BackboneElement Model target qualifier
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: targetQualifier
..... value[x] ΣC 1..1 string If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:targetUrl ΣC 0..1 BackboneElement Model target url
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: targetUrl
..... value[x] ΣC 1..1 string If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding

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()
inv-1errorParameters.parameter, Parameters.parameter:modelName, Parameters.parameter:modelNamespace, Parameters.parameter:modelUrl, Parameters.parameter:patientClassName, Parameters.parameter:patientBirthDatePropertyName, Parameters.parameter:targetQualifier, Parameters.parameter:targetUrlA parameter must have one and only one of (value, resource, part)
: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

This structure is derived from Parameters

Summary

Mandatory: 4 elements(5 nested mandatory elements)
Fixed: 7 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Parameters.parameter

Maturity: 1

Differential View

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters Operation Request or Response
... Slices for parameter 0..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:modelName 1..1 BackboneElement What model
..... name 1..1 string Name from the definition
Fixed Value: modelName
..... value[x] 1..1 string If parameter is a data type
.... parameter:modelNamespace 0..1 BackboneElement What namespace
..... name 1..1 string Name from the definition
Fixed Value: modelNamespace
..... value[x] 1..1 string If parameter is a data type
.... parameter:modelUrl 1..1 BackboneElement What url
..... name 1..1 string Name from the definition
Fixed Value: modelUrl
..... value[x] 1..1 string If parameter is a data type
.... parameter:patientClassName 0..1 BackboneElement Name of the patient class in the model
..... name 1..1 string Name from the definition
Fixed Value: patientClassName
..... value[x] 1..1 string If parameter is a data type
.... parameter:patientBirthDatePropertyName 0..1 BackboneElement Name of the birthdate property of the Patient class in the model
..... name 1..1 string Name from the definition
Fixed Value: patientBirthDatePropertyName
..... value[x] 1..1 string If parameter is a data type
.... parameter:targetQualifier 0..1 BackboneElement Model target qualifier
..... name 1..1 string Name from the definition
Fixed Value: targetQualifier
..... value[x] 1..1 string If parameter is a data type
.... parameter:targetUrl 0..1 BackboneElement Model target url
..... name 1..1 string Name from the definition
Fixed Value: targetUrl
..... value[x] 1..1 string If parameter is a data type

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters Operation Request or Response
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for parameter ΣC 0..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
ele-1: All FHIR elements must have a @value or children
inv-1: A parameter must have one and only one of (value, resource, part)
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name Σ 1..1 string Name from the definition
ele-1: All FHIR elements must have a @value or children
.... parameter:modelName ΣC 1..1 BackboneElement What model
ele-1: All FHIR elements must have a @value or children
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name Σ 1..1 string Name from the definition
ele-1: All FHIR elements must have a @value or children
Fixed Value: modelName
..... value[x] ΣC 1..1 string If parameter is a data type
ele-1: All FHIR elements must have a @value or children
.... parameter:modelNamespace ΣC 0..1 BackboneElement What namespace
ele-1: All FHIR elements must have a @value or children
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name Σ 1..1 string Name from the definition
ele-1: All FHIR elements must have a @value or children
Fixed Value: modelNamespace
..... value[x] ΣC 1..1 string If parameter is a data type
ele-1: All FHIR elements must have a @value or children
.... parameter:modelUrl ΣC 1..1 BackboneElement What url
ele-1: All FHIR elements must have a @value or children
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name Σ 1..1 string Name from the definition
ele-1: All FHIR elements must have a @value or children
Fixed Value: modelUrl
..... value[x] ΣC 1..1 string If parameter is a data type
ele-1: All FHIR elements must have a @value or children
.... parameter:patientClassName ΣC 0..1 BackboneElement Name of the patient class in the model
ele-1: All FHIR elements must have a @value or children
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name Σ 1..1 string Name from the definition
ele-1: All FHIR elements must have a @value or children
Fixed Value: patientClassName
..... value[x] ΣC 1..1 string If parameter is a data type
ele-1: All FHIR elements must have a @value or children
.... parameter:patientBirthDatePropertyName ΣC 0..1 BackboneElement Name of the birthdate property of the Patient class in the model
ele-1: All FHIR elements must have a @value or children
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name Σ 1..1 string Name from the definition
ele-1: All FHIR elements must have a @value or children
Fixed Value: patientBirthDatePropertyName
..... value[x] ΣC 1..1 string If parameter is a data type
ele-1: All FHIR elements must have a @value or children
.... parameter:targetQualifier ΣC 0..1 BackboneElement Model target qualifier
ele-1: All FHIR elements must have a @value or children
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name Σ 1..1 string Name from the definition
ele-1: All FHIR elements must have a @value or children
Fixed Value: targetQualifier
..... value[x] ΣC 1..1 string If parameter is a data type
ele-1: All FHIR elements must have a @value or children
.... parameter:targetUrl ΣC 0..1 BackboneElement Model target url
ele-1: All FHIR elements must have a @value or children
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name Σ 1..1 string Name from the definition
ele-1: All FHIR elements must have a @value or children
Fixed Value: targetUrl
..... value[x] ΣC 1..1 string If parameter is a data type
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

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()
inv-1errorParameters.parameter, Parameters.parameter:modelName, Parameters.parameter:modelNamespace, Parameters.parameter:modelUrl, Parameters.parameter:patientClassName, Parameters.parameter:patientBirthDatePropertyName, Parameters.parameter:targetQualifier, Parameters.parameter:targetUrlA parameter must have one and only one of (value, resource, part)
: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters Operation Request or Response
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 0..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
inv-1: A parameter must have one and only one of (value, resource, part)
.... parameter:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:modelName ΣC 1..1 BackboneElement What model
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: modelName
..... value[x] ΣC 1..1 string If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:modelNamespace ΣC 0..1 BackboneElement What namespace
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: modelNamespace
..... value[x] ΣC 1..1 string If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:modelUrl ΣC 1..1 BackboneElement What url
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: modelUrl
..... value[x] ΣC 1..1 string If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:patientClassName ΣC 0..1 BackboneElement Name of the patient class in the model
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: patientClassName
..... value[x] ΣC 1..1 string If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:patientBirthDatePropertyName ΣC 0..1 BackboneElement Name of the birthdate property of the Patient class in the model
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: patientBirthDatePropertyName
..... value[x] ΣC 1..1 string If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:targetQualifier ΣC 0..1 BackboneElement Model target qualifier
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: targetQualifier
..... value[x] ΣC 1..1 string If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:targetUrl ΣC 0..1 BackboneElement Model target url
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: targetUrl
..... value[x] ΣC 1..1 string If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding

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()
inv-1errorParameters.parameter, Parameters.parameter:modelName, Parameters.parameter:modelNamespace, Parameters.parameter:modelUrl, Parameters.parameter:patientClassName, Parameters.parameter:patientBirthDatePropertyName, Parameters.parameter:targetQualifier, Parameters.parameter:targetUrlA parameter must have one and only one of (value, resource, part)
: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

This structure is derived from Parameters

Summary

Mandatory: 4 elements(5 nested mandatory elements)
Fixed: 7 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Parameters.parameter

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron