Informationsspecifikation – meddelandehuvud
I samband med resurs-anrop eller vid operationer anges information i anropets meddelandehuvud.
I avsnitt 1 beskrivs termer i Meddelandehuvud för anrop/HTTP Request header and Authorization och dess användning.
I avsnitt 2 beskrivs hur ett tillämpningsmönster av termer i Meddelandehuvudet ska användas i olika situationer. I varje tillämpningsanvisning (TA) anges vilka tillämpningsmönster som gäller för meddelandehuvudet i respektive tillämpning.
I avsnitt 3 beskrivs termer i Meddelandehuvud för anropsvar/HTTP Response header och dess användning.
1. Termer i Meddelandehuvud för anrop/HTTP Request Header and Authorization
I Nationella läkemedelslistan registreras och läses information via resurser som beskrivs under Informationsspecifikation – resurser. Här beskrivs information som anges i meddelandehuvudet i samband med resursanropet. Nedan listas de parametrar som kan anges.
En parameter kan avse antingen ett enskilt fält, flera fält eller en hel resurs.
För teknisk information avseende meddelandehuvud se HTTPHeaderandAuthorization (simplifier.net)
Tabell 1- Termer - Meddelandehuvud/HTTP Request header (anrop)
Term |
Definition och anmärkning |
Header-parameter |
FHIR Kommentar |
---|---|---|---|
Ändamål |
Åberopat skäl för direktåtkomst enligt lag (2018:1212) om Nationella läkemedelslistan Anmärkning
|
X-Purpose |
Valueset: purpose-types |
Åtkomsttyp |
Åberopad rättighet att ta del av information i Nationella läkemedelslistan Anmärkning Exempel: |
X-Access | Valueset: access-types |
Händelse |
En händelse kan syfta till att förändra en patients läkemedelslista eller förändra uppgift om spärr. Anmärkning
|
X-Provenance | |
Patientreferens |
hänvisning till en patient Anmärkning |
X-PatientRef | |
Referens till ombud |
hänvisning till ett ombud Anmärkning |
X-ProxyRef | |
Organisationsinformation |
Organisationsinformation är en parameter som skickas i meddelandehuvud som ska innehålla information som kompletterar säkerhetsintyget vad gäller information om arbetsplats. |
X-Org-Info | |
Styrparameter för önskad omfattning av resultat |
Parameter som styr hur mycket information som ska returneras efter genomfört anrop Anmärkning För mer information se Krav på anropsresultat och felhantering |
Prefer | |
Anrops-id |
Unik referens i form av ett UUID för varje enskilt anrop till Nationella läkemedelslistan |
X-Request-ID | |
Anropssekvens-id |
Unik referens i form av ett UUID för varje sekvens av anrop till Nationella läkemedelslistan
|
X-Context-ID | |
Anropstyp |
Anger anropstyp (NORMAL eller DELAYED). Default NORMAL om parameter saknas. Anmärkning |
X-Call-Type | |
Systeminformation |
Information som kompletterar säkerhetsintyget med information om systemet varifrån anropet initierades |
X-User-Agent | |
Format | Standardparameter i HTTP som används vid FHIR-kommunikation för att ange om informationen i HTTP-body är i JSON-format eller XML-format. | Accept | |
Säkerhetsintyg | Säkerhetsintyg i SAML- eller OAUTH2-format. | Authorization |
2. Tillämpningsmönster för Meddelandehuvud
Detta dokument beskriver olika mönster för användning av attribut i Meddelandehuvudet.
2.1. Hämta utan säkerhetsintyg
Tillämpning av attribut i Meddelandehuvud då uppgifter hämtas utan krav på säkerhetsintyg.
Tabell 2 Hämta utan säkerhetsintyg
Term meddelandehuvud |
Header |
Villkor |
---|---|---|
Ändamål |
X-Purpose |
Ignoreras, Ej relevant |
Åtkomsttyp |
X-Access |
Ignoreras, Ej relevant |
Händelse | X-Provenance | Ignoreras, Ej relevant |
Patientreferens | X-PatientRef | Ignoreras, Ej relevant |
Referens till ombud | X-ProxyRef | Ignoreras, Ej relevant |
Organisationsinformation |
X-Org-Info |
Ignoreras, Ej relevant |
Styrparameter för önskad omfattning av resultat | Prefer | Ignoreras, Ej relevant |
Systeminformation |
X-User-Agent |
Obligatorisk se GK6 i Spårbarhetskrav |
Anrops-id |
X-Request-ID |
Obligatorisk se GK1 i Spårbarhetskrav. |
Anropssekvens-id | X-Context-ID | Valfri, rekommenderas se GK2 i Spårbarhetskrav |
Anropstyp | X-Call-Type | Valfri, NORMAL förvalt |
Format | Accept | Valfri, JSON förvalt |
Säkerhetsintyg |
Authorization |
Ignoreras, Ej relevant |
2.2. Hämta med säkerhetsintyg
Tillämpning av attribut i Meddelandehuvud då uppgifter hämtas med krav på eller användning av säkerhetsintyg.
2.2.1. Hämta med säkerhetsintyg utan åtkomsttyp och ändamål
Hämtning av resurser eller användning av utökade operationer där det inte finns krav på angivande av åtkomststyp och ändamål.
Tabell 3 Hämta med säkerhetsintyg utan åtkomsttyp och ändamål
Term i meddelandehuvud |
Header |
Villkor |
---|---|---|
Ändamål |
X-Purpose |
Ignoreras, Ej relevant |
Åtkomsttyp |
X-Access |
Ignoreras, Ej relevant |
Händelse | X-Provenance | Ignoreras, Ej relevant |
Patientreferens | X-PatientRef | Ignoreras, Ej relevant |
Referens till ombud | X-ProxyRef | Ignoreras, Ej relevant |
Organisationsinformation |
X-Org-Info |
Obligatorisk för Vård se GK4 i Spårbarhetskrav Obligatorisk för vid förmedling av direktåtkomst till Nationella läkemedelslistan för privatperson, se GK5 i Spårbarhetskrav för komplettering av organisationsinformation för förmedlande aktör (uppgift saknas i privatpersonens säkerhetsintyg). Anges ej för Apotekens egen åtkomst (apoteks-id fås via säkerhetsintyg och organisationsinformation kompletteras från Expo). |
Styrparameter för önskad omfattning av resultat | Prefer |
Ignoreras, Ej relevant i normalscenarion Anmärkning |
Systeminformation |
X-User-Agent |
Obligatorisk, se GK6 i Spårbarhetskrav. |
Anrops-id |
X-Request-ID |
Obligatorisk, se GK1 i Spårbarhetskrav. |
Anropssekvens-id | X-Context-ID | Valfri, rekommenderas, se GK2 i Spårbarhetskrav |
Anropstyp | X-Call-Type | Valfri, NORMAL förvalt |
Format | Accept | Valfri, JSON förvalt |
Säkerhetsintyg |
Authorization |
Obligatorisk, se Säkerhetslösning samt GK 3 i Spårbarhetskrav. |
2.2.2. Hämta med säkerhetsintyg med åtkomsttyp och ändamål
Hämtning av resurser eller användning av operationer där det finns krav på angivande av åtkomststyp och ändamål.
Tabell 4 Hämta med säkerhetsintyg med åtkomsttyp och ändamål
Term i meddelandehuvud |
Header |
Villkor |
---|---|---|
Ändamål |
X-Purpose |
Obligatorisk, se Ändamål, åtkomsttyper, resurser och behörigheter |
Åtkomsttyp |
X-Access |
Obligatorisk, se Ändamål, åtkomsttyper, resurser och behörigheter |
Händelse | X-Provenance | Ignoreras, Ej relevant |
Patientreferens |
X-PatientRef |
Obligatorisk, valideras enligt Generella verksamhetsregler VR095 eller VR096. Undantag anges inte för:
|
Referens till ombud | X-ProxyRef |
Obligatorisk om ändamål är "Direktåtkomst till egna uppgifter" och Åtkomsttyp är "Vårdnadshavare" eller "Köpfullmakt" |
Organisationsinformation |
X-Org-Info |
Obligatorisk för Vård se GK4 i Spårbarhetskrav Obligatorisk för vid förmedling av direktåtkomst till Nationella läkemedelslistan för privatperson, se GK5 i Spårbarhetskrav för komplettering av organisationsinformation för förmedlande aktör (uppgift saknas i privatpersonens säkerhetsintyg). Anges ej för Apotekens egen åtkomst för ändamålen - "Expediering" och "Underlättande av patients läkemedelsanvändning" (apoteks-id fås via säkerhetsintyg och organisationsinformation kompletteras från Expo). |
Styrparameter för önskad omfattning av resultat | Prefer |
Ignoreras, Ej relevant i normalscenarion Anmärkning |
Systeminformation |
X-User-Agent |
Obligatorisk, se GK6 i Spårbarhetskrav. |
Anrops-id |
X-Request-ID |
Obligatorisk, se GK1 i Spårbarhetskrav. |
Anropssekvens-id | X-Context-ID | Valfri, rekommenderas se GK2 i Spårbarhetskrav |
Anropstyp | X-Call-Type | Valfri, NORMAL förvalt |
Format | Accept | Valfri, JSON förvalt |
Säkerhetsintyg |
Authorization |
Obligatorisk, se Säkerhetslösning samt GK 3 i Spårbarhetskrav. |
2.3. Skapa eller uppdatera resurs
Tabell 5 Skapa eller uppdatera resurser
Term i Meddelandehuvud |
Header |
Villkor |
---|---|---|
Ändamål |
X-Purpose |
Ignoreras, Ej relevant |
Åtkomsttyp |
X-Access |
Ignoreras, Ej relevant |
Händelse |
X-Provenance |
Obligatorisk |
Patientreferens |
X-PatientRef |
Ignoreras, Ej relevant - anges i resurs som skapas eller uppdateras. |
Referens till ombud |
X-ProxyRef |
Ignoreras, Ej relevant |
Organisationsinformation |
X-Org-Info |
Obligatorisk för Vård se GK4 i Spårbarhetskrav Obligatorisk då uppgift registreras av privatperson i nationella läkemedelslistan (exempelvis samtycke eller spärr). Se GK5 i Spårbarhetskrav för komplettering av organisationsinformation för förmedlande aktör (uppgift om detta saknas i privatpersonens säkerhetsintyg). Anges ej för Apoteks anrop (apoteks-id fås via säkerhetsintyg och organisationsinformation kompletteras från Expo). |
Styrparameter för önskad omfattning av resultat |
Prefer |
Obligatorisk, för Förskrivning. Se Krav på anropsresultat och felhantering |
Systeminformation |
X-User-Agent |
Obligatorisk, se GK6 i Spårbarhetskrav. |
Anrops-id |
X-Request-ID |
Obligatorisk, se GK1 i Spårbarhetskrav. |
Anropssekvens-id | X-Context-ID | Valfri, rekommenderas se GK2 i Spårbarhetskrav |
Anropstyp | X-Call-Type |
Valfri, NORMAL förvalt. Anropstyp ska användas i TA10 Skapa förskrivning - Vård med värdet "DELAYED" för tillämpning av reservlösningen. |
Format | Accept | Valfri, JSON förvalt |
Säkerhetsintyg |
Authorization |
Obligatorisk, se Säkerhetslösning samt GK 3 i Spårbarhetskrav. |
3. Termer i Meddelandehuvud för anropssvar/HTTP Response header
Här beskrivs information som returneras i meddelandehuvudet i ett anropssvar/HTTP Response header.
För teknisk information avseende meddelandehuvud i ett anropssvar se HTTPHeaderandAuthorization (simplifier.net)
Tabell 6 - Termer - Meddelandehuvud för anropssvar/HTTP Response header (anropssvar)
Term i meddelandehuvud - anropssvar | Response header | Definition och anmärkning |
Direkt sökväg | content-location |
Direkta webbadressen till resursen, utan vidare omdirigering. |
Etag | etag |
Visar version på uppdaterad resurs. Kan användas för att identifiera om resursen blev uppdaterad. Exempel: Om ett anrop att uppdatera förskrivning sker utan att något på förskrivningen har ändrats så skapas varken en ny förskrivningsversion eller en händelse. Anropssvar med HTTP status 200 returneras och för att veta om användaren behöver uppmärksammas på att ingen ändring skett kan inskickad version jämföras med den version som returneras i Etag. |
Senast uppdaterad | last-modified |
Tidpunkt då resurs senast uppdaterades. Tillhandahålls endast då resurs uppdateras. Händelsetidpunkt returneras för den version av resursen som skapades vid uppdateringen. Senast uppdaterad returneras aldrig för resursen Uttag. |
Sökväg | location | Sökväg till webbadressen där omdirigering till resursen utförs. |
NMI-id | nmi-id |
Unik identifierare för Nationella Medicinska Informationssystem (NMI) för identifiering och spårbarhet. Exempel: |
Anropssekvens-id | x-context-id |
Samma Anropssekvens-id som i anropet om en sådan angavs. For definition se kapitel 1 Termer i Meddelandehuvud för anrop/HTTP Request Header and Authorization. |
Anrops-id | x-request-id |
Samma anrops-id som angavs i anropet För definition se kapitel 1 Termer i Meddelandehuvud för anrop/HTTP Request Header and Authorization. |
Versionshistorik
Version |
Datum |
Release |
Kommentar |
---|---|---|---|
1.0 | 2021-11-27 | 21.0 | Ny handbok vård-och apotekstjänster |
1.1 | 2022-04-05 | Förtydligat anmärkningar för bättre läsbarhet | |
1.2 | 2022-11-10 | 21.4 |
Förtydligat krav vid användning av operationer med hänvisning till spårbarhetskrav. Ändrat det tekniska namnet för Anropssekvens-id från X-Correlation-ID till X-Context-ID Lagt till kapitel om "Tillämpningsmönster för meddelandehuvud" samt redigerat tabell 1 och tagit bort kolumn om "Regler för användning" som flyttats till det nya kapitlet. |
1.3 | 2023-05-04 | 21.5 |
Lagt till kapitel 3 som beskriv termer i Meddelandehuvud för anropsvar/HTTP Response header och dess användning. Rättning i kapitel 2.3 till att Händelse är obligatorisk. Lagt till attributet NMI-id som returneras i HTTP response header |
1.4 | 2023-08-24 | 21.6 | I kapitel 2.2.2 Patientreferens förtydligat att undantag i TA05 avser sökning med personnummer. |
1.5 | 2023-11-09 | 21.7 |
Förtydliganden i dokumentation i Tabell 6 - Termer - Meddelandehuvud för anropssvar/HTTP Response header (anropssvar)
|
1.6 | 2024-05-05 | 21.9 |
Förbättrad dokumentation.
|
1.7 | 2024-11-05 | 21.11 |
Förändringar
|