View Source

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

{{baseURL}}/{{tenant}}/Bundle

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

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.

Example: RED receives a FHIR bundle and creates a new patient (minimal dataset)

<Bundle xmlns="http://hl7.org/fhir">
    <id value="10000"/>
    <meta>
        <versionId value="1"/>
        <lastUpdated value="2022-06-17T12: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://ife.local/fhir/Patient/A123123123"/>
        <resource>
            <Patient>
                <id value="A123123123"/>
                <meta>
                    <versionId value="1"/>
                    <lastUpdated value="2022-06-17T13:23:00+00:00"/>
                    <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_AW_Patient|1.2.0"/>
                </meta>
                <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="A123123123"/>
                </identifier>
                <name>
                    <use value="official"/>
                    <text value="Vorname Nachname"/>
                    <family value="Nachname" />
                    <given value="Vorname"/>
                </name> 
                <telecom>
                    <system value="phone"/>
                    <value value="017670834813"/>
                </telecom>
                <telecom>
                    <system value="email"/>
                    <value value="vorname.nachname@email.de"/>
                </telecom>
                <gender value="male"/>
                <birthDate value="1990-08-18"/>
                <address>
                    <type value="both"/>
                    <line value="Straße 1">
                        <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName">
                            <valueString value="Straße"/>
                        </extension>
                        <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber">
                            <valueString value="1"/>
                        </extension>
                    </line>
                    <city value="Kiel"/>
                    <postalCode value="99997"/>
                    <country value="D"/>
                </address>
            </Patient>
        </resource>
    </entry>
</Bundle>

Example: RED receives a full patient data set with address and contact information and photo

<Bundle xmlns="http://hl7.org/fhir">
  <id value="10001"/>
  <meta>
    <versionId value="1"/>
    <lastUpdated value="2021-08-11T12: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/4711"/>
    <resource>
      <Patient>
        <id value="4711"/>
        <meta>
          <versionId value="2"/>
          <lastUpdated value="2021-07-11T13:45:00+00:00"/>
          <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_AW_Patient|1.2.0"/>
        </meta>
        <text>
          <status value="extensions"/>
          <div xmlns="http://www.w3.org/1999/xhtml">
            TBD
          </div>
        </text>
        <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@mustermann.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>
        <photo>
          <contentType value="image/jpeg"/>
          <data
            value="/9j/4AAQSkZJRgABAQEASABIAAD//gAT....." // Image as base64 String
        </photo>
        <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>
    <request>
      <method value="PUT"/>
      <url value="Patient/4711"/>
    </request>
    <response>
      <status value="201"/>
    </response>
  </entry>
</Bundle>