RED interchange API allows to send FHIR bundles to RED in order to create new data using a POST request.

POST request to create new data
{{baseURL}}/{{tenant}}/Bundle

Example: this POST requests creates data in RED if a FHIR bundle is attached

See RED Interchange API - Postman Collection


The request header should set the content-type to "Content-Type": "application/fhir+xml; charset=UTF-8"

The request body must include a valid FHIR bundle with the items to create. 

  • patients are identified by their patient ID (Patient.id). If patients are created by interface RED will use the Patient.id from the Patient bundle for patient identification, and patient references of incoming data must always refer to this ID. That allows external systems to create patients in RED using their identifiers and to use the same ID in both systems.
  • all bundle items will be referenced by their IDs, their data in RED can be updated by sending a bundle with the same ID.


A condition (=EBM diagnosis) needs a reference to the practitioner who provided the service (LANR) and the practice the service was provided at (BSNR). Therefore a claim must contain a reference to a practitioner and an organization. An additional practitioner role connects practitioner and organization.


Example: RED receives a FHIR bundle and creates a condition

Miminum set to create a new patient with a condition in RED
<Bundle xmlns="http://hl7.org/fhir">
    <id value="10000"/>
    <meta>
        <versionId value="1"/>
        <lastUpdated value="2022-03-25T12:52:00+00:00"/>
        <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_AW_Bundle_Patientenakte|1.2.0"/>
    </meta>
    <type value="history"/>
    <entry>
        <fullUrl value="http://test.local/fhir/Patient/4723"/>
        <resource>
            <Patient>
                <id value="M4732"/>
                <meta>
                    <versionId value="3"/>
                    <lastUpdated value="2021-07-11T13:45:00+00:00"/>
                    <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_AW_Patient|1.2.0"/>
                </meta>
                <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_AW_Patient_KostenuebernahmeIgeL">
                    <valueBoolean value="false"/>
                </extension>
                <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_AW_Patient_Zusatzinformationen">
                    <extension url="religionszugehoerigkeit">
                        <valueString value="ev."/>
                    </extension>
                </extension>
                <extension url="http://hl7.org/fhir/StructureDefinition/patient-citizenship">
                    <extension url="code">
                        <valueCodeableConcept>
                            <coding>
                                <system value="http://fhir.de/CodeSystem/deuev/anlage-8-laenderkennzeichen"/>
                                <code value="D"/>
                            </coding>
                        </valueCodeableConcept>
                    </extension>
                </extension>
                <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_AW_Patient_Vsdm_Zusatzinformationen">
                    <extension url="geschlecht">
                        <valueCoding>
                            <system value="http://hl7.org/fhir/administrative-gender"/>
                            <code value="female"/>
                        </valueCoding>
                    </extension>
                    <extension url="geburtsdatum">
                        <valueDate value="1972-03-04"/>
                    </extension>
                    <extension url="adresse">
                        <valueAddress>
                            <type value="physical"/>
                            <line value="Musterstr. 43">
                                <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName">
                                    <valueString value="Musterstr."/>
                                </extension>
                                <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber">
                                    <valueString value="43"/>
                                </extension>
                            </line>
                            <city value="Hamburg"/>
                            <postalCode value="20146"/>
                            <country value="D"/>
                        </valueAddress>
                    </extension>
                </extension>
                <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_Base_Additional_Comment">
                    <valueString value="Sehr gute Patientin"/>
                </extension>
                <identifier>
                    <type>
                        <coding>
                            <system value="http://fhir.de/CodeSystem/identifier-type-de-basis"/>
                            <code value="GKV"/>
                        </coding>
                    </type>
                    <system value="http://fhir.de/NamingSystem/gkv/kvid-10"/>
                    <value value="M040319722"/>
                </identifier>
                <name>
                    <use value="official"/>
                    <text value="Silke SE von Mustermann"/>
                    <family value="Freifrau von Mustermann">
                        <extension url="http://fhir.de/StructureDefinition/humanname-namenszusatz">
                            <valueString value="SE"/>
                        </extension>
                        <extension url="http://hl7.org/fhir/StructureDefinition/humanname-own-prefix">
                            <valueString value="von"/>
                        </extension>
                        <extension url="http://hl7.org/fhir/StructureDefinition/humanname-own-name">
                            <valueString value="Mustermann"/>
                        </extension>
                    </family>
                    <given value="Silke"/>
                </name>
                <name>
                    <use value="maiden"/>
                    <family value="Schmitt">
                        <extension url="http://hl7.org/fhir/StructureDefinition/humanname-own-name">
                            <valueString value="Schmitt"/>
                        </extension>
                    </family>
                </name>
                <telecom>
                    <system value="phone"/>
                    <value value="07755332211"/>
                </telecom>
                <telecom>
                    <system value="email"/>
                    <value value="m.mustermann@update.de"/>
                </telecom>
                <gender value="female"/>
                <birthDate value="1972-03-04"/>
                <address>
                    <type value="both"/>
                    <line value="Musterstr. 43">
                        <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName">
                            <valueString value="Musterstr."/>
                        </extension>
                        <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber">
                            <valueString value="43"/>
                        </extension>
                    </line>
                    <city value="Hamburg"/>
                    <postalCode value="20146"/>
                    <country value="D"/>
                </address>
                <maritalStatus>
                    <coding>
                        <system value="http://terminology.hl7.org/CodeSystem/v3-MaritalStatus"/>
                        <code value="M"/>
                    </coding>
                </maritalStatus>
                <contact>
                    <relationship>
                        <coding>
                            <system value="http://terminology.hl7.org/CodeSystem/v2-0131"/>
                            <code value="CP"/>
                        </coding>
                    </relationship>
                    <name>
                        <family value="Mustermann"/>
                        <given value="Fritz"/>
                    </name>
                    <telecom>
                        <system value="phone"/>
                        <value value="07755332212"/>
                    </telecom>
                </contact>
                <communication>
                    <language>
                        <coding>
                            <system value="urn:ietf:bcp:47"/>
                            <code value="de-DE"/>
                        </coding>
                    </language>
                    <preferred value="true"/>
                </communication>
            </Patient>
        </resource>
    </entry>
    <entry>
        <fullUrl value="/Encounter/DKDEEDU1-TphQKgN4rdZsD5pu3767kMNprPqwkLGy-163179466271321"/>
        <resource>
            <Encounter>
                <id value="DKDEEDU1-TphQKgN4rdZsD5pu3767kMNprPqwkLGy-163179466271321"/>
                <meta>
                    <lastUpdated value="2022-03-25"/>
                    <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_AW_Begegnung|1.2.0"/>
                </meta>
                <status value="arrived"/>
                <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_AW_Begegnung_Spezielle_Begegnungsinformationen">
                    <extension url="typ">
                        <valueCodeableConcept>
                            <text value="DOKTORDE"/>
                        </valueCodeableConcept>
                    </extension>
                </extension>
                <class>
                    <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/>
                    <code value="AMB"/>
                </class>
                <subject>
                    <reference value="Patient/M4732"/>
                </subject>
                <participant>
                    <individual>
                        <reference value="PractitionerRole/MsEruEL8DtGI6JYfJpi86Mb0mMIrQkBw"/>
                    </individual>
                </participant>
                <serviceProvider>
                    <reference value="Organization/kDp86kMB1KU7a25JYBJlYundTTlJsJOh"/>
                </serviceProvider>
                <period>
                    <start value="2022-03-25"/>
                    <end value="2022-03-25"/>
                </period>
            </Encounter>
        </resource>
    </entry>
    <entry>
        <fullUrl value="http://test.local/fhir/Condition/321911"/>
        <resource>
            <Condition>
                <id value="321911"/>
                <meta>
                    <versionId value="1" />
                    <lastUpdated value="2020-09-14T18:58:00+00:00" />
                    <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_AW_Diagnose|1.2.0"/>
                </meta>
                <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_Base_Additional_Comment">
                    <valueString value="keiner"/>
                </extension>
                <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>
                <category>
                    <coding>
                        <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_AW_Diagnosekategorie"/>
                        <code value="Eigendiagnose"/>
                    </coding>
                </category>
                <category>
                    <coding>
                        <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_AW_Diagnoseart"/>
                        <code value="Behandlungsdiagnose"/>
                    </coding>
                </category>
                <code>
                    <coding>
                        <extension url="http://fhir.de/StructureDefinition/icd-10-gm-diagnosesicherheit">
                            <valueCoding>
                                <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_ICD_DIAGNOSESICHERHEIT"/>
                                <code value="G"/>
                            </valueCoding>
                        </extension>
                        <system value="http://fhir.de/CodeSystem/dimdi/icd-10-gm"/>
                        <version value="2020"/>
                        <code value="Q90.0"/>
                    </coding>
                    <text value="Trisomie 21"/>
                </code>
                <subject>
                    <reference value="Patient/M4732"/>
                </subject>
                <encounter>
                    <reference value="DKDEEDU1-TphQKgN4rdZsD5pu3767kMNprPqwkLGy-163179466271321"/>
                </encounter>
                <recordedDate value="2022-03-25"/>
                <note>
                    <text value="Patientin scheint leicht erkältet zu sein."/>
                </note>
            </Condition>
        </resource>
    </entry>
    <entry>
        <fullUrl value="http://test.local/fhir/Provenance/3002Pro"/>
        <resource>
            <Provenance>
                <id value="3002Pro"/>
                <meta>
                    <versionId value="1"/>
                    <lastUpdated value="2022-03-25T15:43:57+0200"/>
                    <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_AW_Provenienz|1.2.0"/>
                </meta>
                <target>
                    <reference value="Condition/321911"/>
                </target>
                <recorded value="2022-03-25T15:43:57+0200"/>
                <activity>
                    <coding>
                        <system value="http://terminology.hl7.org/CodeSystem/v3-DataOperation"/>
                        <code value="CREATE"/>
                    </coding>
                </activity>
                <agent>
                    <role>
                        <coding>
                            <system value="http://terminology.hl7.org/CodeSystem/contractsignertypecodes"/>
                            <code value="PRIMAUTH"/>
                        </coding>
                    </role>
                    <who>
                        <reference value="Practitioner/g4tcJvOhBU9hwTlwsKWDUhmT6Zku8b7M"/>
                    </who>
                    <onBehalfOf>
                        <reference value="Organization/kDp86kMB1KU7a25JYBJlYundTTlJsJOh"/>
                    </onBehalfOf>
                </agent>
            </Provenance>
        </resource>
    </entry>
</Bundle>





 

  • No labels