PractitionerRoles combine physicians and their practices defined in RED. PractitionerRoles contain a reference to practitioners and organizations. PractitionerRoles can be searched using a search request (GET)  Search returns a bundle of one or more FHIR items of type KBV_PR_AW_Behandelnder.

For an example see RED Interchange API - Postman Collection 0030 - All PractitionerRoles.

SEARCH request for all practitioner roles
{{baseURL}}/{{tenant}}/PractitioneRole?page=1

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

Example for a SEARCH request for all practitioner roles with pagination
<Bundle xmlns="http://hl7.org/fhir">
    <id value="9ee8ae62-2b54-e16f-0565-8f00c42003b8"/>
    <meta>
        <lastUpdated value="2024-08-01T13:44:26+00:00"/>
    </meta>
    <type value="searchset"/>
    <total value="456"/>
    <self>
        <relation value="self"/>
        <url value="/alexanderwilms_7788/PractitionerRole?page=1"/>
    </self>
    <first>
        <relation value="first"/>
        <url value="/alexanderwilms_7788/PractitionerRole?page=1"/>
    </first>
    <next>
        <relation value="next"/>
        <url value="/alexanderwilms_7788/PractitionerRole?page=2"/>
    </next>
    <last>
        <relation value="last"/>
        <url value="/alexanderwilms_7788/PractitionerRole?page=46"/>
    </last>
    <entry>
        <fullUrl value="/PractitionerRole/TcYtTcJHpzXbgAoEAG091FE05w0ZhrXn"/>
        <resource>
            <PractitionerRole xmlns="http://hl7.org/fhir">
                <id value="TcYtTcJHpzXbgAoEAG091FE05w0ZhrXn"/>
                <meta>
                    <versionId value="1"/>
                    <lastUpdated value="2024-08-01T13:44:26+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 Dr. med. Annie More (V1) | ID TcYtTcJHpzXbgAoEAG091FE05w0ZhrXn | LANR 362364901 | Behandler Dr. med. Annie More | BSNR 478818100 | zuletzt bearbeitet 2024-08-01T13:44:26+00:00</div>
                </text>
                <practitioner>
                    <reference value="Practitioner/wK7hhpbEIG1qkSdvRCCd3AEA3W4lBfDB/_history/1"/>
                </practitioner>
                <organization>
                    <reference value="Organization/base_user_group_admin/_history/1"/>
                </organization>
            </PractitionerRole>
        </resource>
    </entry>
    <entry>
        <fullUrl value="/PractitionerRole/6ZOBiBrqOkrlTdTiGfyAFbhsboAAO8dJ"/>
        <resource>
            <PractitionerRole xmlns="http://hl7.org/fhir">
                <id value="6ZOBiBrqOkrlTdTiGfyAFbhsboAAO8dJ"/>
                <meta>
                    <versionId value="1"/>
                    <lastUpdated value="2024-08-01T13:44:26+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 Dr. med. Annie More (V1) | ID 6ZOBiBrqOkrlTdTiGfyAFbhsboAAO8dJ | LANR 362364901 | Behandler Dr. med. Annie More | BSNR 241234601 | zuletzt bearbeitet 2024-08-01T13:44:26+00:00</div>
                </text>
                <practitioner>
                    <reference value="Practitioner/wK7hhpbEIG1qkSdvRCCd3AEA3W4lBfDB/_history/1"/>
                </practitioner>
                <organization>
                    <reference value="Organization/ehAMIhoDyyMPvS$6/_history/1"/>
                </organization>
            </PractitionerRole>
        </resource>
    </entry>
  	// ... more entries
</Bundle>


Data of a specific practitionerRole may be fetched using a read request (GET) with the identifier of the specific practitionerRole. The request returns a FHIR item of type KBV_PR_AW_BehandelnderFunktion

READ request for a specific practitionerRole
{{baseURL}}/{{tenant}}/PractitionerRole/TcYtTcJHpzXbgAoEAG091FE05w0ZhrXn

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

For an example see RED Interchange API - Postman Collection 0031 - Specific PractitionerRole

Example for a READ request for a specific practitioner role
<PractitionerRole xmlns="http://hl7.org/fhir">
    <id value="TcYtTcJHpzXbgAoEAG091FE05w0ZhrXn"/>
    <meta>
        <versionId value="1"/>
        <lastUpdated value="2024-08-01T13:46:57+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 Dr. med. Annie More (V1) | ID TcYtTcJHpzXbgAoEAG091FE05w0ZhrXn | LANR 362364901 | Behandler Dr. med. Annie More | BSNR 478818100 | zuletzt bearbeitet 2024-08-01T13:46:57+00:00</div>
    </text>
    <practitioner>
        <reference value="Practitioner/wK7hhpbEIG1qkSdvRCCd3AEA3W4lBfDB/_history/1"/>
    </practitioner>
    <organization>
        <reference value="Organization/base_user_group_admin/_history/1"/>
    </organization>
</PractitionerRole>


PractitionerRoles may also be fetched for a given practitioner or organization ID, returning all practitionerRoles the practitioner or organization is referenced to.

READ request for all practitionerRoles referenced to the given practitioner
{{baseURL}}/{{tenant}}/PractitionerRole?practitioner=Practitioner/wK7hhpbEIG1qkSdvRCCd3AEA3W4lBfDB&page=1

Example: this read request returns the FHIR items for all practitionerRoles referenced to practitioner ID wK7hhpbEIG1qkSdvRCCd3AEA3W4lBfDB. 

For an example see RED Interchange API - Postman Collection 0032 - PractitionerRole for Practitioner-ID and 0033 - PractitionerRole for Organization-ID

All practitionerRoles for a specific practitioner may be fetched using a read request with practitioner identifier.

READ request for all practitionerRoles of a specific practitioner
{{baseURL}}/{{tenant}}/PractitionerRole?practitioner=wK7hhpbEIG1qkSdvRCCd3AEA3W4lBfDB

Example: this read request returns an array of all practitionerRoles for practitionier with ID wK7hhpbEIG1qkSdvRCCd3AEA3W4lBfDB. The ID may be retrieved by a search request sent before this request.

  • No labels