{
  "description": "The Patient Demographics Query for Mobile (PDQm) Profile defines a lightweight RESTful interface to a patient demographics supplier leveraging technologies readily available to mobile applications and lightweight browser based applications.",
  "_filename": "ig-r4.json",
  "package_name": "ihe.iti.pdqm",
  "definition": {
    "page": {
      "page": [ {
        "title": "Patient Demographics Query for Mobile",
        "nameUrl": "index.html",
        "generation": "markdown"
      }, {
        "title": "1:38 Patient Demographics Query for Mobile (PDQm)",
        "nameUrl": "volume-1.html",
        "generation": "markdown"
      }, {
        "title": "2:3.78 Mobile Patient Demographics Query [ITI-78]",
        "nameUrl": "ITI-78.html",
        "generation": "markdown"
      }, {
        "title": "PDQm Test Plan",
        "nameUrl": "testplan.html",
        "generation": "markdown"
      }, {
        "title": "PDQm Open and Closed issues",
        "nameUrl": "issues.html",
        "generation": "markdown"
      }, {
        "title": "Changes to other Profiles",
        "nameUrl": "other.html",
        "generation": "markdown"
      } ],
      "title": "Table of Contents",
      "nameUrl": "toc.html",
      "generation": "html"
    },
    "resource": [ {
      "name": "Audit Event for PDQm Query at Consumer",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/IHE.PDQm.Query.Audit.Consumer"
      },
      "description": "Defines constraints on the AuditEvent (AuditMessage) Resource for a Patient Demographics Consumer to record when it performs a Patient Demographics Query [ITI-78](./ITI-78.html).\n- type (EventTypeCode) = EV(`110112`, `DCM`, `Query`)\n- action (EventActionCode) = `E`\n- subtype (EventTypeCode) = EV(`ITI-78`, `urn:ihe:event-type-code`, `Mobile Patient Demographics Query`)\n- agent (ActiveParticipant)\n  - supplier as the Destination\n  - consumer as the Source\n    - this agent is the source of the auditEvent\n  - other agents are allowed including identity of the application or infrastructure\n- entity (ParticipantObjectIdentification) \n  - query parameters\n  - no patient, because the consumer does not know the patient they are looking for or they wouldn't be using this transaction.",
      "exampleBoolean": false
    }, {
      "name": "Audit Event for PDQm Query at Supplier",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/IHE.PDQm.Query.Audit.Supplier"
      },
      "description": "Defines constraints on the AuditEvent (AuditMessage) Resource when a Patient Demographics Supplier responds to a Patient Demographics Query [ITI-78](./ITI-78.html).\n- type (EventTypeCode) = EV(`110112`, `DCM`, `Query`)\n- action (EventActionCode) = `E`\n- subtype (EventTypeCode) = EV(`ITI-78`, `urn:ihe:event-type-code`, `Mobile Patient Demographics Query`)\n- agent (ActiveParticipant)\n  - supplier as the Destination\n    - this agent is the source of the auditEvent\n  - consumer as the Source\n  - other agents are allowed including identity of the application or infrastructure\n- entity (ParticipantObjectIdentification) \n  - query parameters\n  - other entity are allowed including one to identify a patient when explicitly identified in the query parameters",
      "exampleBoolean": false
    }, {
      "name": "PDQm Patient Profile",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/IHE.PDQm.Patient"
      },
      "description": "The PDQm Patient Profile \n- when any element in FHIR Core Patient are known, and when authorized to return the element, then all elements that are core to FHIR Patient should be returned\n- forbids modifier extensions - so that all uses do not need to be concerned with changes to the meaning of the core elements of the Patient resource\n- adds the patient-mothersMaidenName extension as an extension available to hold the mothers maiden name",
      "exampleBoolean": false
    }, {
      "name": "PDQm Client requirements CapabilityStatement",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "CapabilityStatement"
      } ],
      "reference": {
        "reference": "CapabilityStatement/IHE.PDQm.client"
      },
      "description": "The PDQm Patient Demographics Consumer Actor requirements CapabililtyStatement expresses the requirements that can be utilized while being compliant.\n\n- Query against the FHIR endpoint to the Patient Resource endpoint\n- Using FHIR R4\n- may request json or xml encoding\n- should use a security framework. Recommend [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-on-FHIR](http://www.hl7.org/fhir/smart-app-launch/)\n- [Search Parameters that may be used](https://profiles.ihe.net/ITI/PDQm/ITI-78.html#23784121-query-search-parameters)\n  - _id\n  - active\n  - family\n  - given\n  - identifier\n  - telecom\n  - birthdate\n  - address\n  - gender\n  - mothersMaidenName",
      "exampleBoolean": false
    }, {
      "name": "IHE.PDQm.server",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "CapabilityStatement"
      } ],
      "reference": {
        "reference": "CapabilityStatement/IHE.PDQm.server"
      },
      "description": "The PDQm Patient Demographics Supplier Actor requirements CapabililtyStatement expresses the requirements that shall be provided.\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 [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-on-FHIR](http://www.hl7.org/fhir/smart-app-launch/)\n- [Search Parameters that shall be supported](https://profiles.ihe.net/ITI/PDQm/ITI-78.html#23784121-query-search-parameters)\n  - _id\n  - active\n  - family\n  - given\n  - identifier\n  - telecom\n  - birthdate\n  - address\n  - gender\n  - mothersMaidenName",
      "exampleBoolean": false
    }, {
      "name": "Audit Example of ITI-78 at Consumer",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "AuditEvent"
      } ],
      "reference": {
        "reference": "AuditEvent/ex-auditPdqmQuery-consumer"
      },
      "description": "Audit Event for PDQm Query Transaction by the Patient Identifier Cross-reference Consumer\n\nwhere the Query was executed with a GET as follows:\n\n```\nGET https://server.example.com/fhir/Patient?family=MOHR&given=ALICE&active=true&gender=female\nAccept: application/fhir+json; fhirVersion=4.0\n```",
      "exampleCanonical": "https://profiles.ihe.net/ITI/PDQm/StructureDefinition/IHE.PDQm.Query.Audit.Consumer"
    }, {
      "name": "Audit Example of ITI-78 at Supplier",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "AuditEvent"
      } ],
      "reference": {
        "reference": "AuditEvent/ex-auditPdqmQuery-supplier"
      },
      "description": "Audit Event for PDQm Query Transaction by the Patient Identifier Cross-reference Supplier\n\nwhere the Query was executed with a GET as follows:\n\n```\nGET https://server.example.com/fhir/Patient?family=MOHR&given=ALICE&active=true&gender=female\nAccept: application/fhir+json; fhirVersion=4.0\n```\n\nNote the Supplier may choose to record patient identities found, but is not required to.\n\nGiven the Supplier chooses to record a patient in the AuditEvent \nWhen the search finds multiple Patients, \nThen the Supplier would create an AuditEvent for each of those Patients. \n\nThis example shows where ex-patient is returned. This single result does not affect the response returned on the ITI-78 that would include all results.",
      "exampleCanonical": "https://profiles.ihe.net/ITI/PDQm/StructureDefinition/IHE.PDQm.Query.Audit.Supplier"
    }, {
      "name": "Dummy Device example",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "Device"
      } ],
      "reference": {
        "reference": "Device/ex-device"
      },
      "description": "Dummy Device example for completeness sake. No actual use of this resource other than an example target",
      "exampleBoolean": true
    }, {
      "name": "Dummy Patient example",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "Patient"
      } ],
      "reference": {
        "reference": "Patient/ex-patient"
      },
      "description": "Dummy patient example for completeness sake. No actual use of this resource other than an example target",
      "exampleCanonical": "https://profiles.ihe.net/ITI/PDQm/StructureDefinition/IHE.PDQm.Patient"
    } ],
    "parameter": [ {
      "code": "copyrightyear",
      "value": "2020+"
    }, {
      "code": "releaselabel",
      "value": "Trial-Implementation"
    }, {
      "code": "path-resource",
      "value": "input/resources"
    }, {
      "code": "path-resource",
      "value": "fsh-generated/resources"
    }, {
      "code": "path-resource",
      "value": "input/examples"
    }, {
      "code": "show-inherited-invariants",
      "value": "false"
    }, {
      "code": "usage-stats-opt-out",
      "value": "false"
    }, {
      "code": "logging",
      "value": "progress"
    }, {
      "code": "shownav",
      "value": "true"
    }, {
      "code": "active-tables",
      "value": "false"
    }, {
      "code": "apply-contact",
      "value": "true"
    }, {
      "code": "apply-jurisdiction",
      "value": "true"
    }, {
      "code": "apply-publisher",
      "value": "true"
    }, {
      "code": "apply-version",
      "value": "true"
    }, {
      "code": "special-url",
      "value": "urn:ihe:event-type-code"
    }, {
      "code": "autoload-resources",
      "value": "true"
    }, {
      "code": "path-resource",
      "value": "input/capabilities"
    }, {
      "code": "path-resource",
      "value": "input/extensions"
    }, {
      "code": "path-resource",
      "value": "input/models"
    }, {
      "code": "path-resource",
      "value": "input/operations"
    }, {
      "code": "path-resource",
      "value": "input/profiles"
    }, {
      "code": "path-resource",
      "value": "input/vocabulary"
    }, {
      "code": "path-resource",
      "value": "input/testing"
    }, {
      "code": "path-resource",
      "value": "input/history"
    }, {
      "code": "path-pages",
      "value": "template/config"
    }, {
      "code": "path-pages",
      "value": "input/images"
    }, {
      "code": "path-liquid",
      "value": "template/liquid"
    }, {
      "code": "path-liquid",
      "value": "input/liquid"
    }, {
      "code": "path-qa",
      "value": "temp/qa"
    }, {
      "code": "path-temp",
      "value": "temp/pages"
    }, {
      "code": "path-output",
      "value": "output"
    }, {
      "code": "path-tx-cache",
      "value": "input-cache/txcache"
    }, {
      "code": "path-suppressed-warnings",
      "value": "input/ignoreWarnings.txt"
    }, {
      "code": "path-history",
      "value": "https://profiles.ihe.net/ITI/PDQm/history.html"
    }, {
      "code": "template-html",
      "value": "template-page.html"
    }, {
      "code": "template-md",
      "value": "template-page-md.html"
    }, {
      "code": "apply-context",
      "value": "true"
    }, {
      "code": "apply-copyright",
      "value": "true"
    }, {
      "code": "apply-license",
      "value": "true"
    }, {
      "code": "fmm-definition",
      "value": "http://hl7.org/fhir/versions.html#maturity"
    }, {
      "code": "propagate-status",
      "value": "true"
    } ]
  },
  "date": "2022-03-01",
  "publisher": "IHE IT Infrastructure Technical Committee",
  "fhirVersion": [ "4.0.1" ],
  "license": "CC-BY-SA-4.0",
  "jurisdiction": [ {
    "coding": [ {
      "code": "001",
      "system": "http://unstats.un.org/unsd/methods/m49/m49.htm"
    } ]
  } ],
  "name": "IHE_PDQm",
  "copyright": "IHE http://www.ihe.net/Governance/#Intellectual_Property",
  "type": null,
  "experimental": null,
  "resourceType": "ImplementationGuide",
  "title": "Patient Demographics Query for mobile (PDQm)",
  "package_version": "2.4.0",
  "status": "active",
  "id": "ff4dcf4d-9854-450d-aa53-7e505d17cc8f",
  "kind": null,
  "url": "https://profiles.ihe.net/ITI/PDQm/ImplementationGuide/ihe.iti.pdqm",
  "version": "2.4.0",
  "packageId": "ihe.iti.pdqm",
  "contact": [ {
    "telecom": [ {
      "value": "https://www.ihe.net/ihe_domains/it_infrastructure/",
      "system": "url"
    } ]
  }, {
    "telecom": [ {
      "value": "iti@ihe.net",
      "system": "email"
    } ]
  }, {
    "name": "IHE IT Infrastructure Technical Committee",
    "telecom": [ {
      "value": "iti@ihe.net",
      "system": "email"
    } ]
  } ]
}