arztkonsultationarztkonsultation Docs
API referencev1.10.0Deutsch

Partner API changelog

1.10.0 — 2026-10-04

Added

  • Room calendar for pharmacy rooms. getPartnerPharmacyRoomCalendar reads the calendar per room and day. createPartnerPharmacyRoomException, retractPartnerPharmacyRoomException, listPartnerPharmacyRoomExceptions and closePartnerPharmacyRooms maintain day closures, ranges, changed hours and extra openings with fixed reason codes. changePartnerPharmacyRoomSchedule sets the weekly hours from a date.
  • Statutory holidays per federal state: getPartnerPharmacyHolidayPolicy, updatePartnerPharmacyHolidayPolicy, openPartnerPharmacyRoomHoliday and revokePartnerPharmacyRoomHolidayOpening.
  • previewPartnerPharmacyRoomCalendarImpact returns only counts of affected booked appointments in advance. Booked appointments stay in place for every change. The optional impactVersion confirms a preview; a stale value returns 409 with the code ROOM_CALENDAR_IMPACT_STALE.

Partner action for 1.10.0

Optional. Regenerate clients from version 1.10.0 to use the new operations. Existing room operations, schemas and webhooks are unchanged. Handle unknown values in kind, status, reasonCode, stateCode and source tolerantly, because enums may grow in compatible versions.

1.9.0 — 2026-09-28

Added

  • listPartnerPharmacies may include optional pharmacyLogin with the effective mode, reconciliation status and availability for one uniquely bound active pharmacy. The existing organizationId and partnerOrgId link fields are unchanged.

Partner action for 1.9.0

Regenerate clients from version 1.9.0 if you want to display pharmacyLogin. Non-active or ambiguously bound entries omit the field.

1.8.0 — 2026-09-23

Added

  • Partners can read one optional KIM address on an existing pharmacy with getPartnerPharmacyKimAddress and set or remove it with updatePartnerPharmacyKimAddress. Both operations are scoped to the authenticated partner and consumer.

Partner action for 1.8.0

Regenerate clients from version 1.8.0 before using the KIM operations. Omit kimAddress to keep the existing value; send null to remove it.

1.7.0 — 2026-09-19

Added

  • Partners can compare allowlisted organization and appointment-type configuration without writes through previewPartnerSettingsCopy, then apply it atomically through applyPartnerSettingsCopy.

Security

  • Partner, consumer, organization and appointment-type binding are checked server-side. Responses, errors and audit evidence exclude copied values, reasons, keys, hashes and revisions.

Partner action for 1.7.0

Regenerate clients from version 1.7.0. Use FAIL_ON_CONFLICT by default; request a new Preview for OVERWRITE_CONFLICTS. Retry transport failures with the same Idempotency-Key.

1.6.0 — 2026-09-18

Added

  • Email content and logo visibility can be configured with revision protection at organization and appointment-type level. Appointment types inherit each unset field first from the organization and then from system defaults.

Security

  • Partner, consumer, organization and appointment-type binding are checked server-side. Free text, rendered content and placeholder values are excluded from audit data; the public API contains only the four S2S operations.

Partner action for 1.6.0

Regenerate clients from version 1.6.0 before configuring email content.

1.5.0 — 2026-09-17

Added

  • Email reminders can be read and configured with revision protection at organization and appointment-type level. Appointment types inherit organization configuration until an explicit override is set.

Security

  • Partner and consumer binding come only from the authenticated API key. Updates require a PHI-free reason and the expected revision; existing reminder jobs are not changed retroactively.

Partner action for 1.5.0

Regenerate clients from version 1.5.0 before configuring email reminders.

1.4.0 — 2026-09-16

Added

  • SMS confirmations can be read and configured with revision protection at organization and appointment-type level. Appointment types inherit organization configuration until an explicit override is set.

Security

  • Partner and consumer binding come only from the authenticated API key. Updates require a reason and the expected revision; SMS text is excluded from audit and log data.

Partner action for 1.4.0

Regenerate clients from version 1.4.0 before configuring SMS confirmations.

1.3.0 — 2026-09-15

Added

  • Up to five normalized and deduplicated additional appointment-confirmation recipients can be read or fully replaced per partner pharmacy. An empty list disables additional delivery.

Security

  • Addresses are stored encrypted. Additional messages are sent separately without intake values, diagnoses, free-form health data, TAN, video links, tokens or credentials. Audit data contains no addresses or email content.

Partner action for 1.3.0

Regenerate clients from version 1.3.0 before configuring additional confirmation recipients.

1.2.0 — 2026-09-15

Added

  • One optional non-secret SMED identifier can be read, set and disabled for an existing partner pharmacy.

Security

  • Partner, consumer and pharmacy binding are derived from the authenticated server-side scope. The contract accepts no SMED credentials or URL tokens.

Partner action for 1.2.0

Regenerate clients from version 1.2.0 before using the optional SMED operations. Blank or null values disable the assignment.

1.1.0 — 2026-09-14

Added

  • Partner pharmacies can be discovered, managed and claimed for control.
  • Scheduling policies can be read and changed at organization and appointment-type level.
  • Intake fields of an active appointment type can be replaced atomically, with revisions preventing concurrent overwrites.
  • Partner channel webhooks can be configured through the published S2S contract.

Changed

  • Appointment-type responses include additive revision and intake-field information.

Security

  • Mutations recheck tenant, consumer, capability and current membership in the same locked transaction.
  • Audit records contain technical field identifiers only; responses and examples remain free of health data.

Partner action for 1.1.0

Regenerate clients from version 1.1.0 before using new operations or additive response fields. Existing integrations can continue to pin the unchanged 1.0.0 contract.

1.0.0 — 2026-08-02

Added

  • First stable version of the published Partner API.
  • Partners can integrate organizations, pharmacies, rooms, providers, availability and bookings through published server-to-server operations.
  • Webhook management and signed test deliveries are available for registered partner pharmacies.

Changed

No changes.

Deprecated

No deprecated features.

Security

  • The contract contains synthetic examples only; publication checks reject API keys, tokens, local hosts and personal example data.
  • One-time credentials are explicitly identified and must never be logged.

Partner action for 1.0.0

Validate against version 1.0.0, use synthetic sandbox data only, and implement webhook signature verification and idempotency before production.