3. Abfrage Auftrag Status
Per GET-Request können die Auftragsdokumente über die codierten Links herunter geladen werden.
Endpunkt Beschreibung
Methode: GET
Endpunkt: {base}/api/v3/orders/{orderId}/state
| Parameter | Beschreibung |
|---|---|
orderId |
Die Id des gewünschten Auftrags |
Request Body — Anfrage zum Server
nicht existend, da HTTP GET Request.
200er Response — Antwort vom Server
{
"Items": [ // optional, Die Elemente der Antwort auf die Status-Anfrage eines Auftrages
{
"CurrentStatus": "Unknown", // optional, Der aktuelle Status des Auftrags, Enum: 'Unknown', 'New', 'Open', 'Approved', 'Sent', 'Done', 'Cancelled', 'Archived'
"OrderId": "string", // optional, Die Id des Auftrags
"LaboratoryOrders": [ // optional, Die Laboraufträge des Auftrags
{
"Documents": [ // optional, Die druckbaren Dokumente zu dem Laborauftrag
{
"DownloadUrl": "string", // optional, Die Url, unter der das Dokument heruntergeladen werden kann.
"DocumentType": "Unknown" // optional, Der Dokumenttyp des Dokuments, Enum: 'Unknown', 'OrderForm', 'Label', 'OrderLabel', 'CumulativReport', 'AdditionalDocument', 'AdditionalLabel', 'ShippingList', 'Offer', 'PatientUserDocument', 'ZPasLabel', 'CancellationDocument', 'ListLabelPrinterDefinitionFile'
}
],
"NotificationReason": "Unknown", // optional, Enum: 'Unknown', 'Save', 'ApproveAndSend', 'PrintAllBeforeFinalized', 'PrintReceiptsBeforeFinalized', 'PrintLabelsBeforeFinalized', 'Cancel', 'SubsequentRequest'
"Order": { // optional,
"CreationDateTime": "2024-04-08T20:07:36.559Z", // optional,
"Diagnosis": "string", // optional,
"ExclusionNumber": "string", // optional,
"Notes": "string" // optional,
},
"OrderInfo": { // optional,
"TakingDateTime": "2024-04-08T20:07:36.559Z" // optional,
},
"Patient": { // optional,
"DateOfBirth": "string", // optional,
"ExternalId": "string", // optional,
"Firstname": "string", // optional,
"Lastname": "string", // optional,
"Gender": "Unknown" // optional, Enum: 'Unknown', 'Female', 'Male', 'Undefined', 'Diverse'
},
"Requests": [ // optional,
{
"OrdnerNo": "string", // optional,
"FormularName": "string", // optional,
"AccountType": "Unknown", // optional, Enum: 'Unknown', 'PanelPatient', 'PrivatePatient', 'OtherInvoiceRecipient', 'Sender'
"Entries": [ // optional,
{
"Id": 0, // optional,
"Ident": "string", // optional,
"Name": "string", // optional,
"Price": 0, // optional,
"MarkerPosition": "string", // optional,
"IsSubsequentRequest": true, // optional,
"NativeMaterials": [ // optional,
"string" // optional,
],
"IsPvsBilling": true, // optional,
"CancelledAt": "2024-04-08T20:07:36.559Z" // optional,
}
],
"Documents": [ // optional,
{
"Id": "string", // optional,
"Usage": "Undefined", // optional, Enum: 'Undefined', 'ForPrinting', 'ForExternal'
"Type": "Unknown", // optional, Enum: 'Unknown', 'Formular', 'Label'
"DocumentTypeId": "string", // optional,
"Data": "string" // optional,
}
],
"MibiItemShortCut": "string", // optional,
"IsMibiRequest": true, // optional,
"MibiMaterialName": "string", // optional,
"MibiLocalizationComment": "string", // optional,
"MibiLocalization": "string", // optional,
"MibiPosition": "string", // optional,
"MibiExamination": "string", // optional,
"MibiMaterialComment": "string", // optional,
"MibiRequestComment": "string", // optional,
"MibiComment": "string", // optional,
"MaterialTaking": "2024-04-08T20:07:36.559Z" // optional,
}
],
"LaboratoryOrder": { // optional,
"Id": 0, // optional,
"OrderId": 0, // optional,
"Name": "string", // optional,
"LaboratoryId": 0, // optional,
"LaboratoryName": "string", // optional,
"Error": "2024-04-08T20:07:36.559Z", // optional,
"ErrorMessage": "string", // optional,
"OrderNo": "string", // optional,
"ResultReceived": "2024-04-08T20:07:36.559Z", // optional,
"Sent": "2024-04-08T20:07:36.559Z", // optional,
"LaboratoryOrderIdOfOrderItems": 0, // optional,
"SettlementType": "Unknown", // optional, Enum: 'Unknown', 'PrivateLg', 'PrivateGoae', 'HealthInsuranceLg', 'HzvContractComplexService', 'HealthInsuranceEbm', 'CollectiveInvoice', 'IgelInPrivateLg', 'Igel', 'IgelPvs', 'MibiPanelPatient', 'MibiPrivatePatient', 'MibiSender', 'MibiOtherInvoiceRecipient', 'HealthInsuranceEbmPreventive', 'HealthInsuranceEbmPattern6', 'HealthInsuranceEbmPattern39', 'MibiIgel', 'MiBiIgelPVS'
"CollectiveInvoiceTypeId": 0, // optional,
"IsSingleRequestOrder": true, // optional,
"Freetext": "string", // optional,
"CancelledAt": "2024-04-08T20:07:36.559Z", // optional,
"CancelledBy": 0, // optional,
"ImportStatus": "NotImported", // optional, Enum: 'NotImported', 'Partial', 'Complete'
"CreatedOn": "2024-04-08T20:07:36.559Z", // optional,
"FormId": 0, // optional,
"OrderExportIdTimestamps": {}, // optional,
"ExportOrderNotificationDocumentIdTimestamps": {}, // optional,
"CancellationStoppedAt": "2024-04-08T20:07:36.559Z", // optional,
"FreetextUpdated": "2024-04-08T20:07:36.559Z", // optional,
"IsPartiallyCancelled": true, // optional,
"HasSubsequentRequest": true, // optional,
"PrintDate": "2024-04-08T20:07:36.559Z", // optional,
"ServiceLocationId": 0 // optional,
},
"OrderRequests": [ // optional,
{
"BillingInformation": "GkvLaboratorySpecialist", // optional, Enum: 'GkvLaboratorySpecialist', 'GkvCollaborativeLaboratory', 'PkvLaboratorySpecialist', 'PkvCollaborativeLaboratory', 'SelectiveContract', 'Igel', 'OtherCostTakeover', 'Asv', 'GkvLaboratorySpecialistPreventive', 'GkvCollaborativeLaboratoryPreventive', 'NoAllocation', 'Cancelled'
"FormId": 0, // optional,
"Id": 0, // optional,
"MaterialCollectionQuantity": 0, // optional,
"MaterialCollectionTime": "string", // optional,
"MaterialLabel": "string", // optional,
"MaterialSpecification": "string", // optional,
"MaterialUnit": "string", // optional,
"OrderId": 0, // optional,
"OrderMicrobiologyItemId": 0, // optional,
"RequestExternalIdent": "string", // optional,
"RequestId": 0, // optional,
"RequestIdent": "string", // optional,
"RequestUniversalIdent": "string", // optional,
"RequestName": "string", // optional,
"RequestPrice": 0, // optional,
"SubsequentRequest": "2024-04-08T20:07:36.559Z", // optional,
"Taking": "2024-04-08T20:07:36.559Z", // optional,
"LaboratoryOrderId": 0, // optional,
"ShouldBeIgeled": true, // optional,
"NativeMaterials": [ // optional,
"string"
],
"CancelledAt": "2024-04-08T20:07:36.559Z", // optional,
"CancelledBy": 0, // optional,
"ImportedAt": "2024-04-08T20:07:36.559Z", // optional,
"SortOrder": 0, // optional,
"RequestPrintName": "string", // optional,
"IsPvsBilling": true, // optional,
"CancellationStoppedAt": "2024-04-08T20:07:36.559Z", // optional,
"GroupName": "string", // optional,
"MessageInfos": [ // optional,
{
"Type": "Info", // optional, Enum: 'Info', 'Warning', 'Error'
"Identifier": "string", // optional,
"Content": "string", // optional,
"OrderRequestId": 0 // optional,
}
],
"BlockId": 0 // optional,
}
],
"Attachments": [ // optional,
{
"Name": "string", // optional,
"Data": "string" // optional,
}
],
"InvestigationType": "string" // optional,
}
]
}
]
}
Platzhalter für Silke
weitere mögliche Antworten
400 Die Anfrage war nicht korrekt
fehlende information
401 Es wurde kein Token zur Authentifizierung übergeben
fehlende information
404 Der Auftrag wurde nicht gefunden
fehlende information
409 Der Auftrag befindet sich im falschen Status
fehlende information
660 Fehler beim Ausdruck der Auftragsdokumente
fehlende information