Using CQL With FHIR
2.1.0-cibuild - STU 2 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.1.0-cibuild 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 Options

Official URL: http://hl7.org/fhir/uv/cql/StructureDefinition/cql-options Version: 2.1.0-cibuild
Standards status: Trial-use Active as of 2025-12-04 Maturity Level: 1 Computable Name: CQLOptions
Other Identifiers: OID:2.16.840.1.113883.4.642.40.37.42.13

A parameters profile that defines supported CQL-to-ELM translator options used to translate CQL. Complete documentation of these options can be found in the Usage topic of the CQL-to-ELM translator overview.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Operation Request or Response
... 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
Constraints: inv-1
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
.... parameter:enableAnnotations ΣC 0..1 BackboneElement Include annotations?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: enableAnnotations
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:enableLocators ΣC 0..1 BackboneElement Include locators?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: enableLocators
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:disableListDemotion ΣC 0..1 BackboneElement Implicitly convert lists to singletons when possible?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: disableListDemotion
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:disableListPromotion ΣC 0..1 BackboneElement Implicitly convert singletons to lists when possible?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: disableListPromotion
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:disableMethodInvocation ΣC 0..1 BackboneElement Disable method-style invocation?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: disableMethodInvocation
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:enableDateRangeOptimization ΣC 0..1 BackboneElement Optimize date ranges when possible?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: enableDateRangeOptimization
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:enableResultTypes ΣC 0..1 BackboneElement Include result types?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: enableResultTypes
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:enableDetailedErrors ΣC 0..1 BackboneElement Include detailed errors?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: enableDetailedErrors
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:disableListTraversal ΣC 0..1 BackboneElement Disallow list traversal?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: disableListTraversal
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:signatureLevel ΣC 0..1 BackboneElement Include signatures?
Constraints: inv-1, cop-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: signatureLevel
..... value[x] ΣC 1..1 string If parameter is a data type
.... parameter:translatorVersion ΣC 0..1 BackboneElement What version
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: translatorVersion
..... value[x] ΣC 1..1 string If parameter is a data type
.... parameter:format ΣC 0..2 BackboneElement What format (XML and/or JSON)
Constraints: inv-1, cop-2
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: format
..... value[x] ΣC 1..1 string If parameter is a data type
.... parameter:compatibilityLevel ΣC 0..1 BackboneElement What compatibility level
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: compatibilityLevel
..... value[x] ΣC 1..1 string If parameter is a data type
.... parameter:enableCqlOnly ΣC 0..1 BackboneElement Include CQL only?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: enableCqlOnly
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:errorLevel ΣC 0..1 BackboneElement What error level
Constraints: inv-1, cop-3
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: errorLevel
..... value[x] ΣC 1..1 string If parameter is a data type
.... parameter:validateUnits ΣC 0..1 BackboneElement Validate UCUM units?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: validateUnits
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:verifyOnly ΣC 0..1 BackboneElement Verify only
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: verifyOnly
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:analyzeDataRequirements ΣC 0..1 BackboneElement Analyze data requirements?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: analyzeDataRequirements
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:collapseDataRequirements ΣC 0..1 BackboneElement Collapse data requirements?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: collapseDataRequirements
..... value[x] ΣC 1..1 boolean If parameter is a data type

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
cop-1 error Parameters.parameter:signatureLevel SignatureLevel parameter must be None, Differing, Overloads, or All value in ( 'None' | 'Differing' | 'Overloads' | 'All' )
cop-2 error Parameters.parameter:format Format parameter must be XML or JSON value in ( 'XML' | 'JSON' )
cop-3 error Parameters.parameter:errorLevel ErrorLevel parameter must be Info, Warning, or Error value in ( 'Info' | 'Warning' | 'Error' )
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-1 error Parameters.parameter, Parameters.parameter:enableAnnotations, Parameters.parameter:enableLocators, Parameters.parameter:disableListDemotion, Parameters.parameter:disableListPromotion, Parameters.parameter:disableMethodInvocation, Parameters.parameter:enableDateRangeOptimization, Parameters.parameter:enableResultTypes, Parameters.parameter:enableDetailedErrors, Parameters.parameter:disableListTraversal, Parameters.parameter:signatureLevel, Parameters.parameter:translatorVersion, Parameters.parameter:format, Parameters.parameter:compatibilityLevel, Parameters.parameter:enableCqlOnly, Parameters.parameter:errorLevel, Parameters.parameter:validateUnits, Parameters.parameter:verifyOnly, Parameters.parameter:analyzeDataRequirements, Parameters.parameter:collapseDataRequirements A 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 & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Operation Request or Response
... Slices for parameter 0..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:enableAnnotations 0..1 BackboneElement Include annotations?
..... name 1..1 string Name from the definition
Fixed Value: enableAnnotations
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:enableLocators 0..1 BackboneElement Include locators?
..... name 1..1 string Name from the definition
Fixed Value: enableLocators
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:disableListDemotion 0..1 BackboneElement Implicitly convert lists to singletons when possible?
..... name 1..1 string Name from the definition
Fixed Value: disableListDemotion
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:disableListPromotion 0..1 BackboneElement Implicitly convert singletons to lists when possible?
..... name 1..1 string Name from the definition
Fixed Value: disableListPromotion
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:disableMethodInvocation 0..1 BackboneElement Disable method-style invocation?
..... name 1..1 string Name from the definition
Fixed Value: disableMethodInvocation
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:enableDateRangeOptimization 0..1 BackboneElement Optimize date ranges when possible?
..... name 1..1 string Name from the definition
Fixed Value: enableDateRangeOptimization
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:enableResultTypes 0..1 BackboneElement Include result types?
..... name 1..1 string Name from the definition
Fixed Value: enableResultTypes
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:enableDetailedErrors 0..1 BackboneElement Include detailed errors?
..... name 1..1 string Name from the definition
Fixed Value: enableDetailedErrors
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:disableListTraversal 0..1 BackboneElement Disallow list traversal?
..... name 1..1 string Name from the definition
Fixed Value: disableListTraversal
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:signatureLevel C 0..1 BackboneElement Include signatures?
Constraints: cop-1
..... name 1..1 string Name from the definition
Fixed Value: signatureLevel
..... value[x] C 1..1 string If parameter is a data type
.... parameter:translatorVersion 0..1 BackboneElement What version
..... name 1..1 string Name from the definition
Fixed Value: translatorVersion
..... value[x] 1..1 string If parameter is a data type
.... parameter:format C 0..2 BackboneElement What format (XML and/or JSON)
Constraints: cop-2
..... name 1..1 string Name from the definition
Fixed Value: format
..... value[x] C 1..1 string If parameter is a data type
.... parameter:compatibilityLevel 0..1 BackboneElement What compatibility level
..... name 1..1 string Name from the definition
Fixed Value: compatibilityLevel
..... value[x] 1..1 string If parameter is a data type
.... parameter:enableCqlOnly 0..1 BackboneElement Include CQL only?
..... name 1..1 string Name from the definition
Fixed Value: enableCqlOnly
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:errorLevel C 0..1 BackboneElement What error level
Constraints: cop-3
..... name 1..1 string Name from the definition
Fixed Value: errorLevel
..... value[x] C 1..1 string If parameter is a data type
.... parameter:validateUnits 0..1 BackboneElement Validate UCUM units?
..... name 1..1 string Name from the definition
Fixed Value: validateUnits
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:verifyOnly 0..1 BackboneElement Verify only
..... name 1..1 string Name from the definition
Fixed Value: verifyOnly
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:analyzeDataRequirements 0..1 BackboneElement Analyze data requirements?
..... name 1..1 string Name from the definition
Fixed Value: analyzeDataRequirements
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:collapseDataRequirements 0..1 BackboneElement Collapse data requirements?
..... name 1..1 string Name from the definition
Fixed Value: collapseDataRequirements
..... value[x] 1..1 boolean If parameter is a data type

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
cop-1 error Parameters.parameter:signatureLevel SignatureLevel parameter must be None, Differing, Overloads, or All value in ( 'None' | 'Differing' | 'Overloads' | 'All' )
cop-2 error Parameters.parameter:format Format parameter must be XML or JSON value in ( 'XML' | 'JSON' )
cop-3 error Parameters.parameter:errorLevel ErrorLevel parameter must be Info, Warning, or Error value in ( 'Info' | 'Warning' | 'Error' )
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
Constraints: inv-1
.... 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:enableAnnotations ΣC 0..1 BackboneElement Include annotations?
Constraints: inv-1
..... 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: enableAnnotations
..... value[x] ΣC 1..1 boolean 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:enableLocators ΣC 0..1 BackboneElement Include locators?
Constraints: inv-1
..... 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: enableLocators
..... value[x] ΣC 1..1 boolean 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:disableListDemotion ΣC 0..1 BackboneElement Implicitly convert lists to singletons when possible?
Constraints: inv-1
..... 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: disableListDemotion
..... value[x] ΣC 1..1 boolean 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:disableListPromotion ΣC 0..1 BackboneElement Implicitly convert singletons to lists when possible?
Constraints: inv-1
..... 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: disableListPromotion
..... value[x] ΣC 1..1 boolean 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:disableMethodInvocation ΣC 0..1 BackboneElement Disable method-style invocation?
Constraints: inv-1
..... 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: disableMethodInvocation
..... value[x] ΣC 1..1 boolean 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:enableDateRangeOptimization ΣC 0..1 BackboneElement Optimize date ranges when possible?
Constraints: inv-1
..... 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: enableDateRangeOptimization
..... value[x] ΣC 1..1 boolean 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:enableResultTypes ΣC 0..1 BackboneElement Include result types?
Constraints: inv-1
..... 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: enableResultTypes
..... value[x] ΣC 1..1 boolean 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:enableDetailedErrors ΣC 0..1 BackboneElement Include detailed errors?
Constraints: inv-1
..... 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: enableDetailedErrors
..... value[x] ΣC 1..1 boolean 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:disableListTraversal ΣC 0..1 BackboneElement Disallow list traversal?
Constraints: inv-1
..... 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: disableListTraversal
..... value[x] ΣC 1..1 boolean 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:signatureLevel ΣC 0..1 BackboneElement Include signatures?
Constraints: inv-1, cop-1
..... 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: signatureLevel
..... 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:translatorVersion ΣC 0..1 BackboneElement What version
Constraints: inv-1
..... 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: translatorVersion
..... 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:format ΣC 0..2 BackboneElement What format (XML and/or JSON)
Constraints: inv-1, cop-2
..... 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: format
..... 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:compatibilityLevel ΣC 0..1 BackboneElement What compatibility level
Constraints: inv-1
..... 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: compatibilityLevel
..... 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:enableCqlOnly ΣC 0..1 BackboneElement Include CQL only?
Constraints: inv-1
..... 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: enableCqlOnly
..... value[x] ΣC 1..1 boolean 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:errorLevel ΣC 0..1 BackboneElement What error level
Constraints: inv-1, cop-3
..... 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: errorLevel
..... 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:validateUnits ΣC 0..1 BackboneElement Validate UCUM units?
Constraints: inv-1
..... 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: validateUnits
..... value[x] ΣC 1..1 boolean 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:verifyOnly ΣC 0..1 BackboneElement Verify only
Constraints: inv-1
..... 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: verifyOnly
..... value[x] ΣC 1..1 boolean 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:analyzeDataRequirements ΣC 0..1 BackboneElement Analyze data requirements?
Constraints: inv-1
..... 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: analyzeDataRequirements
..... value[x] ΣC 1..1 boolean 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:collapseDataRequirements ΣC 0..1 BackboneElement Collapse data requirements?
Constraints: inv-1
..... 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: collapseDataRequirements
..... value[x] ΣC 1..1 boolean 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

Path Status Usage ValueSet Version Source
Parameters.language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cop-1 error Parameters.parameter:signatureLevel SignatureLevel parameter must be None, Differing, Overloads, or All value in ( 'None' | 'Differing' | 'Overloads' | 'All' )
cop-2 error Parameters.parameter:format Format parameter must be XML or JSON value in ( 'XML' | 'JSON' )
cop-3 error Parameters.parameter:errorLevel ErrorLevel parameter must be Info, Warning, or Error value in ( 'Info' | 'Warning' | 'Error' )
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-1 error Parameters.parameter, Parameters.parameter:enableAnnotations, Parameters.parameter:enableLocators, Parameters.parameter:disableListDemotion, Parameters.parameter:disableListPromotion, Parameters.parameter:disableMethodInvocation, Parameters.parameter:enableDateRangeOptimization, Parameters.parameter:enableResultTypes, Parameters.parameter:enableDetailedErrors, Parameters.parameter:disableListTraversal, Parameters.parameter:signatureLevel, Parameters.parameter:translatorVersion, Parameters.parameter:format, Parameters.parameter:compatibilityLevel, Parameters.parameter:enableCqlOnly, Parameters.parameter:errorLevel, Parameters.parameter:validateUnits, Parameters.parameter:verifyOnly, Parameters.parameter:analyzeDataRequirements, Parameters.parameter:collapseDataRequirements A 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()))

Summary

Mandatory: 0 element(19 nested mandatory elements)
Fixed: 19 elements

Slices

This structure defines the following Slices:

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

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Operation Request or Response
... 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
Constraints: inv-1
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
.... parameter:enableAnnotations ΣC 0..1 BackboneElement Include annotations?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: enableAnnotations
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:enableLocators ΣC 0..1 BackboneElement Include locators?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: enableLocators
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:disableListDemotion ΣC 0..1 BackboneElement Implicitly convert lists to singletons when possible?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: disableListDemotion
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:disableListPromotion ΣC 0..1 BackboneElement Implicitly convert singletons to lists when possible?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: disableListPromotion
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:disableMethodInvocation ΣC 0..1 BackboneElement Disable method-style invocation?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: disableMethodInvocation
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:enableDateRangeOptimization ΣC 0..1 BackboneElement Optimize date ranges when possible?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: enableDateRangeOptimization
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:enableResultTypes ΣC 0..1 BackboneElement Include result types?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: enableResultTypes
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:enableDetailedErrors ΣC 0..1 BackboneElement Include detailed errors?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: enableDetailedErrors
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:disableListTraversal ΣC 0..1 BackboneElement Disallow list traversal?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: disableListTraversal
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:signatureLevel ΣC 0..1 BackboneElement Include signatures?
Constraints: inv-1, cop-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: signatureLevel
..... value[x] ΣC 1..1 string If parameter is a data type
.... parameter:translatorVersion ΣC 0..1 BackboneElement What version
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: translatorVersion
..... value[x] ΣC 1..1 string If parameter is a data type
.... parameter:format ΣC 0..2 BackboneElement What format (XML and/or JSON)
Constraints: inv-1, cop-2
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: format
..... value[x] ΣC 1..1 string If parameter is a data type
.... parameter:compatibilityLevel ΣC 0..1 BackboneElement What compatibility level
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: compatibilityLevel
..... value[x] ΣC 1..1 string If parameter is a data type
.... parameter:enableCqlOnly ΣC 0..1 BackboneElement Include CQL only?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: enableCqlOnly
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:errorLevel ΣC 0..1 BackboneElement What error level
Constraints: inv-1, cop-3
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: errorLevel
..... value[x] ΣC 1..1 string If parameter is a data type
.... parameter:validateUnits ΣC 0..1 BackboneElement Validate UCUM units?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: validateUnits
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:verifyOnly ΣC 0..1 BackboneElement Verify only
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: verifyOnly
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:analyzeDataRequirements ΣC 0..1 BackboneElement Analyze data requirements?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: analyzeDataRequirements
..... value[x] ΣC 1..1 boolean If parameter is a data type
.... parameter:collapseDataRequirements ΣC 0..1 BackboneElement Collapse data requirements?
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: collapseDataRequirements
..... value[x] ΣC 1..1 boolean If parameter is a data type

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
cop-1 error Parameters.parameter:signatureLevel SignatureLevel parameter must be None, Differing, Overloads, or All value in ( 'None' | 'Differing' | 'Overloads' | 'All' )
cop-2 error Parameters.parameter:format Format parameter must be XML or JSON value in ( 'XML' | 'JSON' )
cop-3 error Parameters.parameter:errorLevel ErrorLevel parameter must be Info, Warning, or Error value in ( 'Info' | 'Warning' | 'Error' )
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-1 error Parameters.parameter, Parameters.parameter:enableAnnotations, Parameters.parameter:enableLocators, Parameters.parameter:disableListDemotion, Parameters.parameter:disableListPromotion, Parameters.parameter:disableMethodInvocation, Parameters.parameter:enableDateRangeOptimization, Parameters.parameter:enableResultTypes, Parameters.parameter:enableDetailedErrors, Parameters.parameter:disableListTraversal, Parameters.parameter:signatureLevel, Parameters.parameter:translatorVersion, Parameters.parameter:format, Parameters.parameter:compatibilityLevel, Parameters.parameter:enableCqlOnly, Parameters.parameter:errorLevel, Parameters.parameter:validateUnits, Parameters.parameter:verifyOnly, Parameters.parameter:analyzeDataRequirements, Parameters.parameter:collapseDataRequirements A 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()))

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Operation Request or Response
... Slices for parameter 0..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:enableAnnotations 0..1 BackboneElement Include annotations?
..... name 1..1 string Name from the definition
Fixed Value: enableAnnotations
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:enableLocators 0..1 BackboneElement Include locators?
..... name 1..1 string Name from the definition
Fixed Value: enableLocators
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:disableListDemotion 0..1 BackboneElement Implicitly convert lists to singletons when possible?
..... name 1..1 string Name from the definition
Fixed Value: disableListDemotion
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:disableListPromotion 0..1 BackboneElement Implicitly convert singletons to lists when possible?
..... name 1..1 string Name from the definition
Fixed Value: disableListPromotion
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:disableMethodInvocation 0..1 BackboneElement Disable method-style invocation?
..... name 1..1 string Name from the definition
Fixed Value: disableMethodInvocation
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:enableDateRangeOptimization 0..1 BackboneElement Optimize date ranges when possible?
..... name 1..1 string Name from the definition
Fixed Value: enableDateRangeOptimization
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:enableResultTypes 0..1 BackboneElement Include result types?
..... name 1..1 string Name from the definition
Fixed Value: enableResultTypes
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:enableDetailedErrors 0..1 BackboneElement Include detailed errors?
..... name 1..1 string Name from the definition
Fixed Value: enableDetailedErrors
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:disableListTraversal 0..1 BackboneElement Disallow list traversal?
..... name 1..1 string Name from the definition
Fixed Value: disableListTraversal
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:signatureLevel C 0..1 BackboneElement Include signatures?
Constraints: cop-1
..... name 1..1 string Name from the definition
Fixed Value: signatureLevel
..... value[x] C 1..1 string If parameter is a data type
.... parameter:translatorVersion 0..1 BackboneElement What version
..... name 1..1 string Name from the definition
Fixed Value: translatorVersion
..... value[x] 1..1 string If parameter is a data type
.... parameter:format C 0..2 BackboneElement What format (XML and/or JSON)
Constraints: cop-2
..... name 1..1 string Name from the definition
Fixed Value: format
..... value[x] C 1..1 string If parameter is a data type
.... parameter:compatibilityLevel 0..1 BackboneElement What compatibility level
..... name 1..1 string Name from the definition
Fixed Value: compatibilityLevel
..... value[x] 1..1 string If parameter is a data type
.... parameter:enableCqlOnly 0..1 BackboneElement Include CQL only?
..... name 1..1 string Name from the definition
Fixed Value: enableCqlOnly
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:errorLevel C 0..1 BackboneElement What error level
Constraints: cop-3
..... name 1..1 string Name from the definition
Fixed Value: errorLevel
..... value[x] C 1..1 string If parameter is a data type
.... parameter:validateUnits 0..1 BackboneElement Validate UCUM units?
..... name 1..1 string Name from the definition
Fixed Value: validateUnits
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:verifyOnly 0..1 BackboneElement Verify only
..... name 1..1 string Name from the definition
Fixed Value: verifyOnly
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:analyzeDataRequirements 0..1 BackboneElement Analyze data requirements?
..... name 1..1 string Name from the definition
Fixed Value: analyzeDataRequirements
..... value[x] 1..1 boolean If parameter is a data type
.... parameter:collapseDataRequirements 0..1 BackboneElement Collapse data requirements?
..... name 1..1 string Name from the definition
Fixed Value: collapseDataRequirements
..... value[x] 1..1 boolean If parameter is a data type

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
cop-1 error Parameters.parameter:signatureLevel SignatureLevel parameter must be None, Differing, Overloads, or All value in ( 'None' | 'Differing' | 'Overloads' | 'All' )
cop-2 error Parameters.parameter:format Format parameter must be XML or JSON value in ( 'XML' | 'JSON' )
cop-3 error Parameters.parameter:errorLevel ErrorLevel parameter must be Info, Warning, or Error value in ( 'Info' | 'Warning' | 'Error' )

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
Constraints: inv-1
.... 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:enableAnnotations ΣC 0..1 BackboneElement Include annotations?
Constraints: inv-1
..... 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: enableAnnotations
..... value[x] ΣC 1..1 boolean 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:enableLocators ΣC 0..1 BackboneElement Include locators?
Constraints: inv-1
..... 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: enableLocators
..... value[x] ΣC 1..1 boolean 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:disableListDemotion ΣC 0..1 BackboneElement Implicitly convert lists to singletons when possible?
Constraints: inv-1
..... 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: disableListDemotion
..... value[x] ΣC 1..1 boolean 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:disableListPromotion ΣC 0..1 BackboneElement Implicitly convert singletons to lists when possible?
Constraints: inv-1
..... 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: disableListPromotion
..... value[x] ΣC 1..1 boolean 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:disableMethodInvocation ΣC 0..1 BackboneElement Disable method-style invocation?
Constraints: inv-1
..... 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: disableMethodInvocation
..... value[x] ΣC 1..1 boolean 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:enableDateRangeOptimization ΣC 0..1 BackboneElement Optimize date ranges when possible?
Constraints: inv-1
..... 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: enableDateRangeOptimization
..... value[x] ΣC 1..1 boolean 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:enableResultTypes ΣC 0..1 BackboneElement Include result types?
Constraints: inv-1
..... 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: enableResultTypes
..... value[x] ΣC 1..1 boolean 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:enableDetailedErrors ΣC 0..1 BackboneElement Include detailed errors?
Constraints: inv-1
..... 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: enableDetailedErrors
..... value[x] ΣC 1..1 boolean 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:disableListTraversal ΣC 0..1 BackboneElement Disallow list traversal?
Constraints: inv-1
..... 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: disableListTraversal
..... value[x] ΣC 1..1 boolean 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:signatureLevel ΣC 0..1 BackboneElement Include signatures?
Constraints: inv-1, cop-1
..... 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: signatureLevel
..... 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:translatorVersion ΣC 0..1 BackboneElement What version
Constraints: inv-1
..... 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: translatorVersion
..... 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:format ΣC 0..2 BackboneElement What format (XML and/or JSON)
Constraints: inv-1, cop-2
..... 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: format
..... 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:compatibilityLevel ΣC 0..1 BackboneElement What compatibility level
Constraints: inv-1
..... 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: compatibilityLevel
..... 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:enableCqlOnly ΣC 0..1 BackboneElement Include CQL only?
Constraints: inv-1
..... 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: enableCqlOnly
..... value[x] ΣC 1..1 boolean 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:errorLevel ΣC 0..1 BackboneElement What error level
Constraints: inv-1, cop-3
..... 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: errorLevel
..... 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:validateUnits ΣC 0..1 BackboneElement Validate UCUM units?
Constraints: inv-1
..... 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: validateUnits
..... value[x] ΣC 1..1 boolean 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:verifyOnly ΣC 0..1 BackboneElement Verify only
Constraints: inv-1
..... 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: verifyOnly
..... value[x] ΣC 1..1 boolean 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:analyzeDataRequirements ΣC 0..1 BackboneElement Analyze data requirements?
Constraints: inv-1
..... 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: analyzeDataRequirements
..... value[x] ΣC 1..1 boolean 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:collapseDataRequirements ΣC 0..1 BackboneElement Collapse data requirements?
Constraints: inv-1
..... 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: collapseDataRequirements
..... value[x] ΣC 1..1 boolean 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

Path Status Usage ValueSet Version Source
Parameters.language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cop-1 error Parameters.parameter:signatureLevel SignatureLevel parameter must be None, Differing, Overloads, or All value in ( 'None' | 'Differing' | 'Overloads' | 'All' )
cop-2 error Parameters.parameter:format Format parameter must be XML or JSON value in ( 'XML' | 'JSON' )
cop-3 error Parameters.parameter:errorLevel ErrorLevel parameter must be Info, Warning, or Error value in ( 'Info' | 'Warning' | 'Error' )
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-1 error Parameters.parameter, Parameters.parameter:enableAnnotations, Parameters.parameter:enableLocators, Parameters.parameter:disableListDemotion, Parameters.parameter:disableListPromotion, Parameters.parameter:disableMethodInvocation, Parameters.parameter:enableDateRangeOptimization, Parameters.parameter:enableResultTypes, Parameters.parameter:enableDetailedErrors, Parameters.parameter:disableListTraversal, Parameters.parameter:signatureLevel, Parameters.parameter:translatorVersion, Parameters.parameter:format, Parameters.parameter:compatibilityLevel, Parameters.parameter:enableCqlOnly, Parameters.parameter:errorLevel, Parameters.parameter:validateUnits, Parameters.parameter:verifyOnly, Parameters.parameter:analyzeDataRequirements, Parameters.parameter:collapseDataRequirements A 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()))

Summary

Mandatory: 0 element(19 nested mandatory elements)
Fixed: 19 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