2. Auftrag erstellen
Für die Auftragserstellung werden die IDs von Einsender und verschreibendem Arzt benötigt (SenderIdentifier, DoctorIdentifier).
Weiterhin werden hier die Patientendaten aus dem Praxisverwaltungssystem übermittelt um einen Auftrag zu erstellen. Dieses sind insbesondere: Name, Geburtsdatum und die Versichertendaten.
Tipp
Ist dem Benutzer nur 1 Einsender und 1 verschreibender Arzt zugewiesen, so können bei der Auftragserstellung die IDs leer gelassen werden.
Mit dem Aufruf ist es ebenfalls möglich einen Sammelauftrag zu erstellen
Endpunkt Beschreibung
Methode: POST
Endpunkt: {base}/api/v3/orders
Request Body — Anfrage zum Server
{
"Orders": [ // Anzulegende Aufträge
{
"Order": { // Auftrage
"Insurance": { // optional, Versicherungsinformationen
"InsurantId": "string", // optional, Versicherten-ID
"BillingVKNR": "string", // optional, Abrechnungs-VKNR
"HealthInsuranceNumber": "string", // optional, Krankenkassennummer
"InsuranceCoverageEnding": "2024-04-08T11:35:36.870Z", // optional, Ende der Versicherungsabdeckung
"InsuranceCoverageBeginning": "2024-04-08T11:35:36.870Z", // optional, Beginn der Versicherungsabdeckung
"HealthInsuranceName": "string", // optional, Krankenkassenname
"LastReadTimeOfInsuranceCard": "2024-04-08T11:35:36.870Z", // optional, Datum des letzten Einlesens der Gesundheitskarte
"InsurantNumber": "string", // optional, Versichertennummer
"AccountType": "Unknown", // optional, Abrechnungsart, Enum: 'Unknown', 'PanelPatient', 'PrivatePatient', 'OtherInvoiceRecipient', 'Sender'
"InsuranceType": "Unknown", // optional, Versichertentyp, Enum: 'Unknown', 'Member', 'FamilyInsurance', 'Pensioner'
"Wop": "string", // optional, Wohnortprinzipkennzeichen
"CostCarrierBillingSection": "string", // optional, Kostenträgerabrechnungsbereich
"PrivateTariff": "Unknown" // optional, Privattarif, Enum: 'Unknown', 'Private', 'Post', 'KVB'
},
"DmpIdentifier": "Unknown", // optional, DMP-Kennzeichen, Enum: Unknown', 'DiabetesType2', 'BreastCancer', 'CoronaryHeartDisease', 'DiabetesType1', 'Asthma', 'Copd', 'ChronicHeartInsufficiency', 'Depression', 'BackPain', 'Rheumatism', 'Osteoporosis'
"FirstDayOfLastCycle": "2024-04-08T11:35:36.870Z", // optional, Erster Tag des letzten Zyklus
"Pregnancy": {
"DurationWeeks": 0, // optional, Schwangerschaftswoche
"DurationDays": 0, // optional, Schwangerschaftstag
"IsPregnant": true // optional, Patientin ist schwanger
},
"ResultAndMedication": [ // optional, Befund und Medikationen
"string"
],
"Diagnosis": [ // optional, Diagnosen
"string"
],
"PatientHeightMeasureDate": "2024-04-08T11:35:36.870Z", // optional, Zeitpunkt der Erfassung der Patientengröße
"PatientHeight": "string", // optional, Größe des Patienten
"PatientWeightMeasureDate": "2024-04-08T11:35:36.870Z", // optional, Zeitpunkt der Erfassung des Patientengewichts
"PatientWeight": "string", // optional, Gewicht des Patienten
"SpecialPersonGroup": "Unknown", // optional, Besondere Personengruppe, Enum: 'Unknown', 'SozialhilfeEmpfaenger', 'Bvg', 'Sva', 'SvaPauschal', 'Asylbewerber'
"Accident": true, // optional, Unfall oder Unfallfolgen
"Infection": true, // optional, Kontrolluntersuchung einer bekannten Infektion
"Hurried": true, // optional, Befundübermittlung eilt
"PhoneNumber": "string", // optional, Rufnummer, bei eiliger Befundübermittlung
"FaxNumber": "string", // optional, Faxnummer, bei eiliger Befundübermittlung
"ReducedEntitlement": true, // optional, Eingeschränkter Leistungsanspruch gemäß § 16 Abs. 3a SGB V
"Sgb116b": true, // optional, Behandlung gemäß § 116b SGB V
"Sgb14": true, // optional, Auftrag ist für Leistungen nach SGB XIV (Soziales Entschädigungsrecht – SER) gekennzeichnet
"TakingDateTime": "2024-04-08T11:35:36.870Z", // optional, Abnahmezeitpunkt
"FeeRegulations": "Unknown", // optional, Gebührenordnung, Enum: 'Unknown', 'BMAE', 'EGO', 'GOAE96', 'BG', 'GOAE88', 'HZV'
"InvoiceRecipient": { // optional, Rechnungsempfänger
"Firstname": "string", // optional, Vorname
"Name": "string", // optional, Name
"Title": "string", // optional, Titel
"Street": "string", // optional, Straße und Hausnummer
"City": "string", // optional, Stadt
"Zip": "string" // optional, Postleitzahl
},
"FirstInducer": { // optional, Erstveranlasser
"Lanr": "string", // optional, Lebenslange Arztnummer
"Bsnr": "string" // optional, Betriebsstättennummer
},
"MedicationIntakeAtTimeOfSampling": [ // optional, Medikation bei Probenentnahme
"string"
],
"State": "Unknown", // optional, Auftragsstatus, Enum: 'Unknown', 'Normal', 'Important', 'VeryImportant'
"TreatmentType": "Unknown", // optional, Behandlungsart, Enum: 'Unknown', 'Curative', 'Preventive', 'Abortion', 'EvidenceMedicalTreatment'
"Bsnr": "string", // optional, Betriebsstättennummer des Einsenders
"Lanr": "string", // optional, Lebenslange Arztnummer des Einsenders
"InitialTypeOfTreatment": "Unknown", // optional, Initiale Behandlungsart, Enum: 'Unknown', 'Curative', 'Preventive', 'Abortion', 'EvidenceMedicalTreatment'
"AdditionalRecipient": "string", // optional, Zusätzlicher Empfänger
"OrderRequests": [ // optional, Ausgewählte Anforderungen
{
"Form": "string", // Eindeutige Kennung des Formulars
"Requests": [ // optional, Anforderungs-Idents
"string"
]
}
],
"AdditionalFields": [ // optional, Zusatzangaben
{
"AdditionalFieldKey": "string", // Eindeutige Kennung der Zusatzangabe
"ValueList": [ // optional, Werteliste der Zusatzangabe
"string"
]
}
],
"ProcessIdentifier": "string", // optional, Externe Vorgangskennung des Auftrags
"HasMinersAssociationNumber": true // optional, Gibt an, ob die Knappschaftskennziffer (87777) vorhanden ist
},
"Patient": { // Informationen zum Patienten
"AdditionalName": "string", // optional, Namenszusatz (z.B. MdB, MdL, B. Sc)
"PreWord": "string", // optional, Vorsatzwort (z.B. von, van)
"Firstname": "string", // optional, Vorname
"Lastname": "string", // optional, Nachname
"DateOfBirth": "string", // optional, Geburtsdatum
"Title": "string", // optional, Titel (z.B. Dr., Prof.)
"Gender": "Unknown", // optional, Geschlecht, Enum: 'Unknown', 'Female', 'Male', 'Undefined', 'Diverse'
"Address": { // optional, Adressinformationen
"CountryCode": "string", // optional, Ländercode
"Street": "string", // optional, Straße
"Number": "string", // optional, Hausnummer, maximale länge: 9
"City": "string", // optional, Stadt
"Zip": "string" // optional, Postleitzahl
},
"PostBox": { // optional, Postfachinformationen
"PostBox": "string", // optional, Postfachnummer
"Zip": "string", // optional, Postleitzahl
"City": "string", // optional, Stadt
"CountryCode": "string" // optional, Ländercode
},
"ExternalPatientId": "string", // optional, PVS-Patientennummer
"IsHzvPatient": true, // optional, Patient ist HzV Patient
"Department": "string" // optional, Dem Patienten zugewiesene Abteilung
},
"Attachments": [ // optional, Sonstige Anhänge zum Auftrag. Diese Anhänge werden bei einem Auftragsabschluss wieder an das abfragende System zurückübermittelt.
{
"Name": "string", // Name
"Data": "string" // optional, Daten
}
]
}
],
"SenderIdentifier": "string", // optional, ID des Einsenders. Dieser Wert muss nach der Einsender-/Arztauswahl mit dem entsprechenden Wert gefüllt werden.
"DoctorIdentifier": "string", // optional, ID des Arztes. Dieser Wert muss nach der Einsender-/Arztauswahl mit dem entsprechenden Wert gefüllt werden.
"InitStep": "Patient", // optional, Einstiegspunkt in der Auftragserstellung (UI), Enum: 'Patient', 'OrderData', 'Requests', 'Material'
"CreatorIdent": "string", // optional, Kennung der Software, die die Auftragsanlage ausgelöst hat
"CreatorFriendlyName": "string" // optional, Anzeigename der Software, die die Auftragsanlage ausgelöst hat
}
Platzhalter für Silke
201er Response — Antwort vom Server
{
"OrderId": "string",
"DetailsUrl": "string"
}
weitere mögliche Antworten
300 Einsender und/oder Arzt konnten nicht bestimmt werden. Bitte auswählen
{
"Senders": [
{
"Identifier": "string",
"Name": "string",
"Attributes": "None",
"Doctors": [
{
"Identifier": "string",
"Name": "string",
"Attributes": "None"
}
]
}
]
}
400 Die Anfrage ist unvollständig, fehlerhaft oder der Patient konnte nicht eindeutig identifiziert werden
fehlende information
401 Es wurde kein Token zur Authentifizierung übergeben
no content