DICOMweb Service Documentatie | PostDICOM

Vereisten Introductie & Algemene Informatie

Dit document biedt een uitgebreide technische gids voor de DICOMweb API-functies met voorbeeldmethoden die worden gebruikt via een C#-voorbeeldapplicatie. Het bevat gedetailleerde uitleg van alle beschikbare functies, inclusief zowel standaard DICOMweb-services (zoals QIDO-RS, WADO-RS en STOW-RS) als aangepaste DICOMweb API-eindpunten ontwikkeld door PostDICOM. Deze functies zijn ontworpen voor gebruik in server-side aanroepen.

Om de DICOMweb-services van PostDICOM te gebruiken, moet deze functie eerst zijn ingeschakeld voor uw account en moet u over geldige inloggegevens 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.

Gebruikersnaam: Dit is uw primaire inloggegeven, meestal uw e-mailadres. Het is uniek voor uw account en wordt gebruikt als gebruikersnaam bij Basisauthenticatie.

Wachtwoord: Dit is het wachtwoord dat aan uw PostDICOM-account is gekoppeld. Het wordt gebruikt in combinatie met uw gebruikersnaam tijdens Basisauthenticatie. Voor optimale veiligheid raden we ten zeerste aan een sterk wachtwoord te kiezen. Zorg voor de nodige beveiligingsmechanismen aan uw serverzijde zodat deze gebruikersnaam en dit wachtwoord door uzelf worden beschermd.

U kunt uw wachtwoord en beveiligingsinstellingen beheren via uw accountprofielpagina nadat u bent ingelogd op uw PostDICOM-account.

DICOMweb Standaard Services

DICOM-instanties opslaan (STOW-RS)

UploadDicomImagesInAFolder(UserName, Password, WebAddress, FileNamesList)

Deze functie orkestreert het uploaden van alle .dcm-bestanden vanuit een opgegeven lokale map naar de DICOMweb-server. Het identificeert eerst alle relevante bestanden en gebruikt vervolgens hulpmethoden om voor elk bestand een geauthenticeerd multipart/related POST-verzoek samen te stellen en te verzenden, conform de STOW-RS-standaard.

Vereiste parameters	Gegevenstype	Beschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDICOM-account. (vanuit initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDICOM-account. (vanuit initialisatie)
WebAddress	string	De basis-URL van de API. (vanuit initialisatie)
DirectoryPath	string	Het volledige pad naar de lokale map met de DICOM (.dcm) bestanden die geüpload moeten worden.

Zoeken naar DICOM-objecten (QIDO-RS)

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

Deze functie voert een query uit voor 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, Studie-instantie UID of Serie-instantie UID) bouwt het de juiste URL op en voert het een geauthenticeerd verzoek uit om overeenkomende resultaten van de server op te halen.

Vereiste parameters	Gegevenstype	Beschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDICOM-account. (vanuit initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDICOM-account. (vanuit initialisatie)
WebAddress	string	De basis-URL van de API. (vanuit initialisatie)
PatientID	string	Optioneel. Gebruikt om de patiënt te identificeren en naar gerelateerde studies te zoeken.
StudyInstanceUID	string	Optioneel. Gebruikt om naar een specifieke studie of alle series binnen die studie te zoeken.
SeriesInstanceUID	string	Optioneel. Gebruikt om naar alle beeldinstanties binnen een specifieke serie 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 (Studie, Serie of Instantie) en geeft de bijbehorende UID op. De functie doet vervolgens een geauthenticeerd verzoek en verwerkt het multipart/related antwoord, waarbij elk DICOM-deel als een apart .dcm-bestand wordt opgeslagen in een nieuw aangemaakte lokale map.

Vereiste parameters	Gegevenstype	Beschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDICOM-account. (vanuit initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDICOM-account. (vanuit initialisatie)
WebAddress	string	De basis-URL van de API. (vanuit initialisatie)
StudyInstanceUID	string	Optioneel. Een wereldwijd unieke identificatie voor een DICOM-studie. Gebruikt om alle series en instanties gekoppeld aan die studie op te halen.
SeriesInstanceUID	string	Optioneel. Een wereldwijd unieke identificatie voor een serie binnen een DICOM-studie. Gebruikt om alle beelden onder die serie op te halen.
SOPInstanceUID	string	Optioneel. Een unieke identificatie voor een individuele DICOM-beeldinstantie. Gebruikt om een specifiek beeld op te halen met WADO-RS.

Beheer van delen

Deellink aanmaken

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

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

Vereiste parameters	Gegevenstype	Beschrijving
UserName	string	De gebruikersnaam (e-mail) voor het PostDICOM-account. (vanuit initialisatie)
Password	string	Het wachtwoord voor het PostDICOM-account. (vanuit initialisatie)
WebAddress	string	De basis-URL van de API. (vanuit initialisatie)
PatientOrderInfoList	List	Lijst van JSON-strings, elk met een "PatientOrderUuid"-sleutel, die de te delen patiëntorders identificeren.
ExpireDate	string (YYYY-MM-DD)	Vervaldatum voor de deellink. Na deze datum wordt de link uitgeschakeld.
SharePassword	string	Optioneel. Wachtwoord vereist voor toegang tot de deellink. Laat leeg voor openbare toegang.
Downloadable	bool	Optioneel. Bepaalt of de DICOM-studies door de ontvanger gedownload kunnen worden.

Patiëntorder delen via URL

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

Deze functie genereert een deelbare URL voor geselecteerde patiëntorders met extra toegangscontrole-opties zoals downloadtoestemming en wachtwoordbeveiliging.

Vereiste parameters	Gegevenstype	Beschrijving
UserName	string	De gebruikersnaam (e-mail) van het PostDICOM-account. (vanuit initialisatie)
Password	string	Het wachtwoord voor het PostDICOM-account. (vanuit initialisatie)
WebAddress	string	De basis-URL van de API. (vanuit initialisatie)
OrderUuidList	List	Lijst van UUID's die de te delen patiëntorders identificeren.
ExpireDate	string (YYYY-MM-DD)	Datum waarna de deellink inactief wordt.
SharePassword	string	Optioneel. Wachtwoord vereist voor toegang tot de gedeelde link.
UserCanDownloadStudies	bool	Optioneel. Indien ingesteld op waar (true), kan de ontvanger de studies downloaden.

Map- & Orderbeheer

Map aanmaken

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

Deze functie wordt gebruikt om een nieuwe map (een virtuele container) binnen het PostDICOM-account aan te maken om patiëntorders te helpen organiseren.

Vereiste parameters	Gegevenstype	Beschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDICOM-account. (vanuit initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDICOM-account. (vanuit initialisatie)
WebAddress	string	De basis-URL van de API. (vanuit initialisatie)
FolderName	string	Vereist. 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 de nieuwe map daarin aan te maken.

Map zoeken

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

Deze functie vindt bestaande mappen op basis van zoekcriteria. Het kan optioneel de lijst met patiëntorders binnen elke gevonden map bevatten.

Vereiste parameters	Gegevenstype	Beschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDICOM-account. (vanuit initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDICOM-account. (vanuit initialisatie)
WebAddress	string	De basis-URL van de API. (vanuit initialisatie)
ParentFolderUuid	string	Optioneel. Een map-UUID om het zoeken te beperken tot de submappen.
FolderName	string	Optioneel. Een volledige of gedeeltelijke naam om naar te zoeken.
GetOrdersInFolder	bool	Optioneel. Indien `true`, zal het antwoord een lijst met patiëntorders bevatten voor elke gevonden map.

Map delen via URL

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

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

Vereiste parameters	Gegevenstype	Beschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDICOM-account. (vanuit initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDICOM-account. (vanuit initialisatie)
WebAddress	string	De basis-URL van de API. (vanuit initialisatie)
FolderUuid	string	Vereist. De unieke identificatie (UUID) van de map die gedeeld moet worden.
SharePassword	string	Optioneel. Een wachtwoord om de gedeelde link te beschermen. Indien leeg gelaten, is de link openbaar toegankelijk.
ShareTitle	string	Optioneel. Een aangepaste titel voor de gedeelde mappagina, zichtbaar voor de ontvanger.
ShareDescription	string	Optioneel. Een beschrijving weergegeven op de gedeelde mappagina.
ExpireDate	string (YYYY-MM-DD)	Optioneel. De datum waarop de deellink automatisch inactief wordt.
UserCanDownloadStudies	bool	Optioneel. Indien `true`, kunnen ontvangers de patiëntorders in de map downloaden.

Order toevoegen aan map

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

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

Vereiste parameters	Gegevenstype	Beschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDICOM-account. (vanuit initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDICOM-account. (vanuit initialisatie)
WebAddress	string	De basis-URL van de API. (vanuit initialisatie)
PatientOrderUuid	string	Vereist. De UUID van de patiëntorder die in een map moet worden geplaatst.
FolderUuidList	List	Vereist. Een lijst met de UUID van de bestemmingsmap.

Werkstroom & Toewijzing

Order toewijzen aan gebruiker

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

Deze functie is een belangrijk werkstroomhulpmiddel. Het wijst een patiëntorder toe aan een individuele gebruiker, wat aangeeft dat deze gebruiker nu verantwoordelijk is voor een taak met betrekking tot die order (bijv. verslaglegging).

Vereiste parameters	Gegevenstype	Beschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDICOM-account. (vanuit initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDICOM-account. (vanuit initialisatie)
WebAddress	string	De basis-URL van de API. (vanuit initialisatie)
PatientOrderUuid	string	Vereist. De UUID van de patiëntorder die actie vereist.
AssignedUserUuid	string	Vereist. De UUID van de specifieke gebruiker aan wie de verantwoordelijkheid wordt toegewezen.

Order toewijzen aan gebruikersgroep

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

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

Vereiste parameters	Gegevenstype	Beschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDICOM-account. (vanuit initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDICOM-account. (vanuit initialisatie)
WebAddress	string	De basis-URL van de API. (vanuit initialisatie)
PatientOrderUuid	string	Vereist. De UUID van de patiëntorder die aan de groep moet worden toegewezen.
AssignedUserGroupUuid	string	Vereist. De UUID van de gebruikersgroep aan wie de order wordt toegewezen.

Levenscyclus Patiëntorder & Gegevensopvraging

Patiëntorder aanmaken

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

Deze functie maakt een nieuwe patiëntorder aan om beeldvormende onderzoeken binnen het systeem te plannen en te beheren. Vereiste parameters moeten worden opgegeven voor succesvolle aanmaak.

Vereiste parameters	Gegevenstype	Beschrijving
InstitutionUuid	string	Vereist. UUID van de instelling waar de patiëntorder wordt aangemaakt.
PatientName	string	Vereist. Volledige naam van de patiënt.
PatientId	string	Vereist. Unieke identificatie van de patiënt, zoals een nationaal ID of patiëntennummer.
PatientBirthdate	string (YYYY-MM-DD)	Vereist. Geboortedatum van de patiënt in ISO-formaat.
Modality	string	Vereist. Modaliteitstype zoals CT, MR, US, enz.
OtherPatientId	string	Optioneel. Een extra identificatie voor de patiënt, indien van toepassing.
PatientSex	string	Optioneel. Geslacht van de patiënt (bijv. M, F, O).
StudyDescription	string	Optioneel. Beschrijving van het bestelde beeldvormende onderzoek.
AccessionNumber	string	Optioneel. Uniek toegangsnummer voor de order, indien van toepassing.
PatientComplaints	string	Optioneel. Tekst die de klachten of symptomen van de patiënt beschrijft.
OrderScheduledDatetime	string (YYYY-MM-DD HH:MM)	Optioneel. De geplande startdatum en -tijd van de procedure.
RequestedProcedureId	string	Optioneel. Identificatie voor de aangevraagde procedure.
RequestedProcedureDescription	string	Optioneel. Beschrijving van de aangevraagde procedure.
RequestingPhysician	string	Optioneel. Naam van de arts die het onderzoek heeft aangevraagd.
ReferringPhysiciansName	string	Optioneel. Naam van de verwijzende arts, indien anders dan aanvragend.
ScheduledEquipmentUuid	string	Optioneel. UUID van de beeldvormingsapparatuur die gebruikt moet worden voor de geplande procedure.

Eigenschappen patiëntorder ophalen

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

Deze functie haalt de volledige set eigenschappen op voor één specifieke patiëntorder.

Vereiste parameters	Gegevenstype	Beschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDICOM-account. (vanuit initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDICOM-account. (vanuit initialisatie)
WebAddress	string	De basis-URL van de API. (vanuit initialisatie)
PatientOrderInstitutionUuid	string	Vereist. De UUID van de instelling waartoe de order behoort.
PatientOrderUuid	string	Vereist. De UUID van de specifieke patiëntorder die moet worden opgehaald.

Zoeken naar patiëntorders

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

Deze functie haalt een lijst met patiëntorders 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 orders beheren.

Vereiste parameters	Gegevenstype	Beschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDICOM-account. (vanuit initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDICOM-account. (vanuit initialisatie)
WebAddress	string	De basis-URL van de API. (vanuit initialisatie)
InstitutionUuidList	List	Lijst van UUID's die de instellingen identificeren om naar patiëntorders te zoeken.
PatientName	string	Optioneel. Filteren op de volledige naam van de patiënt.
PatientId	string	Optioneel. Filteren op de unieke identificatie van de patiënt.
OtherPatientId	string	Optioneel. Secundaire identificatie voor de patiënt, indien beschikbaar.
AccessionNumber	string	Optioneel. Filteren op toegangsnummer toegewezen aan de studie.
ModalityList	List	Lijst van modaliteiten (bijv. CT, MR, US) om de zoekresultaten te filteren.
StudyDateFrom	string (YYYY-MM-DD)	Optioneel. Startdatum van het studie-datumbereik voor het filteren van resultaten.
StudyDateTo	string (YYYY-MM-DD)	Optioneel. Einddatum van het studie-datumbereik voor het filteren van resultaten.
PatientBirthdateFrom	string (YYYY-MM-DD)	Optioneel. Startdatum van patiëntgeboortedatumbereik om patiënten op leeftijd te filteren.
PatientBirthdateTo	string (YYYY-MM-DD)	Optioneel. Einddatum van patiëntgeboortedatumbereik om patiënten op leeftijd te filteren.

Patiëntorder verwijderen

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

Deze functie verwijdert permanent een patiëntorder uit het systeem. Het vereist zowel de instellings-UUID als de specifieke patiëntorder-UUID om nauwkeurigheid te garanderen en onbedoelde verwijdering te voorkomen.

Vereiste parameters	Gegevenstype	Beschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDICOM-account. (vanuit initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDICOM-account. (vanuit initialisatie)
WebAddress	string	De basis-URL van de API. (vanuit initialisatie)
PatientOrderInstitutionUuid	string	Vereist. UUID van de instelling die de patiëntorder bezit. Zorgt ervoor dat de juiste context wordt gebruikt voor verwijdering.
PatientOrderUuid	string	Vereist. UUID van de specifieke patiëntorder die moet worden verwijderd. Dit identificeert de order uniek in het systeem.

Inhoud DICOM-tag ophalen

Inhoud DICOM-tag ophalen

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

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

Vereiste parameters	Gegevenstype	Beschrijving
UserName	string	De gebruikersnaam (e-mailadres) voor het PostDICOM-account. (vanuit initialisatie)
Password	string	Het wachtwoord dat is gekoppeld aan het PostDICOM-account. (vanuit initialisatie)
WebAddress	string	De basis-URL van de API. (vanuit initialisatie)
PatientOrderInstitutionUuid	string	Vereist. De UUID van de instelling waar de order zich bevindt.
PatientOrderUuid	string	Vereist. De UUID van de order die de beelden bevat.
PatientSeriesUuid	string	Optioneel. Indien opgegeven, worden tags alleen gelezen uit deze specifieke serie.
DicomTagIdList	List	Optioneel. Een lijst met DICOM Tag-ID's om op te halen.