Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Husk å legg til etiketten “api-dokumentasjon” når denne malen benyttes, samt å slette denne notisen

Forutsetninger for å bruke denne prosessen er:

  • Kommunikasjonsparten må kunne markere enkelte tjenester som digitale innbyggertjenester

  • Kommunikasjonsparten må være i stand til å ha en elektronisk meldingsutveksling med Helsenorge.no

API-navn

DIALOG_INNBYGGER_TJENESTEOVERSIKT

Funksjonelt område

Dialog

API-versjon og dato publisert

v1.0

Status

I DRIFT

API-dokumentasjon sist endret

Teknologi

AMQP

Prosesser og flyt

Her er info om prosesser og flyt

 Overordnet flyt og sekvensdiagram

Følgende prosess skal aktiveres i adresseregisteret for å støtte funksjonaliteten.

Prosess

Funksjonalitet

Versjon

Dialog_Innbygger_Tjenesteoversikt

Første versjon av prosess, utvidet til å støtte bruk av RelaterteRoller fra skjema. Siden Helsenorge vil støtte mottak av relaterte Roller og ikke skal sende informasjon til EPJ (utover apprec) innføres ikke egen versjon for dette.

1.0

Tabellen under viser hvilke roller som inngår i prosessen, hvilke funksjoner de ulike rollene kan gjøre og hvilke meldinger som benyttes for de ulike versjonene.

Versjon

Rolle

Funksjon

Meldingsinnhold

1.0

Innbygger

Apprec

Applikasjonskvittering

Helsepersonell

Oversikt

Tjenesteoversikt

Sekvensdiagram for prosessen tjenesteoversikt er vist i figuren under.

Hodemelding

Hodemelding vil inneholde informasjon om avsender, mottaker og pasient. Hodemelding vil også inneholde teknisk informasjon som unik id og tidspunkt for generering. Nedenfor beskrives de viktigste delene av standarden som slik den skal brukes for orientering om tjenestetilbud

 Krav til elementet «MsgHead/MsgInfo/MsgId»

Den unike id (MsgId) i Hodemeldingen skal være en UUID (Universally Unique Identifier).

XML eksempel:

<MsgId>33160f22-3483-11e2-81c1-0800200c9a66</MsgId>
 Krav til elementet «MsgHead/MsgInfo/Type»

Elementet «MsgHead/MsgInfo/Type» skal angi at meldingen er Tjenesteoversikt. Innholdet skal angis med følgende kodeverdi fra kodeverk 8279 Meldingens funksjon:

Kodeverdi

Kodetekst

DIALOG_INNBYGGER_TJENESTEOVERSIKT

Dialog med innbygger – tjenesteoversikt

 Krav til informasjonsinnhold for avsender og mottaker

Informasjon om avsender og mottaker skal være i henhold til beskrivelsen i standarden for tjenestebasert adressering tilgjengelig her: https://www.ehelse.no/standarder/om-standardisering-i-e-helse/tjenestebasert-adressering

Avsender: MsgHead/MsgInfo/Sender

I avsender av en melding skal informasjon på to organisasjonsnivå oppgis, virksomhet og kommunikasjonspart. Her-id på begge nivåer skal brukes som identifikator.

XML eksempel med Oslo kommune som avsender:

<Sender>
	<Organisation>
		<OrganisationName>OSLO KOMMUNE HELSEETATEN</OrganisationName>
		<Ident>
			<Id>93638</Id>
			<TypeId DN="HER-id" V="HER" S="2.16.578.1.12.4.1.1.9051"/>
		</Ident>
		<Organisation>
			<OrganisationName>Sykepleietjeneste, pleie- og omsorg </OrganisationName>
			<Ident>
				<Id>93971</Id>
				<TypeId DN="HER-id" V="HER" S="2.16.578.1.12.4.1.1.9051"/>
			</Ident>
		</Organisation>
	</Organisation> 
</Sender>

Mottaker: MsgHead/MsgInfo/Receiver

I mottager av en melding skal informasjon på to organisasjonsnivå oppgis, virksomhet og kommunikasjonspart. Her-id på begge nivåer skal brukes som identifikator, et XML eksempel er vist under.

<Receiver>
<Organisation>
		<OrganisationName>Direktoratet for e-helse</OrganisationName>
		<Ident>
			<Id>93580</Id>
			<TypeId DN="HER-id" V="HER" S="2.16.578.1.12.4.1.1.9051"/>
		</Ident>
		<Organisation>
			<OrganisationName>Digitale innbyggertjenester</OrganisationName>
			<Ident>
				<Id>93239</Id>
				<TypeId DN="HER-id" V="HER" S="2.16.578.1.12.4.1.1.9051"/>
			</Ident>
		</Organisation>
	</Organisation> 
</Receiver>
 Krav til informasjonsinnhold for MsgHead/MsgInfo/Ack

Elementet <MsgHead/MsgInfo/Ack> skal benyttes til å angi at det skal svares med applikasjonskvittering. Tjenesteoversikt skal alltid ha en applikasjonskvittering.

XML eksempel:

<Ack DN="Ja" V="J"/>
 Krav til informasjonsinnhold for MsgHead/MsgInfo/Patient

For identifikasjon av en pasient benyttes kodeverket «ID-type for personer» 8116, se http://www.volven.no . Skjemaet støtter flere identifikatorer, men for digital dialog benyttes bare en identifikator og det er bare støtte for fødselsnummer eller D-nummer

Følgende informasjon er obligatorisk å oppgi for pasient.

  • fornavn

  • etternavn

  • fødselsnummer eller d-nummer

XML eksempel for pasient med fødselsnummer:

<Patient>
	<FamilyName>Danser</FamilyName> 
	<GivenName>Line</GivenName> 
	<Ident>
		<Id>13116900216</Id> 
		<TypeId V="FNR" DN="Fødselsnummer" S="2.16.578.1.12.4.1.1.8116" /> 
	</Ident>
</Patient>
 Krav til bruk av MsgHead/Document

Hodemeldingen har struktur for å ha null til mange forekomster av MsgHead/Document. Under «Document» vil faginnholdet i en melding være plassert, og faginnholdet er definert i egne xml skjema. Innholdet under Document vil være xml skjemaet TjenesteOversikt.

Tjenesteoversikt

For bruk mot helsenorge.no for overføring av tjenester som innbygger mottar er det utarbeidet et eget skjema spesifikt for dette formålet.

 Informasjonsmodell for skjemaet TjenesteOversikt

 Tjeneste

Tabellen under oppsummerer attributtene i Tjeneste.

Elementer

K

Type

Beskrivelse

Tjenesteid (TjenesteId)

1

string

Id for tjeneste i avsenders system.

Dette er en lokal ID, det fins ikke nasjonal standard for Id og type CV benyttes derfor heller ikke.

Maks lengde på tjenesteId er satt til 30 tegn

Tjenestenavn (TjenesteNavn)

1

string

Den betegnelse som benyttes for tjenestetypen, f.eks. "Praktisk Bistand". Navn slik det vises til innbygger på helsekontakt http://helsenorge.no

 

TjenesteOmrade (TjenesteOmrade)

1

String

ID til tjenestetype, for gruppering av ulike typer tjenester.

 

Gyldige verdier:

1= Kommunal helse og omsorg

Tjenesten levert av (TjenesteLevertAv)

0..1

string

Opplysninger om hvem som leverer tjenesten.

 

For eksempel: Nordre Aker hjemmetjeneste

Tjeneste telefon (TjenesteTlf)

0..1

Telecom

Telefonnummer til leverandør av tjeneste

Tjeneste URL (TjenesteURL)

0..1

Telecom

URL til leverandør av tjeneste

Startdato (Startdato)

1

date

Angir startdato for tjenesten. Helsekontakt blir aktiv for innbygger etter denne datoen.

Sluttdato (Sluttdato)

0..1

date

Angir sluttdato for tjenesten (dersom dette er kjent). Helsekontakt blir inaktiv dersom denne datoen er passert.

Kommunikasjonspart HER id (HerId)

1

Ident

HER id som skal benyttes for å kontakte tjenesten, for eksempel ved dialog fra innbygger til kommune for en spesifikk tjeneste.

Flere tjenester kan ha samme tjenesteadresse (HER ID) og denne kan være ulik nivå 2 adressen til avsender av meldingen med TjenesteOversikt (denne meldingen).

Derfor kreves HER Id spesifikt oppgitt per enkelttjeneste slik at avsender kan styre hvor meldinger adresseres.

 

Eksempel: 93971 (Sykepleietjeneste, pleie og omsorg)

Et eksempel på XML med Oslo kommune, og to aktive tjenester er vist under. Den første tjenesten har en primærkontakt og telefonnummer og URL til tjenesten.

<TjenesteOversikt xmlns:fk1="http://www.kith.no/xmlstds/felleskomponent1" p2:schemaLocation="http://ehelse.no/xmlstds/tjenesteoversikt TjenesteOversiktv1.0.xsd" xmlns:p2="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://ehelse.no/xmlstds/tjenesteoversikt">
<Tjeneste>
	<TjenesteId>3</TjenesteId>
	<TjenesteNavn>Hjemmesykepleie</TjenesteNavn>
	<TjenesteOmrade>1</TjenesteOmrade>
	<TjenesteTlf>
		<fk1:TeleAddress V="tel:21802180"/>
	</TjenesteTlf>
	<TjenesteURL>
		<fk1:TeleAddress V="url:https://www.oslo.kommune.no/helse-og-omsorg/"/>
	</TjenesteURL>
	<TjenesteLevertAv>Bydel Gamle Oslo</TjenesteLevertAv>
	<FraDato>2020-03-17</FraDato>
	<HERId>
		<fk1:Id>93971</fk1:Id>
		<fk1:TypeId V="HER" S="2.16.578.1.12.4.1.1.9051" DN="HER-id"/>
	</HERId>
	<RelaterteRoller>
		<RoleToPatient V="9" S="2.16.578.1.12.4.1.1.9034" DN="Primærkontakt"/>
		<HealthcareProfessional>
		<fk1:TypeHealthcareProfessional DN="Sykepleier" V="SP"/>
		<fk1:FamilyName>Lin</fk1:FamilyName>
		<fk1:GivenName>Rita</fk1:GivenName>
		<fk1:Ident>
			<fk1:Id>9144900</fk1:Id>
		<fk1:TypeId V="HPR" DN="HPR-nummer" S="2.16.578.1.12.4.1.1.8116"/>
		</fk1:Ident>
		</HealthcareProfessional>
	</RelaterteRoller>
</Tjeneste>
<Tjeneste>
	<TjenesteId>12</TjenesteId>
	<TjenesteNavn>Praktisk bistand</TjenesteNavn>
	<TjenesteOmrade>1</TjenesteOmrade>
	<TjenesteLevertAv>Leverandør A</TjenesteLevertAv>
	<FraDato>2017-01-12</FraDato>
	<HERId>
	<fk1:Id>93971</fk1:Id>
	<fk1:TypeId V="HER" S="2.16.578.1.12.4.1.1.9051" DN="HER-id"/>
	</HERId>
</Tjeneste>
</TjenesteOversikt>
 RelaterteRoller

Generell info om meldingsutveksling med Helsenorge

For overordnet informasjon om meldingsutveksling med Helsenorge se her: Meldingsutveksling med Helsenorge og PVK

Ytterligere informasjon

Under er forskjellige typer supplerende informasjon

 Ytterligere informasjon om strukturen eller elementer i Query eller Response

 Evt relevante kodeeksempler

 Benytter av følgende komponenter

Navn

Type

Beskrivelse




  • No labels