Patient Demographics Query for Mobile (PDQm)
3.1.0 - Trial-Implementation
Patient Demographics Query for Mobile (PDQm)
3.1.0 - Trial-Implementation
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
| Active as of 2023-09-25 |
{
"resourceType" : "CapabilityStatement",
"id" : "IHE.PDQm.PatientDemographicsSupplierMatch",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement IHE.PDQm.PatientDemographicsSupplierMatch</b></p><a name=\"IHE.PDQm.PatientDemographicsSupplierMatch\"> </a><a name=\"hcIHE.PDQm.PatientDemographicsSupplierMatch\"> </a><a name=\"IHE.PDQm.PatientDemographicsSupplierMatch-en-US\"> </a><h2 id=\"title\">IHE PDQm Patient Demographics Supplier Implementing Match Operation Option</h2><ul><li>Implementation Guide Version: 3.1.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+xml</code>, <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2023-09-25 </li><li>Published by: IHE IT Infrastructure Technical Committee </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>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.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div><p>PDQm Patient Demographics Supplier provides capability to discover Patient Identities by demographics and identities.</p>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><p>Recommend <a href=\"https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html\">ATNA</a>, encouraged <a href=\"https://profiles.ihe.net/ITI/IUA/index.html\">IHE-IUA</a> or <a href=\"http://www.hl7.org/fhir/smart-app-launch/\">SMART-app-launch</a></p>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>search-system</code>interaction.</li></ul></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Patient1-1\">Patient</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-IHE.PDQm.Patient.html\">PDQm Patient Profile</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_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</td><td/><td/><td><code>$match</code></td></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Patient1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Patient</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-IHE.PDQm.Patient.html\">PDQm Patient Profile</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Mobile Patient Demographics Query [ITI-78] and Patient Demographics Match [ITI-119]</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>_lastUpdated</td><td><code>date</code></td><td><div><p>When the resource version last changed</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>_id</td><td><code>token</code></td><td><div><p>Logical id of this artifact</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>active</td><td><code>token</code></td><td><div><p>Whether the patient record is active</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>family</td><td><code>string</code></td><td><div><p>A portion of the family name of the patient</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>family:exact</td><td><code>string</code></td><td><div><p>A portion of the family name of the patient, modified to use exact string matching</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>given</td><td><code>string</code></td><td><div><p>A portion of the given name of the patient</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>given:exact</td><td><code>string</code></td><td><div><p>A portion of the given name of the patient, modified to use exact string matching</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div><p>A patient identifier</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>telecom</td><td><code>token</code></td><td><div><p>The value in any kind of telecom details of the patient</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>birthdate</td><td><code>date</code></td><td><div><p>The patient's date of birth</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>address</td><td><code>string</code></td><td><div><p>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</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>address:exact</td><td><code>string</code></td><td><div><p>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</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>address-city</td><td><code>string</code></td><td><div><p>A city specified in an address</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>address-city:exact</td><td><code>string</code></td><td><div><p>A city specified in an address, modified to use exact string matching</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>address-country</td><td><code>string</code></td><td><div><p>A country specified in an address</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>address-country:exact</td><td><code>string</code></td><td><div><p>A country specified in an address, modified to use exact string matching</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>address-postalcode</td><td><code>string</code></td><td><div><p>A postalCode specified in an address</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>address-postalcode:exact</td><td><code>string</code></td><td><div><p>A postalCode specified in an address, modified to use exact string matching</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>address-state</td><td><code>string</code></td><td><div><p>A state specified in an address</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>address-state:exact</td><td><code>string</code></td><td><div><p>A state specified in an address, modified to use exact matching</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>gender</td><td><code>token</code></td><td><div><p>Gender of the patient</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/extensions/5.1.0/SearchParameter-patient-extensions-Patient-mothersMaidenName.html\">mothersMaidenName</a></td><td><code>string</code></td><td><div><p>Mother's maiden (unmarried) name, commonly collected to help verify patient identity.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/extensions/5.1.0/SearchParameter-patient-extensions-Patient-mothersMaidenName.html\">mothersMaidenName:exact</a></td><td><code>string</code></td><td><div><p>Mother's maiden (unmarried) name, commonly collected to help verify patient identity, modified to use exact string matching.</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Extended Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"OperationDefinition-PDQmMatch.html\">$match</a></td><td><div><p>Implementation SHALL conform to <a href=\"ITI-119.html\">ITI-119</a></p>\n</div></td></tr></tbody></table></div></div></div></div></div></div>"
},
"url" : "https://profiles.ihe.net/ITI/PDQm/CapabilityStatement/IHE.PDQm.PatientDemographicsSupplierMatch",
"version" : "3.1.0",
"name" : "IHE_PDQM_PATIENT_DEMOGRAPHICS_SUPPLIER_Match",
"title" : "IHE PDQm Patient Demographics Supplier Implementing Match Operation Option",
"status" : "active",
"experimental" : false,
"date" : "2023-09-25",
"publisher" : "IHE IT Infrastructure Technical Committee",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "https://www.ihe.net/ihe_domains/it_infrastructure/"
}
]
},
{
"telecom" : [
{
"system" : "email",
"value" : "iti@ihe.net"
}
]
},
{
"name" : "IHE IT Infrastructure Technical Committee",
"telecom" : [
{
"system" : "email",
"value" : "iti@ihe.net"
}
]
}
],
"description" : "The PDQm Patient Demographics Supplier Actor (server) requirements CapabililtyStatement expresses the requirements that SHALL be provided. This capability statement implements the Match Operation Option.\n\n- Query against the FHIR endpoint to the Patient Resource endpoint\n- Using FHIR R4\n- SHALL support both json or xml encoding\n- SHOULD use a security framework. Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)\n- [Search Parameters that SHALL be supported](ITI-78.html#23784121-search-parameters)\n - _id\n - active\n - family\n - given\n - identifier\n - telecom\n - birthdate\n - address\n - gender\n - mothersMaidenName\n- SHALL support the `:exact` modifier on search parameters of type string\n- SHALL support the PDQm $match operation\n- SHALL return Patient Resources conforming to the PDQm Patient Profile",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"application/fhir+xml",
"application/fhir+json"
],
"rest" : [
{
"mode" : "server",
"documentation" : "PDQm Patient Demographics Supplier provides capability to discover Patient Identities by demographics and identities.",
"security" : {
"description" : "Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)"
},
"resource" : [
{
"type" : "Patient",
"supportedProfile" : [
🔗 "https://profiles.ihe.net/ITI/PDQm/StructureDefinition/IHE.PDQm.Patient"
],
"documentation" : "Mobile Patient Demographics Query [ITI-78] and Patient Demographics Match [ITI-119]",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
},
{
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
},
{
"name" : "active",
"type" : "token",
"documentation" : "Whether the patient record is active"
},
{
"name" : "family",
"type" : "string",
"documentation" : "A portion of the family name of the patient"
},
{
"name" : "family:exact",
"type" : "string",
"documentation" : "A portion of the family name of the patient, modified to use exact string matching"
},
{
"name" : "given",
"type" : "string",
"documentation" : "A portion of the given name of the patient"
},
{
"name" : "given:exact",
"type" : "string",
"documentation" : "A portion of the given name of the patient, modified to use exact string matching"
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "A patient identifier"
},
{
"name" : "telecom",
"type" : "token",
"documentation" : "The value in any kind of telecom details of the patient"
},
{
"name" : "birthdate",
"type" : "date",
"documentation" : "The patient's date of birth"
},
{
"name" : "address",
"type" : "string",
"documentation" : "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"
},
{
"name" : "address:exact",
"type" : "string",
"documentation" : "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"
},
{
"name" : "address-city",
"type" : "string",
"documentation" : "A city specified in an address"
},
{
"name" : "address-city:exact",
"type" : "string",
"documentation" : "A city specified in an address, modified to use exact string matching"
},
{
"name" : "address-country",
"type" : "string",
"documentation" : "A country specified in an address"
},
{
"name" : "address-country:exact",
"type" : "string",
"documentation" : "A country specified in an address, modified to use exact string matching"
},
{
"name" : "address-postalcode",
"type" : "string",
"documentation" : "A postalCode specified in an address"
},
{
"name" : "address-postalcode:exact",
"type" : "string",
"documentation" : "A postalCode specified in an address, modified to use exact string matching"
},
{
"name" : "address-state",
"type" : "string",
"documentation" : "A state specified in an address"
},
{
"name" : "address-state:exact",
"type" : "string",
"documentation" : "A state specified in an address, modified to use exact matching"
},
{
"name" : "gender",
"type" : "token",
"documentation" : "Gender of the patient"
},
{
"name" : "mothersMaidenName",
"definition" : "http://hl7.org/fhir/SearchParameter/patient-extensions-Patient-mothersMaidenName",
"type" : "string",
"documentation" : "Mother's maiden (unmarried) name, commonly collected to help verify patient identity."
},
{
"name" : "mothersMaidenName:exact",
"definition" : "http://hl7.org/fhir/SearchParameter/patient-extensions-Patient-mothersMaidenName",
"type" : "string",
"documentation" : "Mother's maiden (unmarried) name, commonly collected to help verify patient identity, modified to use exact string matching."
}
],
"operation" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "match",
"definition" : "https://profiles.ihe.net/ITI/PDQm/OperationDefinition/PDQmMatch",
"documentation" : "Implementation SHALL conform to [ITI-119](ITI-119.html)"
}
]
}
],
"interaction" : [
{
"code" : "search-system"
}
]
}
]
}
IG © 2020+ IHE IT Infrastructure Technical Committee. Package ihe.iti.pdqm#3.1.0 based on FHIR 4.0.1. Generated 2024-12-02
Links: Table of Contents |
QA Report
| New Issue | Issues
Version History |
|
Propose a change