API docs by Redocly

Alberta Basis Schnittstelle (2.0.5)

Download OpenAPI specification:

REST API für Kunden zur Interaktion mit der Alberta Homecare Plattform.

Dokumentation erstellt am: 30.12.2025

Datenmodell & Organisationsstruktur

Kernkonzepte

  • Patient: Zentrale Entität mit Stammdaten, Adressen und Verknüpfungen zu Kostenträgern, Ärzten und Pflegediensten
  • Region: Hierarchische Organisationseinheit zur Strukturierung und Sichtbarkeitssteuerung aller Entitäten
  • Benutzer (User): Außendienstmitarbeiter, die Patienten betreuen (fieldNurseId)

Versorgung & Bestellungen

  • IntegratedCare (Versorgung): Dauerversorgung eines Patienten für eine Therapie. Enthält proposedArticleLines als Vorlage für wiederkehrende Bestellungen.
  • SingleOrder (Bestellung): Konkrete Bestellung im Rahmen einer Versorgung, verknüpft über integratedCareId
  • DirectOrder (Direktbestellung): Einmalige Bestellung ohne Versorgungsbezug

ERP-Synchronisation

Wichtige Felder

  • salesId: ERP-Auftragsnummer (keine User-Referenz!) - dient der Zuordnung zwischen Alberta und ERP-System
  • customerId: ERP-Kundennummer am Patienten
  • ErpOrder: Rückmeldung von Lieferinformationen (Tracking, Versanddatum) vom ERP an Alberta

Inkrementelle Synchronisation

Die API unterstützt inkrementelle Synchronisation über zwei Pflichtparameter:

  • status: Filtert nach Änderungsstatus (created, updated, transmitted, archived)
  • updatedAfter: ISO 8601 Zeitstempel - nur Datensätze nach diesem Zeitpunkt werden zurückgegeben

Synchronisations-Workflow

  1. Erstaufruf: GET /endpoint?status=created&updatedAfter=2025-12-10T00:00:00Z
  2. Zeitstempel merken: Den aktuellen Zeitpunkt vor dem Abruf speichern
  3. Daten verarbeiten: Empfangene Datensätze im ERP verarbeiten
  4. Status zurückmelden: Bei Bestellungen PATCH mit neuem Status aufrufen
  5. Nächster Abruf: updatedAfter auf den gemerkten Zeitstempel setzen

Vermeidung von Endlosschleifen

Änderungen, die über die API vorgenommen werden (z.B. PATCH/PUT), werden beim nächsten Abruf automatisch ignoriert. Alberta erkennt den API-Key und filtert diese Änderungen heraus. Das bedeutet: Wenn Sie einen Datensatz per API aktualisieren, erscheint er nicht erneut in Ihrer nächsten Synchronisationsabfrage.

Ausnahme bei Bestellungen: Bei SingleOrder, DirectOrder und IntegratedCare erfolgt die Steuerung über den Status-Wechsel (z.B. von created zu transmitted). Sobald Sie den Status per PATCH ändern, erscheint die Bestellung nicht mehr unter status=created.

Institutionen & Stammdaten

  • Doctor: Behandelnder Arzt (primaryDoctorId am Patienten)
  • Payer: Kostenträger/Krankenkasse
  • NursingHome/NursingService: Pflegeheim/Pflegedienst
  • Article: Artikelstammdaten mit Preisen und Verpackungseinheiten

Dokumente & Anlagen

  • Attachment: Dateien/Bilder zu Patienten oder Bestellungen
  • Document (Audit): Ausgefüllte Formulare basierend auf Vorlagen

Endpunkt-Übersicht

Endpunkt Zweck Methoden
/patient Patientenstammdaten GET, POST, PATCH
/singleOrder Bestellungen (im Rahmen einer Versorgung) GET, PATCH
/directOrder Einmalige Bestellungen ohne Bezug zu einer Dauerversorgung GET, PATCH
/integratedCare Dauerversorgungen GET, POST, PATCH
/erpOrder Lieferrückmeldungen vom ERP GET, POST, PUT
/article Artikelstammdaten GET, POST, PUT
/doctor Ärzte GET
/payer Kostenträger/Krankenkassen GET
/region Strukturelle Organisationseinheiten (z.B. regionale Strukturen) GET
/users Außendienstmitarbeiter GET
/attachment Dateien/Bilder GET, POST
/device Medizinische Geräte POST, PUT
/patientNote Notizen zu Patienten GET, POST, PATCH
/patientHistory Änderungshistorie am Patienten GET
/productGroup Produktgruppen-Hierarchie GET, POST, PATCH
/document Ausgefüllte Formulare (PDF/XML) GET

Authentifizierung

Die Authentifizierung erfolgt über einen API-Key, der im Header alberta-api-key übermittelt werden muss. Der API-Key wird von Alberta bereitgestellt und ist mandantenspezifisch.

Status & Verfügbarkeit

Aktuelle Informationen zur Systemverfügbarkeit und geplanten Wartungsarbeiten finden Sie auf unserer Status-Seite.

Artikel

Endpunkte zur Verwaltung von Artikeln (Produktkatalog).

Artikel abrufen

Ruft einen einzelnen Artikel anhand seiner ID ab.

Die ID kann entweder die Alberta-interne _id (UUID) oder die ERP-spezifische customerNumber sein.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Artikel-ID. Kann entweder die Alberta _id (UUID v4) oder die ERP-spezifische customerNumber sein.

Responses

Response samples

Content type
application/json
{
  • "pcn": "string",
  • "name": "string",
  • "description": "string",
  • "manufacturerNumber": "string",
  • "customerNumber": "string",
  • "medicalAidPositionNumber": "string",
  • "ean": "string",
  • "additionalDescription": "string",
  • "manufacturer": "string",
  • "size": "string",
  • "assortmentType": 0,
  • "status": 0,
  • "productGroupId": "string",
  • "therapyIds": [
    ],
  • "billableTherapies": [
    ],
  • "prescriptionType": 0,
  • "packagingUnits": [
    ],
  • "pharmacyPrice": "string",
  • "listPrice": "string",
  • "insuranceFixedPrice": [
    ],
  • "fixedPrice": "string",
  • "purchaseRating": 0,
  • "unavailableTo": "string",
  • "unavailableFrom": "string",
  • "delayedTo": "string",
  • "inventoryType": 0,
  • "stars": 0,
  • "attributes": [
    ],
  • "substituteArticleCustomerNumber": "string",
  • "requiresSerialnumber": true,
  • "requiresBatchnumber": true,
  • "requiresValidToDate": true,
  • "directOrder": true,
  • "pharmacyOnly": true,
  • "statusAnnotation": "string",
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string"
}

Artikel aktualisieren

Aktualisiert einen bestehenden Artikel.

ID-Auflösung

Die ID kann entweder die Alberta-interne _id (UUID v4) oder die ERP-spezifische customerNumber sein. Das System erkennt automatisch, welcher Typ verwendet wird.

Pflichtfelder

  • name: Artikelname
  • customerNumber: ERP-spezifische Artikelnummer
  • packagingUnits: Mindestens eine Verpackungseinheit

Verpackungseinheiten-Logik

Bei der Aktualisierung werden Verpackungseinheiten intelligent zusammengeführt:

  • Bestehende Einheiten (gleiche quantity, unit, pcn) behalten ihre _id
  • Neue Einheiten erhalten eine neue _id
  • Nicht mehr enthaltene Einheiten werden als archived: true markiert

Therapie-IDs

Falls therapyIds nicht angegeben wird, bleibt der bestehende Wert erhalten.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: ART-12345

Artikel-ID. Kann entweder die Alberta _id (UUID v4) oder die ERP-spezifische customerNumber sein.

Request Body schema: application/json
required
pcn
string

Pharmazentralnummer (PZN).

name
string

Name des Artikels.

description
string

Beschreibung des Artikels.

manufacturerNumber
string

Herstellernummer.

customerNumber
string

ERP- bzw. kundenspezifische Nummer des Artikels.

medicalAidPositionNumber
string

Hilfsmittelpositionsnummer.

Nummer aus dem Hilfsmittelverzeichnis der GKV.

ean
string

European Article Number (EAN/GTIN).

additionalDescription
string

Zusätzliche Beschreibung.

manufacturer
string

Name des Herstellers.

size
string

Größe/Abmessung des Artikels.

assortmentType
number

Sortimentstyp. Wert ist der Enum-Wert aus {@link ArticleAssortment } .

status
number

Status des Artikels. Wert ist der Enum-Wert aus {@link ArticleStatus } .

productGroupId
string

ID der Produktgruppe.

therapyIds
Array of numbers

Liste der Therapie-IDs, für die dieser Artikel verwendet werden kann.

Werte sind Enum-Werte aus {@link Therapy } .

billableTherapies
Array of numbers

Liste der Therapie-IDs, für die dieser Artikel abrechenbar ist. Werte sind Enum-Werte aus {@link Therapy } .

prescriptionType
number (PrescriptionType)
Enum: 0 1 2 3 4 5 7

Typ einer Verordnung.

Definiert die verschiedenen Verordnungsarten im Homecare-Bereich.

Wert Name Beschreibung
0 Drug Arzneimittel.
1 Dressings Verbandmittel.
2 NarcoticsRecipe Betäubungsmittelrezept.
3 NursingAids Pflegehilfsmittel.
4 AdisForConsumption Hilfsmittel zum Verbrauch.
5 AidsForUse Hilfsmittel zum Gebrauch.
7 TubeFeeding Sondennahrung.
Array of objects (IQuantityPerUnit)

Verpackungseinheiten mit Mengenangaben.

pharmacyPrice
string

Apothekenverkaufspreis.

listPrice
string

Listenpreis.

Array of objects (IInsuranceFixedPrice)

Pauschalen aus Krankenkassen-Verträgen.

fixedPrice
string

Pauschale.

purchaseRating
number

Verwendet für die Wirtschaftlichkeitsberechnung von Artikel beim Erstellen einer Bestellung.

unavailableTo
string

Nicht verfügbar bis (Enddatum).

unavailableFrom
string

Nicht verfügbar ab (Startdatum).

delayedTo
string

Lieferung verzögert bis.

inventoryType
number (InventoryType)
Enum: 0 1 2

Inventartyp für Lagerbestände von Artikeln.

Unterscheidet zwischen Lager- und Bestellbeständen.

Wert Name Beschreibung
0 Unknown Unbekannter Typ.
1 Store Lagerbestand.
2 Order Bestellbestand.
stars
number

Bewertung (Sterne). Bestimmt die Sortierung der Artikel im Standardversorgungsvorschlag. Höhere Anzahl der Sterne bedeutet Sortierung an den Anfang der Artikel-Liste. Sterne können alternativ auch aus einer Wirtschaftlichkeitsberechnung heraus bestimmt werden.

Array of objects (IAttribute)

Zusätzliche Attribute des Artikels. Werden in der UI im Artikel-Editor angezeigt.

substituteArticleCustomerNumber
string

ERP bzw. kundenseitige Nummer eines Ersatzartikels.

requiresSerialnumber
boolean

Gibt an, ob eine Seriennummer erforderlich ist.

requiresBatchnumber
boolean

Gibt an, ob eine Chargennummer erforderlich ist.

requiresValidToDate
boolean

Gibt an, ob ein Verfallsdatum erforderlich ist.

directOrder
boolean

Gibt an, ob der Artikel für Direktbestellungen verfügbar ist.

pharmacyOnly
boolean

Gibt an, ob der Artikel nur über Apotheken bezogen werden kann.

statusAnnotation
string

Anmerkung zum Status.

_id
string

Eindeutige ID der Entität (UUID v4 als String).

Wird beim Erstellen automatisch generiert.

timestamp
string

Zeitstempel der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

archived
boolean

Markiert die Entität als archiviert (Soft-Delete).

Archivierte Entitäten werden nicht physisch gelöscht, sondern nur als archiviert markiert. Sie erscheinen nicht mehr in Standard-Abfragen.

createdAt
string

Zeitpunkt der Erstellung.

Wird beim Erstellen der Entität automatisch gesetzt.

createdBy
string

ID des Benutzers, der die Entität erstellt hat.

Referenziert einen Benutzer im System.

updatedAt
string

Zeitpunkt der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

updatedBy
string

ID des Benutzers, der die letzte Änderung vorgenommen hat.

Referenziert einen Benutzer im System.

Responses

Request samples

Content type
application/json
{
  • "name": "Wundverband steril 10x10cm (aktualisiert)",
  • "customerNumber": "ART-12345",
  • "status": 2,
  • "packagingUnits": [
    ]
}

Response samples

Content type
application/json
{
  • "pcn": "string",
  • "name": "string",
  • "description": "string",
  • "manufacturerNumber": "string",
  • "customerNumber": "string",
  • "medicalAidPositionNumber": "string",
  • "ean": "string",
  • "additionalDescription": "string",
  • "manufacturer": "string",
  • "size": "string",
  • "assortmentType": 0,
  • "status": 0,
  • "productGroupId": "string",
  • "therapyIds": [
    ],
  • "billableTherapies": [
    ],
  • "prescriptionType": 0,
  • "packagingUnits": [
    ],
  • "pharmacyPrice": "string",
  • "listPrice": "string",
  • "insuranceFixedPrice": [
    ],
  • "fixedPrice": "string",
  • "purchaseRating": 0,
  • "unavailableTo": "string",
  • "unavailableFrom": "string",
  • "delayedTo": "string",
  • "inventoryType": 0,
  • "stars": 0,
  • "attributes": [
    ],
  • "substituteArticleCustomerNumber": "string",
  • "requiresSerialnumber": true,
  • "requiresBatchnumber": true,
  • "requiresValidToDate": true,
  • "directOrder": true,
  • "pharmacyOnly": true,
  • "statusAnnotation": "string",
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string"
}

Artikel auflisten

Listet alle Artikel auf, die seit einem bestimmten Zeitpunkt geändert wurden.

Artikel sind Produkte, die an Patienten geliefert werden können. Sie werden in Bestellungen als Artikelzeilen referenziert.

Wichtige Felder

  • customerNumber: ERP-spezifische Artikelnummer (Pflichtfeld, eindeutig)
  • name: Artikelname (Pflichtfeld)
  • packagingUnits: Verpackungseinheiten (Pflichtfeld, mind. eine)
  • therapyIds: Zuordnung zu Therapien (Enum-Werte)
  • status: Verfügbarkeitsstatus (siehe ArticleStatus Enum)
  • assortmentType: Sortimentszuordnung (siehe ArticleAssortment Enum)

Synchronisation

Dieser Endpunkt ist für die inkrementelle Synchronisation mit ERP-Systemen konzipiert. Der Parameter updatedAfter ist Pflicht und filtert auf Artikel, deren updatedAt größer als der angegebene Zeitstempel ist.

Änderungen, die über die API selbst vorgenommen wurden, werden bei der Synchronisation ignoriert, um Endlosschleifen zu vermeiden.

Authorizations:
ApiKeyAuth
query Parameters
updatedAfter
required
string <date-time>
Example: updatedAfter=2025-01-01T00:00:00.000Z

ISO 8601 Zeitstempel. Nur Artikel, die nach diesem Zeitpunkt geändert wurden, werden zurückgegeben.

status
required
string
Enum: "created" "updated" "archived"
Example: status=updated

Filtert Artikel nach ihrem Änderungsstatus:

  • created: Neue Artikel (noch keine salesId vorhanden)
  • updated: Geänderte Artikel
  • archived: Archivierte/gelöschte Artikel (Soft-Delete)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Artikel erstellen

Erstellt einen neuen Artikel im System.

Pflichtfelder

  • name: Artikelname
  • customerNumber: ERP-spezifische Artikelnummer (muss eindeutig sein)
  • packagingUnits: Mindestens eine Verpackungseinheit

Duplikatsprüfung

Die customerNumber muss eindeutig sein. Bei einem Duplikat wird ein Fehler mit den IDs der existierenden Artikel zurückgegeben.

Automatisch generierte Felder

  • _id: Wird automatisch als UUID v4 generiert
  • packagingUnits[*]._id: Werden automatisch generiert
  • therapyIds: Wird auf leeres Array gesetzt, falls nicht angegeben
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
pcn
string

Pharmazentralnummer (PZN).

name
string

Name des Artikels.

description
string

Beschreibung des Artikels.

manufacturerNumber
string

Herstellernummer.

customerNumber
string

ERP- bzw. kundenspezifische Nummer des Artikels.

medicalAidPositionNumber
string

Hilfsmittelpositionsnummer.

Nummer aus dem Hilfsmittelverzeichnis der GKV.

ean
string

European Article Number (EAN/GTIN).

additionalDescription
string

Zusätzliche Beschreibung.

manufacturer
string

Name des Herstellers.

size
string

Größe/Abmessung des Artikels.

assortmentType
number

Sortimentstyp. Wert ist der Enum-Wert aus {@link ArticleAssortment } .

status
number

Status des Artikels. Wert ist der Enum-Wert aus {@link ArticleStatus } .

productGroupId
string

ID der Produktgruppe.

therapyIds
Array of numbers

Liste der Therapie-IDs, für die dieser Artikel verwendet werden kann.

Werte sind Enum-Werte aus {@link Therapy } .

billableTherapies
Array of numbers

Liste der Therapie-IDs, für die dieser Artikel abrechenbar ist. Werte sind Enum-Werte aus {@link Therapy } .

prescriptionType
number (PrescriptionType)
Enum: 0 1 2 3 4 5 7

Typ einer Verordnung.

Definiert die verschiedenen Verordnungsarten im Homecare-Bereich.

Wert Name Beschreibung
0 Drug Arzneimittel.
1 Dressings Verbandmittel.
2 NarcoticsRecipe Betäubungsmittelrezept.
3 NursingAids Pflegehilfsmittel.
4 AdisForConsumption Hilfsmittel zum Verbrauch.
5 AidsForUse Hilfsmittel zum Gebrauch.
7 TubeFeeding Sondennahrung.
Array of objects (IQuantityPerUnit)

Verpackungseinheiten mit Mengenangaben.

pharmacyPrice
string

Apothekenverkaufspreis.

listPrice
string

Listenpreis.

Array of objects (IInsuranceFixedPrice)

Pauschalen aus Krankenkassen-Verträgen.

fixedPrice
string

Pauschale.

purchaseRating
number

Verwendet für die Wirtschaftlichkeitsberechnung von Artikel beim Erstellen einer Bestellung.

unavailableTo
string

Nicht verfügbar bis (Enddatum).

unavailableFrom
string

Nicht verfügbar ab (Startdatum).

delayedTo
string

Lieferung verzögert bis.

inventoryType
number (InventoryType)
Enum: 0 1 2

Inventartyp für Lagerbestände von Artikeln.

Unterscheidet zwischen Lager- und Bestellbeständen.

Wert Name Beschreibung
0 Unknown Unbekannter Typ.
1 Store Lagerbestand.
2 Order Bestellbestand.
stars
number

Bewertung (Sterne). Bestimmt die Sortierung der Artikel im Standardversorgungsvorschlag. Höhere Anzahl der Sterne bedeutet Sortierung an den Anfang der Artikel-Liste. Sterne können alternativ auch aus einer Wirtschaftlichkeitsberechnung heraus bestimmt werden.

Array of objects (IAttribute)

Zusätzliche Attribute des Artikels. Werden in der UI im Artikel-Editor angezeigt.

substituteArticleCustomerNumber
string

ERP bzw. kundenseitige Nummer eines Ersatzartikels.

requiresSerialnumber
boolean

Gibt an, ob eine Seriennummer erforderlich ist.

requiresBatchnumber
boolean

Gibt an, ob eine Chargennummer erforderlich ist.

requiresValidToDate
boolean

Gibt an, ob ein Verfallsdatum erforderlich ist.

directOrder
boolean

Gibt an, ob der Artikel für Direktbestellungen verfügbar ist.

pharmacyOnly
boolean

Gibt an, ob der Artikel nur über Apotheken bezogen werden kann.

statusAnnotation
string

Anmerkung zum Status.

_id
string

Eindeutige ID der Entität (UUID v4 als String).

Wird beim Erstellen automatisch generiert.

timestamp
string

Zeitstempel der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

archived
boolean

Markiert die Entität als archiviert (Soft-Delete).

Archivierte Entitäten werden nicht physisch gelöscht, sondern nur als archiviert markiert. Sie erscheinen nicht mehr in Standard-Abfragen.

createdAt
string

Zeitpunkt der Erstellung.

Wird beim Erstellen der Entität automatisch gesetzt.

createdBy
string

ID des Benutzers, der die Entität erstellt hat.

Referenziert einen Benutzer im System.

updatedAt
string

Zeitpunkt der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

updatedBy
string

ID des Benutzers, der die letzte Änderung vorgenommen hat.

Referenziert einen Benutzer im System.

Responses

Request samples

Content type
application/json
{
  • "name": "Wundverband steril 10x10cm",
  • "customerNumber": "ART-12345",
  • "pcn": "12345678",
  • "manufacturer": "MedSupply GmbH",
  • "productGroupId": "550e8400-e29b-41d4-a716-446655440000",
  • "status": 1,
  • "assortmentType": 2,
  • "therapyIds": [
    ],
  • "packagingUnits": [
    ]
}

Response samples

Content type
application/json
{
  • "pcn": "string",
  • "name": "string",
  • "description": "string",
  • "manufacturerNumber": "string",
  • "customerNumber": "string",
  • "medicalAidPositionNumber": "string",
  • "ean": "string",
  • "additionalDescription": "string",
  • "manufacturer": "string",
  • "size": "string",
  • "assortmentType": 0,
  • "status": 0,
  • "productGroupId": "string",
  • "therapyIds": [
    ],
  • "billableTherapies": [
    ],
  • "prescriptionType": 0,
  • "packagingUnits": [
    ],
  • "pharmacyPrice": "string",
  • "listPrice": "string",
  • "insuranceFixedPrice": [
    ],
  • "fixedPrice": "string",
  • "purchaseRating": 0,
  • "unavailableTo": "string",
  • "unavailableFrom": "string",
  • "delayedTo": "string",
  • "inventoryType": 0,
  • "stars": 0,
  • "attributes": [
    ],
  • "substituteArticleCustomerNumber": "string",
  • "requiresSerialnumber": true,
  • "requiresBatchnumber": true,
  • "requiresValidToDate": true,
  • "directOrder": true,
  • "pharmacyOnly": true,
  • "statusAnnotation": "string",
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string"
}

Anlage

Endpunkte zur Verwaltung von Anlagen (Dateien, Bilder).

Anlage erstellen

Lädt eine neue Anlage (Datei/Bild) für einen Patienten hoch.

Pflichtfelder

  • data: Base64-kodierte Dateidaten
  • metadata.patientId: ID des zugehörigen Patienten
  • metadata.type: Typ der Anlage (siehe AttachmentType)
  • mime: MIME-Typ der Datei (z.B. "image/jpeg")
  • filename: Dateiname

Hinweise

  • Die regionId wird automatisch vom Patienten übernommen.

Zugriffsbeschränkung

Nur bestimmte API-Keys sind berechtigt, Anlagen zu erstellen. Bei nicht berechtigten API-Keys wird ein 403-Fehler zurückgegeben.

Nicht erlaubte Methoden

Die Methoden PUT, PATCH und DELETE sind für Anlagen nicht verfügbar.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
data
required
string

Base64-kodierte Dateidaten

required
object
mime
required
string

MIME-Typ der Datei

filename
required
string

Dateiname

Responses

Request samples

Content type
application/json
{
  • "data": "string",
  • "metadata": {
    },
  • "mime": "image/jpeg",
  • "filename": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "filename": "string",
  • "uploadDate": "string",
  • "contentType": "string",
  • "authorizedKiwiInstitutions": [
    ],
  • "createdByKiwi": true,
  • "metadata": {
    }
}

Anlagen auflisten

Listet Anlagen auf, gefiltert nach Erstellungszeitstempel.

Wichtige Felder

  • metadata.patientId: ID des zugehörigen Patienten
  • metadata.type: Typ der Anlage (AttachmentType)
  • filename: Dateiname
  • uploadDate: Hochladedatum

Hinweise

  • Archivierte Anlagen werden nicht zurückgegeben.
  • Spezielle Anlagetypen (100-199, z.B. Swodoc-Bilder) werden gefiltert.
Authorizations:
ApiKeyAuth
query Parameters
createdAfter
string <date-time>
Example: createdAfter=2025-01-01T00:00:00.000Z

ISO 8601 Zeitstempel. Nur Anlagen, die nach diesem Zeitpunkt hochgeladen wurden, werden zurückgegeben.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Anlage herunterladen

Lädt die Binärdaten einer Anlage anhand ihrer ID herunter.

Die Datei wird entweder aus Google Cloud Storage oder GridFS geladen.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 507f1f77bcf86cd799439011

Die ObjectId der Anlage.

Responses

Dokument

Endpunkte zur Abfrage von Dokumenten (ausgefüllte Formulare).

Dokument als PDF oder XML abrufen

Ruft ein einzelnes Dokument anhand seiner ID ab und generiert es als PDF oder XML.

Konzept: Dokument (Audit)

Ein Dokument ist ein ausgefülltes Formular basierend auf einer Vorlage (Template). Die PDF-Generierung erfolgt über Stimulsoft-Reports.

Ausgabeformate

  • PDF (Standard): Generiertes PDF-Dokument
  • XML: Strukturierte Daten des Dokuments (mit ?xml=true)
Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Die UUID des Dokuments (Alberta _id).

query Parameters
xml
boolean

Wenn true, wird das Dokument als XML statt PDF zurückgegeben.

Responses

Liste von Dokumenten abrufen

Ruft eine Liste von Dokumenten basierend auf einem Zeitstempel ab.

Filterung

  • Nur abgeschlossene Dokumente (completed=true) werden zurückgegeben
  • Dokumente vom Typ 5 werden standardmäßig ausgeschlossen
  • Ohne templateId-Filter werden nur Dokumente mit relevanten Vorlagen zurückgegeben
Authorizations:
ApiKeyAuth
query Parameters
createdAfter
required
string <date-time>
Example: createdAfter=2025-01-01T00:00:00.000Z

ISO 8601 Zeitstempel. Nur Dokumente, die nach diesem Zeitpunkt erstellt/geändert wurden, werden zurückgegeben.

templateId
string

Filtert nach einer bestimmten Vorlagen-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gerät

Endpunkte zur Verwaltung von medizinischen Geräten.

Gerät erstellen

Erstellt ein neues medizinisches Gerät für einen Patienten.

Geräte sind individuelle Instanzen von Artikeln mit einer Seriennummer, die einem Patienten zugeordnet sind.

Pflichtfelder

  • patientId: ID des Patienten
  • serialNumber: Seriennummer des Geräts
  • description: Beschreibung des Geräts

Wichtige Felder

  • articleId: Verknüpfung zum Artikel
  • articleNumber: ERP-Artikelnummer
  • commissioningDate: Datum der Inbetriebnahme
  • maintenances: Wartungsdaten

Hinweise

  • Die regionId wird automatisch vom Patienten übernommen.
  • Die _id wird automatisch generiert und darf nicht übergeben werden.
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
patientId
string

ID des Patienten, dem das Gerät zugeordnet ist.

regionId
string

ID der Region.

articleId
string

ID des zugrunde liegenden Artikels.

articleNumber
string

ERP Artikelnummer des Geräts.

serialNumber
string

Seriennummer des Geräts.

description
string

Beschreibung des Geräts.

additionalDescription
string

Zusätzliche Beschreibung.

locked
boolean

Gibt an, ob das Gerät gesperrt ist.

commissioningDate
string

Datum der Inbetriebnahme.

repairEstimateRequired
boolean

Gibt an, ob ein Kostenvoranschlag für Reparaturen erforderlich ist.

repairEstimateLimit
string

Kostengrenze für Kosenvoranschläge für Reparaturen.

lastBookingCode
string

Letzter Buchungscode.

lastLocationCode
string

Letzter Standortcode.

ownerName
string

Name des Eigentümers.

deviceNumber
string

Gerätenummer.

registerNumber
string

Registrierungsnummer des Geräts.

Array of objects (IDeviceMaintenanceLine)

Wartungsdaten des Geräts.

Array of objects (IDeviceInformationLine)

Zusätzliche Geräteinformationen.

_id
string

Eindeutige ID der Entität (UUID v4 als String).

Wird beim Erstellen automatisch generiert.

timestamp
string

Zeitstempel der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

archived
boolean

Markiert die Entität als archiviert (Soft-Delete).

Archivierte Entitäten werden nicht physisch gelöscht, sondern nur als archiviert markiert. Sie erscheinen nicht mehr in Standard-Abfragen.

createdAt
string

Zeitpunkt der Erstellung.

Wird beim Erstellen der Entität automatisch gesetzt.

createdBy
string

ID des Benutzers, der die Entität erstellt hat.

Referenziert einen Benutzer im System.

updatedAt
string

Zeitpunkt der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

updatedBy
string

ID des Benutzers, der die letzte Änderung vorgenommen hat.

Referenziert einen Benutzer im System.

Responses

Request samples

Content type
application/json
{
  • "patientId": "string",
  • "regionId": "string",
  • "articleId": "string",
  • "articleNumber": "string",
  • "serialNumber": "string",
  • "description": "string",
  • "additionalDescription": "string",
  • "locked": true,
  • "commissioningDate": "string",
  • "repairEstimateRequired": true,
  • "repairEstimateLimit": "string",
  • "lastBookingCode": "string",
  • "lastLocationCode": "string",
  • "ownerName": "string",
  • "deviceNumber": "string",
  • "registerNumber": "string",
  • "maintenances": [
    ],
  • "deviceInformationLines": [
    ],
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "serialNumber": "string",
  • "updated": 0
}

Gerät aktualisieren

Aktualisiert ein bestehendes medizinisches Gerät.

Pflichtfelder

  • patientId: ID des Patienten
  • serialNumber: Seriennummer des Geräts
  • description: Beschreibung des Geräts

Hinweise

  • Die regionId wird automatisch vom Patienten übernommen.
Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Die UUID des Geräts (Alberta _id).

Request Body schema: application/json
required
patientId
string

ID des Patienten, dem das Gerät zugeordnet ist.

regionId
string

ID der Region.

articleId
string

ID des zugrunde liegenden Artikels.

articleNumber
string

ERP Artikelnummer des Geräts.

serialNumber
string

Seriennummer des Geräts.

description
string

Beschreibung des Geräts.

additionalDescription
string

Zusätzliche Beschreibung.

locked
boolean

Gibt an, ob das Gerät gesperrt ist.

commissioningDate
string

Datum der Inbetriebnahme.

repairEstimateRequired
boolean

Gibt an, ob ein Kostenvoranschlag für Reparaturen erforderlich ist.

repairEstimateLimit
string

Kostengrenze für Kosenvoranschläge für Reparaturen.

lastBookingCode
string

Letzter Buchungscode.

lastLocationCode
string

Letzter Standortcode.

ownerName
string

Name des Eigentümers.

deviceNumber
string

Gerätenummer.

registerNumber
string

Registrierungsnummer des Geräts.

Array of objects (IDeviceMaintenanceLine)

Wartungsdaten des Geräts.

Array of objects (IDeviceInformationLine)

Zusätzliche Geräteinformationen.

_id
string

Eindeutige ID der Entität (UUID v4 als String).

Wird beim Erstellen automatisch generiert.

timestamp
string

Zeitstempel der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

archived
boolean

Markiert die Entität als archiviert (Soft-Delete).

Archivierte Entitäten werden nicht physisch gelöscht, sondern nur als archiviert markiert. Sie erscheinen nicht mehr in Standard-Abfragen.

createdAt
string

Zeitpunkt der Erstellung.

Wird beim Erstellen der Entität automatisch gesetzt.

createdBy
string

ID des Benutzers, der die Entität erstellt hat.

Referenziert einen Benutzer im System.

updatedAt
string

Zeitpunkt der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

updatedBy
string

ID des Benutzers, der die letzte Änderung vorgenommen hat.

Referenziert einen Benutzer im System.

Responses

Request samples

Content type
application/json
{
  • "patientId": "string",
  • "regionId": "string",
  • "articleId": "string",
  • "articleNumber": "string",
  • "serialNumber": "string",
  • "description": "string",
  • "additionalDescription": "string",
  • "locked": true,
  • "commissioningDate": "string",
  • "repairEstimateRequired": true,
  • "repairEstimateLimit": "string",
  • "lastBookingCode": "string",
  • "lastLocationCode": "string",
  • "ownerName": "string",
  • "deviceNumber": "string",
  • "registerNumber": "string",
  • "maintenances": [
    ],
  • "deviceInformationLines": [
    ],
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "serialNumber": "string",
  • "updated": 0
}

Direktbestellung

Endpunkte zur Verwaltung von Direktbestellungen (einmalige Bestellungen ohne Versorgungsbezug).

Liste von Direktbestellungen abrufen

Ruft eine Liste von Direktbestellungen basierend auf dem Status und einem Zeitstempel ab.

Konzept: DirectOrder vs. SingleOrder

Eine DirectOrder ist eine einmalige oder ad-hoc Bestellung ohne Bezug zu einer IntegratedCare (Versorgung). Sie wird typischerweise für außerplanmäßige Lieferungen verwendet.

Im Gegensatz dazu ist eine SingleOrder immer mit einer IntegratedCare verknüpft und Teil einer laufenden Dauerversorgung.

Typischer Synchronisations-Workflow

  1. Neue Direktbestellungen abholen: GET /directOrder?status=created&updatedAfter=...
  2. Bestellung im ERP verarbeiten
  3. Status zurückmelden: PATCH /directOrder/{id} mit neuem status

Synchronisation

Dieser Endpunkt ist für die inkrementelle Synchronisation mit ERP-Systemen konzipiert. Die Parameter updatedAfter und status sind beide Pflicht. Weitere Parameter sind nicht erlaubt.

Änderungen, die über die API selbst vorgenommen wurden, werden bei der Synchronisation ignoriert, um Endlosschleifen zu vermeiden.

Antwort-Modifikationen

  • therapyId und therapyTypeId werden als Zahlen zurückgegeben
Authorizations:
ApiKeyAuth
query Parameters
status
required
string
Enum: "created" "transmitted" "updated" "archived"
Example: status=created

Filtert Direktbestellungen nach ihrem Änderungsstatus:

  • created: Neue Direktbestellungen, bereit zur Abholung durch das ERP-System
  • transmitted: Bereits an das ERP übermittelt
  • updated: Geänderte Direktbestellungen
  • archived: Archivierte/gelöschte Direktbestellungen (Soft-Delete)
updatedAfter
required
string <date-time>
Example: updatedAfter=2025-01-01T00:00:00.000Z

ISO 8601 Zeitstempel. Nur Direktbestellungen, die nach diesem Zeitpunkt geändert wurden, werden zurückgegeben.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Direktbestellung aktualisieren

Aktualisiert eine bestehende Direktbestellung.

Typische Anwendungsfälle

  • Rückmeldung der ERP-Nummer (salesId) nach erfolgreicher Verarbeitung
  • Statusänderungen

Business Logik

  • Bei Statusänderungen werden Pflichtfelder validiert.

Hinweis

Query-Parameter sind bei PATCH nicht erlaubt.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Die UUID der Direktbestellung (Alberta _id).

Request Body schema: application/json
required
regionId
string

ID der Region, der der Auftrag zugeordnet ist.

salesId
string

Id des Auftrag im ERP-System des Kunden

patientId
string

ID des Patienten, für den der Auftrag erstellt wurde.

creationDate
string

Erstellungsdatum des Auftrags.

deliveryDate
string

Geplantes Lieferdatum.

deliveryInformation
string

Zusätzliche Lieferinformationen.

status
number (OrderStatus)
Enum: -3 -2 -1 0 1 2 3 4 5 6 7 8 9 10

Status einer Bestellung.

Definiert den Lebenszyklus einer Bestellung von der Erstellung bis zur Lieferung. Nicht alle Statusänderungen sind erlaubt. Erlaubte Statusübergänge: | Von Status | Erlaubte Zielstatus | |------------|---------------------| | Created | Alle Status (inkl. Deleted) | | Pending | Alle außer Created, Deleted, Pending | | Canceled | Alle außer Created, Deleted, Pending, Canceled | | Deleted | Keine (Endstatus) | | Alle anderen | Alle außer Created, Deleted, Pending | Wichtige Regeln:

  • Deleted ist ein Endstatus - keine weiteren Änderungen möglich
  • Nur von Created kann zu Deleted gewechselt werden
  • Created ist der einzige Status, der zu Pending wechseln kann
Wert Name Beschreibung
-3 Pending Bestellung ist ausstehend/wartend.
-2 Canceled Bestellung wurde storniert.
-1 Deleted Bestellung wurde gelöscht (Endstatus).
0 Created Bestellung wurde erstellt.
1 Transmitted Bestellung wurde an das ERP-System übermittelt.
2 Transmission_failure Übermittlung an das ERP-System ist fehlgeschlagen.
3 Processed Bestellung wurde im ERP-System verarbeitet.
4 Sent Bestellung wurde versendet.
5 Delivered Bestellung wurde geliefert.
6 OrderStopped Bestellung wurde gestoppt.
7 ErpCall ERP-Aufruf erfolgt.
8 InProgress Bestellung ist in Bearbeitung.
9 Progressed Bestellung wurde weitergeleitet.
10 PartiallySent Bestellung wurde teilweise versendet.
annotation
string

Anmerkungen zum Auftrag.

orderType
number (OrderType)
Enum: 0 1 2

Typ einer Bestellung.

Unterscheidet zwischen Erst-, Folge- und Mitarbeiterbestellungen.

Wert Name Beschreibung
0 Initial Erstbestellung.
1 Followup Folgebestellung.
2 Staff Mitarbeiterbestellung.
transmittedAt
string

Zeitpunkt der Verarbeitung durch das Backend.

ISO-String-Datum, wann der Auftrag vom Order-Backend verarbeitet wurde.

deliveryOption
string
_id
string

Eindeutige ID der Entität (UUID v4 als String).

Wird beim Erstellen automatisch generiert.

timestamp
string

Zeitstempel der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

archived
boolean

Markiert die Entität als archiviert (Soft-Delete).

Archivierte Entitäten werden nicht physisch gelöscht, sondern nur als archiviert markiert. Sie erscheinen nicht mehr in Standard-Abfragen.

createdAt
string

Zeitpunkt der Erstellung.

Wird beim Erstellen der Entität automatisch gesetzt.

createdBy
string

ID des Benutzers, der die Entität erstellt hat.

Referenziert einen Benutzer im System.

updatedAt
string

Zeitpunkt der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

updatedBy
string

ID des Benutzers, der die letzte Änderung vorgenommen hat.

Referenziert einen Benutzer im System.

Array of objects (IDirectOrderedArticleLineExternal)

Liste der bestellten Artikelzeilen.

object (IDirectOrderDeliveryAddressExternal)

Lieferadresse für die externe API (Direktbestellung).

Responses

Request samples

Content type
application/json
{
  • "salesId": "ERP-DIRECT-12345"
}

Response samples

Content type
application/json
{
  • "regionId": "string",
  • "salesId": "string",
  • "patientId": "string",
  • "creationDate": "string",
  • "deliveryDate": "string",
  • "deliveryInformation": "string",
  • "status": -3,
  • "annotation": "string",
  • "orderType": 0,
  • "transmittedAt": "string",
  • "deliveryOption": "string",
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string",
  • "orderedArticleLines": [
    ],
  • "deliveryAddress": {
    }
}

ERP-Auftrag

Endpunkte zur Rückmeldung von Lieferinformationen aus dem ERP-System an Alberta.

ERP-Aufträge auflisten

Listet ERP-Aufträge auf.

Konzept: ERP-Order

ERP-Aufträge werden verwendet, um Lieferinformationen vom ERP-System an Alberta zurückzumelden. Sie enthalten Informationen über ausgelieferte Artikel, Tracking-Daten und Versanddaten.

Typischer Workflow

  1. POST /erpOrder: Neuen ERP-Auftrag anlegen (nach Versand im ERP)
  2. PUT /erpOrder/{salesId}: Bestehenden ERP-Auftrag aktualisieren (z.B. Tracking-Informationen ergänzen)
Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ERP-Auftrag erstellen

Erstellt einen neuen ERP-Auftrag.

Pflichtfelder

  • salesId: Auftrags-ID im ERP-System (muss eindeutig sein)
  • patientId: ID des zugehörigen Patienten
  • outboundDate: Auslieferungsdatum
  • deliveryAddress: Lieferadresse
  • erpOrderedArticleLines: Mindestens eine Artikelzeile

Hinweise

  • Die regionId wird automatisch vom Patienten übernommen.
  • Ein Auftrag mit derselben salesId darf nicht bereits existieren.
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
_id
required
string

Eindeutige ID der Entität (UUID v4 als String).

Wird beim Erstellen automatisch generiert.

timestamp
required
string <date-time>

Zeitstempel der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

archived
required
boolean

Markiert die Entität als archiviert (Soft-Delete).

Archivierte Entitäten werden nicht physisch gelöscht, sondern nur als archiviert markiert. Sie erscheinen nicht mehr in Standard-Abfragen.

patientId
required
string

ID des Patienten.

regionId
required
string

ID der Region.

therapyId
required
number

ID der Therapie.

salesId
required
string

Id des Auftrag im ERP-System des Kunden

required
object (IDeliveryAddress)

Lieferadresse.

Erweitert {@link IAddress } für Lieferadressen bei Bestellungen.

outboundDate
required
string <date-time>

Versanddatum.

required
Array of objects (IErpOrderedArticleLine)

Bestellte Artikelzeilen.

annotation
required
string

Anmerkung.

prescriptionStatus
required
string

Rezeptstatus.

completed
required
boolean

Gibt an, ob die Bestellung abgeschlossen ist.

trackingLink
required
string

Link zur Sendungsverfolgung.

required
Array of objects (ITrackingInfo)

Tracking-Informationen.

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "archived": true,
  • "patientId": "string",
  • "regionId": "string",
  • "therapyId": 0,
  • "salesId": "string",
  • "deliveryAddress": {
    },
  • "outboundDate": "2019-08-24T14:15:22Z",
  • "erpOrderedArticleLines": [
    ],
  • "annotation": "string",
  • "prescriptionStatus": "string",
  • "completed": true,
  • "trackingLink": "string",
  • "trackingInfo": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "archived": true,
  • "patientId": "string",
  • "regionId": "string",
  • "therapyId": 0,
  • "salesId": "string",
  • "deliveryAddress": {
    },
  • "outboundDate": "2019-08-24T14:15:22Z",
  • "erpOrderedArticleLines": [
    ],
  • "annotation": "string",
  • "prescriptionStatus": "string",
  • "completed": true,
  • "trackingLink": "string",
  • "trackingInfo": [
    ]
}

ERP-Auftrag aktualisieren

Aktualisiert einen bestehenden ERP-Auftrag anhand seiner salesId.

Pflichtfelder

  • patientId: ID des zugehörigen Patienten
  • outboundDate: Auslieferungsdatum
  • deliveryAddress: Lieferadresse
  • erpOrderedArticleLines: Mindestens eine Artikelzeile

Hinweise

  • Die id im Pfad entspricht der salesId des ERP-Auftrags.
  • Die regionId wird automatisch vom Patienten übernommen.
Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: ERP-12345

Die salesId des ERP-Auftrags (ID im ERP-System).

Request Body schema: application/json
required
_id
required
string

Eindeutige ID der Entität (UUID v4 als String).

Wird beim Erstellen automatisch generiert.

timestamp
required
string <date-time>

Zeitstempel der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

archived
required
boolean

Markiert die Entität als archiviert (Soft-Delete).

Archivierte Entitäten werden nicht physisch gelöscht, sondern nur als archiviert markiert. Sie erscheinen nicht mehr in Standard-Abfragen.

patientId
required
string

ID des Patienten.

regionId
required
string

ID der Region.

therapyId
required
number

ID der Therapie.

salesId
required
string

Id des Auftrag im ERP-System des Kunden

required
object (IDeliveryAddress)

Lieferadresse.

Erweitert {@link IAddress } für Lieferadressen bei Bestellungen.

outboundDate
required
string <date-time>

Versanddatum.

required
Array of objects (IErpOrderedArticleLine)

Bestellte Artikelzeilen.

annotation
required
string

Anmerkung.

prescriptionStatus
required
string

Rezeptstatus.

completed
required
boolean

Gibt an, ob die Bestellung abgeschlossen ist.

trackingLink
required
string

Link zur Sendungsverfolgung.

required
Array of objects (ITrackingInfo)

Tracking-Informationen.

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "archived": true,
  • "patientId": "string",
  • "regionId": "string",
  • "therapyId": 0,
  • "salesId": "string",
  • "deliveryAddress": {
    },
  • "outboundDate": "2019-08-24T14:15:22Z",
  • "erpOrderedArticleLines": [
    ],
  • "annotation": "string",
  • "prescriptionStatus": "string",
  • "completed": true,
  • "trackingLink": "string",
  • "trackingInfo": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "archived": true,
  • "patientId": "string",
  • "regionId": "string",
  • "therapyId": 0,
  • "salesId": "string",
  • "deliveryAddress": {
    },
  • "outboundDate": "2019-08-24T14:15:22Z",
  • "erpOrderedArticleLines": [
    ],
  • "annotation": "string",
  • "prescriptionStatus": "string",
  • "completed": true,
  • "trackingLink": "string",
  • "trackingInfo": [
    ]
}

Arzt

Endpunkte zur Abfrage von Ärzten.

Arzt abrufen

Ruft einen einzelnen Arzt anhand seiner ID ab.

Ärzte sind zentrale Akteure im Versorgungsprozess und werden als behandelnde Ärzte (primaryDoctorId) mit Patienten verknüpft.

Wichtige Felder

  • lifelongNumber: LANR (Lebenslange Arztnummer) - eindeutige Kennung
  • siteNumber: BSNR (Betriebsstättennummer)
Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Die UUID des Arztes (Alberta _id).

Responses

Response samples

Content type
application/json
{
  • "gender": 0,
  • "titleShort": "string",
  • "title": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "address": "string",
  • "postalCode": "string",
  • "city": "string",
  • "phone": "string",
  • "fax": "string",
  • "email": "string",
  • "emailPrescriptionRequest": "string",
  • "faxPrescriptionRequest": "string",
  • "website": "string",
  • "institution": {
    },
  • "lifelongNumber": "string",
  • "siteNumber": "string",
  • "albertaConnect": true,
  • "isKiwiUser": true,
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true
}

Ärzte auflisten

Listet Ärzte auf, gefiltert nach ID oder Änderungszeitstempel.

Ärzte sind zentrale Akteure im Versorgungsprozess und werden als behandelnde Ärzte (primaryDoctorId) mit Patienten verknüpft.

Wichtige Felder

  • lifelongNumber: LANR (Lebenslange Arztnummer) - eindeutige Kennung
  • siteNumber: BSNR (Betriebsstättennummer)

Abfragemöglichkeiten

Es muss genau einer der folgenden Parameter angegeben werden:

  • _id: Einzelnen Arzt per ID abrufen
  • updatedAfter: Alle seit dem Zeitstempel geänderten Ärzte

Mehrere Parameter gleichzeitig sind nicht erlaubt.

Authorizations:
ApiKeyAuth
query Parameters
_id
string
Example: _id=550e8400-e29b-41d4-a716-446655440000

UUID des Arztes. Alternativ zu updatedAfter.

updatedAfter
string <date-time>
Example: updatedAfter=2025-01-01T00:00:00.000Z

ISO 8601 Zeitstempel. Nur Ärzte, die nach diesem Zeitpunkt geändert wurden, werden zurückgegeben. Alternativ zu _id.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Pflegeheim

Endpunkte zur Abfrage von Pflegeheimen.

Pflegeheim abrufen

Ruft ein einzelnes Pflegeheim anhand seiner ID ab.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Die UUID des Pflegeheims.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "address": "string",
  • "postalCode": "string",
  • "city": "string",
  • "phone": "string",
  • "fax": "string",
  • "email": "string",
  • "website": "string",
  • "albertaConnect": true,
  • "isKiwiUser": true,
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true
}

Pflegeheime auflisten

Listet Pflegeheime auf, gefiltert nach ID oder Änderungszeitstempel. Es muss genau einer der Parameter _id oder updatedAfter angegeben werden.

Authorizations:
ApiKeyAuth
query Parameters
_id
string

UUID des Pflegeheims.

updatedAfter
string <date-time>
Example: updatedAfter=2025-01-01T00:00:00.000Z

ISO 8601 Zeitstempel für inkrementelle Synchronisation.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Pflegedienst

Endpunkte zur Abfrage von Pflegediensten.

Pflegedienst abrufen

Ruft einen einzelnen Pflegedienst anhand seiner ID ab.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Die UUID des Pflegedienstes.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "address": "string",
  • "postalCode": "string",
  • "city": "string",
  • "phone": "string",
  • "fax": "string",
  • "email": "string",
  • "website": "string",
  • "albertaConnect": true,
  • "isKiwiUser": true,
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true
}

Pflegedienste auflisten

Listet Pflegedienste auf, gefiltert nach ID oder Änderungszeitstempel. Es muss genau einer der Parameter _id oder updatedAfter angegeben werden.

Authorizations:
ApiKeyAuth
query Parameters
_id
string

UUID des Pflegedienstes.

updatedAfter
string <date-time>
Example: updatedAfter=2025-01-01T00:00:00.000Z

ISO 8601 Zeitstempel für inkrementelle Synchronisation.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Krankenhaus

Endpunkte zur Abfrage von Krankenhäusern.

Krankenhaus abrufen

Ruft ein einzelnes Krankenhaus anhand seiner ID ab.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Die UUID des Krankenhauses.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "address": "string",
  • "postalCode": "string",
  • "city": "string",
  • "phone": "string",
  • "fax": "string",
  • "email": "string",
  • "website": "string",
  • "albertaConnect": true,
  • "isKiwiUser": true,
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true
}

Krankenhäuser auflisten

Listet Krankenhäuser auf, gefiltert nach ID oder Änderungszeitstempel. Es muss genau einer der Parameter _id oder updatedAfter angegeben werden.

Authorizations:
ApiKeyAuth
query Parameters
_id
string

UUID des Krankenhauses.

updatedAfter
string <date-time>
Example: updatedAfter=2025-01-01T00:00:00.000Z

ISO 8601 Zeitstempel für inkrementelle Synchronisation.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Kostenträger

Endpunkte zur Abfrage von Kostenträgern (Krankenkassen).

Kostenträger abrufen

Ruft einen einzelnen Kostenträger anhand seiner ID ab.

Wichtige Felder

  • ikNumber: Institutionskennzeichen (IK-Nummer) - eindeutige Kennung
Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Die UUID des Kostenträgers.

Responses

Response samples

Content type
application/json
{
  • "type": 0,
  • "name": "string",
  • "phone": "string",
  • "email": "string",
  • "fax": "string",
  • "website": "string",
  • "ikNumber": "string",
  • "address": "string",
  • "postalCode": "string",
  • "city": "string",
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true
}

Kostenträger auflisten

Listet Kostenträger auf, gefiltert nach ID oder Änderungszeitstempel.

Wichtige Felder

  • ikNumber: Institutionskennzeichen (IK-Nummer) - eindeutige Kennung

Es muss genau einer der Parameter _id oder updatedAfter angegeben werden.

Authorizations:
ApiKeyAuth
query Parameters
_id
string

UUID des Kostenträgers.

updatedAfter
string <date-time>
Example: updatedAfter=2025-01-01T00:00:00.000Z

ISO 8601 Zeitstempel für inkrementelle Synchronisation.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Postleitzahl

Endpunkte zur Abfrage von Postleitzahlen.

Postleitzahl abrufen

Ruft eine einzelne Postleitzahl anhand ihrer ID ab.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Die UUID der Postleitzahl.

Responses

Response samples

Content type
application/json
{
  • "postalCode": "string",
  • "city": "string",
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true
}

Postleitzahlen auflisten

Listet Postleitzahlen auf, gefiltert nach ID, Änderungszeitstempel oder PLZ. Es muss genau einer der Parameter _id, updatedAfter oder postalCode angegeben werden.

Authorizations:
ApiKeyAuth
query Parameters
_id
string

UUID der Postleitzahl.

updatedAfter
string <date-time>
Example: updatedAfter=2025-01-01T00:00:00.000Z

ISO 8601 Zeitstempel für inkrementelle Synchronisation.

postalCode
string
Example: postalCode=12345

Postleitzahl zur Suche.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Apotheke

Endpunkte zur Abfrage von Apotheken.

Apotheke abrufen

Ruft eine einzelne Apotheke anhand ihrer ID ab.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Die UUID der Apotheke.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "address": "string",
  • "postalCode": "string",
  • "city": "string",
  • "phone": "string",
  • "fax": "string",
  • "email": "string",
  • "website": "string",
  • "albertaConnect": true,
  • "isKiwiUser": true,
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true
}

Apotheken auflisten

Listet Apotheken auf, gefiltert nach ID oder Änderungszeitstempel. Es muss genau einer der Parameter _id oder updatedAfter angegeben werden.

Authorizations:
ApiKeyAuth
query Parameters
_id
string

UUID der Apotheke.

updatedAfter
string <date-time>
Example: updatedAfter=2025-01-01T00:00:00.000Z

ISO 8601 Zeitstempel für inkrementelle Synchronisation.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Versorgung

Endpunkte zur Verwaltung von Versorgungen (IntegratedCare) - der Dauerversorgung eines Patienten.

Liste von Versorgungen abrufen

Ruft eine Liste von Versorgungen basierend auf dem Status und einem Zeitstempel ab.

Konzept: IntegratedCare (Versorgung)

Die IntegratedCare ist das zentrale Objekt für die Patientenversorgung. Sie bündelt alle Informationen zu einer spezifischen Therapie eines Patienten und verknüpft Artikel, Leistungen, Bestellungen und Dokumente.

Jede SingleOrder (Bestellung) ist mit einer IntegratedCare verknüpft.

proposedArticleLines

Die proposedArticleLines enthalten die Artikelzeilen, die als Vorlage für wiederkehrende Bestellungen dienen. Sie definieren, welche Artikel standardmäßig in einer Bestellung für diese Versorgung enthalten sind.

Jede Artikelzeile enthält:

  • articleId: Referenz zum Artikel
  • dosage: Dosierungsinformationen
  • periodStartDate/periodEndDate: Versorgungszeitraum
  • contractId: Kassenvertrag

CareProposalStatus - Erlaubte Werte

Wert Name Beschreibung
1 Active Versorgung ist aktiv
2 Inactive Versorgung ist inaktiv/beendet

Synchronisation

Dieser Endpunkt ist für die inkrementelle Synchronisation mit ERP-Systemen konzipiert. Die Parameter updatedAfter und status sind beide Pflicht. Weitere Parameter sind nicht erlaubt.

Antwort-Modifikationen

  • therapyId und therapyTypeId werden als Zahlen zurückgegeben
Authorizations:
ApiKeyAuth
query Parameters
status
required
string
Enum: "created" "transmitted" "deactivated" "archived"
Example: status=created

Filtert Versorgungen nach ihrem Änderungsstatus:

  • created: Neue Versorgungen, bereit zur Abholung durch das ERP-System
  • transmitted: Bereits an das ERP übermittelt
  • deactivated: Deaktivierte Versorgungen
  • archived: Archivierte/gelöschte Versorgungen (Soft-Delete)
updatedAfter
required
string <date-time>
Example: updatedAfter=2025-01-01T00:00:00.000Z

ISO 8601 Zeitstempel. Nur Versorgungen, die nach diesem Zeitpunkt geändert wurden, werden zurückgegeben.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Versorgung erstellen

Erstellt eine neue Versorgung für einen Patienten.

Pflichtfelder

  • patientId: UUID des Patienten
  • therapyId: Therapie-ID (Enum-Wert)
  • isInitialCare: Flag ob Erstversorgung

Business Logik

  • _id wird automatisch als UUID v4 generiert.
  • regionId wird automatisch vom Patienten übernommen.
  • standardCareProposalId wird automatisch ermittelt, falls nicht angegeben (basierend auf therapyId und therapyTypeId).

Antwort

Gibt nur _id und updated (Timestamp) zurück.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
salesId
string

Id des Auftrag im ERP-System des Kunden

patientId
string

ID des Patienten, dem diese Versorgung zugeordnet ist.

therapyId
number

Zugehörige Therapie. Wert ist der Enum-Wert aus {@link Therapy } .

therapyTypeId
number

Zugehöriger Therapietyp. Wert ist der Enum-Wert aus {@link TherapyType } .

location
number

Lokalisation der Versorgung (z.B. Wundlokalisation).

Wert entspricht areaId aus dem BodyPartService.

additionalLocations
Array of strings

Zusätzliche Lokalisationen bei Mehrfachversorgung.

Nur verfügbar wenn in der Konfiguration showServices aktiviert ist.

doctorId
string

ID des verordnenden Arztes.

pharmacyId
string

ID der beliefernden Apotheke.

isInitialCare
boolean

Gibt an, ob es sich um eine Erstversorgung handelt.

isMonthlyOrderActivated
boolean

Gibt an, ob die monatliche Bestellung aktiviert ist.

standardCareProposalId
string

ID des zugehörigen Standard-Versorgungsvorschlags.

Array of objects (IExtendedServiceLine)

Vorgeschlagene Leistungspositionen für diese Versorgung.

annotation
string

Anmerkungen zur Versorgung.

seriesStatus
number (SeriesStatus)
Enum: -3 0 1 2 3 4 5

Status einer Serienbestellung.

Definiert den Status von wiederkehrenden Bestellungen (Abo).

Wert Name Beschreibung
-3 Pending Serienbestellung ist ausstehend.
0 Created Serienbestellung wurde erstellt.
1 Transmitted Serienbestellung wurde übermittelt.
2 Transmission_failure Übermittlung ist fehlgeschlagen.
3 Processed Serienbestellung wurde verarbeitet.
4 Sent Serienbestellung wurde versendet.
5 Delivered Serienbestellung wurde geliefert.
aboStopped
boolean

Gibt an, ob das Abo gestoppt wurde.

startDate
string

Startdatum der Versorgung.

status
number (CareProposalStatus)
Enum: 1 2

Status einer Versorgung.

Definiert den Status einer Versorgung (IntegratedCare).

Wert Name Beschreibung
1 Active Versorgung ist aktiv.
2 Inactive Versorgung ist inaktiv/beendet.
deactivationReason
string

Grund für die Deaktivierung der Versorgung.

regionId
string

ID der Region, der die Versorgung zugeordnet ist.

object (IApplicationPlan)
Deprecated

Anwendungsplan für die Versorgung.

ICareProposalCalculation (object) or object

Berechnungen für die Versorgung (PE oder EE spezifisch).

object (ICareProposalMiscellaneous)
Deprecated

Sonstige Angaben für einen Versorgungsvorschlag.

permanentExceedMaxAmount
boolean

Gibt an, ob die Artikel Maximalmengen dauerhaft überschritten werden dürfen.

diagnose
string

Diagnose des Patienten für diese Versorgung.

stomaCreationDate
string

Datum der Stoma-Anlage (nur bei Stoma-Versorgungen).

_id
string

Eindeutige ID der Entität (UUID v4 als String).

Wird beim Erstellen automatisch generiert.

timestamp
string

Zeitstempel der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

archived
boolean

Markiert die Entität als archiviert (Soft-Delete).

Archivierte Entitäten werden nicht physisch gelöscht, sondern nur als archiviert markiert. Sie erscheinen nicht mehr in Standard-Abfragen.

createdAt
string

Zeitpunkt der Erstellung.

Wird beim Erstellen der Entität automatisch gesetzt.

createdBy
string

ID des Benutzers, der die Entität erstellt hat.

Referenziert einen Benutzer im System.

updatedAt
string

Zeitpunkt der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

updatedBy
string

ID des Benutzers, der die letzte Änderung vorgenommen hat.

Referenziert einen Benutzer im System.

Array of objects (IExtendedArticleLineExternal)

Vorgeschlagene Artikelzeilen der Versorgung.

Array of objects (ISeriesDataExternal)

Seriendaten für wiederkehrende Lieferungen.

Responses

Request samples

Content type
application/json
{
  • "patientId": "550e8400-e29b-41d4-a716-446655440000",
  • "therapyId": 1,
  • "therapyTypeId": 1,
  • "isInitialCare": true
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "updated": "2019-08-24T14:15:22Z"
}

Versorgung aktualisieren

Aktualisiert eine bestehende Versorgung.

Business Logik

  • regionId wird automatisch vom Patienten übernommen.
  • standardCareProposalId wird automatisch ermittelt, falls nicht angegeben.
  • seriesData wird intelligent mit bestehenden Daten zusammengeführt.
  • proposedArticleLines werden intelligent zusammengeführt (bestehende Zeilen behalten ihre _id).

Antwort

Gibt _id, salesId, updated, proposedArticleLines (mit ID-Mapping) und seriesData zurück.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Die UUID der Versorgung (Alberta _id).

Request Body schema: application/json
required
salesId
string

Id des Auftrag im ERP-System des Kunden

patientId
string

ID des Patienten, dem diese Versorgung zugeordnet ist.

therapyId
number

Zugehörige Therapie. Wert ist der Enum-Wert aus {@link Therapy } .

therapyTypeId
number

Zugehöriger Therapietyp. Wert ist der Enum-Wert aus {@link TherapyType } .

location
number

Lokalisation der Versorgung (z.B. Wundlokalisation).

Wert entspricht areaId aus dem BodyPartService.

additionalLocations
Array of strings

Zusätzliche Lokalisationen bei Mehrfachversorgung.

Nur verfügbar wenn in der Konfiguration showServices aktiviert ist.

doctorId
string

ID des verordnenden Arztes.

pharmacyId
string

ID der beliefernden Apotheke.

isInitialCare
boolean

Gibt an, ob es sich um eine Erstversorgung handelt.

isMonthlyOrderActivated
boolean

Gibt an, ob die monatliche Bestellung aktiviert ist.

standardCareProposalId
string

ID des zugehörigen Standard-Versorgungsvorschlags.

Array of objects (IExtendedServiceLine)

Vorgeschlagene Leistungspositionen für diese Versorgung.

annotation
string

Anmerkungen zur Versorgung.

seriesStatus
number (SeriesStatus)
Enum: -3 0 1 2 3 4 5

Status einer Serienbestellung.

Definiert den Status von wiederkehrenden Bestellungen (Abo).

Wert Name Beschreibung
-3 Pending Serienbestellung ist ausstehend.
0 Created Serienbestellung wurde erstellt.
1 Transmitted Serienbestellung wurde übermittelt.
2 Transmission_failure Übermittlung ist fehlgeschlagen.
3 Processed Serienbestellung wurde verarbeitet.
4 Sent Serienbestellung wurde versendet.
5 Delivered Serienbestellung wurde geliefert.
aboStopped
boolean

Gibt an, ob das Abo gestoppt wurde.

startDate
string

Startdatum der Versorgung.

status
number (CareProposalStatus)
Enum: 1 2

Status einer Versorgung.

Definiert den Status einer Versorgung (IntegratedCare).

Wert Name Beschreibung
1 Active Versorgung ist aktiv.
2 Inactive Versorgung ist inaktiv/beendet.
deactivationReason
string

Grund für die Deaktivierung der Versorgung.

regionId
string

ID der Region, der die Versorgung zugeordnet ist.

object (IApplicationPlan)
Deprecated

Anwendungsplan für die Versorgung.

ICareProposalCalculation (object) or object

Berechnungen für die Versorgung (PE oder EE spezifisch).

object (ICareProposalMiscellaneous)
Deprecated

Sonstige Angaben für einen Versorgungsvorschlag.

permanentExceedMaxAmount
boolean

Gibt an, ob die Artikel Maximalmengen dauerhaft überschritten werden dürfen.

diagnose
string

Diagnose des Patienten für diese Versorgung.

stomaCreationDate
string

Datum der Stoma-Anlage (nur bei Stoma-Versorgungen).

_id
string

Eindeutige ID der Entität (UUID v4 als String).

Wird beim Erstellen automatisch generiert.

timestamp
string

Zeitstempel der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

archived
boolean

Markiert die Entität als archiviert (Soft-Delete).

Archivierte Entitäten werden nicht physisch gelöscht, sondern nur als archiviert markiert. Sie erscheinen nicht mehr in Standard-Abfragen.

createdAt
string

Zeitpunkt der Erstellung.

Wird beim Erstellen der Entität automatisch gesetzt.

createdBy
string

ID des Benutzers, der die Entität erstellt hat.

Referenziert einen Benutzer im System.

updatedAt
string

Zeitpunkt der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

updatedBy
string

ID des Benutzers, der die letzte Änderung vorgenommen hat.

Referenziert einen Benutzer im System.

Array of objects (IExtendedArticleLineExternal)

Vorgeschlagene Artikelzeilen der Versorgung.

Array of objects (ISeriesDataExternal)

Seriendaten für wiederkehrende Lieferungen.

Responses

Request samples

Content type
application/json
{
  • "salesId": "ERP-IC-12345",
  • "proposedArticleLines": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "salesId": "string",
  • "updated": "2019-08-24T14:15:22Z",
  • "proposedArticleLines": [
    ],
  • "seriesData": [
    ]
}

Patientenhistorie

Endpunkte zur Abfrage der Patientenhistorie.

Patientenhistorie abrufen

Ruft einen einzelnen Patientenhistorie-Eintrag anhand seiner ID ab.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Die UUID des Patientenhistorie-Eintrags (Alberta _id).

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "createdBy": "string",
  • "createdAt": "string",
  • "entity": "string",
  • "entityId": "string",
  • "therapy": "string",
  • "therapyType": "string",
  • "woundLocation": "string"
}

Patientenhistorie auflisten

Listet Patientenhistorie-Einträge auf, gefiltert nach Änderungszeitstempel.

Hinweise

  • Archivierte Einträge werden nicht zurückgegeben.
Authorizations:
ApiKeyAuth
query Parameters
updatedAfter
required
string <date-time>
Example: updatedAfter=2025-01-01T00:00:00.000Z

ISO 8601 Zeitstempel. Nur Einträge, die nach diesem Zeitpunkt geändert wurden, werden zurückgegeben.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Patientennotiz

Endpunkte zur Verwaltung von Patientennotizen.

Patientennotizen auflisten

Listet Patientennotizen auf, gefiltert nach Patient oder Änderungszeitstempel.

Abfragemöglichkeiten

Es muss genau einer der folgenden Parameter angegeben werden:

  • patientId: Alle Notizen eines Patienten
  • updatedAfter: Alle seit dem Zeitstempel geänderten Notizen

Wichtige Felder

  • noteText: Inhalt der Notiz
  • status: Status der Notiz
  • patientId: Zugehöriger Patient
Authorizations:
ApiKeyAuth
query Parameters
patientId
string
Example: patientId=550e8400-e29b-41d4-a716-446655440000

UUID des Patienten. Alternativ zu updatedAfter.

updatedAfter
string <date-time>
Example: updatedAfter=2025-01-01T00:00:00.000Z

ISO 8601 Zeitstempel. Nur Notizen, die nach diesem Zeitpunkt geändert wurden, werden zurückgegeben. Alternativ zu patientId.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Patientennotiz erstellen

Erstellt eine neue Patientennotiz.

Pflichtfelder

  • noteText: Inhalt der Notiz
  • status: Status der Notiz
  • patientId: ID des zugehörigen Patienten

Hinweise

  • Die regionId wird automatisch vom Patienten übernommen.
  • Die _id wird automatisch generiert und darf nicht übergeben werden.
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
noteText
string

Text der Notiz.

patientId
string

ID des Patienten.

regionId
string

ID der Region.

createdAt
string

Erstellungszeitpunkt.

updatedAt
string

Zeitpunkt der letzten Bearbeitung.

createdBy
string

ID des Erstellers.

updatedBy
string

ID des letzten Bearbeiters.

edited
boolean

Gibt an, ob die Notiz bearbeitet wurde.

status
number (NoteType)
Enum: 1 2 3

Typ einer Notiz.

Definiert die verschiedenen Arten von Patientennotizen. Steuert, wie die Notiz im Patientenüberblick angezeigt wird.

Wert Name Beschreibung
1 Note Normale Notiz.
2 Information Information.
3 Warning Warnung/Wichtiger Hinweis.
_id
string

Eindeutige ID der Entität (UUID v4 als String).

Wird beim Erstellen automatisch generiert.

timestamp
string

Zeitstempel der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

archived
boolean

Markiert die Entität als archiviert (Soft-Delete).

Archivierte Entitäten werden nicht physisch gelöscht, sondern nur als archiviert markiert. Sie erscheinen nicht mehr in Standard-Abfragen.

Responses

Request samples

Content type
application/json
{
  • "noteText": "string",
  • "patientId": "string",
  • "regionId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "edited": true,
  • "status": 1,
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true
}

Response samples

Content type
application/json
{
  • "noteText": "string",
  • "patientId": "string",
  • "regionId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "edited": true,
  • "status": 1,
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true
}

Patientennotiz aktualisieren

Aktualisiert eine bestehende Patientennotiz.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Die UUID der Patientennotiz (Alberta _id).

Request Body schema: application/json
required
noteText
string

Text der Notiz.

patientId
string

ID des Patienten.

regionId
string

ID der Region.

createdAt
string

Erstellungszeitpunkt.

updatedAt
string

Zeitpunkt der letzten Bearbeitung.

createdBy
string

ID des Erstellers.

updatedBy
string

ID des letzten Bearbeiters.

edited
boolean

Gibt an, ob die Notiz bearbeitet wurde.

status
number (NoteType)
Enum: 1 2 3

Typ einer Notiz.

Definiert die verschiedenen Arten von Patientennotizen. Steuert, wie die Notiz im Patientenüberblick angezeigt wird.

Wert Name Beschreibung
1 Note Normale Notiz.
2 Information Information.
3 Warning Warnung/Wichtiger Hinweis.
_id
string

Eindeutige ID der Entität (UUID v4 als String).

Wird beim Erstellen automatisch generiert.

timestamp
string

Zeitstempel der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

archived
boolean

Markiert die Entität als archiviert (Soft-Delete).

Archivierte Entitäten werden nicht physisch gelöscht, sondern nur als archiviert markiert. Sie erscheinen nicht mehr in Standard-Abfragen.

Responses

Request samples

Content type
application/json
{
  • "noteText": "string",
  • "patientId": "string",
  • "regionId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "edited": true,
  • "status": 1,
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true
}

Response samples

Content type
application/json
{
  • "noteText": "string",
  • "patientId": "string",
  • "regionId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "edited": true,
  • "status": 1,
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true
}

Patient

Endpunkte zur Verwaltung von Patientenstammdaten.

Liste von Patienten abrufen

Ruft eine Liste von Patienten basierend auf dem Status und einem Zeitstempel ab.

Wichtige Felder

  • customerId: ERP-spezifische Kundennummer (für Synchronisation)
  • firstName, lastName: Name des Patienten (Pflichtfelder)
  • address: Adressdaten (Pflichtfeld)
  • primaryDoctorId: Behandelnder Arzt (nicht Hausarzt!)
  • regionId: Zuordnung zur Region
  • fieldNurseId: Zuständiger Außendienstmitarbeiter

Synchronisation

Dieser Endpunkt ist für die inkrementelle Synchronisation mit ERP-Systemen konzipiert. Die Parameter status und updatedAfter sind beide Pflicht.

Änderungen, die über die API selbst vorgenommen wurden, werden bei der Synchronisation ignoriert, um Endlosschleifen zu vermeiden.

Authorizations:
ApiKeyAuth
query Parameters
status
required
string
Enum: "created" "updated" "archived"
Example: status=updated

Filtert Patienten nach ihrem Änderungsstatus:

  • created: Neue Patienten (noch keine customerId vorhanden). Bereit zur Abholung.
  • updated: Geänderte Patienten (haben bereits eine customerId).
  • archived: Archivierte/gelöschte Patienten (Soft-Delete).
updatedAfter
required
string <date-time>
Example: updatedAfter=2025-01-01T00:00:00.000Z

ISO 8601 Zeitstempel. Nur Patienten, die nach diesem Zeitpunkt geändert wurden, werden zurückgegeben.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Neuen Patienten anlegen

Erstellt einen neuen Patientendatensatz.

Pflichtfelder

  • firstName, lastName: Name des Patienten
  • address: Adressdaten

Business Logik

  • Prüft auf Duplikate basierend auf customerId oder Kombination aus firstName, lastName und birthday.
  • Generiert automatisch IDs für den Patienten und zugehörige Objekte (z.B. Betreuer).
  • Lädt fehlende PLZ-IDs nach.

Automatisch generierte Felder

  • _id: Wird automatisch als UUID v4 generiert
  • careGivers[*]._id: Werden automatisch generiert
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
city
string

Wohnort des Patienten.

postalCode
string

Postleitzahl des Wohnorts.

additionalAddress
string

Adresszusatz (z.B. Stockwerk, Zimmernummer).

additionalAddress2
string

Zweiter Adresszusatz.

gender
number (Gender)
Enum: 0 1 2 3

Geschlecht einer Person.

Wird für Patienten, Pflegepersonen und andere Personen verwendet.

Wert Name Beschreibung
0 Unknown Unbekannt
1 Female Weiblich
2 Male Männlich
3 Other Divers
title
number (Title)
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

Titel/Anrede einer Person.

Akademische Titel und Berufsbezeichnungen für Personen und Institutionen.

Wert Name Beschreibung
0 Unknown Unbekannt
1 Doctor Dr.
2 ProfDoctor Prof. Dr.
3 DiplEngineer Dipl. Ing.
4 DiplDoctor Dipl. med.
5 DiplPsych Dipl. Psych.
6 DoctorDoctor Dr. Dr.
7 DoctorMed Dr. med.
8 ProfDoctorDoctor Prof. Dr. Dr.
9 Prof Prof.
10 ProfDoctorMed Prof. Dr. med.
11 Lawyer Rechtsanwalt
12 FemaleLawyer Rechtsanwältin
13 Sister Schwester
14 DoctorJur Dr. jur.
15 Company Firma
16 Baroness Freifrau
17 Baron Freiherr
18 JointPractice Gemeinschaftspraxis
19 Practice Praxis
20 PrivateLecturerDoctorMed Priv.-Doz. Dr. med.
customerId
string

Externe Kundennummer aus dem ERP-System.

Dieses Feld wird zur Synchronisation mit externen ERP-Systemen verwendet. Es muss pro Mandant eindeutig sein.

birthday
string

Geburtsdatum des Patienten.

fieldNurseId
string

ID des zuständigen Außendienstmitarbeiters.

Referenziert einen Außendienstmitarbeiter (_id aus {@link IUser } )

regionId
string

ID der Region, der der Patient zugeordnet ist.

payerInstitutionCode
string

IK-Nummer (Institutionskennzeichen) des Kostenträgers.

Eindeutige Kennung der Krankenkasse.

primaryDoctorId
string

ID des behandelnden Arztes.

nursingHomeId
string

ID des Pflegeheims.

nursingServiceId
string

ID des Pflegedienstes.

deactivationReason
number (PatientDeactivationReason)
Enum: 0 1 2 3 4

Grund für die Deaktivierung eines Patienten.

Definiert die möglichen Gründe, warum ein Patient deaktiviert wurde.

Wert Name Beschreibung
0 Unknown Unbekannter Grund.
1 Dead Patient ist verstorben.
2 EndOfTherapy Therapie wurde beendet.
3 ChangeOfSupplier Wechsel des Leistungserbringers.
4 Other Sonstiger Grund.
deactivationDate
string

Datum der Deaktivierung.

deactivationComment
string

Kommentar zur Deaktivierung.

nextVisit
string

Datum des nächsten geplanten Besuchs.

ivTherapy
boolean

Gibt an, ob der Patient eine IV-Therapie erhält.

classification
string

Debitorenklasse des Patienten.

pharmacyId
string

ID der zugeordneten Apotheke.

changeInSupplier
boolean

Gibt an, ob ein Lieferantenwechsel stattgefunden hat (Umversorgungs-Patient)

object (IPatientBillingAddress)

Rechnungsadresse eines Patienten.

object (IAddress)

Adresse für Lieferungen und Kontakte.

Allgemeine Adressstruktur, die für Lieferadressen, Rechnungsadressen und Kontaktadressen verwendet wird.

comment
string

Allgemeiner Kommentar zum Patienten.

erpStatus
string (ErpStatus)
Enum: "Liefersperre" "Komplettsperre"

ERP-Sperrstatus für Patienten.

Definiert Sperrstatus, die aus dem ERP-System kommen.

Wert Name Beschreibung
"Liefersperre" deliveryBlocked Liefersperre - Patient darf keine Lieferungen erhalten.
"Komplettsperre" allBlocked Komplettsperre - Patient ist vollständig gesperrt.
object (IDeliveryInformation)

Lieferinformationen für einen Patienten.

Enthält Informationen zur Lieferung wie Startzeit der Belieferung und Hinweise.

additionalUserId
string

ID eines zusätzlichen zuständigen Außendienstmitarbeiters.

Referenziert einen Außendienstmitarbeiter (IUser._id).

additionalUserIds
Array of strings

IDs weiterer zuständiger Außendienstmitarbeiter.

Referenziert mehrere Außendienstmitarbeiter (IUser._id).

careDegree
number
Enum: 1 2 3 4 5

Pflegegrad des Patienten (1-5).

Einstufung nach SGB XI.

calorieDemand
number

Kalorienbedarf des Patienten.

dashboardInfo
Array of strings

Informationen für die Anzeige im Überblick des Patienten.

status
string

Status des Patienten. Konfigurierbar. Die für den Mandanten gültigen Werte beim Support erfragen.

additionalAttributes
object

Zusätzliche mandantenspezifische Attribute.

Flexibles Feld für kundenspezifische Erweiterungen.

object (IPatientReferrer)

Repräsentiert den Überweiser/Zuweiser eines Patienten.

Der Überweiser ist die Institution oder Person, die den Patienten an den Homecare-Anbieter vermittelt hat (z.B. Krankenhaus, Arzt, Pflegedienst).

specializedServiceProviderBranchId
string

ID der zugeordneten Filiale des spezialisierten Leistungserbringers.

firstName
string

Vorname der Person.

lastName
string

Nachname der Person.

address
string

Straße und Hausnummer.

phone
string

Festnetz-Telefonnummer.

mobilePhone
string

Mobiltelefonnummer.

email
string

E-Mail-Adresse.

fax
string

Faxnummer.

_id
string

Eindeutige ID der Entität (UUID v4 als String).

Wird beim Erstellen automatisch generiert.

timestamp
string

Zeitstempel der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

archived
boolean

Markiert die Entität als archiviert (Soft-Delete).

Archivierte Entitäten werden nicht physisch gelöscht, sondern nur als archiviert markiert. Sie erscheinen nicht mehr in Standard-Abfragen.

createdAt
string

Zeitpunkt der Erstellung.

Wird beim Erstellen der Entität automatisch gesetzt.

createdBy
string

ID des Benutzers, der die Entität erstellt hat.

Referenziert einen Benutzer im System.

updatedAt
string

Zeitpunkt der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

updatedBy
string

ID des Benutzers, der die letzte Änderung vorgenommen hat.

Referenziert einen Benutzer im System.

object (IPatientPayerRelationExternal)

Kostenträger-Relation für die externe API.

object (IPatientHospitalRelationExternal)

Krankenhaus-Relation für die externe API.

Array of objects (ICareGiverExternal)

Liste der Angehörigen/Betreuer.

Responses

Request samples

Content type
application/json
{
  • "city": "string",
  • "postalCode": "string",
  • "additionalAddress": "string",
  • "additionalAddress2": "string",
  • "gender": 0,
  • "title": 0,
  • "customerId": "string",
  • "birthday": "string",
  • "fieldNurseId": "string",
  • "regionId": "string",
  • "payerInstitutionCode": "string",
  • "primaryDoctorId": "string",
  • "nursingHomeId": "string",
  • "nursingServiceId": "string",
  • "deactivationReason": 0,
  • "deactivationDate": "string",
  • "deactivationComment": "string",
  • "nextVisit": "string",
  • "ivTherapy": true,
  • "classification": "string",
  • "pharmacyId": "string",
  • "changeInSupplier": true,
  • "billingAddress": {
    },
  • "deliveryAddress": {
    },
  • "comment": "string",
  • "erpStatus": "Liefersperre",
  • "deliveryInformation": {
    },
  • "additionalUserId": "string",
  • "additionalUserIds": [
    ],
  • "careDegree": 1,
  • "calorieDemand": 0,
  • "dashboardInfo": [
    ],
  • "status": "string",
  • "additionalAttributes": { },
  • "referrer": {
    },
  • "specializedServiceProviderBranchId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "address": "string",
  • "phone": "string",
  • "mobilePhone": "string",
  • "email": "string",
  • "fax": "string",
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string",
  • "payer": {
    },
  • "hospital": {
    },
  • "careGivers": [
    ]
}

Response samples

Content type
application/json
{
  • "city": "string",
  • "postalCode": "string",
  • "additionalAddress": "string",
  • "additionalAddress2": "string",
  • "gender": 0,
  • "title": 0,
  • "customerId": "string",
  • "birthday": "string",
  • "fieldNurseId": "string",
  • "regionId": "string",
  • "payerInstitutionCode": "string",
  • "primaryDoctorId": "string",
  • "nursingHomeId": "string",
  • "nursingServiceId": "string",
  • "deactivationReason": 0,
  • "deactivationDate": "string",
  • "deactivationComment": "string",
  • "nextVisit": "string",
  • "ivTherapy": true,
  • "classification": "string",
  • "pharmacyId": "string",
  • "changeInSupplier": true,
  • "billingAddress": {
    },
  • "deliveryAddress": {
    },
  • "comment": "string",
  • "erpStatus": "Liefersperre",
  • "deliveryInformation": {
    },
  • "additionalUserId": "string",
  • "additionalUserIds": [
    ],
  • "careDegree": 1,
  • "calorieDemand": 0,
  • "dashboardInfo": [
    ],
  • "status": "string",
  • "additionalAttributes": { },
  • "referrer": {
    },
  • "specializedServiceProviderBranchId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "address": "string",
  • "phone": "string",
  • "mobilePhone": "string",
  • "email": "string",
  • "fax": "string",
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string",
  • "payer": {
    },
  • "hospital": {
    },
  • "careGivers": [
    ]
}

Einzelnen Patienten abrufen

Ruft die Daten eines spezifischen Patienten anhand seiner ID ab.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Die UUID des Patienten (Alberta _id).

Responses

Response samples

Content type
application/json
{
  • "city": "string",
  • "postalCode": "string",
  • "additionalAddress": "string",
  • "additionalAddress2": "string",
  • "gender": 0,
  • "title": 0,
  • "customerId": "string",
  • "birthday": "string",
  • "fieldNurseId": "string",
  • "regionId": "string",
  • "payerInstitutionCode": "string",
  • "primaryDoctorId": "string",
  • "nursingHomeId": "string",
  • "nursingServiceId": "string",
  • "deactivationReason": 0,
  • "deactivationDate": "string",
  • "deactivationComment": "string",
  • "nextVisit": "string",
  • "ivTherapy": true,
  • "classification": "string",
  • "pharmacyId": "string",
  • "changeInSupplier": true,
  • "billingAddress": {
    },
  • "deliveryAddress": {
    },
  • "comment": "string",
  • "erpStatus": "Liefersperre",
  • "deliveryInformation": {
    },
  • "additionalUserId": "string",
  • "additionalUserIds": [
    ],
  • "careDegree": 1,
  • "calorieDemand": 0,
  • "dashboardInfo": [
    ],
  • "status": "string",
  • "additionalAttributes": { },
  • "referrer": {
    },
  • "specializedServiceProviderBranchId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "address": "string",
  • "phone": "string",
  • "mobilePhone": "string",
  • "email": "string",
  • "fax": "string",
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string",
  • "payer": {
    },
  • "hospital": {
    },
  • "careGivers": [
    ]
}

Patienten aktualisieren

Aktualisiert einen bestehenden Patientendatensatz.

Business Logik

  • Prüft, ob der Patient existiert.
  • Unterstützt Soft-Delete (Archivierung) via toDelete Flag oder explizites Setzen von archived.
  • Löst Events aus (z.B. bei Regionswechsel oder Anonymisierung).
  • Verhindert das Löschen von Pflegedienst-Feldern für bestimmte Mandanten.
  • Lädt fehlende PLZ-IDs nach.

Betreuer-Logik

Bei der Aktualisierung werden Betreuer (careGivers) intelligent verarbeitet:

  • Neue Betreuer (ohne _id) erhalten automatisch eine neue UUID.
Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Die UUID des zu aktualisierenden Patienten (Alberta _id).

Request Body schema: application/json
required
city
string

Wohnort des Patienten.

postalCode
string

Postleitzahl des Wohnorts.

additionalAddress
string

Adresszusatz (z.B. Stockwerk, Zimmernummer).

additionalAddress2
string

Zweiter Adresszusatz.

gender
number (Gender)
Enum: 0 1 2 3

Geschlecht einer Person.

Wird für Patienten, Pflegepersonen und andere Personen verwendet.

Wert Name Beschreibung
0 Unknown Unbekannt
1 Female Weiblich
2 Male Männlich
3 Other Divers
title
number (Title)
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

Titel/Anrede einer Person.

Akademische Titel und Berufsbezeichnungen für Personen und Institutionen.

Wert Name Beschreibung
0 Unknown Unbekannt
1 Doctor Dr.
2 ProfDoctor Prof. Dr.
3 DiplEngineer Dipl. Ing.
4 DiplDoctor Dipl. med.
5 DiplPsych Dipl. Psych.
6 DoctorDoctor Dr. Dr.
7 DoctorMed Dr. med.
8 ProfDoctorDoctor Prof. Dr. Dr.
9 Prof Prof.
10 ProfDoctorMed Prof. Dr. med.
11 Lawyer Rechtsanwalt
12 FemaleLawyer Rechtsanwältin
13 Sister Schwester
14 DoctorJur Dr. jur.
15 Company Firma
16 Baroness Freifrau
17 Baron Freiherr
18 JointPractice Gemeinschaftspraxis
19 Practice Praxis
20 PrivateLecturerDoctorMed Priv.-Doz. Dr. med.
customerId
string

Externe Kundennummer aus dem ERP-System.

Dieses Feld wird zur Synchronisation mit externen ERP-Systemen verwendet. Es muss pro Mandant eindeutig sein.

birthday
string

Geburtsdatum des Patienten.

fieldNurseId
string

ID des zuständigen Außendienstmitarbeiters.

Referenziert einen Außendienstmitarbeiter (_id aus {@link IUser } )

regionId
string

ID der Region, der der Patient zugeordnet ist.

payerInstitutionCode
string

IK-Nummer (Institutionskennzeichen) des Kostenträgers.

Eindeutige Kennung der Krankenkasse.

primaryDoctorId
string

ID des behandelnden Arztes.

nursingHomeId
string

ID des Pflegeheims.

nursingServiceId
string

ID des Pflegedienstes.

deactivationReason
number (PatientDeactivationReason)
Enum: 0 1 2 3 4

Grund für die Deaktivierung eines Patienten.

Definiert die möglichen Gründe, warum ein Patient deaktiviert wurde.

Wert Name Beschreibung
0 Unknown Unbekannter Grund.
1 Dead Patient ist verstorben.
2 EndOfTherapy Therapie wurde beendet.
3 ChangeOfSupplier Wechsel des Leistungserbringers.
4 Other Sonstiger Grund.
deactivationDate
string

Datum der Deaktivierung.

deactivationComment
string

Kommentar zur Deaktivierung.

nextVisit
string

Datum des nächsten geplanten Besuchs.

ivTherapy
boolean

Gibt an, ob der Patient eine IV-Therapie erhält.

classification
string

Debitorenklasse des Patienten.

pharmacyId
string

ID der zugeordneten Apotheke.

changeInSupplier
boolean

Gibt an, ob ein Lieferantenwechsel stattgefunden hat (Umversorgungs-Patient)

object (IPatientBillingAddress)

Rechnungsadresse eines Patienten.

object (IAddress)

Adresse für Lieferungen und Kontakte.

Allgemeine Adressstruktur, die für Lieferadressen, Rechnungsadressen und Kontaktadressen verwendet wird.

comment
string

Allgemeiner Kommentar zum Patienten.

erpStatus
string (ErpStatus)
Enum: "Liefersperre" "Komplettsperre"

ERP-Sperrstatus für Patienten.

Definiert Sperrstatus, die aus dem ERP-System kommen.

Wert Name Beschreibung
"Liefersperre" deliveryBlocked Liefersperre - Patient darf keine Lieferungen erhalten.
"Komplettsperre" allBlocked Komplettsperre - Patient ist vollständig gesperrt.
object (IDeliveryInformation)

Lieferinformationen für einen Patienten.

Enthält Informationen zur Lieferung wie Startzeit der Belieferung und Hinweise.

additionalUserId
string

ID eines zusätzlichen zuständigen Außendienstmitarbeiters.

Referenziert einen Außendienstmitarbeiter (IUser._id).

additionalUserIds
Array of strings

IDs weiterer zuständiger Außendienstmitarbeiter.

Referenziert mehrere Außendienstmitarbeiter (IUser._id).

careDegree
number
Enum: 1 2 3 4 5

Pflegegrad des Patienten (1-5).

Einstufung nach SGB XI.

calorieDemand
number

Kalorienbedarf des Patienten.

dashboardInfo
Array of strings

Informationen für die Anzeige im Überblick des Patienten.

status
string

Status des Patienten. Konfigurierbar. Die für den Mandanten gültigen Werte beim Support erfragen.

additionalAttributes
object

Zusätzliche mandantenspezifische Attribute.

Flexibles Feld für kundenspezifische Erweiterungen.

object (IPatientReferrer)

Repräsentiert den Überweiser/Zuweiser eines Patienten.

Der Überweiser ist die Institution oder Person, die den Patienten an den Homecare-Anbieter vermittelt hat (z.B. Krankenhaus, Arzt, Pflegedienst).

specializedServiceProviderBranchId
string

ID der zugeordneten Filiale des spezialisierten Leistungserbringers.

firstName
string

Vorname der Person.

lastName
string

Nachname der Person.

address
string

Straße und Hausnummer.

phone
string

Festnetz-Telefonnummer.

mobilePhone
string

Mobiltelefonnummer.

email
string

E-Mail-Adresse.

fax
string

Faxnummer.

_id
string

Eindeutige ID der Entität (UUID v4 als String).

Wird beim Erstellen automatisch generiert.

timestamp
string

Zeitstempel der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

archived
boolean

Markiert die Entität als archiviert (Soft-Delete).

Archivierte Entitäten werden nicht physisch gelöscht, sondern nur als archiviert markiert. Sie erscheinen nicht mehr in Standard-Abfragen.

createdAt
string

Zeitpunkt der Erstellung.

Wird beim Erstellen der Entität automatisch gesetzt.

createdBy
string

ID des Benutzers, der die Entität erstellt hat.

Referenziert einen Benutzer im System.

updatedAt
string

Zeitpunkt der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

updatedBy
string

ID des Benutzers, der die letzte Änderung vorgenommen hat.

Referenziert einen Benutzer im System.

object (IPatientPayerRelationExternal)

Kostenträger-Relation für die externe API.

object (IPatientHospitalRelationExternal)

Krankenhaus-Relation für die externe API.

Array of objects (ICareGiverExternal)

Liste der Angehörigen/Betreuer.

Responses

Request samples

Content type
application/json
{
  • "city": "string",
  • "postalCode": "string",
  • "additionalAddress": "string",
  • "additionalAddress2": "string",
  • "gender": 0,
  • "title": 0,
  • "customerId": "string",
  • "birthday": "string",
  • "fieldNurseId": "string",
  • "regionId": "string",
  • "payerInstitutionCode": "string",
  • "primaryDoctorId": "string",
  • "nursingHomeId": "string",
  • "nursingServiceId": "string",
  • "deactivationReason": 0,
  • "deactivationDate": "string",
  • "deactivationComment": "string",
  • "nextVisit": "string",
  • "ivTherapy": true,
  • "classification": "string",
  • "pharmacyId": "string",
  • "changeInSupplier": true,
  • "billingAddress": {
    },
  • "deliveryAddress": {
    },
  • "comment": "string",
  • "erpStatus": "Liefersperre",
  • "deliveryInformation": {
    },
  • "additionalUserId": "string",
  • "additionalUserIds": [
    ],
  • "careDegree": 1,
  • "calorieDemand": 0,
  • "dashboardInfo": [
    ],
  • "status": "string",
  • "additionalAttributes": { },
  • "referrer": {
    },
  • "specializedServiceProviderBranchId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "address": "string",
  • "phone": "string",
  • "mobilePhone": "string",
  • "email": "string",
  • "fax": "string",
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string",
  • "payer": {
    },
  • "hospital": {
    },
  • "careGivers": [
    ]
}

Response samples

Content type
application/json
{
  • "city": "string",
  • "postalCode": "string",
  • "additionalAddress": "string",
  • "additionalAddress2": "string",
  • "gender": 0,
  • "title": 0,
  • "customerId": "string",
  • "birthday": "string",
  • "fieldNurseId": "string",
  • "regionId": "string",
  • "payerInstitutionCode": "string",
  • "primaryDoctorId": "string",
  • "nursingHomeId": "string",
  • "nursingServiceId": "string",
  • "deactivationReason": 0,
  • "deactivationDate": "string",
  • "deactivationComment": "string",
  • "nextVisit": "string",
  • "ivTherapy": true,
  • "classification": "string",
  • "pharmacyId": "string",
  • "changeInSupplier": true,
  • "billingAddress": {
    },
  • "deliveryAddress": {
    },
  • "comment": "string",
  • "erpStatus": "Liefersperre",
  • "deliveryInformation": {
    },
  • "additionalUserId": "string",
  • "additionalUserIds": [
    ],
  • "careDegree": 1,
  • "calorieDemand": 0,
  • "dashboardInfo": [
    ],
  • "status": "string",
  • "additionalAttributes": { },
  • "referrer": {
    },
  • "specializedServiceProviderBranchId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "address": "string",
  • "phone": "string",
  • "mobilePhone": "string",
  • "email": "string",
  • "fax": "string",
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string",
  • "payer": {
    },
  • "hospital": {
    },
  • "careGivers": [
    ]
}

Produktgruppe

Endpunkte zur Verwaltung von Produktgruppen.

Produktgruppe abrufen

Ruft eine einzelne Produktgruppe anhand ihrer ID ab.

Produktgruppen-Typen

  • 0 (OWG): Oberwarengruppe - keine Parent-Referenz
  • 1 (WG): Warengruppe - Parent muss OWG sein
  • 2 (TWG): Teilwarengruppe - Parent darf nicht TWG sein
Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Die UUID der Produktgruppe (Alberta _id).

Responses

Response samples

Content type
application/json
{
  • "number": 0,
  • "medicalAidPositionNumber": "string",
  • "name": "string",
  • "description": "string",
  • "type": 0,
  • "parentId": "string",
  • "attributeTemplateIds": [
    ],
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string"
}

Produktgruppe aktualisieren

Aktualisiert eine bestehende Produktgruppe.

Erlaubte Felder

  • Nur das Feld name darf geändert werden.
Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Die UUID der Produktgruppe (Alberta _id).

Request Body schema: application/json
required
name
required
string

Neuer Name der Produktgruppe

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "number": 0,
  • "medicalAidPositionNumber": "string",
  • "name": "string",
  • "description": "string",
  • "type": 0,
  • "parentId": "string",
  • "attributeTemplateIds": [
    ],
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string"
}

Produktgruppen auflisten

Listet Produktgruppen auf.

Produktgruppen-Typen

  • 0 (OWG): Oberwarengruppe
  • 1 (WG): Warengruppe
  • 2 (TWG): Teilwarengruppe
Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Produktgruppe erstellen

Erstellt eine neue Produktgruppe.

Pflichtfelder

  • name: Name der Produktgruppe
  • type: Typ (0=OWG, 1=WG, 2=TWG)

Validierungsregeln

  • OWG (0): Darf keinen Parent haben
  • WG (1): Parent muss OWG sein
  • TWG (2): Parent darf nicht TWG sein

Hinweise

  • Die _id wird automatisch generiert und darf nicht übergeben werden.
  • archived darf beim Erstellen nicht auf true gesetzt werden.
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
number
number

Nummer der Produktgruppe.

medicalAidPositionNumber
string

Hilfsmittelpositionsnummer.

Nummer aus dem Hilfsmittelverzeichnis der GKV.

name
string

Name der Produktgruppe.

description
string

Beschreibung der Produktgruppe.

type
number (ProductGroupType)
Enum: 0 1 2

Typ/Ebene einer Produktgruppe.

Produktgruppen sind hierarchisch in drei Ebenen strukturiert. Die jeweils niedrigere Ebene wird spezifischer: Beispiel:

  • OWG: Harn-/Verdauungsorgane
  • WG: Einmalkatheter für ISK (kann weggelassen werden)
  • TWG: Einmalkatheter, unbeschichtet, nicht gebrauchsfertig Die Therapiewarengruppe (TWG) ist die relevante Ebene für den Versorgungsvorschlag.
Wert Name Beschreibung
0 OWG Oberwarengruppe (OWG) - Oberste Ebene.
1 WG Warengruppe (WG) - Mittlere Ebene (kann weggelassen werden).
2 TWG Therapiewarengruppe (TWG) - Unterste, spezifischste Ebene.

Die TWG ist die relevante Ebene für den Versorgungsvorschlag. |

parentId
string

ID der übergeordneten Produktgruppe.

attributeTemplateIds
Array of strings

IDs der zugeordneten Attributvorlagen.

_id
string

Eindeutige ID der Entität (UUID v4 als String).

Wird beim Erstellen automatisch generiert.

timestamp
string

Zeitstempel der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

archived
boolean

Markiert die Entität als archiviert (Soft-Delete).

Archivierte Entitäten werden nicht physisch gelöscht, sondern nur als archiviert markiert. Sie erscheinen nicht mehr in Standard-Abfragen.

createdAt
string

Zeitpunkt der Erstellung.

Wird beim Erstellen der Entität automatisch gesetzt.

createdBy
string

ID des Benutzers, der die Entität erstellt hat.

Referenziert einen Benutzer im System.

updatedAt
string

Zeitpunkt der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

updatedBy
string

ID des Benutzers, der die letzte Änderung vorgenommen hat.

Referenziert einen Benutzer im System.

Responses

Request samples

Content type
application/json
{
  • "number": 0,
  • "medicalAidPositionNumber": "string",
  • "name": "string",
  • "description": "string",
  • "type": 0,
  • "parentId": "string",
  • "attributeTemplateIds": [
    ],
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string"
}

Response samples

Content type
application/json
{
  • "number": 0,
  • "medicalAidPositionNumber": "string",
  • "name": "string",
  • "description": "string",
  • "type": 0,
  • "parentId": "string",
  • "attributeTemplateIds": [
    ],
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string"
}

Region

Endpunkte zur Abfrage von Regionen.

Region abrufen

Ruft eine einzelne Region anhand ihrer ID ab.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Die UUID der Region (Alberta _id).

Responses

Response samples

Content type
application/json
{
  • "label": "string",
  • "parent": "string",
  • "doNotChange": true,
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true
}

Regionen auflisten

Listet alle Regionen auf.

Regionen dienen der geografischen Strukturierung im Alberta Homecare-System. Sie steuern die Sichtbarkeit von Entitäten.

Wichtige Felder

  • label: Bezeichnung der Region
  • parent: ID der übergeordneten Region (hierarchische Struktur)
Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bestellung

Endpunkte zur Verwaltung von Bestellungen (SingleOrder) im Rahmen einer Versorgung.

Liste von Bestellungen abrufen

Ruft eine Liste von Bestellungen basierend auf dem Status und einem Zeitstempel ab.

Konzept: SingleOrder vs. IntegratedCare

Eine SingleOrder ist eine konkrete Bestellung im Rahmen einer laufenden IntegratedCare (Versorgung). Die IntegratedCare definiert die Dauerversorgung eines Patienten für eine bestimmte Therapie und enthält proposedArticleLines als Vorlage für wiederkehrende Bestellungen.

Jede SingleOrder ist über integratedCareId mit ihrer Versorgung verknüpft.

Typischer Synchronisations-Workflow

  1. Neue Bestellungen abholen: GET /singleOrder?status=created&updatedAfter=...
  2. Bestellung im ERP verarbeiten
  3. Status zurückmelden: PATCH /singleOrder/{id} mit neuem status
  4. Bei Statusänderungen (Versand, Lieferung): Erneut PATCH aufrufen

Sammelbestellungen

Mehrere Bestellungen können zu einer Sammelbestellung zusammengefasst werden:

  • isGroupOrder=true: Diese Bestellung ist die Hauptbestellung der Sammelbestellung
  • groupOrderId: Verweist auf die Hauptbestellung der Sammelbestellung

Synchronisation

Dieser Endpunkt ist für die inkrementelle Synchronisation mit ERP-Systemen konzipiert. Die Parameter updatedAfter und status sind beide Pflicht. Weitere Parameter sind nicht erlaubt.

Änderungen, die über die API selbst vorgenommen wurden, werden bei der Synchronisation ignoriert, um Endlosschleifen zu vermeiden.

Antwort-Modifikationen

  • deliveryDate wird entfernt, wenn deliveryDateUnknown=true
  • therapyId und therapyTypeId werden als Zahlen zurückgegeben
Authorizations:
ApiKeyAuth
query Parameters
status
required
string
Enum: "created" "transmitted" "updated" "archived"
Example: status=created

Filtert Bestellungen nach ihrem Änderungsstatus:

  • created: Neue Bestellungen, bereit zur Abholung durch das ERP-System
  • transmitted: Bereits an das ERP übermittelt
  • updated: Geänderte Bestellungen
  • archived: Archivierte/gelöschte Bestellungen (Soft-Delete)
updatedAfter
required
string <date-time>
Example: updatedAfter=2025-01-01T00:00:00.000Z

ISO 8601 Zeitstempel. Nur Bestellungen, die nach diesem Zeitpunkt geändert wurden, werden zurückgegeben.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bestellung aktualisieren

Aktualisiert eine bestehende Bestellung.

Typische Anwendungsfälle

  • Statusänderungen nach Verarbeitung im ERP
  • Aktualisierung von Artikelzeilen (z.B. gelieferte Mengen)

Statusübergänge

Nicht alle Statusänderungen sind erlaubt:

  • Deleted ist ein Endstatus - keine weiteren Änderungen möglich
  • Nur von Created kann zu Deleted oder Pending gewechselt werden
  • Von Pending und Canceled kann nicht zu Created oder Deleted gewechselt werden

Business Logik

  • Bei Statusänderungen werden Pflichtfelder validiert.
  • packagingUnitId wird bei Artikelzeilen automatisch aus der DB ergänzt, falls nicht angegeben.

Hinweis

Query-Parameter sind bei PATCH nicht erlaubt.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Die UUID der Bestellung (Alberta _id).

Request Body schema: application/json
required
regionId
string

ID der Region, der der Auftrag zugeordnet ist.

salesId
string

Vorgangsnummer im ERP-System des Kunden

patientId
string

ID des Patienten, für den der Auftrag erstellt wurde.

integratedCareId
string

ID der zugehörigen IntegratedCare (Versorgung).

Jede SingleOrder gehört zu einer IntegratedCare, die die gesamte Versorgungssituation des Patienten abbildet.

creationDate
string

Erstellungsdatum des Auftrags.

deliveryDate
string

Geplantes Lieferdatum.

deliveryOption
string

Lieferoption.

reminderDate
string

Datum für die Erinnerung zur Nachbestellung.

accountingMonth
Array of numbers

Abrechnungsmonate für den Auftrag.

startDate
string

Die Artikel dieser Bestellung sind für die Versorgung ab diesem Datum gedacht.

endDate
string

Die Artikel dieser Bestellung sind für die Versorgung bis zu diesem Datum gedacht.

deliveryInformation
string

Zusätzliche Lieferinformationen.

doctorId
string

ID des verordnenden Arztes.

pharmacyId
string

ID der beliefernden Apotheke.

therapyId
number

Zugehörige Therapie. Wert ist der Enum-Wert aus {@link Therapy } .

therapyTypeId
number

Zugehöriger Therapietyp. Wert ist der Enum-Wert aus {@link TherapyType } .

location
number

Lokalisation der versorgten Wunde.

Wert entspricht areaId aus dem BodyPartService.

expressDelivery
boolean

Gibt an, ob es sich um eine Expresslieferung handelt.

isInitialCare
boolean
Deprecated

Gibt an, ob es sich um eine Erstversorgung handelt.

status
number (OrderStatus)
Enum: -3 -2 -1 0 1 2 3 4 5 6 7 8 9 10

Status einer Bestellung.

Definiert den Lebenszyklus einer Bestellung von der Erstellung bis zur Lieferung. Nicht alle Statusänderungen sind erlaubt. Erlaubte Statusübergänge: | Von Status | Erlaubte Zielstatus | |------------|---------------------| | Created | Alle Status (inkl. Deleted) | | Pending | Alle außer Created, Deleted, Pending | | Canceled | Alle außer Created, Deleted, Pending, Canceled | | Deleted | Keine (Endstatus) | | Alle anderen | Alle außer Created, Deleted, Pending | Wichtige Regeln:

  • Deleted ist ein Endstatus - keine weiteren Änderungen möglich
  • Nur von Created kann zu Deleted gewechselt werden
  • Created ist der einzige Status, der zu Pending wechseln kann
Wert Name Beschreibung
-3 Pending Bestellung ist ausstehend/wartend.
-2 Canceled Bestellung wurde storniert.
-1 Deleted Bestellung wurde gelöscht (Endstatus).
0 Created Bestellung wurde erstellt.
1 Transmitted Bestellung wurde an das ERP-System übermittelt.
2 Transmission_failure Übermittlung an das ERP-System ist fehlgeschlagen.
3 Processed Bestellung wurde im ERP-System verarbeitet.
4 Sent Bestellung wurde versendet.
5 Delivered Bestellung wurde geliefert.
6 OrderStopped Bestellung wurde gestoppt.
7 ErpCall ERP-Aufruf erfolgt.
8 InProgress Bestellung ist in Bearbeitung.
9 Progressed Bestellung wurde weitergeleitet.
10 PartiallySent Bestellung wurde teilweise versendet.
annotation
string

Anmerkungen zum Auftrag.

deliveryNote
string

Lieferschein-Notiz.

deliveryStartTime
string

Geplante Lieferuhrzeit.

hospitalId
string

ID des Krankenhauses (falls Krankenhausversorgung).

prescriptionStatus
string (TransmissionStatus)
Enum: "transmissionPending" "transmissionInitiated" "transmissionFailed" "faxWaiting" "faxProcessing" "faxSending" "faxFailed" "emailFailed" "requested" "toClarify" "canceled" "faulty" "copyReceived" "originalReceived"

Übermittlungsstatus für Dokumente.

Definiert den Status der Übermittlung von Dokumenten (Fax, E-Mail).

Wert Name Beschreibung
"transmissionPending" TransmissionPending Übermittlung steht aus.
"transmissionInitiated" TransmissionInitiated Übermittlung wurde gestartet.
"transmissionFailed" TransmissionFailed Übermittlung ist fehlgeschlagen.
"faxWaiting" FaxWaiting Fax wartet in der Warteschlange.
"faxProcessing" FaxProcessing Fax wird verarbeitet.
"faxSending" FaxSending Fax wird gesendet.
"faxFailed" FaxFailed Fax-Versand fehlgeschlagen.
"emailFailed" EmailFailed E-Mail-Versand fehlgeschlagen.
"requested" Requested Dokument wurde angefordert.
"toClarify" ToClarify manueller Klärungsbedarf.
"canceled" Canceled Anforderung wurde storniert.
"faulty" Faulty Dokument ist fehlerhaft.
"copyReceived" CopyReceived Kopie wurde empfangen.
"originalReceived" OriginalReceived Original wurde empfangen.
isHospitalPrescriber
boolean

Gibt an, ob das Krankenhaus der Verordner ist.

tags
Array of strings

Optionale Tags für den Auftrag (konfigurierbar).

groupOrderId
string

ID der zugehörigen Sammelbestellung (falls Teil einer Sammelbestellung).

isGroupOrder
boolean

Gibt an, ob dies eine Sammelbestellung ist. Bestellungen, die dieser Sammelbestellung zugehörig sind, besitzen die gleiche "groupOrderId".

orderNumber
string

Externe Auftragsnummer für Sammelbestellungen.

attachments
Array of strings

Liste von Anlagen, die dieser Bestellung zugehörig sind.

erpOrderNumber
string

ERP-Auftragsnummer.

transmittedAt
string

Zeitpunkt der Verarbeitung durch das Order-Backend.

ISO-String-Datum, wann der Auftrag vom Order-Backend verarbeitet wurde.

hasFollowUpOrder
boolean

Gibt an, ob ein Folgeauftrag in derselben IntegratedCare existiert.

auditIds
Array of strings

Liste von zugehörigen Dokumenten-IDs für diesen Auftrag.

_id
string

Eindeutige ID der Entität (UUID v4 als String).

Wird beim Erstellen automatisch generiert.

timestamp
string

Zeitstempel der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

archived
boolean

Markiert die Entität als archiviert (Soft-Delete).

Archivierte Entitäten werden nicht physisch gelöscht, sondern nur als archiviert markiert. Sie erscheinen nicht mehr in Standard-Abfragen.

createdAt
string

Zeitpunkt der Erstellung.

Wird beim Erstellen der Entität automatisch gesetzt.

createdBy
string

ID des Benutzers, der die Entität erstellt hat.

Referenziert einen Benutzer im System.

updatedAt
string

Zeitpunkt der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

updatedBy
string

ID des Benutzers, der die letzte Änderung vorgenommen hat.

Referenziert einen Benutzer im System.

Array of objects (ISingleOrderedArticleLineExternal)

Liste der bestellten Artikelzeilen.

object (IDeliveryAddressExternal)

Lieferadresse für die externe API.

object (ITrackingInfoExternal)

Tracking-Informationen für die externe API.

Responses

Request samples

Content type
application/json
{
  • "status": 3
}

Response samples

Content type
application/json
{
  • "regionId": "string",
  • "salesId": "string",
  • "patientId": "string",
  • "integratedCareId": "string",
  • "creationDate": "string",
  • "deliveryDate": "string",
  • "deliveryOption": "string",
  • "reminderDate": "string",
  • "accountingMonth": [
    ],
  • "startDate": "string",
  • "endDate": "string",
  • "deliveryInformation": "string",
  • "doctorId": "string",
  • "pharmacyId": "string",
  • "therapyId": 0,
  • "therapyTypeId": 0,
  • "location": 0,
  • "expressDelivery": true,
  • "isInitialCare": true,
  • "status": -3,
  • "annotation": "string",
  • "deliveryNote": "string",
  • "deliveryStartTime": "string",
  • "hospitalId": "string",
  • "prescriptionStatus": "transmissionPending",
  • "isHospitalPrescriber": true,
  • "tags": [
    ],
  • "groupOrderId": "string",
  • "isGroupOrder": true,
  • "orderNumber": "string",
  • "attachments": [
    ],
  • "erpOrderNumber": "string",
  • "transmittedAt": "string",
  • "hasFollowUpOrder": true,
  • "auditIds": [
    ],
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string",
  • "orderedArticleLines": [
    ],
  • "deliveryAddress": {
    },
  • "trackingInfo": {
    }
}

Benutzer

Endpunkte zur Abfrage von Benutzern.

Benutzer abrufen

Ruft einen einzelnen Benutzer anhand seiner ID ab.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Die UUID des Benutzers (Alberta _id).

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "salesPersonId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "address": "string",
  • "postalCodeId": "string",
  • "postalCode": "string",
  • "city": "string",
  • "phone": "string",
  • "mobilePhone": "string",
  • "email": "string",
  • "fax": "string",
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true
}

Benutzer auflisten

Listet Benutzer der eigenen Organisation auf.

Hinweise

  • Nur Benutzer der eigenen Organisation werden zurückgegeben.
  • Sensible Felder werden aus der Antwort entfernt.
Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]