Query API: Medication (Medikation)
Profile: EPAMedication
Voraussetzungen
Dem Medication Service MÜSSEN zur Auswertung in Operationen für jede Aktivität die folgenden Informationen bereitstehen:
- Name des Nutzers
- Nutzergruppe/Rolle ((profession-)oid)
- Kennung (Telematik-ID oder KVNR)
- Hinweis auf eine gültige Befugnis des aktuellen Benutzers (requestor)
HTTP Header-Parameter
Ein ePA-Client MUSS die folgenden HTTP Header bei einer Anfrage an den Medication Service setzen:
Name | Anforderung | Datentyp | Beschreibung |
---|---|---|---|
x-insurantid | MUSS | String | Health Record Identifier |
x-useragent | KANN | String | User Agent Information |
X-Request-ID | MUSS | String | UUID der Nachricht |
Wiederholungsintervalle
Die folgenden Wiederholungsintervalle werden im Falle einer Fehlerantwort definiert:
- '409' Conflict (statusMismatch)
- etwa 24 Stunden
- '500' Internal Error
- etwa 10 Minuten
Erlaubte Nutzergruppen
professionOID |
---|
oid_versicherter |
oid_praxis_arzt |
oid_krankenhaus |
oid_institution |
oid_krankenhaus |
oid_institution-vorsorge-reha |
oid_zahnarztpraxis |
oid_praxis_psychotherapeut |
oid_institution-oegd |
oid_öffentliche_apotheke |
oid_institution-pflege |
oid_institution-geburtshilfe |
oid_praxis-physiotherapeut |
oid_institution-arbeitsmedizin |
Interaktion (Query Medication)
GET [base]/epa/medication/api/v1/fhir/Medication
OperationId: listMedications_MedicationSvc
Anfragen an die Medication-Ressource können über die RESTful API mittels HTTP GET-Anfragen durchgeführt werden. Dabei können spezifische Suchparameter genutzt werden, um die Anfragen zu verfeinern. Zum Beispiel:
- Durch die Verwendung von
?code=[code]
kann nach Medikationen gesucht werden, die einem bestimmten Code entsprechen. - Die Verwendung von
?status=active
kann genutzt werden, um nur aktive Medikationen zu suchen.
Bei Anfragen an die QueryAPI für die Medication-Ressource wird die Antwort als ein FHIR Bundle des Typs searchset zurückgegeben. Dieses Bundle enthält eine Sammlung von Einträgen, die jeweils eine Instanz der Medication-Ressource oder weitere Ressourcen im Zusammenhang mit der Abfrage enthalten können.
Suchparameter
Parameter | Type | Definition | Beschreibung | Anforderung |
---|---|---|---|---|
_id | token | http://hl7.org/fhir/SearchParameter/Resource-id | Resource.id | MUSS |
_lastUpdated | date | http://hl7.org/fhir/SearchParameter/Resource-lastUpdated | Resource.meta.lastUpdated | MUSS |
identifier | token | http://hl7.org/fhir/SearchParameter/clinical-identifier | Medication.identifier | MUSS |
code | token | http://hl7.org/fhir/SearchParameter/clinical-code | Medication.code | MUSS |
status | token | http://hl7.org/fhir/SearchParameter/Medication-status | Medication.status | MUSS |
ingredient | reference | http://hl7.org/fhir/SearchParameter/Medication-ingredient | Medication.ingredient.item.reference | MUSS |
ingredient-code | token | http://hl7.org/fhir/SearchParameter/Medication-ingredient-code | Medication.ingredient.item.concept | MUSS |
rx-prescription | token | https://gematik.de/fhir/epa-medication/SearchParameter/rx-prescription-process-sp | Medication.extension | MUSS |
Suche per Include oder RevInclude
Include |
---|
Medication.ingredient |
RevInclude |
---|
MedicationRequest.medication |
MedicationDispense.medication |
MedicationStatement.medication |
Provenance.target |
Medication.ingredient |
Beispielantwort
{ "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&_count=10" /> </link> <link> <relation value="previous" /> <url value="/epa/medication/api/v1/fhir/Medication?_offset=10&_count=10" /> </link> <link> <relation value="next" /> <url value="/epa/medication/api/v1/fhir/Medication?_offset=30&_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>
Antwort-Status-Codes
Status Code | Bedingung | Error Code | Bemerkung |
---|---|---|---|
200 | Successful operation | ||
400 | Unknown search parameter | EPA OperationOutcome | |
400 | Invalid query parameter(s) | EPA OperationOutcome | |
400 | Invalid request | EPA OperationOutcome | |
403 | Requestor role is not in the list of allowed user groups | invalidOid | |
403 | Requestor is not entitled | notEntitled | |
403 | ID-Token or Insurant-ID mismatch | EPA OperationOutcome | |
404 | Unknown resource type | EPA OperationOutcome | |
404 | Health record is in state UNKNOWN or INITIALIZED | noHealthRecord | (siehe 'Wiederholungsintervalle') |
409 | Health record is in state SUSPENDED | statusMismatch | (siehe 'Wiederholungsintervalle') |
423 | If the insurant objected to the medication process or objected to the submission of prescription and dispensation data into the ePA system, the Medication Service is locked. | locked | |
500 | Any other error | internalError | (siehe 'Wiederholungsintervalle') |
Serviceübergreifende Error Codes ohne Verweis auf EPA OperationOutcome MÜSSEN mit dem entsprechenden HTTP Status Code vom Medication Service mit dem Media Type application/json
nach folgendem Schema zurückgegeben werden:
{ "errorCode": "statusMismatch" }
Interaktion (Medication Instance API)
GET [base]/epa/medication/api/v1/fhir/Medication/[id]
OperationId: getMedicationById_MedicationSvc
Um spezifische Details zu einer einzelnen Medication mittels der RESTful API zu erhalten, kann die Medication Instance API verwendet werden, sodass eine HTTP GET-Anfrage an den Endpunkt /Medication/[id]
gerichtet wird.
Antwort-Status-Codes
Status Code | Bedingung | Error Code | Bemerkung |
---|---|---|---|
200 | Successful operation | ||
400 | Unknown search parameter | EPA OperationOutcome | |
400 | Invalid query parameter(s) | EPA OperationOutcome | |
400 | Invalid request | EPA OperationOutcome | |
403 | Requestor role is not in the list of allowed user groups | invalidOid | |
403 | Requestor is not entitled | notEntitled | |
403 | ID-Token or Insurant-ID mismatch | EPA OperationOutcome | |
404 | Resource is not known | EPA OperationOutcome | |
404 | Unknown resource type | EPA OperationOutcome | |
404 | Health record is in state UNKNOWN or INITIALIZED | noHealthRecord | (siehe 'Wiederholungsintervalle') |
409 | Health record is in state SUSPENDED | statusMismatch | (siehe 'Wiederholungsintervalle') |
423 | If the insurant objected to the medication process or objected to the submission of prescription and dispensation data into the ePA system, the Medication Service is locked. | locked | |
500 | Any other error | internalError | (siehe 'Wiederholungsintervalle') |
Serviceübergreifende Error Codes ohne Verweis auf EPA OperationOutcome MÜSSEN mit dem entsprechenden HTTP Status Code vom Medication Service mit dem Media Type application/json
nach folgendem Schema zurückgegeben werden:
{ "errorCode": "statusMismatch" }