4. Auftrag abschließen
Nachdem der Auftrag im richtigen status ist können sie Per POST-Request den Auftrage abschließen.
Endpunkt Beschreibung
Methode: POST
Endpunkt: {base}/api/v3/orders/approve?orderId={orderId}
| Parameter | Beschreibung |
|---|---|
orderId |
Die Id des gewünschten Auftrags |
Request Body — Anfrage zum Server
nicht existend
200er Response — Antwort vom Server
{
"IsHpmConnectConfigured": true, // Gibt an, ob HPM konfiguriert ist
"InitialTypeOfTreatment": "Unknown", // Die initiale Behandlungsart, Enum: 'Unknown', 'Curative', 'Preventive', 'Abortion', 'EvidenceMedicalTreatment'
"ExistingOrderForHint": { // optional, Gibt einen bestehenden Auftrag zurück, wenn dem Einsender ein Hinweis zu einem bestehenden Auftrag bei der Erstellung neuer Aufträge angezeigt werden soll; oder legt diesen fest
"Id": 0, // optional, Gibt die eindeutige Kennung zurück oder legt diese fest
"Created": "2024-04-10T06:21:10.454Z", // optional, Gibt das Erstelldatum zurück oder legt dieses fest
"TypeOfAccountFriendlyName": "string", // optional, Gibt die Art der Abrechnung als Text zurück oder legt diese fest
"InsuranceName": "string", // optional, Gibt den Namen der Krankenkasse zurück oder legt diesen fest
"RequestNames": "string" // optional, Gibt die Namen der zugewiesenen Anforderungen komma-separiert zurück oder legt diese fest
},
"RemovedFormNames": [ // optional, Gibt eine Auflistung der Namen aller Formulare an, die nicht mehr zur Verfügung stehen, oder legt diese fest
"string"
],
"Id": 0, // optional, Die Auftrags-ID
"OrderGuid": "string", // optional, Die Auftrags-GUID
"Patient": { // optional, Angaben zum Patienten
"Id": 0, // optional, Die ID
"Gender": "Unknown", // optional, Enum: 'Unknown', 'Female', 'Male', 'Undefined', 'Diverse'
"Title": "string", // optional, Der Titel
"AdditionalName": "string", // optional, Der Namenszusatz
"PreWord": "string", // optional, Das Vorsatzwort
"Firstname": "string", // optional,
"Lastname": "string", // optional,
"IsHzvPatient": true, // optional, Gibt an, ob der Patient an HzV teilnimmt
"DateOfBirth": "string", // optional,
"DateOfBirthIsUnknown": true, // optional, Gibt an, ob das Geburtsdatum unbekannt ist
"Email": "string", // optional, Die Emailadresse
"PhoneNumber": "string", // optional, Die Telefonnummer
"Age": 0, // optional, read only??? siehe swagger, Das Alter
"Address": { // optional,
"Street": "string", // optional,
"Number": "string", // optional,
"CountryCode": "string", // optional,
"Zip": "string", // optional,
"City": "string" // optional,
},
"PostBox": { // optional,
"Number": "string", // optional, Die Nummer des Postfachs
"CountryCode": "string", // optional,
"Zip": "string", // optional,
"City": "string" // optional, Die Stadt
}
},
"CorrectionMessages": [ // optional, Gibt eine Liste von Korrekturmeldungen zurück; oder legt diese fest
"string"
],
"CommonMessages": [ // optional, Gibt Meldungen zurück oder legt diese fest
{
"Content": "string", // optional,
"State": "Warning", // optional, Enum: 'Warning', 'Error'
"Type": "KbvRestrictedEntitlement" // optional, Enum: 'KbvRestrictedEntitlement', 'KbvZip', 'InsuranceIdent'
}
],
"Errors": [ // optional, Gibt Fehler je Feld zurück
{
"Field": "string", // optional, Feldbezeichung
"Errors": [ // optional, Liste von Fehlermeldungen
"string"
]
}
],
"SelectedRequests": [ // optional, Die ausgewählten Anforderungen
{
"FormId": 0, //
"BlockId": 0, // optional,
"RequestId": 0, //
"ManuallyIGeLed": true, // optional, Gibt an, ob die Anforderung manuell geigelt wurde
"NativeMaterials": [ // optional,
"string"
]
}
],
"ManuallyDeletedSettlementTypes": [ // optional, Manuell gelöschte Abrechnungsarten
"Unknown"
],
"AdditionalMaterials": [ // optional, Gibt die Anzahl der zusätzlichen Materialien je Formular zurück oder legt diese fest
{
"OrderGenerationGroup": { // optional, Die Auftragsgenerierungsgruppe
"DisplayName": "string", // optional,
"FormId": 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,
"LaboratoryId": 0, // optional,
"OrderId": 0 // optional,
},
"MaterialId": 0, // Die Material-ID
"Quantity": 0 // Die Anzahl zusätzlicher Gefäße zum Material
}
],
"ManuallyDeletedCollectiveInvoiceTypes": [ // optional, Manuell gelöschte Sammelrechnungsarten
0
],
"Freetexts": [ // optional, Gibt eine Liste der Formular-IDs und ihrer zugeordneten Freitexte zurück oder legt diese fest
{
"FormId": 0, //
"Freetext": "string" // optional,
}
],
"CurrentStatus": "Unknown", // Der aktuelle Auftragsstatus, Enum: 'Unknown', 'New', 'Open', 'Approved', 'Sent', 'Done', 'Cancelled', 'Archived'
"OrderUsesManualHzvCheck": true, // Gibt an, ob der Auftrag die manuelle HzV-Auswahl angewählt hat
"IsValid": true, // optional, Gibt an, ob der Auftrag valide ist
"TypeOfAccount": "Unknown", // Der Abrechnungstyp, Enum: 'Unknown', 'PanelPatient', 'PrivatePatient', 'OtherInvoiceRecipient', 'Sender'
"FeeRegulations": "Unknown", // optional, Die Gebührenordnung, Enum: 'Unknown', 'EBM', 'BMAE', 'EGO', 'GOAE', 'BG', 'HZV'
"Insurance": { // optional, Die Daten der Versicherung
"Name": "string", // optional,
"PrintName": "string",
"Ident": "string", // optional,
"ProviderSettlementSection": "Unknown", // Enum: 'Unknown', 'Primary', 'SVA', 'BVG', 'BEG', 'GG', 'RHS', 'SHT', 'BVFG', 'AS', 'Abortions'
"ProviderSettlementArea": "KBA", // Das Abrechnungsgebiet, Enum: 'KBA', 'DA', 'DS', 'MS', 'PENDEK', 'SNDEK', 'FZ', 'D', 'U', 'R', 'H', 'AO', 'AOP', 'WBAP'
"LastReadDateOfInsuranceCard": "2024-04-10T06:21:10.454Z", // optional,
"InsuranceStart": "2024-04-10T06:21:10.454Z", // optional,
"InsuranceEnd": "2024-04-10T06:21:10.454Z", // optional,
"Vknr": "string", // optional,
"ValidUntil": "2024-04-10T06:21:10.454Z", // optional,
"FeeRegulations": 0 //
},
"InsurantNumber": "string", // optional, Die Versichertennummer
"InsurantIdent": "string", // optional, Das Versichertenident
"BillingVknr": "string", // optional, Die Abrechnungs-VKNR
"KindOfInsurance": "Unknown", // Der Versichertenstatus, Enum: 'Unknown', 'Member', 'FamilyInsurance', 'Pensioner'
"Wop": "string", // optional, Das Wohnortprinzip
"PrivateTariff": "Unknown", // optional, Der Privattarif, Enum: 'Unknown', 'Private', 'Post', 'KVB'
"SktAdditionalInfo": "string", // optional, Zusätzliche Kostenträgerinformationen
"DmpIdentifier": "Unknown", // Das DMP-Kennzeichen, Enum: 'Unknown', 'DiabetesType2', 'BreastCancer', 'CoronaryHeartDisease', 'DiabetesType1', 'Asthma', 'Copd', 'ChronicHeartInsufficiency', 'Depression', 'BackPain', 'Rheumatism', 'Osteoporosis'
"SpecialPersonGroup": "Unknown", // optional, Die Besondere Personengruppe, Enum: 'Unknown', 'SozialhilfeEmpfaenger', 'Bvg', 'Sva', 'SvaPauschal', 'Asylbewerber'
"InvoiceRecipient": { // optional, Angaben zum Rechnungsempfänger
"Title": "string", // optional, Der Titel
"Firstname": "string", // optional,
"Name": "string", // optional,
"Street": "string", // optional,
"Zip": "string", // optional,
"City": "string", // optional,
"CountryCode": "string" // optional, Der Ländercode
},
"IsEmergency": true, // Gibt an, ob der Auftrag ein Notfall ist
"IsHurried": true, // Gibt an, ob die Befundübermittlung eilt ist
"HurriedPhone": "string", // optional, Die Telefonnummer für die eilige Befundübermittlung
"HurriedFax": "string", // optional, Die Faxnummer für die eilige Befundübermittlung
"TakingDateTime": "2024-04-10T06:21:10.454Z", // optional, Das Abnahmedatum
"ServiceQuarter": "2024-04-10T06:21:10.454Z", // optional, read only??? siehe swagger, Das Leistungsquartal
"TypeOfTreatment": "Unknown", // Die Behandlungsart, Enum: 'Unknown', 'Curative', 'Preventive', 'Abortion', 'EvidenceMedicalTreatment'
"ExclusionNumberId": 0, // optional, Die ID der Ausnahmekennziffer
"Diagnosis": "string", // optional, Die Diagnose
"InternalNote": "string", // optional, Die interne Notiz
"IsTransferred": true, // Gibt an, ob es sich um eine Weiterüberweisung handelt
"FirstInducer": { // optional, Angaben zum Erstveranlasser
"Lanr": "string", // optional,
"Bsnr": "string" // optional,
},
"IsAccident": true, // Gibt an, ob es sich um einen Unfall handelt
"IsInfection": true, // Gibt an, ob es sich um eine Infektion handelt
"IsSgb116b": true, // Gibt an, ob es sich um eine Behandlung nach SGB $116b handelt
"IsSgb16": true, // Gibt an, ob es sich um eine Behandlung nach SGB §16 handelt
"IsSgb14": true, // optional, Gibt an, ob es der Auftrag für Leistungen nach SGB XIV (Soziales Entschädigungsrecht – SER) gekennzeichnet ist
"ResultAndMedication": "string", // optional, Befund und Medikation
"AdditionalRecipients": [ // optional, Angaben zu weiteren Empfängern
{
"Id": 0, // Die ID des zusätzlichen Empfängers
"Type": "Unknown", // Enum: 'Unknown', 'Paper', 'Phone', 'Fax', 'EMail', 'RDT', 'TourPost', 'KVConnect'
"Recipient": "string" // optional,
}
],
"MedicationAtTaking": "string", // optional, Medikation zum Zeitpunkt der Probenabnahme
"AlternateProcedure": true, // Erfassung der Versicherungsdaten per Ersatzverfahren
"ExaminationReason": "Precaution", // optional, Der Veranlassungsgrund / Anlass der Untersuchung, Enum: 'Precaution', 'FollowUp', 'ConditionPre', 'ConditionPost', 'Eliminiation', 'Confirmation', 'SpecificSearching', 'UnspecificSearching', 'ResultChecking', 'FinalChecking', 'VaccinationControl'
"ExaminationReasonSpecification": "Procedure", // optional, Die Spezifizierung des Veranlassungsgrundes, Enum 'Procedure', 'DrugAdministration', 'UnclearFever', 'Infection', 'Rheumatism', 'Allergy', 'Cardiovascular', 'Tumor', 'Vaccinations', 'Travelling', 'ImmunityAfterInfection', 'Other'
"Weight": "string", // optional, Das Gewicht des Patienten
"Height": "string", // optional, Die Größe des Patienten
"Pregnancy": { // optional, Angaben zur Schwangerschaft
"IsPregnant": true, // optional,
"Week": 0, // optional,
"Day": 0, // optional,
"FirstDayOfLastCycle": "2024-04-10T06:21:10.454Z" // optional, Der erste Tag des letzten Zyklus
},
"OperationDate": "2024-04-10T06:21:10.454Z", // optional, Das OP-Datum
"IncapacityForWorkUntil": "2024-04-10T06:21:10.454Z", // optional, Arbeitsunfähig bis
"TransferTo": "string", // optional, Überweisung an
"MethodOfExamination": "Unknown", // Die Untersuchungsart, Enum: 'Unknown', 'ContractService', 'ConsultativeExamination', 'CoOrFurtherTreatment'
"AdditionalLabelsCount": 0, // Anzahl der zusätzlichen Etiketten
"HasOtherInvoiceRecipient": true, // optional, Gibt an, ob ein anderer Rechnungsempfänger ausgewählt wurde
"SelectedHzvContractId": 0, // optional, Der ausgewählte HzV-Vertrag
"UsesComplexServices": true, // Gibt an, ob Komplexleistungen verwendet werden
"SelectedComplexServiceId": 0, // optional, Die ID der ausgewählten Komplexleistung
"HasMinersAssociationNumber": true, // optional, Gibt an, ob die Knappschaftskennziffer (87777) vorhanden ist
"RecentOrders": [ // optional, Stellt eine Liste der letzten Aufträge bereit
{
"Disabled": true, // optional,
"Group": { // optional,
"Disabled": true, // optional,
"Name": "string" // optional,
},
"Selected": true, // optional,
"Text": "string", // optional,
"Value": "string" // optional,
}
],
"AdditionalFieldValues": [ // optional, Gibt die Werte der Zusatzangaben zurück
{
"Id": 0, // optional,
"Values": [ // optional,
"string"
]
}
],
"SelectedMicrobiologyItems": [ // optional, Gibt die ausgewählten Kombinationen des Mikrobiologie-Moduls zurück; oder legt diese fest
{
"FormId": 0, // optional,
"GroupIdentifier": "string", // optional, Die Kennung der Gruppe
"Id": 0, // optional,
"LocalizationComment": "string", // optional, Kommentar der Lokalisation
"LocalizationId": 0, // optional,
"LocalizationName": "string", // optional, Name der Lokalisation
"LocalizationIdent": "string", // optional, Gibt den Lokalisations-Ident zurück oder legt diesen fest
"MaterialComment": "string", // optional, Kommentar des Materials
"MaterialId": 0, // optional,
"MaterialIdent": "string", // optional, Ident des Materials
"MaterialName": "string", // optional, Name des Materials
"MaterialTaking": "2024-04-10T06:21:10.454Z", // optional, Abnahmedatum des Materials
"OrderComment": "string", // optional, Kommentar der Kombination
"OrderId": 0, // optional, Id des Auftrags
"LaboratoryOrderId": 0, // optional, Gibt die eindeutige Kennung des zugehörigen Labor-Auftrages zurück oder legt diese fest
"PositionComment": "string", // optional, Kommentar der Position
"PositionId": 0, // optional,
"PositionName": "string", // optional, Name der Position
"RequestComment": "string", // optional, Kommentar der Anforderung
"Requests": [ // optional, Die Anforderungen
{
"Id": 0, // optional,
"Name": "string", // optional,
"Price": 0 // optional,
}
],
"Shortcut": "string", // optional, Das Kürzel
"ShouldBeIgeled": true, // optional, Gibt zurück, ob die Anforderung im Falle der Auftragserstellung nach Abrechnungsart ge-IGeL-t werden soll; oder legt dieses fest
"BasketId": "string", // optional, Id im Warenkorb -> Wird von der View gesetz
"Price": 0, // optional, Der Preis
"DisplayMissingPricesHint": true, // optional, Gibt an, ob ein Hinweis das nicht alle Preise berechnet werden konnten im Warenkorb angezeigt werden soll
"SettlementType": "string" // optional, Der Abrechnungstyp
}
],
"OrderNumbers": [ // optional, Die bereits generierten Auftragsnummern
{
"NumberRangeId": 0, // optional, Die Id des Nummernkreises
"AllocationType": "GlobalCounter", // optional, Der Auftragsnummernvergabetyp, Enum: 'GlobalCounter', 'OwnCounter', 'Manually'
"StartOrderNumber": 0, // optional, Die Startauftragsnummer
"CurrentOrderNumber": 0, // optional, Die aktuelle Auftragsnummer
"LaboratoryOrderNumbers": [ // optional, Liste mit Auftragsnummern
{
"OrderNumber": "string", // optional, Die komplette Auftragsnummer
"Prefix": "string", // optional, Der Prefix
"SenderPart": "string", // optional, Der Einsenderteil
"RangePart": 0, // optional, Die Auftragsnummer
"RangeMin": 0, // optional, Die Mindestzahl für die Auftragsnummer
"RangeMax": 0, // optional, Die Maximalzahl für die Auftragsnummer
"Format": "string", // optional, Das Auftragsnummernformat
"FormName": "string", // optional, Der Formularname
"LaboratoryId": 0, // optional, Die Labor ID
"FormType": "Unknown", // optional, Der Fachbereich, Enum: 'Unknown', 'Specialist', 'Microbiology'
"SettlementType": "Unknown", // optional, Gibt, sofern der Laborauftrag auf Grundlage der Labor-Option "Aufträge generieren" > "je Abrechnungsart" erstellt wurde, die Abrechnungsart des Laborauftrages zurück oder legt diese fest, Enum: 'Unknown', 'PrivateLg', 'PrivateGoae', 'HealthInsuranceLg', 'HzvContractComplexService', 'HealthInsuranceEbm', 'CollectiveInvoice', 'IgelInPrivateLg', 'Igel', 'IgelPvs', 'MibiPanelPatient', 'MibiPrivatePatient', 'MibiSender', 'MibiOtherInvoiceRecipient', 'HealthInsuranceEbmPreventive', 'HealthInsuranceEbmPattern6', 'HealthInsuranceEbmPattern39', 'MibiIgel', 'MiBiIgelPVS'
"SettlementIdent": "string", // optional, Gibt ein Ident der Abrechnungsart zurück, oder legt dieses fest
"FormId": 0, // optional, Gibt, sofern der Laborauftrag auf Grundlage der Labor-Option "Aufträge generieren" > "je Formular" erstellt wurde, die Formular-ID des Laborauftrages zurück oder legt diese fest
"ExistingLaboratoryOrderId": 0, // optional, ibt die LaboratoryOrderId an, wenn zu dieser Auftragsnummer bereits eine LaboratoryOrder existiert, oder legt den Wert fest
"ContainedRequests": [ // 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,
"RequestName": "string", // optional,
"RequestPrice": 0, // optional,
"SubsequentRequest": "2024-04-10T06:21:10.454Z", // optional,
"Taking": "2024-04-10T06:21:10.454Z", // optional,
"LaboratoryOrderId": 0, // optional,
"ShouldBeIgeled": true, // optional,
"GroupName": "string", // optional,
"MessageInfos": [ // optional,
{
"Type": "Info", // optional,
"Identifier": "string", // optional,
"Content": "string", // optional,
"OrderRequestId": 0 // optional,
}
]
}
]
}
],
"IsExistingOrderNumber": true, // optional, Gibt an, ob die Auftragsnummer von einem existierenden Laborauftrag stammt oder legt den Wert fest.
"OrderNumberAllocation": "Unkown", // optional, Gibt die gewählte Option (eine für alle Formulare oder für jede je Formular eine) für die Auftragsnummernvergabe zurück; oder legt diese fest, Enum: 'Unkown', 'PerForm', 'OneForAllForms'
"CurrentNumberRangePart": 0 // optional, Gibt den aktuellen Wert des Nummernkreises zurück oder legt diesen fest
}
]
}
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