1 Revisionshistorik
2 Referenser
3 Inledning
- 3.1 Ägarskap
4 Tjänstekontrakt
5 Anvisningens krav och regler
- 5.1 Generella krav och regler
- 5.2 Användning av DocBook
  - 5.2.1 Bilder
    - 5.2.1.1 Användningsanvisning
    - 5.2.1.2 Exempel
  - 5.2.2 Tabeller
    - 5.2.2.1 Användningsanvisning
    - 5.2.2.2 Exempel: Rubrik som spänner över två kolumner
  - 5.2.3 Listor
    - 5.2.3.1 Användningsanvisning
  - 5.2.4 Entitykodning
6 Användningsfall
- 6.1 Användning av DocBook i tjänstekontraktet GetCareDocumentation

Revisionshistorik

Version	Datum	Författare	Kommentar

Version	Datum	Författare	Kommentar
1	2025-03-15	Thomas Siltberg	Utkast
1	2025-06-03	Thomas Siltberg	Har lagt till att en `section` kan vara barn till en `section`.
1	2025-10-20	Thomas Siltberg	Elementet `info` har tagits bort. Beskrivning av hur `section` får placeras.
1 (ej fastställd)	2026-04-02	Thomas Siltberg	Flyttat dokumentet till Confluence. Tagit bort bild från exempel för entitykodning Tillägg av elementet `alt` Tillägg av beskrivning av hantering av listor Förtydliganden i text

Referenser

Namn	Dokument	Länk

Namn	Dokument	Länk
R1	TKB_clinicalprocess.healthcond.description.docx
R2	TKB_itinfrastructure_itintegration_dataexchange.docx
R3	Interaktionsöverenskommelse för GetBinaryData.doc

Inledning

Fältet clinicalDocumentNoteText innehåller anteckningens textinnehåll. Producenten kan formatera innehållet med DocBook 5.0 (OASIS-standard) enligt tjänstekontraktets regler och denna interaktionsöverenskommelse.

Det här dokumentet är en överenskommelse för vilka element ur DocBook-standarden som en tjänsteproducent kan välja att använda i svar till tjänstekonsumenten NPÖ.

Ägarskap

Den som ansvarar för interaktionsöverenskommelsen.

Ägarskap	Kommentar

Ägarskap	Kommentar
Förvaltningen för NPÖ

Tjänstekontrakt

Denna anvisning omfattar följande tjänstekontrakt. För mer information om ingående tjänstekontrakt, se referens R1 och R2.

Tjänstedomän	Tjänstekontrakt	Version

Tjänstedomän	Tjänstekontrakt	Version
clinicalprocess.healthcond.description	GetCareDocumentation	2.1 & 3.1
itinfrastructure.itintegration.dataexchange	GetBinaryData	1.0

Anvisningens krav och regler

Generella krav och regler

Dokumentet kompletterar reglerna i tjänstekontraktsbeskrivningen. Tjänsteproducenter och tjänstekonsumenter som kommunicerar information som omfattas av en interaktionsöverenskommelse ska följa reglerna i tjänstekontraktet samt de regler som uttrycks i interaktionsöverenskommelsen.

En interaktionsöverenskommelse får aldrig motsäga reglerna i tjänstekontraktet. Den preciserar endast hur informationen ska uttryckas i specifika fält/attribut.

Interaktionsöverenskommelse krävs vid användning av GetCareDocumentation eftersom konsumenter och producenter inte enbart kan förlita sig på informationsspecifikation och tjänstekontraktsbeskrivning för att uppnå semantisk interoperabilitet.

Användning av DocBook

Attributet careDocumentationBody.clinicalDocumentNote.clinicalDocumentNoteText kan struktureras med DocBook-formatet. Om DocBook används ska fältet innehålla XML med den XML-deklaration som tjänstekontraktet anger samt endast de element och regler som NPÖ hanterar enligt denna interaktionsöverenskommelse.

Observera: Om DocBook är felaktigt formaterat kan anteckningen utebli i visning i NPÖ.

Följande element ur DocBook version 5.0 har NPÖ stöd för:

Element	Beskrivning	Parent	Child

Element	Beskrivning	Parent	Child
`article`	Behållare för dokumentet. Används som root-element.	–	`title`, `section`, `bibliography`, `para`, `itemizedlist`, `orderedlist`, `table`, `inlinemediaobject`
`section`	Avsnitt i en artikel eller annan sektion, vanligtvis med rubrik (`title`). `section` får inte placeras fritt. Du kan placera stycken (`para`) och andra blockelement före `section`, men du kan inte placera något efter det.	`article`, `section`	`section`, `title`, `para`, `bibliography`, `itemizedlist`, `orderedlist`, `table`, `inlinemediaobject`
`para`	Stycke text. Används i `section`, `listitem`, `td` och `th`.	`article`, `section`, `listitem`, `td`, `th`	–
`title`	Titel för t.ex. `article`, `section` eller `table`.	`article`, `section`, `table`	–
`itemizedlist`	Punktlista.	`article`, `section`	`listitem`
`orderedlist`	Numrerad lista.	`article`, `section`	`listitem`
`listitem`	Enskild punkt i en lista.	`itemizedlist`, `orderedlist`	Text och/eller `para`, `itemizedlist`, `orderedlist`, `inlinemediaobject`
`inlinemediaobject`	Behållare för `imageobject`.	`article`, `section`, `listitem`, `para`, `td`, `th`	`alt`, `imageobject`
`alt`	`alt` är ett valfritt underelement i `inlinemediaobject`. Det ger en textbaserad alternativ presentation, ofta för tillgänglighet, och motsvarar alt-attributet i HTML <img>. `alt` ska placeras före `imageobject`i `inlinemediaobject`.	`inlinemediaobject`	-
`imageobject`	Behållare för `imagedata`.	`inlinemediaobject`	`imagedata`
`imagedata`	Bilddata i `imageobject`. Refererar till en faktisk bildfil.	`imageobject`	–
`table`	Huvudelement för tabeller.	`article`, `section`	`title`, `caption`, `thead`, `tbody`, `tfoot`, `tr`
`caption`	Alternativ rubrik för en `table`.	`table`	–
`thead`	Tabellhuvud (rader med rubrikceller).	`table`	`tr`
`tbody`	Tabellkropp (rader med dataceller).	`table`	`tr`
`tfoot`	Tabellfot (valfri, oftast summeringar).	`table`	`tr`
`tr`	Rad i tabell, kan innehålla `th` och `td`.	`thead`, `tbody`, `tfoot`	`th`, `td`
`th`	Rubrikcell i tabellrad.	`tr`	`para`, `inlinemediaobject`
`td`	Datacell i tabellrad.	`tr`	`para`, `inlinemediaobject`

Bilder

inlinemediaobject
imageobject
imagedata

Användningsanvisning

Elementet inlinemediaobject
Elementet inlinemediaobject används endast för att bädda in elementet imageobject i DocBook-meddelandet. I DocBook-standarden tillåts flera alternativa objekt i inlinemediaobject men endast ett är tillåtet i NPÖ. Skickas ändå flera objekt kommer det första objektet att användas. Bilden kommer att visas på den plats i DocBook-meddelandet där inlinemediaobject är placerat.
Elementet imageobject
Elementet imageobject används endast för att bädda in elementet imagedata i DocBook-meddelandet.
Elementet imagedata
Elementet imagedata håller information om vilken refererad fil som representerar bilden som ska visas. Endast attributet entityref används. Textuella innehållet i attributet entityref ska motsvara identifieraren på den fil som refereras i documentReference i tjänstekontraktet GetCareDocumentation. Se användningsfall 1.2 nedan. Övriga attribut som exempelvis width, scale eller align ska inte användas. NPÖ visar bilden i sin ursprungliga storlek.

Exempel

<inlinemediaobject>
  <imageobject>
    <imagedata entityref="binary-1" />
  </imageobject>
</inlinemediaobject>

<documentReference>
    <id value="document-1" />
    <version value="1" />
    <status value="current" />
    <description value="Ett dokument som exemplifierar användningen av en referens." />
    <attachment>
        <id value="binary-1" />
        <contentType value="application/pdf" />
        <language value="sv" />
        <size value="1256498" />
        <title value="Exempeldokument" />
        <creation value="20241030131305" />
        <endpoint>
            <status value="active" />
            <connectionType value="urn:riv:infrastructure:itintegration:dataexchange:GetBinaryDataResponder:1:rivtabp21" />
            <address value="https://url.till.en.api-endpoint.se" />
            <logicalAddress value="SE2321000016-T65N" />
            <accessControlMechanism value="mutual-tls" />
        </endpoint>
    </attachment>
</documentReference>

Tabeller

table
caption
tbody
td
tfoot
th
thead
title
tr

Användningsanvisning

Elementens beskrivningar i tabellen ovan anger hur elementen bygger upp en tabell.

För att få en rubrikcell (th) att spänna över två eller fler kolumner i thead, använder du attributet colspan.

Exempel: Rubrik som spänner över två kolumner

<table>
  <thead>
    <tr>
      <th colspan="2">Rubrik över två kolumner (kolumn 1 & 2)</th>
      <th>Kolumn 3</th> 
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>Data på rad 1 i kolumn 1</td>
      <td>Data på rad 1 i kolumn 2</td>
      <td>Data på rad 1 i kolumn 3</td>
    </tr>
    <tr>
      <td>Data på rad 2 i kolumn 1</td>
      <td>Data på rad 2 i kolumn 2</td>
      <td>Data på rad 2 i kolumn 3</td>
    </tr>
  </tbody>
</table>

Rubrik över två kolumner (kolumn 1 & 2)		Kolumn 3
Data på rad 1 i kolumn 1	Data på rad 1 i kolumn 2	Data på rad 1 i kolumn 3
Data på rad 2 i kolumn 1	Data på rad 2 i kolumn 2	Data på rad 2 i kolumn 3

Listor

itemizedlist
orderedlist
listitem

Användningsanvisning

Elementen ovan används för punktlistor (itemizedlist) och numrerade listor (orderedlist). Varje lista ska innehålla ett eller flera listitem. Varje listitem ska innehålla text och/eller para, itemizedlist, orderedlist eller inlinemediaobject.

Nästlade listor är tillåtna genom att placera en ny itemizedlist eller orderedlist inuti ett listitem.

Exempel: Punktlista

<itemizedlist>
  <listitem>
    <para>Punkt 1</para>
  </listitem>
  <listitem><para>Punkt 2</para></listitem>
</itemizedlist>

Exempel: Numrerad lista med nästlad numrerad lista

<orderedlist>
  <listitem>
    <para>Steg 1</para>
    <orderedlist>
      <listitem><para>Steg 1.1</para></listitem>
      <listitem><para>Steg 1.2</para></listitem>
    </orderedlist>
  </listitem>
  <listitem><para>Steg 2</para></listitem>
</orderedlist>

Entitykodning

XML:en i fältet behöver vara entity-kodad (för att kunna skickas som text i fältet). Det innebär bl.a. att följande tecken ska kodas:

< → <
> → >
& → &
" → "
' → '

Sökordsfilter appliceras när DocBook-formatet används, med undantag för delar där inbäddade element används. Det vill säga: filtrering görs endast på de delar av DocBook som enbart innehåller en sträng.

Nedan är ett exempel på hur en DocBookformaterad anteckning kan se ut. För mer detaljerad information om DocBook-implementationen se tjänstekontraktsbeskrivningen.

<urn1:clinicalDocumentNoteText>
&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt;
&lt;article&gt;
  &lt;section&gt;
    &lt;title&gt;Tabell&lt;/title&gt;
    &lt;para&gt;Eventuell text före tabellen
      &lt;table&gt;
        &lt;caption&gt;Tabellrubrik&lt;/caption&gt;
        &lt;thead&gt;
          &lt;tr&gt;
            &lt;th&gt;&lt;/th&gt;
            &lt;th&gt;Head, Kolumn 2&lt;/th&gt;
            &lt;th&gt;Head, Kolumn 3&lt;/th&gt;
          &lt;/tr&gt;
        &lt;/thead&gt;
        &lt;tbody&gt;
          &lt;tr&gt;
            &lt;th&gt;Body, Rad 1&lt;/th&gt;
            &lt;td&gt;Body, Rad 1, Kolumn 2&lt;/td&gt;
            &lt;td&gt;Body, Rad 1, Kolumn 3&lt;/td&gt;
          &lt;/tr&gt;
          &lt;tr&gt;
            &lt;th&gt;Body, Rad 2&lt;/th&gt;
            &lt;td&gt;Body, Rad 2, Kolumn 2&lt;/td&gt;
            &lt;td&gt;Body, Rad 2, Kolumn 3&lt;/td&gt;
          &lt;/tr&gt;
        &lt;/tbody&gt;
        &lt;tfoot&gt;
          &lt;tr&gt;
            &lt;th&gt;&lt;/th&gt;
            &lt;td&gt;Foot, Kolumn 2&lt;/td&gt;
            &lt;td&gt;Foot, Kolumn 3&lt;/td&gt;
          &lt;/tr&gt;
        &lt;/tfoot&gt;
      &lt;/table&gt;
      Eventuell text efter tabellen&lt;/para&gt;
  &lt;/section&gt;
  &lt;section&gt;
    &lt;title&gt;Punktlista&lt;/title&gt;
    &lt;para&gt;Eventuell text före punktlistan
      &lt;itemizedlist&gt;
        &lt;listitem&gt;
          &lt;para&gt;Punkt 1&lt;/para&gt;
           &lt;itemizedlist&gt;
             &lt;listitem&gt;&lt;para&gt;Punkt 1 nivå 2&lt;/para&gt;&lt;/listitem&gt;
           &lt;/itemizedlist&gt;
        &lt;/listitem&gt;
        &lt;listitem&gt;&lt;para&gt;Punkt 2&lt;/para&gt;&lt;/listitem&gt;
    &lt;/itemizedlist&gt;
    Eventuell text efter punktlistan&lt;/para&gt;
  &lt;/section&gt;
  &lt;section&gt;
    &lt;title&gt;Numrerad lista&lt;/title&gt;
    &lt;para&gt;Eventuell text före numrerade listan
      &lt;orderedlist&gt;
        &lt;listitem&gt;
          &lt;para&gt;Nummer 1&lt;/para&gt;
          &lt;orderedlist&gt;
            &lt;listitem&gt;&lt;para&gt;Nummer 1.1&lt;/para&gt;&lt;/listitem&gt;
            &lt;listitem&gt;&lt;para&gt;Nummer 1.2&lt;/para&gt;&lt;/listitem&gt;
          &lt;/orderedlist&gt;
        &lt;/listitem&gt;
        &lt;listitem&gt;&lt;para&gt;Nummer 2&lt;/para&gt;&lt;/listitem&gt;
      &lt;/orderedlist&gt;
      Eventuell text efter numrerade listan&lt;/para&gt;
  &lt;/section&gt;
&lt;/article&gt;
</urn1:clinicalDocumentNoteText>

Användningsfall

Användning av DocBook i tjänstekontraktet GetCareDocumentation

Användning av DocBook i tjänstekontraktet GetCareDocumentation version 2.1 & 3.1

Namn	Typ	Beskrivning	Kardinalitet

Namn	Typ	Beskrivning	Kardinalitet
clinicalDocumentNoteText	string	Om DocBook används ska endast de element i DocBook-standarden som beskrivs i den här interaktionsöverenskommelsen användas. Andra element än de som beskrivs i den här interaktionsöverenskommelsen kommer inte att visas i NPÖ.	1..1

Användning av bilder i DocBook i tjänstekontraktet GetCareDocumentation 3.1

Observera att bilder inte kan hanteras i version 2.1 av tjänstekontraktet.

Namn	Typ	Beskrivning	Kardinalitet

Namn	Typ	Beskrivning	Kardinalitet
`clinicalDocumentNoteTex`	string	För att inkludera en bild i DocBook-meddelandet ska elementet `imagedata` inkluderas. Attributet `entityref` i elementet `imagedata` ska vara samma innehåll som `documentReference.attachment.id` i referensen till bilden.	1..1
`documentReference.attachment.id`	string	Unik identifierare för binär fil. Anvisningar för användning av `DocumentReferenceType` i sin helhet finns i interaktionsöverenskommelsen för hantering av GetBinaryData [R3].	1..1
`multimediaEntry`	MultimediaType	Används inte i NPÖ. Om attributet ändå skickas kommer NPÖ bortse från informationen.	0..0

Interaktionsöverenskommelser: DocBook i NPÖ v1

Revisionshistorik

Referenser

Inledning

Ägarskap

Tjänstekontrakt

Anvisningens krav och regler

Generella krav och regler

Användning av DocBook

Bilder

Användningsanvisning

Exempel

Tabeller

Användningsanvisning

Exempel: Rubrik som spänner över två kolumner

Listor

Användningsanvisning

Entitykodning

Användningsfall

Användning av DocBook i tjänstekontraktet GetCareDocumentation