docs.jsonld
type: ApiDocumentation
title: RLDataHub API
description: Rote-Liste DataHub API — Dokumentation der REST‑Schnittstelle zum Zugriff auf veröffentlichte Rote‑Liste‑Daten (Authentifizierung via JWT)
entrypoint: /
supported class: Error
supported class: ConstraintViolation
supported class: AtcCode
supported class: Classification
supported class: Company
supported class: Galenic
supported class: MainClassification
supported class: MeasurementTerm
supported class: MedicinalProduct
supported class: Package
supported class: Signature
supported class: Spc
supported class: Substance
supported class: User
supported class: Entrypoint
supported class: ConstraintViolationList

Error
type: Class
title: Error
supported property: SupportedProperty
  property: Error/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/title
  title: title
  required: false
  readable: true
  writeable: false
  description: A short, human-readable summary of the problem.
supported property: SupportedProperty
  property: Error/detail
  title: detail
  required: false
  readable: true
  writeable: false
  description: A human-readable explanation specific to this occurrence of the problem.
supported property: SupportedProperty
  property: Error/instance
  title: instance
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
supported property: SupportedProperty
  property: Error/type
  title: type
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the problem type
supported property: SupportedProperty
  property: Error/meta
  title: meta
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/source
  title: source
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/message
  title: message
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/code
  title: code
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Error resource.
  method: GET
  returns: Error
  title: getError
description: A representation of common errors.
subclass of: Error

Error/id
type: Property
domain: Error
the hydra core vocabulary: id
range: string

Error/title
type: Property
domain: Error
the hydra core vocabulary: title
range: string

Error/detail
type: Property
domain: Error
the hydra core vocabulary: detail
range: string

Error/instance
type: Property
domain: Error
the hydra core vocabulary: instance
range: string

Error/type
type: Property
domain: Error
the hydra core vocabulary: type
range: string

Error/meta
type: Property
domain: Error
the hydra core vocabulary: meta

Error/source
type: Property
domain: Error
the hydra core vocabulary: source

Error/trace
type: Property
domain: Error
the hydra core vocabulary: trace

Error/message
type: Property
domain: Error
the hydra core vocabulary: message
range: string

Error/code
type: Property
domain: Error
the hydra core vocabulary: code
range: integer

Error/file
type: Property
domain: Error
the hydra core vocabulary: file
range: string

Error/line
type: Property
domain: Error
the hydra core vocabulary: line
range: integer

Error/description
type: Property
domain: Error
the hydra core vocabulary: description
range: string

ConstraintViolation
type: Class
title: ConstraintViolation
supported property: SupportedProperty
  property: ConstraintViolation/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/errorTitle
  title: errorTitle
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/violations
  title: violations
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/detail
  title: detail
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/title
  title: title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/instance
  title: instance
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/statusCode
  title: statusCode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/headers
  title: headers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/previous
  title: previous
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
description: Unprocessable entity
subclass of: Error

ConstraintViolation/status
type: Property
domain: ConstraintViolation
the hydra core vocabulary: status
range: integer

ConstraintViolation/errorTitle
type: Property
domain: ConstraintViolation
the hydra core vocabulary: errorTitle
range: string

ConstraintViolation/violations
type: Property
domain: ConstraintViolation
the hydra core vocabulary: violations
range: ConstraintViolationList

ConstraintViolation/detail
type: Property
domain: ConstraintViolation
the hydra core vocabulary: detail
range: string

ConstraintViolation/message
type: Property
domain: ConstraintViolation
the hydra core vocabulary: message
range: string

ConstraintViolation/code
type: Property
domain: ConstraintViolation
the hydra core vocabulary: code
range: string
range: integer

ConstraintViolation/file
type: Property
domain: ConstraintViolation
the hydra core vocabulary: file
range: string

ConstraintViolation/line
type: Property
domain: ConstraintViolation
the hydra core vocabulary: line
range: integer

ConstraintViolation/description
type: Property
domain: ConstraintViolation
the hydra core vocabulary: description
range: string

ConstraintViolation/type
type: Property
domain: ConstraintViolation
the hydra core vocabulary: type
range: string

ConstraintViolation/title
type: Property
domain: ConstraintViolation
the hydra core vocabulary: title
range: string

ConstraintViolation/instance
type: Property
domain: ConstraintViolation
the hydra core vocabulary: instance
range: string

ConstraintViolation/statusCode
type: Property
domain: ConstraintViolation
the hydra core vocabulary: statusCode
range: integer

ConstraintViolation/headers
type: Property
domain: ConstraintViolation
the hydra core vocabulary: headers

ConstraintViolation/trace
type: Property
domain: ConstraintViolation
the hydra core vocabulary: trace

ConstraintViolation/previous
type: Property
domain: ConstraintViolation
the hydra core vocabulary: previous

AtcCode
type: Class
title: AtcCode
supported property: SupportedProperty
  property: AtcCode/id
  title: id
  required: false
  readable: true
  writeable: false
  description: Interne System-ID des Datenobjekts.
supported property: SupportedProperty
  property: AtcCode/code
  title: code
  required: true
  readable: true
  writeable: true
  description: Bis zu siebenstelliger ATC-Code, der aus fünf Stufen besteht.
supported property: SupportedProperty
  property: AtcCode/description
  title: description
  required: true
  readable: true
  writeable: true
  description: Bezeichnung des ATC-Codes.
supported property: SupportedProperty
  property: AtcCode/published
  title: published
  required: true
  readable: true
  writeable: true
  description: Gibt an, ob das Datenobjekt veröffentlicht (true) oder unveröffentlicht (false) ist.
supported property: SupportedProperty
  property: AtcCode/sourceModificationDate
  title: sourceModificationDate
  required: true
  readable: true
  writeable: true
  description: Letzte Änderung des Datenobjekts als Timestamp im ISO-8601-Standard.
supported operation: Operation
  type: FindAction
  description: Retrieves a AtcCode resource.
  method: GET
  returns: AtcCode
  title: getAtcCode
supported operation: Operation
  description: Updates the AtcCode resource.
  expects: AtcCode
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: AtcCode
  title: patchAtcCode
supported operation: Operation
  type: DeleteAction
  description: Deletes the AtcCode resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteAtcCode
description: Ein ATC-Code (Anatomisch-Therapeutisch-Chemisches Klassifikationssystem) ist eine international anerkannte Klassifikation von Medikamenten und ihren Wirkstoffen. Er wird verwendet, um Arzneimittel nach dem Organ oder Organsystem, auf das sie einwirken, sowie nach ihren chemischen, pharmakologischen und therapeutischen Eigenschaften in verschiedene Gruppen einzuteilen. Basis ist der ATC-Index erstellt vom WIdO für Deutschland des aktuellen Jahres.

AtcCode/id
type: Property
domain: AtcCode
the hydra core vocabulary: id
range: integer

AtcCode/code
type: Property
domain: AtcCode
the hydra core vocabulary: code
range: string

AtcCode/description
type: Property
domain: AtcCode
the hydra core vocabulary: description
range: string

AtcCode/published
type: Property
domain: AtcCode
the hydra core vocabulary: published
range: boolean

AtcCode/sourceModificationDate
type: Property
domain: AtcCode
the hydra core vocabulary: sourceModificationDate
range: dateTime

Classification
type: Class
title: Classification
supported property: SupportedProperty
  property: Classification/id
  title: id
  required: false
  readable: true
  writeable: false
  description: Interne System-ID des Datenobjekts.
supported property: SupportedProperty
  property: Classification/code
  title: code
  required: true
  readable: true
  writeable: true
  description: Die ersten beiden Ziffern geben die Hauptgruppe an, die folgenden drei Ziffern dienen der Nummerierung innerhalb der Hauptgruppe zur Identifikation der Untergruppe.
supported property: SupportedProperty
  property: Classification/text
  title: text
  required: true
  readable: true
  writeable: true
  description: Bezeichnung der Untergruppe.
supported property: SupportedProperty
  property: Classification/displayText
  title: displayText
  required: false
  readable: true
  writeable: true
  description: Untergliederung - Text (formatiert, HTML).
supported property: SupportedProperty
  property: Classification/additionalText
  title: additionalText
  required: false
  readable: true
  writeable: true
  description: Untergliederung - Zusatztext (formatiert, HTML).
supported property: SupportedProperty
  property: Classification/mainClassification
  title: mainClassification
  required: true
  readable: true
  writeable: true
  description: Verlinkung zur dazugehörigen Hauptgruppe.
supported property: SupportedProperty
  property: Classification/gtky
  title: gtky
  required: false
  readable: true
  writeable: true
  description: Einzugsebene der Untergruppe.
supported property: SupportedProperty
  property: Classification/published
  title: published
  required: true
  readable: true
  writeable: true
  description: Gibt an, ob das Datenobjekt veröffentlicht (true) oder unveröffentlicht (false) ist.
supported property: SupportedProperty
  property: Classification/sourceModificationDate
  title: sourceModificationDate
  required: true
  readable: true
  writeable: true
  description: Letzte Änderung des Datenobjekts als Timestamp im ISO-8601-Standard.
supported operation: Operation
  type: FindAction
  description: Retrieves a Classification resource.
  method: GET
  returns: Classification
  title: getClassification
supported operation: Operation
  description: Updates the Classification resource.
  expects: Classification
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Classification
  title: patchClassification
supported operation: Operation
  type: DeleteAction
  description: Deletes the Classification resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteClassification
description: Die Rote Liste Hauptgruppen sind in Untergruppen unterteilt, die die Präparate genauer klassifizieren und in dieser Route angeboten werden.

Classification/id
type: Property
domain: Classification
the hydra core vocabulary: id
range: integer

Classification/code
type: Property
domain: Classification
the hydra core vocabulary: code
range: string

Classification/text
type: Property
domain: Classification
the hydra core vocabulary: text
range: string

Classification/displayText
type: Property
domain: Classification
the hydra core vocabulary: displayText
range: string

Classification/additionalText
type: Property
domain: Classification
the hydra core vocabulary: additionalText
range: string

Classification/mainClassification
type: Property
domain: Classification
the hydra core vocabulary: mainClassification
max cardinality: 1
range: MainClassification

Classification/gtky
type: Property
domain: Classification
the hydra core vocabulary: gtky
range: string

Classification/published
type: Property
domain: Classification
the hydra core vocabulary: published
range: boolean

Classification/sourceModificationDate
type: Property
domain: Classification
the hydra core vocabulary: sourceModificationDate
range: dateTime

Company
type: Class
title: Company
supported property: SupportedProperty
  property: Company/id
  title: id
  required: false
  readable: true
  writeable: false
  description: Interne System-ID des Datenobjekts.
supported property: SupportedProperty
  property: Company/companyId
  title: companyId
  required: true
  readable: true
  writeable: true
  description: ID des Pharmaunternehmens innerhalb der Rote Liste Daten.
supported property: SupportedProperty
  property: Company/name
  title: name
  required: true
  readable: true
  writeable: true
  description: Vollständige Bezeichnung des Unternehmens.
supported property: SupportedProperty
  property: Company/fkb
  title: fkb
  required: false
  readable: true
  writeable: true
  description: Geläufige Firmenkurzbezeichnung des Unternehmens ohne Rechtsform.
supported property: SupportedProperty
  property: Company/published
  title: published
  required: true
  readable: true
  writeable: true
  description: Gibt an, ob das Datenobjekt veröffentlicht (true) oder unveröffentlicht (false) ist.
supported property: SupportedProperty
  property: Company/sourceModificationDate
  title: sourceModificationDate
  required: true
  readable: true
  writeable: true
  description: Letzte Änderung des Datenobjekts als Timestamp im ISO-8601-Standard.
supported operation: Operation
  type: FindAction
  description: Retrieves a Company resource.
  method: GET
  returns: Company
  title: getCompany
supported operation: Operation
  description: Updates the Company resource.
  expects: Company
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Company
  title: patchCompany
supported operation: Operation
  type: DeleteAction
  description: Deletes the Company resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteCompany
description: Ein Pharmaunternehmen aus der Datenbank der Roten Liste.

Company/id
type: Property
domain: Company
the hydra core vocabulary: id
range: integer

Company/companyId
type: Property
domain: Company
the hydra core vocabulary: companyId
range: string

Company/name
type: Property
domain: Company
the hydra core vocabulary: name
range: string

Company/fkb
type: Property
domain: Company
the hydra core vocabulary: fkb
range: string

Company/published
type: Property
domain: Company
the hydra core vocabulary: published
range: boolean

Company/sourceModificationDate
type: Property
domain: Company
the hydra core vocabulary: sourceModificationDate
range: dateTime

Galenic
type: Class
title: Galenic
supported property: SupportedProperty
  property: Galenic/id
  title: id
  required: false
  readable: true
  writeable: false
  description: Interne System-ID des Datenobjekts.
supported property: SupportedProperty
  property: Galenic/bfarmId
  title: bfarmId
  required: true
  readable: true
  writeable: true
  description: ID der Darreichungsform des pharmazeutischen Produkts laut BfArM-Katalog; 10-stelliger Integer.
supported property: SupportedProperty
  property: Galenic/description
  title: description
  required: true
  readable: true
  writeable: true
  description: Bezeichnung der Darreichungsform/Galenik.
supported property: SupportedProperty
  property: Galenic/published
  title: published
  required: true
  readable: true
  writeable: true
  description: Gibt an, ob das Datenobjekt veröffentlicht (true) oder unveröffentlicht (false) ist.
supported property: SupportedProperty
  property: Galenic/sourceModificationDate
  title: sourceModificationDate
  required: true
  readable: true
  writeable: true
  description: Letzte Änderung des Datenobjekts als Timestamp im ISO-8601-Standard.
supported operation: Operation
  type: FindAction
  description: Retrieves a Galenic resource.
  method: GET
  returns: Galenic
  title: getGalenic
supported operation: Operation
  description: Updates the Galenic resource.
  expects: Galenic
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Galenic
  title: patchGalenic
supported operation: Operation
  type: DeleteAction
  description: Deletes the Galenic resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteGalenic
description: Eine Darreichungsform/Galenik eines pharmazeutischen Produkts.

Galenic/id
type: Property
domain: Galenic
the hydra core vocabulary: id
range: integer

Galenic/bfarmId
type: Property
domain: Galenic
the hydra core vocabulary: bfarmId
range: string

Galenic/description
type: Property
domain: Galenic
the hydra core vocabulary: description
range: string

Galenic/published
type: Property
domain: Galenic
the hydra core vocabulary: published
range: boolean

Galenic/sourceModificationDate
type: Property
domain: Galenic
the hydra core vocabulary: sourceModificationDate
range: dateTime

MainClassification
type: Class
title: MainClassification
supported property: SupportedProperty
  property: MainClassification/id
  title: id
  required: false
  readable: true
  writeable: false
  description: Interne System-ID des Datenobjekts.
supported property: SupportedProperty
  property: MainClassification/code
  title: code
  required: true
  readable: true
  writeable: true
  description: Die beiden Ziffern mit einem abschließenden Punkt geben die Hauptgruppe an.
supported property: SupportedProperty
  property: MainClassification/text
  title: text
  required: true
  readable: true
  writeable: true
  description: Bezeichnung der Hauptgruppen.
supported property: SupportedProperty
  property: MainClassification/additionalText
  title: additionalText
  required: false
  readable: true
  writeable: true
  description: Hauptgruppen - Zusatztext.
supported property: SupportedProperty
  property: MainClassification/published
  title: published
  required: true
  readable: true
  writeable: true
  description: Gibt an, ob das Datenobjekt veröffentlicht (true) oder unveröffentlicht (false) ist.
supported property: SupportedProperty
  property: MainClassification/sourceModificationDate
  title: sourceModificationDate
  required: true
  readable: true
  writeable: true
  description: Letzte Änderung des Datenobjekts als Timestamp im ISO-8601-Standard.
supported property: SupportedProperty
  property: MainClassification/references
  title: references
  required: false
  readable: true
  writeable: true
  description: Liste an Verweisen der Hauptgruppe mit optionalen Hinweisen.
supported property: SupportedProperty
  property: MainClassification/gtky
  title: gtky
  required: false
  readable: true
  writeable: true
  description: Einzugsebene der Hauptgruppe.
supported operation: Operation
  type: FindAction
  description: Retrieves a MainClassification resource.
  method: GET
  returns: MainClassification
  title: getMainClassification
supported operation: Operation
  description: Updates the MainClassification resource.
  expects: MainClassification
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: MainClassification
  title: patchMainClassification
supported operation: Operation
  type: DeleteAction
  description: Deletes the MainClassification resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteMainClassification
description: Die Rote Liste Hauptgruppen sind die 88 Hauptgruppen, die die Rote Liste in Deutschland verwendet, um Humanarzneimittel und Medizinprodukte zu klassifizieren.

MainClassification/id
type: Property
domain: MainClassification
the hydra core vocabulary: id
range: integer

MainClassification/code
type: Property
domain: MainClassification
the hydra core vocabulary: code
range: string

MainClassification/text
type: Property
domain: MainClassification
the hydra core vocabulary: text
range: string

MainClassification/additionalText
type: Property
domain: MainClassification
the hydra core vocabulary: additionalText
range: string

MainClassification/published
type: Property
domain: MainClassification
the hydra core vocabulary: published
range: boolean

MainClassification/sourceModificationDate
type: Property
domain: MainClassification
the hydra core vocabulary: sourceModificationDate
range: dateTime

MainClassification/references
type: Property
domain: MainClassification
the hydra core vocabulary: references

MainClassification/gtky
type: Property
domain: MainClassification
the hydra core vocabulary: gtky
range: string

MeasurementTerm
type: Class
title: MeasurementTerm
supported property: SupportedProperty
  property: MeasurementTerm/id
  title: id
  required: false
  readable: true
  writeable: false
  description: Interne System-ID des Datenobjekts.
supported property: SupportedProperty
  property: MeasurementTerm/termId
  title: termId
  required: true
  readable: true
  writeable: true
  description: ID der Einheit aus dem Quelldatenobjekt.
supported property: SupportedProperty
  property: MeasurementTerm/name
  title: name
  required: true
  readable: true
  writeable: true
  description: Name der Einheit.
supported property: SupportedProperty
  property: MeasurementTerm/description
  title: description
  required: false
  readable: true
  writeable: true
  description: Optionale Beschreibung zu der Einheit.
supported property: SupportedProperty
  property: MeasurementTerm/symbol
  title: symbol
  required: true
  readable: true
  writeable: true
  description: Symbol/Abkürzung der Einheit.
supported property: SupportedProperty
  property: MeasurementTerm/published
  title: published
  required: true
  readable: true
  writeable: true
  description: Gibt an, ob das Datenobjekt veröffentlicht (true) oder unveröffentlicht (false) ist.
supported property: SupportedProperty
  property: MeasurementTerm/sourceModificationDate
  title: sourceModificationDate
  required: true
  readable: true
  writeable: true
  description: Letzte Änderung des Datenobjekts als Timestamp im ISO-8601-Standard.
supported operation: Operation
  type: FindAction
  description: Retrieves a MeasurementTerm resource.
  method: GET
  returns: MeasurementTerm
  title: getMeasurementTerm
supported operation: Operation
  description: Updates the MeasurementTerm resource.
  expects: MeasurementTerm
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: MeasurementTerm
  title: patchMeasurementTerm
supported operation: Operation
  type: DeleteAction
  description: Deletes the MeasurementTerm resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteMeasurementTerm
description: Die bei der Roten Liste in der Therapeutika-Datenbank verwendeten Einheiten.

MeasurementTerm/id
type: Property
domain: MeasurementTerm
the hydra core vocabulary: id
range: integer

MeasurementTerm/termId
type: Property
domain: MeasurementTerm
the hydra core vocabulary: termId
range: string

MeasurementTerm/name
type: Property
domain: MeasurementTerm
the hydra core vocabulary: name
range: string

MeasurementTerm/description
type: Property
domain: MeasurementTerm
the hydra core vocabulary: description
range: string

MeasurementTerm/symbol
type: Property
domain: MeasurementTerm
the hydra core vocabulary: symbol
range: string

MeasurementTerm/published
type: Property
domain: MeasurementTerm
the hydra core vocabulary: published
range: boolean

MeasurementTerm/sourceModificationDate
type: Property
domain: MeasurementTerm
the hydra core vocabulary: sourceModificationDate
range: dateTime

MedicinalProduct
type: Class
title: MedicinalProduct
supported property: SupportedProperty
  property: MedicinalProduct/id
  title: id
  required: false
  readable: true
  writeable: false
  description: Interne System-ID des Datenobjekts.
supported property: SupportedProperty
  property: MedicinalProduct/tid
  title: tid
  required: true
  readable: true
  writeable: true
  description: Nummerische ID des Therapeutikums mit eine Buchstaben als Präfix, bspw. 'A' für Arzneimittel oder 'M' für Medizinprodukt.
supported property: SupportedProperty
  property: MedicinalProduct/majorVersion
  title: majorVersion
  required: true
  readable: true
  writeable: true
  description: Hauptversion eines Therapeutikums.
supported property: SupportedProperty
  property: MedicinalProduct/name
  title: name
  required: true
  readable: true
  writeable: true
  description: Volle Bezeichnung des Therapeutikums.
supported property: SupportedProperty
  property: MedicinalProduct/medicinalProductType
  title: medicinalProductType
  required: false
  readable: true
  writeable: true
  description: Typ des Therapeutikums.
supported property: SupportedProperty
  property: MedicinalProduct/nameParts
  title: nameParts
  required: false
  readable: true
  writeable: true
  description: Die Name Parts bei IDMP (Identifikation von Arzneimitteln) umfassen mehrere Normen, die eine eindeutige Identifizierung und Beschreibung von Arzneimitteln ermöglichen.
supported property: SupportedProperty
  property: MedicinalProduct/authorizedPharmaceuticalDoseForm
  title: authorizedPharmaceuticalDoseForm
  required: false
  readable: true
  writeable: true
  description: Im Rahmen der ISO IDMP (Identifizierung von Arzneimitteln) bezieht sich die zugelassene pharmazeutische Darreichungsform auf die spezifische Form, in der ein Arzneimittel für die Verabreichung an Patienten zugelassen ist.
supported property: SupportedProperty
  property: MedicinalProduct/company
  title: company
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: MedicinalProduct/secondaryCompany
  title: secondaryCompany
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: MedicinalProduct/marketingAuthorizationHolder
  title: marketingAuthorizationHolder
  required: false
  readable: true
  writeable: true
  description: Deprecated: Use marketingAuthorizationHolderOrgId instead.
supported property: SupportedProperty
  property: MedicinalProduct/marketingAuthorizationHolderOrgId
  title: marketingAuthorizationHolderOrgId
  required: false
  readable: true
  writeable: true
  description: Org-ID des Zulassungsinhabers.
supported property: SupportedProperty
  property: MedicinalProduct/spc
  title: spc
  required: false
  readable: true
  writeable: true
  description: Die verlinkte Fachinformation der Roten Liste zu dem Therapeutikum.
supported property: SupportedProperty
  property: MedicinalProduct/leafletId
  title: leafletId
  required: false
  readable: true
  writeable: true
  description: Die verlinkte Gebrauchsinformations-ID der Roten Liste.
supported property: SupportedProperty
  property: MedicinalProduct/classification
  title: classification
  required: false
  readable: true
  writeable: true
  description: Primäre Hauptgruppe, die das Therapeutikum klassifiziert.
supported property: SupportedProperty
  property: MedicinalProduct/referenceClassifications
  title: referenceClassifications
  required: false
  readable: true
  writeable: true
  description: Liste der sekundären Hauptgruppen, die ebenfalls das Therapeutikum klassifizieren.
supported property: SupportedProperty
  property: MedicinalProduct/atcCodes
  title: atcCodes
  required: false
  readable: true
  writeable: true
  description: Liste der ATC-Codes, die das Therapeutikum klassifizieren.
supported property: SupportedProperty
  property: MedicinalProduct/packages
  title: packages
  required: false
  readable: true
  writeable: true
  description: Liste der Packungen, die das Therapeutikum enthält.
supported property: SupportedProperty
  property: MedicinalProduct/manufacturedItems
  title: manufacturedItems
  required: false
  readable: true
  writeable: true
  description: Liste der hergestellten Produkte, wie in der verpackten medizinischen Produktliste beschrieben. Die Produkte sind in der zugelassenen Form und gegebenenfalls vor der Umwandlung in die verabreichbaren pharmazeutischen Form beschrieben.
supported property: SupportedProperty
  property: MedicinalProduct/published
  title: published
  required: true
  readable: true
  writeable: true
  description: Gibt an, ob das Datenobjekt veröffentlicht (true) oder unveröffentlicht (false) ist.
supported property: SupportedProperty
  property: MedicinalProduct/sourceModificationDate
  title: sourceModificationDate
  required: true
  readable: true
  writeable: true
  description: Letzte Änderung des Datenobjekts als Timestamp im ISO-8601-Standard.
supported operation: Operation
  type: FindAction
  description: Retrieves a MedicinalProduct resource.
  method: GET
  returns: MedicinalProduct
  title: getMedicinalProduct
supported operation: Operation
  description: Updates the MedicinalProduct resource.
  expects: MedicinalProduct
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: MedicinalProduct
  title: patchMedicinalProduct
supported operation: Operation
  type: DeleteAction
  description: Deletes the MedicinalProduct resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteMedicinalProduct
description: Ein Therapeutikum aus der Therapeutika-Datenbank der Roten Liste ist eindeutig definiert durch seine Arzneimittelbezeichnung, die Darreichungsform, die enthaltenen Wirkstoffe, deren Stärken sowie den jeweiligen Zulassungsinhaber (Anbieter).

MedicinalProduct/id
type: Property
domain: MedicinalProduct
the hydra core vocabulary: id
range: integer

MedicinalProduct/tid
type: Property
domain: MedicinalProduct
the hydra core vocabulary: tid
range: string

MedicinalProduct/majorVersion
type: Property
domain: MedicinalProduct
the hydra core vocabulary: majorVersion
range: integer

MedicinalProduct/name
type: Property
domain: MedicinalProduct
the hydra core vocabulary: name
range: string

MedicinalProduct/medicinalProductType
type: Property
domain: MedicinalProduct
the hydra core vocabulary: medicinalProductType

MedicinalProduct/nameParts
type: Property
domain: MedicinalProduct
the hydra core vocabulary: nameParts

MedicinalProduct/authorizedPharmaceuticalDoseForm
type: Property
domain: MedicinalProduct
the hydra core vocabulary: authorizedPharmaceuticalDoseForm
max cardinality: 1
range: Galenic

MedicinalProduct/company
type: Property
domain: MedicinalProduct
the hydra core vocabulary: company
max cardinality: 1
range: Company

MedicinalProduct/secondaryCompany
type: Property
domain: MedicinalProduct
the hydra core vocabulary: secondaryCompany
max cardinality: 1
range: Company

MedicinalProduct/marketingAuthorizationHolder
type: Property
domain: MedicinalProduct
the hydra core vocabulary: marketingAuthorizationHolder
max cardinality: 1
range: Company

MedicinalProduct/marketingAuthorizationHolderOrgId
type: Property
domain: MedicinalProduct
the hydra core vocabulary: marketingAuthorizationHolderOrgId
range: string

MedicinalProduct/spc
type: Property
domain: MedicinalProduct
the hydra core vocabulary: spc
max cardinality: 1
range: Spc

MedicinalProduct/leafletId
type: Property
domain: MedicinalProduct
the hydra core vocabulary: leafletId
range: string

MedicinalProduct/classification
type: Property
domain: MedicinalProduct
the hydra core vocabulary: classification
max cardinality: 1
range: Classification

MedicinalProduct/referenceClassifications
type: Property
domain: MedicinalProduct
the hydra core vocabulary: referenceClassifications
range: Classification

MedicinalProduct/atcCodes
type: Property
domain: MedicinalProduct
the hydra core vocabulary: atcCodes
range: AtcCode

MedicinalProduct/packages
type: Property
domain: MedicinalProduct
the hydra core vocabulary: packages

MedicinalProduct/manufacturedItems
type: Property
domain: MedicinalProduct
the hydra core vocabulary: manufacturedItems

MedicinalProduct/published
type: Property
domain: MedicinalProduct
the hydra core vocabulary: published
range: boolean

MedicinalProduct/sourceModificationDate
type: Property
domain: MedicinalProduct
the hydra core vocabulary: sourceModificationDate
range: dateTime

Package
type: Class
title: Package
supported property: SupportedProperty
  property: Package/id
  title: id
  required: false
  readable: true
  writeable: false
  description: Interne System-ID des Datenobjekts.
supported property: SupportedProperty
  property: Package/pzn
  title: pzn
  required: true
  readable: true
  writeable: true
  description: Die Pharmazentralnummer (PZN) ist ein in Deutschland (und Österreich) verwendeter achtstelliger Zahlencode zur eindeutigen Identifikation von Arzneimitteln, apothekenpflichtigen Medizinprodukten und anderen apothekenüblichen Waren.
supported property: SupportedProperty
  property: Package/gtin
  title: gtin
  required: false
  readable: true
  writeable: true
  description: Die GTIN (Global Trade Item Number), früher bekannt als EAN (European Article Number) oder UPC (Universal Product Code), ist eine international anerkannte, eindeutige Identifikationsnummer für Produkte und Dienstleistungen im globalen Handel.
supported property: SupportedProperty
  property: Package/ntin
  title: ntin
  required: false
  readable: true
  writeable: true
  description: Die NTIN (Nationale Technische Identifikationsnummer) ist ein in Deutschland verwendeter achtstelliger Zahlencode, der zur eindeutigen Identifikation von nicht-arzneimittelähnlichen Produkten im Apothekenbereich dient.
supported property: SupportedProperty
  property: Package/companyArticleNo
  title: companyArticleNo
  required: false
  readable: true
  writeable: true
  description: Artikelnummer des Anbieters.
supported property: SupportedProperty
  property: Package/ppn
  title: ppn
  required: false
  readable: true
  writeable: true
  description: Die PPN (Pharma Produkt Nummer) ist in der Regel eine interne, nicht-standardisierte Identifikationsnummer für pharmazeutische Produkte oder deren Bestandteile, die nicht unter die nationalen PZN- oder NTIN-Standards fallen, aber dennoch eine eindeutige Kennzeichnung innerhalb eines spezifischen Systems oder Unternehmens benötigen.
supported property: SupportedProperty
  property: Package/udiDI
  title: udiDI
  required: false
  readable: true
  writeable: true
  description: UDI-DI (Device Identifier) dient der eindeutigen Identifizierung des spezifischen Medizinprodukts, d.h. des Modells, der Version, der Größe und der Verpackung.
supported property: SupportedProperty
  property: Package/status
  title: status
  required: true
  readable: true
  writeable: true
  description: Status der Packung.
supported property: SupportedProperty
  property: Package/packageSize
  title: packageSize
  required: true
  readable: true
  writeable: true
  description: Informationen zur Packungsgröße.
supported property: SupportedProperty
  property: Package/articleData
  title: articleData
  required: true
  readable: true
  writeable: true
  description: Allgemeine Artikeldaten (bspw. Artikelname, Artikeltyp).
supported property: SupportedProperty
  property: Package/companies
  title: companies
  required: true
  readable: true
  writeable: true
  description: Informationen zum Anbieter, lokalem Partner oder dem Zulassungsinhaber der Packung.
supported property: SupportedProperty
  property: Package/prices
  title: prices
  required: true
  readable: true
  writeable: true
  description: Allgemeine Angabe zu den Preisinformationen der Packung.
supported property: SupportedProperty
  property: Package/priceData
  title: priceData
  required: false
  readable: true
  writeable: true
  description: Liste der Preistypen und dessen konkreten Preise in Eurocent.
supported property: SupportedProperty
  property: Package/sales
  title: sales
  required: true
  readable: true
  writeable: true
  description: Marktdaten der Packung.
supported property: SupportedProperty
  property: Package/legal
  title: legal
  required: true
  readable: true
  writeable: true
  description: Rechtliche Informationen und weitere Klassifizierungen und Kennzeichnungen der Packung (bspw. Verschreibungspflichtig, Betäubungsmittel).
supported property: SupportedProperty
  property: Package/references
  title: references
  required: true
  readable: true
  writeable: true
  description: Informationen über Vorgänger oder Original-PZN der Packung.
supported property: SupportedProperty
  property: Package/published
  title: published
  required: true
  readable: true
  writeable: true
  description: Gibt an, ob das Datenobjekt veröffentlicht (true) oder unveröffentlicht (false) ist.
supported property: SupportedProperty
  property: Package/sourceModificationDate
  title: sourceModificationDate
  required: true
  readable: true
  writeable: true
  description: Letzte Änderung des Datenobjekts als Timestamp im ISO-8601-Standard.
supported operation: Operation
  type: FindAction
  description: Retrieves a Package resource.
  method: GET
  returns: Package
  title: getPackage
supported operation: Operation
  description: Updates the Package resource.
  expects: Package
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Package
  title: patchPackage
supported operation: Operation
  type: DeleteAction
  description: Deletes the Package resource.
  method: DELETE
  returns: owl:Nothing
  title: deletePackage
description: Packungsinformationen

Package/id
type: Property
domain: Package
the hydra core vocabulary: id
range: integer

Package/pzn
type: Property
domain: Package
the hydra core vocabulary: pzn
range: string

Package/gtin
type: Property
domain: Package
the hydra core vocabulary: gtin
range: string

Package/ntin
type: Property
domain: Package
the hydra core vocabulary: ntin
range: string

Package/companyArticleNo
type: Property
domain: Package
the hydra core vocabulary: companyArticleNo
range: string

Package/ppn
type: Property
domain: Package
the hydra core vocabulary: ppn
range: string

Package/udiDI
type: Property
domain: Package
the hydra core vocabulary: udiDI
range: string

Package/status
type: Property
domain: Package
the hydra core vocabulary: status

Package/packageSize
type: Property
domain: Package
the hydra core vocabulary: packageSize

Package/articleData
type: Property
domain: Package
the hydra core vocabulary: articleData

Package/companies
type: Property
domain: Package
the hydra core vocabulary: companies

Package/prices
type: Property
domain: Package
the hydra core vocabulary: prices

Package/priceData
type: Property
domain: Package
the hydra core vocabulary: priceData

Package/sales
type: Property
domain: Package
the hydra core vocabulary: sales

Package/legal
type: Property
domain: Package
the hydra core vocabulary: legal

Package/references
type: Property
domain: Package
the hydra core vocabulary: references

Package/published
type: Property
domain: Package
the hydra core vocabulary: published
range: boolean

Package/sourceModificationDate
type: Property
domain: Package
the hydra core vocabulary: sourceModificationDate
range: dateTime

Signature
type: Class
title: Signature
supported property: SupportedProperty
  property: Signature/id
  title: id
  required: false
  readable: true
  writeable: false
  description: Interne System-ID des Datenobjekts.
supported property: SupportedProperty
  property: Signature/signatureId
  title: signatureId
  required: true
  readable: true
  writeable: true
  description: ID der Signatur aus dem Quelldatenobjekt.
supported property: SupportedProperty
  property: Signature/signature
  title: signature
  required: false
  readable: true
  writeable: true
  description: Signatur-Kürzel.
supported property: SupportedProperty
  property: Signature/substance
  title: substance
  required: false
  readable: true
  writeable: true
  description: Signatur-Stoff.
supported property: SupportedProperty
  property: Signature/monographyNote
  title: monographyNote
  required: false
  readable: true
  writeable: true
  description: Hinweis auf Monographien.
supported property: SupportedProperty
  property: Signature/additionalTextForSubstance
  title: additionalTextForSubstance
  required: false
  readable: true
  writeable: true
  description: Zusatztext Stoff (HTML).
supported property: SupportedProperty
  property: Signature/signatureReference
  title: signatureReference
  required: false
  readable: true
  writeable: true
  description: Liste an Verweisen auf andere Signaturen.
supported property: SupportedProperty
  property: Signature/published
  title: published
  required: true
  readable: true
  writeable: true
  description: Gibt an, ob das Datenobjekt veröffentlicht (true) oder unveröffentlicht (false) ist.
supported property: SupportedProperty
  property: Signature/sourceModificationDate
  title: sourceModificationDate
  required: true
  readable: true
  writeable: true
  description: Letzte Änderung des Datenobjekts als Timestamp im ISO-8601-Standard.
supported property: SupportedProperty
  property: Signature/contraIndication
  title: contraIndication
  required: false
  readable: true
  writeable: true
  description: Liste an Signatur-Buchstaben für die Gegenanzeige. Jedes Element: leadingLetter (Buchstabe vor dem Text), signatureText (Signaturtext, HTML).
supported property: SupportedProperty
  property: Signature/usageDescription
  title: usageDescription
  required: false
  readable: true
  writeable: true
  description: Liste an Signatur-Buchstaben für die Anwendungsbeschränkung. Jedes Element: leadingLetter (Buchstabe vor dem Text), signatureText (Signaturtext, HTML).
supported property: SupportedProperty
  property: Signature/pregnancy
  title: pregnancy
  required: false
  readable: true
  writeable: true
  description: Liste an Signatur-Buchstaben für die Schwangerschaft. Jedes Element: leadingLetter (Buchstabe vor dem Text), signatureText (Signaturtext, HTML).
supported property: SupportedProperty
  property: Signature/breastfeeding
  title: breastfeeding
  required: false
  readable: true
  writeable: true
  description: Liste an Signatur-Buchstaben für die Stillzeit. Jedes Element: leadingLetter (Buchstabe vor dem Text), signatureText (Signaturtext, HTML).
supported property: SupportedProperty
  property: Signature/sideEffects
  title: sideEffects
  required: false
  readable: true
  writeable: true
  description: Liste an Signatur-Buchstaben für die Nebenwirkungen. Jedes Element: leadingLetter (Buchstabe vor dem Text), organSystem (Organsystem, nur hier), signatureText (Signaturtext, HTML).
supported property: SupportedProperty
  property: Signature/interaction
  title: interaction
  required: false
  readable: true
  writeable: true
  description: Liste an Signatur-Buchstaben für die Wechselwirkung. Jedes Element: leadingLetter (Buchstabe vor dem Text), secondColumn (optionale zweite Spalte, HTML, nur hier), signatureText (Signaturtext, HTML).
supported property: SupportedProperty
  property: Signature/intoxication
  title: intoxication
  required: false
  readable: true
  writeable: true
  description: Liste an Signatur-Einträgen für die Intoxikation. Jedes Element: signatureText (HTML), therapyText (Therapietext, HTML, nur hier), caveText (Cave-Text, HTML, nur hier), headline (Überschrift, HTML, nur hier), textBlock (Textfeld, HTML, nur hier), specialOptions (Besondere Möglichkeiten, HTML, nur hier).
supported property: SupportedProperty
  property: Signature/warning
  title: warning
  required: false
  readable: true
  writeable: true
  description: Liste an Signatur-Buchstaben für die Warnhinweise. Jedes Element: leadingLetter (Buchstabe vor dem Text), signatureText (Signaturtext, HTML).
supported property: SupportedProperty
  property: Signature/note
  title: note
  required: false
  readable: true
  writeable: true
  description: Liste an Signatur-Buchstaben für die Hinweise. Jedes Element: leadingLetter (Buchstabe vor dem Text), signatureText (Signaturtext, HTML).
supported operation: Operation
  type: FindAction
  description: Retrieves a Signature resource.
  method: GET
  returns: Signature
  title: getSignature
supported operation: Operation
  description: Updates the Signature resource.
  expects: Signature
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Signature
  title: patchSignature
supported operation: Operation
  type: DeleteAction
  description: Deletes the Signature resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteSignature
description: Diese Signaturen beinhalten Informationen für Rote Liste Einträge, die sich für bestimmte Stoffe wiederholen und als Signatur mit einem Buchstaben in den Rote Liste Einträgen verwiesen werden, um Wiederholungen zu vermeiden. Die Informationen sind gegliedert nach Kapiteln/Themenbereichen (bspw. Hinweise zur Verwendung/Einnahme während einer Schwangerschaft).

Signature/id
type: Property
domain: Signature
the hydra core vocabulary: id
range: integer

Signature/signatureId
type: Property
domain: Signature
the hydra core vocabulary: signatureId
range: string

Signature/signature
type: Property
domain: Signature
the hydra core vocabulary: signature
range: string

Signature/substance
type: Property
domain: Signature
the hydra core vocabulary: substance
range: string

Signature/monographyNote
type: Property
domain: Signature
the hydra core vocabulary: monographyNote
range: string

Signature/additionalTextForSubstance
type: Property
domain: Signature
the hydra core vocabulary: additionalTextForSubstance
range: string

Signature/signatureReference
type: Link
domain: Signature
the hydra core vocabulary: signatureReference
range: Signature

Signature/published
type: Property
domain: Signature
the hydra core vocabulary: published
range: boolean

Signature/sourceModificationDate
type: Property
domain: Signature
the hydra core vocabulary: sourceModificationDate
range: dateTime

Signature/contraIndication
type: Property
domain: Signature
the hydra core vocabulary: contraIndication

Signature/usageDescription
type: Property
domain: Signature
the hydra core vocabulary: usageDescription

Signature/pregnancy
type: Property
domain: Signature
the hydra core vocabulary: pregnancy

Signature/breastfeeding
type: Property
domain: Signature
the hydra core vocabulary: breastfeeding

Signature/sideEffects
type: Property
domain: Signature
the hydra core vocabulary: sideEffects

Signature/interaction
type: Property
domain: Signature
the hydra core vocabulary: interaction

Signature/intoxication
type: Property
domain: Signature
the hydra core vocabulary: intoxication

Signature/warning
type: Property
domain: Signature
the hydra core vocabulary: warning

Signature/note
type: Property
domain: Signature
the hydra core vocabulary: note

Spc
type: Class
title: Spc
supported property: SupportedProperty
  property: Spc/id
  title: id
  required: false
  readable: true
  writeable: false
  description: Interne System-ID des Datenobjekts.
supported property: SupportedProperty
  property: Spc/spcId
  title: spcId
  required: true
  readable: true
  writeable: true
  description: Rote Liste Fachinformationsnummer.
supported property: SupportedProperty
  property: Spc/versionId
  title: versionId
  required: true
  readable: true
  writeable: true
  description: Hauptversion einer Fachinformation.
supported property: SupportedProperty
  property: Spc/iterationId
  title: iterationId
  required: true
  readable: true
  writeable: true
  description: Version der Iteration innerhalb einer Hauptversion einer Fachinformation.
supported property: SupportedProperty
  property: Spc/name
  title: name
  required: true
  readable: true
  writeable: true
  description: Bezeichnung der Fachinformation.
supported property: SupportedProperty
  property: Spc/published
  title: published
  required: true
  readable: true
  writeable: true
  description: Gibt an, ob das Datenobjekt veröffentlicht (true) oder unveröffentlicht (false) ist.
supported property: SupportedProperty
  property: Spc/sourceModificationDate
  title: sourceModificationDate
  required: true
  readable: true
  writeable: true
  description: Letzte Änderung des Datenobjekts als Timestamp im ISO-8601-Standard.
supported operation: Operation
  type: FindAction
  description: Retrieves a Spc resource.
  method: GET
  returns: Spc
  title: getSpc
supported operation: Operation
  description: Updates the Spc resource.
  expects: Spc
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Spc
  title: patchSpc
supported operation: Operation
  type: DeleteAction
  description: Deletes the Spc resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteSpc
description: Eine Fachinformation aus der Datenbank der Roten Liste.

Spc/id
type: Property
domain: Spc
the hydra core vocabulary: id
range: integer

Spc/spcId
type: Property
domain: Spc
the hydra core vocabulary: spcId
range: string

Spc/versionId
type: Property
domain: Spc
the hydra core vocabulary: versionId
range: integer

Spc/iterationId
type: Property
domain: Spc
the hydra core vocabulary: iterationId
range: integer

Spc/name
type: Property
domain: Spc
the hydra core vocabulary: name
range: string

Spc/published
type: Property
domain: Spc
the hydra core vocabulary: published
range: boolean

Spc/sourceModificationDate
type: Property
domain: Spc
the hydra core vocabulary: sourceModificationDate
range: dateTime

Substance
type: Class
title: Substance
supported property: SupportedProperty
  property: Substance/id
  title: id
  required: false
  readable: true
  writeable: false
  description: Interne System-ID des Datenobjekts.
supported property: SupportedProperty
  property: Substance/code
  title: code
  required: true
  readable: true
  writeable: true
  description: Rote Liste Stoff-Code ist eine sechstellige Ziffernfolge gefolgt von einem optionalen '/' und Buchstaben, um eine Gruppierung der Stoffe auszudrücken oder 'HC', um zu signalisieren, dass es sich um einen Hilfsstoff handelt (wird aktuell nicht mehr weiter gepflegt).
supported property: SupportedProperty
  property: Substance/name
  title: name
  required: true
  readable: true
  writeable: true
  description: Stoff-Kurzbezeichnung bzw. Verweis-Links (Normstoffname).
supported property: SupportedProperty
  property: Substance/published
  title: published
  required: true
  readable: true
  writeable: true
  description: Gibt an, ob das Datenobjekt veröffentlicht (true) oder unveröffentlicht (false) ist.
supported property: SupportedProperty
  property: Substance/sourceModificationDate
  title: sourceModificationDate
  required: true
  readable: true
  writeable: true
  description: Letzte Änderung des Datenobjekts als Timestamp im ISO-8601-Standard.
supported property: SupportedProperty
  property: Substance/sortName
  title: sortName
  required: false
  readable: true
  writeable: true
  description: Sortiername des Stoffs.
supported property: SupportedProperty
  property: Substance/substanceType
  title: substanceType
  required: false
  readable: true
  writeable: true
  description: Stoffart (PhEur = Europäisches Arzneibuch (Pharmacopoea Europaea), HAB = Homöopathisches Arzneibuch, DAB = Deutsches Arzneibuch).
supported property: SupportedProperty
  property: Substance/substanceClass
  title: substanceClass
  required: false
  readable: true
  writeable: true
  description: Stoffklasse (A = Pflanzlich, B = Chemisch, C = Enzymatisch/Organisch, D = Homöopathisch/Anthroposophisch).
supported property: SupportedProperty
  property: Substance/printType
  title: printType
  required: false
  readable: true
  writeable: true
  description: Stofftypen als Liste. Mögliche Werte: VW = Stoffverweis. I = Der Internationale Freiname (INN) ist ein von der Weltgesundheitsorganisation (WHO) vergebener, gemeinfreier Name für einen Arzneimittelwirkstoff. V = Der Internationale Freiname (INN) ist ein von der Weltgesundheitsorganisation (WHO) vergebener, gemeinfreier Name für einen Arzneimittelwirkstoff und bezieht sich hier auf Substanzvarianten, Salzformen oder Derivate eines aktiven Wirkstoffs, die unter derselben Wirkstoffklasse geführt werden, aber leichte Unterschiede in chemischer Zusammensetzung oder pharmazeutischer Form haben. Es handelt sich um eine bestimmte Variante oder verwandte Form eines INN. S = Sonstige Stoffe. N = Pflanzliche Stoffe und Hilfsstoffe; wird nicht auf der blauen Seite der Roten Liste dargestellt.
supported property: SupportedProperty
  property: Substance/eNumber
  title: eNumber
  required: false
  readable: true
  writeable: true
  description: Stoff-E-Nummer (gemäß Zusatzstoffzulassungs- bzw. -verkehrsordnung).
supported property: SupportedProperty
  property: Substance/chemicalDesignation
  title: chemicalDesignation
  required: false
  readable: true
  writeable: true
  description: Chemische Bezeichnung (i. d. R. IUPAC-Bez., formatiert, HTML).
supported property: SupportedProperty
  property: Substance/indicationActiveIngredient
  title: indicationActiveIngredient
  required: false
  readable: true
  writeable: true
  description: Stoffindikation vom Arzneimittel wirksamen Bestandteil (formatiert, HTML).
supported property: SupportedProperty
  property: Substance/indicationMedicalProduct
  title: indicationMedicalProduct
  required: false
  readable: true
  writeable: true
  description: Stoffindikation vom Medizinprodukt.
supported property: SupportedProperty
  property: Substance/indicationAdditive
  title: indicationAdditive
  required: false
  readable: true
  writeable: true
  description: Stoffindikation vom Hilfsstoff.
supported property: SupportedProperty
  property: Substance/substanceRelation
  title: substanceRelation
  required: false
  readable: true
  writeable: true
  description: Stoffverweise (Synonyme) als Liste der Namen der verlinkten Stoffobjekte.
supported property: SupportedProperty
  property: Substance/halflife
  title: halflife
  required: false
  readable: true
  writeable: true
  description: Stoffhalbwertszeit (formatiert, HTML).
supported property: SupportedProperty
  property: Substance/hemoperfusion
  title: hemoperfusion
  required: false
  readable: true
  writeable: true
  description: Stoffhämoperfusion (ja, "(ja)", nein).
supported property: SupportedProperty
  property: Substance/hemodialysis
  title: hemodialysis
  required: false
  readable: true
  writeable: true
  description: Stoffhämodialyse (ja, "(ja)", nein).
supported operation: Operation
  type: FindAction
  description: Retrieves a Substance resource.
  method: GET
  returns: Substance
  title: getSubstance
supported operation: Operation
  description: Updates the Substance resource.
  expects: Substance
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Substance
  title: patchSubstance
supported operation: Operation
  type: DeleteAction
  description: Deletes the Substance resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteSubstance
description: Ein Stoff aus der Rote Liste Stoffdatenbank.

Substance/id
type: Property
domain: Substance
the hydra core vocabulary: id
range: integer

Substance/code
type: Property
domain: Substance
the hydra core vocabulary: code
range: string

Substance/name
type: Property
domain: Substance
the hydra core vocabulary: name
range: string

Substance/published
type: Property
domain: Substance
the hydra core vocabulary: published
range: boolean

Substance/sourceModificationDate
type: Property
domain: Substance
the hydra core vocabulary: sourceModificationDate
range: dateTime

Substance/sortName
type: Property
domain: Substance
the hydra core vocabulary: sortName
range: string

Substance/substanceType
type: Property
domain: Substance
the hydra core vocabulary: substanceType

Substance/substanceClass
type: Property
domain: Substance
the hydra core vocabulary: substanceClass

Substance/printType
type: Property
domain: Substance
the hydra core vocabulary: printType

Substance/eNumber
type: Property
domain: Substance
the hydra core vocabulary: eNumber
range: string

Substance/chemicalDesignation
type: Property
domain: Substance
the hydra core vocabulary: chemicalDesignation
range: string

Substance/indicationActiveIngredient
type: Property
domain: Substance
the hydra core vocabulary: indicationActiveIngredient
range: string

Substance/indicationMedicalProduct
type: Property
domain: Substance
the hydra core vocabulary: indicationMedicalProduct
range: string

Substance/indicationAdditive
type: Property
domain: Substance
the hydra core vocabulary: indicationAdditive
range: string

Substance/substanceRelation
type: Property
domain: Substance
the hydra core vocabulary: substanceRelation
range: string

Substance/halflife
type: Property
domain: Substance
the hydra core vocabulary: halflife
range: string

Substance/hemoperfusion
type: Property
domain: Substance
the hydra core vocabulary: hemoperfusion

Substance/hemodialysis
type: Property
domain: Substance
the hydra core vocabulary: hemodialysis

User
type: Class
title: User
supported property: SupportedProperty
  property: User/email
  title: email
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/company
  title: company
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/plainPassword
  title: plainPassword
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: User/roles
  title: roles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/jwt
  title: jwt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: User/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/lastActivity
  title: lastActivity
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a User resource.
  method: GET
  returns: User
  title: getUser
supported operation: Operation
  type: ReplaceAction
  description: Replaces the User resource.
  expects: User
  method: PUT
  returns: User
  title: putUser
supported operation: Operation
  description: Updates the User resource.
  expects: User
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: User
  title: patchUser
supported operation: Operation
  type: DeleteAction
  description: Deletes the User resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteUser

User/email
type: Property
domain: User
the hydra core vocabulary: email
range: string

User/name
type: Property
domain: User
the hydra core vocabulary: name
range: string

User/company
type: Property
domain: User
the hydra core vocabulary: company
range: string

User/plainPassword
type: Property
domain: User
the hydra core vocabulary: plainPassword
range: string

User/roles
type: Property
domain: User
the hydra core vocabulary: roles
range: string

User/jwt
type: Property
domain: User
the hydra core vocabulary: jwt
range: string

User/active
type: Property
domain: User
the hydra core vocabulary: active
range: boolean

User/lastActivity
type: Property
domain: User
the hydra core vocabulary: lastActivity
range: dateTime

Entrypoint
type: Class
title: Entrypoint
supported property: SupportedProperty
  property: Entrypoint/atcCode
  title: getAtcCodeCollection
  description: The collection of AtcCode resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/classification
  title: getClassificationCollection
  description: The collection of Classification resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/company
  title: getCompanyCollection
  description: The collection of Company resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/galenic
  title: getGalenicCollection
  description: The collection of Galenic resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/mainClassification
  title: getMainClassificationCollection
  description: The collection of MainClassification resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/measurementTerm
  title: getMeasurementTermCollection
  description: The collection of MeasurementTerm resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/medicinalProduct
  title: getMedicinalProductCollection
  description: The collection of MedicinalProduct resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/package
  title: getPackageCollection
  description: The collection of Package resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/signature
  title: getSignatureCollection
  description: The collection of Signature resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/spc
  title: getSpcCollection
  description: The collection of Spc resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/substance
  title: getSubstanceCollection
  description: The collection of Substance resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/user
  title: getUserCollection
  description: The collection of User resources
  readable: true
  writeable: false
supported operation: Operation
  method: GET
  title: index
  description: The API Entrypoint.
  returns: Entrypoint

Entrypoint/atcCode
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: AtcCode
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of AtcCode resources.
  method: GET
  returns: Collection
  title: getAtcCodeCollection
supported operation: Operation
  type: CreateAction
  description: Creates a AtcCode resource.
  expects: AtcCode
  method: POST
  returns: AtcCode
  title: postAtcCode

Entrypoint/classification
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Classification
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Classification resources.
  method: GET
  returns: Collection
  title: getClassificationCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Classification resource.
  expects: Classification
  method: POST
  returns: Classification
  title: postClassification

Entrypoint/company
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Company
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Company resources.
  method: GET
  returns: Collection
  title: getCompanyCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Company resource.
  expects: Company
  method: POST
  returns: Company
  title: postCompany

Entrypoint/galenic
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Galenic
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Galenic resources.
  method: GET
  returns: Collection
  title: getGalenicCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Galenic resource.
  expects: Galenic
  method: POST
  returns: Galenic
  title: postGalenic

Entrypoint/mainClassification
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: MainClassification
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of MainClassification resources.
  method: GET
  returns: Collection
  title: getMainClassificationCollection
supported operation: Operation
  type: CreateAction
  description: Creates a MainClassification resource.
  expects: MainClassification
  method: POST
  returns: MainClassification
  title: postMainClassification

Entrypoint/measurementTerm
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: MeasurementTerm
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of MeasurementTerm resources.
  method: GET
  returns: Collection
  title: getMeasurementTermCollection
supported operation: Operation
  type: CreateAction
  description: Creates a MeasurementTerm resource.
  expects: MeasurementTerm
  method: POST
  returns: MeasurementTerm
  title: postMeasurementTerm

Entrypoint/medicinalProduct
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: MedicinalProduct
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of MedicinalProduct resources.
  method: GET
  returns: Collection
  title: getMedicinalProductCollection
supported operation: Operation
  type: CreateAction
  description: Creates a MedicinalProduct resource.
  expects: MedicinalProduct
  method: POST
  returns: MedicinalProduct
  title: postMedicinalProduct

Entrypoint/package
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Package
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Package resources.
  method: GET
  returns: Collection
  title: getPackageCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Package resource.
  expects: Package
  method: POST
  returns: Package
  title: postPackage

Entrypoint/signature
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Signature
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Signature resources.
  method: GET
  returns: Collection
  title: getSignatureCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Signature resource.
  expects: Signature
  method: POST
  returns: Signature
  title: postSignature

Entrypoint/spc
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Spc
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Spc resources.
  method: GET
  returns: Collection
  title: getSpcCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Spc resource.
  expects: Spc
  method: POST
  returns: Spc
  title: postSpc

Entrypoint/substance
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Substance
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Substance resources.
  method: GET
  returns: Collection
  title: getSubstanceCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Substance resource.
  expects: Substance
  method: POST
  returns: Substance
  title: postSubstance

Entrypoint/user
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: User
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of User resources.
  method: GET
  returns: Collection
  title: getUserCollection
supported operation: Operation
  type: CreateAction
  description: Creates a User resource.
  expects: User
  method: POST
  returns: User
  title: postUser

ConstraintViolationList
type: Class
title: ConstraintViolationList
description: A constraint violation List.
supported property: SupportedProperty
  property: propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writeable: false
supported property: SupportedProperty
  property: message
  title: message
  description: The message associated with the violation
  readable: true
  writeable: false

propertyPath
type: Property
domain: ConstraintViolationList
range: string

message
type: Property
domain: ConstraintViolationList
range: string