Differences

This shows you the differences between two versions of the page.

--- fmk:1.6.0:services:hent_pakkegruppe [2025-10-09 14:33] – lbdo
+++ fmk:1.6.0:services:hent_pakkegruppe [2026-03-06 08:53] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
-=== TODO: ===
- Denne servicebeskrivelse skal tilrettes, så den passer med 1.6.0. Det vil sige:
-  * Specifikation af IncludeContents-flaget
-  * Eksempel på brug af IncludeContents-flaget
-  * Beskrivelse af PackingGroupDetails i svar
-  * Eksempel på svar (her kan [[fmk:1.6.0:services:Hent akutte perioder]] nok bruges som inspiration, da begge dele benytter ''EntityWithDispensing''-elementet)
 ====== Hent pakkegruppe ======
@@ Line 11: / Line 4: @@
 Denne service anvendes af apoteket til at hente en pakkegruppe samt evt. et overblik over de patienter, dispenseringskort og -perioder, der er knyttet til pakkegruppen.
-Denne service kan kaldes med VOCES / FOCES certifikat. Det kan blandt andet anvendes af udleveringsapoteket, til automatisering af kald Påbegynd DD ekspedition for alle dispenseringskort i en pakkegruppe, eller til polling fra pakkeapoteket for at afgøre om hele pakkegruppen er klar til pakning.
+Denne service kan kaldes med VOCES / FOCES certifikat. Det kan blandt andet anvendes af udleveringsapoteket, til automatisering af kald Påbegynd DD ekspedition for alle dispenseringskort i en pakkegruppe, eller til poll-ing fra pakkeapoteket for at afgøre om hele pakkegruppen er klar til pakning.
-===== Forespørgsler til servicen =====
+===== Forespørgsel =====
-Der er 3 primære inputs til servicen:
+[[fmk:medicinecard-inline_2022_01_01:feltbeskrivelser#GetPackingGroupRequestType|Request]]
+I forspørgsel til service angives følgende elementer:
   * ''PackingGroupIdentifier'': Identifier på pakkegruppen
-  * ''FilterDate'': Op til 2 af disse kan angives. Se beskrivelse herunder.
+  * Optionelt: ''IncludeContents'' element, som markerer at et overblik af tilknyttede dispenseringskort ønskes.
-  * ''IncludeContents'': Flag, som markerer, at opsummering af tilknyttede dispenseringskort ønskes. Derudover kan der på dette element specificeres ''IncludePatientDetails'', hvis dispenseringskortene ønskes returneret sammen med patientdetaljer.
-''FilterDate'' er valgfri at benytte, benyttes den ikke vil FMK bruge "nu" og "14 dage". ''FilterDate'' overtager for ''ProductionTime'' i 1.4.6, hvor ''ProductionTime'' skulle være en dato mellem ''Deadline'' og ''StartDate'' (Begge inklusive). Da ''Deadline'' udgår i 1.6.0, benyttes 1 eller 2 ''FilterDate'' til at vælge et tidsrum hvor StartDate skal ligge imellem disse datoer. Angives 1 ''FilterDate'' vil FMK søge mellem "nu" og den angivne ''FilterDate''. Angives begge søger FMK perioder hvor ''StartDate'' ligger imellem disse datoer.
+På ''IncludeContents'' elementet kan der gives et eller begge af følgende elementer:
+  * ''IncludePatientDetails''-flag, hvis dispenseringskortene ønskes returneret sammen med patientdetaljer.
+  * ''IncludeStatus''-element kan angives, for at modtage overblik og evt status for alle de dispenseringskort //og dertil knyttede dispenseringsperioder//, der er knyttet til gruppen. Det er kun dispenseringskort med aktive dispenseringsperioder, som fremsøges hvis dette benyttes, se nedenfor.
+''IncludeStatus'' kan indeholde op til 2 ''FilterDate''-elementer, som specificerer et tidsrum, hvor en aktiv periode på fremsøgte dispenseringskort skal have StartDate til at ligge imellem disse datoer. Angives der ikke nogen ''FilterDate''-elementer, vil FMK søge mellem "nu" og "14 dage frem".
+Angives 1 ''FilterDate'', vil FMK søge mellem "nu" og den angivne ''FilterDate''. Angives begge, fremsøger FMK perioder, hvor ''StartDate'' ligger imellem disse datoer.
+**Bemærk** Benyttes ''IncludeStatus'' ikke på ''IncludeContents'' vil man få et overblik over alle dispenseringskort i pakkegruppen, også dem uden nogen perioder. Hvorimod de frasorteres såfremt ''IncludeStatus'' benyttes.
 Her er et eksempel på et request, der blot henter overordnet information om pakkegruppen:
@@ Line 33: / Line 37: @@
 Dette er et eksempel på et request, der henter en oversigt over hvilke dosiskort der er tilknyttet til en pakkegruppe.
-<file xml GetPackingGroupOverviewRequest.xml>
+<file xml GetPackingGroupRequest.xml>
 <GetPackingGroupRequest>
     <PackingGroupIdentifier>24646345634</PackingGroupIdentifier>
@@ Line 40: / Line 44: @@
 </file>
-===== Svar fra servicen =====
+Dette er et eksempel på et request, der henter en opsummeringer af dosiskort der er tilknyttet til en pakkegruppe. Der fremsøges dosiskort, hvor en dispenseringsperiode starter mellem "nu" og 30. september 2026.
-Svaret fra servicen indeholder et ''PackingGroupDetails'' og en liste af ''EntityWithDispensing'' elementer. Disse elementer indeholder følgende:
+<file xml GetPackingGroupRequest2.xml>
+<GetPackingGroupRequest>
+    <PackingGroupIdentifier>24646345634</PackingGroupIdentifier>
+    <IncludeContents>
+        <IncludeStatus>
+            <FilterDate>2026-09-30T00:00:00</FilterDate>
+        </IncludeStatus>
+    </IncludeContents>
+</GetPackingGroupRequest>
+</file>
+===== Svar =====
+[[fmk:medicinecard-inline_2022_01_01:feltbeskrivelser#GetPackingGroupResponseType|Response]]
+Svaret fra servicen indeholder først et ''PackingGroup''-element med følgende detaljer om pakkegruppen:
+  * ''Identifier'', ID på pakkegruppen
+  * ''Version'', pakkegruppens versionsnummer
+  * ''Created'', modifikator på personen som oprettede pakkegruppen
+  * Optionelt ''ReportedBy'', modifikator som indrapportede pakkegruppen til FMK
+  * Optionelt ''Modified'', modifikator på personen som senest ændrede pakkegruppen
+  * ''Name'', navnet på pakkegruppen
+  * ''OrderedAtPharmacy'', udleveringsapoteket, som pakkegruppen er tilknyttet
+  * ''PackedAtOrganisation'', pakkeapoteket, som pakkegruppen er tilknyttet
+Hernæst kommer en liste af ''EntityWithDispensing'' elementer. Disse hentes kun såfremt ''IncludeContents'' blev angives i forespørgslen, elementer indeholder følgende:
-  * Valget mellem ''PersonIdentifier'', ''Patient'' & ''Organisation''. Hvorvidt ''Patient'' eller ''PersonIdentifier'' returneres, afhænger af ''IncludePatientDetails''-flaget fra forespørgslen.
+  * Valget mellem ''PersonIdentifier'', ''Patient'' & ''Organisation''. **bemærk** Hvorvidt ''Patient'' eller ''PersonIdentifier'' returneres, afhænger af ''IncludePatientDetails''-flaget fra forespørgslen.
   * Optionelt en række ''PatientRegistration'' elementer. Såfremt der på patienten er registeret nogle af disse, og disse er aktive, vil de fremkomme her.
-  * ''DispensingCard'' element, som indeholder en række informationer.
+  * Optionelt en række ''DispensingCard''-elementer
-''DispensingCard'' elementet indeholder følgende informationer:
+''DispensingCard'' elementerne forekommer kun såfremt blev angivet i forespørgslen, elementerne indeholder følgende informationer:
   * ''Identifier'' ID på dispenseringskortet
   * ''Description'' Beskrivelse af kortet
-  * ''PackingGroupIdentifier'', ''PackingGroupName'', ''OrderedAtPharmacy'' & ''PackedAtOrganisation''. Bemærk igen at ''DispensingOrganisation'' er inkluderet i skemaet, men det forventes ikke denne værdi vil kunne forekomme fra denne service.
+  * ''PackingGroupIdentifier'', ''PackingGroupName'', ''OrderedAtPharmacy'' & ''PackedAtOrganisation''. Bemærk at ''DispensingOrganisation'' er inkluderet i skemaet, men det forventes ikke denne værdi vil kunne forekomme fra denne service.
-  * Optionelt en række ''DispensingPeriod'' elementer. Der vil fra denne service altid være mindst 1 periode.
+  * Optionelt en række ''DispensingPeriod'' elementer.
-''DispensingPeriod'' elementerne indeholder følgende:
+''DispensingPeriod'' elementerne forekommer kun såfremt ''IncludeStatus'' blev angivet på forespørgslen, gøres dette vil der altid være mindst 1 periode per ''DispenisngCard''. Elementerne indeholder følgende:
-  * ''Identifier'' ID på perioden.
+  * ''Identifier'', ID på perioden.
-  * ''Created'' Modifikatoren på person som oprettede perioden.
+  * ''Version'', versionsnummer for perioden
-  * Optionelt ''ReportedBy'' & ''Modified'' modifikatorer på personen som indberettede og foretog den seneste ændring. ''Modified'' forekommer kun såfremt perioden har været ændret mindst 1 gang
+  * ''Created'', Modifikatoren på person som oprettede perioden.
-  * Optionelt ''ExpectedDelivery'' timestamp på hvornår perioden forventes leveret.
+  * Optionelt ''ReportedBy'' & ''Modified'', modifikatorer på personen som indberettede og foretog den seneste ændring. ''Modified'' forekommer kun såfremt perioden har været ændret mindst 1 gang
+  * ''StartDate'', periodens startdato
+  * ''EndDate'', periodens slutdato
+  * Optionelt ''ExpectedDelivery'', timestamp på hvornår perioden forventes leveret.
   * ''Status'' den nuværende status for perioden.
-  * Optionelt ''ProductionIdentifier'' stregkoden for den pågældende periode.
+  * Optionelt ''ProductionIdentifier'', stregkoden for den pågældende periode.
-  * Optionelt ''AcutePacking''
+  * Optionelt ''AcutePacking'', akut status for perioden
-  *
+=== Eksempel ===
+Nedenstående eksempel svarer til det tredje eksempel på request. I.e. der hentes ikke patientdetaljer, men til gengæld hentes der overblik over perioder via ''IncludeStatus''.
+<file xml GetPackingGroupResponse.xml>
+<GetPackingGroupResponse>
+    <PackingGroup>
+        <Identifier>24646345634</Identifier>
+        <Version>323423424908</Version>
+        <Created>
+            <By>
+                <HealthcareProfessional>
+                    <Identifier source="CPR">1212121234</Identifier>
+                    <Name>Anne Jørgensen</Name>
+                </HealthcareProfessional>
+                <Role>Apoteksansat</Role>
+                <Organisation>
+                    <Identifier source="EAN-Lokationsnummer">5790000171323</Identifier>
+                    <Type>Apotek</Type>
+                    <Name>Århus Jernbane Apotek</Name>
+                    <AddressLine>Banegårdsplads 8</AddressLine>
+                    <AddressLine>8000 Århus</AddressLine>
+                </Organisation>
+            </By>
+            <DateTime>2025-08-16T10:34:08</DateTime>
+        </Created>
+        <Name>Jernbanens pakkegruppe</Name>
+        <OrderedAtPharmacy>
+            <Identifier source="EAN-Lokationsnummer">5790000171323</Identifier>
+            <Type>Apotek</Type>
+            <Name>Århus Jernbane Apotek</Name>
+            <AddressLine>Banegårdsplads 8</AddressLine>
+            <AddressLine>8000 Århus</AddressLine>
+        </OrderedAtPharmacy>
+        <PackedAtOrganisation>
+            <Identifier source="EAN-Lokationsnummer">5790000173525</Identifier>
+            <Type>Apotek</Type>
+            <Name>Århus Stjerne Apotek</Name>
+            <AddressLine>Funch Thomsensgade 3</AddressLine>
+            <AddressLine>8200 Århus N</AddressLine>
+        </PackedAtOrganisation>
+    </PackingGroup>
+    <EntityWithDispensing>
+        <PersonIdentifier>1231231238</PersonIdentifier>
+        <DispensingCard>
+            <Identifier>21312312309179</Identifier>
+            <Description>Dosisdispenseret medicin</Description>
+            <PackingGroupIdentifier>24646345634</PackingGroupIdentifier>
+            <PackingGroupName>Jernbanens pakkegruppe</PackingGroupName>
+            <OrderedAtPharmacy>
+               ...
+            </OrderedAtPharmacy>
+            <PackedAtOrganisation>
+               ...
+            </PackedAtOrganisation>
+            <DispensingPeriod>
+                <Identifier>98989893421</Identifier>
+                <Version>9891342898234</Version>
+                <Created>
+                    <By>
+                        <HealthcareProfessional>
+                            <Identifier source="CPR">1212121234</Identifier>
+                            <Name>Anne Jørgensen</Name>
+                        </HealthcareProfessional>
+                        <Role>Apoteksansat</Role>
+                        ...
+                   </By>
+                   <DateTime>2026-09-02T10:34:08</DateTime>
+                </Created>
+                <StartDate>2026-09-25</StartDate>
+                <EndDate>2026-10-15</EndDate>
+                <Status>Pakning afsluttet</Status>
+            </DispensingPeriod>
+        </DispensingCard>
+    </EntityWithDispensing>
+    <EntityWithDispensing>...</EntityWithDispensing>
+    <EntityWithDispensing>...</EntityWithDispensing>
+</GetPackingGroupResponse>
+</file>