{ "description": "ImplementationGuide for IHE IT Infrastructure Technical Framework Supplement Patient Identifier Cross-referencing for mobile (PIXm)", "_filename": "ImplementationGuide-ihe.iti.pixm.json", "package_name": "ihe.iti.pixm", "definition": { "page": { "page": [ { "title": "1:41. PIXm Home", "nameUrl": "index.html", "generation": "markdown" }, { "title": "Volume 1:41", "nameUrl": "volume-1.html", "generation": "markdown" }, { "title": "2:3.83 Mobile Patient Identifier Cross-reference Query [ITI-83]", "nameUrl": "ITI-83.html", "generation": "markdown" }, { "title": "2:3:104 Patient Identity Feed FHIR [ITI-104]", "nameUrl": "ITI-104.html", "generation": "markdown" }, { "title": "Test Plan", "nameUrl": "5_testplan.html", "generation": "markdown" }, { "title": "Issues", "nameUrl": "a_issues.html", "generation": "markdown" }, { "title": "Other", "nameUrl": "other.html", "generation": "markdown" } ], "title": "Table of Contents", "nameUrl": "toc.html", "generation": "html" }, "resource": [ { "name": "Audit Event for Patient Identity Feed FHIR by the Manager", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:resource" } ], "reference": { "reference": "StructureDefinition/IHE.PIXm.Feed.Audit.Manager" }, "description": "Defines constraints on the AuditEvent Resource to record when a Patient Identity Feed FHIR Transaction happens, as recorded by the Patient Identifier Cross-reference Manager.\r\n- Feed event for ITI-104\r\n- shall have the source as itself\r\n- shall have a destination\r\n- may have user, app, organization agent(s)\r\n- shall have a source patient identifier", "exampleBoolean": false }, { "name": "Audit Event for Patient Identity Feed by the Source", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:resource" } ], "reference": { "reference": "StructureDefinition/IHE.PIXm.Feed.Audit.Source" }, "description": "Defines constraints on the AuditEvent Resource to record when a Patient Identity Feed Transaction happens, as recorded by the Patient Identity Source.\r\n- Feed event for ITI-104\r\n- shall have the source as itself\r\n- shall have a destination\r\n- may have user, app, organization agent(s)\r\n- shall have a source patient identifier", "exampleBoolean": false }, { "name": "Audit Event for PIXm Query by the Consumer", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:resource" } ], "reference": { "reference": "StructureDefinition/IHE.PIXm.Query.Audit.Consumer" }, "description": "Defines constraints on the AuditEvent Resource to record when a PIXm Query Transaction happens, as recorded by the Patient Identifier Cross-reference Consumer.\r\n- Query event for ITI-83\r\n- shall have the source as itself\r\n- shall have a destination\r\n- may have user, app, organization agent(s)\r\n- shall have a source patient identifier\r\n- shall have a the query parameters", "exampleBoolean": false }, { "name": "Audit Event for PIXm Query by the Manager", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:resource" } ], "reference": { "reference": "StructureDefinition/IHE.PIXm.Query.Audit.Manager" }, "description": "Defines constraints on the AuditEvent Resource to record when a PIXm Query Transaction happens, as recorded by the Patient Identifier Cross-reference Manager.\r\n- Query event for ITI-83\r\n- shall have the source as itself\r\n- shall have a destination\r\n- may have user, app, organization agent(s)\r\n- shall have a source patient identifier\r\n- shall have a the query parameters", "exampleBoolean": false }, { "name": "PIXm Patient constraints for Feed", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:resource" } ], "reference": { "reference": "StructureDefinition/IHE.PIXm.Patient" }, "description": "Profile for describing elements which have to be accepted by the Patient Identifier Cross-reference Manager for performing its cross-referencing function.\r\n- requiring name\r\n- mustSupport for identifier, name, telecom, gender birthDate, address and managingOrganization", "exampleBoolean": false }, { "name": "PIXm Patient Profile example for additional Manager constraints", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:resource" } ], "reference": { "reference": "StructureDefinition/IHE.PIXm.Patient.BirthDateRequired" }, "description": "Example Profile StructureDefinition for describing additional Patient resource constraints (requiring birthDate) by the Patient Identifier Cross-reference Manager for performing its cross-referencing function.\r\n- requiring name and birthDate\r\n- mustSupport for identifier, birthDate, name, telecom, gender birthDate, address and managingOrganization", "exampleBoolean": false }, { "name": "IHE PIXm Query Parameters In", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:resource" } ], "reference": { "reference": "StructureDefinition/IHE.PIXm.Query.Parameters.In" }, "description": "The StructureDefinition defines the Input Parameters for the $ihe-pix operation\r\n- Input: sourceIdentifier, targetSystem", "exampleBoolean": false }, { "name": "IHE PIXm Query Parameters Out", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:resource" } ], "reference": { "reference": "StructureDefinition/IHE.PIXm.Query.Parameters.Out" }, "description": "The StructureDefinition defines the Output Parameters for the $ihe-pix operation\r\n- Output: targetId, targetIdentifier", "exampleBoolean": false }, { "name": "Audit Example of ITI-104 at Manager", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "AuditEvent" } ], "reference": { "reference": "AuditEvent/ex-auditPixmFeed-manager" }, "description": "Audit Event for Patient Identity Feed FHIR Transaction ITI-104 by the Patient Identifier Cross-reference Manager", "exampleCanonical": "https://profiles.ihe.net/ITI/PIXm/StructureDefinition/IHE.PIXm.Feed.Audit.Manager" }, { "name": "Audit Example of ITI-104 at Source", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "AuditEvent" } ], "reference": { "reference": "AuditEvent/ex-auditPixmFeed-source" }, "description": "Audit Event for Patient Identity Feed FHIR Transaction ITI-104 by the Patient Identity Source", "exampleCanonical": "https://profiles.ihe.net/ITI/PIXm/StructureDefinition/IHE.PIXm.Feed.Audit.Source" }, { "name": "Audit Example of ITI-83 at Consumer", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "AuditEvent" } ], "reference": { "reference": "AuditEvent/ex-auditPixmQuery-consumer" }, "description": "Audit Event for PIXm Query Transaction ITI-83 by the Patient Identifier Cross-reference Consumer", "exampleCanonical": "https://profiles.ihe.net/ITI/PIXm/StructureDefinition/IHE.PIXm.Query.Audit.Consumer" }, { "name": "Audit Example of ITI-83 at Manager", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "AuditEvent" } ], "reference": { "reference": "AuditEvent/ex-auditPixmQuery-manager" }, "description": "Audit Event for PIXm Query Transaction ITI-83 by the Patient Identifier Cross-reference Manager", "exampleCanonical": "https://profiles.ihe.net/ITI/PIXm/StructureDefinition/IHE.PIXm.Query.Audit.Manager" }, { "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": "IHE ITI Patient Identifier Cross-referencing for mobile (PIXm) - Consumer (client)", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "CapabilityStatement" } ], "reference": { "reference": "CapabilityStatement/IHE.PIXm.Consumer" }, "description": "The Patient Identifier Cross-reference Consumer Actor CapabililtyStatement expresses the requirements that can be utilized while being compliant.\r\n- using FHIR R4\r\n- using json or xml encoding\r\n- query the $ihe-pix operation", "exampleBoolean": false }, { "name": "IHE ITI Patient Identifier Cross-referencing for mobile (PIXm) - Manager (server)", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "CapabilityStatement" } ], "reference": { "reference": "CapabilityStatement/IHE.PIXm.Manager" }, "description": "The Patient Identifier Cross-reference Manager CapabililtyStatement expresses the requirements that shall be provided.\r\n- using FHIR R4\r\n- using json and xml encoding\r\n- support the $ihe-pix operation\r\n- support conditional update for [ITI-104]\r\n- support conditional delete for [ITI-104] if Remove Patient Option is supported\r\n- should use a security framework. Recommend IHE-IUA or SMART-on-FHIR", "exampleBoolean": false }, { "name": "IHE ITI Patient Identifier Cross-referencing for mobile (PIXm) - Source (client)", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "CapabilityStatement" } ], "reference": { "reference": "CapabilityStatement/IHE.PIXm.Source" }, "description": "The Patient Identity Source Actor CapabililtyStatement expresses the requirements that can be utilized while being compliant.\r\n- using FHIR R4\r\n- using json or xml encoding\r\n- using conditional update for [ITI-104]\r\n- using conditional delete for [ITI-104] if Remove Patient Option is supported\r\n- provide supported Patient profile for crosss-referencing for [ITI-104]", "exampleBoolean": false }, { "name": "Get Corresponding Identifiers Operation", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "OperationDefinition" } ], "reference": { "reference": "OperationDefinition/IHE.PIXm.pix" }, "description": "The OperationDefinition defines the In and Output Parameters for the $ihe-pix operation\r\n- Input: sourceIdentifier, targetSystem and _format\r\n- Opuut: targetIdentifier, targetId", "exampleBoolean": false }, { "name": "Patient Maiden Alice (Red)", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Patient" } ], "reference": { "reference": "Patient/Patient-MaidenAlice-Red" }, "description": "Patient Maiden Alice in Red Domain", "exampleBoolean": true }, { "name": "Patient Alice Mohr (Blue)", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Patient" } ], "reference": { "reference": "Patient/Patient-MohrAlice-Blue" }, "description": "Patient Mohr Alice in Blue Domain", "exampleBoolean": true }, { "name": "Patient Alice Mohr (Green)", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Patient" } ], "reference": { "reference": "Patient/Patient-MohrAlice-Green" }, "description": "Patient Mohr Alice in Green Domain", "exampleBoolean": true }, { "name": "Patient Alice Mohr (Red)", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Patient" } ], "reference": { "reference": "Patient/Patient-MohrAlice-Red" }, "description": "Patient Mohr Alice in Red Domain", "exampleBoolean": true }, { "name": "Patient Alice Mohr", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Patient" } ], "reference": { "reference": "Patient/Patient-MohrAlice" }, "description": "Patient Mohr Alice with all domain identifiers, note: this is just a consolidated identifier example will all identifiers from all the domains equivalent to a golden patient, however a golden patient is not the scope of PIXm, see the IHE PMIR profile", "exampleBoolean": true }, { "name": "Patient Alissa Mohr (Red)", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Patient" } ], "reference": { "reference": "Patient/Patient-MohrAlissa-Red" }, "description": "Patient Mohr Alisa in Red Domain", "exampleBoolean": true }, { "name": "Patient Mohr Maiden Resolved by Mohr Alice (Red)", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Patient" } ], "reference": { "reference": "Patient/Patient-MohrMaidenResolvedByMohrMalice-Red" }, "description": "Patient Mohr Maiden (Duplicate) Resolved by Mohr Alice Red Domain", "exampleBoolean": true }, { "name": "PIXm Query with source identifier", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Parameters" } ], "reference": { "reference": "Parameters/pixm-request-mohralice-red-all" }, "description": "PIXm Query for Patient with source identifier in RED domain for Mohr Alice", "exampleBoolean": true }, { "name": "PIXm Query with source identifier and target system", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Parameters" } ], "reference": { "reference": "Parameters/pixm-request-mohralice-red-to-blue" }, "description": "PIXm Query for Patient with source identifier in RED domain and query for BLUE domain for Mohr Alice", "exampleBoolean": true }, { "name": "PIXm Query Response error message", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Parameters" } ], "reference": { "reference": "Parameters/pixm-response-error-not-found" }, "description": "Error source identifier not found", "exampleBoolean": true }, { "name": "PIXm Query Response for source identifier", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Parameters" } ], "reference": { "reference": "Parameters/pixm-response-mohralice-red-all" }, "description": "PIXm Query Response for Patient with source identifier in RED domain for Mohr Alice", "exampleBoolean": true }, { "name": "PIXm Query Response for source identifier and target system specified", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Parameters" } ], "reference": { "reference": "Parameters/pixm-response-mohralice-red-to-blue" }, "description": "PIXm Query Response for Patient with source identifier in RED domain and query for BLUE domain for Mohr Alice", "exampleBoolean": true } ], "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "copyrightyear" }, { "url": "value", "valueString": "2020+" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "releaselabel" }, { "url": "value", "valueString": "Trial-Implementation" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "active-tables" }, { "url": "value", "valueString": "false" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "apply-contact" }, { "url": "value", "valueString": "true" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "apply-jurisdiction" }, { "url": "value", "valueString": "true" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "apply-publisher" }, { "url": "value", "valueString": "true" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "apply-version" }, { "url": "value", "valueString": "true" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "show-inherited-invariants" }, { "url": "value", "valueString": "false" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "usage-stats-opt-out" }, { "url": "value", "valueString": "true" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "autoload-resources" }, { "url": "value", "valueString": "true" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "shownav" }, { "url": "value", "valueString": "true" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "special-url" }, { "url": "value", "valueString": "urn:oid:1.3.6.1.4.1.21367.13.20.3000" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "path-liquid" }, { "url": "value", "valueString": "template/liquid" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "path-liquid" }, { "url": "value", "valueString": "input/liquid" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "path-qa" }, { "url": "value", "valueString": "temp/qa" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "path-temp" }, { "url": "value", "valueString": "temp/pages" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "path-output" }, { "url": "value", "valueString": "output" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "path-suppressed-warnings" }, { "url": "value", "valueString": "input/ignoreWarnings.txt" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "path-history" }, { "url": "value", "valueString": "https://profiles.ihe.net/ITI/PIXm/history.html" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "template-html" }, { "url": "value", "valueString": "template-page.html" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "template-md" }, { "url": "value", "valueString": "template-page-md.html" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "apply-context" }, { "url": "value", "valueString": "true" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "apply-copyright" }, { "url": "value", "valueString": "true" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "apply-license" }, { "url": "value", "valueString": "true" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "fmm-definition" }, { "url": "value", "valueString": "http://hl7.org/fhir/versions.html#maturity" } ] }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter", "extension": [ { "url": "code", "valueString": "propagate-status" }, { "url": "value", "valueString": "true" } ] } ], "parameter": [ { "code": "path-resource", "value": "input/resources" }, { "code": "path-resource", "value": "fsh-generated/resources" }, { "code": "path-resource", "value": "input/examples" }, { "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-tx-cache", "value": "input-cache/txcache" } ] }, "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_PIXm", "copyright": "IHE http://www.ihe.net/Governance/#Intellectual_Property", "type": null, "experimental": null, "resourceType": "ImplementationGuide", "title": "Patient Identifier Cross-referencing for mobile (PIXm)", "package_version": "3.0.2", "status": "active", "id": "0e997374-158f-4ee1-92de-406d143b2a8c", "kind": null, "url": "https://profiles.ihe.net/ITI/PIXm/ImplementationGuide/ihe.iti.pixm", "version": "3.0.2", "packageId": "ihe.iti.pixm", "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" } ] } ] }