Documentazione Tecnica di Prodotto

Transcript

1 G.P.I. Gruppo per l Informatica Gestione Query HL7 GPI S.p.A. Via Ragazzi del 99, Trento Tel Fax gpi@gpi.it URL: Documentazione Tecnica di Prodotto Nome Tecnico/Commerciale del Prodotto HL7 Manager Interfaccia Query HL7 Versione a cui si riferisce la presente documentazione 3.0 Autore Zanella Gianpaolo Data di Ultimo Aggiornamento del presente documento 02/10/2009 Archiviazione H:\Area_SWSanitari\Progetti\ Standard HL7\DOCUMENTAZIONE GPI\Query Pag. 1 di 15

2 STORIA DELLE MODIFICHE APPORTATE Descrizione delle Modifiche 1.0 Prima emissione Zanella 13/03/ Aggiunta ricerca per nosologico Zanella 28/07/ Aggiunta gestione del segento PV1 nella risposta Zanella 02/10/09 SOMMARIO 1 1. ACRONIMI ABSTRACT USE CASE DEI RUOLI RIFERIMENTI AGLI STANDARD HL INTERACTION DIAGRAM SEMANTICA DEI MESSAGGI Patient Demographics Query (Trigger event Q22 Find Candidates) Segmento MSH Segmento QPD...6 A1. Field QPD-1 Message Query Name...7 A2. Field QPD-3 Query Tag...7 A3. Field QPD-3 Demographics Fields...7 A4. Field QPD-5 Algorithm Name...8 A5. Field QPD-6 Algorithm version...8 A6. Field QPD-8 What Domains Returned Segmento RCP...8 A1. Field RCP-1 Query Priority...9 A2. Field RCP-2 Quantity Limited Request...9 A3. Field RCP-3 Response Modality...9 A4. Field RCP-4 Execution and Delivery Time...10 A5. Field RCP-5 Modify Indicator...10 A6. Field RCP-6 Sort-By Field...10 A7. Field RCP-7 Segment Group Inclusion Patient Demographics Response (Trigger event K22 Find Candidates response) Segmento MSH Segmento MSA Segmento QAK...12 A1. Field QAK-1 Query Tag...12 A2. Field QAK-2 Query Response Status...12 A3. Field QAK-3 Message Query name...12 A4. Field QAK-4 Hit Count...12 A5. Field QAK-5 This Payload...12 A6. Field QAK-6 Hits remaining Segmento QPD Segmento PID Segmento PV MESSAGGI DI ESEMPIO Esempio di messaggio Q22-K22 con HIT COUNT a ZERO...14 A1. Query Q A2. Risposta K

3 7.1.2 Esempio di messaggio Q22-K22 con HIT COUNT maggiore di ZERO...15 A1. Query Q A2. Risposta K

4 1. ACRONIMI PDC = Patient Demographics Consumer PDS = Patient Demographics Supplier 2. ABSTRACT Il presente documento prende in analisi le modalità di interrogazione dell'anagrafe GPI via query HL7 tramite il software HL7 Manager. Nello specifico tale integrazione implementa lo standard previsto dall' IHE Techinical Framework, nella transazione ITI USE CASE DEI RUOLI ud Use Case Model Patient Demographics Consumer Patient Demographics Supplier Patient Demographics Query Attore: Patient Demographics Consumer (PDC) Ruolo: Richiede una lista di posizioni anagrafiche passando un set minimo di informazioni anagrafiche (ad esempio il nome del paziente, la data di nascita...). Popola la propria anagrafica o le eventuali informazioni mancanti con i dati ricevuti da parte del Patient Demographics Supplier. Attore: Patient Demographics Supplier (PDS) Ruolo: Invia la lista posizioni anagrafiche trovate ricercando con i criteri di ricerca ricevuti dal Patient Demographics Consumer.

5 4. RIFERIMENTI AGLI STANDARD HL7 Versione 2.5, capitolo 2: Control Versione 2.5, capitolo 3: Patient Administration Versione 2.5, capitolo 5: Query 5. INTERACTION DIAGRAM sd Interactions Patient Demographics Consumer Patient Demographics Supplier Patient Dem ographics Query: QBP^Q୨୨ Patient Dem ographics Response: RSP^K୨୨ 6. SEMANTICA DEI MESSAGGI In questo paragrafo viene presa in analisi la semantica dei due messaggi interessati da questa integrazione, che sono identificati dai trigger event Q22 per la richiesta di informazioni e K22 per la risposta. 6.1 Patient Demographics Query (Trigger event Q22 Find Candidates) Il messaggio di query inviato dal PDC al PDS è composto dai seguenti segmenti: Tabella 1: Struttura messaggio Q22 Segmento Descrizione Riferimento MSH Message Header Capitolo 2 in HL7 2.5 [ { STF } ] Software Segment Capitolo 2 in HL7 2.5 QPD Query Parameter Definition Capitolo 5 in HL7 2.5 RCP Repose Control Parameter Capitolo 5 in HL7 2.5 [ DSC ] Continuation Pointer Capitolo 2 in HL7 2.5

6 Appena il PDS riceve il messaggio Q22 dal PDC, risponde immediatamente con un ACK. Successivamente a questo verrà inviato il messaggio K22 con il risultato della query, al quale dovrà seguire il relativo ACK. Di seguito verrà dettagliata la composizione dei segmenti obbligatori (effettivamente utilizzati in questa integrazione), con le relative informazioni da riportare Segmento MSH Tabella 2: Struttura segmento MSH SEQ LEN DT OPT RP/# TBL# ELEMENT NAME VALORE 1 1 ST R Field Separator 2 4 ST R Encoding Characters ^~\& HD R 0361 Sending Application <sending application> HD R 0362 Sending Facility <sending facility> HD R 0361 Receiving Application IE-ANAGRAFE HD R 0362 Receiving Facility GPI 7 26 TS R Date/Time Of Message <yyyymmddhhmmss> 8 40 ST O Security 9 15 MSG R Message Type QBP^Q22^QBP_Q ST R Message Control ID <id univoco del messaggio> 11 3 PT R Processing ID T VID R Version ID 2.5 Il valore riportato nel campo MSH.10 verrà poi riportato nel messaggio K22 di risposta, per poter collegare il messaggio di query con quello di risposta Segmento QPD Tabella 3: Struttura segmento QPD SEQ LEN DT OPT RP/# TBL# ELEMENT NAME VALORE CE R 0471 Message Query Name Q22^Find Candidates^HL7nnn 2 32 ST R+ Query Tag 3 QIP R Y Demographics Fields 4 NM O Search Confidence Threashold 5 ST O Algorithm Name 6 ST O Algorithm Version 7 ST O Algorithm Description 8 CX O Y What Domains Returned... Esempio di segmento QPD: QPD Q22^FIND CANDIDATES^HL7NNN 80 FINDBYEPID 1 0^^^^^FACILTY_1^^^^~0^^^^^FACILTY_2^^^^ ^^^GOOD HEALTH HOSPITAL~^^^SOUTH LAB

7 A1. Field QPD-1 Message Query Name Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> Definizione: Questo campo contiene il nome della query. Fare riferimento alla tabella User-defined Table 0471 Query name. Tabella 4: User-defined Table 0471 Query name Value Description Comments Q22 Find Candidates A2. Field QPD-3 Query Tag Definizione: Valore generato dal Patient Demographics Consumer, riportato poi nel messaggio K22 in modo tale da permettere il match della query con il suo risultato. A3. Field QPD-3 Demographics Fields Components: <Segment Field Name (ST)> ^ <Value (ST)> Definizione: Campo composto dalla ripetizione di field ti tipo QIP. Questo dataype contiene due valori, che sono rispettivamente il nome del field e il suo valore, che verranno utilizzati per comporre il filtro di ricerca. Il nome del field deve rispettare una sintassi di composizione, per mapparlo all'interno della struttura dei messaggi HL7. In particolare il nome del campo sarà composto nel seguente no>.<component no>.<subcompoment no> Le varie sezioni del campo assumo i seguenti significati: <seg>: valore alfanumerico di 3 caratteri che rappresenta il segment ID (o acronimo) del segmento a cui si riferisce. < field no>: numero del campo in riferimento al segmento indicato. < component no>:per campi in cui il data type è composto da più componenti, questo valore rappresenta il numero del componente all'interno del data type. <subcompoment no>:per campi il cui data type è composto da più sotto componenti, questo valore rappresenta il numero del sotto componente all'interno del datatype. I campi supportati in questa integrazione sono i seguenti: Tabella 5: Segment Fields @PV Element name E-PID assistito Cognome Nome Sesso Nosologico Esempio di espressione del campo

8 A4. FIELD QPD-5 ALGORITHM NAME Definizione: Questo campo contiene il nome del metodo da utilizzare per effettuare la ricerca. Di seguito viene riportata la lista dei metodi esposti per la ricerca. Tabella 6: Algorithm Algorithm Version Description FINDBYEPID 1 Ricerca solo utilizzano l'e-pid FINDBYPARAMS 1 Ricerca utilizzano i parametri passati in QPD-3 FINDBYNOSOLOGICO 1 Ricerca assistito per nosologico A5. FIELD QPD-6 ALGORITHM VERSION Definizione: Questo campo contiene il numero di versione del metodo di ricerca da utilizzare. Fare riferimento alla tabella precedente Algorithm per verificare i valori validi di questo campo. A6. FIELD QPD-8 WHAT DOMAINS RETURNED Components: <ID (ST)> ^ <check digit (ST)> ^ <code identifying the check digit scheme employed (ID)> ^ < assigning authority (HD)> ^ <identifier type code (IS)> ^ < assigning facility (HD) Definizione: Questo campo specifica il set di domini per i quali deve ritornare l'identificativo come ripetizione del campo PID.3. Nota: Per il momento questa informazione, anche se compilata, non viene gestita. Quindi il campo PID.3 dei vari segmenti all'interno del messaggio K22 verrà composto allo stesso modo dei campi PID.3 presenti negli altri messaggi anagrafici dell'integrazione anagrafica, quali A28, A31, A40, etc. Esempio di espressione del campo QPD-8: 0^^^^^FACILTY_1^^^^~0^^^^^FACILTY_2^^^^ Segmento RCP Tabella 7: Struttura segmento RCP SEQ LEN DT OPT RP/# TBL# ELEMENT NAME VALORE 1 1 ID O 0091 Query Priority 2 10 CQ O 0126 Quantity Limited Request CE O 0394 Response Modality 4 26 TS C Execution and Delivery Time 5 1 ID O 0395 Modify Indicator SRT O Y Sort-by Field ID O Y Segment group inclusion Esempio di segmento RCP: RCP I 20^RD PATIENT_NAME^1~DOB^2

9 A1. FIELD RCP-1 QUERY PRIORITY Definizione: Questo campo specifica se il messaggio di riposta deve essere immediato o schedulato per un certo istante. I possibili valori che può assumere sono riassunti nella tabella HL7 Table Query priority riportata di seguito. Tabella 8: HL7 Table Query priority Value Description Comment D Deferred Modalità non supportata I Immediate A2. FIELD RCP-2 QUANTITY LIMITED REQUEST Components: <Quantity (NM)> ^ <Units (CE)> Subcomponents for Units (CE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)> Definizione: Questo campo definisce la lunghezza massima della risposta. Di default il numero massimo di record è fissato a 20. Vengono presi in considerazione solo valori < 20 per limitare la ricerca. I possibili valori del campo che specifica l'unità di misura sono riportati nella tabella HL7 Table Quantity limited request di seguito. Tabella 9: HL7 Table Quantity limited request Value Description Message Usage Comment CH Characters RSP/RTB/RDY Unità non supportata LI Lines RTB/RDY Unità non supportata PG Pages RDY Unità non supportata RD Records RSP/RTB/RDY ZO Locally defined A3. FIELD RCP-3 RESPONSE MODALITY Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> Definizione: Questo campo specifica il tempo e il raggruppamento dei messaggi di riposta. Per i possibili valori fare riferimento alla tabella HL7 Table 0394 Response modality riportata di seguito. Tabella 10: HL7 Table 0394 Response modality Value Description Comment R Real Time T Bolus (a series of responses sent at the Modalità non supportata same time without use of batch formatting) B Batch Modalità non supportata

10 A4. FIELD RCP-4 EXECUTION AND DELIVERY TIME Components: <Time (DTM)> ^ <DEPRECATED-Degree of Precision (ID)> Definizione: Questo campo specifica l'ora di invio della risposta alla query richiesta. Questo campo deve essere valorizzato solo nel caso in cui il campo RCP-3 Response Modality contenga D (Deferred). A5. FIELD RCP-5 MODIFY INDICATOR Definizione: Questo campo specifica se si tratta di una nuova richiesta o della modifica di una esistente. I possibili valori sono riportati nella tabella HL7 Table 0395 Modify indicator di seguito. Tabella 11: HL7 Table 0395 Modify indicator Value N M Description New Subscription Modiefied Subscription A6. FIELD RCP-6 SORT-BY FIELD Components: <Sort-by Field (ST)> ^ <Sequencing (ID)> Definizione: Questo campo permette di definire il criterio di ordinamento della lista di risultati inviata nel messaggio K22. IL campo Sort-by Field può assumere i valori riportati nella seguente tabella: Tabella 12: Sort-by Field Value PATIENT_NAME SEX DOB Description Nominativo del paziente, inteso come <cognome>,<nome> Sesso Data di nascita Esempio di espressione del campo RCP-6: PATIENT_NAME^1~DOB^2 A7. FIELD RCP-7 SEGMENT GROUP INCLUSION Definizione: Questo campo permette di specificare i segmenti che devono essere presenti all'interno del messaggio di riposta. Per i possibili valori ammessi in questo campo fare riferimento alla tabella HL7 Table 0391 Segment group riportata di seguito. Tabella 13: HL7 Table 0391 Segment group Value PIDG OBRG ORCG Etc Description PID group OBR group ORC group Nota: Per il momento questa informazione, anche se compilata, non viene gestita. I segmenti presenti all'interno del messaggio K22 verranno composti allo stesso modo degli altri messaggi anagrafici dell'integrazione anagrafica, quali A28, A31, A40, etc.

11 6.2 Patient Demographics Response (Trigger event K22 Find Candidates response) Il messaggio di risposta inviato dal PDS al PDC è composto dai seguenti segmenti: Tabella 14: Struttura messaggio K22 Segmento Descrizione Riferimento MSH Message Header Capitolo 2 in HL7 2.5 MSA Message Acknowledgement Capitolo 2 in HL7 2.5 [ { ERR } ] Error Capitolo 2 in HL7 2.5 QAK Query Acknowledgement Capitolo 5 in HL7 2.5 QPD Query Parameter Definition Capitolo 5 in HL7 2.5 [ { PID Patient Identification Capitolo 3 in HL7 2.5 [ PD1 ] Patient Additional Demographic Capitolo 3 in HL7 2.5 [ PV1 ] Patient Visit Capitolo 3 in HL7 2.5 [ QRI ] } ] Query Response Instace Capitolo 5 in HL7 2.5 [ DSC ] Continuation Pointer Capitolo 2 in HL7 2.5 Dopo aver ricevuto il messaggio Q22 e risposto con un ACK, il PDS apre un'altra comunicazione in cui invierà il messaggio K22 al PDC, il quale deve rispondere con un ACK. Di seguito verrà dettagliata la composizione dei segmenti obbligatori (effettivamente utilizzati in questa integrazione), con le relative informazioni da riportare SEGMENTO MSH Vedi paragrafo SEGMENTO MSH SEGMENTO MSA Tabella 15: Struttura segmento MSA SEQ LEN DT OPT RP/# TBL# ELEMENT NAME 1 2 ID R 0008 Acknowledgment Code 2 20 ST R Message Control ID 3 80 ST B Text Message 4 15 NM O Expected Sequence Number 5 W Delayed Acknowledgment Type CE R 0357 Error Condition Tale segmento riporta gli stessi valori del acknowledge inviato come conferma del messaggio Q22, per tanto non viene dettagliato in questa sezione.

12 6.2.3 SEGMENTO QAK Tabella 16: Struttura segmento QAK SEQ LEN DT OPT RP/# TBL# ELEMENT NAME 1 32 ST C Query Tag 2 2 ID O 0208 Query Response Status CE O 0471 Message Query Name 4 10 NM O Hit Count 5 10 NM O This payload 6 10 NM O Hits remaining A1. FIELD QAK-1 QUERY TAG Definizione: Questo campo serve per associare il messaggio alla query di interrogazione ricevuta. In particolare riporta lo stesso valore contenuto nel campo QPD-2 del messaggio Q22. A2. FIELD QAK-2 QUERY RESPONSE STATUS Definizione: Questo campo riporta l'esito della query eseguita con i parametri indicati nel messaggio Q22. I possibili valori che può assumere sono riportati nella tabella HL7 Table 0208 Query Response Status di seguito. Tabella 17: HL7 Table 0208 Query Response Status Value OK NF AE AR Description Data found, no errors (this is the default) No data found, no errors Application error Application reject Nota: In caso di Application error o Application reject, questo viene notificato direttamente nel primo ACK di risposta al messaggio Q22, e il messaggio K22 non viene generato. Quindi nel caso reale questo campo potrà essere valorizzato solo con OK o NF. A3. FIELD QAK-3 MESSAGE QUERY NAME Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> Definizione: Questo campo contiene il nome della query, indicato nel messaggio di richiesta Q22, campo QPD-1. Per i valori di questo campo fare riferimento alla tabella User-defined Table 0471 Query name specificata in precedenza. A4. FIELD QAK-4 HIT COUNT Definizione: Questo campo contiene il numero di record trovati eseguendo la query richiesta e riportati nel messaggio. A5. FIELD QAK-5 THIS PAYLOAD Definizione: Questo campo contiene il numero di record presenti nel messaggio in caso si utilizzi il Continuation Protocol.

13 A6. FIELD QAK-6 HITS REMAINING Definizione: Questo campo contiene il numero di record trovati con la query che devono ancora esser inviati nel caso si utilizzi il Continuation Protocol SEGMENTO QPD Questo segmento è uguale al segmento QPD inviato nel messaggio Q22. Per le specifiche fare riferimento al paragrafo Segmento QPD SEGMENTO PID Questo segmento è composto dai campi specificati nella tabella a riportata di seguito. Per la valorizzazione di questo segmento fare riferimento ai documenti di integrazione anagrafica. Tabella 18: Struttura segmento PID SEQ LEN DT OPT RP/# TBL# ELEMENT NAME 1 4 SI O Set ID - PID 2 20 CX B Patient ID CX R Y Patient Identifier List 4 20 CX B Y Alternate Patient ID - PID XPN R Y Patient Name XPN O Y Mother s Maiden Name 7 26 TS O Date/Time of Birth 8 1 IS O 0001 Administrative Sex XPN B Y Patient Alias CE O Y 0005 Race XAD O Y Patient Address 12 4 IS B 0289 County Code XTN O Y Phone Number - Home XTN O Y Phone Number - Business CE O 0296 Primary Language CE O 0002 Marital Status CE O 0006 Religion CX O Patient Account Number ST B SSN Number - Patient DLN B Driver's License Number - Patient CX O Y Mother's Identifier CE O Y 0189 Ethnic Group ST O Birth Place 24 1 ID O 0136 Multiple Birth Indicator 25 2 NM O Birth Order CE O Y 0171 Citizenship CE O 0172 Veterans Military Status CE B 0212 Nationality TS O Patient Death Date and Time 30 1 ID O 0136 Patient Death Indicator 31 1 ID O 0136 Identity Unknown Indicator

14 SEQ LEN DT OPT RP/# TBL# ELEMENT NAME IS O Y 0445 Identity Reliability Code TS O Last Update Date/Time HD O Last Update Facility CE C 0446 Species Code CE O 0447 Breed Code ST O Strain CE O Y 0429 Production Class Code CWE O Y 0171 Tribal Citizenship SEGMENTO PV1 Questo segmento è stato aggiunto per gestire il ritorno dei dati dell'ultimo ricovero come riposta alle query HL7 per nosologico. Per la valorizzazione di questo segmento fare riferimento ai documenti di integrazione anagrafica. 7. MESSAGGI DI ESEMPIO ESEMPIO DI MESSAGGIO Q22-K22 CON HIT COUNT A ZERO A1. QUERY Q22 MSH ^~\& SENDING_APPLICATION SENDING_FACILITY IE-ANAGRAFE GPI QBP^Q22^QBP_Q22 1 D 2.5 QPD Q22^FIND CANDIDATES^HL7NNN 80 FINDBYEPID 1 0^^^^^FACILTY_1^^^^~0^^^^^FACILTY_2^^^^ ^^^GOOD HEALTH HOSPITAL~^^^SOUTH LAB RCP I 20^RD PATIENT_NAME^1~DOB^2 A2. RISPOSTA K22 MSH ^~\& IE-ANAGRAFE GPI SENDING_APPLICATION SENDING_FACILITY ^K22^ 1 P 2.5 MSA AA 1 QAK NF Q22^FIND CANDIDATES^HL7NNN^^^^ 0 QPD Q22^FIND CANDIDATES^HL7NNN 80 FINDBYEPID 1 0^^^^^FACILTY_1^^^^~0^^^^^FACILTY_2^^^^ ^^^GOOD HEALTH HOSPITAL~^^^SOUTH LAB

15 7.1.2 ESEMPIO DI MESSAGGIO Q22-K22 CON HIT COUNT MAGGIORE DI ZERO A1. QUERY Q22 MSH ^~\& SENDING_APPLICATION SENDING_FACILITY IE-ANAGRAFE GPI QBP^Q22^QBP_Q22 1 D 2.5 QPD Q22^FIND CANDIDATES^HL7NNN 80 FINDBYPARAMS 1 0^^^^^FACILTY_1^^^^~0^^^^^FACILTY_2^^^^ ^^^GOOD HEALTH HOSPITAL~^^^SOUTH LAB RCP I 2^RD PATIENT_NAME^1~DOB^2 A2. RISPOSTA K22 MSH ^~\& IE-ANAGRAFE GPI ^K22^ 1 P 2.5 MSA AA 1 QAK OK Q22^FIND CANDIDATES^HL7NNN^^^^ 4 QPD Q22^FIND CANDIDATES^HL7NNN 80 FINDBYPARAMS 1 0^^^^^FACILTY_1^^^^~0^^^^^FACILTY_2^^^^ ^^^GOOD HEALTH HOSPITAL~^^^SOUTH LAB PID ^^^^FI^IE-ANAGRAFE^^^A^^~RSSCLD40S11L123J^^^^NI^IE- ANAGRAFE^^^A^^~^OK^^^RES_MOV^IE-ANAGRAFE^^^A^^~^^^^RES_ETI^IE- ANAGRAFE^^^A^^ M VERLA VIA DI PROVA, 17^^GIOVO^TN^^^L^004^022092^^^^^~VERLA VIA DI PROVA, 17^^GIOVO^TN^^^H^004^022092^^^^^~^^TRENTO^TN^^^BDL^^022205^^^^^ RSSCLD40S11L123J^^^^^^^^^^ RSSCLD40S11L123J PID ^^^^FI^IE-ANAGRAFE^^^A^^~RSSCLD62C29F456Q^^^^NI^IE- ANAGRAFE^^^A^^~^OK^^^RES_MOV^IE-ANAGRAFE^^^A^^~^^^^RES_ETI^IE- ANAGRAFE^^^A^^ M ERBOSTA^^MILANO^MI^^^L^003^015146^^^^^~ERBOSTA^^TALAMONA^SO^^^H^003^ ^^^^^~^^MORBEGNO^SO^^^BDL^^014045^^^^^ S RSSCLD62C29F456Q^^^^^^^^^^