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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

Operation to retrieve all endpoints for an interface

This operation returns all endpoints (HiisDeviceDataRecorderEndpoint) that are linked to a specific interface (HiisDeviceDataRecorderDefinition) via the HiisDeviceDataRecorderEndpointLink extension

Operation to retrieve all interfaces supporting a specific device

This operation returns all interfaces (HiisDeviceDataRecorderDefinition) that support a specific medical aid or implant (HiisPersonalHealthDeviceDefinition) with relation type 'supports'

Operation to retrieve all related resources

This operation is used to return the DeviceDefinition resource itself along with all other resources from the server that relate to the DeviceDefinition.

Operation to retrieve all supported devices for an interface

This operation returns all medical aids or implants (HiisPersonalHealthDeviceDefinition) that are supported by a specific interface (HiisDeviceDataRecorderDefinition) with relation type 'supports'

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

SearchParameter for code on ChargeItemDefinition

Search for ChargeItemDefinition entries based on the code

SearchParameter for combined search on DeviceDefinition (deviceName, modelNumber, type)

Search for DeviceDefinition entries based on device name (model-name), model number, or device type code

SearchParameter for device name on DeviceDefinition

Search for DeviceDefinition entries based on the device name (deviceName with type model-name)

SearchParameter for manufacturer name on DeviceDefinition

Search for DeviceDefinition entries based on the name of the referenced manufacturer Organization

SearchParameter for mivSet on DeviceDefinition

Search for DeviceDefinition entries based on a supported MIV Set

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

HealthApp

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

HealthAppCatalogEntry
HealthAppManufacturer

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

HealthAppModule
HealthAppPrescriptionUnit
HealthAppQuestionnaire
HealthAppQuestionnaireResponse
HiisCatalogEntry

Definition of an entry in the HIIS catalog representing a medical aid, an implant, or an interface for a medical aid or implant.

HiisCategory

Definition of a category in the HIIS catalog.

HiisDeviceDataRecorderDefinition

Definition of an interface (DeviceDataRecorder) for a medical aid or implant in the HIIS catalog.

HiisDeviceDataRecorderEndpoint

Definition of an endpoint for a medical aid interface (DeviceDataRecorder) in HIIS.

HiisManufacturer

Definition of a manufacturer in the HIIS catalog.

HiisPersonalHealthDeviceDefinition

Definition of a personal health medical aid or implant in the HIIS catalog.

HiisQuestionnaire

Definition of a questionnaire that is answered by the manufacturer of an interface for a medical aid or implant as part of an application for inclusion in the HIIS catalog.

HiisQuestionnaireResponse

Definition of answers given by the manufacturer for a specific questionnaire.

Structures: Data Type Profiles

These define constraints on FHIR data types for systems conforming to this implementation guide.

Attachment for HealthApp

Attachment profile for HealthApp.

Attachment for Hiis

Attachment profile for Hiis.

Coding for HealthAppAge
Coding for HealthAppCategoryIdentifier
Coding for HealthAppCategoryType
Coding for HealthAppCountry
Coding for HealthAppEbm
Coding for HealthAppFocus
Coding for HealthAppGender
Coding for HealthAppHistoryEntryType
Coding for HealthAppIcd
Coding for HealthAppLanguage
Coding for HealthAppManufacturerType

Coding profile for HealthAppManufacturerType.

Coding for HealthAppPriceCode
Coding for HealthAppSeverity
Coding for HiisCatalogEntryType

Coding profile for HiisCatalogEntryType.

Coding for HiisCountry

Coding profile for country codes in HIIS context.

Coding for HiisEbm

Coding profile for EBM codes in HIIS context.

Coding for HiisEndpointConnectionType

Coding profile for endpoint connection types.

Coding for HiisLanguage

Coding profile for language codes in HIIS questionnaires.

Coding for HiisManufacturerType

Coding profile for HiisManufacturerType.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Answer Range on HealthAppQuestionnaireResponse
Answer Range on HiisQuestionnaireResponse

Extension for the given answer range for range-type questions.

AnswerOption Description on HealthAppQuestionnaire
Anwendungsdauer on HealthAppPrescriptionUnit
Category on HealthAppModule
ErgaenzendeUnterstuetzungsleistungen on HealthAppPrescriptionUnit
Handbook on HealthApp

Extension for the handbook of a digital application.

Hardware on HealthAppModule
HealthApp on HealthAppCatalogEntry
HealthAppHiisTrustAttributes

Extension for HIIS trust attributes of a HealthApp.

HealthAppMivSet

Extension for references to MIV Sets (Mandatory Interoperable Value Sets) supported by a DiGA.

HealthAppModule on HealthAppPrescriptionUnit
HiisCatalogEntryHistory

Extension for the change history of a HIIS catalog entry.

HiisCategorySubjects

Extension for references to MIV Sets (Mandatory Interoperable Value Sets) in a HIIS category.

HiisDeviceDataRecorderEndpointLink

Extension for referencing an endpoint of a medical aid interface.

HiisDeviceDefinitionMivSet

Extension for referencing an MIV Set (Mandatory Interoperable Value Set).

History on HealthAppCatalogEntry
Indikation on HealthAppPrescriptionUnit
Item Description on HealthAppQuestionnaire
Item Description on HiisQuestionnaire

Extension for additional descriptive texts for an answerOption or item.

Item Inapplicable on HealthAppQuestionnaireResponse
Item Inapplicable on HiisQuestionnaireResponse

Extension for indicating whether "Not applicable" was selected for this question

Kontraindikation on HealthAppPrescriptionUnit
Media on HealthApp

Extension for the media data of a digital application.

MedicalDevice on HealthAppModule
NonRefundable on HealthAppPrescriptionUnitPropertyGroup
Nutzungshinweis on HealthApp

DiGA only: Extension for notes that should be considered when using a digital application.

Reference Link on HiisCatalogEntry

Extension for the reference to a medical aid or medical aid interface in the HIIS catalog entry.

Severity on HealthAppPrescriptionUnitUseContextValueCoding
Specialization Compatibility on HealthAppModule
Specialization Url on HealthAppModule
Summaries on HealthApp

Extension for editorial descriptions of a digital application.

TrialPeriod on HealthAppCatalogEntry
ValidUntil on HealthAppPrescriptionUnitCode
VertragsaerztlicheLeistungen on HealthAppPrescriptionUnit

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

ValueSet for HealthAppAge
ValueSet for HealthAppAttachment

ValueSet for attachment content types in the HealthApp context.

ValueSet for HealthAppCategoryType
ValueSet for HealthAppEbm
ValueSet for HealthAppHistoryEntryType
ValueSet for HealthAppIcd
ValueSet for HealthAppManufacturerType

ValueSet for the type of a manufacturer in the HealthApp context.

ValueSet for HealthAppPlatformType
ValueSet for HealthAppPriceCode
ValueSet for HealthAppRegulatoryBasis
ValueSet for HealthAppRiskClass
ValueSet for HealthAppSeverity
ValueSet for HiisAttachmentContentType

ValueSet for attachment content types in the HIIS context.

ValueSet for HiisCatalogEntryStatus

ValueSet for the status of a HIIS catalog entry. Restricts PublicationStatus to only active and retired.

ValueSet for HiisCatalogEntryType

ValueSet for the type of a HIIS catalog entry.

ValueSet for HiisDeviceDefinitionRelationType

ValueSet for device definition relation types in the HIIS context.

ValueSet for HiisEbm

ValueSet for EBM codes used in HIIS questionnaires.

ValueSet for HiisEndpointConnectionType

ValueSet for endpoint connection types in the HIIS context. Restricts to hl7-fhir-rest and oauth-authz-server.

ValueSet for HiisManufacturerType

ValueSet for the type of a manufacturer in the HIIS context.

ValueSet for HiisQuestionnaireItemType

ValueSet for the item type of a HIIS questionnaire item. Restricts QuestionnaireItemType to only group.

ValueSet for HiisQuestionnaireQuestionItemType

ValueSet for the item type of a HIIS questionnaire question item. Restricts QuestionnaireItemType to text, choice, open-choice, and attachment.

ValueSet for HiisQuestionnaireResponseStatus

ValueSet for the status of a HIIS questionnaire response. Restricts QuestionnaireResponseStatus to only completed.

ValueSet for HiisQuestionnaireStatus

ValueSet for the status of a HIIS questionnaire. Restricts PublicationStatus to only active.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

CodeSystem for HealthAppCategoryType
CodeSystem for HealthAppHistoryEntryType
CodeSystem for HealthAppManufacturerType

CodeSystem for the type of a manufacturer in the HealthApp context.

CodeSystem for HealthAppPlatformType
CodeSystem for HealthAppPriceCode
CodeSystem for HealthAppRegulatoryBasis
CodeSystem for HealthAppRiskClass
CodeSystem for HealthAppSeverity
CodeSystem for HiisCatalogEntryType

CodeSystem for the type of a HIIS catalog entry.

CodeSystem for HiisDeviceDefinitionRelationType

CodeSystem for additional device definition relation types in the HIIS context.

CodeSystem for HiisEndpointConnectionType

CodeSystem for additional endpoint connection types in the HIIS context.

CodeSystem for HiisManufacturerType

CodeSystem for the type of a manufacturer in the HIIS context.

CodeSystem-BCP 13

Terminology: Naming Systems

These define identifier and/or code system identities used by systems conforming to this implementation guide.

HiisId

NamingSystem for the unique identification number for an entry in the HIIS catalog.

HiisQuestionnaireId

NamingSystem for the unique identification number for a questionnaire in the HIIS catalog.

NamingSystem-DigaId
NamingSystem-DigaVeId
NamingSystem-DipaAeId
NamingSystem-DipaId
NamingSystem-HealthAppCategoryId
NamingSystem-HealthAppFocusId
NamingSystem-HealthAppId
NamingSystem-HealthAppQuestionnaireId