Ebrev - abonnementtjenester NAV

Transkript

1 .. Ebrev - abonnementtjenester NAV Informasjonsmodell og XML meldingsbeskrivelse VERSJON 1.0 Status: Til utprøving 1. februar 2010 KITH-rapport 1021:2010

2 Innhold 1 Innledning Bakgrunn Bruksområder Om dette dokumentet Informasjonsinnhold Hodemelding TOKT felleskomponenter Abonnementstatus-type (AbonnementStatusType) Ebrev samhandleradresser Ebrev samhandleradresser (EbrevSamhandlerAdresser) Organisasjonsenhet (Organisasjonsenhet) Ebrev forespørsel Ebrev parametertype (EbrevParamType) Ebrev forespørsel (EbrevForesporsel) Hent samhandleradresser (HentSamhandlerAdresser) Start abonnement (StartAbonnement) Stopp abonnement (StoppAbonnement) Hent abonnementstatus (HentAbonnementStatus) Test Ebrev (TestEbrev) Ebrev abonnementstatus Ebrev abonnementstatus (EbrevAbonnementStatus) Meldings- og implementasjonsbeskrivelse Namespace Datatyper ebxml Hodemelding Hvilke klasser som skal være med Applikasjonskvittering Kodeverk for Applikasjonskvittering XML-meldingens struktur XML Schema... 15

3 4 Referanser

4 1 Innledning Dette kapitlet gir en kort beskrivelse av dokumentet: Bakgrunn for arbeidet, bruksområder av dette dokumentet samt en kort oversikt over innholdet i dokumentet. 1.1 Bakgrunn I forbindelse med prosjektet ELSAM 2009 (Elektronisk Samhandling) skal det utvikles en løsning som har som formål å øke graden av elektronisk samhandling mellom NAV og behandlere. Løsningen skal støtte elektronisk utsending av meldinger fra NAV til behandlere, og vil i første omgang være begrenset til et utvalg brev fra NAV. Løsningen baseres på at samhandler melder inn (abonnerer på) at brev til en adresse skal sendes til elektronisk adresse. Elektronisk adresse i denne sammenheng er ikke kun en e-post adresse, men består av kommunikasjonsparametre for ebxml som CPP/CPA (enighetsinformasjon), sertifikatinformasjon, samt e-postadresse til kommunikasjonsserver hos samhandler. Meldingene sendes som et brev i pdf-format med en elektronisk konvolutt rundt. Løsningen skal kunne håndtere meldinger med personsensitive opplysninger. Standard e-post kan derfor ikke benyttes. NAVs samhandlingsplattform med eksisterende sikkerhets og utsendingsmekanismer skal benyttes (PKI/ebXML). Dokumentet inneholder informasjonsmodell og XML meldingsbeskrivelse for tjenesten Ebrev - abonnementtjenester NAV. Dette dokumentet beskriver bruk abonnementtjenestene hos Nav, beskrivelsen av formatet for selve Ebrevet er beskrevet i et eget dokument: Ebrev - Elektronisk utsending av brev.[ebrev] 1.2 Bruksområder Dokumentet er beregnet på leverandører av fagsystemer, herunder kommunikasjonsleverandører, som skal implementere tjenesten i sitt system. 1.3 Om dette dokumentet Dokumentet er organisert på følgende måte: Kap. 2 inneholder beskrivelse av informasjonsinnholdet. Kap. 3 inneholder nærmere detaljer om meldings- og implementasjonsbeskrivelse. Kap. 4 inneholder referanser

5 2 Informasjonsinnhold Ebrev abonnementstatus Ebrev forespørsel Ebrev samhandleradresser TOKT felleskomponenter Figur 1 Pakkediagram 2.1 Hodemelding Dette kapittelet spesifiserer hvilke felter som skal plasseres i hodemeldingen og hvor disse skal plasseres. I tillegg til elementene som er nevnt under, må alle obligatoriske klasser og dataelementer spesifisert i hodemeldingen [HODE] være med i meldingsinstansene. Avsender-informasjon fylles ut som beskrevet i Standard for hodemelding Merk at det er spesielle krav til utfylling av avsenderidentifikasjon. Minimumskravet for dette er som følger: Felt navn Element Beskrivelse Institusjon MsgHead/MsgInfo/Sender/Organisation/Ident Benytt både HER og ENH hvis mulig Institusjonsnavn Identifikasjon Navn MsgHead/MsgInfo/Sender/Organisation/Organis ationname MsgHead/MsgInfo/Sender/Organisation/Healthca reprofessional/ident MsgHead/MsgInfo/Sender/Organisation/Healthca reprofessional/familyname MsgHead/MsgInfo/Sender/Organisation/Healthca reprofessional/givenname Navn på legekontor/praksis/avdeling Samhandlers FNR skal være med. HPR-nummer kan benyttes i tillegg til evt andre ID er (f.eks. HER-ID). Samhandlers navn Adresse MsgHead/MsgInfo/Sender/Organisation/Address Samhandlers adressse. Vi forventer kun en adresse entitet som er relevant i til det forholdet som meldingen beskriver. Adresse/Type benyttes ikke. Telefon MsgHead/MsgInfo/Sender/Organisation/TeleCo m/ Samhandlers telefonnummer bør være med. Vi forventer kun ett telefonnummer som er relevant til

6 det forholdet som meldingen beskriver. Telecom/TypeTelecom benyttes ikke. Mottaker-informasjon (i dette tilfelle NAV). Kun de obligatoriske feltene i spesifikasjon til hodemeldingen må fylles ut. Identifikasjonen av NAV (som er mottaker av meldingen i første rekke) gjøres i de obligatoriske feltene i hodemeldingen: Feltnavn Element Beskrivelse Institusjon MsgHead/MsgInfo/Receiver/Organisation/Ident Benytt både HER og ENH hvis mulig Institusjonsnavn MsgHead/MsgInfo/Receiver/Organisation/Organi sationname Mottakers navn Informasjon om pasienten fylles ut som beskrevet i Standard for hodemeldingen i de tilfeller medlingen omhandler en pasient. Merk at det stilles spesielle krav til utfylling av pasientinformasjon. Minimumskravet for utfylling er: Feltnavn Element Beskrivelse Identifikasjon MsgHead/MsgInfo/Patient/Ident FNR skal oppgis Navn MsgHead/MsgInfo/Patient/FamilyName MsgHead/MsgInfo/Patient/GivenName Pasientens navn Adresse MsgHead/MsgInfo/Patient/Address Adresse til pasienten er ønskelig, men er ikke obligatorisk Fødselsdato MsgHead/MsgInfo/Patient/DateOfBirth Fødselddato til pasienten kan oppgis, men er ikke obligatorisk Kjønn MsgHead/MsgInfo/Patient/Sex Pasienetens kjønn kan oppgis, men er ikke obligatorisk - 6 -

7 2.2 TOKT felleskomponenter Figur 2 Abonnementstatus-type fra TOKT felleskomponenter Abonnementstatus-type (AbonnementStatusType) Attributter K Type Beskrivelse statuskode (Statuskode) 1 CS Abonnementstatus har en av følgende verdier: Aktiv, Inaktiv, Ingen data. sist endret (SistEndret) 0..1 datetime Tidspunkt når abonnementet er opprettet eller sist endret. slutt dato (SluttDato) 0..1 date Dersom abonnementet er inaktivt sier sluttdato når abonnementet er avsluttet. 2.3 Ebrev samhandleradresser Figur 3 Ebrev samhandleradresser Ebrev samhandleradresser (EbrevSamhandlerAdresser) Svarmelding på HentSamhandlerAdresser. Inneholder 1..* 'Organisasjonsenhet' 'by value' - 7 -

8 2.3.2 Organisasjonsenhet (Organisasjonsenhet) En Samhandler kan ha en eller flere avdelinger eller praksiser. Et Ebrev abonnement knyttes til en organisasjonsenhet med TSSID Er en del av 'Ebrev samhandleradresser' 'by value' Attributter K Type Beskrivelse organisasjonsnavn (Orgnavn) 1 string Navn på avdeling eller praksis. TSS-id (TSSId) 1 string En ekstern id i Nav's samhandlersystem. Alle som samhandler med Nav er registret HER-id (HerId) 0..1 string Løsningen er forberedt for bruk av HER-id. aktiv abonnement (AktivtAbonnement) abonnementstatus (AbonnementStatus) 1 boolean True når det er aktivt abonnement Abonnem entstatustype Dersom det finens et aktivt abonnement vil AbonnementStatus inkluderes i meldingen. adresse (Adresse) 1..* Adresse En eller flere adresser som er registrert på organisasjonsenheten. Adressen er inkludert for å nærmere identifisere organisasjonsenheten. 2.4 Ebrev forespørsel Figur 4 Ebrev forespørsel Ebrev parametertype (EbrevParamType) Abstrakt klasse, spesialiserer som 'Test Ebrev', 'Stopp abonnement', 'Start abonnement', 'Hent abonnementstatus' - 8 -

9 Attributter K Type Beskrivelse Identifikasjon (Ident) 1 Identifikat or Samhandlers fødselsnummer( FNR) eller annen id skal alltid oppgis. TSS-id (TSSId) 0..1 string TSS id som returnert i svaret fra HentSamhandlerAdresser skal oppgis. HER-id (HerId) 0..1 string Meldingen er forberedt for HerId, men HerId er foreløpig ikke tatt i bruk Ebrev forespørsel (EbrevForesporsel) Inneholder 1 'Test Ebrev' 'by value' Inneholder 1 'Start abonnement' 'by value' Inneholder 1 'Stopp abonnement' 'by value' Inneholder 1 'Hent samhandleradresser' 'by value' Inneholder 1 'Hent abonnementstatus' 'by value' Hent samhandleradresser (HentSamhandlerAdresser) Forespørsel om alle samhandlers adresser for alle registrerte avdelinger/praksiser. Returnerer med meldingen EbrevSamhandlerAdresser Er en del av 'Ebrev forespørsel' 'by value' Attributter K Type Beskrivelse Identifikasjon (Ident) 1 Identifikat or Identifikasjon. Bruk: FNR/DNR/HPR/HNR brukes for helsepersonell ENH brukes for organisasjoner Start abonnement (StartAbonnement) Forspørsel om start av Abonnement på en organisasjonsenhet (avdeling/praksis) identifisert med en TSSId som oppgitt i EbrevSamhandlerAdresser. Svarer med en EbrevAbonnentStatus melding Spesialisering av 'Ebrev parametertype' Er en del av 'Ebrev forespørsel' 'by value' Attributter K Type Beskrivelse Identifikasjon (Ident) 1 Identifikat or Samhandlers fødselsnummer( FNR) eller annen id skal alltid oppgis. TSS-id (TSSId) 0..1 string TSS id som returnert i svaret fra HentSamhandlerAdresser skal oppgis. HER-id (HerId) 0..1 string Meldingen er forberedt for HerId, men HerId er foreløpig ikke tatt i bruk Stopp abonnement (StoppAbonnement) Forspørsel om stopp av Abonnement på en organisasjonsenhet (avdeling/praksis) identifisert med en TSSId som oppgitt i EbrevSamhandlerAdresser. Svarer med en EbrevAbonnentStatus melding Spesialisering av 'Ebrev parametertype' Er en del av 'Ebrev forespørsel' 'by value' - 9 -

10 Attributter K Type Beskrivelse Identifikasjon (Ident) 1 Identifikat or Samhandlers fødselsnummer( FNR) eller annen id skal alltid oppgis. TSS-id (TSSId) 0..1 string TSS id som returnert i svaret fra HentSamhandlerAdresser skal oppgis. HER-id (HerId) 0..1 string Meldingen er forberedt for HerId, men HerId er foreløpig ikke tatt i bruk Hent abonnementstatus (HentAbonnementStatus) Forspørsel om abonnement status på en organisasjonsenhet (avdeling/praksis) identifisert med en TSSId som oppgitt i EbrevSamhandlerAdresser. Svarer med en EbrevAbonnentStatus melding Spesialisering av 'Ebrev parametertype' Er en del av 'Ebrev forespørsel' 'by value' Attributter K Type Beskrivelse Identifikasjon (Ident) 1 Identifikat or Samhandlers fødselsnummer( FNR) eller annen id skal alltid oppgis. TSS-id (TSSId) 0..1 string TSS id som returnert i svaret fra HentSamhandlerAdresser skal oppgis. HER-id (HerId) 0..1 string Meldingen er forberedt for HerId, men HerId er foreløpig ikke tatt i bruk Test Ebrev (TestEbrev) Forspørsel om å få tilsendt ett testbrev til en organisasjonsenhet (avdeling/praksis) identifisert med en TSSId som det abonneres på. Svarer umidelbart med en applikasjonskvittering. Deretter følger et test dokumentasynkront i en egen melding Spesialisering av 'Ebrev parametertype' Er en del av 'Ebrev forespørsel' 'by value' Attributter K Type Beskrivelse Identifikasjon (Ident) 1 Identifikat or Samhandlers fødselsnummer( FNR) eller annen id skal alltid oppgis. TSS-id (TSSId) 0..1 string TSS id som returnert i svaret fra HentSamhandlerAdresser skal oppgis. HER-id (HerId) 0..1 string Meldingen er forberedt for HerId, men HerId er foreløpig ikke tatt i bruk. Pasientens fødselsnummer (PasientFnr) 0..1 string Når pasientens fødselsnummer (PasientFnr) er oppgitt vil testbrevet påføres pasientens fødselsnummer i retur og kan angis i pasientens Journal

11 2.5 Ebrev abonnementstatus Ebrev abonnementstatus (EbrevAbonnementStatus) Statusmelding på Ebrev abonnement. Attributter K Type Beskrivelse status (Status) 1 Abonnem entstatustype

12 3 Meldings- og implementasjonsbeskrivelse Meldingsbeskrivelsen gjelder for XML, og det er laget en skjemadefinisjon ved hjelp av XML Schema (XSD). Skjemadefinisjon og eksempelfiler finnes i egen dokumentasjon. 3.1 Namespace Meldingens namespace (navnerom) er per dags dato Datatyper Det er brukt datatyper som er basert på CEN og HL7s anbefalinger for datatyper i helsevesenet. Disse er beskrevet i [HL7]. 3.3 ebxml Ebrev - abonnementtjenester NAV skal benyttes sammen med Rammeverk for elektronisk kommunikasjon i helsevesenet [REM] med tilhørende PKI-løsning. 3.4 Hodemelding Ebrev - abonnementtjenester NAV benytter et standardisert meldingshode [HODE]. XSD spesifisert i denne rapporten skal alltid benyttes sammen med XSD for Hodemeldingen [HODE]. Hodemeldingen vil inneholde opplysninger om avsender og mottaker og vil fungere som toppnoden i en instansmelding. Det faglige innholdet overføres i henhold til XML-schema for Ebrev - abonnementtjenester NAV, og skal inkluderes i samme instansmelding. Aktuelle meldingstyper for hodemeldingen vil være: EbrevForesporsel Forespørsel om elektronisk brev EbrevSamhandlerAdresser Informasjon om samhandlers adresser EbrevAbonnementStatus Status om abonnementstatus Hvilke klasser som skal være med Følgende klasser fra Hodemeldingen skal benyttes sammen med Ebrev - abonnementtjenester NAV Hodemelding (MsgHead) Meldingsinformasjon (MsgInfo) Avsender (Sender) med relaterte klasser

13 Mottaker (Receiver) med relaterte klasser Dokument (Document) Referanse (RefDoc) 3.5 Applikasjonskvittering For tilbakemelding fra mottaker av Forespørsel om egenandel og Svar på forespørsel om egenandel vil det bli brukt en generell applikasjonskvittering [AK] for å rapportere feil. Se denne dokumentasjon for bruk av Applikasjonskvittering. Under finnes kodeverk som skal brukes i kombinasjonen Ebrev - abonnementtjenester NAV og Applikasjonskvittering Kodeverk for Applikasjonskvittering Slik brukes feilmeldingsattributtet (Error) i applikasjonskvitteringen: Attributt Kardinalitet Beskrivelse V 1 Kodenummer "99" Eksempel S 1 OID for feilkodeverket " " DN 1 Kodens betydning "Annet" OT 0..1 Original tekst Slik brukes statusattributtet (Status) i applikasjonskvitteringen: Attributt Kardinalitet Beskrivelse Eksempel V 1 Kodenummer "3" eller "2", "1" benyttes DN 1 Kodens betydning "OK" (kode 1) "Avvist" (kode 2, innsendingen er avvist) Det er foreløpig ikke laget et eget kodeverk for feilmeldinger. Koder kan bli etablert i løpet av utviklingsperioden. 3.6 XML-meldingens struktur Dette kapittelet inneholder en hierarkisk oversikt over hvordan meldingen er strukturert

14 Figur 5 EbrevForesporsel Figur 6 EbrevSamhandlerAdresser Figur 7 EbrevAbonnementStatus

15 Figur 8 EbrevParamType 3.7 XML Schema <?xml version="1.0" encoding="utf-8"?> <!-- NAV Ebrev abonnementtjenester Versjon > <xs:schema xmlns=" xmlns:fk1=" xmlns:ebr=" xmlns:tokt=" xmlns:xs=" xmlns:kith=" targetnamespace=" elementformdefault="qualified" attributeformdefault="unqualified"> <xs:import namespace=" schemalocation="felleskomponent1.xsd"/> <xs:import namespace=" schemalocation="kith.xsd"/> <xs:element name="ebrevforesporsel"> <xs:complextype> <xs:choice> <xs:element name="hentsamhandleradresser"> <xs:documentation>forespørsel om alle samhandlers adresser for alle registrerte avdelinger/praksiser. Returnerer med meldingen EbrevSamhandlerAdresser</xs:documentation> <xs:complextype> <xs:sequence> <xs:element name="ident" type="fk1:ident"> <xs:documentation>ident inneholder normalt fødselsnummer, men en av de andre identifkasjonstyper som DNR,HPS etc. kan benyttes</xs:documentation> </xs:sequence> </xs:complextype> <xs:element name="startabonnement" type="ebrevparamtype"> <xs:documentation>forspørsel om start av Abonnement på en organisasjonsenhet (avdeling/praksis) identifisert med en TSSId som oppgitt i EbrevSamhandlerAdresser. Svarer med en EbrevAbonnentStatus melding </xs:documentation> <xs:element name="stoppabonnement" type="ebrevparamtype"> <xs:documentation>forspørsel om stopp av Abonnement på en organisasjonsenhet (avdeling/praksis) identifisert med en TSSId som oppgitt i EbrevSamhandlerAdresser. Svarer med en EbrevAbonnentStatus melding </xs:documentation> <xs:element name="hentabonnementstatus" type="ebrevparamtype"> <xs:documentation>forspørsel om abonnement status på en organisasjonsenhet (avdeling/praksis) identifisert med en TSSId som oppgitt i EbrevSamhandlerAdresser. Svarer med en EbrevAbonnentStatus melding </xs:documentation>

16 <xs:element name="testebrev"> <xs:documentation>forspørsel om å få tilsendt ett testbrev til en organisasjonsenhet (avdeling/praksis) identifisert med en TSSId som det abonneres på. Svarer umidelbart med en applikasjonskvittering. Deretter følger et test dokumentasynkront i en egen melding</xs:documentation> <xs:complextype> <xs:complexcontent> <xs:extension base="ebrevparamtype"> <xs:sequence> <xs:element name="pasientfnr" type="xs:string" minoccurs="0"> <xs:documentation>når pasientfnr er oppgitt vil testbrevet påføres pasinetfnr i retur og kan langis i pasientens Journal. </xs:documentation> </xs:sequence> </xs:extension> </xs:complexcontent> </xs:complextype> </xs:choice> </xs:complextype> <xs:element name="ebrevsamhandleradresser"> <xs:documentation>svarmelding på HentSamhandlerAdresser</xs:documentation> <xs:complextype> <xs:sequence> <xs:element name="samhandlernavn"/> <xs:element name="organisasjonsenhet" maxoccurs="unbounded"> <xs:documentation>en Samhandler kan ha en eller flere avdelinger eller praksiser. Et Ebrev abonnement knyttes til en organisasjonsenhet med TSSID </xs:documentation> <xs:complextype> <xs:sequence> <xs:element name="orgnavn" type="xs:string"> <xs:documentation>navn på avdeling eller praksis</xs:documentation> <xs:element name="tssid" type="xs:string"> <xs:documentation>en ekstern id i Nav's samhandlersystem. Alle som samhandler med Nav er registret </xs:documentation> <xs:element name="herid" type="xs:string" minoccurs="0"> <xs:documentation>løsningen er forberedt for bruk av HER id</xs:documentation> <xs:element name="aktivtabonnement" type="xs:boolean"> <xs:documentation>true når det er aktivt abonnement </xs:documentation> <xs:element name="abonnementstatus" type="abonnementstatustype" minoccurs="0"> <xs:documentation>dersom det finens et aktivt abonnement vil AbonnementStatus inkluderes i meldingen</xs:documentation> <xs:element name="adresse" type="fk1:address" maxoccurs="unbounded"> <xs:documentation>en eller flere adresser som er registrert på organisasjonsenheten. Adressen er inkludert for å nærmere identifisere organisasjonsenheten.</xs:documentation> </xs:sequence> </xs:complextype>

17 </xs:sequence> </xs:complextype> <xs:element name="ebrevabonnementstatus"> <xs:documentation>statusmelding på Ebrev abonnement</xs:documentation> <xs:complextype> <xs:sequence> <xs:element name="status" type="abonnementstatustype"/> </xs:sequence> </xs:complextype> <xs:complextype name="ebrevparamtype"> <xs:sequence> <xs:element name="ident" type="fk1:ident"> <xs:documentation>samhandlers fødselsnummer( FNR) eller annen id skal alltid oppgis. </xs:documentation> <xs:element name="tssid" type="xs:string" minoccurs="0"> <xs:documentation>tss id som returnert i svaret fra HentSamhandlerAdresser skal oppgis.</xs:documentation> <xs:element name="herid" type="xs:string" minoccurs="0"> <xs:documentation>meldingen er forberedt for HerId, men HerId er foreløpig ikke tatt i bruk.</xs:documentation> </xs:sequence> </xs:complextype> <!-- Felleskomponent TOKT --> <xs:complextype name="abonnementstatustype"> <xs:sequence> <xs:element name="statuskode" type="kith:cs"> <xs:documentation>abonnementstatus har en av følgende verdier: Aktiv, Inaktiv, Ingen data</xs:documentation> <xs:element name="sistendret" type="xs:datetime" minoccurs="0"> <xs:documentation>tidspunkt når abonnementet er oppretett eller sist endret </xs:documentation> <xs:element name="sluttdato" type="xs:date" minoccurs="0"> <xs:documentation>dersom abonnementet er inaktivt sier sluttdato når abonnementet er avsluttet.</xs:documentation> </xs:sequence> </xs:complextype> </xs:schema>

18 4 Referanser I dokumentet er det referert til følgende dokumenter: [EBREV] KITH-rapport 1020:2010: Ebrev - Elektronisk utsending av brev [HL7] [AK] [REM] KITH rapport R17/01: Datatyper til bruk ved meldingsutveksling mv. ISBN KITH rapport R15/04: Applikasjonskvittering ISBN KITH rapport R16/06: Rammeverk for elektronisk meldingsutveksling i helsevesenet, versjon 1.0. ISBN [HODE] KITH rapport R01/06: Standard for Hodemelding, versjon 1.2 ISBN