AMQP Avtaleavbestilling

Prosessen avtaleavbestilling er identisk med funksjonen for innbygger å sende avbestilling i prosessen AMQP Timereservasjon versjon 1.2

Denne prosessen gjør det mulig for en aktør å åpne opp for avbestillinger av avtaler fra innbygger, uten å åpne opp for hele prosessen timeadministrasjon som også innebærer at innbygger får hente ledige timer og bestille nye timer. En forutsetning for å kunne benytte denne prosessen er at helseaktør tilbyr timevisning og at innbygger har en helsekontakt.

API-navn	DIALOG_INNBYGGER_AVTALEAVBESTILLING
Funksjonelt område	Dialog
API-versjon og dato publisert	v1.0 Oct 25, 2018
Status	I Drift
API-dokumentasjon sist endret	Feb 11, 2021
Teknologi	AMQP

Kommunikasjonsprosess

Dette er en frittstående prosess og har en egen verdi i meldingens funksjon i hodemeldingen. Følgende prosess skal aktiveres i adresseregisteret for å støtte funksjonaliteten.

Prosess	Funksjonalitet	Versjon
Dialog_Innbygger_Avtaleavbestilling	Første versjon av kommunikasjonsprosess.	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

AvbestillAvtale

Dialogmelding 1.1

Pasientrelasjon

iCal

Helsepersonell

SvarAvbestilling

Dialogmelding 1.1

iCal

Se ytterligere detaljer i innholdsstandarder for innhold i meldinger

Forespørsel fra innbygger om avbestilling

Med forespørsel om avbestilling kan innbygger sende en forespørsel om å avbestille en time.

Denne funksjonen dekker avbestilling som beskrevet i AMQP Timereservasjon under Reservasjon av valgt time.

Tjeneste	Forespørsel om avbestilling, asynkron tjeneste
Bruksområde	Brukes når innbygger ønsker å avbestille en reservert time.
Hodemelding	Obligatorisk, og benyttes i henhold til beskrivelse i Hodemelding Obligatorisk verdi i MsgHead/MsgInfo/Type er: `<Type V="DIALOG_INNBYGGER_AVTALEAVBESTILLING" DN="Dialog med innbygger - avtaleavbestilling "/>` Obligatorisk verdi i MsgHead/MsgInfo/Ack er: `<Ack DN="Ja" V="J"/>` Referanse til samtaletråd settes til meldingen som ble sendt for timenotifikasjon, beskrevet i AMQP Avtaleutsending `<ConversationRef> <RefToParent>f5896674-1147-46f0-bc9b-6b6bde5bb844</RefToParent> <RefToConversation>f5896674-1147-46f0-bc9b-6b6bde5bb844</RefToConversation> </ConversationRef>`
Dialogmelding	Obligatoriske elementer (klasse/element): Dialogmelding/Foresporsel/TypeForesp Lovlige kodeverdier som kan brukes i TypeForesp: ART Avbestill reservert time
iCalender	Obligatorisk når informasjon om tidspunkt sendes til legekontor. Elementene under iCal/vevent skal ha følgende innhold dtstart: tidspunkt for gjeldende time, start dtend: tidspunkt for gjeldende time, slutt uid: id for timeavtalen som ønskes avbestilt contact: HER-id for kommunikasjonspart som timeavtale tilhører Følgende valgfrie informasjon kan benyttes: Summary: Hva timen gjelder Description: Fritekst informasjon om hvorfor avbestilling sendes XML eksempel: <vcalendar> <properties> <version> <text>2.0</text> </version> <prodid> <text>PAS EPJ</text> </prodid> </properties> <components> <vevent> <properties> <dtstart> <date-time>2019-07-05T11:45:00</date-time> </dtstart> <dtend> <date-time>2019-07-05T12:00:00</date-time> </dtend> <uid> <text>651b1341-26ca-11e4-8c21-0800200c9a66</text> </uid> <contact> <text>91095</text> </contact> <summary> <text>Reisevaksine</text> </summary> <description> <text>Jeg har allerede tatt dose 2</text> </description> </properties> <components/> </vevent> </components> </vcalendar>

Svar på forespørsel om avbestilling

Innholdet i Dialogmeldingen for svar på forespørsel er identisk med svar som beskrevet i AMQP Timereservasjon under Reservasjon av valgt time. Dersom avbestilling kommer via prosessen Avtaleavbestilling skal det også svares med avbestilling slik som i eksempelet under.

Tjeneste	Svar på forespørsel om avbestilling, asynkron tjeneste
Bruksområde	Svar på avbestilling av en reservert time.
Hodemelding	Obligatorisk, og benyttes i henhold til beskrivelse i Hodemelding Obligatorisk verdi i MsgHead/MsgInfo/Type er `<Type V="DIALOG_INNBYGGER_AVTALEAVBESTILLING" DN="Dialog med innbygger - avtaleavbestilling "/>` Obligatorisk verdi i MsgHead/MsgInfo/Ack er: `<Ack DN="Ja" V="J"/>` Meldinger som inngår i en samtaletråd skal refereres til hverandre ved hjelp av MsgHead/MsgInfo/ConversationRef på følgende måte: Elementet «RefToParent» skal referere til forrige melding i dialog Elementet «RefToConversation» skal referere til første melding i dialogen `<ConversationRef> <RefToParent>ae53cf18-c834-4342-994c-387e5b80078c</RefToParent> <RefToConversation>ae53cf18-c834-4342-994c-387e5b80078c</RefToConversation> </ConversationRef>`
Dialogmelding	Obligatoriske elementer (klasse/element): Dialogmelding/Notat/Temakodet Lovlige kodeverdier som kan brukes i Dialogmelding/Notat/Temakodet: 08 Avbestilling av time bekreftet 09 Time kunne ikke avbestilles Avvisning av henvendelse/forespørsel: dersom system/behandler ikke kan svare på mottatt henvendelse/forespørsel kan følgende kodeverdier fra kodeverk 7602 benyttes i elementet <Dialogmelding/Notat/Temakodet>: 26 Forespørsel avvist 30 Ikke tilgang
iCalender	Obligatorisk når informasjon om tidspunkt sendes til Helsenorge.no. Elementene under iCal/vevent skal ha følgende innhold dtstart: tidspunkt for gjeldende time, start dtend: tidspunkt for gjeldende time, slutt uid: id for avtale contact: HER-id til kommunikasjonspart som timeavtale tilhører related-to: id for relatert avtale. Ved avbestilling av time skal feltet related-to ha samme verdi som den opprinnelige avtalen, i tilfeller der det opprettes en ny avtale (uid) i timebok Følgende valgfrie informasjon kan benyttes: Summary: Hva timen gjelder Description: Fritekst informasjon knyttet til svaret Status: Status for timen. Settes til CANCELLED dersom timen er avlyst Cancellation-reason: årsak til avlysning XML eksempel: <vcalendar> <properties> <version> <text>2.0</text> </version> <prodid> <text>PAS EPJ</text> </prodid> </properties> <components> <vevent> <properties> <dtstart> <date-time>2019-07-05T11:45:00</date-time> </dtstart> <dtend> <date-time>2019-07-05T12:00:00</date-time> </dtend> <uid> <text>651b1341-26ca-11e4-8c21-0800200c9a66</text> </uid> <related-to> <uri>651b1341-26ca-11e4-8c21-0800200c9a66</uri> </related-to> <contact> <text>91095</text> </contact> <status> <text>CANCELLED</text> </status> <x-cancellation-reason> <text>Avlyst av innbygger</text> </x-cancellation-reason> <summary> <text>Reisevaksine</text> </summary> <description> <text>Siden du allerede har tatt dose 2, trenger du ikke denne timen</text> </description> </properties> <components/> </vevent> </components> </vcalendar>

Generell info om meldingsutveksling med Helsenorge

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

Eksempelmeldinger

<?xml version="1.0" encoding="UTF-8"?>
<MsgHead xmlns="http://www.kith.no/xmlstds/msghead/2006-05-24" xmlns:xsd="http://www.w3.org/2001/XMLSchema.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.kith.no/xmlstds/msghead/2006-05-24 MsgHead-v1_2.xsd">
	<MsgInfo>
		<Type V="DIALOG_INNBYGGER_AVTALEAVBESTILLING" DN="Dialog med innbygger - avtaleavbestilling"/>
		<MIGversion>v1.2 2006-05-24</MIGversion>
		<GenDate>2019-11-21T09:30:47.0Z</GenDate>
		<MsgId>ae53cf18-c834-4342-994c-387e5b80078c</MsgId>
		<Ack V="J" DN="Ja"/>
		<Sender>
			<Organisation>
				<OrganisationName>Norsk helsenett SF</OrganisationName>
				<Ident>
					<Id>112374</Id>
					<TypeId V="HER" DN="Identifikator fra Helsetjenesteenhetsregisteret (HER-id)" S="2.16.578.1.12.4.1.1.9051"/>
				</Ident>
				<Organisation>
					<OrganisationName>Helsenorge</OrganisationName>
					<Ident>
						<Id>109989</Id>
						<TypeId V="HER" DN="Identifikator fra Helsetjenesteenhetsregisteret (HER-id)" S="2.16.578.1.12.4.1.1.9051"/>
					</Ident>
				</Organisation>
			</Organisation>
		</Sender>
		<Receiver>
			<Organisation>
				<OrganisationName>Helsevirksomhet</OrganisationName>
				<Ident>
					<Id>123456</Id>
					<TypeId V="HER" S="2.16.578.1.12.4.1.1.9051" DN="HER-id"/>
				</Ident>
				<Organisation>
					<OrganisationName>Tjeneste</OrganisationName>
					<Ident>
						<Id>987654</Id>
						<TypeId V="HER" DN="Identifikator fra Helsetjenesteenhetsregisteret (HER-id)" S="2.16.578.1.12.4.1.1.9051"/>
					</Ident>
				</Organisation>
			</Organisation>
		</Receiver>
		<Patient>
			<FamilyName>Danser</FamilyName>
			<GivenName>Folke</GivenName>
			<Ident>
				<Id>13116900216</Id>
				<TypeId V="FNR" S="2.16.578.1.12.4.1.1.8116" DN="Fødselsnummer"/>
			</Ident>
		</Patient>
	</MsgInfo>
	<Document>
		<ContentDescription>Avbestill reservert time</ContentDescription>
		<RefDoc>
			<IssueDate V="2012-11-14T09:30:47.0Z"/>
			<MsgType V="XML" DN="XML-instans"/>
			<Content>
				<Dialogmelding xmlns="http://www.kith.no/xmlstds/dialog/2013-01-23" xsi:schemaLocation="http://www.kith.no/xmlstds/dialog/2013-01-23 dialogmelding-v1.1.xsd">
					<Foresporsel>
						<TypeForesp V="ART" S="2.16.578.1.12.4.1.1.7601" DN="Avbestill reservert time"/>
						<Sporsmal>Har blitt syk og kan ikke møte til timen.</Sporsmal>
					</Foresporsel>
				</Dialogmelding>
			</Content>
		</RefDoc>
	</Document>
	<Document>
		<RefDoc>
			<MsgType V="XML" DN="XML-instans"/>
			<Description>iCalendarBestillTime</Description>
			<Content>
				<icalendar xmlns="urn:ietf:params:xml:ns:icalendar-2.0" xsi:schemaLocation="urn:ietf:params:xml:ns:icalendar-2.0 iCalendar.xsd">
					<vcalendar>
						<properties>
							<version>
								<text>2.0</text>
							</version>
							<prodid>
								<text>PAS EPJ</text>
							</prodid>
						</properties>
						<components>
							<vevent>
								<properties>
									<dtstart>
										<date-time>2019-07-05T11:45:00</date-time>
									</dtstart>
									<dtend>
										<date-time>2019-07-05T12:00:00</date-time>
									</dtend>
									<uid>
										<text>4088E990AD89CB3DBB484909</text>
									</uid>
									<related-to>
										<uri>651b1341-26ca-11e4-8c21-0800200c9a66</uri>
									</related-to>
									<contact>
										<text>91095</text>
									</contact>
								</properties>
								<components/>
							</vevent>
						</components>
					</vcalendar>
				</icalendar>
			</Content>
		</RefDoc>
	</Document>
</MsgHead>

<?xml version="1.0" encoding="UTF-8"?>
<MsgHead xmlns="http://www.kith.no/xmlstds/msghead/2006-05-24" xmlns:xsd="http://www.w3.org/2001/XMLSchema.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.kith.no/xmlstds/msghead/2006-05-24 MsgHead-v1_2.xsd">
	<MsgInfo>
		<Type V="DIALOG_INNBYGGER_AVTALEAVBESTILLING" DN="Dialog med innbygger - avtaleavbestilling"/>
		<MIGversion>v1.2 2006-05-24</MIGversion>
		<GenDate>2019-05-21T11:21:00.0Z</GenDate>
		<MsgId>e6e2c36e-e6d3-4c75-9755-398a29b57e7e</MsgId>
		<Ack V="J" DN="Ja"/>
		<ConversationRef>
			<RefToParent>ae53cf18-c834-4342-994c-387e5b80078c</RefToParent>
			<RefToConversation>ae53cf18-c834-4342-994c-387e5b80078c</RefToConversation>
		</ConversationRef>
		<Sender>
			<Organisation>
				<OrganisationName>Helsevirksomhet</OrganisationName>
				<Ident>
					<Id>123456</Id>
					<TypeId V="HER" S="2.16.578.1.12.4.1.1.9051" DN="HER-id"/>
				</Ident>
				<Organisation>
					<OrganisationName>Tjeneste</OrganisationName>
					<Ident>
						<Id>987654</Id>
						<TypeId V="HER" DN="Identifikator fra Helsetjenesteenhetsregisteret (HER-id)" S="2.16.578.1.12.4.1.1.9051"/>
					</Ident>
				</Organisation>
			</Organisation>
		</Sender>
		<Receiver>
			<Organisation>
				<OrganisationName>Norsk helsenett SF</OrganisationName>
				<Ident>
					<Id>112374</Id>
					<TypeId V="HER" DN="Identifikator fra Helsetjenesteenhetsregisteret (HER-id)" S="2.16.578.1.12.4.1.1.9051"/>
				</Ident>
				<Organisation>
					<OrganisationName>Helsenorge</OrganisationName>
					<Ident>
						<Id>109989</Id>
						<TypeId V="HER" DN="Identifikator fra Helsetjenesteenhetsregisteret (HER-id)" S="2.16.578.1.12.4.1.1.9051"/>
					</Ident>
				</Organisation>
			</Organisation>
		</Receiver><Patient>
			<FamilyName>Danser</FamilyName>
			<GivenName>Folke</GivenName>
			<Ident>
				<Id>13116900216</Id>
				<TypeId V="FNR" S="2.16.578.1.12.4.1.1.8116" DN="Fødselsnummer"/>
			</Ident>
		</Patient>
	</MsgInfo>
	<Document>
		<ContentDescription>Avbestilling bekreftet</ContentDescription>
		<RefDoc>
			<IssueDate V="2019-05-21T11:21:00.0Z"/>
			<MsgType V="XML" DN="XML-instans"/>
			<Content>
				<Dialogmelding xmlns="http://www.kith.no/xmlstds/dialog/2013-01-23" xsi:schemaLocation="http://www.kith.no/xmlstds/dialog/2013-01-23 dialogmelding-v1.1.xsd">
					<Notat>
						<TemaKodet V="08" S="2.16.578.1.12.4.1.1.7602" DN="Avbestilling av time bekreftet"/>
					</Notat>
				</Dialogmelding>
			</Content>
		</RefDoc>
	</Document>
	<Document>
		<RefDoc>
			<MsgType V="XML" DN="XML-instans"/>
			<Description>iCalendarBestillTime</Description>
			<Content>
				<icalendar xmlns="urn:ietf:params:xml:ns:icalendar-2.0" xsi:schemaLocation="urn:ietf:params:xml:ns:icalendar-2.0 iCalendar.xsd">
					<vcalendar>
						<properties>
							<version>
								<text>2.0</text>
							</version>
							<prodid>
								<text>PAS EPJ</text>
							</prodid>
						</properties>
						<components>
							<vevent>
								<properties>
									<dtstart>
										<date-time>2019-07-05T11:45:00</date-time>
									</dtstart>
									<dtend>
										<date-time>2019-07-05T12:00:00</date-time>
									</dtend>
									<uid>
										<text>651b1341-26ca-11e4-8c21-0800200c9a66</text>
									</uid>
									<related-to>
										<uri>651b1341-26ca-11e4-8c21-0800200c9a66</uri>
									</related-to>
									<contact>
										<text>91095</text>
									</contact>
								</properties>
								<components/>
							</vevent>
						</components>
					</vcalendar>
				</icalendar>
			</Content>
		</RefDoc>
	</Document>
</MsgHead>

<?xml version="1.0" encoding="UTF-8"?>
<MsgHead xmlns="http://www.kith.no/xmlstds/msghead/2006-05-24" xmlns:xsd="http://www.w3.org/2001/XMLSchema.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.kith.no/xmlstds/msghead/2006-05-24 MsgHead-v1_2.xsd">
	<MsgInfo>
		<Type V="DIALOG_INNBYGGER_AVTALEAVBESTILLING" DN="Dialog med innbygger - avtaleavbestilling"/>
		<MIGversion>v1.2 2006-05-24</MIGversion>
		<GenDate>2019-05-21T11:21:00.0Z</GenDate>
		<MsgId>e6e2c36e-e6d3-4c75-9755-398a29b57e7e</MsgId>
		<Ack V="J" DN="Ja"/>
		<ConversationRef>
			<RefToParent>ae53cf18-c834-4342-994c-387e5b80078c</RefToParent>
			<RefToConversation>ae53cf18-c834-4342-994c-387e5b80078c</RefToConversation>
		</ConversationRef>
		<Sender>
			<Organisation>
				<OrganisationName>Helsevirksomhet</OrganisationName>
				<Ident>
					<Id>123456</Id>
					<TypeId V="HER" S="2.16.578.1.12.4.1.1.9051" DN="HER-id"/>
				</Ident>
				<Organisation>
					<OrganisationName>Tjeneste</OrganisationName>
					<Ident>
						<Id>987654</Id>
						<TypeId V="HER" DN="Identifikator fra Helsetjenesteenhetsregisteret (HER-id)" S="2.16.578.1.12.4.1.1.9051"/>
					</Ident>
				</Organisation>
			</Organisation>
		</Sender>
		<Receiver>
			<Organisation>
				<OrganisationName>Norsk helsenett SF</OrganisationName>
				<Ident>
					<Id>112374</Id>
					<TypeId V="HER" DN="Identifikator fra Helsetjenesteenhetsregisteret (HER-id)" S="2.16.578.1.12.4.1.1.9051"/>
				</Ident>
				<Organisation>
					<OrganisationName>Helsenorge</OrganisationName>
					<Ident>
						<Id>109989</Id>
						<TypeId V="HER" DN="Identifikator fra Helsetjenesteenhetsregisteret (HER-id)" S="2.16.578.1.12.4.1.1.9051"/>
					</Ident>
				</Organisation>
			</Organisation>
		</Receiver>
		<Patient>
			<FamilyName>Danser</FamilyName>
			<GivenName>Folke</GivenName>
			<Ident>
				<Id>13116900216</Id>
				<TypeId V="FNR" S="2.16.578.1.12.4.1.1.8116" DN="Fødselsnummer"/>
			</Ident>
		</Patient>
	</MsgInfo>
	<Document>
		<ContentDescription>Forespørsel avvist</ContentDescription>
		<RefDoc>
			<IssueDate V="2019-05-21T11:21:00.0Z"/>
			<MsgType V="XML" DN="XML-instans"/>
			<Content>
				<Dialogmelding xmlns="http://www.kith.no/xmlstds/dialog/2013-01-23" xsi:schemaLocation="http://www.kith.no/xmlstds/dialog/2013-01-23 dialogmelding-v1.1.xsd">
					<Notat>
						<TemaKodet V="09" S="2.16.578.1.12.4.1.1.7602" DN="Time kunne ikke avbestilles"/>
					</Notat>
				</Dialogmelding>
			</Content>
		</RefDoc>
	</Document>
	<Document>
		<RefDoc>
			<MsgType V="XML" DN="XML-instans"/>
			<Description>iCalendarBestillTime</Description>
			<Content>
				<icalendar xmlns="urn:ietf:params:xml:ns:icalendar-2.0" xsi:schemaLocation="urn:ietf:params:xml:ns:icalendar-2.0 iCalendar.xsd">
					<vcalendar>
						<properties>
							<version>
								<text>2.0</text>
							</version>
							<prodid>
								<text>PAS EPJ</text>
							</prodid>
						</properties>
						<components>
							<vevent>
								<properties>
									<dtstart>
										<date-time>2019-07-05T11:45:00</date-time>
									</dtstart>
									<dtend>
										<date-time>2019-07-05T12:00:00</date-time>
									</dtend>
									<uid>
										<text>4088E990AD89CB3DBB484909</text>
									</uid>
									<related-to>
										<uri>651b1341-26ca-11e4-8c21-0800200c9a66</uri>
									</related-to>
									<contact>
										<text>91095</text>
									</contact>
								</properties>
								<components/>
							</vevent>
						</components>
					</vcalendar>
				</icalendar>
			</Content>
		</RefDoc>
	</Document>
</MsgHead>

Logikk for å avgjøre om innbygger kan avbestille timen

For å finne ut om "Avbestille time" knappen skal vises gjør Helsenorge følgende sjekker:

Dersom timen venter på svar for avbestilling eller endring, eller om avbestilling er avvist, så vil bruker ikke kunne avbestille timen på nytt.
Dersom avsender av timevtalen støtter DIALOG_INNBYGGER_TIMERESERVASJON eller DIALOG_INNBYGGER_AVTALEAVBESTILLING så vil bruker kunne avbestille timen.
1. Dersom begge støttes vil avbestillingen sendes med meldingstypen DIALOG_INNBYGGER_TIMERESERVASJON.