API docs by Redocly

Alberta Akquinet Schnittstelle (2.0.2)

Download OpenAPI specification:

Alberta Akquinet Schnittstelle

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

Dokumentation erstellt am: 05.03.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

Viele Endpunkte unterstützen inkrementelle Synchronisation über zwei Parameter:

  • status: Filtert nach Änderungsstatus (je Endpunkt z.B. created, updated, archived, transmitted)
  • 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
/patient/customerMapping Patient anhand Kundennummer finden GET
/patientNote Notizen zu Patienten GET, POST, PATCH
/singleOrder Bestellungen (im Rahmen einer Versorgung) GET, PATCH
/directOrder Einmalige Bestellungen ohne Bezug zu einer Dauerversorgung GET, PATCH
/integratedCare Dauerversorgungen GET
/erpOrder Lieferrückmeldungen vom ERP GET, POST, PUT
/article Artikelstammdaten GET, POST, PUT
/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
/document Ausgefüllte Formulare (PDF) GET
/device Medizinische Geräte POST, PUT

Authentifizierung

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

Status & Verfügbarkeit

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

Artikel

Endpunkte zur Verwaltung von Artikeln (Produktkatalog).

Artikel abrufen

Ruft einen einzelnen Artikel anhand seiner ID ab.

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

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

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

Responses

Response samples

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

Artikel auflisten

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

Synchronisation

Der Parameter updatedAfter ist für externe Abfragen Pflicht und filtert auf Artikel, deren updatedAt größer als der angegebene Zeitstempel ist.

Hinweise

Dieser Endpunkt unterstützt auch eine interne Abfrage über customerNumber. In diesem Fall ist updatedAfter nicht erforderlich.

Authorizations:
ApiKeyAuth
query Parameters
updatedAfter
required
string <date-time>
Example: updatedAfter=2025-05-14T04:25:35.000Z

ISO 8601 Zeitstempel (z.B. 2025-05-14T04:25:35.000Z)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Artikel erstellen

Erstellt einen neuen Artikel im System.

Pflichtfelder

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

Hinweise

Wenn prescriptionType als Zahl 6 übergeben wird, wird dieser Wert serverseitig auf 0 (Drug) gesetzt.

Beim Aufruf von POST sind keine Query-Parameter erlaubt.

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 aktualisieren

Aktualisiert einen bestehenden Artikel.

Hinweise

Der Pfadparameter customerNumber ist die ERP-spezifische Artikelnummer. Beim Aufruf von PUT sind keine Query-Parameter erlaubt.

Wenn prescriptionType als Zahl 6 übergeben wird, wird dieser Wert serverseitig auf 0 (Drug) gesetzt.

Authorizations:
ApiKeyAuth
path Parameters
customerNumber
required
string
Example: 123456

ERP-spezifische Artikelnummer

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

Gerät

Endpunkte zur Verwaltung von medizinischen Geräten.

Gerät erstellen

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

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

Pflichtfelder

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

Hinweise

  • Die regionId wird automatisch vom Patienten übernommen.
  • Die _id wird automatisch generiert und darf nicht übergeben werden.
  • Beim Aufruf von POST sind keine Query-Parameter erlaubt.
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
patientId
string

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

regionId
string

ID der Region.

articleId
string

ID des zugrunde liegenden Artikels.

articleNumber
string

ERP Artikelnummer des Geräts.

serialNumber
string

Seriennummer des Geräts.

description
string

Beschreibung des Geräts.

additionalDescription
string

Zusätzliche Beschreibung.

locked
boolean

Gibt an, ob das Gerät gesperrt ist.

commissioningDate
string

Datum der Inbetriebnahme.

repairEstimateRequired
boolean

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

repairEstimateLimit
string

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

lastBookingCode
string

Letzter Buchungscode.

lastLocationCode
string

Letzter Standortcode.

ownerName
string

Name des Eigentümers.

deviceNumber
string

Gerätenummer.

registerNumber
string

Registrierungsnummer des Geräts.

Array of objects (IDeviceMaintenanceLine)

Wartungsdaten des Geräts.

Array of objects (IDeviceInformationLine)

Zusätzliche Geräteinformationen.

_id
string

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

Wird beim Erstellen automatisch generiert.

timestamp
string

Zeitstempel der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

archived
boolean

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

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

createdAt
string

Zeitpunkt der Erstellung.

Wird beim Erstellen der Entität automatisch gesetzt.

createdBy
string

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

Referenziert einen Benutzer im System.

updatedAt
string

Zeitpunkt der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

updatedBy
string

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

Referenziert einen Benutzer im System.

Responses

Request samples

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

Response samples

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

Gerät aktualisieren

Aktualisiert ein bestehendes medizinisches Gerät.

Pflichtfelder

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

Hinweise

  • Die regionId wird automatisch vom Patienten übernommen.
  • Optional kann die Geräte-ID auch als Query-Parameter id übergeben werden.
Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Die UUID des Geräts (Alberta _id).

Request Body schema: application/json
required
patientId
string

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

regionId
string

ID der Region.

articleId
string

ID des zugrunde liegenden Artikels.

articleNumber
string

ERP Artikelnummer des Geräts.

serialNumber
string

Seriennummer des Geräts.

description
string

Beschreibung des Geräts.

additionalDescription
string

Zusätzliche Beschreibung.

locked
boolean

Gibt an, ob das Gerät gesperrt ist.

commissioningDate
string

Datum der Inbetriebnahme.

repairEstimateRequired
boolean

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

repairEstimateLimit
string

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

lastBookingCode
string

Letzter Buchungscode.

lastLocationCode
string

Letzter Standortcode.

ownerName
string

Name des Eigentümers.

deviceNumber
string

Gerätenummer.

registerNumber
string

Registrierungsnummer des Geräts.

Array of objects (IDeviceMaintenanceLine)

Wartungsdaten des Geräts.

Array of objects (IDeviceInformationLine)

Zusätzliche Geräteinformationen.

_id
string

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

Wird beim Erstellen automatisch generiert.

timestamp
string

Zeitstempel der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

archived
boolean

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

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

createdAt
string

Zeitpunkt der Erstellung.

Wird beim Erstellen der Entität automatisch gesetzt.

createdBy
string

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

Referenziert einen Benutzer im System.

updatedAt
string

Zeitpunkt der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

updatedBy
string

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

Referenziert einen Benutzer im System.

Responses

Request samples

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

Response samples

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

Arzt

Endpunkte zur Abfrage von Ärzten.

Arzt abrufen

Ruft einen einzelnen Arzt anhand seiner ID ab.

Hinweis: Das Feld draft wird serverseitig entfernt und ist daher nicht Teil der externen API.

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

Die UUID des Arztes (Alberta _id).

Responses

Response samples

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

Ärzte auflisten

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

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

Authorizations:
ApiKeyAuth
query Parameters
_id
string

UUID des Arztes.

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

ISO 8601 Zeitstempel für inkrementelle Synchronisation.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Pflegeheim

Endpunkte zur Abfrage von Pflegeheimen.

Pflegeheim abrufen

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Pflegeheime auflisten

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Pflegedienst

Endpunkte zur Abfrage von Pflegediensten.

Pflegedienst abrufen

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Pflegedienste auflisten

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Krankenhaus

Endpunkte zur Abfrage von Krankenhäusern.

Krankenhaus abrufen

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Krankenhäuser auflisten

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Kostenträger

Endpunkte zur Abfrage von Kostenträgern (Krankenkassen).

Kostenträger abrufen

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

UUID des Kostenträgers.

Responses

Response samples

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

Kostenträger auflisten

Listet Kostenträger auf, gefiltert nach _id oder updatedAfter.

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Postleitzahl

Endpunkte zur Abfrage von Postleitzahlen.

Postleitzahl abrufen

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

UUID der Postleitzahl.

Responses

Response samples

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

Postleitzahlen auflisten

Listet Postleitzahlen auf, gefiltert nach _id, updatedAfter oder postalCode.

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Apotheke

Endpunkte zur Abfrage von Apotheken.

Apotheke abrufen

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Response samples

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

Apotheken auflisten

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Region

Endpunkte zur Abfrage von Regionen.

Region abrufen

Ruft eine einzelne Region anhand ihrer ID ab.

In der Antwort werden u.a. postalCodes sowie Audit-Felder entfernt.

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

Die UUID der Region (Alberta _id).

Responses

Response samples

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

Regionen auflisten

Listet alle Regionen auf.

Regionen dienen der geografischen Strukturierung im Alberta Homecare-System. Sie steuern u.a. Sichtbarkeit und Synchronisation von Entitäten.

In der Antwort werden u.a. postalCodes sowie Audit-Felder entfernt.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Benutzer

Endpunkte zur Abfrage von Benutzern.

Benutzer abrufen

Ruft einen einzelnen Benutzer anhand seiner ID ab.

Der Zugriff ist auf Benutzer der Organisation eingeschränkt, die zur API-Key Authentifizierung gehört. Sensible Felder werden serverseitig entfernt.

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

Die UUID des Benutzers (Alberta _id).

Responses

Response samples

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

Benutzer auflisten

Listet Benutzer der Organisation auf, die zur API-Key Authentifizierung gehört.

Synchronisation

updatedAfter ist Pflicht und wird zur inkrementellen Synchronisation verwendet.

Filter

  • status=active: Nicht archivierte Benutzer
  • status=archived: Archivierte Benutzer

Sensible Felder werden serverseitig entfernt.

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

Filtert Benutzer nach Archivierungsstatus.

updatedAfter
required
string <date-time>
Example: updatedAfter=2025-05-14T04:25:35.000Z

ISO 8601 Zeitstempel (z.B. 2025-05-14T04:25:35.000Z)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Anlage

Anlagen auflisten

Listet Anlagen (Dateien) auf, die seit einem bestimmten Zeitpunkt erstellt wurden.

Synchronisation

Der Parameter createdAfter kann verwendet werden, um die Liste inkrementell zu laden.

Hinweise

In der Response werden einige technische Felder entfernt:

  • chunkSize, md5, length, timestamp
  • metadata.uniqueId, metadata.patientApp, metadata.auditId, metadata.auditNodeId
  • metadata.regionId, metadata.templateId, metadata.templateNodeId

Zusätzlich werden bestimmte interne Attachment-Typen gefiltert (z.B. Swodoc-Bilder).

Authorizations:
ApiKeyAuth
query Parameters
createdAfter
string <date-time>
Example: createdAfter=2025-05-14T04:25:35.000Z

ISO 8601 Zeitstempel (z.B. 2025-05-14T04:25:35.000Z)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Anlage herunterladen

Lädt die Datei-Daten einer Anlage anhand ihrer ID.

Je nach Speicherung wird die Datei aus GCP oder GridFS geladen.

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

ID der Anlage (MongoDB ObjectId als String)

Responses

Dokument

Dokumente auflisten

Listet Dokumente (Audits) auf, die seit einem bestimmten Zeitpunkt erstellt wurden.

Synchronisation

Der Parameter createdAfter ist Pflicht und filtert auf Dokumente mit einem updatedAt größer als der angegebene Zeitstempel.

Hinweise

Der Service liefert eine reduzierte Dokumentliste (z.B. mit name, patientId). Die name wird serverseitig aus dem zugehörigen Template-Titel abgeleitet.

Authorizations:
ApiKeyAuth
query Parameters
createdAfter
required
string <date-time>
Example: createdAfter=2025-05-14T04:25:35.000Z

ISO 8601 Zeitstempel (z.B. 2025-05-14T04:25:35.000Z)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Dokument herunterladen

Rendert ein Dokument (Audit) anhand seiner ID als PDF.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 2c0a1b2a-3e17-4f09-9c2a-1f9f3b0c2a11

ID des Dokuments (IAudit._id)

Responses

Patient

Patient anhand Kundennummer finden

Ermittelt die interne Patienten-ID (_id) anhand einer externen Kundennummer (customerId).

Der Endpoint liefert ein kleines Mapping-Objekt (kein vollständiges Patient-Objekt).

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string
Example: K-1000001

Externe Kundennummer.

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "customerId": "string",
  • "updatedAt": "string"
}

Patient-Notizen auflisten

Listet Patient-Notizen.

Es ist entweder updatedAfter oder patientId erlaubt.

Authorizations:
ApiKeyAuth
query Parameters
updatedAfter
string <date-time>
Example: updatedAfter=2025-05-14T04:25:35.000Z

ISO-Zeitstempel. Wenn gesetzt, werden Notizen zurückgegeben, die nach diesem Zeitpunkt aktualisiert wurden.

patientId
string
Example: patientId=550e8400-e29b-41d4-a716-446655440000

Patienten-ID (_id). Wenn gesetzt, werden Notizen für diesen Patienten zurückgegeben.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Patient-Notiz anlegen

Legt eine neue Patient-Notiz an.

Pflichtfelder sind noteText, status und patientId.

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
}

Patient-Notiz aktualisieren

Aktualisiert eine bestehende Patient-Notiz.

Hinweis: Query-Parameter sind bei diesem Endpoint nicht erlaubt.

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

ID der Patient-Notiz (_id).

Request Body schema: application/json
required
noteText
string

Text der Notiz.

patientId
string

ID des Patienten.

regionId
string

ID der Region.

createdAt
string

Erstellungszeitpunkt.

updatedAt
string

Zeitpunkt der letzten Bearbeitung.

createdBy
string

ID des Erstellers.

updatedBy
string

ID des letzten Bearbeiters.

edited
boolean

Gibt an, ob die Notiz bearbeitet wurde.

status
number (NoteType)
Enum: 1 2 3

Typ einer Notiz.

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

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

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

Wird beim Erstellen automatisch generiert.

timestamp
string

Zeitstempel der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

archived
boolean

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

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

Responses

Request samples

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

Response samples

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

Patienten abrufen

Ruft Patienten für Synchronisationszwecke ab.

Synchronisation

Die Parameter status und updatedAfter sind Pflichtparameter.

Hinweise

In der Response werden einige interne Felder entfernt:

  • therapies, diagnoses
  • postalCodeId (auch in careGivers)
  • primaryDoctor, nursingHome, nursingService, pharmacy
  • hospital.subunitId, hospital.contactId

Zusätzlich werden diese Felder angereichert:

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

Filtert nach Änderungsstatus:

  • created: Neue Datensätze (z.B. ohne customerId)
  • updated: Geänderte Datensätze
  • archived: Archivierte Datensätze
updatedAfter
required
string <date-time>
Example: updatedAfter=2025-05-14T04:25:35.000Z

ISO 8601 Zeitstempel (z.B. 2025-05-14T04:25:35.000Z)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Patient abrufen

Ruft einen Patienten anhand seiner ID ab.

Hinweise

In der Response werden einige interne Felder entfernt und einige Felder angereichert. Details siehe GET /patient.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 2c0a1b2a-3e17-4f09-9c2a-1f9f3b0c2a11

ID des Patienten (IPatient._id)

Responses

Response samples

Content type
application/json
{
  • "city": "string",
  • "postalCode": "string",
  • "additionalAddress": "string",
  • "additionalAddress2": "string",
  • "gender": 0,
  • "title": 0,
  • "customerId": "string",
  • "birthday": "string",
  • "fieldNurseId": "string",
  • "regionId": "string",
  • "payerInstitutionCode": "string",
  • "primaryDoctorId": "string",
  • "nursingHomeId": "string",
  • "nursingServiceId": "string",
  • "deactivationReason": 0,
  • "deactivationDate": "string",
  • "deactivationComment": "string",
  • "nextVisit": "string",
  • "ivTherapy": true,
  • "classification": "string",
  • "pharmacyId": "string",
  • "changeInSupplier": true,
  • "billingAddress": {
    },
  • "deliveryAddress": {
    },
  • "comment": "string",
  • "erpStatus": "Liefersperre",
  • "deliveryInformation": {
    },
  • "additionalUserId": "string",
  • "additionalUserIds": [
    ],
  • "careDegree": 1,
  • "calorieDemand": 0,
  • "dashboardInfo": [
    ],
  • "status": "string",
  • "additionalAttributes": { },
  • "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": {
    },
  • "primaryDoctor": {
    },
  • "nursingHome": {
    },
  • "nursingService": {
    },
  • "pharmacy": {
    },
  • "careGivers": [
    ],
  • "primaryDoctorInstitution": {
    },
  • "zec": "string"
}

Direktbestellung

Direktbestellungen abrufen

Ruft Direktbestellungen (IDirectOrder) für Synchronisationszwecke ab.

Synchronisation

Die Parameter status und updatedAfter sind Pflichtparameter.

Hinweise

In der Response werden therapyId und therapyTypeId durch einen Hook in Enum-Werte umgewandelt. Dadurch können diese Felder als string (Enum-Name) zurückgegeben werden.

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

Filtert nach Änderungsstatus:

  • created: Neue Direktbestellungen (z.B. ohne salesId)
  • transmitted: Übermittelte/gestoppte Direktbestellungen (z.B. ohne salesId)
  • updated: Geänderte Direktbestellungen (typischerweise mit salesId)
  • archived: Archivierte Direktbestellungen
updatedAfter
required
string <date-time>
Example: updatedAfter=2025-05-14T04:25:35.000Z

ISO 8601 Zeitstempel (z.B. 2025-05-14T04:25:35.000Z)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Direktbestellung aktualisieren

Aktualisiert eine bestehende Direktbestellung via PATCH.

Hinweise

Beim Aufruf von PATCH sind keine Query-Parameter erlaubt.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 2c0a1b2a-3e17-4f09-9c2a-1f9f3b0c2a11

ID der Direktbestellung (IDirectOrder._id)

Request Body schema: application/json
required
regionId
string

ID der Region, der der Auftrag zugeordnet ist.

salesId
string

Id des Auftrag im ERP-System des Kunden

patientId
string

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

creationDate
string

Erstellungsdatum des Auftrags.

deliveryDate
string

Geplantes Lieferdatum.

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)
therapyId
number or string
therapyTypeId
number or string

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": [
    ],
  • "therapyId": 0,
  • "therapyTypeId": 0
}

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": [
    ],
  • "therapyId": 0,
  • "therapyTypeId": 0
}

ERP-Auftrag

ERP-Aufträge auflisten

Listet ERP-Aufträge basierend auf Query-Parametern.

Hinweis: Das Feld therapyId wird serverseitig ggf. in eine Zahl konvertiert.

Authorizations:
ApiKeyAuth
query Parameters
salesId
string
Example: salesId=ERP-123456

Optionaler Filter nach salesId (ERP-Auftragsnummer).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ERP-Auftrag anlegen

Legt einen neuen ERP-Auftrag an.

Hinweis: Query-Parameter sind bei diesem Endpoint nicht erlaubt.

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

ID des Patienten.

regionId
required
string

ID der Region.

salesId
required
string

Id des Auftrag im ERP-System des Kunden

required
object (IDeliveryAddress)

Lieferadresse.

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

outboundDate
required
string

Versanddatum.

required
Array of objects (IErpOrderedArticleLine)

Bestellte Artikelzeilen.

annotation
required
string

Anmerkung.

prescriptionStatus
required
string

Rezeptstatus.

completed
required
boolean

Gibt an, ob die Bestellung abgeschlossen ist.

trackingLink
required
string

Link zur Sendungsverfolgung.

required
Array of objects (ITrackingInfo)

Tracking-Informationen.

_id
required
string

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

Wird beim Erstellen automatisch generiert.

timestamp
required
string

Zeitstempel der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

archived
required
boolean

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

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

Responses

Request samples

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

ERP-Auftrag aktualisieren

Aktualisiert einen bestehenden ERP-Auftrag.

Als id wird die salesId verwendet. Intern wird dann die passende _id ermittelt.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: ERP-123456

salesId des ERP-Auftrags.

Request Body schema: application/json
required
therapyId
required
number or string
patientId
required
string

ID des Patienten.

regionId
required
string

ID der Region.

salesId
required
string

Id des Auftrag im ERP-System des Kunden

required
object (IDeliveryAddress)

Lieferadresse.

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

outboundDate
required
string

Versanddatum.

required
Array of objects (IErpOrderedArticleLine)

Bestellte Artikelzeilen.

annotation
required
string

Anmerkung.

prescriptionStatus
required
string

Rezeptstatus.

completed
required
boolean

Gibt an, ob die Bestellung abgeschlossen ist.

trackingLink
required
string

Link zur Sendungsverfolgung.

required
Array of objects (ITrackingInfo)

Tracking-Informationen.

_id
required
string

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

Wird beim Erstellen automatisch generiert.

timestamp
required
string

Zeitstempel der letzten Änderung.

Wird bei jeder Änderung automatisch aktualisiert.

archived
required
boolean

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

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

Responses

Request samples

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

Versorgung

Versorgungen abrufen

Ruft Versorgungen (IIntegratedCare) für Synchronisationszwecke ab.

Synchronisation

Die Parameter status und updatedAfter sind Pflichtparameter.

Hinweise

In der Response werden therapyId und therapyTypeId durch einen Hook in Enum-Werte umgewandelt. Dadurch können diese Felder als string (Enum-Name) zurückgegeben werden.

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

Filtert nach Änderungsstatus:

  • created: Neue Versorgungen
  • transmitted: Übermittelte Versorgungen
  • deactivated: Deaktivierte Versorgungen
  • archived: Archivierte Versorgungen
updatedAfter
required
string <date-time>
Example: updatedAfter=2025-05-14T04:25:35.000Z

ISO 8601 Zeitstempel (z.B. 2025-05-14T04:25:35.000Z)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bestellung

Bestellungen abrufen

Ruft Bestellungen (ISingleOrder) für Synchronisationszwecke ab.

Synchronisation

Die Parameter status und updatedAfter sind Pflichtparameter.

Hinweise

In der Response werden therapyId und therapyTypeId durch einen Hook in Enum-Werte umgewandelt. Dadurch können diese Felder als string (Enum-Name) zurückgegeben werden.

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

Filtert nach Änderungsstatus:

  • created: Neue Bestellungen (z.B. ohne salesId)
  • transmitted: Übermittelte/gestoppte Bestellungen (z.B. ohne salesId)
  • updated: Geänderte Bestellungen (typischerweise mit salesId)
  • archived: Archivierte Bestellungen
updatedAfter
required
string <date-time>
Example: updatedAfter=2025-05-14T04:25:35.000Z

ISO 8601 Zeitstempel (z.B. 2025-05-14T04:25:35.000Z)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bestellung aktualisieren

Aktualisiert eine bestehende Bestellung via PATCH.

Hinweise

Beim Aufruf von PATCH sind keine Query-Parameter erlaubt.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 2c0a1b2a-3e17-4f09-9c2a-1f9f3b0c2a11

ID der Bestellung (ISingleOrder._id)

Request Body schema: application/json
required
regionId
string

ID der Region, der der Auftrag zugeordnet ist.

salesId
string

Vorgangsnummer im ERP-System des Kunden

patientId
string

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

integratedCareId
string

ID der zugehörigen IntegratedCare (Versorgung).

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

creationDate
string

Erstellungsdatum des Auftrags.

deliveryDate
string

Geplantes Lieferdatum.

deliveryOption
string

Lieferoption.

reminderDate
string

Datum für die Erinnerung zur Nachbestellung.

accountingMonth
Array of numbers

Abrechnungsmonate für den Auftrag.

startDate
string

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

endDate
string

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

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.

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)
therapyId
number or string
therapyTypeId
number or string

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",
  • "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": [
    ],
  • "therapyId": 0,
  • "therapyTypeId": 0
}

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",
  • "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": [
    ],
  • "therapyId": 0,
  • "therapyTypeId": 0
}