This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v2.0.0-ballot: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 1.0.0. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON

Resource Profile: CRMI Manifest Parameters

The CRMI Manifest Parameters Profile defines the expected parameters used for representing version-pinning.

Usages:

• Refer to this Profile: CRMI ImplementationGuide and CRMI Manifest Library
• Examples for this Profile: Parameters/manifestparameters-example

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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:includeDefinition	ΣC	0..1	BackboneElement	Include definition? Constraints: inv-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Fixed Value: includeDefinition
value[x]	ΣC	1..1	boolean	If parameter is a data type
parameter:activeOnly	ΣC	0..1	BackboneElement	Only include active codes? Constraints: inv-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Fixed Value: activeOnly
value[x]	ΣC	1..1	boolean	If parameter is a data type
parameter:includeDraft	ΣC	0..1	BackboneElement	Include unreleased content? Constraints: inv-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Fixed Value: includeDraft
value[x]	ΣC	1..1	boolean	If parameter is a data type
parameter:lastActiveVersion	ΣC	0..1	BackboneElement	Indicate last active 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: lastActiveVersion
value[x]	ΣC	1..1	boolean	If parameter is a data type
parameter:system-version	ΣC	0..*	BackboneElement	Code system version (deprecated, use default-system-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: system-version
value[x]	ΣC	1..1	canonical()	If parameter is a data type
Slices for extension				Content/Rules for all slices
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
parameter:default-system-version	ΣC	0..*	BackboneElement	Code system 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: default-system-version
value[x]	ΣC	1..1	canonical()	If parameter is a data type
Slices for extension				Content/Rules for all slices
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
parameter:default-valueset-version	ΣC	0..*	BackboneElement	Value set 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: default-valueset-version
value[x]	ΣC	1..1	canonical()	If parameter is a data type
Slices for extension				Content/Rules for all slices
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
parameter:canonicalVersion	ΣC	0..*	BackboneElement	Canonical version (deprecated, use default-canonical-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: canonicalVersion
value[x]	ΣC	1..1	canonical()	If parameter is a data type
Slices for extension				Content/Rules for all slices
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
extension:resourceType		0..1	code	What type of resource URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required)
parameter:default-canonical-version	ΣC	0..*	BackboneElement	Canonical 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: default-canonical-version
value[x]	ΣC	1..1	canonical()	If parameter is a data type
Slices for extension				Content/Rules for all slices
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
extension:uriReference		0..1	uri	Uri for non-canonical artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
extension:resourceType		0..1	code	What type of resource URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required)
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
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:includeDefinition, Parameters.parameter:activeOnly, Parameters.parameter:includeDraft, Parameters.parameter:lastActiveVersion, Parameters.parameter:system-version, Parameters.parameter:default-system-version, Parameters.parameter:default-valueset-version, Parameters.parameter:canonicalVersion, Parameters.parameter:default-canonical-version	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()))

This structure is derived from Parameters

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Parameters		0..*	Parameters	Operation Request or Response
Slices for parameter		0..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name
parameter:includeDefinition		0..1	BackboneElement	Include definition?
name		1..1	string	Name from the definition Fixed Value: includeDefinition
value[x]		1..1	boolean	If parameter is a data type
parameter:activeOnly		0..1	BackboneElement	Only include active codes?
name		1..1	string	Name from the definition Fixed Value: activeOnly
value[x]		1..1	boolean	If parameter is a data type
parameter:includeDraft		0..1	BackboneElement	Include unreleased content?
name		1..1	string	Name from the definition Fixed Value: includeDraft
value[x]		1..1	boolean	If parameter is a data type
parameter:lastActiveVersion		0..1	BackboneElement	Indicate last active version?
name		1..1	string	Name from the definition Fixed Value: lastActiveVersion
value[x]		1..1	boolean	If parameter is a data type
parameter:system-version		0..*	BackboneElement	Code system version (deprecated, use default-system-version)
name		1..1	string	Name from the definition Fixed Value: system-version
value[x]		1..1	canonical()	If parameter is a data type
Slices for extension				Content/Rules for all slices
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
parameter:default-system-version		0..*	BackboneElement	Code system version
name		1..1	string	Name from the definition Fixed Value: default-system-version
value[x]		1..1	canonical()	If parameter is a data type
Slices for extension				Content/Rules for all slices
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
parameter:default-valueset-version		0..*	BackboneElement	Value set version
name		1..1	string	Name from the definition Fixed Value: default-valueset-version
value[x]		1..1	canonical()	If parameter is a data type
Slices for extension				Content/Rules for all slices
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
parameter:canonicalVersion		0..*	BackboneElement	Canonical version (deprecated, use default-canonical-version)
name		1..1	string	Name from the definition Fixed Value: canonicalVersion
value[x]		1..1	canonical()	If parameter is a data type
Slices for extension				Content/Rules for all slices
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
extension:resourceType		0..1	code	What type of resource URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required)
parameter:default-canonical-version		0..*	BackboneElement	Canonical version
name		1..1	string	Name from the definition Fixed Value: default-canonical-version
value[x]		1..1	canonical()	If parameter is a data type
Slices for extension				Content/Rules for all slices
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
extension:uriReference		0..1	uri	Uri for non-canonical artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
extension:resourceType		0..1	code	What type of resource URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required)
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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:includeDefinition	ΣC	0..1	BackboneElement	Include definition? 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: includeDefinition
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:activeOnly	ΣC	0..1	BackboneElement	Only include active codes? 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: activeOnly
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:includeDraft	ΣC	0..1	BackboneElement	Include unreleased content? 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: includeDraft
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:lastActiveVersion	ΣC	0..1	BackboneElement	Indicate last active 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: lastActiveVersion
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:system-version	ΣC	0..*	BackboneElement	Code system version (deprecated, use default-system-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: system-version
value[x]	ΣC	1..1	canonical()	If parameter is a data type
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
value		0..1	string	Primitive value for canonical
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:default-system-version	ΣC	0..*	BackboneElement	Code system 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: default-system-version
value[x]	ΣC	1..1	canonical()	If parameter is a data type
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
value		0..1	string	Primitive value for canonical
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:default-valueset-version	ΣC	0..*	BackboneElement	Value set 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: default-valueset-version
value[x]	ΣC	1..1	canonical()	If parameter is a data type
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
value		0..1	string	Primitive value for canonical
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:canonicalVersion	ΣC	0..*	BackboneElement	Canonical version (deprecated, use default-canonical-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: canonicalVersion
value[x]	ΣC	1..1	canonical()	If parameter is a data type
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
extension:resourceType		0..1	code	What type of resource URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required)
value		0..1	string	Primitive value for canonical
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:default-canonical-version	ΣC	0..*	BackboneElement	Canonical 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: default-canonical-version
value[x]	ΣC	1..1	canonical()	If parameter is a data type
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
extension:uriReference		0..1	uri	Uri for non-canonical artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
extension:resourceType		0..1	code	What type of resource URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required)
value		0..1	string	Primitive value for canonical
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Parameters.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
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:includeDefinition, Parameters.parameter:activeOnly, Parameters.parameter:includeDraft, Parameters.parameter:lastActiveVersion, Parameters.parameter:system-version, Parameters.parameter:default-system-version, Parameters.parameter:default-valueset-version, Parameters.parameter:canonicalVersion, Parameters.parameter:default-canonical-version	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()))

This structure is derived from Parameters

Summary

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

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/display
• http://hl7.org/fhir/StructureDefinition/cqf-resourceType
• http://hl7.org/fhir/StructureDefinition/artifact-uriReference

Slices

This structure defines the following Slices:

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

Maturity: 3

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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:includeDefinition	ΣC	0..1	BackboneElement	Include definition? Constraints: inv-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Fixed Value: includeDefinition
value[x]	ΣC	1..1	boolean	If parameter is a data type
parameter:activeOnly	ΣC	0..1	BackboneElement	Only include active codes? Constraints: inv-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Fixed Value: activeOnly
value[x]	ΣC	1..1	boolean	If parameter is a data type
parameter:includeDraft	ΣC	0..1	BackboneElement	Include unreleased content? Constraints: inv-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Fixed Value: includeDraft
value[x]	ΣC	1..1	boolean	If parameter is a data type
parameter:lastActiveVersion	ΣC	0..1	BackboneElement	Indicate last active 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: lastActiveVersion
value[x]	ΣC	1..1	boolean	If parameter is a data type
parameter:system-version	ΣC	0..*	BackboneElement	Code system version (deprecated, use default-system-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: system-version
value[x]	ΣC	1..1	canonical()	If parameter is a data type
Slices for extension				Content/Rules for all slices
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
parameter:default-system-version	ΣC	0..*	BackboneElement	Code system 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: default-system-version
value[x]	ΣC	1..1	canonical()	If parameter is a data type
Slices for extension				Content/Rules for all slices
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
parameter:default-valueset-version	ΣC	0..*	BackboneElement	Value set 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: default-valueset-version
value[x]	ΣC	1..1	canonical()	If parameter is a data type
Slices for extension				Content/Rules for all slices
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
parameter:canonicalVersion	ΣC	0..*	BackboneElement	Canonical version (deprecated, use default-canonical-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: canonicalVersion
value[x]	ΣC	1..1	canonical()	If parameter is a data type
Slices for extension				Content/Rules for all slices
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
extension:resourceType		0..1	code	What type of resource URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required)
parameter:default-canonical-version	ΣC	0..*	BackboneElement	Canonical 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: default-canonical-version
value[x]	ΣC	1..1	canonical()	If parameter is a data type
Slices for extension				Content/Rules for all slices
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
extension:uriReference		0..1	uri	Uri for non-canonical artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
extension:resourceType		0..1	code	What type of resource URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required)
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
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:includeDefinition, Parameters.parameter:activeOnly, Parameters.parameter:includeDraft, Parameters.parameter:lastActiveVersion, Parameters.parameter:system-version, Parameters.parameter:default-system-version, Parameters.parameter:default-valueset-version, Parameters.parameter:canonicalVersion, Parameters.parameter:default-canonical-version	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

This structure is derived from Parameters

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Parameters		0..*	Parameters	Operation Request or Response
Slices for parameter		0..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name
parameter:includeDefinition		0..1	BackboneElement	Include definition?
name		1..1	string	Name from the definition Fixed Value: includeDefinition
value[x]		1..1	boolean	If parameter is a data type
parameter:activeOnly		0..1	BackboneElement	Only include active codes?
name		1..1	string	Name from the definition Fixed Value: activeOnly
value[x]		1..1	boolean	If parameter is a data type
parameter:includeDraft		0..1	BackboneElement	Include unreleased content?
name		1..1	string	Name from the definition Fixed Value: includeDraft
value[x]		1..1	boolean	If parameter is a data type
parameter:lastActiveVersion		0..1	BackboneElement	Indicate last active version?
name		1..1	string	Name from the definition Fixed Value: lastActiveVersion
value[x]		1..1	boolean	If parameter is a data type
parameter:system-version		0..*	BackboneElement	Code system version (deprecated, use default-system-version)
name		1..1	string	Name from the definition Fixed Value: system-version
value[x]		1..1	canonical()	If parameter is a data type
Slices for extension				Content/Rules for all slices
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
parameter:default-system-version		0..*	BackboneElement	Code system version
name		1..1	string	Name from the definition Fixed Value: default-system-version
value[x]		1..1	canonical()	If parameter is a data type
Slices for extension				Content/Rules for all slices
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
parameter:default-valueset-version		0..*	BackboneElement	Value set version
name		1..1	string	Name from the definition Fixed Value: default-valueset-version
value[x]		1..1	canonical()	If parameter is a data type
Slices for extension				Content/Rules for all slices
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
parameter:canonicalVersion		0..*	BackboneElement	Canonical version (deprecated, use default-canonical-version)
name		1..1	string	Name from the definition Fixed Value: canonicalVersion
value[x]		1..1	canonical()	If parameter is a data type
Slices for extension				Content/Rules for all slices
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
extension:resourceType		0..1	code	What type of resource URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required)
parameter:default-canonical-version		0..*	BackboneElement	Canonical version
name		1..1	string	Name from the definition Fixed Value: default-canonical-version
value[x]		1..1	canonical()	If parameter is a data type
Slices for extension				Content/Rules for all slices
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
extension:uriReference		0..1	uri	Uri for non-canonical artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
extension:resourceType		0..1	code	What type of resource URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required)
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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:includeDefinition	ΣC	0..1	BackboneElement	Include definition? 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: includeDefinition
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:activeOnly	ΣC	0..1	BackboneElement	Only include active codes? 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: activeOnly
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:includeDraft	ΣC	0..1	BackboneElement	Include unreleased content? 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: includeDraft
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:lastActiveVersion	ΣC	0..1	BackboneElement	Indicate last active 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: lastActiveVersion
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:system-version	ΣC	0..*	BackboneElement	Code system version (deprecated, use default-system-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: system-version
value[x]	ΣC	1..1	canonical()	If parameter is a data type
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
value		0..1	string	Primitive value for canonical
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:default-system-version	ΣC	0..*	BackboneElement	Code system 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: default-system-version
value[x]	ΣC	1..1	canonical()	If parameter is a data type
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
value		0..1	string	Primitive value for canonical
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:default-valueset-version	ΣC	0..*	BackboneElement	Value set 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: default-valueset-version
value[x]	ΣC	1..1	canonical()	If parameter is a data type
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
value		0..1	string	Primitive value for canonical
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:canonicalVersion	ΣC	0..*	BackboneElement	Canonical version (deprecated, use default-canonical-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: canonicalVersion
value[x]	ΣC	1..1	canonical()	If parameter is a data type
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
extension:resourceType		0..1	code	What type of resource URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required)
value		0..1	string	Primitive value for canonical
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:default-canonical-version	ΣC	0..*	BackboneElement	Canonical 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: default-canonical-version
value[x]	ΣC	1..1	canonical()	If parameter is a data type
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:display		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
extension:uriReference		0..1	uri	Uri for non-canonical artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
extension:resourceType		0..1	code	What type of resource URL: http://hl7.org/fhir/StructureDefinition/cqf-resourceType Binding: all-resource-types (??) (required)
value		0..1	string	Primitive value for canonical
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Parameters.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
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:includeDefinition, Parameters.parameter:activeOnly, Parameters.parameter:includeDraft, Parameters.parameter:lastActiveVersion, Parameters.parameter:system-version, Parameters.parameter:default-system-version, Parameters.parameter:default-valueset-version, Parameters.parameter:canonicalVersion, Parameters.parameter:default-canonical-version	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()))

This structure is derived from Parameters

Summary

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

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/display
• http://hl7.org/fhir/StructureDefinition/cqf-resourceType
• http://hl7.org/fhir/StructureDefinition/artifact-uriReference

Slices

This structure defines the following Slices:

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

Maturity: 3