Overordnet avtale. Representerer innkalling/avtalen pasienten får. Kan stå alene eller ha underliggende timer.

Oppmøtetid, dokumenter, instruksjoner, serviceCategory, appointmentType, varslinger, henvisning (basedOn), kommunikasjonspart

Underliggende aktiviteter. Delsteg i avtalen. Peker alltid på en ATA via partOf.

Faktisk tid for aktivitet, fysisk lokasjon, varighet, practitionerRole/practitioner (contained), minutter, daglige detaljer

meta.lastUpdated

For å unngå mulig utfordring med synkronisering må lastUpdated alltid populeres

Ved konflikt der eldre versjon av ressursen er mottatt benytte HTTP: 409 og operationOutcome:

Se beskrivelse av Http code 409 i FHIR spec. version conflict management

1..1

ATA, ATn

Unik identifikator for timeavtalen/timen.

1..1

ATA, ATn

Identifier.assigner

Organisasjon som opprettet og er ansvarlig for identifikator.

Se https://hl7.org/fhir/R4/datatypes-definitions.html#Identifier.assigner
^{Anvendes i spørringer}

1..1

ATA, ATn

identifier.value

Unik timeidentifikator for time/timeavtale (appointment) - GUID
_{Anvendes for å unikt identifisere timer}
^{Anvendes i spørringer}

1..1

ATA, ATn

Identifier.system

Id for systemet som publiserer timeavtale/time (appointment) informasjon
^{Anvendes i spørringer}

1..1

ATA, ATn

Status

Status på timen http://hl7.org/fhir/R4/valueset-appointmentstatus.html

Spesifikt for HSØ og DIPS integrasjon gjelder følgende:

• DIPS sender Appointment.status -> Booked, Cancelled, Noshow, Entered-in-error.

• DIPS sender ikke statusen «Fulfilled» når en time er gjennomført. På Helsenorge kan status «utført» vises når tidspunkt for timeavtalen er passert og ingen annen status er sendt. Sendes en no-show i etterkant vil «ikke møtt» overskrive status «utført».

ATA, ATn

cancelationReason

Kanselleringsårsak (cancellationReason). Kodeverk urn:oid:2.16.578.1.12.4.1.1.8445 (preferred) men urn:oid:2.16.578.1.12.4.1.1.9179 kan også brukes. Kanselleringsårsak må settes når status = cancelled og serviceCategory = 27 (Specialist Medical) or serviceCategory = 30 (Specialist Radiology/Imaging). Kanselleringsårsak kan også være som tekst.

ATA

serviceCategory

Valueset basert på http://hl7.org/fhir/R4/codesystem-service-category.html

Foreløpig valueset:

1..1

ATA, ATn

appointmentType

For timenotifikasjon støtter NHN valueset basert på 2 koder fra 7617, 4 koder fra 8406 og nytt kodeverk som er under utvikling.

1..1

ATA, ATn

description

Kort beskrivelse av hva timen gjelder. Begrensning 1000 char.

ATA, ATn

start

Start-tidspunktet. Hvis det brukes appointment hierarki (partOf) er start for timeavtale oppmøtetidspunkt og start for enkelt avtaler - tidspunkt for time/avtale. Se constraint for start og slutt tidspunkt i profilen app-2 og app-3.

ATA, ATn

end

Slutt-tidspunktet Se constraint for start og slutt tidspunkt i profilen app-2 og app-3.

ATA, ATn

slot

Referanse til innslaget i timebok.

ATA (ATn)

patientInstruction

Beskrivelse om timen som vil vises i detaljvisningen. Begrensning på 1000 char.

ATA

participant.actor.Patient

Logisk ressursreferanse av type Patient. Identifikatoren er fødselsnummer eller d-nummer.

I reference  settes kardinalitet 0..0 for å hindre bruk av element

identifier 1..1 

identifier.type for pasient kun lov med DNR/FNR

eksempel:

type : http://hl7.org/fhir/resource-types

ATA, ATn

participant.actor.Patient.identifier

Logisk referanse brukes for partisipant av type patient

1..1

ATA

participant.actor.Patient.reference

Litteral referanse brukes ikke for partisipant av type patient

0..0

participant.actor.practitioner

Resurs kan kun legges in som en del av bundle. Helsenorge vi foreløpig ikke støtte resurs som krever eksternt kall eller er en del av bundle.

Foreløpige støttede profiler: no-basis-Practitioner

ATA/ATn

participant.location

Resurs kan kun legges in som contained ressurs. Helsenorge vi foreløpig ikke støtte resurs som krever eksternt kall eller er en del av bundle.

Lokasjon brukes oftest som en fysisk plassering for kontakten (inkludert telefonnummer) eller opphold. Lokasjon kan være en del av en annen lokasjon. Denne må da være del av same bundle og referert fra "child" lokasjon.

I eksisterende implementasjon kan telefon til oppmøte sted legges på lokasjon av type HU (Avdeling).

Støttede profiler: no-basis-Location

ATA/ATn

participant.PractitionerRole

Resurs kan kun legges in som contained ressurs. Helsenorge vi foreløpig ikke støtte resurs som krever eksternt kall eller er en del av bundle.

Foreløpig støttede profiler: no-basis-PractitionerRole

ATA/ATn

partOf

partOf er extension i no-basis-appointment og kan brukes for å peke til timeavtale for avtaler/timer. Kan også brukes for timer som er steg og peker da på overordnet appointment

ATn

basedOn

basedOn referer til Henvisning. Standard attributt i appointment og kan både være logisk eller literal referanse

ATA

VirtualService

Profil er oppdatert med VirtualService

Handterer behov for møteform.

The VirtualService er basert på VirtualServiceDetail struktur from R5 og definerer detaljer for virtuell avtale/møte/time. VirtualService er extension i no-basis-appointment

• channelType: Coding: The type of virtual service to connect to.

• virtualAddress: string, url, ContactPoint: What address or number needs to be used for a user to connect to the virtual service to join.

• additionalInfo: url: Address to see alternative connection details.

• maxPartisipants: positiveInt: Maximum number of participants supported by the virtual service.

• sessionKey: string: Session Key required by the virtual service.

Følgende value sett er definert av NHN og anbefales brukt for channelType

ValueSet: vs-hn-basis-virtualService

Se gyldige koder i Hn Basis VirtualServiceType Value Set - v1.0.1

ATA

recurring

X

Extension som viser om timen er av typen regelmessig 

ATA

group

Extension fra no-basis-appointement som viser om appointment er gruppetime/gruppe avtale

ATA

minutesDuration

Timens varighet i antall minutter. Hvis denne ikke inneholder noen verdi, vil timens varighet være differansen mellom starttidspunkt og sluttidspunkt

ATA, ATn

consultationType

X

Extension: Volven 9505 (Preferred). System: FinnKode

Dette kodeverket inneholder koder som benyttes for å identifisere de faste alderstrinn (intervall) som er relevante i forbindelse med arbeidet på helsestasjoner og i skolehelsetjenesten.

ATA

postponmentReason

X

Extension: Utsettelseskode .  Kodeverk: urn:oid:2.16.578.1.12.4.1.1.8446 (preferred). Denne extension var tidligere del av forslag til no-basis-appointment profilen men er nå fjernet der og leggs inn som del av hn-basis-appointment

Hvis ny time/opphold skal opprettes og status = "cancelled" kan postponmentReason brukes for å gi informasjon om utsettelsen

Kommentar: Det vurderes om attribut trenges i denne profilen og hvis det trengs en attribute om den ikke heller bør gnerelt bør reflektere endring i stedet for kun uttsettelse.

ATA

supportingInformation

SupportingInformation i Appointment brukes til å referere til informasjon og ressurser som støtter avtalen. Feltet benyttes for å peke på tilleggsdata som er relevante for visning, kontekst eller videre behandling av timen.

Kommunikasjonspart (obligatorisk)

• Kommunikasjonspart skal alltid legges på supportingInformation.

• HER-id nivå 2 skal publiseres som kommunikasjonspart ved bruk av profilen:

  • kommunikasjonspart-Organization - v1.0.1

  • Den nasjonale profilen:
    HL7 Norway no-basis | kommunikasjonspart-Organization - SIMPLIFIER.NET

• For spesialist helse skal Her-id på nivå 1 legges ut som identifier på managing organization for lokasjon av type HOSP.

Andre typer ressurser som kan refereres fra

• DocumentRefrence: SupportingInformationdokument inkludert brev med referanse til no-basis-DocumentReference. Document resursen kan inneholde selve brevet som attachment eller som url (path til dokument eller peker til XDS dokument). Det er teknisk støtte for å sende inn flere vedlegg, men per nå er det bare det første som blir vist til innbygger, og det antas at dette vedlegget er innkallingsbrev til ti, og blir omtalt som dette i visningen. Maks total filstørrelse på alle vedlegg er 20MB. Se eksempler på bruk her.

• flag: flag er resurs som inneholder informasjon om hva innbygger og andre kan gjøre i forhold til appointment

1..*

ATA, ATn

meta.security - Sensitiv avsender

Valgfri

meta.tag - Paminnelse (reminder)

Valgfri

meta.tag - Varsling

Valgfri

meta.lastUpdated

Påkrevd