Documentatie DICOMweb-services

VereistenIntroductie en algemene informatie

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

Om de DICOMweb-services van PostDICOM te gebruiken, moet u deze functie eerst voor uw account hebben ingeschakeld en over geldige inloggegevens beschikken. Als DICOMweb-toegang nog niet is geactiveerd voor uw account en u uw applicatie met PostDICOM wilt integreren, 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 Basic Authentication.

Wachtwoord: Dit is het wachtwoord dat is gekoppeld aan uw PostDICOM-account. Het wordt gebruikt in combinatie met uw gebruikersnaam tijdens Basic Authentication. Voor optimale veiligheid raden wij u ten zeerste aan een sterk wachtwoord te kiezen. Zorg ervoor dat u over de nodige beveiligingsmechanismen bij uw serverzijde-aanroep beschikt, 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.

DICOMwebStandaard DICOMweb-services

DICOM-instanties opslaan (STOW-RS)

UploadDicomImagesInAFolder(UserName, Password, WebAddress, FileNamesList)

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

Vereiste parameters Gegevenstype Beschrijving
UserName string De gebruikersnaam (e-mailadres) voor het PostDICOM-account. (van initialisatie)
Password string Het wachtwoord dat is gekoppeld aan het PostDICOM-account. (van initialisatie)
WebAddress string De basis-URL van de API. (van initialisatie)
DirectoryPath string Het volledige pad naar de lokale directory met de te uploaden DICOM-bestanden (.dcm).

Zoeken naar 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 niveau van het onderzoek, de serie of de instantie mogelijk zijn. Op basis van de opgegeven zoekparameter (zoals patiënt-ID, onderzoek-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. (van initialisatie)
Password string Het wachtwoord dat is gekoppeld aan het PostDICOM-account. (van initialisatie)
WebAddress string De basis-URL van de API. (van initialisatie)
PatientID string Optioneel. Gebruikt om de patiënt te identificeren en naar gerelateerde onderzoeken te zoeken.
StudyInstanceUID string Optioneel. Gebruikt om te zoeken naar een specifiek onderzoek of naar alle series binnen dat onderzoek.
SeriesInstanceUID string Optioneel. Gebruikt om 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 (onderzoek, serie of instantie) en geeft de bijbehorende UID op. De functie doet vervolgens een geauthenticeerd verzoek, verwerkt het multipart/related antwoord en slaat elk DICOM-onderdeel als een apart .dcm-bestand op in een nieuw gemaakte lokale map.

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

DelenBeheer van deelfuncties

Deellink aanmaken

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

Deze functie genereert een beveiligde webkoppeling om één of meerdere patiëntonderzoeken te delen met externe gebruikers. De koppeling kan met een wachtwoord worden beveiligd en het kan optioneel worden toegestaan om downloads uit te voeren.

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

Patiëntonderzoek delen met URL

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

Deze functie genereert een deelbare URL voor geselecteerde patiëntonderzoeken met extra toegangsbeheeropties, zoals downloadrechten en wachtwoordbeveiliging.

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

MapMappen- & Onderzoeksbeheer

Map aanmaken

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

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

Vereiste parameters Gegevenstype Beschrijving
UserName string De gebruikersnaam (e-mailadres) voor het PostDICOM-account. (van initialisatie)
Password string Het wachtwoord dat is gekoppeld aan het PostDICOM-account. (van initialisatie)
WebAddress string De basis-URL van de API. (van initialisatie)
FolderName string Vereist. De zichtbare naam voor de nieuwe map.
FolderDescription string Optioneel. Een tekstuele beschrijving voor de map.
ParentFolderUuid string Optioneel. De UUID van een bestaande map om daarin de nieuwe map te creëren.

Map zoeken

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

Deze functie zoekt naar bestaande mappen op basis van zoekcriteria. Het kan optioneel de lijst met patiëntonderzoeken binnen elke gevonden map opnemen.

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

Map delen met URL

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

Deze functie genereert een veilige, deelbare URL voor een volledige map en diens inhoud. Het zorgt voor uitgebreid toegangsbeheer door een aangepaste titel, beschrijving, een wachtwoord en een vervaldatum in te stellen, en te specificeren of de inhoud door de ontvanger kan worden gedownload.

Vereiste parameters Gegevenstype Beschrijving
UserName string De gebruikersnaam (e-mailadres) voor het PostDICOM-account. (van initialisatie)
Password string Het wachtwoord dat is gekoppeld aan het PostDICOM-account. (van initialisatie)
WebAddress string De basis-URL van de API. (van 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 beveiligen. Als dit leeg wordt gelaten, zal de link publiek toegankelijk zijn.
ShareTitle string Optioneel. Een aangepaste titel voor de gedeelde map-pagina, zichtbaar voor de ontvanger.
ShareDescription string Optioneel. Een beschrijving die wordt weergegeven op de gedeelde map-pagina.
ExpireDate string (JJJJ-MM-DD) Optioneel. De datum waarop de deellink automatisch inactief wordt.
UserCanDownloadStudies bool Optioneel. Indien `true`, kunnen ontvangers de patiëntonderzoeken binnen de map downloaden.

Onderzoek toevoegen aan map

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

Deze functie creëert een associatie tussen een bestaand patiëntonderzoek 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. (van initialisatie)
Password string Het wachtwoord dat is gekoppeld aan het PostDICOM-account. (van initialisatie)
WebAddress string De basis-URL van de API. (van initialisatie)
PatientOrderUuid string Vereist. De UUID van het patiëntonderzoek dat in een map geplaatst moet worden.
FolderUuidList List Vereist. Een lijst met daarin de UUID van de bestemmingsmap.

WorkflowWorkflow en toewijzing

Onderzoek toewijzen aan gebruiker

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

Deze functie is een essentieel workflow-hulpmiddel. Het wijst een patiëntonderzoek toe aan een individuele gebruiker, wat aangeeft dat deze gebruiker nu verantwoordelijk is voor een taak gerelateerd aan dat onderzoek (bijv. verslaglegging).

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

Onderzoek toewijzen aan gebruikersgroep

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

Vergelijkbaar met toewijzen aan een individuele gebruiker, wijst deze functie een patiëntonderzoek toe aan een hele groep. Dit maakt teamgebaseerde workflows mogelijk waarbij elk groepslid de taak kan afhandelen.

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

PatiëntonderzoekLevenscyclus van patiëntonderzoek en ophalen van gegevens

Patiëntonderzoek 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 nieuw patiëntonderzoek aan om beeldvormingsonderzoeken binnen het systeem te plannen en te beheren. Vereiste parameters moeten worden opgegeven voor een succesvolle creatie.

Vereiste parameters Gegevenstype Beschrijving
InstitutionUuid string Vereist. UUID van de instelling waar het patiëntonderzoek wordt aangemaakt.
PatientName string Vereist. Volledige naam van de patiënt.
PatientId string Vereist. Unieke identificatiecode van de patiënt, zoals een nationaal ID of patiëntnummer (MRN).
PatientBirthdate string (JJJJ-MM-DD) Vereist. Geboortedatum van de patiënt in ISO-formaat.
Modality string Vereist. Modaliteitstype zoals CT, MRI, echografie (US), enz.
OtherPatientId string Optioneel. Een extra identificatiecode voor de patiënt, indien van toepassing.
PatientSex string Optioneel. Geslacht van de patiënt (bijv. M, V, O).
StudyDescription string Optioneel. Beschrijving van het bestelde beeldvormingsonderzoek.
AccessionNumber string Optioneel. Uniek aanvraagnummer (accession number) voor het onderzoek, indien van toepassing.
PatientComplaints string Optioneel. Tekst met de klachten of symptomen van de patiënt.
OrderScheduledDatetime string (JJJJ-MM-DD UU:MM) Optioneel. De geplande startdatum en -tijd van de procedure.
RequestedProcedureId string Optioneel. Identificatiecode 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 verwijzend arts, indien verschillend van aanvragend.
ScheduledEquipmentUuid string Optioneel. UUID van de beeldvormingsapparatuur die gebruikt wordt voor de geplande procedure.

Eigenschappen van patiëntonderzoek ophalen

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

Deze functie haalt de volledige set eigenschappen op voor één specifiek patiëntonderzoek.

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

Zoeken naar patiëntonderzoeken

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

Deze functie haalt een lijst met patiëntonderzoeken op basis van een combinatie van zoekfilters, zoals de naam van de patiënt, het ID, de modaliteit, en onderzoek- of geboortedata. Het biedt geavanceerde zoekfunctionaliteit voor instellingen die meerdere onderzoeken beheren.

Vereiste parameters Gegevenstype Beschrijving
UserName string De gebruikersnaam (e-mailadres) voor het PostDICOM-account. (van initialisatie)
Password string Het wachtwoord dat is gekoppeld aan het PostDICOM-account. (van initialisatie)
WebAddress string De basis-URL van de API. (van initialisatie)
InstitutionUuidList List Lijst van UUID's die de instellingen identificeren om in te zoeken naar patiëntonderzoeken.
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 aanvraagnummer (accession number) toegewezen aan het onderzoek.
ModalityList List Lijst van modaliteiten (bijv. CT, MRI, echografie) om de zoekresultaten te filteren.
StudyDateFrom string (JJJJ-MM-DD) Optioneel. Startdatum van de onderzoeksdatumreeks voor het filteren van resultaten.
StudyDateTo string (JJJJ-MM-DD) Optioneel. Einddatum van de onderzoeksdatumreeks voor het filteren van resultaten.
PatientBirthdateFrom string (JJJJ-MM-DD) Optioneel. Startdatum van geboortedatumreeks om patiënten op leeftijd te filteren.
PatientBirthdateTo string (JJJJ-MM-DD) Optioneel. Einddatum van geboortedatumreeks om patiënten op leeftijd te filteren.

Patiëntonderzoek verwijderen

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

Deze functie verwijdert een patiëntonderzoek definitief uit het systeem. Er is zowel de UUID van de instelling als de specifieke UUID van het patiëntonderzoek vereist om nauwkeurigheid te garanderen en onbedoelde verwijdering te voorkomen.

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

DICOM-tagDICOM-taginhoud ophalen

DICOM-taginhoud ophalen

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

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

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