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

  • 0240 - Patient and Claim
  • 0241 - Claim for a known Patient


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 chargecode needs a reference to the practitioner who provided the service (LANR) and the practice the service was provided at (BSNR). The Claim therefore needs a reference to a PractitionerRole. The PractitionerRole definition may be given in the same bundle with a Practitioner item, an Organization item and a combining PractitionerRole item. If the Practitioners and Organizations are created and maintained in RED the Claim may just contain the reference to an existing PractitionerRole (that has e.g. been fetched from RED before)

Set to create a new claim in RED
<Bundle xmlns="http://hl7.org/fhir">
    <id value="10000"/>
    <meta>
        <versionId value="1"/>
        <lastUpdated value="2023-06-14T12: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/Claim/3197AbrVor"/>
        <resource>
            <Claim>
                <id value="3197AbrVor"/>
                <meta>
                    <versionId value="1"/>
                    <lastUpdated value="2023-06-14T09:49:00+00:00"/>
                    <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_AW_Abrechnung_Vorlaeufig|1.2.0"/>
                </meta>
                <status value="active"/>
                <type>
                    <coding>
                        <system value="http://terminology.hl7.org/CodeSystem/claim-type"/>
                        <code value="professional"/>
                    </coding>
                </type>
                <subType>
                    <coding>
                        <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_AW_Abrechnung_Art"/>
                        <code value="Abrechnung_Vorlaeufig"/>
                    </coding>
                </subType>
                <use value="predetermination"/>
                <patient>
                    <reference value="Patient/4723"/>
                </patient>
                <created value="2023-06-14"/>
                <provider>
                    <reference value="PractitionerRole/MsEruEL8DtGI6JYfJpi86Mb0mMIrQkBw"/>
                </provider>
                <priority>
                    <coding>
                        <system value="http://terminology.hl7.org/CodeSystem/processpriority"/>
                        <code value="normal"/>
                    </coding>
                </priority>
                <insurance>
                    <sequence value="1"/>
                    <focal value="true"/>
                    <coverage>
                        <display value="N.N."/>
                    </coverage>
                </insurance>
                <item>
                    <extension
            url="https://fhir.kbv.de/StructureDefinition/KBV_EX_AW_Abrechnung_spezielle_Abrechnungsbegruendung">
                        <extension url="art_der_Untersuchung">
                            <valueString value="Übersichtsaufnahmen"/>
                        </extension>
                        <extension url="name_des_Arztes">
                            <valueString value="Dr. Müller"/>
                        </extension>
                        <extension url="poststationaer_erbrachte_Leistung">
                            <valueBoolean value="false"/>
                        </extension>
                        <extension url="freie_Begruendung">
                            <valueString value="Die Patientin leidet an extremer externer Pigmentation."/>
                        </extension>
                        <extension url="gop_fuer_bezugsperson">
                            <valueBoolean value="false"/>
                        </extension>
                        <extension url="wiederholungsuntersuchung">
                            <valueBoolean value="true"/>
                        </extension>
                        <extension url="jahr_der_letzten_Krebsfrueherkennung">
                            <valueDate value="2017"/>
                        </extension>
                        <extension url="betreffendes_Organ">
                            <valueString value="Leber"/>
                        </extension>
                        <extension url="gop_Zusatz">
                            <valueString value="ein GOP-Zusatz"/>
                        </extension>
                        <extension url="kontrast_Arzneimittel">
                            <valueQuantity>
                                <value value="30"/>
                                <unit value="ml"/>
                                <system value="http://unitsofmeasure.org"/>
                                <code value="ml"/>
                            </valueQuantity>
                        </extension>
                    </extension>
                    <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_AW_istAbrechnungsrelevant">
                        <valueBoolean value="true"/>
                    </extension>
                    <sequence value="1"/>
                    <category>
                        <coding>
                            <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_AW_Abrechnung_Item_Kategorie"/>
                            <code value="GOP"/>
                        </coding>
                    </category>
                    <productOrService>
                        <coding>
                            <system value="https://fhir.kbv.de/NamingSystem/KBV_NS_Base_EBM"/>
                            <code value="34210"/>
                        </coding>
                    </productOrService>
                    <quantity>
                        <value value="1"/>
                        <unit value="1"/>
                        <system value="http://unitsofmeasure.org"/>
                        <code value="1"/>
                    </quantity>
                    <unitPrice>
                        <value value="11.65"/>
                        <currency value="EUR"/>
                    </unitPrice>
                    <factor value="1"/>
                    <net>
                        <value value="13.47"/>
                        <currency value="EUR"/>
                    </net>
                </item>
            </Claim>
        </resource>
    </entry>
    <entry>
        <fullUrl value="/Practitioner/g4tcJvOhBU9hwTlwsKWDUhmT6Zku8b7M"/>
        <resource>
            <Practitioner xmlns="http://hl7.org/fhir">
                <id value="g4tcJvOhBU9hwTlwsKWDUhmT6Zku8b7M"/>
                <meta>
                    <versionId value="1"/>
                    <lastUpdated value="2023-06-14T00:00:00+00:00"/>
                    <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_AW_Behandelnder|1.2.0"/>
                </meta>
                <text>
                    <status value="extensions"/>
                    <div xmlns="http://www.w3.org/1999/xhtml">Behandler Dr. Hannes Heinrich</div>
                </text>
                <identifier>
                    <type>
                        <coding>
                            <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
                            <code value="LANR"/>
                        </coding>
                    </type>
                    <system value="https://fhir.kbv.de/NamingSystem/KBV_NS_Base_ANR"/>
                    <value value="479999912"/>
                </identifier>
                <name>
                    <use value="official"/>
                    <text value="Dr. Hannes Heinrich"/>
                    <family value="Heinrich">
                        <extension url="http://hl7.org/fhir/StructureDefinition/humanname-own-name">
                            <valueString value="Heinrich"/>
                        </extension>
                    </family>
                    <given value="Hannes"/>
                    <prefix value="Dr.">
                        <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier">
                            <valueCode value="AC"/>
                        </extension>
                    </prefix>
                </name>
                <address>
                    <country value="D"/>
                </address>
                <gender value="male">
                    <extension url="http://fhir.de/StructureDefinition/gender-amtlich-de">
                        <valueCoding>
                            <system value="http://fhir.de/CodeSystem/gender-amtlich-de"/>
                            <code value="M"/>
                            <display value="männlich"/>
                        </valueCoding>
                    </extension>
                </gender>
                <qualification>
                    <code>
                        <coding>
                            <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_BAR2_ARZTNRFACHGRUPPE"/>
                            <code value="05"/>
                        </coding>
                    </code>
                </qualification>
            </Practitioner>
        </resource>
    </entry>
    <entry>
        <fullUrl value="/Organization/kDp86kMB1KU7a25JYBJlYundTTlJsJOh"/>
        <resource>
            <Organization xmlns="http://hl7.org/fhir">
                <id value="kDp86kMB1KU7a25JYBJlYundTTlJsJOh"/>
                <meta>
                    <versionId value="1"/>
                    <lastUpdated value="2023-06-14T00:00:00+00:00"/>
                    <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_AW_Betriebsstaette|1.2.0"/>
                </meta>
                <text>
                    <status value="extensions"/>
                    <div xmlns="http://www.w3.org/1999/xhtml">Organisation Dr. Heinrich</div>
                </text>
                <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_AW_Betriebsstaette_Hierarchie">
                    <valueCode value="BSNR"/>
                </extension>
                <identifier>
                    <type>
                        <coding>
                            <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
                            <code value="BSNR"/>
                        </coding>
                    </type>
                    <system value="https://fhir.kbv.de/NamingSystem/KBV_NS_Base_BSNR"/>
                    <value value="AD1234500"/>
                </identifier>
                <name value="Dr. Heinrich"/>
                <address>
                    <country value="D"/>
                </address>
            </Organization>
        </resource>
    </entry>
    <entry>
        <fullUrl value="/PractitionerRole/MsEruEL8DtGI6JYfJpi86Mb0mMIrQkBw"/>
        <resource>
            <PractitionerRole xmlns="http://hl7.org/fhir">
                <id value="MsEruEL8DtGI6JYfJpi86Mb0mMIrQkBw"/>
                <meta>
                    <versionId value="1"/>
                    <lastUpdated value="2023-06-14T00:00:00+00:00"/>
                    <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_AW_BehandelnderFunktion|1.2.0"/>
                </meta>
                <text>
                    <status value="extensions"/>
                    <div xmlns="http://www.w3.org/1999/xhtml">Behandlerrolle LANR 479999912/BSNR 479999999</div>
                </text>
                <practitioner>
                    <reference value="Practitioner/g4tcJvOhBU9hwTlwsKWDUhmT6Zku8b7M/_history/1"/>
                </practitioner>
                <organization>
                    <reference value="Organization/yYJ1iAwyEocr1h2HJM0HWzGeWJMcjJrM/_history/1"/>
                </organization>
            </PractitionerRole>
        </resource>
    </entry>
</Bundle>
Minimal set for a claim
<Bundle xmlns="http://hl7.org/fhir">
    <id value="123456"/>
    <meta>
        <versionId value="1"/>
        <lastUpdated value="2024-02-29"/>
    </meta>
    <type value="history"/>
    <entry>
        <resource>
            <Claim>
                <id value="123123128"/>
                <meta>
                    <versionId value="1"/>
                    <lastUpdated value="2024-02-29"/>
                    <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_AW_Abrechnung_Vorlaeufig|1.2.0"/>
                </meta>
                <status value="active"/>
                <type>
                    <coding>
                        <system value="http://terminology.hl7.org/CodeSystem/claim-type"/>
                        <code value="professional"/>
                    </coding>
                </type>
                <subType>
                    <coding>
                        <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_AW_Abrechnung_Art"/>
                        <code value="Abrechnung_Vorlaeufig"/>
                    </coding>
                </subType>
                <use value="Claim"/>
                <patient>
                    <reference value="Patient/A4567"/>
                </patient>
                <created value="2024-02-29"/>
                <provider>
                    <reference value="PractitionerRole/EAQ4i8WB3qDlAJwp2aQvPneIMA6irC2S"/>
                </provider>
                <priority>
                    <coding>
                        <system value="http://terminology.hl7.org/CodeSystem/processpriority"/>
                        <code value="normal"/>
                    </coding>
                </priority>
                <item>
                    <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_AW_istAbrechnungsrelevant">
                        <valueBoolean value="true"/>
                    </extension>
                    <sequence value="1"/>
                    <category>
                        <coding>
                            <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_AW_Abrechnung_Item_Kategorie"/>
                            <code value="GOP"/>
                        </coding>
                    </category>
                    <productOrService>
                        <coding>
                            <code value="03220"/>
                        </coding>
                    </productOrService>
                    <quantity>
                        <value value="1"/>
                        <unit value="1"/>
                        <system value="http://unitsofmeasure.org"/>
                        <code value="1"/>
                    </quantity>
                    <factor value="1"/>
                </item>
            </Claim>
        </resource>
    </entry>
</Bundle>






 

  • No labels



RED Medical Systems GmbH
Lutzstraße 2, 80687 München

Fon 089 954 57 55 20 | Fax 089 954 57 55 21 | Mail support@redmedical.de | RED Hotline 089 997 43 72 72
Datenschutzerklärung | Impressum