Patient Demographics Query for Mobile (PDQm)
3.0.0 - Trial-Implementation
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
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Parameters
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Parameters | 0..* | Parameters | Operation Request or Response | |
implicitRules | 0..0 | |||
Slices for parameter | 1..3 | BackboneElement | Operation Parameter Slice: Unordered, Closed by value:name | |
parameter:All Slices | Content/Rules for all slices | |||
modifierExtension | 0..0 | |||
parameter:resource | 1..1 | BackboneElement | Operation Parameter | |
modifierExtension | 0..0 | |||
name | 1..1 | string | Name from the definition Required Pattern: resource | |
value[x] | 0..0 | |||
resource | 1..1 | PDQmMatchInput | Information about an individual or animal receiving health care services | |
part | 0..0 | |||
parameter:onlyCertainMatches | 0..1 | BackboneElement | Operation Parameter | |
modifierExtension | 0..0 | |||
name | 1..1 | string | Name from the definition Required Pattern: onlyCertainMatches | |
value[x] | 1..1 | boolean | If parameter is a data type | |
resource | 0..0 | |||
part | 0..0 | |||
parameter:count | 0..1 | BackboneElement | Operation Parameter | |
modifierExtension | 0..0 | |||
name | 1..1 | string | Name from the definition Required Pattern: count | |
value[x] | 1..1 | integer | If parameter is a data type | |
resource | 0..0 | |||
part | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Parameters | 0..* | Parameters | Operation Request or Response | |
Slices for parameter | ΣC | 1..3 | BackboneElement | Operation Parameter Slice: Unordered, Closed by value:name |
parameter:All Slices | Content/Rules for all slices | |||
name | Σ | 1..1 | string | Name from the definition |
parameter:resource | ΣC | 1..1 | BackboneElement | Operation Parameter |
name | Σ | 1..1 | string | Name from the definition Required Pattern: resource |
resource | 1..1 | PDQmMatchInput | Information about an individual or animal receiving health care services | |
parameter:onlyCertainMatches | ΣC | 0..1 | BackboneElement | Operation Parameter |
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 |
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 |
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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
Slices for parameter | ΣC | 1..3 | BackboneElement | Operation Parameter Slice: Unordered, Closed by value:name | ||||
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 | ||||
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 | PDQmMatchInput | Information about an individual or animal receiving health care services | |||||
parameter:onlyCertainMatches | ΣC | 0..1 | BackboneElement | Operation Parameter | ||||
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 | ||||
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 |
Path | Conformance | ValueSet | URI | |||
Parameters.language | preferred | CommonLanguages
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:
Differential View
This structure is derived from Parameters
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Parameters | 0..* | Parameters | Operation Request or Response | |
implicitRules | 0..0 | |||
Slices for parameter | 1..3 | BackboneElement | Operation Parameter Slice: Unordered, Closed by value:name | |
parameter:All Slices | Content/Rules for all slices | |||
modifierExtension | 0..0 | |||
parameter:resource | 1..1 | BackboneElement | Operation Parameter | |
modifierExtension | 0..0 | |||
name | 1..1 | string | Name from the definition Required Pattern: resource | |
value[x] | 0..0 | |||
resource | 1..1 | PDQmMatchInput | Information about an individual or animal receiving health care services | |
part | 0..0 | |||
parameter:onlyCertainMatches | 0..1 | BackboneElement | Operation Parameter | |
modifierExtension | 0..0 | |||
name | 1..1 | string | Name from the definition Required Pattern: onlyCertainMatches | |
value[x] | 1..1 | boolean | If parameter is a data type | |
resource | 0..0 | |||
part | 0..0 | |||
parameter:count | 0..1 | BackboneElement | Operation Parameter | |
modifierExtension | 0..0 | |||
name | 1..1 | string | Name from the definition Required Pattern: count | |
value[x] | 1..1 | integer | If parameter is a data type | |
resource | 0..0 | |||
part | 0..0 | |||
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Parameters | 0..* | Parameters | Operation Request or Response | |
Slices for parameter | ΣC | 1..3 | BackboneElement | Operation Parameter Slice: Unordered, Closed by value:name |
parameter:All Slices | Content/Rules for all slices | |||
name | Σ | 1..1 | string | Name from the definition |
parameter:resource | ΣC | 1..1 | BackboneElement | Operation Parameter |
name | Σ | 1..1 | string | Name from the definition Required Pattern: resource |
resource | 1..1 | PDQmMatchInput | Information about an individual or animal receiving health care services | |
parameter:onlyCertainMatches | ΣC | 0..1 | BackboneElement | Operation Parameter |
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 |
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 |
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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
Slices for parameter | ΣC | 1..3 | BackboneElement | Operation Parameter Slice: Unordered, Closed by value:name | ||||
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 | ||||
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 | PDQmMatchInput | Information about an individual or animal receiving health care services | |||||
parameter:onlyCertainMatches | ΣC | 0..1 | BackboneElement | Operation Parameter | ||||
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 | ||||
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 |
Path | Conformance | ValueSet | URI | |||
Parameters.language | preferred | CommonLanguages
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:
Other representations of profile: CSV, Excel, Schematron