Patient Demographics Query for Mobile (PDQm)
3.0.0 - Trial-Implementation International flag

This page is part of the IHE Patient Demographics Query for Mobile (v3.0.0: Publication) 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

Resource Profile: PDQm Match Input Parameters Profile

Official URL: https://profiles.ihe.net/ITI/PDQm/StructureDefinition/IHE.PDQm.MatchParametersIn Version: 3.0.0
Active as of 2024-02-23 Computable Name: MatchParametersIn

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 expections 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:

Formal Views of Profile Content

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

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... implicitRules 0..0
... Slices for parameter 1..3BackboneElementOperation Parameter
Slice: Unordered, Closed by value:name
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension 0..0
.... parameter:resource 1..1BackboneElementOperation Parameter
..... modifierExtension 0..0
..... name 1..1stringName from the definition
Required Pattern: resource
..... value[x] 0..0
..... resource 1..1PDQmMatchInputInformation about an individual or animal receiving health care services
..... part 0..0
.... parameter:onlyCertainMatches 0..1BackboneElementOperation Parameter
..... modifierExtension 0..0
..... name 1..1stringName from the definition
Required Pattern: onlyCertainMatches
..... value[x] 1..1booleanIf parameter is a data type
..... resource 0..0
..... part 0..0
.... parameter:count 0..1BackboneElementOperation Parameter
..... modifierExtension 0..0
..... name 1..1stringName from the definition
Required Pattern: count
..... value[x] 1..1integerIf parameter is a data type
..... resource 0..0
..... part 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... Slices for parameter ΣC1..3BackboneElementOperation Parameter
Slice: Unordered, Closed by value:name
.... parameter:All Slices Content/Rules for all slices
..... name Σ1..1stringName from the definition
.... parameter:resource ΣC1..1BackboneElementOperation Parameter
..... name Σ1..1stringName from the definition
Required Pattern: resource
..... resource 1..1PDQmMatchInputInformation about an individual or animal receiving health care services
.... parameter:onlyCertainMatches ΣC0..1BackboneElementOperation Parameter
..... name Σ1..1stringName from the definition
Required Pattern: onlyCertainMatches
..... value[x] ΣC1..1booleanIf parameter is a data type
.... parameter:count ΣC0..1BackboneElementOperation Parameter
..... name Σ1..1stringName from the definition
Required Pattern: count
..... value[x] ΣC1..1integerIf parameter is a data type

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... Slices for parameter ΣC1..3BackboneElementOperation Parameter
Slice: Unordered, Closed by value:name
.... parameter:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... name Σ1..1stringName from the definition
..... value[x] ΣC0..1If parameter is a data type
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:resource ΣC1..1BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... name Σ1..1stringName from the definition
Required Pattern: resource
..... resource 1..1PDQmMatchInputInformation about an individual or animal receiving health care services
.... parameter:onlyCertainMatches ΣC0..1BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... name Σ1..1stringName from the definition
Required Pattern: onlyCertainMatches
..... value[x] ΣC1..1booleanIf parameter is a data type
.... parameter:count ΣC0..1BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... name Σ1..1stringName from the definition
Required Pattern: count
..... value[x] ΣC1..1integerIf parameter is a data type

doco Documentation for this format

Terminology Bindings

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

This structure is derived from Parameters

Summary

Mandatory: 3 elements (2 nested mandatory elements)
Prohibited: 11 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Parameters.parameter is sliced based on the value of value:name (Closed)

Differential View

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... implicitRules 0..0
... Slices for parameter 1..3BackboneElementOperation Parameter
Slice: Unordered, Closed by value:name
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension 0..0
.... parameter:resource 1..1BackboneElementOperation Parameter
..... modifierExtension 0..0
..... name 1..1stringName from the definition
Required Pattern: resource
..... value[x] 0..0
..... resource 1..1PDQmMatchInputInformation about an individual or animal receiving health care services
..... part 0..0
.... parameter:onlyCertainMatches 0..1BackboneElementOperation Parameter
..... modifierExtension 0..0
..... name 1..1stringName from the definition
Required Pattern: onlyCertainMatches
..... value[x] 1..1booleanIf parameter is a data type
..... resource 0..0
..... part 0..0
.... parameter:count 0..1BackboneElementOperation Parameter
..... modifierExtension 0..0
..... name 1..1stringName from the definition
Required Pattern: count
..... value[x] 1..1integerIf parameter is a data type
..... resource 0..0
..... part 0..0

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... Slices for parameter ΣC1..3BackboneElementOperation Parameter
Slice: Unordered, Closed by value:name
.... parameter:All Slices Content/Rules for all slices
..... name Σ1..1stringName from the definition
.... parameter:resource ΣC1..1BackboneElementOperation Parameter
..... name Σ1..1stringName from the definition
Required Pattern: resource
..... resource 1..1PDQmMatchInputInformation about an individual or animal receiving health care services
.... parameter:onlyCertainMatches ΣC0..1BackboneElementOperation Parameter
..... name Σ1..1stringName from the definition
Required Pattern: onlyCertainMatches
..... value[x] ΣC1..1booleanIf parameter is a data type
.... parameter:count ΣC0..1BackboneElementOperation Parameter
..... name Σ1..1stringName from the definition
Required Pattern: count
..... value[x] ΣC1..1integerIf parameter is a data type

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... Slices for parameter ΣC1..3BackboneElementOperation Parameter
Slice: Unordered, Closed by value:name
.... parameter:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... name Σ1..1stringName from the definition
..... value[x] ΣC0..1If parameter is a data type
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:resource ΣC1..1BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... name Σ1..1stringName from the definition
Required Pattern: resource
..... resource 1..1PDQmMatchInputInformation about an individual or animal receiving health care services
.... parameter:onlyCertainMatches ΣC0..1BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... name Σ1..1stringName from the definition
Required Pattern: onlyCertainMatches
..... value[x] ΣC1..1booleanIf parameter is a data type
.... parameter:count ΣC0..1BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... name Σ1..1stringName from the definition
Required Pattern: count
..... value[x] ΣC1..1integerIf parameter is a data type

doco Documentation for this format

Terminology Bindings

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

This structure is derived from Parameters

Summary

Mandatory: 3 elements (2 nested mandatory elements)
Prohibited: 11 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Parameters.parameter is sliced based on the value of value:name (Closed)

 

Other representations of profile: CSV, Excel, Schematron