Endpunkte


Inhalt


CatalogEntry

Über die FHIR®-Ressource CatalogEntry werden die einzelnen Einträge aus dem DiPA-Verzeichnis mit Referenzierung auf die jeweiligen DiPA ausgegeben.

GET https://dipa.bfarm.de/api/fhir/v2.0/CatalogEntry


Informationen zu einem bestimmten Eintrag des DiPA-Verzeichnisses

Hinweis: Die intern verwendeten IDs dürfen nicht extern gespeichert werden, da diese sich bei neuen Releases der API ändern.

GET https://dipa.bfarm.de/api/fhir/v2.0/CatalogEntry/10

gibt die Daten zum Verzeichniseintrag mit der internen ID 10 aus.

JSON

{
    "resourceType": "CatalogEntry",
    "id": "10",
    "meta": {
        "versionId": "1",
        "lastUpdated": "2022-12-27T07:31:09.079+01:00",
        "source": "#tTaQXzIG5hRjot9s",
        "profile":  [
            "https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntry"
        ]
    },
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "https://dipa.bfarm.de/de/verzeichnis/01964"
        }
    ],
    "orderable": false,
    "referencedItem": {
        "extension":  [
            {
                "url": "https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntryHealthAppLink",
                "valueReference": {
                    "reference": "DeviceDefinition/1",
                    "display": "Healthy DiPA von krautsalad"
                }
            }
        ]
    },
    "status": "unknown"
}

XML

<CatalogEntry xmlns="http://hl7.org/fhir">
    <id value="10" />
    <meta>
        <versionId value="1" />
        <lastUpdated value="2022-12-27T07:31:09.079+01:00" />
        <source value="#tTaQXzIG5hRjot9s" />
        <profile value="https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntry" />
    </meta>
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="https://dipa.bfarm.de/de/verzeichnis/01964" />
    </identifier>
    <orderable value="false" />
    <referencedItem>
        <extension url="https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntryHealthAppLink">
            <valueReference>
                <reference value="DeviceDefinition/1" />
                <display value="Healthy DiPA von krautsalad" />
            </valueReference>
        </extension>
    </referencedItem>
    <status value="unknown" />
</CatalogEntry>


ChargeItemDefinition

Über die FHIR®-Ressource ChargeItemDefinition werden Informationen zu einzelnen Anwendungseinheiten der DiPA-Module ausgegeben.

GET https://dipa.bfarm.de/api/fhir/v2.0/ChargeItemDefinition


Informationen zu einer bestimmten DiPA-Anwendungseinheit

Hinweis: Die intern verwendeten IDs dürfen nicht extern gespeichert werden, da diese sich bei neuen Releases der API ändern.

GET https://dipa.bfarm.de/api/fhir/v2.0/ChargeItemDefinition/6

gibt die Daten zur Anwendungseinheit mit der internen ID 6 aus.

JSON

{
    "resourceType": "ChargeItemDefinition",
    "id": "6",
    "meta": {
        "versionId": "2",
        "lastUpdated": "2022-12-27T13:20:05.048+01:00",
        "source": "#bfIUHiPaEqwTHITD",
        "profile":  [
            "https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnit"
        ]
    },
    "url": "https://dipa.bfarm.de/de/verzeichnis/01964",
    "identifier":  [
        {
            "system": "https://fhir.bfarm.de/Identifier/DipaAeId",
            "value": "00000 001"
        }
    ],
    "title": "Healthy DiPA 001",
    "status": "unknown",
    "useContext":  [
        {
            "code": {
                "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
                "code": "age",
                "display": "Altersgruppe"
            },
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "41847000",
                        "display": "Erwachsene(r) (18-65 Jahre)"
                    }
                ]
            }
        },
        {
            "code": {
                "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
                "code": "age",
                "display": "Altersgruppe"
            },
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "271872005",
                        "display": "Erwachsene (älter als 65 Jahre)"
                    }
                ]
            }
        },
        {
            "code": {
                "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
                "code": "focus",
                "display": "Beeinträchtigung"
            },
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "https://fhir.bfarm.de/Identifier/HealthAppFocusId",
                        "code": "125",
                        "display": "Haushaltsführung"
                    }
                ]
            }
        },
        {
            "code": {
                "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
                "code": "focus",
                "display": "Beeinträchtigung"
            },
            "valueCodeableConcept": {
                "extension":  [
                    {
                        "url": "https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitUseContextValueSeverity",
                        "valueCoding": {
                            "system": "https://fhir.bfarm.de/CodeSystem/HealthAppSeverity",
                            "code": "severity-1",
                            "display": "Punktbereich 1: Geringe Beeinträchtigungen der Selbständigkeit oder der Fähigkeiten."
                        }
                    },
                    {
                        "url": "https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitUseContextValueSeverity",
                        "valueCoding": {
                            "system": "https://fhir.bfarm.de/CodeSystem/HealthAppSeverity",
                            "code": "severity-2",
                            "display": "Punktbereich 2: Erhebliche Beeinträchtigungen der Selbständigkeit oder der Fähigkeiten."
                        }
                    }
                ],
                "coding":  [
                    {
                        "system": "https://fhir.bfarm.de/Identifier/HealthAppFocusId",
                        "code": "119",
                        "display": "Mobilität"
                    }
                ]
            }
        },
        {
            "code": {
                "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
                "code": "gender",
                "display": "Geschlecht"
            },
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "http://hl7.org/fhir/administrative-gender",
                        "code": "female",
                        "display": "Weiblich"
                    }
                ]
            }
        },
        {
            "code": {
                "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
                "code": "gender",
                "display": "Geschlecht"
            },
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "http://hl7.org/fhir/administrative-gender",
                        "code": "male",
                        "display": "Männlich"
                    }
                ]
            }
        },
        {
            "code": {
                "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
                "code": "gender",
                "display": "Geschlecht"
            },
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "http://hl7.org/fhir/administrative-gender",
                        "code": "other",
                        "display": "Nichtbinäre Geschlechtsidentität"
                    }
                ]
            }
        }
    ],
    "effectivePeriod": {
        "start": "2022-12-05",
        "end": "2022-12-11"
    },
    "instance":  [
        {
            "extension":  [
                {
                    "url": "https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitHealthAppModuleLink",
                    "valueReference": {
                        "reference": "DeviceDefinition/3",
                        "display": "DiPA-Modul 1"
                    }
                }
            ]
        }
    ],
    "propertyGroup":  [
        {
            "priceComponent":  [
                {
                    "type": "informational",
                    "code": {
                        "coding":  [
                            {
                                "system": "https://fhir.bfarm.de/CodeSystem/HealthAppPriceCode",
                                "code": "compensation-amount",
                                "display": "Verhandelter Vergütungsbetrag"
                            }
                        ]
                    },
                    "amount": {
                        "value": 350,
                        "currency": "EUR"
                    }
                },
                {
                    "type": "informational",
                    "code": {
                        "coding":  [
                            {
                                "system": "https://fhir.bfarm.de/CodeSystem/HealthAppPriceCode",
                                "code": "additional-costs",
                                "display": "Mehrkosten (bei alleiniger Nutzung)"
                            }
                        ]
                    },
                    "amount": {
                        "value": 250,
                        "currency": "EUR"
                    }
                }
            ]
        }
    ]
}

XML

<ChargeItemDefinition xmlns="http://hl7.org/fhir">
    <id value="6" />
    <meta>
        <versionId value="2" />
        <lastUpdated value="2022-12-27T13:20:05.048+01:00" />
        <source value="#bfIUHiPaEqwTHITD" />
        <profile value="https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnit" />
    </meta>
    <url value="https://dipa.bfarm.de/de/verzeichnis/01964" />
    <identifier>
        <system value="https://fhir.bfarm.de/Identifier/DipaAeId" />
        <value value="00000 001" />
    </identifier>
    <title value="Healthy DiPA 001" />
    <status value="unknown" />
    <useContext>
        <code>
            <system value="http://terminology.hl7.org/CodeSystem/usage-context-type" />
            <code value="age" />
            <display value="Altersgruppe" />
        </code>
        <valueCodeableConcept>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="41847000" />
                <display value="Erwachsene(r) (18-65 Jahre)" />
            </coding>
        </valueCodeableConcept>
    </useContext>
    <useContext>
        <code>
            <system value="http://terminology.hl7.org/CodeSystem/usage-context-type" />
            <code value="age" />
            <display value="Altersgruppe" />
        </code>
        <valueCodeableConcept>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="271872005" />
                <display value="Erwachsene (&#228;lter als 65 Jahre)" />
            </coding>
        </valueCodeableConcept>
    </useContext>
    <useContext>
        <code>
            <system value="http://terminology.hl7.org/CodeSystem/usage-context-type" />
            <code value="focus" />
            <display value="Beeintr&#228;chtigung" />
        </code>
        <valueCodeableConcept>
            <coding>
                <system value="https://fhir.bfarm.de/Identifier/HealthAppFocusId" />
                <code value="125" />
                <display value="Haushaltsf&#252;hrung" />
            </coding>
        </valueCodeableConcept>
    </useContext>
    <useContext>
        <code>
            <system value="http://terminology.hl7.org/CodeSystem/usage-context-type" />
            <code value="focus" />
            <display value="Beeintr&#228;chtigung" />
        </code>
        <valueCodeableConcept>
            <extension url="https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitUseContextValueSeverity">
                <valueCoding>
                    <system value="https://fhir.bfarm.de/CodeSystem/HealthAppSeverity" />
                    <code value="severity-1" />
                    <display value="Punktbereich 1: Geringe Beeintr&#228;chtigungen der Selbst&#228;ndigkeit oder der F&#228;higkeiten." />
                </valueCoding>
            </extension>
            <extension url="https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitUseContextValueSeverity">
                <valueCoding>
                    <system value="https://fhir.bfarm.de/CodeSystem/HealthAppSeverity" />
                    <code value="severity-2" />
                    <display value="Punktbereich 2: Erhebliche Beeintr&#228;chtigungen der Selbst&#228;ndigkeit oder der F&#228;higkeiten." />
                </valueCoding>
            </extension>
            <coding>
                <system value="https://fhir.bfarm.de/Identifier/HealthAppFocusId" />
                <code value="119" />
                <display value="Mobilit&#228;t" />
            </coding>
        </valueCodeableConcept>
    </useContext>
    <useContext>
        <code>
            <system value="http://terminology.hl7.org/CodeSystem/usage-context-type" />
            <code value="gender" />
            <display value="Geschlecht" />
        </code>
        <valueCodeableConcept>
            <coding>
                <system value="http://hl7.org/fhir/administrative-gender" />
                <code value="female" />
                <display value="Weiblich" />
            </coding>
        </valueCodeableConcept>
    </useContext>
    <useContext>
        <code>
            <system value="http://terminology.hl7.org/CodeSystem/usage-context-type" />
            <code value="gender" />
            <display value="Geschlecht" />
        </code>
        <valueCodeableConcept>
            <coding>
                <system value="http://hl7.org/fhir/administrative-gender" />
                <code value="male" />
                <display value="M&#228;nnlich" />
            </coding>
        </valueCodeableConcept>
    </useContext>
    <useContext>
        <code>
            <system value="http://terminology.hl7.org/CodeSystem/usage-context-type" />
            <code value="gender" />
            <display value="Geschlecht" />
        </code>
        <valueCodeableConcept>
            <coding>
                <system value="http://hl7.org/fhir/administrative-gender" />
                <code value="other" />
                <display value="Nichtbin&#228;re Geschlechtsidentit&#228;t" />
            </coding>
        </valueCodeableConcept>
    </useContext>
    <effectivePeriod>
        <start value="2022-12-05" />
        <end value="2022-12-11" />
    </effectivePeriod>
    <instance>
        <extension url="https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitHealthAppModuleLink">
            <valueReference>
                <reference value="DeviceDefinition/3" />
                <display value="DiPA-Modul 1" />
            </valueReference>
        </extension>
    </instance>
    <propertyGroup>
        <priceComponent>
            <type value="informational" />
            <code>
                <coding>
                    <system value="https://fhir.bfarm.de/CodeSystem/HealthAppPriceCode" />
                    <code value="compensation-amount" />
                    <display value="Verhandelter Verg&#252;tungsbetrag" />
                </coding>
            </code>
            <amount>
                <value value="350" />
                <currency value="EUR" />
            </amount>
        </priceComponent>
        <priceComponent>
            <type value="informational" />
            <code>
                <coding>
                    <system value="https://fhir.bfarm.de/CodeSystem/HealthAppPriceCode" />
                    <code value="additional-costs" />
                    <display value="Mehrkosten (bei alleiniger Nutzung)" />
                </coding>
            </code>
            <amount>
                <value value="250" />
                <currency value="EUR" />
            </amount>
        </priceComponent>
    </propertyGroup>
</ChargeItemDefinition>


DeviceDefinition

Über die FHIR®-Ressource DeviceDefinition werden Informationen sowohl zu einzelnen DiPA also auch zu deren zugehörigen DiPA-Modulen ausgegeben.

GET https://dipa.bfarm.de/api/fhir/v2.0/DeviceDefinition


Informationen zu einer bestimmten DiPA

Hinweis: Die intern verwendeten IDs dürfen nicht extern gespeichert werden, da diese sich bei neuen Releases der API ändern. Als eindeutiger Identifier einer DiPA gilt allein die DiPA-ID welche in der identifier-Eigenschaft ausgelesen werden kann.

GET https://dipa.bfarm.de/api/fhir/v2.0/DeviceDefinition/1

gibt die Daten zur DiPA mit der internen ID 1 aus (DiPA-ID ist 01964).

https://dipa.bfarm.de/api/fhir/v2.0/DeviceDefinition?identifier=https://fhir.bfarm.de/Identifier/DipaId|01964

gibt die Daten zur DiPA mit der DiPA-ID 01964 aus.

JSON

{
    "resourceType": "DeviceDefinition",
    "id": "1",
    "meta": {
        "versionId": "2",
        "lastUpdated": "2022-12-27T07:23:41.269+01:00",
        "source": "#3FooIIDZ70KpfG4I",
        "profile":  [
            "https://fhir.bfarm.de/StructureDefinition/HealthApp"
        ]
    },
    "extension":  [
        {
            "url": "https://fhir.bfarm.de/StructureDefinition/HealthAppMedia",
            "extension":  [
                {
                    "url": "icon",
                    "valueAttachment": {
                        "url": "https://dipa.bfarm.de/images/testsystem-dipa-2268.png"
                    }
                }
            ]
        },
        {
            "url": "https://fhir.bfarm.de/StructureDefinition/HealthAppSummaries",
            "extension":  [
                {
                    "url": "bewertungsentscheidung",
                    "valueString": "Auf Basis der vom Hersteller im Antragsverfahren vorgelegten Angaben und Nachweise bewertet das BfArM die Anforderungen an\n• Sicherheit und Funktionstauglichkeit des Medizinproduktes\n• Datenschutz und Datensicherheit nach dem Stand der Technik\n• die Qualität des Medizinproduktes, einschließlich Interoperabilität \nentsprechend den Vorgaben der Digitale Pflegeanwendungs-Verordnung (DiPAV) als erfüllt.\n\nLaut Hersteller findet die die Datenverarbeitung im Zusammenhang mit der Nutzung von Healthy DiPA in Deutschland statt."
                },
                {
                    "url": "steckbrief",
                    "valueString": "Healthy DiPA ist eine Digitale Pflegeanwendung um Beeinträchtigungen der Selbständigkeit oder der Fähigkeiten der Pflegebedürftigen oder des Pflegebedürftigen zu mindern oder einer Verschlimmerung der Pflegebedürftigkeit entgegenzuwirken. Basierend auf persönlichen Angaben des Anwenders zu Pflegestufe- und Belastungsempfinden, wird der Hilfestellungen im Verlauf der Therapie kontinuierlich an die individuellen Bedürfnisse des Nutzers angepasst. Daten zu Schmerz und Funktionseinschränkungen werden innerhalb der Anwendung regelmäßig erfasst und für die Patienten und deren behandelnde Ärzte graphisch aufbereitet. Die Anwendungsdauer beträgt 90 Tage."
                },
                {
                    "url": "steckbriefKurz",
                    "valueString": "Healthy DiPA ist eine Digitale Pflegeanwendung um Beeinträchtigungen der Selbständigkeit oder der Fähigkeiten der Pflegebedürftigten zu mindern oder einer Verschlimmerung zu verhindern."
                }
            ]
        }
    ],
    "identifier":  [
        {
            "system": "https://fhir.bfarm.de/Identifier/DipaId",
            "value": "01964"
        },
        {
            "system": "https://fhir.bfarm.de/Identifier/HealthAppId",
            "value": "1964"
        }
    ],
    "manufacturerReference": {
        "reference": "Organization/2",
        "display": "krautsalad GmbH"
    },
    "deviceName":  [
        {
            "name": "Healthy DiPA von krautsalad",
            "type": "user-friendly-name"
        }
    ]
}

XML

<DeviceDefinition xmlns="http://hl7.org/fhir">
    <id value="1" />
    <meta>
        <versionId value="2" />
        <lastUpdated value="2022-12-27T07:23:41.269+01:00" />
        <source value="#3FooIIDZ70KpfG4I" />
        <profile value="https://fhir.bfarm.de/StructureDefinition/HealthApp" />
    </meta>
    <extension url="https://fhir.bfarm.de/StructureDefinition/HealthAppMedia">
        <extension url="icon">
            <valueAttachment>
                <url value="https://dipa.bfarm.de/images/testsystem-dipa-2268.png" />
            </valueAttachment>
        </extension>
    </extension>
    <extension url="https://fhir.bfarm.de/StructureDefinition/HealthAppSummaries">
        <extension url="bewertungsentscheidung">
            <valueString value="Auf Basis der vom Hersteller im Antragsverfahren vorgelegten Angaben und Nachweise bewertet das BfArM die Anforderungen an\n• Sicherheit und Funktionstauglichkeit des Medizinproduktes\n• Datenschutz und Datensicherheit nach dem Stand der Technik\n• die Qualit&#228;t des Medizinproduktes, einschlie&#223;lich Interoperabilit&#228;t \nentsprechend den Vorgaben der Digitale Pflegeanwendungs-Verordnung (DiPAV) als erf&#252;llt.\n\nLaut Hersteller findet die die Datenverarbeitung im Zusammenhang mit der Nutzung von Healthy DiPA in Deutschland statt." />
        </extension>
        <extension url="steckbrief">
            <valueString value="Healthy DiPA ist eine Digitale Pflegeanwendung um Beeintr&#228;chtigungen der Selbst&#228;ndigkeit oder der F&#228;higkeiten der Pflegebed&#252;rftigen oder des Pflegebed&#252;rftigen zu mindern oder einer Verschlimmerung der Pflegebed&#252;rftigkeit entgegenzuwirken. Basierend auf pers&#246;nlichen Angaben des Anwenders zu Pflegestufe- und Belastungsempfinden, wird der Hilfestellungen im Verlauf der Therapie kontinuierlich an die individuellen Bed&#252;rfnisse des Nutzers angepasst. Daten zu Schmerz und Funktionseinschr&#228;nkungen werden innerhalb der Anwendung regelm&#228;&#223;ig erfasst und f&#252;r die Patienten und deren behandelnde &#196;rzte graphisch aufbereitet. Die Anwendungsdauer betr&#228;gt 90 Tage." />
        </extension>
        <extension url="steckbriefKurz">
            <valueString value="Healthy DiPA ist eine Digitale Pflegeanwendung um Beeintr&#228;chtigungen der Selbst&#228;ndigkeit oder der F&#228;higkeiten der Pflegebed&#252;rftigten zu mindern oder einer Verschlimmerung zu verhindern." />
        </extension>
    </extension>
    <identifier>
        <system value="https://fhir.bfarm.de/Identifier/DipaId" />
        <value value="01964" />
    </identifier>
    <identifier>
        <system value="https://fhir.bfarm.de/Identifier/HealthAppId" />
        <value value="1964" />
    </identifier>
    <manufacturerReference>
        <reference value="Organization/2" />
        <display value="krautsalad GmbH" />
    </manufacturerReference>
    <deviceName>
        <name value="Healthy DiPA von krautsalad" />
        <type value="user-friendly-name" />
    </deviceName>
</DeviceDefinition>

Hinweis: Je nach verwendeter Software ist eine URL-Kodierung der Parameter notwendig: DipaId%7C01964.


Informationen zu einem der DiPA zugehörigen DiPA-Modul

GET https://dipa.bfarm.de/api/fhir/v2.0/DeviceDefinition/3

gibt die Daten zum der DiPA zugehörigen DiPA-Modul mit der internen ID 3 aus.

JSON

{
    "resourceType": "DeviceDefinition",
    "id": "3",
    "meta": {
        "versionId": "1",
        "lastUpdated": "2022-12-27T07:23:41.732+01:00",
        "source": "#7WiwZ2KRceCnOqBV",
        "profile":  [
            "https://fhir.bfarm.de/StructureDefinition/HealthAppModule"
        ]
    },
    "extension":  [
        {
            "url": "https://fhir.bfarm.de/StructureDefinition/HealthAppModuleHardware",
            "extension":  [
                {
                    "url": "included",
                    "valueBoolean": false
                },
                {
                    "url": "optional",
                    "valueBoolean": false
                },
                {
                    "url": "required",
                    "valueBoolean": false
                }
            ]
        },
        {
            "url": "https://fhir.bfarm.de/StructureDefinition/HealthAppModuleMedicalDevice",
            "extension":  [
                {
                    "url": "intendedPurpose",
                    "valueString": "Ziel der Healthy DiPA ist es Beeinträchtigungen der Selbständigkeit oder der Fähigkeiten der Pflegebedürftigten zu mindern oder einer Verschlimmerung der Pflegebedürftigkeit entgegenzuwirken. Basierend auf persönlichen Angaben des Anwenders zu Pflegestufe- und Belastungsempfinden, wird der Hilfestellungen im Verlauf der Therapie kontinuierlich an die individuellen Bedürfnisse des Nutzers angepasst. Daten zu Schmerz und Funktionseinschränkungen werden innerhalb der Anwendung regelmäßig erfasst und für die Patienten und deren behandelnde Ärzte graphisch aufbereitet."
                },
                {
                    "url": "isMedicalDevice",
                    "valueBoolean": true
                },
                {
                    "url": "notifiedBody",
                    "extension":  [
                        {
                            "url": "code",
                            "valueString": "0000"
                        },
                        {
                            "url": "name",
                            "valueString": "Test Zertifikatstelle"
                        }
                    ]
                },
                {
                    "url": "nursingBenefit",
                    "valueString": "Healthy DiPA hilft bei der Verminderung von Beeinträchtigungen der Selbständigkeit oder der Fähigkeiten von Pflegebedürftigten."
                },
                {
                    "url": "regulatoryBasis",
                    "valueCode": "mdr"
                },
                {
                    "url": "riskClass",
                    "valueCode": "1"
                }
            ]
        }
    ],
    "deviceName":  [
        {
            "name": "DiPA-Modul 1",
            "type": "model-name"
        }
    ],
    "specialization":  [
        {
            "extension":  [
                {
                    "url": "https://fhir.bfarm.de/StructureDefinition/HealthAppModuleSpecializationCompatibility",
                    "extension":  [
                        {
                            "url": "hardware",
                            "valueString": "Zur Nutzung werden ein Internetfähiges Endgerät, ein Internetzugang sowie ein aktueller Browser benötigt (Chrome, Edge, Mozilla, Safari)."
                        },
                        {
                            "url": "software",
                            "valueString": "Zur Nutzung werden ein Internetfähiges Endgerät, ein Internetzugang sowie ein aktueller Browser benötigt (Chrome, Edge, Mozilla, Safari)."
                        }
                    ]
                },
                {
                    "url": "https://fhir.bfarm.de/StructureDefinition/HealthAppModuleSpecializationUrl",
                    "valueUri": "https://krautsalad.com"
                }
            ],
            "systemType": "web-app",
            "version": "00000"
        }
    ],
    "languageCode":  [
        {
            "coding":  [
                {
                    "system": "urn:ietf:bcp:47",
                    "code": "de",
                    "display": "Deutsch"
                }
            ]
        },
        {
            "coding":  [
                {
                    "system": "urn:ietf:bcp:47",
                    "code": "en",
                    "display": "Englisch"
                }
            ]
        }
    ],
    "parentDevice": {
        "reference": "DeviceDefinition/1",
        "display": "Healthy DiPA von krautsalad"
    }
}

XML

<DeviceDefinition xmlns="http://hl7.org/fhir">
    <id value="3" />
    <meta>
        <versionId value="1" />
        <lastUpdated value="2022-12-27T07:23:41.732+01:00" />
        <source value="#7WiwZ2KRceCnOqBV" />
        <profile value="https://fhir.bfarm.de/StructureDefinition/HealthAppModule" />
    </meta>
    <extension url="https://fhir.bfarm.de/StructureDefinition/HealthAppModuleHardware">
        <extension url="included">
            <valueBoolean value="false" />
        </extension>
        <extension url="optional">
            <valueBoolean value="false" />
        </extension>
        <extension url="required">
            <valueBoolean value="false" />
        </extension>
    </extension>
    <extension url="https://fhir.bfarm.de/StructureDefinition/HealthAppModuleMedicalDevice">
        <extension url="intendedPurpose">
            <valueString value="Ziel der Healthy DiPA ist es Beeintr&#228;chtigungen der Selbst&#228;ndigkeit oder der F&#228;higkeiten der Pflegebed&#252;rftigten zu mindern oder einer Verschlimmerung der Pflegebed&#252;rftigkeit entgegenzuwirken. Basierend auf pers&#246;nlichen Angaben des Anwenders zu Pflegestufe- und Belastungsempfinden, wird der Hilfestellungen im Verlauf der Therapie kontinuierlich an die individuellen Bed&#252;rfnisse des Nutzers angepasst. Daten zu Schmerz und Funktionseinschr&#228;nkungen werden innerhalb der Anwendung regelm&#228;&#223;ig erfasst und f&#252;r die Patienten und deren behandelnde &#196;rzte graphisch aufbereitet." />
        </extension>
        <extension url="isMedicalDevice">
            <valueBoolean value="true" />
        </extension>
        <extension url="notifiedBody">
            <extension url="code">
                <valueString value="0000" />
            </extension>
            <extension url="name">
                <valueString value="Test Zertifikatstelle" />
            </extension>
        </extension>
        <extension url="nursingBenefit">
            <valueString value="Healthy DiPA hilft bei der Verminderung von Beeintr&#228;chtigungen der Selbst&#228;ndigkeit oder der F&#228;higkeiten von Pflegebed&#252;rftigten." />
        </extension>
        <extension url="regulatoryBasis">
            <valueCode value="mdr" />
        </extension>
        <extension url="riskClass">
            <valueCode value="1" />
        </extension>
    </extension>
    <deviceName>
        <name value="DiPA-Modul 1" />
        <type value="model-name" />
    </deviceName>
    <specialization>
        <extension url="https://fhir.bfarm.de/StructureDefinition/HealthAppModuleSpecializationCompatibility">
            <extension url="hardware">
                <valueString value="Zur Nutzung werden ein Internetf&#228;higes Endger&#228;t, ein Internetzugang sowie ein aktueller Browser ben&#246;tigt (Chrome, Edge, Mozilla, Safari)." />
            </extension>
            <extension url="software">
                <valueString value="Zur Nutzung werden ein Internetf&#228;higes Endger&#228;t, ein Internetzugang sowie ein aktueller Browser ben&#246;tigt (Chrome, Edge, Mozilla, Safari)." />
            </extension>
        </extension>
        <extension url="https://fhir.bfarm.de/StructureDefinition/HealthAppModuleSpecializationUrl">
            <valueUri value="https://krautsalad.com" />
        </extension>
        <systemType value="web-app" />
        <version value="00000" />
    </specialization>
    <languageCode>
        <coding>
            <system value="urn:ietf:bcp:47" />
            <code value="de" />
            <display value="Deutsch" />
        </coding>
    </languageCode>
    <languageCode>
        <coding>
            <system value="urn:ietf:bcp:47" />
            <code value="en" />
            <display value="Englisch" />
        </coding>
    </languageCode>
    <parentDevice>
        <reference value="DeviceDefinition/1" />
        <display value="Healthy DiPA von krautsalad" />
    </parentDevice>
</DeviceDefinition>

Die Beispieldaten entsprechen denen eines DiPA-Moduls, welches auf die zugehörige DiPA referenziert (parentDevice, im Beispiel lautet die Referenz DeviceDefinition/1).


Organization

Über die FHIR®-Ressource Organization werden Informationen zu einzelnen DiPA-Herstellern ausgegeben.

GET https://dipa.bfarm.de/api/fhir/v2.0/Organization


Informationen zu einem bestimmten DiPA-Hersteller

Hinweis: Die intern verwendeten IDs dürfen nicht extern gespeichert werden, da diese sich bei neuen Releases der API ändern.

GET https://dipa.bfarm.de/api/fhir/v2.0/Organization/2

gibt die Daten zum DiPA-Hersteller mit der internen ID 2 aus.

JSON

Command 'json' could not render: File was not found for bfarm/Example-DiPA-HealthAppManufacturer

XML

Command 'xml' could not render: File was not found for bfarm/Example-DiPA-HealthAppManufacturer


Questionnaire

Über die FHIR®-Ressource Questionnaire werden Fragenkataloge repräsentiert welche im Zuge eines Antrags auf Aufnahme ins DiPA-Verzeichnis vom Hersteller der DiPA beantwortet werden.

GET https://dipa.bfarm.de/api/fhir/v2.0/Questionnaire


Informationen zu einem bestimmten Fragenkatalog

Hinweis: Die intern verwendeten IDs dürfen nicht extern gespeichert werden, da diese sich bei neuen Releases der API ändern.

GET https://dipa.bfarm.de/api/fhir/v2.0/Questionnaire/11

gibt die Daten zum Fragenkatalog mit der internen ID 11 aus.

JSON

Command 'json' could not render: File was not found for bfarm/Example-DiPA-HealthAppQuestionnaire

XML

Command 'xml' could not render: File was not found for bfarm/Example-DiPA-HealthAppQuestionnaire


QuestionnaireResponse

Über die FHIR®-Ressource QuestionnaireResponse werden die vom Hersteller gegebenen Antworten für einen bestimmten Fragenkatalog repräsentiert.

GET https://dipa.bfarm.de/api/fhir/v2.0/QuestionnaireResponse


Informationen zu einem bestimmten Antwortdatensatz

Hinweis: Die intern verwendeten IDs dürfen nicht extern gespeichert werden, da diese sich bei neuen Releases der API ändern.

GET https://dipa.bfarm.de/api/fhir/v2.0/QuestionnaireResponse/12

gibt die Daten zum Antwortdatensatz mit der internen ID 12 aus.

JSON

Command 'json' could not render: File was not found for bfarm/Example-DiPA-HealthAppQuestionnaireResponse

XML

Command 'xml' could not render: File was not found for bfarm/Example-DiPA-HealthAppQuestionnaireResponse