http://localhost:29221/alexanderwilms_7788/
Introduction
RED medical offers a FHIR interface for third-party data providers/consumers. This interface is based on the German regulatory standards §291 (Verordnungssoftware - Schnittstelle / VOS) and §371 (Archiv- und Wechselschnittstelle / AWS) SGB V. These interfaces are based on the international FHIR-Standard with local extensions e.g. for statutory billing purposes.
...
For development and testing the tool Postman (https://www.postman.com/downloads/) can be used as sending application. Please contact us to receive a Postman collection with sample requests.
Search
To query for data items stored in the RED database GET requests are sent to RED. A search requests uses GET and contains
...
Code Block | ||
---|---|---|
| ||
http://localhost:29221/alexanderwilms_7788/Condition?page=1&subject=Patient/6006 |
A successful search request will be responded with a FHIR-Bundle:. In this example two diagnoses are found for the given patient. The FHIR bundle has a wrapper with two entries. For description of entries see below.
Code Blockexpand | ||
---|---|---|
| ||
Code Block | <Bundle xmlns="http://hl7.org/fhir">
<id value=" 47cf8fbd3548c21b-98af 28e2-8ed0 b29e-450b 1f83-e3c13f05eaaa 9a9658909dd6"/> <meta> <lastUpdated value="2022-06-24T19:15 39:59 11+00:00"/> // date-timestamp of request </meta> <type value="searchset"/> <total value="2"/> // number of<self> results found and returned as <entry><relation value="self"/> <entry><url <fullUrl value="/alexanderwilms_7788/ Condition ?page=1&subject=Patient/6006/IEG6VfAE0uw0AuYyzQtx2oIsXLFbUslA"/></self> <first><resource><relation value="first"/> <url value="/alexanderwilms_7788/Condition?page=1&subject=Patient/6006"/<Condition xmlns="http://hl7.org/fhir"></first> <last>
<relation<id value="last IEG6VfAE0uw0AuYyzQtx2oIsXLFbUslA"/> ... </Condition><url value="/alexanderwilms_7788/Condition?page=1&subject=Patient/6006"/>
</resource> </last> entry> <entry><fullUrl <fullUrl value="/Condition/IEG6VfAE0uw0AuYyzQtx2oIsXLFbUslA ROAG8t8Bz7MO8yHXAZOA5y2Tc5zVR8RA"/> <resource> <Condition xmlns="http://hl7.org/fhir"> <id value="IEG6VfAE0uw0AuYyzQtx2oIsXLFbUslA ROAG8t8Bz7MO8yHXAZOA5y2Tc5zVR8RA"/> ... </Condition> </resource><meta> <versionId value="1"/> <lastUpdated value="2022-04-27T00:00:00+00:00"/> <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_AW_Diagnose|1.2.0"/> </meta> <text> <status value="extensions"/> <div xmlns="http://www.w3.org/1999/xhtml">Diagnose von Patient Luca Fink</div> </text> </entry>
</Bundle> |
Search is used to query if a certain data item or data items of a given type have been stored in RED. Search can be applied to
- Encounters (Visits or consultations) and Chargecodes
- Diagnoses
- Medication (orders and overviews)
- History items documented in patient record
- Document references, including stored files (e.g PDF files from scanner or imaging results, printouts of forms created (e.g. Muster, Rezepte) or letters written
- Practitioners and Organizations (users and user groups)
Read
In order to fetch a specific identifiable data item a Read request is used. A read requests uses GET and contains
- address of the system (base url)
- RED tenant ID
- type of data to fetch (e.g Patient)
- identifier of the specific data item. The identifier may be an external identifier sent by the third-party system when the data item was created in RED or may have been retrieved by search
Code Block | ||
---|---|---|
| ||
http://localhost:29221/alexanderwilms_7788/Condition/IEG6VfAE0uw0AuYyzQtx2oIsXLFbUslA |
A read request for a specific data item will be answered with a single FHIR item of the reqested type.
Code Block | ||
---|---|---|
| ||
<Condition xmlns="http://hl7.org/fhir"> <id value="IEG6VfAE0uw0AuYyzQtx2oIsXLFbUslA"/> <meta> <versionId value="1"/> <lastUpdated value="2022-04-27T00:00:00+00:00"/>. // date of creation<extension url / last update in RED <profile value="https://fhir.kbv.de/StructureDefinition/KBV_EX PR_AW_Diagnose_istDauerdiagnose" |1.2.0"/> </meta> <text> // text contains a human-readable description of its content<valueBoolean <status value="true extensions"/> <div xmlns="http://www.w3.org/1999/xhtml">Diagnose von Patient Luca Fink</div> </extension> text> <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_AW_Diagnose_istAbrechnungsrelevant istDauerdiagnose"> <valueBoolean value="true"/> </extension> <extension<valueBoolean value="false"/ url="https://fhir.kbv.de/StructureDefinition/KBV_EX_AW_istAbrechnungsrelevant"> <valueBoolean value="false"/> </extension> extension <clinicalStatus>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/condition-clinical"/>
<code value="active"/>
</coding> </clinicalStatus> <verificationStatus></clinicalStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/condition-ver-status"/><verificationStatus> <code value="confirmed"/> </coding><coding> </verificationStatus> <code> <coding> <system value="http://terminology fhir.hl7.org de/CodeSystem/condition dimdi/icd-ver 10-status gm"/> <version value="2017"/> <code value="confirmed I20.9"/> <display value="Angina pectoris"/> </coding> </code> <subject></verificationStatus> <reference value="Patient/6tVbNJZq1buNwKmp6UKpd8CpLceNDlRF/_history/1"/> </subject><code> <encounter> <reference value="Encounter/P2U6P2J9K53tahcsGALfMyXA1wEAAroy/_history/1"/><coding> </encounter><system value="http://fhir.de/CodeSystem/dimdi/icd-10-gm"/> <version value="2017"/> <code value="I20.9"/> <display value="Angina pectoris mit blauen Punkten"/> </coding> </code> <subject> <reference value="Patient/6tVbNJZq1buNwKmp6UKpd8CpLceNDlRF/_history/1"/> </subject> <encounter> <reference value="Encounter/P2U6P2J9K53tahcsGALfMyXA1wEAAroy/_history/1"/> </encounter> <recordedDate value="2022-04-27"/> </Condition> </resource> </entry> <entry> <fullUrl value="/Condition/ROAG8t8Bz7MO8yHXAZOA5y2Tc5zVR8RA"/> <resource> <Condition xmlns="http://hl7.org/fhir"> <id value="ROAG8t8Bz7MO8yHXAZOA5y2Tc5zVR8RA"/> <meta> <versionId value="1"/> <lastUpdated value="2022-06-23T00:00:00+00:00"/> <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_AW_Diagnose|1.2.0"/> </meta> <text> <status value="extensions"/> <div xmlns="http://www.w3.org/1999/xhtml">Diagnose von Patient Luca Fink</div> </text> <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_AW_Diagnose_istDauerdiagnose"> <valueBoolean value="true"/> </extension> <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_AW_istAbrechnungsrelevant"> <valueBoolean value="true"/> </extension> <clinicalStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/condition-clinical"/> <code value="active"/> </coding> </clinicalStatus> <verificationStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/condition-ver-status"/> <code value="confirmed"/> </coding> </verificationStatus> <code> <coding> <system value="http://fhir.de/CodeSystem/dimdi/icd-10-gm"/> <version value="2017"/> <code value="Q82.01"/> <display value="Hereditäres Lymphödem der oberen Extremität, Stadium II"/> </coding> </code> <subject> <reference value="Patient/6tVbNJZq1buNwKmp6UKpd8CpLceNDlRF/_history/1"/> </subject> <encounter> <reference value="Encounter/R4nutXB6AH2XX2HudUWSnlnZDZqvAuAL/_history/1"/> </encounter> <recordedDate value="2022-06-23"/> </Condition> </resource> </entry> </Bundle> |
Search is used to query if a certain data item or data items of a given type have been stored in RED. Search can be applied to
...
<recordedDate value="2022-04-27"/>
</Condition> |
Practitioners
Practitioners are physicians defined in RED as users/user LANRs. Returns a bundle of one or more FHIR items of type Practitioner. Search for practitioners with this GET requestusers/user LANRs. Practitioners can be searched using a search request. Search returns a bundle of one or more FHIR items of type KBV_PR_AW_Behandelnder.
Code Block | ||
---|---|---|
| ||
{{baseURL}}/{{tenant}}/Practitioner?page=1 |
Data of a specific practitioner may be fetched using a read request with the identifier of the specific practitioner. The request returns a FHIR item of type KBV_PR_AW_Behandelnder
Code Block | ||
---|---|---|
| ||
{{baseURL}}/{{tenant}}/Practitioner?page=1/wK7hhpbEIG1qkSdvRCCd3AEA3W4lBfDB |
Postman Examples
SEARCH All Practitioner
...