FHIR Application Feature Framework Implementation Guide, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/capstmt/ and changes regularly. See the Directory of published versions

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

Resource Profile: Feature Query Input Parameters

The Parameters profile used to define the inputs of the $feature-query operation.

Usage:

• Examples for this Resource Profile: Parameters/FeatureQueryInputParametersExample

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
Parameters		0..*	Parameters	Operation Request or Response
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
parameter	SΣC	1..*	BackboneElement	Operation Parameter ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	SΣ	1..1	string	Name from the definition ele-1: All FHIR elements must have a @value or children Required Pattern: feature
Slices for part	SΣC	1..*	See parameter (Parameters)	Named part of a multi-part parameter Slice: Unordered, Open by pattern:$this.name ele-1: All FHIR elements must have a @value or children
part:name	SΣC	1..1	BackboneElement	Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	SΣ	1..1	string	Name from the definition ele-1: All FHIR elements must have a @value or children Required Pattern: name
value[x]	SΣC	1..1	uri	The name of the feature. If not a core FHIR feature, must be a fully qualified URI ele-1: All FHIR elements must have a @value or children
part:context	SΣC	0..1	BackboneElement	Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	SΣ	1..1	string	Name from the definition ele-1: All FHIR elements must have a @value or children Required Pattern: context
value[x]	SΣC	1..1	string	An expression showing the context of the feature in the CapabilityStatement ele-1: All FHIR elements must have a @value or children
part:value	SΣC	0..1	BackboneElement	Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	SΣ	1..1	string	Name from the definition ele-1: All FHIR elements must have a @value or children Required Pattern: value
value[x]	SΣC	1..1		The expected value of the feature. To query for multiple values, supply multiple parameter elements. ele-1: All FHIR elements must have a @value or children
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
valueCodeableConcept			CodeableConcept
valueCoding			Coding
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	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
Parameters		0..*	Parameters	Operation Request or Response
parameter	S	1..*	BackboneElement	Operation Parameter
name	S	1..1	string	Name from the definition Required Pattern: feature
Slices for part	S	1..*		Named part of a multi-part parameter Slice: Unordered, Open by pattern:$this.name
part:name	S	1..1	BackboneElement	Named part of a multi-part parameter
name	S	1..1	string	Name from the definition Required Pattern: name
value[x]	S	1..1	uri	The name of the feature. If not a core FHIR feature, must be a fully qualified URI
part:context	S	0..1	BackboneElement	Named part of a multi-part parameter
name	S	1..1	string	Name from the definition Required Pattern: context
value[x]	S	1..1	string	An expression showing the context of the feature in the CapabilityStatement
part:value	S	0..1	BackboneElement	Named part of a multi-part parameter
name	S	1..1	string	Name from the definition Required Pattern: value
value[x]	S	1..1		The expected value of the feature. To query for multiple values, supply multiple parameter elements.
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
valueCodeableConcept			CodeableConcept
valueCoding			Coding
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
parameter	SΣC	1..*	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	SΣ	1..1	string	Name from the definition Required Pattern: feature
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
valueInteger64			integer64
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
valueCodeableReference			CodeableReference
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueRatioRange			RatioRange
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueAvailability			Availability
valueExtendedContactDetail			ExtendedContactDetail
valueDosage			Dosage
valueMeta			Meta
resource	ΣC	0..1	Resource	If parameter is a whole resource
Slices for part	SΣC	1..*	See parameter (Parameters)	Named part of a multi-part parameter Slice: Unordered, Open by pattern:$this.name
part:name	SΣC	1..1	BackboneElement	Named part of a multi-part parameter
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	SΣ	1..1	string	Name from the definition Required Pattern: name
value[x]	SΣC	1..1	uri	The name of the feature. If not a core FHIR feature, must be a fully qualified URI
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	ΣC	0..*	See parameter (Parameters)	Named part of a multi-part parameter
part:context	SΣC	0..1	BackboneElement	Named part of a multi-part parameter
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	SΣ	1..1	string	Name from the definition Required Pattern: context
value[x]	SΣC	1..1	string	An expression showing the context of the feature in the CapabilityStatement
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	ΣC	0..*	See parameter (Parameters)	Named part of a multi-part parameter
part:value	SΣC	0..1	BackboneElement	Named part of a multi-part parameter
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	SΣ	1..1	string	Name from the definition Required Pattern: value
value[x]	SΣC	1..1		The expected value of the feature. To query for multiple values, supply multiple parameter elements.
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
valueCodeableConcept			CodeableConcept
valueCoding			Coding
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	ΣC	0..*	See parameter (Parameters)	Named part of a multi-part parameter
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Parameters.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard

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	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: 4 elements(2 nested mandatory elements)
Must-Support: 12 elements

Slices

This structure defines the following Slices:

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

Maturity: 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	Parameters	Operation Request or Response
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
parameter	SΣC	1..*	BackboneElement	Operation Parameter ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	SΣ	1..1	string	Name from the definition ele-1: All FHIR elements must have a @value or children Required Pattern: feature
Slices for part	SΣC	1..*	See parameter (Parameters)	Named part of a multi-part parameter Slice: Unordered, Open by pattern:$this.name ele-1: All FHIR elements must have a @value or children
part:name	SΣC	1..1	BackboneElement	Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	SΣ	1..1	string	Name from the definition ele-1: All FHIR elements must have a @value or children Required Pattern: name
value[x]	SΣC	1..1	uri	The name of the feature. If not a core FHIR feature, must be a fully qualified URI ele-1: All FHIR elements must have a @value or children
part:context	SΣC	0..1	BackboneElement	Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	SΣ	1..1	string	Name from the definition ele-1: All FHIR elements must have a @value or children Required Pattern: context
value[x]	SΣC	1..1	string	An expression showing the context of the feature in the CapabilityStatement ele-1: All FHIR elements must have a @value or children
part:value	SΣC	0..1	BackboneElement	Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	SΣ	1..1	string	Name from the definition ele-1: All FHIR elements must have a @value or children Required Pattern: value
value[x]	SΣC	1..1		The expected value of the feature. To query for multiple values, supply multiple parameter elements. ele-1: All FHIR elements must have a @value or children
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
valueCodeableConcept			CodeableConcept
valueCoding			Coding
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	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
Parameters		0..*	Parameters	Operation Request or Response
parameter	S	1..*	BackboneElement	Operation Parameter
name	S	1..1	string	Name from the definition Required Pattern: feature
Slices for part	S	1..*		Named part of a multi-part parameter Slice: Unordered, Open by pattern:$this.name
part:name	S	1..1	BackboneElement	Named part of a multi-part parameter
name	S	1..1	string	Name from the definition Required Pattern: name
value[x]	S	1..1	uri	The name of the feature. If not a core FHIR feature, must be a fully qualified URI
part:context	S	0..1	BackboneElement	Named part of a multi-part parameter
name	S	1..1	string	Name from the definition Required Pattern: context
value[x]	S	1..1	string	An expression showing the context of the feature in the CapabilityStatement
part:value	S	0..1	BackboneElement	Named part of a multi-part parameter
name	S	1..1	string	Name from the definition Required Pattern: value
value[x]	S	1..1		The expected value of the feature. To query for multiple values, supply multiple parameter elements.
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
valueCodeableConcept			CodeableConcept
valueCoding			Coding
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
parameter	SΣC	1..*	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	SΣ	1..1	string	Name from the definition Required Pattern: feature
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
valueInteger64			integer64
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
valueCodeableReference			CodeableReference
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueRatioRange			RatioRange
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueAvailability			Availability
valueExtendedContactDetail			ExtendedContactDetail
valueDosage			Dosage
valueMeta			Meta
resource	ΣC	0..1	Resource	If parameter is a whole resource
Slices for part	SΣC	1..*	See parameter (Parameters)	Named part of a multi-part parameter Slice: Unordered, Open by pattern:$this.name
part:name	SΣC	1..1	BackboneElement	Named part of a multi-part parameter
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	SΣ	1..1	string	Name from the definition Required Pattern: name
value[x]	SΣC	1..1	uri	The name of the feature. If not a core FHIR feature, must be a fully qualified URI
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	ΣC	0..*	See parameter (Parameters)	Named part of a multi-part parameter
part:context	SΣC	0..1	BackboneElement	Named part of a multi-part parameter
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	SΣ	1..1	string	Name from the definition Required Pattern: context
value[x]	SΣC	1..1	string	An expression showing the context of the feature in the CapabilityStatement
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	ΣC	0..*	See parameter (Parameters)	Named part of a multi-part parameter
part:value	SΣC	0..1	BackboneElement	Named part of a multi-part parameter
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	SΣ	1..1	string	Name from the definition Required Pattern: value
value[x]	SΣC	1..1		The expected value of the feature. To query for multiple values, supply multiple parameter elements.
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
valueCodeableConcept			CodeableConcept
valueCoding			Coding
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	ΣC	0..*	See parameter (Parameters)	Named part of a multi-part parameter
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Parameters.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard

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	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: 4 elements(2 nested mandatory elements)
Must-Support: 12 elements

Slices

This structure defines the following Slices:

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

Maturity: 1

Other representations of profile: CSV, Excel, Schematron