ISiK Dokumentenaustausch Implementierungsleitfaden
Version 6.0.0-rc - ci-build

Resource Profile: ISiKBinary

Official URL: https://gematik.de/fhir/isik/StructureDefinition/ISiKBinary Version: 6.0.0-rc
Active as of 2025-12-17 Computable Name: ISiKBinary

Dieses Profil ermöglicht die Darstellung von FHIR-fremden Formaten (z.B. PDFs, Bilder, CDA) in ISiK Szenarien.

Motivation

Für FHIR-fremde Formate werden die Daten base64-codiert in der Binary-Ressource (in XML oder JSON) transportiert oder über die REST-API am Binary-Endpunkt in ihrem nativen Format bereitgestellt. Binary-Ressourcen werden von Attachment-Elementen in DocumentReference-Ressourcen verlinkt und damit in den Kontext anderer FHIR-Ressourcen (z.B. Patient und Encounter) gestellt.

Kompatibilität

Hinweise zu Inkompatibilitäten können über die Portalseite gemeldet werden.

Hinweis

Das ISIK-Binary-Profil ist nicht Bestandteil der Implementierung und des Bestätigungsverfahrens zum ISIK Basismodul. Das Profil ist Teil des ISIK Basismoduls, da es im Modul Dokumentenaustausch implementiert werden muss und ein hohes Potential für die Wiederverwednung in anderen Modulen naheliegt.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Binary 0..* Binary Pure binary content defined by a format other than FHIR
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contentType SΣ 1..1 code MimeType der Binärdaten
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Binary.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

This structure is derived from Binary

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Binary 0..* Binary Pure binary content defined by a format other than FHIR
... id S 0..1 id serverseitige, interne ID des Datensatzes
... meta
.... versionId 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated 0..1 instant Zeitpunkt der letzten Änderung
... contentType S 1..1 code MimeType der Binärdaten

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Binary 0..* Binary Pure binary content defined by a format other than FHIR
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated Σ 0..1 instant Zeitpunkt der letzten Änderung
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contentType SΣ 1..1 code MimeType der Binärdaten
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
... securityContext Σ 0..1 Reference(Resource) Identifies another resource to use as proxy when enforcing access control
... data S 1..1 base64Binary Base64-codierte Binärdaten

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Binary.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Binary.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Binary.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Binary.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ElementShort descriptionNotes
Binary.contentType MimeType der Binärdaten

z.B. "application/pdf" oder "image/jpeg"
Begründung Pflichtfeld: Ohne Kenntnis des MimeTypes sind die Base65-codierten Daten in data nicht interpretierbar

Binary.data Base64-codierte Binärdaten

Begründung Pflichtfeld: Sind keine Binärdaten vorhanden, ist diese Ressource sinnlos.

Binary.id serverseitige, interne ID des Datensatzes

bedingtes Pflichtfeld/bedingtes MS: Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine id verfügen. Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine idverfügen.

This structure is derived from Binary

Summary

Mandatory: 1 element
Must-Support: 3 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Binary 0..* Binary Pure binary content defined by a format other than FHIR
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contentType SΣ 1..1 code MimeType der Binärdaten
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Binary.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

Differential View

This structure is derived from Binary

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Binary 0..* Binary Pure binary content defined by a format other than FHIR
... id S 0..1 id serverseitige, interne ID des Datensatzes
... meta
.... versionId 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated 0..1 instant Zeitpunkt der letzten Änderung
... contentType S 1..1 code MimeType der Binärdaten

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Binary 0..* Binary Pure binary content defined by a format other than FHIR
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated Σ 0..1 instant Zeitpunkt der letzten Änderung
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contentType SΣ 1..1 code MimeType der Binärdaten
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
... securityContext Σ 0..1 Reference(Resource) Identifies another resource to use as proxy when enforcing access control
... data S 1..1 base64Binary Base64-codierte Binärdaten

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Binary.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Binary.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Binary.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Binary.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Binary

Summary

Mandatory: 1 element
Must-Support: 3 elements

 

Other representations of profile: CSV, Excel, Schematron