This page is part of the CH EPR FHIR (R4) (v4.0.1: DSTU 4) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

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

Resource Profile: CH PDQm Match Input Parameters Profile

The PDQm Match Input Parameters Profile describes the Parameters Resource that is to be posted to the $match endpoint when invoking ITI-119. This profile is consistent with the exceptions of the Patient-match operation in FHIR core, except the input resource SHALL be an instance of the PDQm Patient Profile for $match Input.

Note that the only REQUIRED parameter is the Patient Resource. When only the Patient is supplied, it can be POSTed directly to the $match endpoint without being wrapped in a Parameters Resource, as long as it conforms to the PDQm Patient Profile for $match Input.

Usage:

• This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

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

This structure is derived from MatchParametersIn

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	MatchParametersIn	Operation Request or Response
Slices for parameter				Content/Rules for all slices
parameter:resource		1..1	BackboneElement	Operation Parameter
resource		1..1	CHPDQmMatchInput	Information about an individual or animal receiving health care services
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	MatchParametersIn	Operation Request or Response
Slices for parameter	ΣC	1..3	BackboneElement	Operation Parameter Slice: Unordered, Closed by value:name ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
parameter:All Slices				Content/Rules for all slices
name	Σ	1..1	string	Name from the definition ele-1: All FHIR elements must have a @value or children
parameter:resource	ΣC	1..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)
name	Σ	1..1	string	Name from the definition ele-1: All FHIR elements must have a @value or children Required Pattern: resource
resource		1..1	CHPDQmMatchInput	Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
parameter:onlyCertainMatches	ΣC	0..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)
name	Σ	1..1	string	Name from the definition ele-1: All FHIR elements must have a @value or children Required Pattern: onlyCertainMatches
value[x]	ΣC	1..1	boolean	If parameter is a data type ele-1: All FHIR elements must have a @value or children
parameter:count	ΣC	0..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)
name	Σ	1..1	string	Name from the definition ele-1: All FHIR elements must have a @value or children Required Pattern: count
value[x]	ΣC	1..1	integer	If parameter is a data type ele-1: All FHIR elements must have a @value or children
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Parameters.parameter:resource.resource	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Parameters.parameter:resource.resource	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Parameters.parameter:resource.resource	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Parameters.parameter:resource.resource	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Parameters.parameter:resource.resource	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
inv-1	error	Parameters.parameter, Parameters.parameter:resource, Parameters.parameter:onlyCertainMatches, Parameters.parameter:count	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()))

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	MatchParametersIn	Operation Request or Response
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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	1..3	BackboneElement	Operation Parameter Slice: Unordered, Closed by value:name inv-1: A parameter must have one and only one of (value, resource, part)
parameter:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
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:resource	ΣC	1..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
name	Σ	1..1	string	Name from the definition Required Pattern: resource
resource		1..1	CHPDQmMatchInput	Information about an individual or animal receiving health care services
parameter:onlyCertainMatches	ΣC	0..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
name	Σ	1..1	string	Name from the definition Required Pattern: onlyCertainMatches
value[x]	ΣC	1..1	boolean	If parameter is a data type
parameter:count	ΣC	0..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
name	Σ	1..1	string	Name from the definition Required Pattern: count
value[x]	ΣC	1..1	integer	If parameter is a data type
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
dom-2	error	Parameters.parameter:resource.resource	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Parameters.parameter:resource.resource	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Parameters.parameter:resource.resource	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Parameters.parameter:resource.resource	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Parameters.parameter:resource.resource	A resource should have narrative for robust management : text.`div`.exists()
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:resource, Parameters.parameter:onlyCertainMatches, Parameters.parameter:count	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 MatchParametersIn

Summary

Structures

This structure refers to these other structures:

• CH PDQm Patient Profile for $match Input (http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/CHPDQmMatchInput)

Differential View

This structure is derived from MatchParametersIn

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	MatchParametersIn	Operation Request or Response
Slices for parameter				Content/Rules for all slices
parameter:resource		1..1	BackboneElement	Operation Parameter
resource		1..1	CHPDQmMatchInput	Information about an individual or animal receiving health care services
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	MatchParametersIn	Operation Request or Response
Slices for parameter	ΣC	1..3	BackboneElement	Operation Parameter Slice: Unordered, Closed by value:name ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
parameter:All Slices				Content/Rules for all slices
name	Σ	1..1	string	Name from the definition ele-1: All FHIR elements must have a @value or children
parameter:resource	ΣC	1..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)
name	Σ	1..1	string	Name from the definition ele-1: All FHIR elements must have a @value or children Required Pattern: resource
resource		1..1	CHPDQmMatchInput	Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
parameter:onlyCertainMatches	ΣC	0..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)
name	Σ	1..1	string	Name from the definition ele-1: All FHIR elements must have a @value or children Required Pattern: onlyCertainMatches
value[x]	ΣC	1..1	boolean	If parameter is a data type ele-1: All FHIR elements must have a @value or children
parameter:count	ΣC	0..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)
name	Σ	1..1	string	Name from the definition ele-1: All FHIR elements must have a @value or children Required Pattern: count
value[x]	ΣC	1..1	integer	If parameter is a data type ele-1: All FHIR elements must have a @value or children
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Parameters.parameter:resource.resource	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Parameters.parameter:resource.resource	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Parameters.parameter:resource.resource	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Parameters.parameter:resource.resource	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Parameters.parameter:resource.resource	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
inv-1	error	Parameters.parameter, Parameters.parameter:resource, Parameters.parameter:onlyCertainMatches, Parameters.parameter:count	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()))

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	MatchParametersIn	Operation Request or Response
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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	1..3	BackboneElement	Operation Parameter Slice: Unordered, Closed by value:name inv-1: A parameter must have one and only one of (value, resource, part)
parameter:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
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:resource	ΣC	1..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
name	Σ	1..1	string	Name from the definition Required Pattern: resource
resource		1..1	CHPDQmMatchInput	Information about an individual or animal receiving health care services
parameter:onlyCertainMatches	ΣC	0..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
name	Σ	1..1	string	Name from the definition Required Pattern: onlyCertainMatches
value[x]	ΣC	1..1	boolean	If parameter is a data type
parameter:count	ΣC	0..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
name	Σ	1..1	string	Name from the definition Required Pattern: count
value[x]	ΣC	1..1	integer	If parameter is a data type
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
dom-2	error	Parameters.parameter:resource.resource	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Parameters.parameter:resource.resource	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Parameters.parameter:resource.resource	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Parameters.parameter:resource.resource	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Parameters.parameter:resource.resource	A resource should have narrative for robust management : text.`div`.exists()
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:resource, Parameters.parameter:onlyCertainMatches, Parameters.parameter:count	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 MatchParametersIn

Summary

Structures

This structure refers to these other structures:

• CH PDQm Patient Profile for $match Input (http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/CHPDQmMatchInput)

Other representations of profile: CSV, Excel, Schematron