Organizations are practices defined in RED as user groups. Organizations contain e.g. addresses and contact information for a practice. Organizations can be searched using a search request (GET). Search for organizations will return a bundle including one or more FHIR items of type KBV_PR_AW_Betriebsstaette

For an example see RED Interchange API - Postman Collection example 0040 All Organizations.

SEARCH request for all organizations
{{baseURL}}/{{tenant}}/Organization?page=1

Example: this search requests fetches all organizations defined in RED using paging to limit the number of results.

Example for an Organization SEARCH with pagination
<Bundle xmlns="http://hl7.org/fhir">
    <id value="0dd7165e-62c4-41d2-19ec-78a77ca6cb88"/>
    <meta>
        <lastUpdated value="2024-08-01T13:36:51+00:00"/>
    </meta>
    <type value="searchset"/>
    <total value="76"/>
    <self>
        <relation value="self"/>
        <url value="/alexanderwilms_7788/Organization?page=1"/>
    </self>
    <first>
        <relation value="first"/>
        <url value="/alexanderwilms_7788/Organization?page=1"/>
    </first>
    <next>
        <relation value="next"/>
        <url value="/alexanderwilms_7788/Organization?page=2"/>
    </next>
    <last>
        <relation value="last"/>
        <url value="/alexanderwilms_7788/Organization?page=8"/>
    </last>
    <entry>
        <fullUrl value="/Organization/base_user_group_admin"/>
        <resource>
            <Organization xmlns="http://hl7.org/fhir">
                <id value="base_user_group_admin"/>
                <meta>
                    <versionId value="1"/>
                    <lastUpdated value="2024-08-01T13:36:51+00:00"/>
                    <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_AW_Betriebsstaette|1.3.0"/>
                </meta>
                <text>
                    <status value="extensions"/>
                    <div xmlns="http://www.w3.org/1999/xhtml">Organisation RED Medical Systems (V1) | ID base_user_group_adminBSNR 478818100 | Adresse Hauptstrasse 180, 56170 Bendorf | Telefon 0171 1014211 | zuletzt bearbeitet 2024-08-01T13:36:51+00:00</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="478818100"/>
                </identifier>
                <name value="RED Medical Systems"/>
                <telecom>
                    <system value="phone"/>
                    <value value="01711014211"/>
                </telecom>
                <telecom>
                    <system value="fax"/>
                    <value value="0643144672"/>
                </telecom>
                <address>
                    <type value="both"/>
                    <line value="Hauptstrasse 180">
                        <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName">
                            <valueString value="Hauptstrasse"/>
                        </extension>
                        <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber">
                            <valueString value="180"/>
                        </extension>
                    </line>
                    <city value="Bendorf"/>
                    <postalCode value="56170"/>
                    <country value="D"/>
                </address>
            </Organization>
        </resource>
    </entry>
    .... // More entries
</Bundle>


Data of a specific organization may be fetched using a read request (GET) including the identifier of the specific organization. A read request returns one FHIR item of type KBV_PR_AW_Betriebsstaette. A read request for an organization specifies the organization by its organization ID. The organization ID may be fetched by a previous search request.

READ request for a given organization
{{baseURL}}/{{tenant}}/Organization/wK7hhpbEIG1qkSdvRCCd3AEA3W4lBfDB

Example: this read request returns the FHIR item for organization with ID wK7hhpbEIG1qkSdvRCCd3AEA3W4lBfDB. The ID may be retrieved by a search request sent before this request.

For an example see RED Interchange API - Postman Collection 0041 - Specific Organization

Example for an Organization READ
<Organization xmlns="http://hl7.org/fhir">
    <id value="ehAMIhoDyyMPvS$6"/>
    <meta>
        <versionId value="1"/>
        <lastUpdated value="2024-08-01T12:56:34+00:00"/>
        <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_AW_Betriebsstaette|1.3.0"/>
    </meta>
    <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml">Organisation Praxis Annie More (V1) | ID ehAMIhoDyyMPvS$6BSNR 241234601 | Adresse Musterstr. 1, 40474 Düsseldorf | Telefon 0211 / 1111111 | E-Mail AM@Testpraxis.de | zuletzt bearbeitet 2024-08-01T12:56:34+00:00</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="241234601"/>
    </identifier>
    <name value="Praxis Annie More"/>
    <telecom>
        <system value="phone"/>
        <value value="02111111111"/>
    </telecom>
    <telecom>
        <system value="fax"/>
        <value value="02112222222"/>
    </telecom>
    <telecom>
        <system value="email"/>
        <value value="AM@Testpraxis.de"/>
    </telecom>
    <address>
        <type value="both"/>
        <line value="Musterstr. 1">
            <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="1"/>
            </extension>
        </line>
        <city value="Düsseldorf"/>
        <postalCode value="40474"/>
        <country value="D"/>
    </address>
</Organization>


  • No labels