PostDICOM Cloud API

I den här artikeln lär du dig mer om PostDICOM Cloud API-metoderna och hur du integrerar ditt befintliga program. Vi tillhandahåller också PostDICOM Cloud API Reference Implementation som kan nås från PostDICOM Cloud API Reference Implementation.

PrequisitesFörutsättningar

För att kunna använda PostDICOM Cloud API måste du först och främst ha två nycklar, nämligen AccountKey och APIKey. Om du inte har dessa nycklar och vill integrera din applikation/webbsida med PostDICOM, vänligen kontakta oss och få din.

Detaljer om dessa nycklar finns nedan.

Kontonyckel: Detta är nyckeln som tilldelas ditt konto av PostDICOM. Det är unikt och det skapas när du registrerar dig på PostDICOM och det ändras inte i tid.

APIKey: Detta är nyckeln som tilldelas ditt konto när det är auktoriserat att använda PostDICOM Cloud API-funktioner. Det rekommenderas att ändra den här nyckeln regelbundet med sidan ”API-inställningar”. En exempelskärmdump ges nedan.

Cloud API Settings

Vilka funktioner stöds av PostDICOM Cloud API? Hur kan jag använda den?

PostDICOM Cloud API tillhandahålls som ett Javascript-bibliotek och är utformat på ett sätt som ger alla de funktioner som behövs av medicinska företag. Det handlar om att ladda upp DICOM-filer, skapa mappar, söka, visa och ta bort patientbeställningar. Funktioner som stöds och deras användning förklaras i följande stycken.

Om ditt företag behöver en annan funktion som inte finns listad nedan, vänligen kontakta oss. Vi kan gå igenom begäran och kan tillhandahålla funktionen.

Javascript
PostDICOM Cloud API Javascript-bibliotek

PostDICOM Cloud API-funktioner tillhandahålls via ett javascript-bibliotek. Det här biblioteket kan laddas ner från länken PostDicomCloudApi.js nedan. Lägg till den här adressen i avsnittet ”huvud” på din HTML-sida. Exempel på användning är som följer.

<script src="https://www.postdicom.com/cloud-api/PostDicomCloudApi.min.v10.9.js" type="text/javascript"></script>

Funktioner som stöds av PostDICOM Cloud API

InitializationInitiering

Om du vill använda PostDICOM Cloud API-tjänsten anropar du först ”PostdicomCloudAPI” -metoden med din APIKey och AccountKey. På så sätt skapar du ett objekt. Provanvändningen är nedan.

var myApi = new postDicomCloudApi(apiKey, accountKey);
Required Parameters Description
apiKey It is used to authenticate the request. Provide your apiKey to the method.
accountKey It is used to authenticate the request. Provide your accountKey to the method.

När objektet har skapats, anropa dess ”Initialize” -metod. Den här metoden kontrollerar din kontonyckel med APIKey och anropar återanropsmetoden när den är klar. Resultaten är i JSON-format, och de kan visas i callback-metoden. Exempel på användning ges nedan.

myApi.Initialize(callback);
Required Parameters Data Type Description
callback function Callback method.
Read Files
Läsa DICOM-filer och få patient- och studieinformation

PostDICOM Cloud API tillhandahåller ReaddicomFiles för att läsa DICOM-filer och returnera patient- och studieinformation till den som ringer. På så sätt kan användare bearbeta DICOM-filer och visa patient- och studiedata i sina användargränssnitt. Exempel på användning ges nedan.

myApi.ReadDicomFiles(selectedFiles, callback);
Required Parameters Data Type Description
selectedFiles file list Select files from your user interface and pass them to this method.
callback function Callback method.

UploadingLadda upp DICOM-bilder

För att ladda upp DICOM-filer tillhandahåller vi fyra olika metoder. Under alla dessa metoder anropas callback-metoden vid uppladdning för att tillhandahålla uppladdningsförlopp och överföra slutförda händelser. Endast filer i DICOM-format kan laddas upp. Metoder och deras parametrar anges nedan.

myApi.UploadDicomFiles(userUuid, institutionUuid, selectedFiles, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
institutionUuid string Provide the institution unique id which is returned from the Initialize method.
selectedFiles file list Select files from your user interface and pass them to this method.
callback function Callback method.
myApi.UploadDicomFilesIntoFolder(userUuid, institutionUuid, folderUuid, selectedFiles, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
institutionUuid string Provide the institution unique id which is returned from the Initialize method.
folderUuid string Provide the folder unique id which is returned from the GetFolderList method.
selectedFiles file list Select files from your user interface and pass them to this method.
callback function Callback method.
myApi.UploadDicomFilesWithAnonymization(userUuid, institutionUuid, selectedFiles, anonymizedData, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
institutionUuid string Provide the institution unique id which is returned from the Initialize method.
selectedFiles file list Select files from your user interface and pass them to this method.
anonymizedData DicomTagsEnum value list This is the anonymization data which will be used to change DICOM file tags.
Example usage:
anonymousData = [];
anonymousData.push({ Tag: myApi.DicomTagsEnum.PatientName, Value: 'John Doe' });
anonymousData.push({ Tag: myApi.DicomTagsEnum.PatientId, Value: '123' });
callback function Callback method.
myApi.UploadDicomFilesIntoFolderWithAnonymization(userUuid, institutionUuid, folderUuid, selectedFiles, anonymizedData, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
institutionUuid string Provide the institution unique id which is returned from the Initialize method.
folderUuid string Provide the folder unique id which is returned from the GetFolderList method.
selectedFiles file list Select files from your user interface and pass them to this method.
anonymizedData DicomTagsEnum value list This is the anonymization data which will be used to change DICOM file tags.
Example usage:
anonymousData = [];
anonymousData.push({ Tag: myApi.DicomTagsEnum.PatientName, Value: 'John Doe' });
anonymousData.push({ Tag: myApi.DicomTagsEnum.PatientId, Value: '123' });
callback function Callback method.

UploadingLadda upp kliniska dokument

För att ladda upp kliniska dokument tillhandahåller vi följande metoder. Under uppladdningen anropas callback-metoden för att tillhandahålla uppladdningsförlopp och överföra slutförda händelser. Endast filer i PDF, JPEG, JPG, PNG, BMP och MP4-format kan laddas upp. Metod och dess parametrar anges nedan.

myApi.UploadDocumentFiles(userUuid, institutionUuid, patientOrderUuid, selectedFiles, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
institutionUuid string Provide the institution unique id which is returned from the Initialize method.
patientOrderUuid string Patient order unique id which is returned from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
selectedFiles file list Select files from your user interface and pass them to this method (.pdf, .jpeg, .jpg, .png, .bmp, .mp4).
callback function Callback method.

Search OrdersSöka efter patientbeställningar

Med PostDICOM Cloud API kan du söka patientorder i ditt konto med olika parametrar. Vi tillhandahåller tre olika metoder för sökning. Dessa metoder och deras användning anges nedan.

myApi.GetPatientOrderList(callback, userUuid, institutionUuidList, patientName, accessionNumber, patientId, otherPatientId, modalities);
Required Parameters Data Type Description
callback function Callback method.
userUuid string Provide the user unique id which is returned from the Initialize method.
institutionUuidList string array Provide the institution unique id list. Institution unique ids can be obtained from Initialize method. This is an optional parameter and can be given as empty array.
patientName string Patient name to search for. This is an optional parameter and can be given as empty string.
accessionNumber string Accession number to search for. This is an optional parameter and can be given as empty string.
patientId string Patient ID to search for. This is an optional parameter and can be given as empty string.
otherPatientId string Other patient ids to search for. This is an optional parameter and can be given as empty string.
modalities string array Modalities to search for. This is an optional parameter and can be given as empty array.
myApi.GetPatientOrderListWithDateRange(callback, userUuid, institutionUuidList, patientName, accessionNumber, patientId, otherPatientId, modalities, startDate, endDate);
Required Parameters Data Type Description
callback function Callback method.
userUuid string Provide the user unique id which is returned from the Initialize method.
institutionUuidList string array Provide the institution unique id list. Institution unique ids can be obtained from Initialize method. This is an optional parameter and can be given as empty array.
patientName string Patient name to search for. This is an optional parameter and can be given as empty string.
accessionNumber string Accession number to search for. This is an optional parameter and can be given as empty string.
patientId string Patient ID to search for. This is an optional parameter and can be given as empty string.
otherPatientId string Other patient ids to search for. This is an optional parameter and can be given as empty string.
modalities string array Modalities to search for. This is an optional parameter and can be given as empty array.
startDate date Start date to search for. This is an optional parameter and can be given as empty.
endDate date End date to search for. This is an optional parameter and can be given as empty.
myApi.GetPatientOrderListWithBirthdate(callback, userUuid, institutionUuidList, patientName, accessionNumber, patientId, otherPatientId, modalities, startBirthdate, endBirthdate);
Required Parameters Data Type Description
callback function Callback method.
userUuid string Provide the user unique id which is returned from the Initialize method.
institutionUuidList string array Provide the institution unique id list. Institution unique ids can be obtained from Initialize method. This is an optional parameter and can be given as empty array.
patientName string Patient name to search for. This is an optional parameter and can be given as empty string.
accessionNumber string Accession number to search for. This is an optional parameter and can be given as empty string.
patientId string Patient ID to search for. This is an optional parameter and can be given as empty string.
otherPatientId string Other patient ids to search for. This is an optional parameter and can be given as empty string.
modalities string array Modalities to search for. This is an optional parameter and can be given as empty array.
startBirthdate date Start Birthdate to search for. This is an optional parameter and can be given as empty.
endBirthdate date End Birthdate to search for. This is an optional parameter and can be given as empty.
myApi.GetPatientOrderListInFolder(callback, userUuid, folderUuid);
Required Parameters Data Type Description
callback function Callback method.
userUuid string Provide the user unique id which is returned from the Initialize method.
folderUuid string Provide the folder unique id which is returned from the GetFolderList method.

Create Patient OrderSkapa patientordning

För att skapa patientbeställningar tillhandahåller vi två olika metoder. I alla dessa metoder anropas callback-metoden när den är klar för att tillhandahålla slutförda händelser. Metoder och deras parametrar anges nedan.

myApi.CreateOrderWithMinimumParameters(userUuid, institutionUuid, patientName, patientId, modality, studyDescription, orderDate, orderTime, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
institutionUuid string Provide the institution unique id which is returned from the Initialize method.
patientName string Patient name to create for. You can send the patient name in “LAST NAME^FIRST NAME^MIDDLE NAME” format.
That way, we can use the location of ‘^’ character and split first name, middle name and last name.
patientId string Patient ID to create for.
modality string Modality to create for.
studyDescription string Study description to create for. This is an optional parameter and can be given as empty string.
orderDate string (YYYY-MM-DD) Order date to create for.
orderTime string (HH:MM) Order time to create for. This is an optional parameter and can be given as empty string.
callback function Callback method.
myApi.CreateOrderWithFullParameters(userUuid, institutionUuid, patientName, patientId, patientOtherId, patientBirthdate, modality, studyDescription, accessionNumber, complaints, orderDate, orderTime, procedureId, procedureDescription, scheduledEquipmentUuid, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
institutionUuid string Provide the institution unique id which is returned from the Initialize method.
patientName string Patient name to create for. You can send the patient name in “LAST NAME^FIRST NAME^MIDDLE NAME” format.
That way, we can use the location of ‘^’ character and split first name, middle name and last name.
patientId string Patient ID to create for.
patientOtherId string Patient Other ID to create for. This is an optional parameter and can be given as empty string.
patientBirthdate string (YYYY-MM-DD) Patient birth date to create for.
modality string Modality to create for.
studyDescription string Study description to create for. This is an optional parameter and can be given as empty string.
accessionNumber string Accession number to create for. This is an optional parameter and can be given as empty string.
complaints string Complaints to create for. This is an optional parameter and can be given as empty string.
orderDate string (YYYY-MM-DD) Order date to create for.
orderTime string (HH:MM) Order time to create for. This is an optional parameter and can be given as empty string.
procedureId string Procedure ID to create for. This is an optional parameter and can be given as empty string.
procedureDescription string Procedure description to create for. This is an optional parameter and can be given as empty string.
scheduledEquipmentUuid string Scheduled Equipment can be set by this parameter. Equipment unique ids can be obtained from GetDicomNodeList method. This is an optional parameter and can be given as empty array.
callback function Callback method.
myApi.CreateOrderWithFullParameters2(userUuid, institutionUuid, patientName, patientId, patientOtherId, patientSex, patientBirthdate, modality, studyDescription, accessionNumber, complaints, orderDate, orderTime, procedureId, procedureDescription, scheduledEquipmentUuid, referringPhysiciansName, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
institutionUuid string Provide the institution unique id which is returned from the Initialize method.
patientName string Patient name to create for. You can send the patient name in “LAST NAME^FIRST NAME^MIDDLE NAME” format.
That way, we can use the location of ‘^’ character and split first name, middle name and last name.
patientId string Patient ID to create for.
patientOtherId string Patient Other ID to create for. This is an optional parameter and can be given as empty string.
patientSex string Patient Sex to create for. This is an optional parameter and can be given "M","F","O" or empty string.
patientBirthdate string (YYYY-MM-DD) Patient birth date to create for.
modality string Modality to create for.
studyDescription string Study description to create for. This is an optional parameter and can be given as empty string.
accessionNumber string Accession number to create for. This is an optional parameter and can be given as empty string.
complaints string Complaints to create for. This is an optional parameter and can be given as empty string.
orderDate string (YYYY-MM-DD) Order date to create for.
orderTime string (HH:MM) Order time to create for. This is an optional parameter and can be given as empty string.
procedureId string Procedure ID to create for. This is an optional parameter and can be given as empty string.
procedureDescription string Procedure description to create for. This is an optional parameter and can be given as empty string.
scheduledEquipmentUuid string Scheduled Equipment can be set by this parameter. Equipment unique ids can be obtained from GetDicomNodeList method. This is an optional parameter and can be given as empty array.
referringPhysiciansName string Referring Physicians Name to create for. This is an optional parameter and can be given as empty string.
callback function Callback method.
myApi.CreateOrderWithJSON(userUuid, institutionUuid, jsonParameters, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
institutionUuid string Provide the institution unique id which is returned from the Initialize method.
jsonParameters JSON You can create Patient Orders by setting the jsonParameters below.
You can only send the necessary JSON parameters to create the order.

{
OtherPatientId: 'Patient Other ID to create for.', //Format: string
PatientName: 'Patient Name to create for.', //Format: string
OrderModality: 'Modality to create for.', //Format: string
OrderAccessionNumber: 'Accession Number to create for.', //Format: string(lenght: 1-16) , Example: 'AN-12345'
PatientsBirthDate: 'Patient birth date to create for.', //Format: string(YYYY-MM-DD), Example: '2000-01-01'
PatientID: 'Patient ID to create for.', //Format: string
Priority: 'Priority flag to create for.', //Format: string
PatientHistory: 'Patient History to create for.', //Format: string
PatientComplaints: 'Patient Complaints to create for.', //Format: string
PatientSymptom: 'Patient Symptom to create for.', //Format: string
RequestingPhysician: 'Requesting Physician to create for.', //Format: string
RequestingDepartment: 'Requesting Department to create for.', //Format: string
RequestingProcedureDescription: 'Requesting Procedure Description to create for.', //Format: string
PerformedDatetime: 'Order datetime to create for.', //Format: string(YYYY-MM-DD HH:MM), Example: '2000-01-01 16:00'
OrderNote1: 'Order Note1 to create for.', //Format: string
OrderNote2: 'Order Note2 to create for.', //Format: string
ReferringPhysiciansName: 'Referring Physicians Name to create for.', //Format: string
StudyDescription: 'Study Description to create for.', //Format: string
RequestedProcedureId: 'Requested Procedure Id to create for.', //Format: string
ScheduledEquipmentUuid: 'Scheduled Equipment Uuid to create for.', //Format: string(GUID), Example: '00000000-0000-0000-0000-000000000000'
PatientSex: 'Patient Sex to create for. This is an optional parameter and can be given "M","F","O" or empty string.' //Format: string(lenght: 1), Example: 'O'
}
callback function Callback method.

Create and Delete FolderSkapa och ta bort mapp

Mappar kan skapas med metoden createFolder. Exempel på användning ges nedan. När API-anropet är klart anropas callback-metoden.

myApi.CreateFolder(userUuid, parentFolderUuid, folderName, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
parentFolderUuid string Parent folder unique id in which the new folder will be created. If this parameter is empty, folder is created at the root folder.
folderName string Name of the folder. Subfolders can be created by proving the folder names separated by '/' character. For example when "folderA/folderB" is passed to the method, folderA will be created and then folderB will be created in folderA.
callback function Callback method.

Mappar kan skapas med metoden createFolder. Exempel på användning ges nedan. När API-anropet är klart anropas callback-metoden.

myApi.CreateFolderWithDescription(userUuid, parentFolderUuid, folderName, folderDescription, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
parentFolderUuid string Parent folder unique id in which the new folder will be created. If this parameter is empty, folder is created at the root folder.
folderName string Name of the folder. Subfolders can be created by proving the folder names separated by '/' character. For example when "folderA/folderB" is passed to the method, folderA will be created and then folderB will be created in folderA.
folderDescription string Description of the folder.
callback function Callback method.

Mappar kan tas bort med metoden DeleteFolder. Exempel på användning ges nedan. När API-anropet är klart anropas callback-metoden.

myApi.DeleteFolder(userUuid, folderUuid, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
folderUuid string Folder unique id in which the folder will be deleted.
callback function Callback method.

Search FolderSöka efter mappar

Mappar kan söka med metoden GetFolderList. Exempel på användning ges nedan. När API-anropet är klart anropas callback-metoden.

myApi.GetFolderList(userUuid, parentFolderUuid, folderName, getOrdersInFolder, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
parentFolderUuid string Parent folder unique id in which the new folder will be searched. If this parameter is empty, root folders in the root folder are searched.
folderName string Name of the folder to be searched for. If this parameter is empty, all of the folders in the parent folder are returned.
getOrdersInFolder bool If this parameter is true, orders in that folder will be returned within the result.
callback function Callback method.
View
Hämta en åtkomstlänk för att visa mappar

Du kan skapa åtkomstlänkar för dina mapp i ditt konto. Efter att ha fått tittarlänken öppnar du den i din applikation eller via en webbläsare som Google Chrome, Mozilla Firefox, Apple Safari etc. Av säkerhetsskäl måste IP-adresserna för länkförfrågan och betraktaren vara desamma. Om du anger ditt domännamn kan vi dessutom skapa visningslänkar endast för förfrågningar som kommer från din domän.

myApi.GetFolderViewUrl(userUuid, folderUuid, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
folderUuid string Provide the folder unique id which is returned from the GetFolderList method.
callback function Callback method.
View
Hämta en åtkomstlänk för att visa order

Du kan skapa åtkomstlänkar för dina beställningar i ditt konto. Efter att ha fått tittarlänken öppnar du den i din applikation eller via en webbläsare som Google Chrome, Mozilla Firefox, Apple Safari etc. Av säkerhetsskäl måste IP-adresserna för länkförfrågan och betraktaren vara desamma. Om du anger ditt domännamn kan vi dessutom skapa visningslänkar endast för förfrågningar som kommer från din domän.

myApi.GetViewUrl(userUuid, patientOrderUuid, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
patientOrderUuid string Patient order unique id which is returned from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
callback function Callback method.
Deleting Orders
Flytta order till papperskorgen

Du kan flytta patientorder till papperskorgen med metoden DeleteOrder. Dess användning och parametrar anges nedan.

myApi.DeleteOrder(userUuid, patientOrderInstitutionUuid, patientOrderUuid, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
patientOrderInstitutionUuid string Patient order institution unique id which is returned from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
patientOrderUuid string Patient order unique id which is returned from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
callback function Callback method.
Dicom Nodes
Hämta dicom-noder lista

Du kan hämta DICOM-noder med hjälp av metoden GetDiComnoDelist. När du anropas returneras alla DICOM-noder som användaren kan se.

myApi.GetDicomNodeList(userUuid, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
callback function Callback method.
Add Patient Order to Folders - Remove Patient Orders From Folder
Lägg till patientordning i mappar - Ta bort patientorder från mapp

Patientordning kan läggas till i befintliga mappar med metoden addOrderToFolder. Exempel på användning ges nedan. När API-anropet är klart anropas callback-metoden.

myApi.AddOrderToFolder(userUuid, patientOrderInstitutionUuid, patientOrderUuid, folderUuidList, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
patientOrderInstitutionUuid string Patient order institution unique id which is returned from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
patientOrderUuid string Patient order unique id which is returned from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
folderUuidList string array Provide the folder unique id list. Folder unique ids can be obtained from GetFolderList method.
callback function Callback method.

Patientorder kan tas bort från mappen med hjälp av metoden RemoveOrderFromFolder. Exempel på användning ges nedan. När API-anropet är klart anropas callback-metoden.

myApi.RemoveOrderFromFolder(userUuid, folderUuid, patientOrderUuidList, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
folderUuid string Provide the folder unique id list. Folder unique ids can be obtained from GetFolderList method.
patientOrderUuidList string array Patient order unique id which is returned from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
callback function Callback method.
Patient Order linking processes to opening together
Patientordning som länkar processer till att öppna tillsammans

Funktioner som kan användas för att gruppera patientorder åtgärder skapa en ny patientordergrupp, lägga till patientordning i en befintlig grupp och ta bort patientordning från gruppen. Alla dessa metoder och deras parametrar ges nedan.

myApi.CreateOrderGroup(userUuid, patientOrderInstitutionUuid, patientOrderUuidList, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
patientOrderInstitutionUuid string Patient order institution unique id which is returned from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
patientOrderUuidList string array Patient order unique id list. Patient order unique ids can be obtained from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
callback function Callback method.
myApi.AddOrdersToOrderGroup(userUuid, patientOrderInstitutionUuid, connectedGroupUuid, patientOrderUuidList, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
patientOrderInstitutionUuid string Patient order institution unique id which is returned from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
connectedGroupUuid string Patient order connected group unique id which is returned from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
patientOrderUuidList string array Patient order unique id list. Patient order unique ids can be obtained from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
callback function Callback method.
myApi.RemoveOrdersFromGroup(userUuid, patientOrderInstitutionUuid, patientOrderUuidList, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
patientOrderInstitutionUuid string Patient order institution unique id which is returned from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
patientOrderUuidList string array Patient order unique id list. Patient order unique ids can be obtained from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
callback function Callback method.
Patient Order Properties
Egenskaper för patientordning

Du kan få detaljerade patientorderegenskaper med metoden GetPatientOrderProperties. När den anropas returneras alla egenskaper hos patientordningen.

myApi.GetPatientOrderProperties(userUuid, patientOrderInstitutionUuid, patientOrderUuid, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
patientOrderInstitutionUuid string Patient order institution unique id which is returned from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
patientOrderUuid string Patient order unique id which is returned from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
callback function Callback method.
Assign Patient Order to User
Tilldela patientorder till användare

Du kan tilldela patientordern till den begränsade åtkomstanvändaren så att användaren kan se patientordern.

myApi.AssignPatientOrderToUser(userUuid, patientOrderUuid, assignedUserUuid, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
patientOrderUuid string Patient order unique id which is returned from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
assignedUserUuid string Provide the user unique id which is returned from the Initialize method.
callback function Callback method.
Unassign Patient Order to User
Ta bort patientordern till användaren

Du kan ta bort patientordern från den tilldelade användaren med begränsad åtkomst så att användaren inte kan se patientordern.

myApi.UnassignPatientOrderFromUser(userUuid, patientOrderUuid, unassignedUserUuid, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
patientOrderUuid string Patient order unique id which is returned from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
unassignedUserUuid string Provide the user unique id which is returned from the Initialize method.
callback function Callback method.
Assign Patient Order to User Group
Tilldela patientorder till användargrupp

Du kan tilldela patientordern till den begränsade åtkomstgruppen så att användare i gruppen kan se patientordern.

myApi.AssignPatientOrderToUserGroup(userUuid, patientOrderUuid, assignedUserGroupUuid, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
patientOrderUuid string Patient order unique id which is returned from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
assignedUserGroupUuid string Provide the user group unique id which is returned from the GetUserGroupList method and its parameters are given below.
callback function Callback method.
Unassign Patient Order to User Group
Ta bort patientordern till användargruppen

Du kan ta bort tilldelningen av patientordern från den tilldelade användargruppen med begränsad åtkomst så att användare i gruppen inte kan se patientordern.

myApi.UnassignPatientOrderFromUserGroup(userUuid, patientOrderUuid, unassignedUserGroupUuid, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
patientOrderUuid string Patient order unique id which is returned from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
unassignedUserGroupUuid string Provide the user group unique id which is returned from the GetUserGroupList method and its parameters are given below.
callback function Callback method.
Assign Patient Order to Location
Tilldela patientorder till plats

Du kan ändra platsen för patientordern om du har mer än en plats.

myApi.AssignPatientOrderToLocation(userUuid, patientOrderUuid, institutionUuid, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
patientOrderUuid string Patient order unique id which is returned from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
institutionUuid string Provide the institution unique id which is returned from the Initialize method.
callback function Callback method.
Set Flag To Patient Order
Ställ in flagga på patientordning

Du kan ställa in flaggan till en patientorder.

myApi.SetFlagToPatientOrder(userUuid, patientOrderUuid, flagGroupId, flagId, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
patientOrderUuid string Patient order unique id which is returned from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
flagGroupId string Provide the user group unique id which is returned from the GetAccountFlagDictionary method and its parameters are given below.
flagId string Provide the user group unique id which is returned from the GetAccountFlagDictionary method and its parameters are given below.
callback function Callback method.
Get Account Flag Dictionary
Skaffa Account Flag Dictionary
myApi.GetAccountFlagDictionary(userUuid, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
callback function Callback method.
Share Patient Order
Dela patientordning

Funktioner som kan användas för att dela patientbeställningar. Metoder och deras parametrar anges nedan.

myApi.SharePatientOrder(userUuid, orderUuidList, email, emailForSendingSharePassword, userCanDownloadStudies, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
patientOrderUuidList string array Patient order unique id list. Patient order unique ids can be obtained from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
emailAddress string Email address to which the sharing access information will be sent. If you call function with this parameter but without emailAddressForSendingSharePassword parameter, both access link and password information will be send to email address that given emailAddress.
emailAddressForSendingSharePassword string Email address to which the sharing access information will be sent. If you call function with both emailAddress and emailAddressForSendingSharePassword parameters, access link will be send emailAddress and password information will be send to emailAddressForSendingSharePassword.
userCanDownloadStudies bool With this parameter users that access patient order images via sharing information could be download images in their local computer.
callback function Callback method.
myApi.SharePatientOrderWithExpireDate(userUuid, orderUuidList, email, emailForSendingSharePassword, userCanDownloadStudies, expireDate, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
patientOrderUuidList string array Patient order unique id list. Patient order unique ids can be obtained from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
emailAddress string Email address to which the sharing access information will be sent. If you call function with this parameter but without emailAddressForSendingSharePassword parameter, both access link and password information will be send to email address that given emailAddress.
emailAddressForSendingSharePassword string Email address to which the sharing access information will be sent. If you call function with both emailAddress and emailAddressForSendingSharePassword parameters, access link will be send emailAddress and password information will be send to emailAddressForSendingSharePassword.
userCanDownloadStudies bool With this parameter users that access patient order images via sharing information could be download images in their local computer.
expireDate string (YYYY-MM-DD) The expiration date for sharing.
callback function Callback method.
myApi.CreateQuickShareLink(userUuid, orderUuidList, userCanDownloadStudies, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
patientOrderUuidList string array Patient order unique id list. Patient order unique ids can be obtained from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
userCanDownloadStudies bool With this parameter users that access patient order images via sharing information could be download images in their local computer.
callback function Callback method.
myApi.CreateQuickShareLinkWithExpireDate(userUuid, orderUuidList, userCanDownloadStudies, expireDate, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
patientOrderUuidList string array Patient order unique id list. Patient order unique ids can be obtained from the GetPatientOrderList, GetPatientOrderListWithDateRange and GetPatientOrderListInFolder methods.
userCanDownloadStudies bool With this parameter users that access patient order images via sharing information could be download images in their local computer.
expireDate string (YYYY-MM-DD) The expiration date for sharing.
callback function Callback method.
Share Folder
Dela mapp

Funktioner som kan användas för att dela mappar. Metoder och deras parametrar anges nedan.

myApi.ShareFolderWithEmail(userUuid, folderUuid, emailAddress, emailAddressForSendingSharePassword, sharePassword, shareTitle, shareDescription, expireDate, userCanDownloadStudies, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
folderUuid string Provide the folder unique id list. Folder unique ids can be obtained from GetFolderList method.
emailAddress string Email address to which the sharing access information will be sent. If you call function with this parameter but without emailAddressForSendingSharePassword parameter, both access link and password information will be send to email address that given emailAddress.
emailAddressForSendingSharePassword string Email address to which the sharing access information will be sent. If you call function with both emailAddress and emailAddressForSendingSharePassword parameters, access link will be send emailAddress and password information will be send to emailAddressForSendingSharePassword.
sharePassword string Password is used by recipients of the link to gain access.
shareTitle string Title information for sharing.
shareDescription string Description for sharing.
expireDate string (YYYY-MM-DD) The expiration date for sharing.
userCanDownloadStudies bool With this parameter users that access patient order images via sharing information could be download images in their local computer.
callback function Callback method.
myApi.ShareFolderWithURL(userUuid, folderUuid, sharePassword, shareTitle, shareDescription, expireDate, userCanDownloadStudies, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
folderUuid string Provide the folder unique id list. Folder unique ids can be obtained from GetFolderList method.
sharePassword string Password is used by recipients of the link to gain access.
shareTitle string Title information for sharing.
shareDescription string Description for sharing.
expireDate string (YYYY-MM-DD) The expiration date for sharing.
userCanDownloadStudies bool With this parameter users that access patient order images via sharing information could be download images in their local computer.
callback function Callback method.
myApi.ShareFolderToUploadWithEmail(userUuid, folderUuid, emailAddress, emailAddressForSendingSharePassword, sharePassword, shareTitle, shareDescription, expireDate, userCanDownloadStudies, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
folderUuid string Provide the folder unique id list. Folder unique ids can be obtained from GetFolderList method.
emailAddress string Email address to which the sharing access information will be sent. If you call function with this parameter but without emailAddressForSendingSharePassword parameter, both access link and password information will be send to email address that given emailAddress.
emailAddressForSendingSharePassword string Email address to which the sharing access information will be sent. If you call function with both emailAddress and emailAddressForSendingSharePassword parameters, access link will be send emailAddress and password information will be send to emailAddressForSendingSharePassword.
sharePassword string Password is used by recipients of the link to gain access.
shareTitle string Title information for sharing.
shareDescription string Description for sharing.
expireDate string (YYYY-MM-DD) The expiration date for sharing.
userCanDownloadStudies bool With this parameter users that access patient order images via sharing information could be download images in their local computer.
callback function Callback method.
myApi.ShareFolderToUploadWithUrl(userUuid, folderUuid, sharePassword, shareTitle, shareDescription, expireDate, userCanDownloadStudies, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
folderUuid string Provide the folder unique id list. Folder unique ids can be obtained from GetFolderList method.
sharePassword string Password is used by recipients of the link to gain access.
shareTitle string Title information for sharing.
shareDescription string Description for sharing.
expireDate string (YYYY-MM-DD) The expiration date for sharing.
userCanDownloadStudies bool With this parameter users that access patient order images via sharing information could be download images in their local computer.
callback function Callback method.
myApi.ShareFolderWithAccountUser(userUuid, folderUuid, sharedUserUuidList, expireDate, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
folderUuid string Provide the folder unique id list. Folder unique ids can be obtained from GetFolderList method.
sharedUserUuidList string array Provide the user unique id which is returned from the Initialize method.
expireDate string (YYYY-MM-DD) The expiration date for sharing.
userCanDownloadStudies bool With this parameter users that access patient order images via sharing information could be download images in their local computer.
callback function Callback method.
myApi.ShareFolderWithAccountUserGroup(userUuid, folderUuid, sharedUserGroupUuidList, expireDate, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
folderUuid string Provide the folder unique id list. Folder unique ids can be obtained from GetFolderList method.
sharedUserGroupUuidList string array Provide the user group unique id which is returned from the GetUserGroupList method and its parameters are given below.
expireDate string (YYYY-MM-DD) The expiration date for sharing.
userCanDownloadStudies bool With this parameter users that access patient order images via sharing information could be download images in their local computer.
callback function Callback method.
myApi.GetUserGroupList(userUuid, callback);
Required Parameters Data Type Description
userUuid string Provide the user unique id which is returned from the Initialize method.
callback function Callback method.