FHIR R4 Resource - PractitionerRole

OpenIMIS table - tblClaimAdmin

FHIR R4 field	OpenIMIS field	notes	mapping status

FHIR R4 field

OpenIMIS field

notes

mapping status

practitioner - Reference(Practitioner)

Rest field of Claim Admin

example of reference (where "{ClaimAdminCode}" is the Claim Admin code):

"Practitioner/{ClaimAdminCode}"

mapped

healthcareService - Reference(HealthcareService)

HFId

example of reference (where "{HFCode}" is the health facility code):

"HealthcareService/{HFUUID}"

mapped

Endpoint specification:

Example of endpoint URL:

http://localhost:8000/api_fhir_r4/PractitionerRole/

CREATE - used to create a relation between OpenIMIS ClaimAdmin and HealthFacility. The request should contain a reference to FHIR Location (HealthFacility) and FHIR Practitioner (ClaimAdmin). Should be used the POST HTTP method and the body as JSON representation (example can be found below).
Note:
- The ClaimAdmin (FHIR Practitioner) need to exist before we will able to create relationships with HealtFacility (FHIR Location)
READ - by default return list of all available resources (based on ClaimAdmin resource so return representation for each ClaimAdmin). To fetch information about a specific object you should add the primary key to URL for instance:
http://localhost:8000/api_fhir_r4/PractitionerRole/1
, where "1" is the value of the primary key. Should be used the GET HTTP method.
UPDATE - update the value of the specific object. List of supported fields can be found in the table which shows the mapping between OpenIMIS and FHIR. Should be used the PUT HTTP method and the body as JSON representation (example can be found below). The requested URL needs to point to a specific object to do that you should add the primary key to URL for instance:
http://localhost:8000/api_fhir_r4/PractitionerRole/1
, where "1" is the value of the primary key.
Note:
- the UPDATE operation will update the specific row of the database and doesn't create the history of changes (like in the legacy OpenIMIS)
DELETE - the operation can be used to remove the relation between OpenIMIS ClaimAdmin and HealthFacility (ClaimAdmin will have null as value of health_facility model attribute). Should be used the DELETE HTTP method. The requested URL needs to point to a specific object to do that you should add the primary key to URL for instance:
http://localhost:8000/api_fhir_r4/Practitioner/1
, where "1" is the value of the primary key.
Note:
- the DELETE operation will the relation between OpenIMIS ClaimAdmin and HealthFacility from the database. ClaimAdmin will have null as value of health_facility model attribute

Example JSON representation of content:

{
    "resourceType": "PractitionerRole",
    "healthcareService": [
        {
            "reference": "HealthcareService/69F8201B-3812-40C1-963C-0F330B9BBC7D"
        }
    ],
    "id": "019E3C7A-0392-41BA-9B78-07519B301483",
    "identifier": [
        {
            "type": {
                "coding": [
                    {
                        "code": "UUID",
                        "system": "https://hl7.org/fhir/valueset-identifier-type.html"
                    }
                ]
            },
            "use": "usual",
            "value": "019E3C7A-0392-41BA-9B78-07519B301483"
        }
    ],
    "practitioner": {
        "reference": "Practitioner/019E3C7A-0392-41BA-9B78-07519B301483"
    }
}

openIMIS

FHIR R4 - PractitionerRole

Endpoint specification:

Example of endpoint URL:

Example JSON representation of content:

Did you encounter a problem or do you have a suggestion?

Please contact our Service Desk