Documentatie voor de DiComWeb-service | PostDiCom

Prerequisites Introductie en algemene informatie

Dit document bevat een uitgebreide technische handleiding voor de DICOMweb API functies met voorbeeldmethoden die worden gebruikt via een C#-voorbeeldtoepassing. Het bevat gedetailleerde uitleg van alle beschikbare functies, met betrekking tot beide standard DICOMweb services (zoals QIDO-RS, WADO-RS, and STOW-RS) en custom DICOMweb API endpoints ontwikkeld door PostDiCom. Deze functies zijn ontworpen om te worden gebruikt bij gesprekken aan de serverzijde.

Om de DiComWeb-services van PostDiCom te gebruiken, moet u deze functie eerst hebben ingeschakeld voor uw account en over geldige gebruikersgegevens beschikken. Als DiComWeb-toegang nog niet is geactiveerd voor uw account en u uw applicatie wilt integreren met PostDiCom, neem dan contact met ons op om activering aan te vragen.

User Name: Dit is uw primaire inloggegevens, meestal uw e-mailadres. Het is uniek voor uw account en wordt gebruikt als gebruikersnaam bij basisverificatie.

Password: Dit is het wachtwoord dat is gekoppeld aan uw PostDiCom-account. Het wordt gebruikt in combinatie met uw gebruikersnaam tijdens de basisverificatie. Voor een optimale beveiliging raden we ten zeerste aan om een sterk wachtwoord te kiezen. Zorg voor de nodige beveiligingsmechanismen bij uw server-side call, zodat deze gebruikersnaam en wachtwoord door uzelf worden beschermd.

U kunt uw wachtwoord en beveiligingsinstellingen beheren via de profielpagina van uw account nadat u bent ingelogd op uw PostDiCom-account

DiComWeb standaarddiensten

DICOM-instanties opslaan ( STOW-RS)

UploadDicomImagesInAFolder(UserName, Password, WebAddress, FileNamesList)

Deze functie orkestreert het uploaden van alle .dcm-bestanden van een bepaalde lokale map naar de DICOMweb-server. Het identificeert eerst alle relevante bestanden en gebruikt vervolgens hulpmethoden om een geverifieerd, meerdelig of gerelateerd POST-verzoek voor elk bestand samen te stellen en te verzenden, volgens de STOW-RS-standaard.

Required Parameters	Data Type	Omschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDiCom-account. (vanaf de initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDiCom-account. (vanaf de initialisatie)
WebAddress	string	De basis-URL van de API. (vanaf de initialisatie)
DirectoryPath	string	Het volledige pad naar de lokale map met de DICOM-bestanden (.dcm) die moeten worden geüpload.

Query voor DICOM-objecten ( QIDO-RS)

QidoSearch(UserName, Password, WebAddress, PatientID, StudyInstanceUID, SeriesInstanceUID)

Deze functie voert een zoekopdracht uit naar DICOM-objecten met behulp van de QIDO-RS-standaard, waardoor zoekopdrachten op studie-, serie- of instantieniveau mogelijk zijn. Op basis van de opgegeven zoekparameter (zoals patiënt-ID, Study Instance UID of Series Instance UID) wordt de juiste URL geconstrueerd en een geverifieerd verzoek uitgevoerd om overeenkomende resultaten van de server op te halen.

Required Parameters	Data Type	Omschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDiCom-account. (vanaf de initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDiCom-account. (vanaf de initialisatie)
WebAddress	string	De basis-URL van de API. (vanaf de initialisatie)
PatientID	string	Optioneel. Wordt gebruikt om de patiënt te identificeren en te zoeken naar gerelateerde onderzoeken.
StudyInstanceUID	string	Optioneel. Wordt gebruikt om te zoeken naar een specifiek onderzoek of naar alle series binnen dat onderzoek.
SeriesInstanceUID	string	Optioneel. Wordt gebruikt om naar alle afbeeldingsinstanties binnen een specifieke reeks te zoeken.

DICOM-instanties ophalen ( WADO-RS)

RetrieveImagesUsingWadoRs(UserName, Password, WebAddress, StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID)

Deze functie biedt een interactief menu om DICOM-objecten op te halen met behulp van de WADO-RS-standaard. De gebruiker selecteert een ophaalniveau (Study, Series of Instance) en geeft de bijbehorende UID op. De functie voert vervolgens een geverifieerd verzoek uit en verwerkt het multipart/gerelateerde antwoord, waarbij elk DICOM-onderdeel als een afzonderlijk .dcm-bestand wordt opgeslagen in een nieuw aangemaakte lokale map.

Required Parameters	Data Type	Omschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDiCom-account. (vanaf de initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDiCom-account. (vanaf de initialisatie)
WebAddress	string	De basis-URL van de API. (vanaf de initialisatie)
StudyInstanceUID	string	Optioneel. Een wereldwijd unieke identificatiecode voor een DICOM-onderzoek. Wordt gebruikt om alle series en instanties op te halen die verband houden met dat onderzoek.
SeriesInstanceUID	string	Optioneel. Een wereldwijd unieke identificatiecode voor een reeks binnen een DICOM-onderzoek. Wordt gebruikt om alle afbeeldingen in die serie op te halen.
SOPInstanceUID	string	Optioneel. Een unieke identificatie voor een individuele DICOM-beeldinstantie. Wordt gebruikt om een specifieke afbeelding op te halen met WADO-RS.

Beheer van delen

Maak een link om te delen

CreateShareLink(UserName, Password, WebAddress, PatientOrderInfoList, ExpireDate, SharePassword, Downloadable)

Deze functie genereert een beveiligde weblink om een of meer patiëntopdrachten te delen met externe gebruikers. De link kan met een wachtwoord worden beveiligd en optioneel downloads toestaan.

Required Parameters	Data Type	Omschrijving
UserName	string	De gebruikersnaam (e-mail) voor het PostDiCom-account. (vanaf de initialisatie)
Password	string	Het wachtwoord voor het PostDiCom-account. (vanaf de initialisatie)
WebAddress	string	De basis-URL van de API. (vanaf de initialisatie)
PatientOrderInfoList	List	Lijst met JSON-tekenreeksen, die elk een „PatientOrderUUID” -sleutel bevatten, waarmee de orders van patiënten worden geïdentificeerd die moeten worden gedeeld.
ExpireDate	string (YYYY-MM-DD)	Vervaldatum voor de deellink. Na deze datum wordt de link uitgeschakeld.
SharePassword	string	Optioneel. Wachtwoord vereist om toegang te krijgen tot de deellink. Leeg laten voor openbare toegang.
Downloadable	bool	Optioneel. Bepaalt of de DICOM-onderzoeken door de ontvanger kunnen worden gedownload.

Patiëntbestelling delen met URL

SharePatientOrderWithUrl(UserName, Password, WebAddress, OrderUuidList, ExpireDate, SharePassword, UserCanDownloadStudies)

Deze functie genereert een deelbare URL voor geselecteerde patiëntenbestellingen met extra opties voor toegangsbeheer, zoals downloadtoestemming en wachtwoordbeveiliging.

Required Parameters	Data Type	Omschrijving
UserName	string	De gebruikersnaam (e-mail) van het PostDiCom-account. (vanaf de initialisatie)
Password	string	Het wachtwoord voor het PostDiCom-account. (vanaf de initialisatie)
WebAddress	string	De basis-URL van de API. (vanaf de initialisatie)
OrderUuidList	List	Lijst met UUID's die aangeven welke orders van patiënten moeten worden gedeeld.
ExpireDate	string (YYYY-MM-DD)	Datum waarna de deellink inactief wordt.
SharePassword	string	Optioneel. Wachtwoord vereist om toegang te krijgen tot de gedeelde link.
UserCanDownloadStudies	bool	Optioneel. Indien ingesteld op true, kan de ontvanger de onderzoeken downloaden.

Mappen- en orderbeheer

Folder aanmaken

CreateFolder(UserName, Password, WebAddress, FolderName, FolderDescription, ParentFolderUuid)

Deze functie wordt gebruikt om binnen het PostDiCom-account een nieuwe map (een virtuele container) aan te maken om de bestellingen van patiënten te helpen organiseren.

Required Parameters	Data Type	Omschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDiCom-account. (vanaf de initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDiCom-account. (vanaf de initialisatie)
WebAddress	string	De basis-URL van de API. (vanaf de initialisatie)
FolderName	string	Verplicht. De zichtbare naam voor de nieuwe map.
FolderDescription	string	Optioneel. Een tekstbeschrijving voor de map.
ParentFolderUuid	string	Optioneel. De UUID van een bestaande map om daarin een nieuwe map aan te maken.

Folder zoeken

SearchFolder(UserName, Password, WebAddress, ParentFolderUuid, FolderName, GetOrdersInFolder)

Deze functie vindt bestaande mappen op basis van zoekcriteria. Optioneel kan de lijst met patiëntenbestellingen in elke gevonden map worden opgenomen.

Required Parameters	Data Type	Omschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDiCom-account. (vanaf de initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDiCom-account. (vanaf de initialisatie)
WebAddress	string	De basis-URL van de API. (vanaf de initialisatie)
ParentFolderUuid	string	Optioneel. Een map UUID om de zoekopdracht te beperken tot de onderliggende bestanden.
FolderName	string	Optioneel. Een volledige of gedeeltelijke naam om naar te zoeken.
GetOrdersInFolder	bool	Optioneel. Indien 'waar', bevat het antwoord een lijst met patiëntenbestellingen voor elke gevonden map.

Map met URL delen

ShareFolderWithUrl(UserName, Password, WebAddress, FolderUuid, SharePassword, ShareTitle, ShareDescription, ExpireDate, UserCanDownloadStudies)

Deze functie genereert een veilige, deelbare URL voor een hele map en de inhoud ervan. Het maakt uitgebreide toegangscontrole mogelijk door een aangepaste titel, beschrijving, wachtwoord en vervaldatum in te stellen en aan te geven of de inhoud door de ontvanger kan worden gedownload.

Required Parameters	Data Type	Omschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDiCom-account. (vanaf de initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDiCom-account. (vanaf de initialisatie)
WebAddress	string	De basis-URL van de API. (vanaf de initialisatie)
FolderUuid	string	Verplicht. De unieke identificatiecode (UUID) van de map die moet worden gedeeld.
SharePassword	string	Optioneel. Een wachtwoord om de gedeelde link te beschermen. Als de link leeg blijft, is deze openbaar toegankelijk.
ShareTitle	string	Optioneel. Een aangepaste titel voor de pagina met gedeelde mappen, zichtbaar voor de ontvanger.
ShareDescription	string	Optioneel. Een beschrijving die wordt weergegeven op de pagina met gedeelde mappen.
ExpireDate	string (YYYY-MM-DD)	Optioneel. De datum waarop de deellink automatisch inactief wordt.
UserCanDownloadStudies	bool	Optioneel. Indien 'waar', kunnen ontvangers de patiëntenbestellingen in de map downloaden.

Bestelling aan map toevoegen

AddOrderToFolder(UserName, Password, WebAddress, PatientOrderUuid, FolderUuidList)

Deze functie creëert een koppeling tussen een bestaande patiëntenbestelling en een bestaande map. Dit is een organisatietool; het verplaatst of kopieert geen gegevens.

Required Parameters	Data Type	Omschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDiCom-account. (vanaf de initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDiCom-account. (vanaf de initialisatie)
WebAddress	string	De basis-URL van de API. (vanaf de initialisatie)
PatientOrderUuid	string	Verplicht. De UUID van de patiëntenbestelling moet in een map worden geplaatst.
FolderUuidList	List	Verplicht. Een lijst met de UUID van de doelmap.

Workflow en opdracht

Bestelling aan gebruiker toewijzen

AssignOrderToUser(UserName, Password, WebAddress, PatientOrderUuid, AssignedUserUuid)

Deze functie is een belangrijk hulpmiddel voor de workflow. Het wijst een patiëntopdracht toe aan een individuele gebruiker, wat betekent dat deze gebruiker nu verantwoordelijk is voor een taak die verband houdt met die opdracht (bijvoorbeeld rapportage).

Required Parameters	Data Type	Omschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDiCom-account. (vanaf de initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDiCom-account. (vanaf de initialisatie)
WebAddress	string	De basis-URL van de API. (vanaf de initialisatie)
PatientOrderUuid	string	Verplicht. De UUID van de patiëntenbestelling waarvoor actie vereist is.
AssignedUserUuid	string	Verplicht. De UUID van de specifieke gebruiker aan wie de verantwoordelijkheid wordt toegewezen.

Bestelling aan gebruikersgroep toewijzen

AssignOrderToUserGroup(UserName, Password, WebAddress, PatientOrderUuid, AssignedUserGroupUuid)

Net als bij het toewijzen aan een enkele gebruiker, wijst deze functie een patiëntopdracht toe aan een hele groep, waardoor teamgebaseerde workflows mogelijk worden waarbij elk groepslid de taak kan uitvoeren.

Required Parameters	Data Type	Omschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDiCom-account. (vanaf de initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDiCom-account. (vanaf de initialisatie)
WebAddress	string	De basis-URL van de API. (vanaf de initialisatie)
PatientOrderUuid	string	Verplicht. De UUID van de patiëntenbestelling die aan de groep moet worden toegewezen.
AssignedUserGroupUuid	string	Verplicht. De UUID van de gebruikersgroep waaraan de bestelling moet worden toegewezen.

Levenscyclus van patiëntbestellingen en ophalen van gegevens

Patiëntbestelling aanmaken

CreatePatientOrder(UserName, Password, WebAddress, InstitutionUuid, PatientName, PatientId, OtherPatientId, PatientSex, PatientBirthdate, Modality, StudyDescription, AccessionNumber, PatientComplaints, OrderScheduledDatetime, RequestedProcedureId, RequestedProcedureDescription, RequestingPhysician, ReferringPhysiciansName, ScheduledEquipmentUuid)

Deze functie creëert een nieuwe patiëntopdracht voor het plannen en beheren van beeldvormende onderzoeken binnen het systeem. De vereiste parameters moeten worden opgegeven voor een succesvolle creatie.

Required Parameters	Data Type	Omschrijving
InstitutionUuid	string	Verplicht. UUID van de instelling waar de patiëntenbestelling wordt aangemaakt.
PatientName	string	Verplicht. Volledige naam van de patiënt.
PatientId	string	Verplicht. De unieke identificatiecode van de patiënt, zoals een nationale identiteitskaart of MRN.
PatientBirthdate	string (YYYY-MM-DD)	Verplicht. Geboortedatum van de patiënt in ISO-formaat.
Modality	string	Verplicht. Modaliteitstype zoals CT, MR, US, etc.
OtherPatientId	string	Optioneel. Een extra identificatiecode voor de patiënt, indien van toepassing.
PatientSex	string	Optioneel. Geslacht van de patiënt (bijvoorbeeld M, F, O).
StudyDescription	string	Optioneel. Beschrijving van het beeldvormende onderzoek dat wordt besteld.
AccessionNumber	string	Optioneel. Uniek toegangsnummer voor de bestelling, indien van toepassing.
PatientComplaints	string	Optioneel. Tekst waarin de klachten of symptomen van de patiënt worden beschreven.
OrderScheduledDatetime	string (YYYY-MM-DD HH:MM)	Optioneel. De geplande startdatum en -tijd van de procedure.
RequestedProcedureId	string	Optioneel. Identificatiecode voor de gevraagde procedure.
RequestedProcedureDescription	string	Optioneel. Beschrijving van de gevraagde procedure.
RequestingPhysician	string	Optioneel. Naam van de arts die de studie heeft aangevraagd.
ReferringPhysiciansName	string	Optioneel. Naam van de verwijzende arts, indien anders dan de verzoekende arts.
ScheduledEquipmentUuid	string	Optioneel. UUID van de beeldvormingsapparatuur die moet worden gebruikt voor de geplande procedure.

Eigenschappen voor patiëntbestellingen opvragen

GetPatientOrderProperties(UserName, Password, WebAddress, PatientOrderInstitutionUuid, PatientOrderUuid)

Deze functie haalt de volledige set eigenschappen op voor een enkele, specifieke patiëntbestelling.

Required Parameters	Data Type	Omschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDiCom-account. (vanaf de initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDiCom-account. (vanaf de initialisatie)
WebAddress	string	De basis-URL van de API. (vanaf de initialisatie)
PatientOrderInstitutionUuid	string	Verplicht. De UUID van de instelling waartoe de bestelling behoort.
PatientOrderUuid	string	Verplicht. De UUID van de specifieke opdracht van de patiënt om op te halen.

Zoek naar bestellingen voor patiënten

GetPatientOrderList(UserName, Password, WebAddress, InstitutionUuidList, PatientName, PatientId, OtherPatientId, AccessionNumber, ModalityList, StudyDateFrom, StudyDateTo, PatientBirthdateFrom, PatientBirthdateTo)

Deze functie haalt een lijst met patiëntenbestellingen op op basis van een combinatie van zoekfilters, zoals patiëntnaam, ID, modaliteit en studie- of geboortedata. Het maakt geavanceerde zoekfunctionaliteit mogelijk voor instellingen die meerdere bestellingen beheren.

Required Parameters	Data Type	Omschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDiCom-account. (vanaf de initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDiCom-account. (vanaf de initialisatie)
WebAddress	string	De basis-URL van de API. (vanaf de initialisatie)
InstitutionUuidList	List	Lijst met UUID's die de instellingen identificeren voor het zoeken naar bestellingen van patiënten.
PatientName	string	Optioneel. Filter op de volledige naam van de patiënt.
PatientId	string	Optioneel. Filter op de unieke identificatiecode van de patiënt.
OtherPatientId	string	Optioneel. Secundaire identificatiecode voor de patiënt, indien beschikbaar.
AccessionNumber	string	Optioneel. Filter op toegangsnummer dat aan het onderzoek is toegewezen.
ModalityList	List	Lijst met modaliteiten (bijv. CT, MR, VS) om de zoekresultaten te filteren.
StudyDateFrom	string (YYYY-MM-DD)	Optioneel. Startdatum van het datumbereik van het onderzoek voor het filteren van resultaten.
StudyDateTo	string (YYYY-MM-DD)	Optioneel. Einddatum van het datumbereik van het onderzoek voor het filteren van resultaten.
PatientBirthdateFrom	string (YYYY-MM-DD)	Optioneel. Startdatum van het geboortedatumbereik van de patiënt om patiënten op leeftijd te filteren.
PatientBirthdateTo	string (YYYY-MM-DD)	Optioneel. Einddatum van het geboortedatumbereik van de patiënt om patiënten op leeftijd te filteren.

Patiëntbestelling verwijderen

DeletePatientOrder(UserName, Password, WebAddress, PatientOrderInstitutionUuid, PatientOrderUuid)

Met deze functie wordt een patiëntopdracht permanent uit het systeem verwijderd. Het vereist dat zowel de UUID van de instelling als de specifieke patiënt een UUID bestellen om de nauwkeurigheid te garanderen en onbedoelde verwijdering te voorkomen.

Required Parameters	Data Type	Omschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDiCom-account. (vanaf de initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDiCom-account. (vanaf de initialisatie)
WebAddress	string	De basis-URL van de API. (vanaf de initialisatie)
PatientOrderInstitutionUuid	string	Verplicht. UUID van de instelling die eigenaar is van de patiëntenbestelling. Zorgt ervoor dat de juiste context wordt gebruikt voor verwijdering.
PatientOrderUuid	string	Verplicht. UUID van de specifieke patiëntenopdracht die moet worden verwijderd. Dit identificeert op unieke wijze de bestelling in het systeem.

Verkrijg de inhoud van de Dicom-tag

Inhoud van DICOM-tags verkrijgen

GetDicomTagContent(UserName, Password, WebAddress, PatientOrderInstitutionUuid, PatientOrderUuid, PatientSeriesUuid, DicomTagIdList)

Deze functie haalt de waarden van specifieke DICOM-tags op uit de afbeeldingen die zijn gekoppeld aan een patiëntbestelling.

Required Parameters	Data Type	Omschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDiCom-account. (vanaf de initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDiCom-account. (vanaf de initialisatie)
WebAddress	string	De basis-URL van de API. (vanaf de initialisatie)
PatientOrderInstitutionUuid	string	Verplicht. De UUID van de instelling waar de order zich bevindt.
PatientOrderUuid	string	Verplicht. De UUID van de bestelling die de afbeeldingen bevat.
PatientSeriesUuid	string	Optioneel. Indien aanwezig, worden alleen tags uit deze specifieke serie gelezen.
DicomTagIdList	List	Optioneel. Een lijst met DICOM-tag-ID's om op te halen.