FHIR Extensions Pack
5.3.0-ballot-tc1 - (September 2025 Ballot) International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.3.0-ballot-tc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

Extension: Bundle Match Grade

Official URL: http://hl7.org/fhir/StructureDefinition/match-grade Version: 5.3.0-ballot-tc1
Standards status: Trial-use Maturity Level: 3 Computable Name: BundleMatchGrade
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1154

Assessment of resource match outcome - how likely this resource is to be a match.

This extension is intended to supplement the search score with a coded value that can provide more discrete values than a numeric 'ordering' style score.

A score is not required to use the grade.

This is returned by the Patient $match operation (though could be used by similar operations on other resource types).

The codes 'probable' and 'possible' although similar, indicate the level of confidence the matching engine has that the result is a match. This could be through the number of matching fields, or other similar levels of certainty. Probable indicates that the match is likely, however possible indicates it had some partial matching data.

Context of Use

This extension may be used on the following element(s)

Usage info

Usages:

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

You can also check for usages in the FHIR IG Statistics

Changes since version 5.2.0:

  • The resource metadata has changed (description)
  • The data elements list has changed
  • One or more text definitions, invariants or bindings have changed

    • Formal Views of Extension Content

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

    This structure is derived from Extension

    Summary

    Simple Extension with the type code: Assessment of resource match outcome - how likely this resource is to be a match.

    This extension is intended to supplement the search score with a coded value that can provide more discrete values than a numeric 'ordering' style score.

    A score is not required to use the grade.

    This is returned by the Patient $match operation (though could be used by similar operations on other resource types).

    The codes 'probable' and 'possible' although similar, indicate the level of confidence the matching engine has that the result is a match. This could be through the number of matching fields, or other similar levels of certainty. Probable indicates that the match is likely, however possible indicates it had some partial matching data.

    Maturity: 3

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension How likely this resource is to be a match
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/match-grade"
    ... value[x] 1..1 code Value of extension
    Binding: MatchGrade (required): A Master Patient Index (MPI) assessment of whether a candidate patient record is a match or not.

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension How likely this resource is to be a match
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/match-grade"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension with the type code: Assessment of resource match outcome - how likely this resource is to be a match.

    This extension is intended to supplement the search score with a coded value that can provide more discrete values than a numeric 'ordering' style score.

    A score is not required to use the grade.

    This is returned by the Patient $match operation (though could be used by similar operations on other resource types).

    The codes 'probable' and 'possible' although similar, indicate the level of confidence the matching engine has that the result is a match. This could be through the number of matching fields, or other similar levels of certainty. Probable indicates that the match is likely, however possible indicates it had some partial matching data.

    Maturity: 3

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension How likely this resource is to be a match
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/match-grade"
    ... value[x] 1..1 code Value of extension
    Binding: MatchGrade (required): A Master Patient Index (MPI) assessment of whether a candidate patient record is a match or not.

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension How likely this resource is to be a match
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/match-grade"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    PathConformanceValueSetURI
    Extension.value[x]requiredMatchGrade(a valid code from match grade code system)
    http://hl7.org/fhir/ValueSet/match-grade
    From this IG

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    R4B

    The extension is not used in R4B

    • Duplicate Resource http://hl7.org/fhir/StructureDefinition/match-grade of type StructureDefinition (existing version 4.3.0, new version 5.3.0-ballot-tc1)

    R4

    The extension is not used in R4

    • Duplicate Resource http://hl7.org/fhir/StructureDefinition/match-grade of type StructureDefinition (existing version 4.0.1, new version 5.3.0-ballot-tc1)

    R3

    The extension is not used in R3

    • Duplicate Resource http://hl7.org/fhir/StructureDefinition/match-grade of type StructureDefinition (existing version null, new version 5.3.0-ballot-tc1)

    Search Parameters for this Extension

    (none found)