Query API: Observation (Beobachtung)
Profile:
- EPAObservationBodyHeight
- EPAObservationBodyWeight
- EPAObservationBreastfeedingStatus
- EPAObservationCreatinine
- EPAObservationEstimatedDateOfDelivery
- EPAObservationGFR
- EPAObservationPregnancyStatus
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 Observation)
GET [base]/epa/medication/api/v1/fhir/Observation
OperationId: listObservations_MedicationSvc
Anfragen an die Observation-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 Observations gesucht werden, die einem bestimmten Code entsprechen. - Die Verwendung von
?date=2025-01-15
kann genutzt werden, um Observations zu suchen, die zu einem bestimmten Datum aufgenommen wurden - Die Verwendung von
?performer=1-test-telematik-id
kann genutzt werden, um Observations zu suchen, die von einem bestimmten Leistungserbringer aufgezeichnet wurden
Bei Anfragen an die QueryAPI für die Observation-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 Observation-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 | Observation.identifier | MUSS |
code | token | http://hl7.org/fhir/SearchParameter/clinical-code | Observation.code | MUSS |
date | date | http://hl7.org/fhir/SearchParameter/clinical-date | Observation.effective | MUSS |
performer | reference | http://hl7.org/fhir/SearchParameter/Observation-performer | Observation.performer | MUSS |
status | token | http://hl7.org/fhir/SearchParameter/Observation-status | Observation.status | MUSS |
Suche per Include oder RevInclude
Include |
---|
Observation.performer |
RevInclude |
---|
Provenance.target |
Beispielantwort
{ "resourceType": "Bundle", "id": "example-searchset-observation", "type": "searchset", "total": 100, "link": [ { "relation": "self", "url": "/epa/medication/api/v1/fhir/Observation?_offset=20&_count=10" }, { "relation": "previous", "url": "/epa/medication/api/v1/fhir/Observation?_offset=10&_count=10" }, { "relation": "next", "url": "/epa/medication/api/v1/fhir/Observation?_offset=30&_count=10" } ], "entry": [ { "fullUrl": "https://epa-as-0.prod.epa4all.de/vau-cid-1234/epa/medication/api/v1/fhir/Observation/82a464e0-7c29-4006-9950-026b1ba83dbd", "resource": { "resourceType": "Observation", "id": "82a464e0-7c29-4006-9950-026b1ba83dbd", "meta": { "versionId": "1", "lastUpdated": "2025-07-23T16:22:33.244Z", "profile": [ "https://gematik.de/fhir/epa/StructureDefinition/epa-observation-body-weight" ] }, "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "vital-signs" } ] } ], "code": { "coding": [ { "system": "http://loinc.org", "code": "29463-7", "version": "2.77", "display": "Body weight" }, { "system": "http://snomed.info/sct", "code": "27113001", "version": "http://snomed.info/sct/11000274103/version/20240515", "display": "Body weight (observable entity)" } ] }, "valueQuantity": { "system": "http://unitsofmeasure.org", "value": 81.2, "unit": "kg", "code": "kg" }, "status": "final", "subject": { "identifier": { "type": { "coding": [ { "code": "KVZ10", "system": "http://fhir.de/CodeSystem/identifier-type-de-basis", "display": "Krankenversichertennummer" } ] }, "value": "X110411319", "system": "http://fhir.de/sid/gkv/kvid-10" } }, "effectiveDateTime": "2025-07-23" }, "search": { "mode": "match" } }, { "fullUrl": "https://epa-as-0.prod.epa4all.de/vau-cid-1234/epa/medication/api/v1/fhir/Observation/42867e48-b793-4f8a-a2ca-e8d4c122b7d7", "resource": { "resourceType": "Observation", "id": "42867e48-b793-4f8a-a2ca-e8d4c122b7d7", "meta": { "versionId": "1", "lastUpdated": "2025-07-23T16:22:33.244Z", "profile": [ "https://gematik.de/fhir/epa/StructureDefinition/epa-observation-body-height" ] }, "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "vital-signs" } ] } ], "code": { "coding": [ { "system": "http://loinc.org", "code": "8302-2", "version": "2.77", "display": "Body height" }, { "system": "http://snomed.info/sct", "code": "1153637007", "version": "http://snomed.info/sct/11000274103/version/20240515", "display": "Body height (observable entity)" } ] }, "valueQuantity": { "system": "http://unitsofmeasure.org", "value": 180, "code": "cm", "unit": "cm" }, "status": "final", "subject": { "identifier": { "type": { "coding": [ { "code": "KVZ10", "system": "http://fhir.de/CodeSystem/identifier-type-de-basis", "display": "Krankenversichertennummer" } ] }, "value": "X110411319", "system": "http://fhir.de/sid/gkv/kvid-10" } }, "effectiveDateTime": "2025-07-23" }, "search": { "mode": "match" } }, { "fullUrl": "https://epa-as-0.prod.epa4all.de/vau-cid-1234/epa/medication/api/v1/fhir/Observation/612d18b0-6555-42fb-b286-0cd72a989fad", "resource": { "resourceType": "Observation", "id": "612d18b0-6555-42fb-b286-0cd72a989fad", "meta": { "versionId": "1", "lastUpdated": "2025-10-23T16:22:33.244Z", "profile": [ "https://gematik.de/fhir/epa/StructureDefinition/epa-observation-creatinine" ] }, "code": { "coding": [ { "system": "http://loinc.org", "code": "77140-2", "version": "2.77", "display": "Creatinine [Moles/volume] in Serum, Plasma or Blood" } ] }, "valueQuantity": { "system": "http://unitsofmeasure.org", "value": 1.2, "comparator": ">=", "unit": "mg/dL", "code": "mg/dL" }, "status": "final", "subject": { "identifier": { "type": { "coding": [ { "code": "KVZ10", "system": "http://fhir.de/CodeSystem/identifier-type-de-basis", "display": "Krankenversichertennummer" } ] }, "value": "X110411319", "system": "http://fhir.de/sid/gkv/kvid-10" } }, "effectiveDateTime": "2025-10-23" }, "search": { "mode": "match" } }, { "fullUrl": "https://epa-as-0.prod.epa4all.de/vau-cid-1234/epa/medication/api/v1/fhir/Observation/5a056693-8acf-4ab3-b51e-9e45fc66056a", "resource": { "resourceType": "Observation", "id": "5a056693-8acf-4ab3-b51e-9e45fc66056a", "meta": { "versionId": "1", "lastUpdated": "2025-07-23T16:22:33.244Z", "profile": [ "https://gematik.de/fhir/epa/StructureDefinition/epa-observation-gfr" ] }, "code": { "coding": [ { "system": "http://loinc.org", "code": "69405-9", "version": "2.77", "display": "Glomerular filtration rate/1.73 sq M.predicted [Volume Rate/Area] in Serum, Plasma or Blood" } ] }, "subject": { "identifier": { "system": "http://fhir.de/sid/gkv/kvid-10", "type": { "coding": [ { "code": "KVZ10", "system": "http://fhir.de/CodeSystem/identifier-type-de-basis", "display": "Krankenversichertennummer" } ] }, "value": "X110411319" } }, "status": "final", "effectiveDateTime": "2025-07-23", "valueQuantity": { "value": 26, "unit": "#mL/min/1.73_m2", "system": "http://unitsofmeasure.org", "code": "mL/min/{1.73_m2}" } }, "search": { "mode": "match" } }, { "fullUrl": "https://epa-as-0.prod.epa4all.de/vau-cid-1234/epa/medication/api/v1/fhir/Observation/a053f908-e133-4dc4-ac0b-8ae0818334cb", "resource": { "resourceType": "Observation", "id": "a053f908-e133-4dc4-ac0b-8ae0818334cb", "meta": { "versionId": "1", "lastUpdated": "2025-10-23T16:22:33.244Z", "profile": [ "https://gematik.de/fhir/epa/StructureDefinition/epa-observation-breastfeeding-status" ] }, "subject": { "identifier": { "system": "http://fhir.de/sid/gkv/kvid-10", "type": { "coding": [ { "code": "KVZ10", "system": "http://fhir.de/CodeSystem/identifier-type-de-basis", "display": "Krankenversichertennummer" } ] }, "value": "X110411319" } }, "code": { "coding": [ { "code": "63895-7", "system": "http://loinc.org", "version": "2.77", "display": "Breastfeeding status" } ] }, "status": "final", "effectiveDateTime": "2025-10-23", "valueCodeableConcept": { "coding": [ { "code": "LA29253-4", "system": "http://loinc.org", "version": "2.77", "display": "Not currently breastfeeding" } ] } }, "search": { "mode": "match" } }, { "fullUrl": "https://epa-as-0.prod.epa4all.de/vau-cid-1234/epa/medication/api/v1/fhir/Observation/43451912-c81e-4d54-8dc8-91bdea027975", "resource": { "resourceType": "Observation", "id": "43451912-c81e-4d54-8dc8-91bdea027975", "meta": { "versionId": "1", "lastUpdated": "2025-10-23T16:22:33.244Z", "profile": [ "https://gematik.de/fhir/epa/StructureDefinition/epa-observation-estimated-date-of-delivery" ] }, "subject": { "identifier": { "system": "http://fhir.de/sid/gkv/kvid-10", "type": { "coding": [ { "code": "KVZ10", "system": "http://fhir.de/CodeSystem/identifier-type-de-basis", "display": "Krankenversichertennummer" } ] }, "value": "X110411319" } }, "code": { "coding": [ { "code": "11778-8", "system": "http://loinc.org", "version": "2.77", "display": "Delivery date Estimated" } ] }, "status": "preliminary", "effectiveDateTime": "2025-07-23", "valueDateTime": "2025-07-15" }, "search": { "mode": "match" } }, { "fullUrl": "https://epa-as-0.prod.epa4all.de/vau-cid-1234/epa/medication/api/v1/fhir/Observation/45ffea3c-dd06-44ef-adbd-a4741ed064d2", "resource": { "resourceType": "Observation", "id": "45ffea3c-dd06-44ef-adbd-a4741ed064d2", "meta": { "versionId": "1", "lastUpdated": "2025-07-23T16:22:33.244Z", "profile": [ "https://gematik.de/fhir/epa/StructureDefinition/epa-observation-pregnancy-status" ] }, "subject": { "identifier": { "system": "http://fhir.de/sid/gkv/kvid-10", "type": { "coding": [ { "code": "KVZ10", "system": "http://fhir.de/CodeSystem/identifier-type-de-basis", "display": "Krankenversichertennummer" } ] }, "value": "X110411319" } }, "code": { "coding": [ { "code": "82810-3", "system": "http://loinc.org", "version": "2.77", "display": "Pregnancy status" } ] }, "status": "final", "effectiveDateTime": "2025-07-23", "valueCodeableConcept": { "coding": [ { "code": "LA26683-5", "system": "http://loinc.org", "version": "2.77", "display": "Not pregnant" } ] } }, "search": { "mode": "match" } } ] }
<Bundle xmlns="http://hl7.org/fhir"> <id value="example-searchset-observation" /> <type value="searchset" /> <total value="100" /> <link> <relation value="self" /> <url value="/epa/medication/api/v1/fhir/Observation?_offset=20&_count=10" /> </link> <link> <relation value="previous" /> <url value="/epa/medication/api/v1/fhir/Observation?_offset=10&_count=10" /> </link> <link> <relation value="next" /> <url value="/epa/medication/api/v1/fhir/Observation?_offset=30&_count=10" /> </link> <entry> <fullUrl value="https://epa-as-0.prod.epa4all.de/vau-cid-1234/epa/medication/api/v1/fhir/Observation/82a464e0-7c29-4006-9950-026b1ba83dbd" /> <resource> <Observation> <id value="82a464e0-7c29-4006-9950-026b1ba83dbd" /> <meta> <versionId value="1" /> <lastUpdated value="2025-07-23T16:22:33.244Z" /> <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-observation-body-weight" /> </meta> <status value="final" /> <category> <coding> <system value="http://terminology.hl7.org/CodeSystem/observation-category" /> <code value="vital-signs" /> </coding> </category> <code> <coding> <system value="http://loinc.org" /> <version value="2.77" /> <code value="29463-7" /> <display value="Body weight" /> </coding> <coding> <system value="http://snomed.info/sct" /> <version value="http://snomed.info/sct/11000274103/version/20240515" /> <code value="27113001" /> <display value="Body weight (observable entity)" /> </coding> </code> <subject> <identifier> <type> <coding> <system value="http://fhir.de/CodeSystem/identifier-type-de-basis" /> <code value="KVZ10" /> <display value="Krankenversichertennummer" /> </coding> </type> <system value="http://fhir.de/sid/gkv/kvid-10" /> <value value="X110411319" /> </identifier> </subject> <effectiveDateTime value="2025-07-23" /> <valueQuantity> <value value="81.2" /> <unit value="kg" /> <system value="http://unitsofmeasure.org" /> <code value="kg" /> </valueQuantity> </Observation> </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/Observation/42867e48-b793-4f8a-a2ca-e8d4c122b7d7" /> <resource> <Observation> <id value="42867e48-b793-4f8a-a2ca-e8d4c122b7d7" /> <meta> <versionId value="1" /> <lastUpdated value="2025-07-23T16:22:33.244Z" /> <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-observation-body-height" /> </meta> <status value="final" /> <category> <coding> <system value="http://terminology.hl7.org/CodeSystem/observation-category" /> <code value="vital-signs" /> </coding> </category> <code> <coding> <system value="http://loinc.org" /> <version value="2.77" /> <code value="8302-2" /> <display value="Body height" /> </coding> <coding> <system value="http://snomed.info/sct" /> <version value="http://snomed.info/sct/11000274103/version/20240515" /> <code value="1153637007" /> <display value="Body height (observable entity)" /> </coding> </code> <subject> <identifier> <type> <coding> <system value="http://fhir.de/CodeSystem/identifier-type-de-basis" /> <code value="KVZ10" /> <display value="Krankenversichertennummer" /> </coding> </type> <system value="http://fhir.de/sid/gkv/kvid-10" /> <value value="X110411319" /> </identifier> </subject> <effectiveDateTime value="2025-07-23" /> <valueQuantity> <value value="180" /> <unit value="cm" /> <system value="http://unitsofmeasure.org" /> <code value="cm" /> </valueQuantity> </Observation> </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/Observation/612d18b0-6555-42fb-b286-0cd72a989fad" /> <resource> <Observation> <id value="612d18b0-6555-42fb-b286-0cd72a989fad" /> <meta> <versionId value="1" /> <lastUpdated value="2025-10-23T16:22:33.244Z" /> <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-observation-creatinine" /> </meta> <status value="final" /> <code> <coding> <system value="http://loinc.org" /> <version value="2.77" /> <code value="77140-2" /> <display value="Creatinine [Moles/volume] in Serum, Plasma or Blood" /> </coding> </code> <subject> <identifier> <type> <coding> <system value="http://fhir.de/CodeSystem/identifier-type-de-basis" /> <code value="KVZ10" /> <display value="Krankenversichertennummer" /> </coding> </type> <system value="http://fhir.de/sid/gkv/kvid-10" /> <value value="X110411319" /> </identifier> </subject> <effectiveDateTime value="2025-10-23" /> <valueQuantity> <value value="1.2" /> <comparator value=">=" /> <unit value="mg/dL" /> <system value="http://unitsofmeasure.org" /> <code value="mg/dL" /> </valueQuantity> </Observation> </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/Observation/5a056693-8acf-4ab3-b51e-9e45fc66056a" /> <resource> <Observation> <id value="5a056693-8acf-4ab3-b51e-9e45fc66056a" /> <meta> <versionId value="1" /> <lastUpdated value="2025-07-23T16:22:33.244Z" /> <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-observation-gfr" /> </meta> <status value="final" /> <code> <coding> <system value="http://loinc.org" /> <version value="2.77" /> <code value="69405-9" /> <display value="Glomerular filtration rate/1.73 sq M.predicted [Volume Rate/Area] in Serum, Plasma or Blood" /> </coding> </code> <subject> <identifier> <type> <coding> <system value="http://fhir.de/CodeSystem/identifier-type-de-basis" /> <code value="KVZ10" /> <display value="Krankenversichertennummer" /> </coding> </type> <system value="http://fhir.de/sid/gkv/kvid-10" /> <value value="X110411319" /> </identifier> </subject> <effectiveDateTime value="2025-07-23" /> <valueQuantity> <value value="26" /> <unit value="#mL/min/1.73_m2" /> <system value="http://unitsofmeasure.org" /> <code value="mL/min/{1.73_m2}" /> </valueQuantity> </Observation> </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/Observation/a053f908-e133-4dc4-ac0b-8ae0818334cb" /> <resource> <Observation> <id value="a053f908-e133-4dc4-ac0b-8ae0818334cb" /> <meta> <versionId value="1" /> <lastUpdated value="2025-10-23T16:22:33.244Z" /> <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-observation-breastfeeding-status" /> </meta> <status value="final" /> <code> <coding> <system value="http://loinc.org" /> <version value="2.77" /> <code value="63895-7" /> <display value="Breastfeeding status" /> </coding> </code> <subject> <identifier> <type> <coding> <system value="http://fhir.de/CodeSystem/identifier-type-de-basis" /> <code value="KVZ10" /> <display value="Krankenversichertennummer" /> </coding> </type> <system value="http://fhir.de/sid/gkv/kvid-10" /> <value value="X110411319" /> </identifier> </subject> <effectiveDateTime value="2025-10-23" /> <valueCodeableConcept> <coding> <system value="http://loinc.org" /> <version value="2.77" /> <code value="LA29253-4" /> <display value="Not currently breastfeeding" /> </coding> </valueCodeableConcept> </Observation> </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/Observation/43451912-c81e-4d54-8dc8-91bdea027975" /> <resource> <Observation> <id value="43451912-c81e-4d54-8dc8-91bdea027975" /> <meta> <versionId value="1" /> <lastUpdated value="2025-10-23T16:22:33.244Z" /> <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-observation-estimated-date-of-delivery" /> </meta> <status value="preliminary" /> <code> <coding> <system value="http://loinc.org" /> <version value="2.77" /> <code value="11778-8" /> <display value="Delivery date Estimated" /> </coding> </code> <subject> <identifier> <type> <coding> <system value="http://fhir.de/CodeSystem/identifier-type-de-basis" /> <code value="KVZ10" /> <display value="Krankenversichertennummer" /> </coding> </type> <system value="http://fhir.de/sid/gkv/kvid-10" /> <value value="X110411319" /> </identifier> </subject> <effectiveDateTime value="2025-07-23" /> <valueDateTime value="2025-07-15" /> </Observation> </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/Observation/45ffea3c-dd06-44ef-adbd-a4741ed064d2" /> <resource> <Observation> <id value="45ffea3c-dd06-44ef-adbd-a4741ed064d2" /> <meta> <versionId value="1" /> <lastUpdated value="2025-07-23T16:22:33.244Z" /> <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-observation-pregnancy-status" /> </meta> <status value="final" /> <code> <coding> <system value="http://loinc.org" /> <version value="2.77" /> <code value="82810-3" /> <display value="Pregnancy status" /> </coding> </code> <subject> <identifier> <type> <coding> <system value="http://fhir.de/CodeSystem/identifier-type-de-basis" /> <code value="KVZ10" /> <display value="Krankenversichertennummer" /> </coding> </type> <system value="http://fhir.de/sid/gkv/kvid-10" /> <value value="X110411319" /> </identifier> </subject> <effectiveDateTime value="2025-07-23" /> <valueCodeableConcept> <coding> <system value="http://loinc.org" /> <version value="2.77" /> <code value="LA26683-5" /> <display value="Not pregnant" /> </coding> </valueCodeableConcept> </Observation> </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 (Observation Instance API)
GET [base]/epa/medication/api/v1/fhir/Observation/[id]
OperationId: getObservationById_MedicationSvc
Um spezifische Details zu einer einzelnen Observation mittels der RESTful API zu erhalten, kann die Observation Instance API verwendet werden, sodass eine HTTP GET-Anfrage an den Endpunkt /Observation/[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" }