DOCUMENTAZIONE TECNICA

Transcript

1 DOCUMENTAZIONE TECNICA Standard HL7 Document Management SPECIFICHE DEI MESSAGGI AZIENDA OSPEDALIERA SANTA CROCE E CARLE DI CUNEO Redazione: Bonetto Fabio Data: 14/09/2011 Archivio : STORIA DELLE MODIFICHE APPORTATE Data Versione Autore Note 23/02/ Zanella Gianpaolo Prima versione del documento 14/02/ Bonetto Fabio Aggiornamento specifiche nuovo Document Repository SFW\MD04-02 Documentazione tecnica Pagina 1 di 18

2 INDICE DEGLI ARGOMENTI Standard HL7 Specifiche Document Management CONTENUTO DEL DOCUMENTO...3 MODALITÀ DI COMUNICAZIONE...4 EVENTI GESTITI...5 STRUTTURA MESSAGGI...8 STRUTTURA SEGMENTI...9 TABELLE DI RIFERIMENTO...15 SFW\MD04-02 Documentazione tecnica Pagina 2 di 18

3 CONTENUTO DEL DOCUMENTO Il presente documento riporta le specifiche di integrazione con IE-Repository per la pubblicazione di documenti, la modifica e la cancellazione mediante utilizzo di messaggi HL7. Tale documento descrive esclusivamente la sintassi dei messaggi gestiti, per consultare i contesti di applicazione dei vari messaggi fare riferimento al documento GPI sulle transazioni. 1.1Documentazione e riferimenti HL7 v 2.5 Standards [GPI][HL7][v-2.0] Specifiche Patient Administration.pdf [GPI][HL7][v-2.2] Specifiche Order Entry.pdf 1.2Definizioni Order placer: Order filler: Message: Segment: Data field: Delimiters: l applicazione che origina un messaggio HL7. l applicazione che elabora o che risponde ad un messaggio HL7. unità atomica di dati trasferiti fra due sistemi. E composto da un gruppo di segmenti posti in una determinata sequenza. Ogni messaggio è definito da un tipo che ne determina lo scopo. Ad esempio il messaggio SIU è usato per trasmettere schedulazioni. raggruppamento logico di data fields. I segmenti possono essere obbligatori o facoltativi. Possono apparire in modo ripetuto o essere unici. Ogni segmento è identificato da un codice a tre caratteri. un campo è una stringa di caratteri. Il valore nullo è diverso dall omissione del campo (non presente). I campi hanno una posizione predefinita all interno del segmento. I campi sono separati da un carattere delimitatore e possono avere lunghezza variabile nonostante sia definita una lunghezza massima raccomandata. I campi possono essere obbligatori (R), facoltativi (O), da valorizzare se si desidera compatibilità con versioni precedenti (B) dipende (C). Il carattere che termina un segmento deve essere sempre CR (in ASCII, esadecimale 0D). Gli altri delimitatori sono definiti nel segmento di intestazione (MSH). Delimitatore di campo nel 4 carattere e gli altri come definito nel primo campo dopo il segmento ID. In mancanza di altre considerazioni HL7 raccomanda l utilizzo dei caratteri presenti in tabella. Esempio: MSH ^~\& <cr> L applicazione ricevente dovrà utilizzare i caratteri delimitatori presenti nel segmento di intestazione. SFW\MD04-02 Documentazione tecnica Pagina 3 di 18

4 Delimiter Segment Terminator Suggested Value <cr> hex 0D Encoding Character Position Usage - Terminates a segment record. This value cannot be changed by implementors. Field Separator - Separates two adjacent data fields within a segment. It also separates the segment ID from the first data field in each segment. Component Separator ^ 1 Separates adjacent components of data fields where allowed. Repetition Separator ~ 2 Separates multiple occurrences of a field where allowed. Escape Character \ 3 Escape character for use with any field represented by an ST, TX or FT data type, or for use with the data (fourth) component of the ED data type If no escape characters are used in a message, this character may be omitted. However, it must be present if subcomponents are used in the message. Subcomponent Separator & 4 Separates adjacent subcomponents of data fields where allowed. If there are no subcomponents, this character may be omitted. Modalità di comunicazione Lo scambio dati avverrà attraverso canale di comunicazione socket con protocollo TCP/IP su porte appositamente concordate. Sul server sarà attivo un servizio HL7 costituito da: 1) listener in grado di interpretare i messaggi in arrivo e di fornire il necessario acknowledge. 2) processo in grado di inviare in modo controllato le notifiche di variazioni anagrafiche e le richieste di esami diagnostici. Il sistema gestirà opportunamente l acknowledge o la condizione di errore garantendo l invio successivo del messaggio o la notifica dell eventuale anomalia in apposito log. Il servizio utilizzerà un apposita tabella di configurazione in cui saranno censiti i sistemi destinatari dei messaggi con indirizzo del server di riferimento, porta di comunicazione e versione HL7 in uso per quel sistema. SFW\MD04-02 Documentazione tecnica Pagina 4 di 18

5 Eventi Gestiti Gli eventi di document management gestiti dal middleware HL7Manager sono i seguenti: EVENT DESCRIPTION NOTE CHAPTER HL7 MDM^T02 Original Document Notification and Content Inserimento nuovo documento MDM^T06 Document Addendum Notification and Content Inserimento documento aggiuntivo ad uno precedentemente inviato MDM^T10 Document Replacement Notification and Content Sostituzione di un documento precedentemente inviato MDM^T11 Document Cancel Notification Cancellazione di un documento precedentemente inviato Evento MDM^T02 Il messaggio T02 viene utilizzato per trasmettere la prima versione di un referto. La struttura semplificata di questo messaggio è la seguente: Segmento MSH EVN PID PV1 Message Header Event Type Dati anagrafici assistito Dati relativi all'accesso Descrizione [{ Blocco di segmenti relativi ad ogni prestazione presente all'interno dell'ordine }] TXA ORC OBR Utilizzato per trasmettere dati che risultano comuni per uno o più ordini. Utilizzato per trasmettere specifiche informazioni relative a studi diagnostici o osservazioni, esami o valutazioni. Contiene informazioni specifiche relative al documento [ { OBX } ] Contiene il documento effettivo, codificato in base Evento MDM^T06 Il messaggio T06 viene utilizzato per trasmettere un documento integrativo rispetto ad una versione precedentemente inviata. Il nuovo documento è considerato come un addendum, quindi la versione precedente continua ad esistere ed essere valida, e la totalità dell'informazione è data da entrambi i documenti. La struttura semplificata di questo messaggio è la seguente: SFW\MD04-02 Documentazione tecnica Pagina 5 di 18

6 Segmento MSH EVN PID PV1 Message Header Event Type Standard HL7 Specifiche Document Management Descrizione Dati anagrafici assistito Dati relativi all'accesso [{ Blocco di segmenti relativi ad ogni prestazione presente all'interno dell'ordine }] TXA ORC OBR Utilizzato per trasmettere dati che risultano comuni per uno o più ordini. Utilizzato per trasmettere specifiche informazioni relative a studi diagnostici o osservazioni, esami o valutazioni. Contiene informazioni specifiche relative al documento [ { OBX } ] Contiene il documento effettivo, codificato in base Evento MDM^T10 Il messaggio T10 viene utilizzato per trasmettere un documento sostitutivo rispetto ad una versione precedentemente inviata. Quindi la versione precedente verrà invalidata all'interno di IE-Repository. La struttura semplificata di questo messaggio è la seguente: Segmento MSH EVN PID PV1 Message Header Event Type Dati anagrafici assistito Dati relativi all'accesso Descrizione [{ Blocco di segmenti relativi ad ogni prestazione presente all'interno dell'ordine }] TXA ORC OBR Utilizzato per trasmettere dati che risultano comuni per uno o più ordini. Utilizzato per trasmettere specifiche informazioni relative a studi diagnostici o osservazioni, esami o valutazioni. Contiene informazioni specifiche relative al documento [ { OBX } ] Contiene il documento effettivo, codificato in base Evento MDM^T11 Il messaggio T11 viene utilizzato per invalidare un documento presente all'interno di IE- Repository. La struttura semplificata di questo messaggio è la seguente: Segmento MSH Message Header Descrizione SFW\MD04-02 Documentazione tecnica Pagina 6 di 18

7 Segmento EVN PID PV1 Event Type Standard HL7 Specifiche Document Management Descrizione Dati anagrafici assistito Dati relativi all'accesso [{ Blocco di segmenti relativi ad ogni prestazione presente all'interno dell'ordine }] TXA ORC OBR Utilizzato per trasmettere dati che risultano comuni per uno o più ordini. Utilizzato per trasmettere specifiche informazioni relative a studi diagnostici o osservazioni, esami o valutazioni. Contiene informazioni specifiche relative al documento SFW\MD04-02 Documentazione tecnica Pagina 7 di 18

8 Struttura messaggi Di seguito viene presentata la struttura completa dei messaggi gestiti. Struttura completa MDM MDM General Order Message Chapter HL7 Utilizzato MSH Message Header x [ { STF } ] Software Segment EVN Event Type x PID Patient Identification x PV1 Patient Visit x [{ --- COMMON ORDER begin ORC Common Order x [{ --- TIMING begin TQ1 Timing/Quantity [{ TQ2 }] Timing/Quantity Order Sequence }] --- TIMING end OBR Order Request x [{ NTE }] Notes and comments about the obstervation request (OBR) }] --- COMMON ORDER end TXA Document Notification x { OBX Observation/Result (one or more required) x [{ NTE }] Notes and comments about the obstervation request (OBR) } SFW\MD04-02 Documentazione tecnica Pagina 8 di 18

9 Struttura segmenti Nota sulle tabelle dei segmenti Le tabelle che rappresentano la struttura dei messaggi contengono la seguente classe di informazioni: SEQ: numero di sequenza, ovvero la posizione del campo all'interno del messaggio considerato; LEN: lunghezza massima del campo; DT: Datatype del campo, che descrive quali informazioni contiene al suo interno; OPT: indica se il campo è obbligatorio (R - required) o opzionale (O - optional) all'interno del messaggio; TBL: indica la tabella di riferimento per i valori che può assumere un campo, se si tratta di un dato tabellato; ELEMENT NAME: descrizione del contenuto del campo; VALORE: contenuto atteso del campo. MSH - Message Header (obbligatorio) Segmento di testata del messaggio, contiene le informazioni generali del messaggio (mittente, destinatario tipo di messaggio). 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 <sistema inviante> HD R 0362 Sending Facility <azienda inviante> HD R 0361 Receiving Application <sistema ricevente> HD R 0362 Receiving Facility <azienda ricevente> 7 26 TS R Date/Time Of Message <yyyymmddhhmmss> 9 15 MSG R Message Type MDM^T02^MDM_T ST R Message Control ID <id univoco del messaggio> 11 3 PT R Processing ID P VID R Version ID 2.5 NTE Notes And Comment Segment SEQ LEN DT OPT RP/# TBL# ELEMENT NAME VALORE 1 4 SI O Set ID - NTE 2 8 ID O 0105 Source of Comment FT O Comment CE O 0364 Comment Type NTE-1 Set ID NTE (SI) Questo campo contiene il numero progressivo della nota. SFW\MD04-02 Documentazione tecnica Pagina 9 di 18

10 NTE-2 Source of Comment (ID) Questo campo identifica la sorgente del commento. Per i possibili valori fare riferimento alla tabella [HL7 table 0105]. NTE-3 Comment (FT) Questo campo contiene il testo della nota. NTE-4 Comment Type (CE) Questo campo identifica la tipologia della nota. I fields da considerare sono i seguenti: CE.1 (identifier): contiene il codice della tipologia del commento. Per i possibili valori fare riferimento alla tabella [User-defined table 0364]; CE.2 (text): contiene la descrizione della tipologia del commento; CE.3 (name of coding system): nome del sistema di codifica utilizzato. Per i possibili valori fare riferimento alla tabella [HL7 Table 0396]. PID - Patient Identification Segment Contiene i dati anagrafici del paziente. Per la specifica fare riferimento al documento di Patient Administration. PV1 - Patient Visit Segment Contiene i dati della visita. Per la specifica fare riferimento al documento di Patient Administration. Campi in evidenza: PV1-2 Patient Class (IS) Questo campo rappresenta la classificazione del paziente, riportando la tipologia di accesso. Per i possibili valori fare riferimento all tabella [User-defined Table 0004]. PV1-3 Assigned Patient Location (PL) Questo campo contiene le informazioni della posizione del paziente all'interno della struttura ospedaliera. Le informazioni contenute nei vari fields sono: PL.1 (point of care): codice disciplina; PL.2 (room): codice reparto/ambulatorio; PL.3 (bed): codice letto; PL.4 (facility): codice istituto; PL.9 (location description): descrizione disciplina. In caso di patient class O valorizzare i campi PL4 con l'istituto, PL1 con la disciplina e PL2 con l'ambulatorio. In tutti gli altri casi valorizzare i campi PL4 con l'istituto, PL1 con la disciplina e PL2 con il reparto. SFW\MD04-02 Documentazione tecnica Pagina 10 di 18

11 PV1-19 Visit Number (CX) Standard HL7 Specifiche Document Management Questo campo contiene l'identificativo univoco assegnato ad ogni singola visita o episodio. Per ulteriori dettagli fare riferimento al documento di Patient Administration. Le informazioni contenute nei vari fields sono: CX.1 (id number): identificativo univoco della cartella/episodio; CX.5 (identifyer type code): identificativo del contesto di riferimento ( N in caso di nosologico, C in caso di cartella dea, A in caso di accettazione, P in caso di prericovero, CUP in caso di prenotazione ambulatoriale ed E in casi non classificati). ORC Common Order Segment Contiene i dati dell'ordine collegato al quale è collegato il referto. Per la specifica fare riferimento al documento di Order Entry. Campi in evidenza: ORC-4 Placer Group Number (EI) Contiene il numero della richiesta generata all'interno degli applicativi GPI (in funzione di Placer). OBR Observation Request Segment OBR-4 Universal Service Identifier (CE) Questo campo contiene il codice dell'esame richiesto all'interno dell'ordine (esame prenotato o accettato...) Per ulteriori dettagli fare riferimento al documento di Order Entry. TXA Transcription Document Header Segment Il segmento TXA contiene le informazioni che identificano e classificano il documento trasmesso. SEQ LEN DT OPT RP/# TBL# ELEMENT NAME VALORE 1 4 SI R Set ID - TXA <progressivo TXA, sempre uguale a 1> 2 30 IS R 0270 Document Type 3 2 ID C 0191 Document Content Presentation 6 26 TS O Origination Date/Time <data e ora del referto> XCN O Y Originator Code/Name <autore> XCN O Y Assigned Document Authenticator <responsabile del documento> EI R Unique Document Number <codice univoco del documento + versione> EI C Parent Document Number <codice univoco + versione del documento collegato> EI O Y Placer Order Number EI O Filler Order Number SFW\MD04-02 Documentazione tecnica Pagina 11 di 18

12 SEQ LEN DT OPT RP/# TBL# ELEMENT NAME VALORE ST O Unique Document File Name 17 2 ID R 0271 Document Completition Status TXA-1 Set ID TXA (SI) Il presente campo indica il valore progressivo del segmento all interno della transazione. TXA-2 Document Type (SI) Questo campo specifica la tipologia del documento trasmesso. Per i possibili valori fare riferimento alla tabella [User-Defined table 0270]. TXA-3 Document Type (SI) Questo campo specifica la natura del documento, sulla base del metodo con cui è stato originato. Per i possibili valori fare riferimento alla tabella [HL7 table 0191]. TXA-6 Origination Date/Time (TS) Questo campo contiene la data e l'ora di creazione del documento. TXA-9 Originator Code/Name (XCN) Questo campo contiene il riferimento all'autore del documento. Sono valorizzati i seguenti fields: XCN.1 (idnumber): contiene l'identificato dell'autore (il nome utente del medico refertante); XCN.2 (family name): contiene il cognome dell'autore; XCN.3 (given name): contiene il nome dell'autore. TXA-10 Assigned Document Authenticator (XCN) Questo campo contiene il riferimento del responsabile del documento, ad esempio il medico che ha firmato il referto. Sono valorizzati i seguenti fields: XCN.1 (idnumber): contiene l'identificato del responsabile (il nome utente del medico refertante); XCN.2 (family name): contiene il cognome del responsabile; XCN.3 (given name): contiene il nome del responsabile. TXA-12 Unique Document Number (EI) Questo campo contiene l'identificativo univoco del documento, generato dal sistema inviante. Sono valorizzati i seguenti fields: EI.1 (entity identifier): contiene l'identificativo univoco del documento inviato. Tale identificativo è composto dal codice del documento, assegnato dal sistema inviante, e dal numero di versione sepatato da SFW\MD04-02 Documentazione tecnica Pagina 12 di 18

13 Il nome del documento deve essere costruito nel seguente modo: prefissodocumento + identificativodipartimentale + idunivocodipartimentale +.pdf Il prefisso deve essere ad esempio ro_ per i registri operatori, rx_ per la radiologia, lab_, mn_, ap_, amb_, e cosi via. Quindi ad esempio la versione 1 del documento con codice viene codificato come ro_dg_ @1. Nota: la codifica di numero documento e versione non è definita nelle specifiche ufficiali HL7, è semplicemente una convenzione adottata in mancanza di un campo appropriato per il passaggio della versione. TXA-13 Parent Document Number (EI) Nel caso di documento sostitutivo/integrativo, questo campo contiene l'identificativo univoco del documento collegato. Per dettagli sulla struttura fare riferimento al paragrafo [TXA-12 Unique Document Number]. TXA-14 Placer Order Number (EI) Contiene il numero della richiesta generata all'interno degli applicativi GPI (in funzione di Placer). Per ulteriori dettagli fare riferimento al paragrafo [ORC-4 Placer Group Number]. TXA-15 Filler Order Number (EI) Contiene il numero univoco della richiesta assegnato dal filler, al momento della ricezione dell'ordine, al quale è collegato il documento. Per ulteriori dettagli fare riferimento al paragrafo [ORC-3 Filler Order Number]. TXA-16 Unique Document File Name (ST) Questo campo contiene il nome univoco del documento assegnato dal sistema inviante. TXA-17 Document Completition Status (ID) Questo campo contiene lo stato di completamento del documento. Per i possibili valori fare riferimento alla tabella [HL7 table 0271]. OBX Observation Segment Usage Il segmento OBX contiene id documento effettivo, codificato in base64. SEQ LEN DT OPT RP/# TBL# ELEMENT NAME VALORE 1 4 SI R Set ID OBX <numero di sequenza> SFW\MD04-02 Documentazione tecnica Pagina 13 di 18

14 SEQ LEN DT OPT RP/# TBL# ELEMENT NAME VALORE 2 2 ID R 125 Value Type 5 * * C/R Observation Value 11 1 ID R/NA 0085 Observation Result Status OBX-1 Set-ID OBX Il presente campo indica il valore progressivo del segmento all interno della transazione. OBX-2 Value Type Questo campo defisce il datatype utilizzato per comporre il campo OBX-5 (Observation Value). Per i possibili valori fare riferimento alla tabella [HL7 table 0125]. OBX-5 Observation Value Questo campo contiene il documento, formattata secondo il datatype indicato nel campo OBX-2 (value type). Per la trasmissione di documenti viene utilizzato il datatype ED (Encapsuled Data), valorizzato come segue: ED.2 (type of data): indica il tipo di dato presente nel campo ED.5. Per i possibili valori fare riferimento alla tabella [HL7 table 0191]; ED.3 (data subtype): specifica ulteriormente il tipo di dato presente nel campo ED.5. Per i possibili valori fare riferimento alla tabella [HL7 table 0291]; ED.4 (encoding): indica il tipo di codifica utilizzata per trasmettere il documento. Per i possibili valori fare riferimento alla tabella [HL7 table 0299]; ED.5 (data): contiene il documento. OBX-11 Observation Result Status Questo campo riporta lo stato di completamento del documento contenuto nella ripetizione corrente del segmento OBX. Per i possibili valori fare riferimento alla tabella [HL7 table 0085]. SFW\MD04-02 Documentazione tecnica Pagina 14 di 18

15 Tabelle di riferimento HL7 table 0105 Source of comment L Ancillary (filler) department is source of comment Commento generato dal filler P Orderer (placer) is source of comment Commento generato dal placer O Other system is source of comment Commento generato da altri sistemi HL7 table 0085 Observation result status codes interpretation C D F I N O P R S X U W Record coming over is a correction and thus replaces a final result Deletes the OBX record Final results; Can only be changed with a corrected result Specimen in lab; results pending Not asked; used to affirmatively document that the observation identified in the OBX was not sought when the universal service ID in OBR-4 implies that it would be sought Order detail description only (no result) Preliminary results Results entered -- not verified Partial results Results cannot be obtained for this observation Results status change to final without retransmitting results already sent as preliminary. E.g., radiology changes status from preliminary to final Post original as wrong, e.g., transmitted for wrong patient Stato utilizzato per indicare che il referto allegato è firmato digitalmente SFW\MD04-02 Documentazione tecnica Pagina 15 di 18

16 HL7 table 0125 Value Type AD CE CF CK CN CP CX DT Address Coded Entry Coded Element With Formatted Values Composite ID With Check Digit Composite ID And Name Composite Price Extended Composite ID With Check Digit Date ED Encapsulated Data Utilizzato per la trasmissione di documenti FT MO NM PN RP SN ST TM TN TS TX XAD XCN XON XPN XTN Formatted Text (Display) Money Numeric Person Name Reference Pointer Structured Numeric String Data Time Telephone Number Time Stamp (Date & Time) Text Data (Display) Extended Address Extended Composite Name And Number For Persons Extended Composite Name And Number For Organizations Extended Person Name Extended Telecommunications Number HL7 table 0191 Type Of Referenced Data AP AU IM Other application data, typically uninterpreted binary data (HL7 V2.3 and later) Audio data (HL7 V2.3 and later) Image data (HL7 V2.3 and later) multipart MIME multipart package (CDA per 2.5.2) TEXT Machine readable text document (HL7 V2.3.1 and later) SFW\MD04-02 Documentazione tecnica Pagina 16 di 18

17 User-defined table 0270 Document Type REGOP Registro operatorio LAB Referto di laboratorio RAD Referto di radiologia MN Referto di medicina nucleare AMB Referto ambulatoriale EXT Referto esterno Generico HL7 table 0271 Document Completition Status DI DO IP IN PA AU AL Dictated Documented In Progress Incomplete Pre-authenticated Authenticated Legally authenticated HL7 table 0291 Subtype of referenced data BASIC DICOM FAX GIF HTML JOT JPEG Octet-stream PICT PostScript RTF SGML TIFF x-hl7-cda-level-one XML ISDN PCM audio data Digital Imaging and Communications in Medicine Facsimile data Graphics Interchange Format Hypertext Markup Language Electronic ink data (Jot 1.0 standard) Joint Photographic Experts Group Uninterpreted binary data PICT format image data PostScript program Rich Text Format Standard Generalized Markup Language (HL7 V2.3.1 and later) TIFF image data HL7 Clinical Document Architecture Level One document Extensible Markup Language (HL7 V2.3.1 and later) SFW\MD04-02 Documentazione tecnica Pagina 17 di 18

18 HL7 table 0299 Encoding Standard HL7 Specifiche Document Management A Hex Base64 No encoding - data are displayable ASCII characters Hexadecimal encoding - consecutive pairs of hexadecimal digits represent consecutive single octets Encoding as defined by MIME (Multipurpose Internet Mail Extensions) standard RFC Four consecutive ASCII characters represent three consecutive octets of binary data. Base64 utilizes a 65-character subset of US-ASCII, consisting of both the upper and lower case alphabetic characters, digits "0" through 9, +", /", and = Utilizzato per la trasmissione di referti User-defined table 0362 Facility IE-DEGENTI IE-RICHIESTE IE-DEA IPPOCRATE-DEGENTI IPPOCRATE-RICHIESTE IPPOCRATE-DEA User-defined table 0364 Comment Type Value Coding System Description Comment N5 99GPICOMMTYPE Anamnesi DEA [GPI] User-defined table 0004 Patient Class E Emergency Accesso in pronto soccorso I Inpatient Ricovero ordinario O Outpatient Accesso ambulatoriale (accesso diretto da parte di pazienti esterni D Day Hospital Ricovero diurno P Preadmit Prericovero C Postadmit Paziente in regime di prestazioni post ricovero N Not applicable Valore da inserire per I messaggi anagrafici U Unknow Non conosciuto SFW\MD04-02 Documentazione tecnica Pagina 18 di 18