| ITI47 | ITI47-1 | Implementers of the Patient Demographics Query HL7 V3 [ITI-47] transaction shall comply with the requirements described in HL7 Version 3 Edition 2008, Patient Administration DSTU, Patient Topic (found at http://www.hl7.org/memonly/downloads/v3edition.cfm#V32008) |
| ITI47 | ITI47-10 | The messages exchanged in the context of the Patient Demographics Query HL7 V3 [ITI-47] transaction will be transmitted using Web Services, according to the requirements specified in ITI TF-2x: Appendix V. |
| ITI47 | ITI47-11 | The following WSDL naming conventions SHALL apply:
query message -> "PRPA_IN201305UV02_Message" |
| ITI47 | ITI47-12 | The Patient Demographics Supplier shall be capable of accepting, searching on, and responding with attributes in the Query Person by Demographics message |
| ITI47 | ITI47-13 | The Supplier shall return at least all exact matches to the query parameters sent by the Consumer; |
| ITI47 | ITI47-18 | The Patient Demographics Suppliers response to the Find Candidates Query message is triggered by the following trigger:
Find Candidates Response (PRPA_TE201306UV02) |
| ITI47 | ITI47-19 | An application returns a Patient Registry Find Candidates Response message populated with information it holds for each person whose record matches the demographic information sent as parameters in a query-by-parameter message |
| ITI47 | ITI47-2 | Implementers of this transaction shall comply with all requirements described in ITI TF-2x: Appendix V Web Services for IHE Transactions |
| ITI47 | ITI47-21 | The components of the Patient Registry Find Candidates Response message (PRPA_MT201310UV02) with cardinality greater than 0 (as shown in Figure 3.47.4.2.2-1) are required |
| ITI47 | ITI47-22 | The Patient Demographics Supplier finds (in the patient information source associated with Receiver.Device in the query transmission wrapper) at least one patient record matching the criteria sent in the query parameters. There were no OtherIDsScopingOrganization parameters in the query.
AA (application accept) is returned in Acknowledgement.typeCode (transmission wrapper).
OK (data found, no errors) is returned in QueryAck.queryResponseCode (control act wrapper)
One RegistrationEvent (and the associated Patient role, subject of that event) is returned from the patient information source for each patient record found. If the Patient Demographics Supplier returns data for multiple patients, it shall return these data in successive occurrences of the RegistrationEvent class within the transmission wrapper.
For each patient, one or more identifiers from the Patient ID Domain associated with the target patient information source identified by Receiver.Device are represented as Patient.id attributes.
If an incremental number of records are specified in QueryByParamter.initialQuantity (i.e., the Consumer supports the Continuation Option), and the number of records to be sent exceeds that incremental number, the Supplier shall return only up to the incremental number of records. If the Supplier supports the Continuation Option, it shall correctly populate the resultTotalQuantity, resultCurrentQuantity, and resultRemainingQuantity attributes of the QueryAck class in the control act wrapper. If the Supplier does not support the Continuation Option, in addition to returning only up to the incremental number of records requested, it shall return AE (application error in the Acknowledgement.typeCode (transmission wrapper) and AE (application error) is returned in QueryAck.queryResponseCode (control act wrapper).
The Consumer may then send a query continuation message as a subsequent query request for the next increment of responses. |
| ITI47 | ITI47-23 | The Patient Demographics Supplier finds (in the patient information source associated with Receiver.Device in the query transmission wrapper) at least one patient record matching the criteria sent in the query parameters. One or more OtherIDsScopingOrganization parameters are present in the query; the Supplier recognizes all the requested domains.
AA (application accept) is returned in Acknowledgement.typeCode (transmission wrapper).
OK (data found, no errors) is returned in QueryAck.queryResponseCode (control act wrapper)
One RegistrationEvent (and the associated Patient role, subject of that event) is returned from the patient information source for each patient record found. If the Patient Demographics Supplier returns data for multiple patients, it shall return these data in successive occurrences of the RegistrationEvent class within the transmission wrapper.
For each patient, the identifiers from all the Patient ID Domains requested via the OtherIDsScopingOrganization parameter are returned either as values of the Patient.id attribute, or as values of the OtherIDs.idattribute. The same patient identifier value shall not appear in both the Patient.id and OtherIDs.id attributes. The Patient Demographics consumer shall consider the identifiers from both places as equivalently valid. If the Patient Demographics supplier cannot provide a patient ID for some of the requested Patient ID Domains, then an OtherIDs.id attribute shall have an appropriate null value, and the ScopingOrganization class shall identify the corresponding domain.
If an incremental number of records are specified in QueryByParamter.initialQuantity, and the number of records to be sent exceeds that incremental number, and the Patient Demographics Supplier supports the Continuation Option, the Supplier returns only the incremental number of records, correctly populating the resultTotalQuantity, resultCurrentQuantity, and resultRemainingQuantity attributes of the QueryAck class in the control act wrapper. The consumer will sent a query continuation message as a subsequent query request for the next increment of responses. If the Supplier does not support the Continuation Option, then AE (application error) is returned in the Acknowledgement.typeCode (transmission wrapper) and AE (application error) is returned in QueryAck.queryResponseCode (control act wrapper). |
| ITI47 | ITI47-24 | The Patient Demographics Supplier does not recognize one or more OtherIDsScopingOrganization parameters as representing valid Patient Identity Domains.
AE (application error) is returned in Acknowledgement.typeCode (transmission wrapper) and in QueryAck.queryResponseCode (control act wrapper).
No RegistrationEvent is returned.
The queried-for patient identification domains are returned in the QueryByParameter parameter list (control act wrapper).
For each domain that was not recognized, an AcknowledgmentDetail class is returned in which the attributes typeCode, code, and location are valued as follows:
- typeCode: E
- code: 204
- Location: XPath expression for the value element of the OtherIDsScopingOrganization parameter
(which includes the repetition number of the parameter) |
| ITI47 | ITI47-25 | The following WSDL naming conventions SHALL apply:
wsdl:definitions/@name="PDSupplier":
patient demographics query -> "PRPA_IN201305UV02_Message"
patient demographics response ->"PRPA_IN201306UV02_Message"
continuation query ->"QUQI_IN000003UV01_Message"
accept acknowledgement -> "MCCI_IN000002UV01_Message"
portType -> "PDSupplier_PortType"
get candidates operation -> "PDSupplier_PRPA_IN201305UV02"
continuation operation -> "PDSupplier_PRPA_IN201305UV02_Continue"
cancel operation -> "PDSupplier_PRPA_IN201305UV02_Cancel"
SOAP 1.2 binding -> "PDSupplier_Binding_Soap12"
SOAP 1.2 port -> "PDSupplier_Port_Soap12" |
| ITI47 | ITI47-3 | A Patient Demographics Consumer needs to select a patient based on demographic information about patients whose information matches a set of known data will trigger the Patient Demographics Query based on the following HL7 trigger event: Find Candidates Query (PRPA_TE201305UV02) |
| ITI47 | ITI47-32 | If the Patient Demographics Supplier does not support the Continuation Option and the number of matching records to the original query exceeds the number specified, then, in addition to returning up to that number of records, the Supplier shall return AE (application error) in the Acknowledgement.typeCode (transmission wrapper) and AE (application error) in QueryAck.queryResponseCode (control act wrapper). |
| ITI47 | ITI47-37 | When grouped with ATNA Secure Node or Secure Application actors, this transaction is to be audited as Query Information event, as defined in ITI TF-2a: Table 3.20.6-1. The table 3.47.5.1.1 show items that are required to be part of the audit record produced by the Patient Demographics Consumer actor for this transaction. |
| ITI47 | ITI47-38 | When grouped with ATNA Secure Node or Secure Application actors, this transaction is to be audited as Query Information event, as defined in ITI TF-2a: Table 3.20.6-1. The table 3.47.5.1.1 show items that are required to be part of the audit record produced by the Patient Demographics Supplier actor for this transaction. |
| ITI47 | ITI47-4 | The Find Candidates Query is supported by the Patient Registry Query by Demographics (PRPA_MT201306UV02) message. The Patient Demographics Consumer shall generate the query message whenever it needs to select from a list of patients whose information matches a set of demographic data |
| ITI47 | ITI47-5 | The components of the Patient Registry Query by Demographics message with cardinality greater than 0 (as shown in figure 3.47.4.1.2-1) are required |
| ITI47 | ITI47-6 | Additional components to be included if the Pediatric Demographics Option is supported are also indicated in ITI TF-2b: 3.47.4.1.2.1 to 3.47.4.1.2.4 |