-
Notifications
You must be signed in to change notification settings - Fork 0
Operasjoner
Eirik Broen edited this page Oct 27, 2024
·
13 revisions
Under følger en overordnet beskrivelse av HTTP REST operasjoner som forventes å være tilgjengelige.
Kategori av operasjoner relatert til pasienter. En pasient er et individ med en unik system-id og typisk en nasjonal identifikator som F-nr, D-nr eller kombinasjon av fornavn/etternavn og en fødselsdato. En pasient er unik i kontekst av et journalsystem.
Search
Hent liste med pasienter i samsvar med søkekriterier, returnerer 0 til mange pasienter for kombinasjon av søkeparametere. Liste inneholder basisinformasjon om pasient inklusive id.GET
name type data type description
http code content-type response 200application/json{"result": [Patient]}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
POST
name type data type description
http code content-type response 200application/json{"result": [Patient]}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Read
Returnerer personalia og annen data knyttet til pasient med id i samsvar med verdi fra forespørsel. GET
name type data type description id required uuid
http code content-type response 200application/json{"result":Patient}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Create
Opprett ny pasient med verdier fra forespørsel. Ny pasient opprettes med id som er unik for journalsystemet. Hvis en pasient allerede finnes (match på f-fn, d-nr eller fødselsdato og fornavn/etternavn) opprettes ingen ny pasient. POST
name type data type description
http code content-type response 201text/plain;charset=UTF-8`` 400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Update
Oppdater pasient med verdier fra forespørsel, pasienten identifiseres med id. PUT
name type data type description id required uuid
http code content-type response 200text/plain;charset=UTF-8{Patient}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Kategori av operasjoner relatert til personell og administrasjon av personell. Denne gruppen med funksjonalitet inkluderer en egen operasjon for å hente ut aktiv kontekst for en innlogget bruker. I denne beskrivelsen er begrepene bruker og personell å betrakte som likestilte.
Search
Hent liste med personell i samsvar med søkekriterier, returnerer 0 til mange brukere for kombinasjon av søkeparametere. Liste inneholder basisinformasjon om bruker inklusive id. GET
name type data type description
http code content-type response 200application/json{"result": [Practitioner]}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
POST
name type data type description
http code content-type response 200application/json{"result": [Practitioner]}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Read
Returnerer personalia og annen data knyttet til bruker med id i samsvar med verdi fra forespørsel. GET
name type data type description id required uuid
http code content-type response 200application/json{"result":Practitioner}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
GET (Hent bruker med kontekst)
Returnerer kontekstinformasjon fra pasientjournal for en aktiv brukersesjon. Bruker angis i forespørsel. Kontekst inneholder informasjon om innlogget bruker, aktiv pasient, kontakt/behandlingssituasjon/begrunnelse for aktivering av journal, seksjon/avdeling.
Kontekst skal inneholde tilstrekkelig data for å konstruere en helsepersonellattest i samsvar med regler fra
Felles Tillitsmodell.
name type data type description id required uuid context required string hvis verdi returner kontekst
http code content-type response 200application/json{"context": user, role, department, patient...}`400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Create
Opprett en bruker med verdier fra forespørsel. Ny bruker får opprettet en unik id i journalsystemet. Hvis en bruker allerede finnes (match på f-fn, d-nr eller fødselsdato og fornavn/etternavn) opprettes ingen bruker. POST
name type data type description
http code content-type response 201text/plain;charset=UTF-8`` 400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Update
Oppdater bruker med verdier fra forespørsel, brukeren identifiseres med id. PUT
name type data type description id required uuid
http code content-type response 200text/plain;charset=UTF-8{Practitioner}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Kategori av operasjoner relatert til en hendelse. En hendelse har typisk en knytning til både helsepersonell og pasient. Pasient og personell har en tilknytning til en lokasjon og en hendelse har typisk en klassifikasjon som for eksempel “konsultasjon”. En hendelse er avgrenset i tid. I denne beskrivelsen er begrepene hendelse og kontakt å betrakte som likestilte.
Search
Hent liste med hendelser som er i samsvar med søkekriterier, returnerer 0 til mange hendelser for kombinasjon av
søkeparametere. Liste inneholder grunnleggende informasjon om hendelse slik som tidspunkt, type, lokasjon, pasient og
id.
GET
name type data type description
http code content-type response 200application/json{"result": [Encounter]}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
POST
name type data type description
http code content-type response 200application/json{"result": [Encounter]}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Read
Returnerer data knyttet til en hendelse med id som er i samsvar med verdi fra forespørsel. GET
name type data type description id required uuid
http code content-type response 200application/json{"result":Encounter}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Create
Opprett en hendelse med verdier fra forespørsel.
POST
name type data type description
http code content-type response 201text/plain;charset=UTF-8`` 400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Update
Oppdater en hendelse med verdier fra forespørsel, hendelsen identifiseres med id.
PUT
name type data type description id required uuid
http code content-type response 200text/plain;charset=UTF-8{Encounter}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Kategori av operasjoner relatert til en pasientavtale. En avtale har typisk en tilknytning både til en pasient og en lokasjon. En avtale er avgrenset i tid og har typisk en status for om den er aktiv, fremtidig eller avsluttet.
Search
Hent liste med avtaler som er i samsvar med søkekriterier, returnerer 0 til mange avtaler for kombinasjon av
søkeparametere. Liste inneholder grunnleggende informasjon om avtale slik som tidspunkt, lokasjon, status og id.
GET
name type data type description patient_id optional uuid department_id optional uuid user_id optional uuid type optional string status optional string
http code content-type response 200application/json{"result": [Appointment]}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
POST
name type data type description patient_id optional uuid department_id optional uuid user_id optional uuid type optional string status optional string
http code content-type response 200application/json{"result": [Appointment]}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Read
Returnerer data knyttet til en avtale med id som er i samsvar med verdi fra forespørsel.
GET
name type data type description id required uuid
http code content-type response 200application/json{"result":Appointment}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Create
Opprett en avtale med verdier fra forespørsel.
POST
name type data type description
http code content-type response 201text/plain;charset=UTF-8`` 400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Update
Oppdater en avtale med verdier fra forespørsel, avtalen identifiseres med id.
PUT
name type data type description id required uuid
http code content-type response 200text/plain;charset=UTF-8{Appointment}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Kategori av operasjoner relatert til notater. Et notat har typisk en tilknytning både til en pasient, personell og kontakt. Et notat kan bestå av en kombinasjon av tekst og mer strukturerte elementer som en eller flere observasjoner
Search
Hent liste med notater som er i samsvar med søkekriterier, returnerer 0 til mange notater for kombinasjon av
søkeparametere. Liste inneholder grunnleggende informasjon slik som tittel, type, dato opprettet og id.
GET
name type data type description patient_id optional uuid department_id optional uuid user_id optional uuid
http code content-type response 200application/json{"result": [Composition]}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
POST
name type data type description patient_id optional uuid department_id optional uuid user_id optional uuid
http code content-type response 200application/json{"result": [Composition]}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Read
Returnerer data knyttet til et notat med id som er i samsvar med verdi fra forespørsel.
GET
name type data type description id required uuid
http code content-type response 200application/json{"result":Composition}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Create
Opprett et notat med verdier fra forespørsel.
POST
name type data type description
http code content-type response 201text/plain;charset=UTF-8`` 400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Update
Oppdater et notat med verdier fra forespørsel, notatet identifiseres med id.
PUT
name type data type description id required uuid
http code content-type response 200text/plain;charset=UTF-8{Composition}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Kategori av operasjoner relatert til et dokument. Et dokument har typisk en tilknytning både til en pasient, personell og en lokasjon. Et dokument er typisk av en bestemt type, for eksempel “Epikrise” og i et bestemt format, for eksempel “XML”. Et dokument kan ha en status som indikerer om det kan deles med pasient eller helsepersonell.
Search
Hent liste med dokumenter som er i samsvar med søkekriterier, returnerer 0 til mange dokumenter for kombinasjon av
søkeparametere. Liste inneholder grunnleggende informasjon om dokumentene slik som tittel, format, dato opprettet og id.
GET
name type data type description patient_id optional uuid department_id optional uuid user_id optional uuid type optional string
http code content-type response 200application/json{"result": [DocumentReference]}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
POST
name type data type description patient_id optional uuid department_id optional uuid user_id optional uuid type optional string
http code content-type response 200application/json{"result": [DocumentReference]}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Read
Returnerer data knyttet til et dokument med id som er i samsvar med verdi fra forespørsel.
GET
name type data type description id required uuid
http code content-type response 200application/json{"result":DocumentReference}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Create
Opprett et dokument med verdier fra forespørsel.
POST
name type data type description
http code content-type response 201text/plain;charset=UTF-8`` 400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Update
Oppdater et dokument med verdier fra forespørsel, dokumentet identifiseres med id.
PUT
name type data type description id required uuid
http code content-type response 200text/plain;charset=UTF-8{DocumentReference}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Kategori av operasjoner relatert til tjenester en pasient kan motta. En tjeneste har typisk en tilknytning både til en pasient og en lokasjon. En tjeneste er typisk av en bestemt type, for eksempel “Helsetjenester i hjemmet” og har en gitt varighet. I denne beskrivelsen er begrepene tjeneste og tiltak å betrakte som likestilte.
Search
Hent liste med tjenester som er i samsvar med søkekriterier, returnerer 0 til mange tjenester for kombinasjon av
søkeparametere. Liste inneholder grunnleggende informasjon om tjeneste slik som type, pasient, dato opprettet, status og
id.
GET
name type data type description patient_id optional uuid
http code content-type response 200application/json{"result": [CarePlan]}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
POST
name type data type description id optional uuid
http code content-type response 200application/json{"result": [CarePlan]}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Read
Returnerer data knyttet til en tjeneste med id som er i samsvar med verdi fra forespørsel.
GET
name type data type description id required uuid
http code content-type response 200application/json{"result":CarePlan}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Create
Opprett en tjeneste med verdier fra forespørsel. Tjeneste kan potensiellt knyttes til en pasient.
POST
name type data type description
http code content-type response 201text/plain;charset=UTF-8`` 400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Update
Oppdater en tjeneste med verdier fra forespørsel, instans av tjeneste identifiseres med id.
PUT
name type data type description id required uuid
http code content-type response 200text/plain;charset=UTF-8{CarePlan}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Kategori av operasjoner relatert til målinger og observasjoner. En måling har typisk en tydelig definert type med tilhørende verdisett og kodeverk. Målinger har en tilknytning til en pasient og opptrer gjerne i relasjon til andre målinger, hendelser eller prosedyrer. Det utveksles i dag en rekke målinger via Velferdsteknologisk Knutepunkt som har en egen FHIR profilering. Nye nasjonale tjenester for tilgang til målinger og laboratoriesvar benytter seg av flere av de samme ressursene. I denne beskrivelsen er begrepene observasjon og måling å betrakte som likestilte.
Search
Hent liste med observasjoner i samsvar med angitte søkekriterier, returnerer 0 til mange observasjoner for kombinasjon av
søkeparametere. Liste inneholder grunnleggende informasjon slik som type/kategori, pasient, dato opprettet, verdi og
id for en observasjon.
GET
name type data type description patient_id optional uuid type optional string
http code content-type response 200application/json{"result": [Observation]}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
POST
name type data type description patient_id optional uuid type optional string
http code content-type response 200application/json{"result": [Observation]}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Read
Returnerer data knyttet til en observasjon med id som er i samsvar med verdi fra forespørsel.
GET
name type data type description id required uuid
http code content-type response 200application/json{"result":Observation}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Create
Opprett en observasjon med verdier fra forespørsel.
POST
name type data type description type required string Type observasjon
http code content-type response 201text/plain;charset=UTF-8`` 400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}
Update
Oppdater en observasjon med verdier fra forespørsel.
PUT
name type data type description id required uuid
http code content-type response 200text/plain;charset=UTF-8{Observation}400application/json{"code":"400","message":"Bad Request"}401application/json{"code":"401","message":"Unauthorized"}