BfArM Digitale Anwendungen
3.0.2-RC1 - draft

​BfArM Digitale Anwendungen - Local Development build (v3.0.2-RC1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: HealthApp

Official URL: https://fhir.bfarm.de/StructureDefinition/HealthApp Version: 3.0.2-RC1
Active as of 2026-02-25 Computable Name: HealthApp

Definition of a digital health application (DiGA) or digital nursing application (DiPA).

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
.. DeviceDefinition S 0..* DeviceDefinition Digital application
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:handbook S 0..1 AttachmentHealthApp Handbook
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppHandbook
.... extension:hiisTrustAttributes S 0..1 (Complex) HIIS Trust Attributes
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppHiisTrustAttributes
.... extension:media S 0..1 (Complex) Media data
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppMedia
.... extension:mivSet S 0..* Reference() HealthAppMivSet
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppMivSet
.... extension:nutzungshinweis S 0..1 (Complex) Usage notes
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppNutzungshinweis
.... extension:summaries S 0..1 (Complex) Editorial descriptions
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppSummaries
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:digaId S 0..1 Identifier DiGA-ID in the directory
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/DigaId
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:dipaId S 0..1 Identifier DiPA-ID in the directory
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/DipaId
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:healthAppId S 1..1 Identifier HealthApp-ID
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/HealthAppId
..... value SΣ 1..1 string The value that is unique
Example General: 123456
... Slices for manufacturer[x] S 0..1 Name of device manufacturer
Slice: Unordered, Open by type:$this
.... manufacturerString string
.... manufacturerReference Reference(Organization)
.... manufacturer[x]:manufacturerReference S 0..1 Reference(HealthAppManufacturer) HealthAppManufacturer
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... display SΣ 0..1 string Text alternative for the resource
... Slices for deviceName S 0..* BackboneElement Application name
Slice: Unordered, Open by value:type
.... deviceName:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1 string The name of the device
..... type 1..1 code udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
Binding: DeviceNameType (required): The type of name the device is referred by.
.... deviceName:userFriendlyName S 0..1 BackboneElement Name
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name S 1..1 string The name of the device
..... type 1..1 code udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
Binding: DeviceNameType (required): The type of name the device is referred by.
Fixed Value: user-friendly-name
... onlineInformation S 0..1 uri Information website

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DeviceDefinition.identifier:digaId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DeviceDefinition.identifier:dipaId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DeviceDefinition.identifier:healthAppId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DeviceDefinition.deviceName.​type Base required DeviceNameType 📍4.0.1 FHIR Std.
DeviceDefinition.deviceName:userFriendlyName.​type Base required DeviceNameType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DeviceDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DeviceDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DeviceDefinition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DeviceDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DeviceDefinition A resource should have narrative for robust management text.`div`.exists()
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 DeviceDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DeviceDefinition S 0..* DeviceDefinition Digital application
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:handbook S 0..1 AttachmentHealthApp Handbook
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppHandbook
.... extension:hiisTrustAttributes S 0..1 (Complex) HIIS Trust Attributes
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppHiisTrustAttributes
.... extension:media S 0..1 (Complex) Media data
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppMedia
.... extension:mivSet S 0..* Reference() HealthAppMivSet
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppMivSet
.... extension:nutzungshinweis S 0..1 (Complex) Usage notes
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppNutzungshinweis
.... extension:summaries S 0..1 (Complex) Editorial descriptions
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppSummaries
... Slices for identifier S 1..* Identifier IDs of the digital application
Slice: Unordered, Open by value:system
.... identifier:digaId S 0..1 Identifier DiGA-ID in the directory
..... system S 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/DigaId
..... value S 1..1 string The value that is unique
.... identifier:dipaId S 0..1 Identifier DiPA-ID in the directory
..... system S 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/DipaId
..... value S 1..1 string The value that is unique
.... identifier:healthAppId S 1..1 Identifier HealthApp-ID
..... system S 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/HealthAppId
..... value S 1..1 string The value that is unique
... Slices for manufacturer[x] S 0..1 string, Reference(Organization) Name of device manufacturer
Slice: Unordered, Open by type:$this
.... manufacturer[x]:manufacturerReference S 0..1 Reference(HealthAppManufacturer) HealthAppManufacturer
..... reference S 1..1 string Literal reference, Relative, internal or absolute URL
..... display S 0..1 string Text alternative for the resource
.... deviceName:userFriendlyName S 0..1 BackboneElement Name
..... name S 1..1 string The name of the device
..... type 1..1 code udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
Fixed Value: user-friendly-name
... onlineInformation S 0..1 uri Information website

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DeviceDefinition S 0..* DeviceDefinition Digital application
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:handbook S 0..1 AttachmentHealthApp Handbook
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppHandbook
.... extension:hiisTrustAttributes S 0..1 (Complex) HIIS Trust Attributes
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppHiisTrustAttributes
.... extension:media S 0..1 (Complex) Media data
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppMedia
.... extension:mivSet S 0..* Reference() HealthAppMivSet
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppMivSet
.... extension:nutzungshinweis S 0..1 (Complex) Usage notes
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppNutzungshinweis
.... extension:summaries S 0..1 (Complex) Editorial descriptions
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppSummaries
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 1..* Identifier IDs of the digital application
Slice: Unordered, Open by value:system
.... identifier:digaId S 0..1 Identifier DiGA-ID in the directory
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/DigaId
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:dipaId S 0..1 Identifier DiPA-ID in the directory
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/DipaId
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:healthAppId S 1..1 Identifier HealthApp-ID
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/HealthAppId
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... udiDeviceIdentifier 0..* BackboneElement Unique Device Identifier (UDI) Barcode string
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... deviceIdentifier 1..1 string The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
.... issuer 1..1 uri The organization that assigns the identifier algorithm
.... jurisdiction 1..1 uri The jurisdiction to which the deviceIdentifier applies
... Slices for manufacturer[x] S 0..1 Name of device manufacturer
Slice: Unordered, Open by type:$this
.... manufacturerString string
.... manufacturerReference Reference(Organization)
.... manufacturer[x]:manufacturerReference S 0..1 Reference(HealthAppManufacturer) HealthAppManufacturer
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display SΣ 0..1 string Text alternative for the resource
... Slices for deviceName S 0..* BackboneElement Application name
Slice: Unordered, Open by value:type
.... deviceName:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1 string The name of the device
..... type 1..1 code udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
Binding: DeviceNameType (required): The type of name the device is referred by.
.... deviceName:userFriendlyName S 0..1 BackboneElement Name
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name S 1..1 string The name of the device
..... type 1..1 code udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
Binding: DeviceNameType (required): The type of name the device is referred by.
Fixed Value: user-friendly-name
... modelNumber 0..1 string The model number for the device
... type 0..1 CodeableConcept What kind of device or device system this is
Binding: FHIRDeviceTypes (example): Type of device e.g. according to official classification.
... specialization 0..* BackboneElement The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... systemType 1..1 string The standard that is used to operate and communicate
.... version 0..1 string The version of the standard that is used to operate and communicate
... version 0..* string Available versions
... safety Σ 0..* CodeableConcept Safety characteristics of the device
Binding: DeviceSafety (example)
... shelfLifeStorage 0..* ProductShelfLife Shelf Life and storage information
... physicalCharacteristics 0..1 ProdCharacteristic Dimensions, color etc.
... languageCode 0..* CodeableConcept Language code for the human-readable text strings produced by the device (all supported)
... capability 0..* BackboneElement Device capabilities
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Type of capability
.... description 0..* CodeableConcept Description of capability
... property 0..* BackboneElement The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
.... valueQuantity 0..* Quantity Property value as a quantity
.... valueCode 0..* CodeableConcept Property value as a code, e.g., NTP4 (synced to NTP)
... owner 0..1 Reference(Organization) Organization responsible for device
... contact 0..* ContactPoint Details for human/organization for support
... url 0..1 uri Network address to contact device
... onlineInformation S 0..1 uri Information website
... note 0..* Annotation Device notes and comments
... quantity 0..1 Quantity The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product)
... parentDevice Σ 0..1 Reference(DeviceDefinition) The parent device it can be part of
... material 0..* BackboneElement A substance used to create the material(s) of which the device is made
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance 1..1 CodeableConcept The substance
.... alternate 0..1 boolean Indicates an alternative material of the device
.... allergenicIndicator 0..1 boolean Whether the substance is a known or suspected allergen

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DeviceDefinition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DeviceDefinition.identifier:digaId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DeviceDefinition.identifier:digaId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DeviceDefinition.identifier:dipaId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DeviceDefinition.identifier:dipaId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DeviceDefinition.identifier:healthAppId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DeviceDefinition.identifier:healthAppId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DeviceDefinition.manufacturer[x]:manufacturerReference.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
DeviceDefinition.deviceName.​type Base required DeviceNameType 📍4.0.1 FHIR Std.
DeviceDefinition.deviceName:userFriendlyName.​type Base required DeviceNameType 📍4.0.1 FHIR Std.
DeviceDefinition.type Base example FHIR Device Types 📍4.0.1 FHIR Std.
DeviceDefinition.safety Base example Device safety 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DeviceDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DeviceDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DeviceDefinition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DeviceDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DeviceDefinition A resource should have narrative for robust management text.`div`.exists()
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 DeviceDefinition

Summary

Mandatory: 4 elements(5 nested mandatory elements)
Must-Support: 25 elements
Fixed: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DeviceDefinition.identifier
  • The element 1 is sliced based on the value of DeviceDefinition.manufacturer[x]
  • The element 1 is sliced based on the value of DeviceDefinition.deviceName

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DeviceDefinition S 0..* DeviceDefinition Digital application
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:handbook S 0..1 AttachmentHealthApp Handbook
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppHandbook
.... extension:hiisTrustAttributes S 0..1 (Complex) HIIS Trust Attributes
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppHiisTrustAttributes
.... extension:media S 0..1 (Complex) Media data
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppMedia
.... extension:mivSet S 0..* Reference() HealthAppMivSet
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppMivSet
.... extension:nutzungshinweis S 0..1 (Complex) Usage notes
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppNutzungshinweis
.... extension:summaries S 0..1 (Complex) Editorial descriptions
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppSummaries
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:digaId S 0..1 Identifier DiGA-ID in the directory
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/DigaId
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:dipaId S 0..1 Identifier DiPA-ID in the directory
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/DipaId
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:healthAppId S 1..1 Identifier HealthApp-ID
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/HealthAppId
..... value SΣ 1..1 string The value that is unique
Example General: 123456
... Slices for manufacturer[x] S 0..1 Name of device manufacturer
Slice: Unordered, Open by type:$this
.... manufacturerString string
.... manufacturerReference Reference(Organization)
.... manufacturer[x]:manufacturerReference S 0..1 Reference(HealthAppManufacturer) HealthAppManufacturer
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... display SΣ 0..1 string Text alternative for the resource
... Slices for deviceName S 0..* BackboneElement Application name
Slice: Unordered, Open by value:type
.... deviceName:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1 string The name of the device
..... type 1..1 code udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
Binding: DeviceNameType (required): The type of name the device is referred by.
.... deviceName:userFriendlyName S 0..1 BackboneElement Name
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name S 1..1 string The name of the device
..... type 1..1 code udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
Binding: DeviceNameType (required): The type of name the device is referred by.
Fixed Value: user-friendly-name
... onlineInformation S 0..1 uri Information website

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DeviceDefinition.identifier:digaId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DeviceDefinition.identifier:dipaId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DeviceDefinition.identifier:healthAppId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DeviceDefinition.deviceName.​type Base required DeviceNameType 📍4.0.1 FHIR Std.
DeviceDefinition.deviceName:userFriendlyName.​type Base required DeviceNameType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DeviceDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DeviceDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DeviceDefinition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DeviceDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DeviceDefinition A resource should have narrative for robust management text.`div`.exists()
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()

Differential View

This structure is derived from DeviceDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DeviceDefinition S 0..* DeviceDefinition Digital application
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:handbook S 0..1 AttachmentHealthApp Handbook
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppHandbook
.... extension:hiisTrustAttributes S 0..1 (Complex) HIIS Trust Attributes
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppHiisTrustAttributes
.... extension:media S 0..1 (Complex) Media data
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppMedia
.... extension:mivSet S 0..* Reference() HealthAppMivSet
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppMivSet
.... extension:nutzungshinweis S 0..1 (Complex) Usage notes
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppNutzungshinweis
.... extension:summaries S 0..1 (Complex) Editorial descriptions
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppSummaries
... Slices for identifier S 1..* Identifier IDs of the digital application
Slice: Unordered, Open by value:system
.... identifier:digaId S 0..1 Identifier DiGA-ID in the directory
..... system S 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/DigaId
..... value S 1..1 string The value that is unique
.... identifier:dipaId S 0..1 Identifier DiPA-ID in the directory
..... system S 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/DipaId
..... value S 1..1 string The value that is unique
.... identifier:healthAppId S 1..1 Identifier HealthApp-ID
..... system S 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/HealthAppId
..... value S 1..1 string The value that is unique
... Slices for manufacturer[x] S 0..1 string, Reference(Organization) Name of device manufacturer
Slice: Unordered, Open by type:$this
.... manufacturer[x]:manufacturerReference S 0..1 Reference(HealthAppManufacturer) HealthAppManufacturer
..... reference S 1..1 string Literal reference, Relative, internal or absolute URL
..... display S 0..1 string Text alternative for the resource
.... deviceName:userFriendlyName S 0..1 BackboneElement Name
..... name S 1..1 string The name of the device
..... type 1..1 code udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
Fixed Value: user-friendly-name
... onlineInformation S 0..1 uri Information website

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DeviceDefinition S 0..* DeviceDefinition Digital application
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:handbook S 0..1 AttachmentHealthApp Handbook
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppHandbook
.... extension:hiisTrustAttributes S 0..1 (Complex) HIIS Trust Attributes
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppHiisTrustAttributes
.... extension:media S 0..1 (Complex) Media data
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppMedia
.... extension:mivSet S 0..* Reference() HealthAppMivSet
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppMivSet
.... extension:nutzungshinweis S 0..1 (Complex) Usage notes
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppNutzungshinweis
.... extension:summaries S 0..1 (Complex) Editorial descriptions
URL: https://fhir.bfarm.de/StructureDefinition/HealthAppSummaries
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 1..* Identifier IDs of the digital application
Slice: Unordered, Open by value:system
.... identifier:digaId S 0..1 Identifier DiGA-ID in the directory
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/DigaId
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:dipaId S 0..1 Identifier DiPA-ID in the directory
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/DipaId
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:healthAppId S 1..1 Identifier HealthApp-ID
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/HealthAppId
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... udiDeviceIdentifier 0..* BackboneElement Unique Device Identifier (UDI) Barcode string
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... deviceIdentifier 1..1 string The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
.... issuer 1..1 uri The organization that assigns the identifier algorithm
.... jurisdiction 1..1 uri The jurisdiction to which the deviceIdentifier applies
... Slices for manufacturer[x] S 0..1 Name of device manufacturer
Slice: Unordered, Open by type:$this
.... manufacturerString string
.... manufacturerReference Reference(Organization)
.... manufacturer[x]:manufacturerReference S 0..1 Reference(HealthAppManufacturer) HealthAppManufacturer
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display SΣ 0..1 string Text alternative for the resource
... Slices for deviceName S 0..* BackboneElement Application name
Slice: Unordered, Open by value:type
.... deviceName:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1 string The name of the device
..... type 1..1 code udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
Binding: DeviceNameType (required): The type of name the device is referred by.
.... deviceName:userFriendlyName S 0..1 BackboneElement Name
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name S 1..1 string The name of the device
..... type 1..1 code udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
Binding: DeviceNameType (required): The type of name the device is referred by.
Fixed Value: user-friendly-name
... modelNumber 0..1 string The model number for the device
... type 0..1 CodeableConcept What kind of device or device system this is
Binding: FHIRDeviceTypes (example): Type of device e.g. according to official classification.
... specialization 0..* BackboneElement The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... systemType 1..1 string The standard that is used to operate and communicate
.... version 0..1 string The version of the standard that is used to operate and communicate
... version 0..* string Available versions
... safety Σ 0..* CodeableConcept Safety characteristics of the device
Binding: DeviceSafety (example)
... shelfLifeStorage 0..* ProductShelfLife Shelf Life and storage information
... physicalCharacteristics 0..1 ProdCharacteristic Dimensions, color etc.
... languageCode 0..* CodeableConcept Language code for the human-readable text strings produced by the device (all supported)
... capability 0..* BackboneElement Device capabilities
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Type of capability
.... description 0..* CodeableConcept Description of capability
... property 0..* BackboneElement The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
.... valueQuantity 0..* Quantity Property value as a quantity
.... valueCode 0..* CodeableConcept Property value as a code, e.g., NTP4 (synced to NTP)
... owner 0..1 Reference(Organization) Organization responsible for device
... contact 0..* ContactPoint Details for human/organization for support
... url 0..1 uri Network address to contact device
... onlineInformation S 0..1 uri Information website
... note 0..* Annotation Device notes and comments
... quantity 0..1 Quantity The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product)
... parentDevice Σ 0..1 Reference(DeviceDefinition) The parent device it can be part of
... material 0..* BackboneElement A substance used to create the material(s) of which the device is made
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance 1..1 CodeableConcept The substance
.... alternate 0..1 boolean Indicates an alternative material of the device
.... allergenicIndicator 0..1 boolean Whether the substance is a known or suspected allergen

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DeviceDefinition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DeviceDefinition.identifier:digaId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DeviceDefinition.identifier:digaId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DeviceDefinition.identifier:dipaId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DeviceDefinition.identifier:dipaId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DeviceDefinition.identifier:healthAppId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DeviceDefinition.identifier:healthAppId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DeviceDefinition.manufacturer[x]:manufacturerReference.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
DeviceDefinition.deviceName.​type Base required DeviceNameType 📍4.0.1 FHIR Std.
DeviceDefinition.deviceName:userFriendlyName.​type Base required DeviceNameType 📍4.0.1 FHIR Std.
DeviceDefinition.type Base example FHIR Device Types 📍4.0.1 FHIR Std.
DeviceDefinition.safety Base example Device safety 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DeviceDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DeviceDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DeviceDefinition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DeviceDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DeviceDefinition A resource should have narrative for robust management text.`div`.exists()
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 DeviceDefinition

Summary

Mandatory: 4 elements(5 nested mandatory elements)
Must-Support: 25 elements
Fixed: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DeviceDefinition.identifier
  • The element 1 is sliced based on the value of DeviceDefinition.manufacturer[x]
  • The element 1 is sliced based on the value of DeviceDefinition.deviceName

 

Other representations of profile: CSV, Excel, Schematron