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

CapabilityStatement: PDQm Patient Demographics Supplier Actor Implementing Match Operation Option

Official URL: https://profiles.ihe.net/ITI/PDQm/CapabilityStatement/IHE.PDQm.PatientDemographicsSupplierMatch Version: 3.0.0
Active as of 2023-09-25 Computable Name: IHE_PDQM_PATIENT_DEMOGRAPHICS_SUPPLIER_Match

The PDQm Patient Demographics Supplier Actor (server) requirements CapabililtyStatement expresses the requirements that SHALL be provided. This capability statement implements the Match Operation Option.

  • Query against the FHIR endpoint to the Patient Resource endpoint
  • Using FHIR R4
  • SHALL support both json or xml encoding
  • SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch
  • Search Parameters that SHALL be supported
    • _id
    • active
    • family
    • given
    • identifier
    • telecom
    • birthdate
    • address
    • gender
    • mothersMaidenName
  • SHALL support the :exact modifier on search parameters of type string
  • SHALL support the PDQm $match operation
  • SHALL return Patient Resources conforming to the PDQm Patient Profile

Raw OpenAPI-Swagger Definition file | Download

IHE PDQm Patient Demographics Supplier Implementing Match Operation Option

  • Implementation Guide Version: 3.0.0
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: Mon Sep 25 00:00:00 CDT 2023
  • Published by: IHE IT Infrastructure Technical Committee

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as "SHALL NOT". A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: server

PDQm Patient Demographics Supplier provides capability to discover Patient Identities by demographics and identities.

Security

Recommend ATNA, encouraged IHE-IUA or SMART-app-launch

Summary of System-wide Interactions
  • Supports the search-system interaction.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
PatientSupported profiles:
  PDQm Patient Profile		yy_lastUpdated, _id, active, family, family:exact, given, given:exact, identifier, telecom, birthdate, address, address:exact, address-city, address-city:exact, address-country, address-country:exact, address-postalcode, address-postalcode:exact, address-state, address-state:exact, gender, mothersMaidenName, mothersMaidenName:exact$match

Resource Conformance: supportedPatient

Core FHIR Resource
Patient
Reference Policy
Interaction summary
  • Supports read, search-type.

Supported Profiles

https://profiles.ihe.net/ITI/PDQm/StructureDefinition/IHE.PDQm.Patient

Documentation

Mobile Patient Demographics Query [ITI-78] and Patient Demographics Match [ITI-119]

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_lastUpdateddate

When the resource version last changed

SHALL_idtoken

Logical id of this artifact

SHALLactivetoken

Whether the patient record is active

SHALLfamilystring

A portion of the family name of the patient

SHALLfamily:exactstring

A portion of the family name of the patient, modified to use exact string matching

SHALLgivenstring

A portion of the given name of the patient

SHALLgiven:exactstring

A portion of the given name of the patient, modified to use exact string matching

SHALLidentifiertoken

A patient identifier

SHALLtelecomtoken

The value in any kind of telecom details of the patient

SHALLbirthdatedate

The patient's date of birth

SHALLaddressstring

A server defined search that MAY match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text

SHALLaddress:exactstring

A server defined search that MAY match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text, modified to use exact string matching

SHALLaddress-citystring

A city specified in an address

SHALLaddress-city:exactstring

A city specified in an address, modified to use exact string matching

SHALLaddress-countrystring

A country specified in an address

SHALLaddress-country:exactstring

A country specified in an address, modified to use exact string matching

SHALLaddress-postalcodestring

A postalCode specified in an address

SHALLaddress-postalcode:exactstring

A postalCode specified in an address, modified to use exact string matching

SHALLaddress-statestring

A state specified in an address

SHALLaddress-state:exactstring

A state specified in an address, modified to use exact matching

SHALLgendertoken

Gender of the patient

SHALLmothersMaidenNamestring

Mother's maiden (unmarried) name, commonly collected to help verify patient identity.

SHALLmothersMaidenName:exactstring

Mother's maiden (unmarried) name, commonly collected to help verify patient identity, modified to use exact string matching.

 
Extended Operations
ConformanceOperationDocumentation
SHALL$match

Implementation SHALL conform to ITI-119