Query API: Anforderungen

Diese Seite beschreibt Standard-API-Zugriffe für eine clientseitige Suche und Bereitstellung von Daten des Medication Service. Im Detail bedeutet dies das Navigieren in Suchergebnisseiten, die kompakte Suche mit verknüpften FHIR-Ressourcen als auch die Suche unter Nutzung von Vergleichsoperatoren.

Paginierungsfunktion (Pagination)

Der Medication Service stellt dem ePA-Client in seiner Antwort Navigationsinformationen in Ergebnisseiten zur Verfügung.

URL-Parameter

Um die Paginierungsfunktion zu implementieren, werden die URL-Parameter _count und _offset verwendet. Der Parameter _count bestimmt die Anzahl der Einträge pro Seite, während _offset das Startelement der Seite angibt. Zusätzlich entscheidet der_total-Parameter, ob die Gesamtanzahl der Einträge in der Antwort enthalten sein soll.

URL-Parameter	Beschreibung	Standardwert
`_count`	Der ePA-Client kann die maximale Anzahl von Elementen festlegen, die auf einer "Seite" (page) der Antwort enthalten sein soll. Das bedeutet, dass der Medication Service die Ergebnismenge auf diese maximal angegebene Anzahl beschränkt.	25
`_offset`	Dieser Parameter gibt den (zero-based) Offset des ersten zurückgegebenen Elements in der Sammlung an.	0
`_total`	Dieser Parameter steuert, ob und wie der Medication Service die Gesamtanzahl der Suchergebnisse zurückgibt. Folgende Werte können eingestellt werden: `none`, `estimate`, `accurate`.

Werte für _total:

none (Standardwert): Die Gesamtanzahl der Suchtreffer wird nicht angezeigt.
estimate: Die ungefähre Gesamtanzahl der Suchtreffer wird angezeigt.
accurate: Die genaue Gesamtanzahl der Suchtreffer wird angezeigt.

Beispiele

API-Anfrage von zehn Elementen des Ressourcentyps Medication, beginnend mit Element 20 der Liste:

GET [base]/epa/medication/api/v1/fhir/Medication?_count=10&_offset=20

API-Anfrage der ersten fünf Elemente:

GET [base]/epa/medication/api/v1/fhir/Medication?_count=5

API-Anfrage nur für die Gesamtanzahl der Einträge:

GET [base]/epa/medication/api/v1/fhir/Medication?_count=0&_total=accurate

Links zur Seitennavigation

In einem FHIR Search Set Bundle enthält das Attribut link eine Liste von Link-Elementen, die jeweils einem spezifischen Navigationszweck innerhalb des Bundles dienen. Die folgenden Beziehungen werden gemäß den Link Relation Types bereitgestellt.

Attribut	Beschreibung	Anforderung
`self`	Ein Link zur aktuellen Seite der Ergebnisse, der die Abfrage repräsentiert, die diese Ergebnisse generiert hat.	MUSS
`next`	Wird verwendet, um zur nächsten Seite der Ergebnisse zu navigieren, entsprechend der festgelegten Paginierung.	MUSS
`previous`	Ermöglicht die Rückkehr zur vorherigen Ergebnismenge und erleichtert die rückwärtige Navigation durch die Seiten.	MUSS
`first`	Navigiert zur ersten Seite der Suchergebnisse und ermöglicht eine schnelle Navigation zum Anfang der Ergebnisliste.	KANN
`last`	Navigiert zur letzten Seite der Suchergebnisse, um ans Ende der Ergebnisliste zu gelangen.	KANN

Jeder Link enthält eine URL, um das entsprechende Ergebnis-Set abzurufen, das dynamisch basierend auf der Suchanfrage und den Paginierungsparametern wie _count und _offset generiert wird. Diese Links vereinfachen die Navigation des ePA-Clients durch große Suchergebnisse, indem sie die Notwendigkeit manueller Anpassungen der Abfrageparameter eliminieren.

Zu jedem Link können zusätzlich zu den Standardpaginierungsparametern wie _count und _offset auch andere Parameter enthalten sein, die die Paginierung innerhalb des Medication Service erleichtern. Ein Beispiel hierfür ist der Parameter stateid, der den aktuellen Zustand der Ergebnisliste repräsentiert. Dies ermöglicht es dem Medication Service, die Navigation durch die Ergebnisse effizient zu verwalten, indem der Kontext oder Zustand der Suche erhalten bleibt. Dies ist besonders nützlich, wenn ePA-Clients durch umfangreiche oder komplex strukturierte Ergebnismengen navigieren.

{
    "resourceType": "Bundle",
    "id": "example-searchset-medication",
    "type": "searchset",
    "total": 100,
    "link":  [
        {
            "relation": "self",
            "url": "/epa/medication/api/v1/fhir/Medication?_offset=20&_count=10"
        },
        {
            "relation": "previous",
            "url": "/epa/medication/api/v1/fhir/Medication?_offset=10&_count=10"
        },
        {
            "relation": "next",
            "url": "/epa/medication/api/v1/fhir/Medication?_offset=30&_count=10"
        }
    ],
    "entry":  [
        {
            "fullUrl": "https://epa-as-0.prod.epa4all.de/vau-cid-1234/epa/medication/api/v1/fhir/Medication/2571d29b-e213-40ec-b817-a1490718a490",
            "resource": {
                "resourceType": "Medication",
                "id": "2571d29b-e213-40ec-b817-a1490718a490",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2025-01-22T14:43:33.244Z",
                    "profile":  [
                        "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication"
                    ]
                },
                "extension":  [
                    {
                        "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension",
                        "valueCoding": {
                            "code": "781405001",
                            "system": "http://snomed.info/sct",
                            "version": "http://snomed.info/sct/11000274103/version/20240515",
                            "display": "Medicinal product package (product)"
                        }
                    },
                    {
                        "valueIdentifier": {
                            "system": "https://gematik.de/fhir/epa-medication/sid/rx-prescription-process-identifier",
                            "value": "160.153.303.257.459_20250122"
                        },
                        "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension"
                    }
                ],
                "identifier":  [
                    {
                        "system": "https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier",
                        "value": "A632B2AB4232C9787E0731E3824942350070FB492EB1005A4AFA00F4BACD8AA1"
                    },
                    {
                        "system": "https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier",
                        "value": "dc810e53-c26b-47bc-8c78-c7f79ea5f7ae_160.153.303.257.459"
                    }
                ],
                "status": "active",
                "code": {
                    "coding":  [
                        {
                            "system": "http://fhir.de/CodeSystem/ask",
                            "code": "5682",
                            "display": "Ibuprofen"
                        }
                    ]
                }
            },
            "search": {
                "mode": "match"
            }
        },
        {
            "fullUrl": "https://epa-as-0.prod.epa4all.de/vau-cid-1234/epa/medication/api/v1/fhir/Medication/3b990824-3814-4d75-80b1-e2935827f8f0",
            "resource": {
                "resourceType": "Medication",
                "id": "3b990824-3814-4d75-80b1-e2935827f8f0",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2025-01-22T14:43:33.244Z",
                    "profile":  [
                        "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication"
                    ]
                },
                "extension":  [
                    {
                        "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension",
                        "valueCoding": {
                            "code": "781405001",
                            "system": "http://snomed.info/sct",
                            "version": "http://snomed.info/sct/11000274103/version/20240515",
                            "display": "Medicinal product package (product)"
                        }
                    },
                    {
                        "valueIdentifier": {
                            "system": "https://gematik.de/fhir/epa-medication/sid/rx-prescription-process-identifier",
                            "value": "160.153.303.257.459_20250122"
                        },
                        "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension"
                    }
                ],
                "identifier":  [
                    {
                        "system": "https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier",
                        "value": "E5A0DE886C10E6A7C044D39204A23FE945CFA4C93C694837F43A2C9DE7C858DF"
                    },
                    {
                        "system": "https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier",
                        "value": "ec4d55a0-dec1-46b7-96cc-096845b74c4b_160.153.303.257.459"
                    }
                ],
                "code": {
                    "text": "Infusion bestehend aus 85mg Doxorubicin aufgeloest zur Verabreichung in 250ml 5-%iger (50 mg/ml) Glucose-Infusionsloesung"
                },
                "status": "active",
                "form": {
                    "coding":  [
                        {
                            "system": "http://standardterms.edqm.eu",
                            "code": "11210000",
                            "display": "Solution for infusion"
                        }
                    ]
                },
                "ingredient":  [
                    {
                        "itemCodeableConcept": {
                            "coding":  [
                                {
                                    "system": "http://fhir.de/CodeSystem/bfarm/atc",
                                    "code": "L01DB01",
                                    "display": "Doxorubicin"
                                }
                            ]
                        },
                        "isActive": true,
                        "strength": {
                            "numerator": {
                                "value": 85,
                                "unit": "mg",
                                "system": "http://unitsofmeasure.org",
                                "code": "mg"
                            },
                            "denominator": {
                                "value": 250,
                                "unit": "Milliliter",
                                "system": "http://unitsofmeasure.org",
                                "code": "mL"
                            }
                        }
                    }
                ]
            },
            "search": {
                "mode": "match"
            }
        },
        {
            "fullUrl": "https://epa-as-0.prod.epa4all.de/vau-cid-1234/epa/medication/api/v1/fhir/Medication/4bfef107-7d81-4d36-8aa0-7ea937969046",
            "resource": {
                "resourceType": "Medication",
                "id": "4bfef107-7d81-4d36-8aa0-7ea937969046",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2025-01-22T14:43:33.244Z",
                    "profile":  [
                        "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication"
                    ]
                },
                "extension":  [
                    {
                        "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension",
                        "valueCoding": {
                            "code": "781405001",
                            "system": "http://snomed.info/sct",
                            "version": "http://snomed.info/sct/11000274103/version/20240515",
                            "display": "Medicinal product package (product)"
                        }
                    },
                    {
                        "valueIdentifier": {
                            "system": "https://gematik.de/fhir/epa-medication/sid/rx-prescription-process-identifier",
                            "value": "160.153.303.257.459_20250122"
                        },
                        "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension"
                    },
                    {
                        "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension",
                        "valueCoding": {
                            "system": "https://gematik.de/fhir/terminology/CodeSystem/epa-drug-category-cs",
                            "code": "00"
                        }
                    }
                ],
                "identifier":  [
                    {
                        "system": "https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier",
                        "value": "5FD46319BA6C5C0D7626CFB709AF564362667A70D4A261E0F8EE57D9D837F394"
                    },
                    {
                        "system": "https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier",
                        "value": "358f35e5-2e32-46bb-b565-c373ecfb6230_160.153.303.257.459"
                    }
                ],
                "code": {
                    "text": "250ml 5-%iger (50 mg/ml) Glucose-Infusionsloesung"
                },
                "status": "active"
            },
            "search": {
                "mode": "match"
            }
        },
        {
            "fullUrl": "https://epa-as-0.prod.epa4all.de/vau-cid-1234/epa/medication/api/v1/fhir/Medication/4f9ab221-0eef-4e46-a8a9-38302e0488b1",
            "resource": {
                "resourceType": "Medication",
                "id": "4f9ab221-0eef-4e46-a8a9-38302e0488b1",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2025-01-22T14:43:33.244Z",
                    "profile":  [
                        "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication"
                    ]
                },
                "extension":  [
                    {
                        "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension",
                        "valueCoding": {
                            "code": "781405001",
                            "system": "http://snomed.info/sct",
                            "version": "http://snomed.info/sct/11000274103/version/20240515",
                            "display": "Medicinal product package (product)"
                        }
                    },
                    {
                        "valueIdentifier": {
                            "system": "https://gematik.de/fhir/epa-medication/sid/rx-prescription-process-identifier",
                            "value": "160.153.303.257.459_20250122"
                        },
                        "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension"
                    },
                    {
                        "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension",
                        "valueCoding": {
                            "system": "https://gematik.de/fhir/terminology/CodeSystem/epa-drug-category-cs",
                            "code": "00"
                        }
                    },
                    {
                        "url": "http://fhir.de/StructureDefinition/normgroesse",
                        "valueCode": "N3"
                    }
                ],
                "identifier":  [
                    {
                        "system": "https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier",
                        "value": "B849184C973EA5FA7D9751E6FAA6AFCFFD100183596239F84DD2C0DB4C751D67"
                    },
                    {
                        "system": "https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier",
                        "value": "c7f34f27-7564-43ad-b13f-2be3c5d7fd3d_160.153.303.257.459"
                    }
                ],
                "code": {
                    "coding":  [
                        {
                            "system": "http://fhir.de/CodeSystem/ifa/pzn",
                            "code": "10019621",
                            "display": "IBU-ratiopharm 400mg akut Schmerztabletten"
                        },
                        {
                            "system": "http://fhir.de/CodeSystem/bfarm/atc",
                            "code": "M01AE01",
                            "display": "Ibuprofen",
                            "version": "2022"
                        }
                    ]
                },
                "form": {
                    "coding":  [
                        {
                            "system": "https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM",
                            "code": "TAB",
                            "display": "Tabletten",
                            "version": "1.10"
                        },
                        {
                            "system": "http://standardterms.edqm.eu",
                            "code": "12200",
                            "display": "Tablet"
                        },
                        {
                            "system": "http://snomed.info/sct",
                            "code": "385055001",
                            "version": "http://snomed.info/sct/11000274103/version/20240515",
                            "display": "Tablet (basic dose form)"
                        }
                    ]
                },
                "status": "active",
                "amount": {
                    "numerator": {
                        "value": 50,
                        "code": "{Tablet}",
                        "system": "http://unitsofmeasure.org",
                        "unit": "Tablet"
                    },
                    "denominator": {
                        "value": 1,
                        "code": "{Package}",
                        "system": "http://unitsofmeasure.org",
                        "unit": "Package"
                    }
                },
                "ingredient":  [
                    {
                        "itemCodeableConcept": {
                            "coding":  [
                                {
                                    "code": "387207008",
                                    "system": "http://snomed.info/sct",
                                    "version": "http://snomed.info/sct/11000274103/version/20240515",
                                    "display": "Ibuprofen (substance)"
                                }
                            ]
                        },
                        "strength": {
                            "numerator": {
                                "value": 400,
                                "code": "mg",
                                "system": "http://unitsofmeasure.org",
                                "unit": "MilliGram"
                            },
                            "denominator": {
                                "value": 1,
                                "code": "{Tablet}",
                                "system": "http://unitsofmeasure.org",
                                "unit": "Tablet"
                            }
                        }
                    }
                ]
            },
            "search": {
                "mode": "match"
            }
        }
    ]
}

<Bundle xmlns="http://hl7.org/fhir">
    <id value="example-searchset-medication" />
    <type value="searchset" />
    <total value="100" />
    <link>
        <relation value="self" />
        <url value="/epa/medication/api/v1/fhir/Medication?_offset=20&amp;_count=10" />
    </link>
    <link>
        <relation value="previous" />
        <url value="/epa/medication/api/v1/fhir/Medication?_offset=10&amp;_count=10" />
    </link>
    <link>
        <relation value="next" />
        <url value="/epa/medication/api/v1/fhir/Medication?_offset=30&amp;_count=10" />
    </link>
    <entry>
        <fullUrl value="https://epa-as-0.prod.epa4all.de/vau-cid-1234/epa/medication/api/v1/fhir/Medication/2571d29b-e213-40ec-b817-a1490718a490" />
        <resource>
            <Medication>
                <id value="2571d29b-e213-40ec-b817-a1490718a490" />
                <meta>
                    <versionId value="1" />
                    <lastUpdated value="2025-01-22T14:43:33.244Z" />
                    <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication" />
                </meta>
                <extension url="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension">
                    <valueCoding>
                        <system value="http://snomed.info/sct" />
                        <version value="http://snomed.info/sct/11000274103/version/20240515" />
                        <code value="781405001" />
                        <display value="Medicinal product package (product)" />
                    </valueCoding>
                </extension>
                <extension url="https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension">
                    <valueIdentifier>
                        <system value="https://gematik.de/fhir/epa-medication/sid/rx-prescription-process-identifier" />
                        <value value="160.153.303.257.459_20250122" />
                    </valueIdentifier>
                </extension>
                <identifier>
                    <system value="https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier" />
                    <value value="A632B2AB4232C9787E0731E3824942350070FB492EB1005A4AFA00F4BACD8AA1" />
                </identifier>
                <identifier>
                    <system value="https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier" />
                    <value value="dc810e53-c26b-47bc-8c78-c7f79ea5f7ae_160.153.303.257.459" />
                </identifier>
                <code>
                    <coding>
                        <system value="http://fhir.de/CodeSystem/ask" />
                        <code value="5682" />
                        <display value="Ibuprofen" />
                    </coding>
                </code>
                <status value="active" />
            </Medication>
        </resource>
        <search>
            <mode value="match" />
        </search>
    </entry>
    <entry>
        <fullUrl value="https://epa-as-0.prod.epa4all.de/vau-cid-1234/epa/medication/api/v1/fhir/Medication/3b990824-3814-4d75-80b1-e2935827f8f0" />
        <resource>
            <Medication>
                <id value="3b990824-3814-4d75-80b1-e2935827f8f0" />
                <meta>
                    <versionId value="1" />
                    <lastUpdated value="2025-01-22T14:43:33.244Z" />
                    <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication" />
                </meta>
                <extension url="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension">
                    <valueCoding>
                        <system value="http://snomed.info/sct" />
                        <version value="http://snomed.info/sct/11000274103/version/20240515" />
                        <code value="781405001" />
                        <display value="Medicinal product package (product)" />
                    </valueCoding>
                </extension>
                <extension url="https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension">
                    <valueIdentifier>
                        <system value="https://gematik.de/fhir/epa-medication/sid/rx-prescription-process-identifier" />
                        <value value="160.153.303.257.459_20250122" />
                    </valueIdentifier>
                </extension>
                <identifier>
                    <system value="https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier" />
                    <value value="E5A0DE886C10E6A7C044D39204A23FE945CFA4C93C694837F43A2C9DE7C858DF" />
                </identifier>
                <identifier>
                    <system value="https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier" />
                    <value value="ec4d55a0-dec1-46b7-96cc-096845b74c4b_160.153.303.257.459" />
                </identifier>
                <code>
                    <text value="Infusion bestehend aus 85mg Doxorubicin aufgeloest zur Verabreichung in 250ml 5-%iger (50 mg/ml) Glucose-Infusionsloesung" />
                </code>
                <status value="active" />
                <form>
                    <coding>
                        <system value="http://standardterms.edqm.eu" />
                        <code value="11210000" />
                        <display value="Solution for infusion" />
                    </coding>
                </form>
                <ingredient>
                    <itemCodeableConcept>
                        <coding>
                            <system value="http://fhir.de/CodeSystem/bfarm/atc" />
                            <code value="L01DB01" />
                            <display value="Doxorubicin" />
                        </coding>
                    </itemCodeableConcept>
                    <isActive value="true" />
                    <strength>
                        <numerator>
                            <value value="85" />
                            <unit value="mg" />
                            <system value="http://unitsofmeasure.org" />
                            <code value="mg" />
                        </numerator>
                        <denominator>
                            <value value="250" />
                            <unit value="Milliliter" />
                            <system value="http://unitsofmeasure.org" />
                            <code value="mL" />
                        </denominator>
                    </strength>
                </ingredient>
            </Medication>
        </resource>
        <search>
            <mode value="match" />
        </search>
    </entry>
    <entry>
        <fullUrl value="https://epa-as-0.prod.epa4all.de/vau-cid-1234/epa/medication/api/v1/fhir/Medication/4bfef107-7d81-4d36-8aa0-7ea937969046" />
        <resource>
            <Medication>
                <id value="4bfef107-7d81-4d36-8aa0-7ea937969046" />
                <meta>
                    <versionId value="1" />
                    <lastUpdated value="2025-01-22T14:43:33.244Z" />
                    <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication" />
                </meta>
                <extension url="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension">
                    <valueCoding>
                        <system value="http://snomed.info/sct" />
                        <version value="http://snomed.info/sct/11000274103/version/20240515" />
                        <code value="781405001" />
                        <display value="Medicinal product package (product)" />
                    </valueCoding>
                </extension>
                <extension url="https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension">
                    <valueIdentifier>
                        <system value="https://gematik.de/fhir/epa-medication/sid/rx-prescription-process-identifier" />
                        <value value="160.153.303.257.459_20250122" />
                    </valueIdentifier>
                </extension>
                <extension url="https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension">
                    <valueCoding>
                        <system value="https://gematik.de/fhir/terminology/CodeSystem/epa-drug-category-cs" />
                        <code value="00" />
                    </valueCoding>
                </extension>
                <identifier>
                    <system value="https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier" />
                    <value value="5FD46319BA6C5C0D7626CFB709AF564362667A70D4A261E0F8EE57D9D837F394" />
                </identifier>
                <identifier>
                    <system value="https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier" />
                    <value value="358f35e5-2e32-46bb-b565-c373ecfb6230_160.153.303.257.459" />
                </identifier>
                <code>
                    <text value="250ml 5-%iger (50 mg/ml) Glucose-Infusionsloesung" />
                </code>
                <status value="active" />
            </Medication>
        </resource>
        <search>
            <mode value="match" />
        </search>
    </entry>
    <entry>
        <fullUrl value="https://epa-as-0.prod.epa4all.de/vau-cid-1234/epa/medication/api/v1/fhir/Medication/4f9ab221-0eef-4e46-a8a9-38302e0488b1" />
        <resource>
            <Medication>
                <id value="4f9ab221-0eef-4e46-a8a9-38302e0488b1" />
                <meta>
                    <versionId value="1" />
                    <lastUpdated value="2025-01-22T14:43:33.244Z" />
                    <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication" />
                </meta>
                <extension url="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension">
                    <valueCoding>
                        <system value="http://snomed.info/sct" />
                        <version value="http://snomed.info/sct/11000274103/version/20240515" />
                        <code value="781405001" />
                        <display value="Medicinal product package (product)" />
                    </valueCoding>
                </extension>
                <extension url="https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension">
                    <valueIdentifier>
                        <system value="https://gematik.de/fhir/epa-medication/sid/rx-prescription-process-identifier" />
                        <value value="160.153.303.257.459_20250122" />
                    </valueIdentifier>
                </extension>
                <extension url="https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension">
                    <valueCoding>
                        <system value="https://gematik.de/fhir/terminology/CodeSystem/epa-drug-category-cs" />
                        <code value="00" />
                    </valueCoding>
                </extension>
                <extension url="http://fhir.de/StructureDefinition/normgroesse">
                    <valueCode value="N3" />
                </extension>
                <identifier>
                    <system value="https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier" />
                    <value value="B849184C973EA5FA7D9751E6FAA6AFCFFD100183596239F84DD2C0DB4C751D67" />
                </identifier>
                <identifier>
                    <system value="https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier" />
                    <value value="c7f34f27-7564-43ad-b13f-2be3c5d7fd3d_160.153.303.257.459" />
                </identifier>
                <code>
                    <coding>
                        <system value="http://fhir.de/CodeSystem/ifa/pzn" />
                        <code value="10019621" />
                        <display value="IBU-ratiopharm 400mg akut Schmerztabletten" />
                    </coding>
                    <coding>
                        <system value="http://fhir.de/CodeSystem/bfarm/atc" />
                        <version value="2022" />
                        <code value="M01AE01" />
                        <display value="Ibuprofen" />
                    </coding>
                </code>
                <status value="active" />
                <form>
                    <coding>
                        <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM" />
                        <version value="1.10" />
                        <code value="TAB" />
                        <display value="Tabletten" />
                    </coding>
                    <coding>
                        <system value="http://standardterms.edqm.eu" />
                        <code value="12200" />
                        <display value="Tablet" />
                    </coding>
                    <coding>
                        <system value="http://snomed.info/sct" />
                        <version value="http://snomed.info/sct/11000274103/version/20240515" />
                        <code value="385055001" />
                        <display value="Tablet (basic dose form)" />
                    </coding>
                </form>
                <amount>
                    <numerator>
                        <value value="50" />
                        <unit value="Tablet" />
                        <system value="http://unitsofmeasure.org" />
                        <code value="{Tablet}" />
                    </numerator>
                    <denominator>
                        <value value="1" />
                        <unit value="Package" />
                        <system value="http://unitsofmeasure.org" />
                        <code value="{Package}" />
                    </denominator>
                </amount>
                <ingredient>
                    <itemCodeableConcept>
                        <coding>
                            <system value="http://snomed.info/sct" />
                            <version value="http://snomed.info/sct/11000274103/version/20240515" />
                            <code value="387207008" />
                            <display value="Ibuprofen (substance)" />
                        </coding>
                    </itemCodeableConcept>
                    <strength>
                        <numerator>
                            <value value="400" />
                            <unit value="MilliGram" />
                            <system value="http://unitsofmeasure.org" />
                            <code value="mg" />
                        </numerator>
                        <denominator>
                            <value value="1" />
                            <unit value="Tablet" />
                            <system value="http://unitsofmeasure.org" />
                            <code value="{Tablet}" />
                        </denominator>
                    </strength>
                </ingredient>
            </Medication>
        </resource>
        <search>
            <mode value="match" />
        </search>
    </entry>
</Bundle>

Suche

Die FHIR-Schnittstellen des Medication Service unterstützen standardmäßige FHIR-Suchoperationen gemäß den Vorgaben der FHIR-Spezifikation. Bei einer Suche wird ein Search Set Bundle zurückgegeben, das speziell für Ressourcen wie beispielsweise Medication, MedicationRequest oder MedicationDispense konfiguriert ist.

Standard-Suchparameter für alle Ressourcen

_id: Bezieht sich auf die logische ID der Ressource

Beispiel

GET [base]/epa/medication/api/v1/fhir/MedicationRequest?_id=ea01ccbc-aa5d-4c34-8292-d95678d52c98

_lastUpdated: Kann verwendet werden, um Ressourcen basierend auf dem letzten Änderungszeitpunkt auszuwählen

Beispiel

GET [base]/epa/medication/api/v1/fhir/MedicationRequest?_lastUpdated=2025-15-01

Einbeziehung verknüpfter Ressourcen in das Ergebnis

_include:

In FHIR wird der Suchparameter _include verwendet, um zu fordern, dass der Server nicht nur die angeforderten Ressourcen, sondern auch andere Ressourcen, die über eine angegebene Referenz mit ihnen verbunden sind, zurückgibt. Dieser Parameter ist besonders nützlich, um verknüpfte Ressourcen in einer einzigen Abfrage abzurufen, wodurch die Notwendigkeit nachfolgender Anfragen verringert wird. Beispielsweise, wenn eine Abfrage an MedicationRequest-Instanzen mit einem _include-Parameter wie MedicationRequest:medication durchgeführt wird, gibt der Medication Service die angeforderten MedicationRequest-Instanzen zusammen mit verknüpften Medication-Instanzen zurück. Das bedeutet, dass eine Liste von Medication-Instanzen ebenso erhalten ist.

Beispiel

GET [base]/epa/medication/api/v1/fhir/MedicationRequest?_include=MedicationRequest:medication

In dieser Abfrage bedeutet:

MedicationRequest der FHIR-Ressourcentyp, der abgefragt wird
_include=MedicationRequest:medication die Anweisung an den Medication Service, die Medication-Instanzen einzubeziehen, auf die in den MedicationRequest-Instanzen referenziert wird

Diese Abfrage gibt ein Search Set Bundle zurück, welches alle im Medication Service verfügbaren MedicationRequest-Instanzen enthält - also auch zugehörige Medication-Instanzen. Hinweis: Dies kann potenziell eine große Ergebnismenge bedeuten und ist davon abhängig, wie viele MedicationRequest-Datensätze gespeichert sind.

_revinclude:

In FHIR ist _revinclude ein Suchparameter, der es ermöglicht, Ressourcen-Instanzen in die Ergebnismenge einzubeziehen, die jeweils auf die primäre Ressourcen-Instanz referenziert.

Beispiel

GET [base]/epa/medication/api/v1/fhir/MedicationRequest?_revinclude=MedicationDispense:prescription

In dieser Abfrage bedeutet:

MedicationRequest der FHIR-Ressourcentyp, der abgefragt wird
_revinclude=MedicationDispense:prescription die Anweisung an den Medication Service, die MedicationDispense-Instanzen einzuschließen, die eine authorizingPrescription-Referenz haben, welche wiederum auf die MedicationRequest-Instanzen verweist

Diese Abfrage gibt ein Search Set Bundle zurück, welche MedicationRequest-Instanzen zusammen mit den MedicationDispense-Instanzen enthält.

Vergleiche und Präzision für Zahlen, Daten und Mengen

Bei einer Suche, die numerische oder Datumsparameter umfasst, hängen die verwendeten Werte von der Präzision des bereitgestellten Parameters ab. Zum Beispiel erstreckt sich für das Datum 2025-02-11 der Bereich von 2025-02-11, um 00:00:00 Uhr (inklusive) bis 2025-02-12, um 00:00:00 Uhr (exklusive).

Präfix

In FHIR werden Gleitkommazahlen durch Datentypen wie decimal und quantity dargestellt, die die Präzision des gespeicherten Werts erfassen. Dies schließt jedoch einige Felder aus, die einfache Ganzzahlen verwenden. Suchoperationen in diesen Feldern führen zu exakten numerischen Übereinstimmungen. Bei numerischen Vergleichen (number, quantity) mit einem einzelnen Wert sind nachfolgende spezifische Präfixe anwendbar. Wenn kein Präfix angegeben wird, wird standardmäßig eq verwendet. Weitere Details finden sich hier: FHIR R4 Search Prefix

Präfix	Beschreibung
`eq`	Der Wert des Parameters in der Ressource ist gleich dem bereitgestellten Wert.
`ne`	Der Wert des Parameters in der Ressource ist nicht gleich dem bereitgestellten Wert.
`gt`	Der Wert des Parameters in der Ressource ist größer als der bereitgestellte Wert.
`lt`	Der Wert des Parameters in der Ressource ist kleiner als der bereitgestellte Wert.
`ge`	Der Wert des Parameters in der Ressource ist größer oder gleich dem bereitgestellten Wert.
`le`	Der Wert des Parameters in der Ressource ist kleiner oder gleich dem bereitgestellten Wert.

Datumsangaben haben einen Bereich, der auf ihrer Präzision (Jahr, Monat, Tag) basiert. Für Typen wie Range oder Period sind eindeutige obere und untere Grenzen definiert. Es gibt spezifische Präfixe für derartige Vergleiche. Wird kein Präfix angegeben, ist eq die Standardwahl.

Präfix	Beschreibung
`eq`	Der Bereich des Suchwerts enthält den Bereich des Zielwerts vollständig.
`ne`	Der Bereich des Suchwerts enthält den Bereich des Zielwerts nicht vollständig.
`gt`	Der Bereich oberhalb des Suchwerts überlappt mit dem Bereich des Zielwerts.
`lt`	Der Bereich unterhalb des Suchwerts überlappt mit dem Bereich des Zielwerts.
`ge`	Der Bereich oberhalb des Suchwerts überlappt mit oder schließt den Bereich des Zielwerts vollständig ein.
`le`	Der Bereich unterhalb des Suchwerts überlappt mit oder schließt den Bereich des Zielwerts vollständig ein.
`sa`	Der Bereich des Parameterwerts beginnt nach dem Zielbereich.
`eb`	Der Bereich des Parameterwerts endet vor dem Zielbereich.

Beispiele

Alle Verschreibungen, die vor dem 15. Februar 2025 aktualisiert wurden.

GET [base]/epa/medication/api/v1/fhir/MedicationRequest?_lastUpdated=lt2025-15-02

Alle Arzneimittelabgaben, die nach dem 15. Februar 2025 erfolgten.

GET [base]/epa/medication/api/v1/fhir/MedicationDispense?whenhandedover=gt2025-15-02

Fortgeschrittene Suche

Die FHIR-Schnittstellen des Medication Service unterstützt neben den standardmäßigen FHIR-Suchoperationen auch die fortgeschrittene Suche mittels _query Suchparameter gemäß den Vorgaben der FHIR-Spezifikation - dies allerdings ausschließlich für den Abruf der Medikationsliste.

Sortierung von Ergebnissen

Das Primärsystem KANN die Reihenfolge der zurückgegebenen Ergebnisse durch den Parameter _sort angeben, der eine durch Kommas getrennte Liste von Sortierregeln in Prioritätsreihenfolge enthalten kann:

GET [base]/epa/medication/api/v1/fhir/MedicationDispense?_sort=status,-whenhandedover

Der Medication Service MUSS die Sortierfunktion nach FHIR R4 Sorting implementieren.