API docs by Redocly

Alberta Massist Schnittstelle (2.0.1)

Download OpenAPI specification:

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

Dokumentation erstellt am: 12.02.2026

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, PUT
/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 POST, PUT
/article Artikelstammdaten GET, POST, PUT, PATCH
/doctor Ärzte GET
/payer Kostenträger/Krankenkassen GET
/hospital Krankenhäuser GET
/nursingHome Pflegeheime GET
/nursingService Pflegedienste GET
/pharmacy Apotheken GET
/region Strukturelle Organisationseinheiten GET
/users Außendienstmitarbeiter GET
/attachment Dateien/Bilder GET
/device Medizinische Geräte POST, PUT
/patientNote Notizen zu Patienten GET, POST, PATCH
/patientHistory Änderungshistorie am Patienten GET
/contractArticleGroup Vertragsartikelgruppen GET, POST, PUT
/insuranceContract Versicherungsverträge GET, POST, PUT
/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

Artikel abrufen

Ruft Artikel ab, die seit dem angegebenen Zeitpunkt geändert wurden.

Wichtig: Der Parameter updatedAfter ist ein Pflichtparameter.

Authorizations:
ApiKeyAuth
query Parameters
updatedAfter
required
string <date-time>

ISO 8601 Zeitstempel. Nur Artikel, die nach diesem Zeitpunkt geändert wurden. Beispiel: 2025-01-01T00:00:00.000Z

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Artikel anlegen

Legt einen neuen Artikel an.

Pflichtfelder: name, articleNumber

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
{
  • "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"
}

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 abrufen

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>

Die eindeutige ID des Artikels (UUID)

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 (vollständig)

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>

Die eindeutige ID des Artikels (UUID)

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
{
  • "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"
}

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 (partiell)

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>

Die eindeutige ID des Artikels (UUID)

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
{
  • "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"
}

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

Anlagen abrufen

Authorizations:
ApiKeyAuth
query Parameters
updatedAfter
required
string <date-time>

ISO 8601 Zeitstempel

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Anlage herunterladen

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "data": "string"
}

Vertragsartikelgruppe

Vertragsartikelgruppen abrufen

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Vertragsartikelgruppe anlegen

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

Name der Vertragsartikelgruppe.

customerNumber
string

Kundennummer für die Abrechnung.

articleIds
Array of strings

IDs der enthaltenen Artikel.

productGroupIds
Array of strings

IDs der enthaltenen Produktgruppen.

_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": "string",
  • "customerNumber": "string",
  • "articleIds": [
    ],
  • "productGroupIds": [
    ],
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "customerNumber": "string",
  • "articleIds": [
    ],
  • "productGroupIds": [
    ],
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string"
}

Vertragsartikelgruppe abrufen

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "customerNumber": "string",
  • "articleIds": [
    ],
  • "productGroupIds": [
    ],
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string"
}

Vertragsartikelgruppe aktualisieren

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
name
string

Name der Vertragsartikelgruppe.

customerNumber
string

Kundennummer für die Abrechnung.

articleIds
Array of strings

IDs der enthaltenen Artikel.

productGroupIds
Array of strings

IDs der enthaltenen Produktgruppen.

_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": "string",
  • "customerNumber": "string",
  • "articleIds": [
    ],
  • "productGroupIds": [
    ],
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "customerNumber": "string",
  • "articleIds": [
    ],
  • "productGroupIds": [
    ],
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string"
}

Dokument

Dokumente abrufen

Authorizations:
ApiKeyAuth
query Parameters
createdAfter
required
string <date-time>

ISO 8601 Zeitstempel

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Dokument abrufen

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "patientId": "string",
  • "therapyId": 0,
  • "therapyTypeId": 0,
  • "archived": true,
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Patient

Patient-ID anhand der Kundennummer abrufen

Ermittelt die Alberta Patient-ID (_id) anhand der externen Kundennummer (customerId).

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

Die externe Kundennummer aus dem ERP-System

Responses

Response samples

Content type
application/json
{
  • "_id": "1f704bc5-5055-43eb-a851-c87b6b0bf7b9",
  • "customerId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Patientenhistorie abrufen

Authorizations:
ApiKeyAuth
query Parameters
updatedAfter
required
string <date-time>

ISO 8601 Zeitstempel

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Patientennotizen abrufen

Ruft Patientennotizen ab. Entweder updatedAfter oder patientId muss angegeben werden.

Authorizations:
ApiKeyAuth
query Parameters
updatedAfter
string <date-time>

ISO 8601 Zeitstempel (alternativ zu patientId)

patientId
string <uuid>

Patient-ID (alternativ zu updatedAfter)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Patientennotiz anlegen

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

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>
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
}

Patienten abrufen

Ruft Patienten ab, die seit dem angegebenen Zeitpunkt geändert wurden.

Wichtig: Die Parameter status und updatedAfter sind Pflichtparameter.

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

Filtert nach Änderungsstatus:

  • created: Neue Patienten ohne customerId
  • updated: Geänderte Patienten mit customerId
  • archived: Gelöschte/archivierte Patienten
updatedAfter
required
string <date-time>

ISO 8601 Zeitstempel. Nur Patienten, die nach diesem Zeitpunkt geändert wurden. Beispiel: 2025-01-01T00:00:00.000Z

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Patient anlegen

Legt einen neuen Patienten an.

Pflichtfelder: firstName, lastName, birthday, gender, address

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.

calendarResourceId
string

Interne Kalender-Ressourcen-ID für Terminplanung.

Wird für die standardisierte Zuordnung von Patienten zu Ressourcen beim Erstellen von {@link IAppointment } verwendet. Kalender Ressourcen können über den Support angelegt werden.

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)

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": { },
  • "calendarResourceId": "string",
  • "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": { },
  • "calendarResourceId": "string",
  • "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": [
    ]
}

Patient aktualisieren

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>

Die eindeutige ID des Patienten (UUID)

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.

calendarResourceId
string

Interne Kalender-Ressourcen-ID für Terminplanung.

Wird für die standardisierte Zuordnung von Patienten zu Ressourcen beim Erstellen von {@link IAppointment } verwendet. Kalender Ressourcen können über den Support angelegt werden.

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)

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": { },
  • "calendarResourceId": "string",
  • "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": { },
  • "calendarResourceId": "string",
  • "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": [
    ]
}

Gerät

Gerät anlegen

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
{
  • "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"
}

Gerät aktualisieren

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>
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
{
  • "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"
}

Direktbestellung

Direktbestellungen abrufen

Ruft Direktbestellungen ab, die seit dem angegebenen Zeitpunkt geändert wurden.

Wichtig: Die Parameter status und updatedAfter sind Pflichtparameter.

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

Filtert nach Änderungsstatus:

  • created: Neue Direktbestellungen ohne salesId
  • transmitted: Direktbestellungen die übermittelt wurden
  • updated: Geänderte Direktbestellungen mit salesId
  • archived: Gelöschte/archivierte Direktbestellungen
updatedAfter
required
string <date-time>

ISO 8601 Zeitstempel. Nur Direktbestellungen, die nach diesem Zeitpunkt geändert wurden. Beispiel: 2025-01-01T00:00:00.000Z

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Direktbestellung aktualisieren

Aktualisiert eine bestehende Direktbestellung.

Typischerweise wird die salesId gesetzt, um die Direktbestellung als vom ERP verarbeitet zu markieren.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>

Die eindeutige ID der Direktbestellung (UUID)

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.

object (IDeliveryAddress)

Lieferadresse.

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

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)

Responses

Request samples

Content type
application/json
{
  • "regionId": "string",
  • "salesId": "string",
  • "patientId": "string",
  • "creationDate": "string",
  • "deliveryDate": "string",
  • "deliveryAddress": {
    },
  • "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": [
    ]
}

Response samples

Content type
application/json
{
  • "regionId": "string",
  • "salesId": "string",
  • "patientId": "string",
  • "creationDate": "string",
  • "deliveryDate": "string",
  • "deliveryAddress": {
    },
  • "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": [
    ]
}

ERP-Auftrag

ERP-Auftrag anlegen

Legt einen neuen ERP-Auftrag an. Wird verwendet, um Aufträge aus dem ERP-System nach Alberta zu übertragen.

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

ID des Patienten.

regionId
string

ID der Region.

therapyId
number

ID der Therapie.

salesId
string

Id des Auftrag im ERP-System des Kunden

object (IDeliveryAddress)

Lieferadresse.

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

outboundDate
string

Versanddatum.

Array of objects (IErpOrderedArticleLine)

Bestellte Artikelzeilen.

annotation
string

Anmerkung.

prescriptionStatus
string

Rezeptstatus.

completed
boolean

Gibt an, ob die Bestellung abgeschlossen ist.

trackingLink
string

Link zur Sendungsverfolgung.

Array of objects (ITrackingInfo)

Tracking-Informationen.

_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
{
  • "patientId": "string",
  • "regionId": "string",
  • "therapyId": 0,
  • "salesId": "string",
  • "deliveryAddress": {
    },
  • "outboundDate": "string",
  • "erpOrderedArticleLines": [
    ],
  • "annotation": "string",
  • "prescriptionStatus": "string",
  • "completed": true,
  • "trackingLink": "string",
  • "trackingInfo": [
    ],
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true
}

Response samples

Content type
application/json
{
  • "patientId": "string",
  • "regionId": "string",
  • "therapyId": 0,
  • "salesId": "string",
  • "deliveryAddress": {
    },
  • "outboundDate": "string",
  • "erpOrderedArticleLines": [
    ],
  • "annotation": "string",
  • "prescriptionStatus": "string",
  • "completed": true,
  • "trackingLink": "string",
  • "trackingInfo": [
    ],
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true
}

ERP-Auftrag aktualisieren

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
patientId
string

ID des Patienten.

regionId
string

ID der Region.

therapyId
number

ID der Therapie.

salesId
string

Id des Auftrag im ERP-System des Kunden

object (IDeliveryAddress)

Lieferadresse.

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

outboundDate
string

Versanddatum.

Array of objects (IErpOrderedArticleLine)

Bestellte Artikelzeilen.

annotation
string

Anmerkung.

prescriptionStatus
string

Rezeptstatus.

completed
boolean

Gibt an, ob die Bestellung abgeschlossen ist.

trackingLink
string

Link zur Sendungsverfolgung.

Array of objects (ITrackingInfo)

Tracking-Informationen.

_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
{
  • "patientId": "string",
  • "regionId": "string",
  • "therapyId": 0,
  • "salesId": "string",
  • "deliveryAddress": {
    },
  • "outboundDate": "string",
  • "erpOrderedArticleLines": [
    ],
  • "annotation": "string",
  • "prescriptionStatus": "string",
  • "completed": true,
  • "trackingLink": "string",
  • "trackingInfo": [
    ],
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true
}

Response samples

Content type
application/json
{
  • "patientId": "string",
  • "regionId": "string",
  • "therapyId": 0,
  • "salesId": "string",
  • "deliveryAddress": {
    },
  • "outboundDate": "string",
  • "erpOrderedArticleLines": [
    ],
  • "annotation": "string",
  • "prescriptionStatus": "string",
  • "completed": true,
  • "trackingLink": "string",
  • "trackingInfo": [
    ],
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true
}

System

Health-Check

Authorizations:
ApiKeyAuth

Responses

Institution

Ärzte abrufen

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Kostenträger abrufen

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Krankenhäuser abrufen

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Pflegeheime abrufen

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Pflegedienste abrufen

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Apotheken abrufen

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Versicherungsvertrag

Versicherungsverträge abrufen

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Versicherungsvertrag anlegen

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

Mandanten-Kennung.

name
string

Interner Name des Vertrags.

therapyId
number

Therapie-ID, für die der Vertrag gilt.

therapyTypeIds
Array of numbers

Therapietyp-IDs, für die der Vertrag gilt.

validFrom
string

Gültig ab Datum.

validTo
string

Gültig bis Datum.

description
string

Beschreibung des Vertrags.

Array of objects (ISalesContract)

ERP Kassenverträge innerhalb dieses Kassenvertrags.

Definiert die Verknüpfung zu den Verträgen im ERP-System des Kunden.

insuranceContractName
string

Offizieller Name des Kassenvertrags.

payerIds
Array of strings

IDs der Kostenträger, für die der Vertrag gilt.

isSelfPayer
boolean

Gibt an, ob es sich um einen Selbstzahler-Vertrag handelt.

notPayingPayerIds
Array of strings

IDs der Kostenträger, die nicht zahlen.

pricingModelType
number (PricingModelType)
Enum: 0 1 2 3 4 5 6

Preismodell-Typ für Kassenverträge.

Definiert die Art der Preisberechnung für einen Kassenvertrag.

Wert Name Beschreibung
0 Unknown Unbekannt/nicht definiert.
1 FlatCharge Pauschale - Festbetrag unabhängig von der Menge.
2 Overvaluation Aufschlag - Preiserhöhung auf den Basispreis.
3 Undervaluation Abschlag - Preisreduzierung auf den Basispreis.
4 FixedPricing Fixpreis - Fester Preis pro Einheit.
5 Purchase Kauf - Einmaliger Kaufpreis.
6 PurchaseReplacement Kauf/Wiederbeschaffung - Kaufpreis mit Wiederbeschaffungsoption.
pricingBasis
string

Basis für die Preisberechnung.

billingType
number

Abrechnungstyp.

productGroupIds
Array of strings

IDs der Produktgruppen, die im Vertrag enthalten sind.

costEstimateRequired
boolean

Gibt an, ob ein Kostenvoranschlag erforderlich ist.

Array of objects (IProductGroupQuantity)

Maximale Mengen pro Produktgruppe.

object (IVisitInterval)

Besuchsintervall für Leistungen.

Definiert, wie oft Besuche in einem bestimmten Zeitraum stattfinden sollen.

object (IDuration)

Zeitdauer mit Menge und Zeiteinheit.

Wird für Zeiträume wie Dosierungen, Verordnungslaufzeiten oder Besuchsintervalle verwendet.

approvalObligation
boolean

Gibt an, ob eine Genehmigungspflicht besteht.

periodOnPrescriptionNecessary
boolean

Gibt an, ob ein Zeitraum auf der Verordnung erforderlich ist.

flatChargeTextAllowed
boolean

Gibt an, ob Pauschaltext erlaubt ist.

flatChargeText
string

Pauschaltext für die Abrechnung.

ageLimit
number

Obere Altersgrenze für den Vertrag.

ageLimitLower
number

Untere Altersgrenze für den Vertrag.

Array of objects (IRequiredTemplate)

Erforderliche Dokumentvorlagen für den Vertrag. Für diesen Vertrag müssen die benötigten Dokumente ausgefüllt werden um die Abrechnung zu ermöglichen.

contractArticleGroupIds
Array of strings

IDs der Vertragsartikelgruppen.

generalContract
boolean

Gibt an, ob es sich um einen allgemeinen Vertrag handelt.

_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
{
  • "tenant": "string",
  • "name": "string",
  • "therapyId": 0,
  • "therapyTypeIds": [
    ],
  • "validFrom": "string",
  • "validTo": "string",
  • "description": "string",
  • "salesContracts": [
    ],
  • "insuranceContractName": "string",
  • "payerIds": [
    ],
  • "isSelfPayer": true,
  • "notPayingPayerIds": [
    ],
  • "pricingModelType": 0,
  • "pricingBasis": "string",
  • "billingType": 0,
  • "productGroupIds": [
    ],
  • "costEstimateRequired": true,
  • "maximumAmountForProductGroups": [
    ],
  • "visitInterval": {
    },
  • "maxPermanentPrescriptionPeriod": {
    },
  • "approvalObligation": true,
  • "periodOnPrescriptionNecessary": true,
  • "flatChargeTextAllowed": true,
  • "flatChargeText": "string",
  • "ageLimit": 0,
  • "ageLimitLower": 0,
  • "requiredTemplates": [
    ],
  • "contractArticleGroupIds": [
    ],
  • "generalContract": true,
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string"
}

Response samples

Content type
application/json
{
  • "tenant": "string",
  • "name": "string",
  • "therapyId": 0,
  • "therapyTypeIds": [
    ],
  • "validFrom": "string",
  • "validTo": "string",
  • "description": "string",
  • "salesContracts": [
    ],
  • "insuranceContractName": "string",
  • "payerIds": [
    ],
  • "isSelfPayer": true,
  • "notPayingPayerIds": [
    ],
  • "pricingModelType": 0,
  • "pricingBasis": "string",
  • "billingType": 0,
  • "productGroupIds": [
    ],
  • "costEstimateRequired": true,
  • "maximumAmountForProductGroups": [
    ],
  • "visitInterval": {
    },
  • "maxPermanentPrescriptionPeriod": {
    },
  • "approvalObligation": true,
  • "periodOnPrescriptionNecessary": true,
  • "flatChargeTextAllowed": true,
  • "flatChargeText": "string",
  • "ageLimit": 0,
  • "ageLimitLower": 0,
  • "requiredTemplates": [
    ],
  • "contractArticleGroupIds": [
    ],
  • "generalContract": true,
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string"
}

Versicherungsvertrag abrufen

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "tenant": "string",
  • "name": "string",
  • "therapyId": 0,
  • "therapyTypeIds": [
    ],
  • "validFrom": "string",
  • "validTo": "string",
  • "description": "string",
  • "salesContracts": [
    ],
  • "insuranceContractName": "string",
  • "payerIds": [
    ],
  • "isSelfPayer": true,
  • "notPayingPayerIds": [
    ],
  • "pricingModelType": 0,
  • "pricingBasis": "string",
  • "billingType": 0,
  • "productGroupIds": [
    ],
  • "costEstimateRequired": true,
  • "maximumAmountForProductGroups": [
    ],
  • "visitInterval": {
    },
  • "maxPermanentPrescriptionPeriod": {
    },
  • "approvalObligation": true,
  • "periodOnPrescriptionNecessary": true,
  • "flatChargeTextAllowed": true,
  • "flatChargeText": "string",
  • "ageLimit": 0,
  • "ageLimitLower": 0,
  • "requiredTemplates": [
    ],
  • "contractArticleGroupIds": [
    ],
  • "generalContract": true,
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string"
}

Versicherungsvertrag aktualisieren

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
tenant
string

Mandanten-Kennung.

name
string

Interner Name des Vertrags.

therapyId
number

Therapie-ID, für die der Vertrag gilt.

therapyTypeIds
Array of numbers

Therapietyp-IDs, für die der Vertrag gilt.

validFrom
string

Gültig ab Datum.

validTo
string

Gültig bis Datum.

description
string

Beschreibung des Vertrags.

Array of objects (ISalesContract)

ERP Kassenverträge innerhalb dieses Kassenvertrags.

Definiert die Verknüpfung zu den Verträgen im ERP-System des Kunden.

insuranceContractName
string

Offizieller Name des Kassenvertrags.

payerIds
Array of strings

IDs der Kostenträger, für die der Vertrag gilt.

isSelfPayer
boolean

Gibt an, ob es sich um einen Selbstzahler-Vertrag handelt.

notPayingPayerIds
Array of strings

IDs der Kostenträger, die nicht zahlen.

pricingModelType
number (PricingModelType)
Enum: 0 1 2 3 4 5 6

Preismodell-Typ für Kassenverträge.

Definiert die Art der Preisberechnung für einen Kassenvertrag.

Wert Name Beschreibung
0 Unknown Unbekannt/nicht definiert.
1 FlatCharge Pauschale - Festbetrag unabhängig von der Menge.
2 Overvaluation Aufschlag - Preiserhöhung auf den Basispreis.
3 Undervaluation Abschlag - Preisreduzierung auf den Basispreis.
4 FixedPricing Fixpreis - Fester Preis pro Einheit.
5 Purchase Kauf - Einmaliger Kaufpreis.
6 PurchaseReplacement Kauf/Wiederbeschaffung - Kaufpreis mit Wiederbeschaffungsoption.
pricingBasis
string

Basis für die Preisberechnung.

billingType
number

Abrechnungstyp.

productGroupIds
Array of strings

IDs der Produktgruppen, die im Vertrag enthalten sind.

costEstimateRequired
boolean

Gibt an, ob ein Kostenvoranschlag erforderlich ist.

Array of objects (IProductGroupQuantity)

Maximale Mengen pro Produktgruppe.

object (IVisitInterval)

Besuchsintervall für Leistungen.

Definiert, wie oft Besuche in einem bestimmten Zeitraum stattfinden sollen.

object (IDuration)

Zeitdauer mit Menge und Zeiteinheit.

Wird für Zeiträume wie Dosierungen, Verordnungslaufzeiten oder Besuchsintervalle verwendet.

approvalObligation
boolean

Gibt an, ob eine Genehmigungspflicht besteht.

periodOnPrescriptionNecessary
boolean

Gibt an, ob ein Zeitraum auf der Verordnung erforderlich ist.

flatChargeTextAllowed
boolean

Gibt an, ob Pauschaltext erlaubt ist.

flatChargeText
string

Pauschaltext für die Abrechnung.

ageLimit
number

Obere Altersgrenze für den Vertrag.

ageLimitLower
number

Untere Altersgrenze für den Vertrag.

Array of objects (IRequiredTemplate)

Erforderliche Dokumentvorlagen für den Vertrag. Für diesen Vertrag müssen die benötigten Dokumente ausgefüllt werden um die Abrechnung zu ermöglichen.

contractArticleGroupIds
Array of strings

IDs der Vertragsartikelgruppen.

generalContract
boolean

Gibt an, ob es sich um einen allgemeinen Vertrag handelt.

_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
{
  • "tenant": "string",
  • "name": "string",
  • "therapyId": 0,
  • "therapyTypeIds": [
    ],
  • "validFrom": "string",
  • "validTo": "string",
  • "description": "string",
  • "salesContracts": [
    ],
  • "insuranceContractName": "string",
  • "payerIds": [
    ],
  • "isSelfPayer": true,
  • "notPayingPayerIds": [
    ],
  • "pricingModelType": 0,
  • "pricingBasis": "string",
  • "billingType": 0,
  • "productGroupIds": [
    ],
  • "costEstimateRequired": true,
  • "maximumAmountForProductGroups": [
    ],
  • "visitInterval": {
    },
  • "maxPermanentPrescriptionPeriod": {
    },
  • "approvalObligation": true,
  • "periodOnPrescriptionNecessary": true,
  • "flatChargeTextAllowed": true,
  • "flatChargeText": "string",
  • "ageLimit": 0,
  • "ageLimitLower": 0,
  • "requiredTemplates": [
    ],
  • "contractArticleGroupIds": [
    ],
  • "generalContract": true,
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string"
}

Response samples

Content type
application/json
{
  • "tenant": "string",
  • "name": "string",
  • "therapyId": 0,
  • "therapyTypeIds": [
    ],
  • "validFrom": "string",
  • "validTo": "string",
  • "description": "string",
  • "salesContracts": [
    ],
  • "insuranceContractName": "string",
  • "payerIds": [
    ],
  • "isSelfPayer": true,
  • "notPayingPayerIds": [
    ],
  • "pricingModelType": 0,
  • "pricingBasis": "string",
  • "billingType": 0,
  • "productGroupIds": [
    ],
  • "costEstimateRequired": true,
  • "maximumAmountForProductGroups": [
    ],
  • "visitInterval": {
    },
  • "maxPermanentPrescriptionPeriod": {
    },
  • "approvalObligation": true,
  • "periodOnPrescriptionNecessary": true,
  • "flatChargeTextAllowed": true,
  • "flatChargeText": "string",
  • "ageLimit": 0,
  • "ageLimitLower": 0,
  • "requiredTemplates": [
    ],
  • "contractArticleGroupIds": [
    ],
  • "generalContract": true,
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string"
}

Versorgung

Versorgungen abrufen

Ruft Versorgungen ab, die seit dem angegebenen Zeitpunkt geändert wurden.

Wichtig: Die Parameter status und updatedAfter sind Pflichtparameter.

Authorizations:
ApiKeyAuth
query Parameters
status
required
string
Enum: "created" "transmitted" "deactivated" "archived"

Filtert nach Änderungsstatus:

  • created: Neue Versorgungen
  • transmitted: Übermittelte Versorgungen
  • deactivated: Deaktivierte Versorgungen
  • archived: Archivierte Versorgungen
updatedAfter
required
string <date-time>

ISO 8601 Zeitstempel

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Versorgung anlegen

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 (ISeriesData)

Seriendaten für wiederkehrende Bestellungen.

Array of objects (IExtendedArticleLine)

Vorgeschlagene Artikelzeilen für diese Versorgung.

Array of objects (IExtendedServiceLine)

Vorgeschlagene Leistungspositionen für diese Versorgung.

Array of objects (IExtendedArchivedArticleLine)

Archivierte Artikelzeilen (in dieser Versorgung nicht mehr aktive Artikel).

Array of objects (IIntegratedCareHistoryLine)

Änderungshistorie der 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 (IIntegratedCareArticleLineExternal)

Responses

Request samples

Content type
application/json
{
  • "salesId": "string",
  • "patientId": "string",
  • "therapyId": 0,
  • "therapyTypeId": 0,
  • "location": 0,
  • "additionalLocations": [
    ],
  • "doctorId": "string",
  • "pharmacyId": "string",
  • "isInitialCare": true,
  • "isMonthlyOrderActivated": true,
  • "standardCareProposalId": "string",
  • "seriesData": [
    ],
  • "proposedArticleLines": [
    ],
  • "proposedServiceLines": [
    ],
  • "archivedArticleLines": [
    ],
  • "history": [
    ],
  • "annotation": "string",
  • "seriesStatus": -3,
  • "aboStopped": true,
  • "startDate": "string",
  • "status": 1,
  • "deactivationReason": "string",
  • "regionId": "string",
  • "applicationPlan": {
    },
  • "calculations": { },
  • "miscellaneous": {
    },
  • "permanentExceedMaxAmount": true,
  • "diagnose": "string",
  • "stomaCreationDate": "string",
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string",
  • "articleLines": [
    ]
}

Response samples

Content type
application/json
{
  • "salesId": "string",
  • "patientId": "string",
  • "therapyId": 0,
  • "therapyTypeId": 0,
  • "location": 0,
  • "additionalLocations": [
    ],
  • "doctorId": "string",
  • "pharmacyId": "string",
  • "isInitialCare": true,
  • "isMonthlyOrderActivated": true,
  • "standardCareProposalId": "string",
  • "seriesData": [
    ],
  • "proposedArticleLines": [
    ],
  • "proposedServiceLines": [
    ],
  • "archivedArticleLines": [
    ],
  • "history": [
    ],
  • "annotation": "string",
  • "seriesStatus": -3,
  • "aboStopped": true,
  • "startDate": "string",
  • "status": 1,
  • "deactivationReason": "string",
  • "regionId": "string",
  • "applicationPlan": {
    },
  • "calculations": { },
  • "miscellaneous": {
    },
  • "permanentExceedMaxAmount": true,
  • "diagnose": "string",
  • "stomaCreationDate": "string",
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string",
  • "articleLines": [
    ]
}

Versorgung aktualisieren

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>
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 (ISeriesData)

Seriendaten für wiederkehrende Bestellungen.

Array of objects (IExtendedArticleLine)

Vorgeschlagene Artikelzeilen für diese Versorgung.

Array of objects (IExtendedServiceLine)

Vorgeschlagene Leistungspositionen für diese Versorgung.

Array of objects (IExtendedArchivedArticleLine)

Archivierte Artikelzeilen (in dieser Versorgung nicht mehr aktive Artikel).

Array of objects (IIntegratedCareHistoryLine)

Änderungshistorie der 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 (IIntegratedCareArticleLineExternal)

Responses

Request samples

Content type
application/json
{
  • "salesId": "string",
  • "patientId": "string",
  • "therapyId": 0,
  • "therapyTypeId": 0,
  • "location": 0,
  • "additionalLocations": [
    ],
  • "doctorId": "string",
  • "pharmacyId": "string",
  • "isInitialCare": true,
  • "isMonthlyOrderActivated": true,
  • "standardCareProposalId": "string",
  • "seriesData": [
    ],
  • "proposedArticleLines": [
    ],
  • "proposedServiceLines": [
    ],
  • "archivedArticleLines": [
    ],
  • "history": [
    ],
  • "annotation": "string",
  • "seriesStatus": -3,
  • "aboStopped": true,
  • "startDate": "string",
  • "status": 1,
  • "deactivationReason": "string",
  • "regionId": "string",
  • "applicationPlan": {
    },
  • "calculations": { },
  • "miscellaneous": {
    },
  • "permanentExceedMaxAmount": true,
  • "diagnose": "string",
  • "stomaCreationDate": "string",
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string",
  • "articleLines": [
    ]
}

Response samples

Content type
application/json
{
  • "salesId": "string",
  • "patientId": "string",
  • "therapyId": 0,
  • "therapyTypeId": 0,
  • "location": 0,
  • "additionalLocations": [
    ],
  • "doctorId": "string",
  • "pharmacyId": "string",
  • "isInitialCare": true,
  • "isMonthlyOrderActivated": true,
  • "standardCareProposalId": "string",
  • "seriesData": [
    ],
  • "proposedArticleLines": [
    ],
  • "proposedServiceLines": [
    ],
  • "archivedArticleLines": [
    ],
  • "history": [
    ],
  • "annotation": "string",
  • "seriesStatus": -3,
  • "aboStopped": true,
  • "startDate": "string",
  • "status": 1,
  • "deactivationReason": "string",
  • "regionId": "string",
  • "applicationPlan": {
    },
  • "calculations": { },
  • "miscellaneous": {
    },
  • "permanentExceedMaxAmount": true,
  • "diagnose": "string",
  • "stomaCreationDate": "string",
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string",
  • "articleLines": [
    ]
}

Auftrag (deprecated)

Aufträge abrufen (deprecated) Deprecated

DEPRECATED: Bitte /singleOrder oder /directOrder verwenden.

Authorizations:
ApiKeyAuth
query Parameters
status
required
string
Enum: "created" "updated" "archived"
updatedAfter
required
string <date-time>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Auftrag aktualisieren (deprecated) Deprecated

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
regionId
string
salesId
string
patientId
string
careProposalId
string
creationDate
string <date-time>
deliveryDate
string <date-time>
accountingMonth
Array of numbers
startDate
string <date-time>
endDate
string <date-time>
dayOfDelivery
number
nextDelivery
string <date-time>
deliveryDateChanged
boolean
object (IDeliveryInterval)

Lieferintervall.

Definiert das Intervall für wiederkehrende Lieferungen.

object (IDeliveryAddress)

Lieferadresse.

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

deliveryInformation
string
doctorId
string
hospitalId
string
pharmacyId
string
therapyId
number
therapyTypeId
number
location
number
isInitialCare
boolean
Array of objects (IOrderedArticleLine)
Array of objects (IHistoryArticleLine)

Historie der Artikelzeilen.

createdBy
string

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

Referenziert einen Benutzer im System.

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.
isSeriesOrder
boolean
seriesOrderChanged
boolean
alreadyTransmitted
boolean
deliveryAddressChanged
boolean
annotation
string
rootId
string
updated
string <date-time>
deliveryNote
string
startTime
string
isHospitalPrescriber
boolean
transmittedAt
string

iso string date when order backed processed the order

_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.

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
{
  • "regionId": "string",
  • "salesId": "string",
  • "patientId": "string",
  • "careProposalId": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "deliveryDate": "2019-08-24T14:15:22Z",
  • "accountingMonth": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "dayOfDelivery": 0,
  • "nextDelivery": "2019-08-24T14:15:22Z",
  • "deliveryDateChanged": true,
  • "deliveryInterval": {
    },
  • "deliveryAddress": {
    },
  • "deliveryInformation": "string",
  • "doctorId": "string",
  • "hospitalId": "string",
  • "pharmacyId": "string",
  • "therapyId": 0,
  • "therapyTypeId": 0,
  • "location": 0,
  • "isInitialCare": true,
  • "orderedArticleLines": [
    ],
  • "articleLineHistory": [
    ],
  • "createdBy": "string",
  • "status": -3,
  • "isSeriesOrder": true,
  • "seriesOrderChanged": true,
  • "alreadyTransmitted": true,
  • "deliveryAddressChanged": true,
  • "annotation": "string",
  • "rootId": "string",
  • "updated": "2019-08-24T14:15:22Z",
  • "deliveryNote": "string",
  • "startTime": "string",
  • "isHospitalPrescriber": true,
  • "transmittedAt": "string",
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "updatedAt": "string",
  • "updatedBy": "string"
}

Response samples

Content type
application/json
{
  • "regionId": "string",
  • "salesId": "string",
  • "patientId": "string",
  • "careProposalId": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "deliveryDate": "2019-08-24T14:15:22Z",
  • "accountingMonth": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "dayOfDelivery": 0,
  • "nextDelivery": "2019-08-24T14:15:22Z",
  • "deliveryDateChanged": true,
  • "deliveryInterval": {
    },
  • "deliveryAddress": {
    },
  • "deliveryInformation": "string",
  • "doctorId": "string",
  • "hospitalId": "string",
  • "pharmacyId": "string",
  • "therapyId": 0,
  • "therapyTypeId": 0,
  • "location": 0,
  • "isInitialCare": true,
  • "orderedArticleLines": [
    ],
  • "articleLineHistory": [
    ],
  • "createdBy": "string",
  • "status": -3,
  • "isSeriesOrder": true,
  • "seriesOrderChanged": true,
  • "alreadyTransmitted": true,
  • "deliveryAddressChanged": true,
  • "annotation": "string",
  • "rootId": "string",
  • "updated": "2019-08-24T14:15:22Z",
  • "deliveryNote": "string",
  • "startTime": "string",
  • "isHospitalPrescriber": true,
  • "transmittedAt": "string",
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "updatedAt": "string",
  • "updatedBy": "string"
}

Region

Regionen abrufen

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Region abrufen

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "label": "string",
  • "parent": "string",
  • "postalCodes": [
    ],
  • "doNotChange": true,
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string"
}

Bestellung

Bestellungen abrufen

Ruft Bestellungen ab, die seit dem angegebenen Zeitpunkt geändert wurden.

Wichtig: Die Parameter status und updatedAfter sind Pflichtparameter.

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

Filtert nach Änderungsstatus:

  • created: Neue Bestellungen ohne salesId, bereit zur ERP-Abholung
  • transmitted: Bestellungen die an das Order-Backend übermittelt wurden
  • updated: Geänderte Bestellungen mit salesId
  • archived: Gelöschte/archivierte Bestellungen
updatedAfter
required
string <date-time>

ISO 8601 Zeitstempel. Nur Bestellungen, die nach diesem Zeitpunkt geändert wurden. Beispiel: 2025-01-01T00:00:00.000Z

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bestellung aktualisieren

Aktualisiert eine bestehende Bestellung.

Typischerweise wird die salesId gesetzt, um die Bestellung als vom ERP verarbeitet zu markieren.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>

Die eindeutige ID der Bestellung (UUID)

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.

object (IDeliveryAddress)

Lieferadresse.

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

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.

Array of objects (ITrackingInfo)

Tracking-Informationen zur Sendungsverfolgung.

_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)

Responses

Request 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",
  • "deliveryAddress": {
    },
  • "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": [
    ],
  • "trackingInfo": [
    ],
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string",
  • "orderedArticleLines": [
    ]
}

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",
  • "deliveryAddress": {
    },
  • "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": [
    ],
  • "trackingInfo": [
    ],
  • "_id": "string",
  • "timestamp": "string",
  • "archived": true,
  • "createdAt": "string",
  • "createdBy": "string",
  • "updatedAt": "string",
  • "updatedBy": "string",
  • "orderedArticleLines": [
    ]
}

Benutzer

Benutzer abrufen

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Benutzer abrufen

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>

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
}