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.
Example: RED receives a FHIR bundle and creates a new person
<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> |
The request body may contain several entries, e.g. claims, diagnoses, encounters, coverages, medication. If the person has already been created in RED the FHIR bundle does not require a person entry, but each entry needs a reference to an existing person identifier.
Example: RED creates a new episode for an existing person (with ID 6202)
<Bundle xmlns="http://hl7.org/fhir">
<id value="10000"/>
<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>
<resource>
<Coverage>
<id value="TCI7596-1-1629639837586"/>
<meta>
<versionId value="1"/>
<lastUpdated value="2021-08-22T15:43:57+0200"/>
<profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_AW_Krankenversicherungsverhaeltnis|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="Y681518688"/>
</identifier>
<extension url="http://fhir.de/StructureDefinition/gkv/versichertenart">
<valueCoding>
<system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_VERSICHERTENSTATUS"/>
<code value="1"/>
</valueCoding>
</extension>
<extension url="http://fhir.de/StructureDefinition/gkv/besondere-personengruppe">
<valueCoding>
<system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_PERSONENGRUPPE"/>
<code value="00"/>
<display value="nicht gesetzt"/>
</valueCoding>
</extension>
<status value="active"/>
<type url="http://fhir.de/StructureDefinition/gkv/besondere-personengruppe">
<coding>
<system value="http://fhir.de/CodeSystem/versicherungsart-de-basis"/>
<version value="0.2.3"/>
<code value="GKV"/>
</coding>
</type>
<beneficiary>
<reference value="Patient/6202"/>
</beneficiary>
<payor>
<identifier>
<system value="http://fhir.de/NamingSystem/arge-ik/iknr"/>
<value value="109577006"/>
</identifier>
</payor>
<period>
<start value="2022-01-02"/>
<end value="2022-03-31"/>
</period>
</Coverage>
</resource>
</entry>
</Bundle> |
Example: RED receives a document and creates a new person record entry for person
<Bundle xmlns="http://hl7.org/fhir">
<id value="10000"/>
<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>
<resource>
<DocumentReference>
<id value="self_diagnosis-DKDEEDU1-TphQKgN4rdZsD5pu3767kMNprPqwkLGy-1631794662713-1631794665397"/>
<identifier>
<type>
<coding>
<system value="https://fhir.kbv.de/CodeSystem/KBV_CS_AW_Anlage_Identifiertyp"/>
<code value="Bezeichnung"/>
</coding>
</type>
</identifier>
<status value="current"/>
<type>
<coding>
<system value="https://fhir.kbv.de/CodeSystem/KBV_CS_AW_Anlagetyp"/>
<code value="Sonstige"/>
</coding>
</type>
<created value="2021-11-16T12:17:45Z"/>
<description value="self_diagnosis"/>
<content>
<attachment>
<contentType value="application/pdf"/>
<url value="self_diagnosis-DKDEEDU1-TphQKgN4rdZsD5pu3767kMNprPqwkLGy-1631794662713-1631794665396.pdf"/>
<data value="JVBERi0xLjMKJf////8KOSAwIG9iago8PAovVHlwZSAvRXh0R1N0YXRlCi9jYSAxCi9DQSAxCj4+CmVuZG9iagoxMCAwIG9iago8PAovVHlwZSAvRXh0R1N0YXRlCi9jYSAwLjEKPj4KZW5kb2JqCjExIDAgb2JqCjw8Ci9UeXBlIC9FeHRHU3RhdGUKL2NhIDEKPj4KZW5kb2JqCjEyIDAgb2JqCjw8Ci9UeXBlIC9FeHRHU3RhdGUKL2NhIDAuNQovQ0EgMC41Cj4+CmVuZG9iagoxMyAwIG9iago8PAovVHlwZSAvRXh0R1N0YXRlCi9jYSAwLjcKL0NBIDAuNwo+PgplbmRvYmoKNyAwIG9iago8PAovVHlwZSAvUGFnZQovUGFyZW50IDEgMCBSCi9NZWRpYUJveCBbMCAwIDU5NS4yOCA4NDEuODldCi9Db250ZW50cyA1IDAgUgovUmVzb3VyY2VzIDYgMCBSCj4+CmVuZG9iago2IDAgb2JqCjw8Ci9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUIgL0ltYWdlQyAvSW1hZ2VJXQovRm9udCA8PAovRjEgOCAwIFIKPj4KL0V4dEdTdGF0ZSA8PAovR3MxIDkgMCBSCi9HczIgMTAgMCBSCi9HczMgMTEgMCBSCi9HczQgMTIgMCBSCi9HczUgMTMgMCBSCj4+Cj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNjc0Ci9GaWx0ZXIgL0ZsYXRlRGVjb2RlCj4+CnN0cmVhbQp4nL1W247TMBB9z1f4B9Zre26xtOrDCliJN6BviIdtmiIkigSV4Pc5000WtsmKbSOhKE5mYs/4nLk4OSRcVxlDyzm2NXT75nuT59S360GfQ04pGFEsxmG9b67fQFXCetd8vGHWnW4MoxVmlpIkrQKncKMZ2qqivTG0hLdOlV2X1bTHCtJqtArpU1i/bV6vm3fN9d0hh8+Hl+4p18ipnO5pbgezXq5f9T+/dP37u9vQHZoUJeWqyVqmTFZEwstUh+5bs3OjxY36xjLlaMzYRQoafvT++amvIwpfiGXky3bDQou1ctg38pf01fcWfvlc9rkfzuRJK8X6h6f2MXROkDyh5t8GizxnkAol3Lls8awYM4LuLBHdO1cYmaRs8DXjTk8cH9ELx5Qf0Q/SYvRmsW0n6AmJ2xsZ0tJ4SBVouCpfwsi8E+aNVwUuFnFmLjGtbVTiE9PClrSVzBs17omtKMu9EYNiSyYgHfVFphvecg8NTFk2lzs2G8KDWR6YisAoroJ3hGsaGKsIxRiXB2FxWKSAMT2FVVCvzFsfERBCr+jm6vnSMM06PQ3TFH/laNKOBAzSYgZQ3pna080oumJBYqJrcg/828tKdN64WFmFqyJgE7YnQEv2/qYD0FFaDLTkSHWCcxXkGFUgrCjCugzvnA/xrG7dvrHdT9EWjUXGfjNKi9EmicqTVlA8rODeMxl53OqC9jvrAZVbHe+x/XoTLsRTyFxiQuceIA/S85DPgy5tnvtJECQz+pMgqeePezzlDC/KUeSxiOuDEzs6AcHZk7sive3/HvqlFYDX8w/9UnNE3xtjMkhL01A4RbKTHPEzYxXIU7D679dDgy0J5FXd4pTw37mtUUkXpOWsR6mrkI/dW2x6sFCyKDxCH6Xnof8G/ktDUgplbmRzdHJlYW0KZW5kb2JqCjE1IDAgb2JqCihQREZLaXQpCmVuZG9iagoxNiAwIG9iagooUERGS2l0KQplbmRvYmoKMTcgMCBvYmoKKEQ6MjAyMTA5MTYxMjE3NDVaKQplbmRvYmoKMTQgMCBvYmoKPDwKL1Byb2R1Y2VyIDE1IDAgUgovQ3JlYXRvciAxNiAwIFIKL0NyZWF0aW9uRGF0ZSAxNyAwIFIKPj4KZW5kb2JqCjggMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL0Jhc2VGb250IC9IZWx2ZXRpY2EKL1N1YnR5cGUgL1R5cGUxCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nCj4+CmVuZG9iago0IDAgb2JqCjw8Cj4+CmVuZG9iagozIDAgb2JqCjw8Ci9UeXBlIC9DYXRhbG9nCi9QYWdlcyAxIDAgUgovTmFtZXMgMiAwIFIKPj4KZW5kb2JqCjEgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9Db3VudCAxCi9LaWRzIFs3IDAgUl0KPj4KZW5kb2JqCjIgMCBvYmoKPDwKL0Rlc3RzIDw8CiAgL05hbWVzIFsKXQo+Pgo+PgplbmRvYmoKeHJlZgowIDE4CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMTYzMCAwMDAwMCBuIAowMDAwMDAxNjg3IDAwMDAwIG4gCjAwMDAwMDE1NjggMDAwMDAgbiAKMDAwMDAwMTU0NyAwMDAwMCBuIAowMDAwMDAwNTQyIDAwMDAwIG4gCjAwMDAwMDAzNzcgMDAwMDAgbiAKMDAwMDAwMDI2NyAwMDAwMCBuIAowMDAwMDAxNDUwIDAwMDAwIG4gCjAwMDAwMDAwMTUgMDAwMDAgbiAKMDAwMDAwMDA2NSAwMDAwMCBuIAowMDAwMDAwMTEyIDAwMDAwIG4gCjAwMDAwMDAxNTcgMDAwMDAgbiAKMDAwMDAwMDIxMiAwMDAwMCBuIAowMDAwMDAxMzc0IDAwMDAwIG4gCjAwMDAwMDEyODggMDAwMDAgbiAKMDAwMDAwMTMxMyAwMDAwMCBuIAowMDAwMDAxMzM4IDAwMDAwIG4gCnRyYWlsZXIKPDwKL1NpemUgMTgKL1Jvb3QgMyAwIFIKL0luZm8gMTQgMCBSCi9JRCBbPDM4NjBlMWM4YjhkNzRkODc4ZjA4M2JhNmJlNTcwY2NhPiA8Mzg2MGUxYzhiOGQ3NGQ4NzhmMDgzYmE2YmU1NzBjY2E+XQo+PgpzdGFydHhyZWYKMTczNAolJUVPRgo="/>
<title value="self_diagnosis"/>
<creation value="2021-11-16T12:17:45Z"/>
</attachment>
</content>
<context>
<encounter>
<reference value="Encounter/DKDEEDU1-TphQKgN4rdZsD5pu3767kMNprPqwkLGy-1631794662713"/>
</encounter>
</context>
</DocumentReference>
</resource>
</entry>
<entry>
<fullUrl value="/Encounter/DKDEEDU1-TphQKgN4rdZsD5pu3767kMNprPqwkLGy-1631794662713"/>
<resource>
<Encounter>
<id value="DKDEEDU1-TphQKgN4rdZsD5pu3767kMNprPqwkLGy-1631794662713"/>
<meta>
<lastUpdated value="2021-11-16"/>
<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/4723"/>
</subject>
<participant>
<individual>
<reference value="PractitionerRole/MsEruEL8DtGI6JYfJpi86Mb0mMIrQkBw"/>
</individual>
</participant>
<serviceProvider>
<reference value="Organization/kDp86kMB1KU7a25JYBJlYundTTlJsJOh"/>
</serviceProvider>
<period>
<start value="2021-11-16T12:17:45Z"/>
<end value="2021-11-16T13:17:45Z"/>
</period>
</Encounter>
</resource>
</entry>
</Bundle> |