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

This page is part of the IHE Patient Demographics Query for Mobile (v3.1.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 Consumer Actor Implementing Patient Search Option

Official URL: https://profiles.ihe.net/ITI/PDQm/CapabilityStatement/IHE.PDQm.PatientDemographicsConsumerQuery Version: 3.1.0
Active as of 2022-10-28 Computable Name: IHE_PDQM_PATIENT_DEMOGRAPHICS_CONSUMER_SEARCH

The PDQm Patient Demographics Consumer Actor (client) requirements CapabililtyStatement expresses the requirements that can be utilized while being compliant. This capability statement implements the Patient Search Option.

  • Query against the FHIR endpoint to the Patient Resource endpoint
  • Using FHIR R4
  • MAY request json or xml encoding
  • SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch
  • Search Parameters that MAY be used
    • _id
    • active
    • family
    • given
    • identifier
    • telecom
    • birthdate
    • address
    • gender
    • mothersMaidenName

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement IHE.PDQm.PatientDemographicsConsumerQuery

IHE PDQm Patient Demographics Consumer Implementing Patient Search Option

  • Implementation Guide Version: 3.1.0
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: 2022-10-28
  • 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: client

PDQm Patient Demographics Consumer 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-systeminteraction.

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
Patient yy_lastUpdated, _id, active, family, given, identifier, telecom, birthdate, address, address-city, address-country, address-postalcode, address-state, gender, mothersMaidenName

Resource Conformance: MAY Patient

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

Documentation

Mobile Patient Demographics Query [ITI-78]

Search Parameters
ConformanceParameterTypeDocumentation
MAY_lastUpdateddate

When the resource version last changed

MAY_idtoken

Logical id of this artifact

MAYactivetoken

Whether the patient record is active

MAYfamilystring

A portion of the family name of the patient

MAYgivenstring

A portion of the given name of the patient

MAYidentifiertoken

A patient identifier

MAYtelecomtoken

The value in any kind of telecom details of the patient

MAYbirthdatedate

The patient's date of birth

MAYaddressstring

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

MAYaddress-citystring

A city specified in an address

MAYaddress-countrystring

A country specified in an address

MAYaddress-postalcodestring

A postalCode specified in an address

MAYaddress-statestring

A state specified in an address

MAYgendertoken

Gender of the patient

MAYmothersMaidenNamestring

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