BfArM Digitale Anwendungen
3.1.0-TEST - draft

BfArM Digitale Anwendungen - Local Development build (v3.1.0-TEST) 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 (user-friendly-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 user-friendly-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

Definition of an entry in the DiGA or DiPA catalog representing a digital health application (DiGA) or digital nursing application (DiPA).

HealthAppManufacturer

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

HealthAppModule

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

HealthAppPrescriptionUnit

Definition of a prescription unit of a module of a digital health application (DiGA) or a usage unit of a module of a digital nursing application (DiPA).

HealthAppQuestionnaire

Definition of a questionnaire that is answered by the manufacturer of a digital application as part of an application for inclusion in the DiGA or DiPA catalog.

HealthAppQuestionnaireResponse

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

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 profile for age codes in the HealthApp context.

Coding for HealthAppCategoryIdentifier

Coding profile for HealthApp category identifiers.

Coding for HealthAppCountry

Coding profile for country codes in the HealthApp context.

Coding for HealthAppEbm

Coding profile for KBV EBM codes in the HealthApp context.

Coding for HealthAppFocus

Coding profile for HealthApp impairment dimensions (focus).

Coding for HealthAppGender

Coding profile for administrative gender in the HealthApp context.

Coding for HealthAppHistoryEntryType

Coding profile for the type of a history entry.

Coding for HealthAppIcd

Coding profile for ICD-10-GM codes in the HealthApp context.

Coding for HealthAppLanguage

Coding profile for language codes in HealthApp questionnaires.

Coding for HealthAppManufacturerType

Coding profile for the type of a manufacturer.

Coding for HealthAppPriceCode

Coding profile for price codes in the HealthApp context.

Coding for HealthAppSeverity

Coding profile for the severity inside the focus use context of Digital Nursing Applications (DiPA).

Coding for HiisCatalogEntryType

Coding profile for the type of a HIIS catalog entry.

Coding for HiisCountry

Coding profile for country codes in HIIS context.

Coding for HiisEndpointConnectionType

Coding profile for endpoint connection types.

Coding for HiisHistoryEntryType

Coding profile for the type of a history entry.

Coding for HiisLanguage

Coding profile for language codes in HIIS questionnaires.

Coding for HiisManufacturerType

Coding profile for the type of a manufacturer.

Structures: Extension Definitions

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

HealthApp: Handbook

Extension for the handbook of a digital application.

HealthApp: HiisTrustAttributes

Extension for HIIS trust attributes of a HealthApp.

HealthApp: Media

Extension for the media data of a digital application.

HealthApp: MivSet

Extension for referencing an MIV Set (Mandatory Interoperable Value Set) supported by a DiGA.

HealthApp: Nutzungshinweis

Extension for notes that should be considered when using a digital health application.

HealthApp: Summaries

Extension for editorial descriptions of a digital application.

HealthAppCatalogEntry: HealthAppLink

Extension for the reference to a digital application (HealthApp) in the HealthApp catalog entry.

HealthAppCatalogEntry: History

Extension for the change history of a DiGA or DiPA catalog entry.

HealthAppCatalogEntry: TrialPeriod

Extension for the trial listing period of a DiGA catalog entry.

HealthAppModule: Category

Extension for categorizing the module of a digital health application.

HealthAppModule: Hardware

Extension for information about whether additional devices are required to use the digital application module.

HealthAppModule: MedicalDevice

Extension for information about the medical device.

HealthAppModule: SpecializationCompatibility

Extension for describing the hardware and software compatibility.

HealthAppModule: SpecializationUrl

Extension for the specification of the URL of the digital application module for the respective platform.

HealthAppPrescriptionUnit: Anwendungsdauer

Extension for specifying how long the user should use the prescription unit of the digital health application (DiGA). If not present, use is not time-limited (single licence).

HealthAppPrescriptionUnit: CodeValidUntil

Extension for specifying the latest date until which the PZN can be prescribed.

HealthAppPrescriptionUnit: ErgaenzendeUnterstuetzungsleistungen

Extension for indicating whether additional support services are required for the usage unit.

HealthAppPrescriptionUnit: HealthAppModuleLink

Extension for referencing the parent module of the digital application (HealthAppModule).

HealthAppPrescriptionUnit: Indikation

Extension for providing information on when the prescription unit of the digital health application (DiGA) is indicated.

HealthAppPrescriptionUnit: Kontraindikation

Extension for providing information on when the prescription unit of the digital health application (DiGA) is contraindicated.

HealthAppPrescriptionUnit: PropertyGroupNonRefundable

Extension for information on costs of the prescription or usage unit that cannot be reimbursed (e.g. by statutory health insurance).

HealthAppPrescriptionUnit: UseContextValueSeverity

Extension for specifying the optional severity level of the impairment dimension.

HealthAppPrescriptionUnit: VertragsaerztlicheLeistungen

Extension for specifying whether additional services provided by a contracted doctor are required for the prescription unit.

HealthAppQuestionnaire: ItemDescription

Extension for additional descriptive texts for an answerOption or item.

HealthAppQuestionnaireResponse: AnswerRange

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

HealthAppQuestionnaireResponse: ItemInapplicable

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

HiisCatalogEntry: History

Extension for the change history of a HIIS catalog entry.

HiisCatalogEntry: ReferencedItemLink

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

HiisCategory: Subject

Extension for referencing an MIV Set (Mandatory Interoperable Value Set) in a HIIS category.

HiisDeviceDataRecorder: EndpointLink

Extension for referencing an endpoint of a medical aid interface.

HiisDeviceDefinition: MivSet

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

HiisQuestionnaire: ItemDescription

Extension for additional descriptive texts for an answerOption or item.

HiisQuestionnaireResponse: AnswerRange

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

HiisQuestionnaireResponse: ItemInapplicable

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

Terminology: Value Sets

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

HealthAppAge

ValueSet for age groups in the HealthApp context.

HealthAppAttachment

ValueSet for attachment content types in the HealthApp context.

HealthAppCatalogEntryStatus

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

HealthAppDeviceDefinitionRelationType

ValueSet for device definition relation types in the HealthApp context.

HealthAppEbm

ValueSet for KBV EBM codes in the HealthApp context.

HealthAppHistoryEntryType

ValueSet for the type of a history entry in the HealthApp context.

HealthAppIcd

ValueSet for ICD-10-GM codes in the HealthApp context.

HealthAppManufacturerType

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

HealthAppPlatformType

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

HealthAppPrescriptionUnitPriceComponentType

ValueSet for the type of a price component on a HealthApp prescription or usage unit. Restricts InvoicePriceComponentType to only informational.

HealthAppPrescriptionUnitStatus

ValueSet for the status of a HealthApp prescription or usage unit. Restricts PublicationStatus to only unknown.

HealthAppPriceCode

ValueSet for price codes in the HealthApp context.

HealthAppQuestionnaireItemType

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

HealthAppQuestionnaireQuestionItemType

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

HealthAppQuestionnaireResponseStatus

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

HealthAppQuestionnaireStatus

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

HealthAppRegulatoryBasis

ValueSet for the regulatory basis of a medical device in the HealthApp context.

HealthAppRiskClass

ValueSet for the risk class of a medical device in the HealthApp context.

HealthAppSeverity

ValueSet for the severity inside the focus use context of Digital Nursing Applications (DiPA).

HiisAttachmentContentType

ValueSet for attachment content types in the HIIS context.

HiisCatalogEntryStatus

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

HiisCatalogEntryType

ValueSet for the type of a HIIS catalog entry.

HiisDeviceDefinitionRelationType

ValueSet for device definition relation types in the HIIS context.

HiisEndpointConnectionType

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

HiisHistoryEntryType

ValueSet for the type of a history entry in the HIIS context.

HiisManufacturerType

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

HiisQuestionnaireItemType

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

HiisQuestionnaireQuestionItemType

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

HiisQuestionnaireResponseStatus

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

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.

HealthAppDeviceDefinitionRelationType

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

HealthAppHistoryEntryType

Codesystem for the type of a change history entry on a HealthApp catalog entry.

HealthAppManufacturerType

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

HealthAppPlatformType

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

HealthAppPriceCode

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

HealthAppRegulatoryBasis

CodeSystem for the regulatory basis of a medical device in the HealthApp context.

HealthAppRiskClass

CodeSystem for the risk class of a medical device in the HealthApp context.

HealthAppSeverity

CodeSystem for the severity inside the focus use context of Digital Nursing Applications (DiPA).

HiisCatalogEntryType

CodeSystem for the type of a HIIS catalog entry.

HiisDeviceDefinitionRelationType

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

HiisEndpointConnectionType

CodeSystem for additional endpoint connection types in the HIIS context.

HiisHistoryEntryType

Codesystem for the type of a change history entry on a HIIS catalog entry.

HiisManufacturerType

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

Terminology: Naming Systems

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

DigaId

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

DigaVeId

NamingSystem for the unique identification number of a prescription unit of a digital health application (DiGA-VE).

DipaAeId

NamingSystem for the unique identification number of an application unit of a digital nursing application (DiPA-AE).

DipaId

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

HealthAppCategoryId

NamingSystem for the unique internal identification number of a HealthApp category.

HealthAppFocusId

NamingSystem for the unique internal identification number of a dimension of impairment of a HealthApp.

HealthAppQuestionnaireId

NamingSystem for the unique internal identification number of a questionnaire in the HealthApp context.

HiisId

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

HiisQuestionnaireId

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