API docs by Redocly

Alberta Akquinet Schnittstelle (2.0.1)

Download OpenAPI specification:

Alberta Akquinet Schnittstelle

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

Dokumentation erstellt am: 30.12.2025

Datenmodell & Organisationsstruktur

Kernkonzepte

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

Versorgung & Bestellungen

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

ERP-Synchronisation

Wichtige Felder

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

Inkrementelle Synchronisation

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": "2019-08-24T14:15:22Z",
  • "unavailableFrom": "2019-08-24T14:15:22Z",
  • "delayedTo": "2019-08-24T14:15:22Z",
  • "inventoryType": 0,
  • "stars": 0,
  • "attributes": [
    ],
  • "substituteArticleCustomerNumber": "string",
  • "requiresSerialnumber": true,
  • "requiresBatchnumber": true,
  • "requiresValidToDate": true,
  • "directOrder": true,
  • "pharmacyOnly": true,
  • "statusAnnotation": "string",
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "archived": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "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
name
string
description
string
manufacturerNumber
string
customerNumber
string
medicalAidPositionNumber
string
ean
string
additionalDescription
string
manufacturer
string
size
string
assortmentType
number
status
number
productGroupId
string
therapyIds
Array of numbers
billableTherapies
Array of numbers
prescriptionType
number (PrescriptionType)
Enum: 0 1 2 3 4 5 7
Wert Name Beschreibung
0 Drug
1 Dressings
2 NarcoticsRecipe
3 NursingAids
4 AdisForConsumption
5 AidsForUse
7 TubeFeeding
Array of objects (IQuantityPerUnit)
pharmacyPrice
string
listPrice
string
Array of objects (IInsuranceFixedPrice)
fixedPrice
string
purchaseRating
number
unavailableTo
string <date-time>
unavailableFrom
string <date-time>
delayedTo
string <date-time>
inventoryType
number (InventoryType)
Enum: 0 1 2
Wert Name Beschreibung
0 Unknown
1 Store
2 Order
stars
number
Array of objects (IAttribute)
substituteArticleCustomerNumber
string
requiresSerialnumber
boolean
requiresBatchnumber
boolean
requiresValidToDate
boolean
directOrder
boolean
pharmacyOnly
boolean
statusAnnotation
string
_id
string
timestamp
string <date-time>
archived
boolean
createdAt
string <date-time>
createdBy
string
updatedAt
string <date-time>
updatedBy
string

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": "2019-08-24T14:15:22Z",
  • "unavailableFrom": "2019-08-24T14:15:22Z",
  • "delayedTo": "2019-08-24T14:15:22Z",
  • "inventoryType": 0,
  • "stars": 0,
  • "attributes": [
    ],
  • "substituteArticleCustomerNumber": "string",
  • "requiresSerialnumber": true,
  • "requiresBatchnumber": true,
  • "requiresValidToDate": true,
  • "directOrder": true,
  • "pharmacyOnly": true,
  • "statusAnnotation": "string",
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "archived": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "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": "2019-08-24T14:15:22Z",
  • "unavailableFrom": "2019-08-24T14:15:22Z",
  • "delayedTo": "2019-08-24T14:15:22Z",
  • "inventoryType": 0,
  • "stars": 0,
  • "attributes": [
    ],
  • "substituteArticleCustomerNumber": "string",
  • "requiresSerialnumber": true,
  • "requiresBatchnumber": true,
  • "requiresValidToDate": true,
  • "directOrder": true,
  • "pharmacyOnly": true,
  • "statusAnnotation": "string",
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "archived": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "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
name
string
description
string
manufacturerNumber
string
customerNumber
string
medicalAidPositionNumber
string
ean
string
additionalDescription
string
manufacturer
string
size
string
assortmentType
number
status
number
productGroupId
string
therapyIds
Array of numbers
billableTherapies
Array of numbers
prescriptionType
number (PrescriptionType)
Enum: 0 1 2 3 4 5 7
Wert Name Beschreibung
0 Drug
1 Dressings
2 NarcoticsRecipe
3 NursingAids
4 AdisForConsumption
5 AidsForUse
7 TubeFeeding
Array of objects (IQuantityPerUnit)
pharmacyPrice
string
listPrice
string
Array of objects (IInsuranceFixedPrice)
fixedPrice
string
purchaseRating
number
unavailableTo
string <date-time>
unavailableFrom
string <date-time>
delayedTo
string <date-time>
inventoryType
number (InventoryType)
Enum: 0 1 2
Wert Name Beschreibung
0 Unknown
1 Store
2 Order
stars
number
Array of objects (IAttribute)
substituteArticleCustomerNumber
string
requiresSerialnumber
boolean
requiresBatchnumber
boolean
requiresValidToDate
boolean
directOrder
boolean
pharmacyOnly
boolean
statusAnnotation
string
_id
string
timestamp
string <date-time>
archived
boolean
createdAt
string <date-time>
createdBy
string
updatedAt
string <date-time>
updatedBy
string

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": "2019-08-24T14:15:22Z",
  • "unavailableFrom": "2019-08-24T14:15:22Z",
  • "delayedTo": "2019-08-24T14:15:22Z",
  • "inventoryType": 0,
  • "stars": 0,
  • "attributes": [
    ],
  • "substituteArticleCustomerNumber": "string",
  • "requiresSerialnumber": true,
  • "requiresBatchnumber": true,
  • "requiresValidToDate": true,
  • "directOrder": true,
  • "pharmacyOnly": true,
  • "statusAnnotation": "string",
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "archived": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "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": "2019-08-24T14:15:22Z",
  • "unavailableFrom": "2019-08-24T14:15:22Z",
  • "delayedTo": "2019-08-24T14:15:22Z",
  • "inventoryType": 0,
  • "stars": 0,
  • "attributes": [
    ],
  • "substituteArticleCustomerNumber": "string",
  • "requiresSerialnumber": true,
  • "requiresBatchnumber": true,
  • "requiresValidToDate": true,
  • "directOrder": true,
  • "pharmacyOnly": true,
  • "statusAnnotation": "string",
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "archived": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "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
regionId
string
articleId
string
articleNumber
string
serialNumber
string
description
string
additionalDescription
string
locked
boolean
commissioningDate
string
repairEstimateRequired
boolean
repairEstimateLimit
string
lastBookingCode
string
lastLocationCode
string
ownerName
string
deviceNumber
string
registerNumber
string
Array of objects (IDeviceMaintenanceLine)
Array of objects (IDeviceInformationLine)
_id
string
timestamp
string <date-time>
archived
boolean
createdAt
string <date-time>
createdBy
string
updatedAt
string <date-time>
updatedBy
string

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": "2019-08-24T14:15:22Z",
  • "archived": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "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
regionId
string
articleId
string
articleNumber
string
serialNumber
string
description
string
additionalDescription
string
locked
boolean
commissioningDate
string
repairEstimateRequired
boolean
repairEstimateLimit
string
lastBookingCode
string
lastLocationCode
string
ownerName
string
deviceNumber
string
registerNumber
string
Array of objects (IDeviceMaintenanceLine)
Array of objects (IDeviceInformationLine)
_id
string
timestamp
string <date-time>
archived
boolean
createdAt
string <date-time>
createdBy
string
updatedAt
string <date-time>
updatedBy
string

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": "2019-08-24T14:15:22Z",
  • "archived": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "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": "2019-08-24T14:15:22Z",
  • "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,
  • "isKiwiUser": true,
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "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,
  • "isKiwiUser": true,
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "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,
  • "isKiwiUser": true,
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "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": "2019-08-24T14:15:22Z",
  • "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": "2019-08-24T14:15:22Z",
  • "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,
  • "isKiwiUser": true,
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "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": "2019-08-24T14:15:22Z",
  • "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
{
  • "groups": [
    ],
  • "organization": "string",
  • "isOnline": true,
  • "modules": null,
  • "active": true,
  • "o365Id": "string",
  • "isAgent": true,
  • "userAlreadyInFusionAuth": true,
  • "storageLocation": "string",
  • "accountingType": "full",
  • "salesPersonId": "string",
  • "employeeId": "string",
  • "externalReference": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "address": "string",
  • "postalCodeId": "string",
  • "postalCode": "string",
  • "city": "string",
  • "phone": "string",
  • "mobilePhone": "string",
  • "email": "string",
  • "fax": "string",
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "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
patientId
string
regionId
string
createdAt
string <date-time>
updatedAt
string <date-time>
createdBy
string
updatedBy
string
edited
boolean
status
number (NoteType)
Enum: 1 2 3
Wert Name Beschreibung
1 Note
2 Information
3 Warning
_id
string
timestamp
string <date-time>
archived
boolean

Responses

Request samples

Content type
application/json
{
  • "noteText": "string",
  • "patientId": "string",
  • "regionId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "edited": true,
  • "status": 1,
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "archived": true
}

Response samples

Content type
application/json
{
  • "noteText": "string",
  • "patientId": "string",
  • "regionId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "edited": true,
  • "status": 1,
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "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
patientId
string
regionId
string
createdAt
string <date-time>
updatedAt
string <date-time>
createdBy
string
updatedBy
string
edited
boolean
status
number (NoteType)
Enum: 1 2 3
Wert Name Beschreibung
1 Note
2 Information
3 Warning
_id
string
timestamp
string <date-time>
archived
boolean

Responses

Request samples

Content type
application/json
{
  • "noteText": "string",
  • "patientId": "string",
  • "regionId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "edited": true,
  • "status": 1,
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "archived": true
}

Response samples

Content type
application/json
{
  • "noteText": "string",
  • "patientId": "string",
  • "regionId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "edited": true,
  • "status": 1,
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "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",
  • "customerContactId": "string",
  • "accountingStatus": true,
  • "birthday": "2019-08-24T14:15:22Z",
  • "fieldNurseId": "string",
  • "regionId": "string",
  • "payerInstitutionCode": "string",
  • "primaryDoctorId": "string",
  • "nursingHomeId": "string",
  • "nursingServiceId": "string",
  • "deactivationReason": 0,
  • "deactivationDate": "2019-08-24T14:15:22Z",
  • "deactivationComment": "string",
  • "nextVisit": "2019-08-24T14:15:22Z",
  • "ivTherapy": true,
  • "classification": "string",
  • "pharmacyId": "string",
  • "changeInSupplier": true,
  • "billingAddress": {
    },
  • "deliveryAddress": {
    },
  • "comment": "string",
  • "erpStatus": "Liefersperre",
  • "imported": true,
  • "resmedTenant": "string",
  • "validToDate": "2019-08-24T14:15:22Z",
  • "deliveryInformation": {
    },
  • "additionalUserId": "string",
  • "additionalUserIds": [
    ],
  • "careDegree": 1,
  • "calorieDemand": 0,
  • "dashboardInfo": [
    ],
  • "status": "string",
  • "additionalAttributes": { },
  • "calendarResourceId": "string",
  • "referrer": {
    },
  • "accountingType": "full",
  • "specializedServiceProviderBranchId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "address": "string",
  • "phone": "string",
  • "mobilePhone": "string",
  • "email": "string",
  • "fax": "string",
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "archived": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "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
salesId
string
patientId
string
creationDate
string <date-time>
deliveryDate
string <date-time>
object (IDeliveryAddress)
deliveryInformation
string
status
number (OrderStatus)
Enum: -3 -2 -1 0 1 2 3 4 5 6 7 8 9 10
Wert Name Beschreibung
-3 Pending
-2 Canceled
-1 Deleted
0 Created
1 Transmitted
2 Transmission_failure
3 Processed
4 Sent
5 Delivered
6 OrderStopped
7 ErpCall
8 InProgress
9 Progressed
10 PartiallySent
annotation
string
resmedTenant
string
orderType
number (OrderType)
Enum: 0 1 2
Wert Name Beschreibung
0 Initial
1 Followup
2 Staff
transmittedAt
string

iso string date when order backed processed the order

_id
string
timestamp
string <date-time>
archived
boolean
createdAt
string <date-time>
createdBy
string
updatedAt
string <date-time>
updatedBy
string
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": "2019-08-24T14:15:22Z",
  • "deliveryDate": "2019-08-24T14:15:22Z",
  • "deliveryAddress": {
    },
  • "deliveryInformation": "string",
  • "status": -3,
  • "annotation": "string",
  • "resmedTenant": "string",
  • "orderType": 0,
  • "transmittedAt": "string",
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "archived": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "orderedArticleLines": [
    ],
  • "therapyId": 0,
  • "therapyTypeId": 0
}

Response samples

Content type
application/json
{
  • "regionId": "string",
  • "salesId": "string",
  • "patientId": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "deliveryDate": "2019-08-24T14:15:22Z",
  • "deliveryAddress": {
    },
  • "deliveryInformation": "string",
  • "status": -3,
  • "annotation": "string",
  • "resmedTenant": "string",
  • "orderType": 0,
  • "transmittedAt": "string",
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "archived": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "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
regionId
required
string
salesId
required
string
required
object (IDeliveryAddress)
outboundDate
required
string <date-time>
required
Array of objects (IErpOrderedArticleLine)
annotation
required
string
prescriptionStatus
required
string
completed
required
boolean
trackingLink
required
string
required
Array of objects (ITrackingInfo)
_id
required
string
timestamp
required
string <date-time>
archived
required
boolean

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "therapyId": 0,
  • "patientId": "string",
  • "regionId": "string",
  • "salesId": "string",
  • "deliveryAddress": {
    },
  • "outboundDate": "2019-08-24T14:15:22Z",
  • "erpOrderedArticleLines": [
    ],
  • "annotation": "string",
  • "prescriptionStatus": "string",
  • "completed": true,
  • "trackingLink": "string",
  • "trackingInfo": [
    ],
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "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
regionId
required
string
salesId
required
string
required
object (IDeliveryAddress)
outboundDate
required
string <date-time>
required
Array of objects (IErpOrderedArticleLine)
annotation
required
string
prescriptionStatus
required
string
completed
required
boolean
trackingLink
required
string
required
Array of objects (ITrackingInfo)
_id
required
string
timestamp
required
string <date-time>
archived
required
boolean

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "therapyId": 0,
  • "patientId": "string",
  • "regionId": "string",
  • "salesId": "string",
  • "deliveryAddress": {
    },
  • "outboundDate": "2019-08-24T14:15:22Z",
  • "erpOrderedArticleLines": [
    ],
  • "annotation": "string",
  • "prescriptionStatus": "string",
  • "completed": true,
  • "trackingLink": "string",
  • "trackingInfo": [
    ],
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "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
salesId
string
patientId
string
integratedCareId
string
creationDate
string <date-time>
deliveryDate
string <date-time>
reminderDate
string <date-time>
accountingMonth
Array of numbers
startDate
string <date-time>
endDate
string <date-time>
object (IDeliveryAddress)
deliveryInformation
string
doctorId
string
pharmacyId
string
location
number
expressDelivery
boolean
isInitialCare
boolean
status
number (OrderStatus)
Enum: -3 -2 -1 0 1 2 3 4 5 6 7 8 9 10
Wert Name Beschreibung
-3 Pending
-2 Canceled
-1 Deleted
0 Created
1 Transmitted
2 Transmission_failure
3 Processed
4 Sent
5 Delivered
6 OrderStopped
7 ErpCall
8 InProgress
9 Progressed
10 PartiallySent
annotation
string
resmedTenant
string
deliveryNote
string
deliveryStartTime
string
hospitalId
string
prescriptionStatus
string (TransmissionStatus)
Enum: "transmissionPending" "transmissionInitiated" "transmissionFailed" "faxWaiting" "faxProcessing" "faxSending" "faxFailed" "emailFailed" "requested" "toClarify" "canceled" "faulty" "copyReceived" "originalReceived"
Wert Name Beschreibung
"transmissionPending" TransmissionPending
"transmissionInitiated" TransmissionInitiated
"transmissionFailed" TransmissionFailed
"faxWaiting" FaxWaiting
"faxProcessing" FaxProcessing
"faxSending" FaxSending
"faxFailed" FaxFailed
"emailFailed" EmailFailed
"requested" Requested
"toClarify" ToClarify
"canceled" Canceled
"faulty" Faulty
"copyReceived" CopyReceived
"originalReceived" OriginalReceived
isHospitalPrescriber
boolean
tags
Array of strings
groupOrderId
string
isGroupOrder
boolean
orderNumber
string
attachments
Array of strings
erpOrderNumber
string
externalReference
string
transmittedAt
string

iso string date when order backed processed the order

hasFollowUpOrder
boolean

Is set, when another order inside the same integratedcare is created after this one

auditIds
Array of strings
Array of objects (ITrackingInfo)
_id
string
timestamp
string <date-time>
archived
boolean
createdAt
string <date-time>
createdBy
string
updatedAt
string <date-time>
updatedBy
string
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": "2019-08-24T14:15:22Z",
  • "deliveryDate": "2019-08-24T14:15:22Z",
  • "reminderDate": "2019-08-24T14:15:22Z",
  • "accountingMonth": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "deliveryAddress": {
    },
  • "deliveryInformation": "string",
  • "doctorId": "string",
  • "pharmacyId": "string",
  • "location": 0,
  • "expressDelivery": true,
  • "isInitialCare": true,
  • "status": -3,
  • "annotation": "string",
  • "resmedTenant": "string",
  • "deliveryNote": "string",
  • "deliveryStartTime": "string",
  • "hospitalId": "string",
  • "prescriptionStatus": "transmissionPending",
  • "isHospitalPrescriber": true,
  • "tags": [
    ],
  • "groupOrderId": "string",
  • "isGroupOrder": true,
  • "orderNumber": "string",
  • "attachments": [
    ],
  • "erpOrderNumber": "string",
  • "externalReference": "string",
  • "transmittedAt": "string",
  • "hasFollowUpOrder": true,
  • "auditIds": [
    ],
  • "trackingInfo": [
    ],
  • "_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "archived": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "orderedArticleLines": [
    ],
  • "therapyId": 0,
  • "therapyTypeId": 0
}

Response samples

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