List of content:

Description:

The OpenIMIS HF object (from the openimis-be-location_py module) was mapped to the FHIR Location resource. 

Notes / Assumptions:

• The endpoint uses the UUID as a primary key
• The current version of mapping will be focused on aspects of claiming.
• In the current version of the openimis-be-location_py missing services layer which can be used to perform operations (CRUD - Create, Read, Update, Delete) on entities. That's why the current version of API use directly database layer manager for managing the HealthFacility objects. This leads to differences between the operation between legacy and new OpenIMIS, for instance, the update operation doesn't create the database row with a history of the object and the delete operation permanently remove the object from the database.
• legalForm - missing in the current version of the HealthFacility model (from the openimis-be-location_py module). That's why the current version of API doesn't cover that field. Attribute needs to be nullable type in the Database Schema.
• locationid - missing in the current version of the HealthFacility model (from the openimis-be-location_py module). That's why the current version of API doesn't cover that field. Attribute needs to be nullable type in the Database Sche

FHIR resource:

Location

Fields mapping:

Table legend:

Mapping:

Note:

• the tblHF has a relation with tblHFCatchment, the information from tblHFCatchment can be added as FHIR extensions (if needed)

Endpoint specification:

Example of endpoint URL:

http://127.0.0.1:8000/api_fhir/Location/

Supported HTTP operation:

• CREATE - used to create new FHIR Location (HF). List of supported fields can be found in the table which shows the mapping between OpenIMIS and FHIR. Should be used the POST HTTP method and the body as JSON representation (example can be found below).

  Note:

  • the `offline` model attribute isn't currently covered by the current API. By the default value is False (can be modified by the module configuration).

  • the `care_type` model attribute isn't currently covered by the current API. By the default value is "B" - both (can be modified by the module configuration).

  • the `validity_from` attribute is set as the current value of date when the object is created

  • the `audit_user_id` - the user which interact with the FHIR API is the `TechnicalUser` (Backend security - Models and Concepts) which hasn't representation in tblUsers. That's why the value of the `audit_user_id` attribute is set based on the following algorithm:
    1) Try to get that value from the 'auditUserId' query parameter

    2) If missing get that value then use the value from the module configuration (by default 1)

• READ - by default return list of all available resources. To fetch information about a specific object you should add the primary key to URL for instance:
  http://127.0.0.1:8000/api_fhir/Location/01DB0819-69F6-44F9-BF3D-0BCC5D4803E2
  , where "01DB0819-69F6-44F9-BF3D-0BCC5D4803E2" 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://127.0.0.1:8000/api_fhir/Location/01DB0819-69F6-44F9-BF3D-0BCC5D4803E2
  , where "01DB0819-69F6-44F9-BF3D-0BCC5D4803E2" is the value of the primary key.
  Note:
  
  • the `offline` model attribute isn't updated
  • the `care_type` model attribute isn't updated
  • 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 specific object from the database. 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://127.0.0.1:8000/api_fhir/Location/01DB0819-69F6-44F9-BF3D-0BCC5D4803E2
  , where "01DB0819-69F6-44F9-BF3D-0BCC5D4803E2" is the value of the primary key.
  Note:
  - the DELETE operation will permanently remove the row from the database

Module configuration used by the endpoint: 

Example JSON representation of content:

{
    "resourceType": "Location",
    "address": {
        "text": "HfAddress",
        "type": "physical",
        "use": "home"
    },
    "id": "72CE44C0-5D33-4452-BAD2-ECD6CA6A0DFF",
    "identifier": [
        {
            "type": {
                "coding": [
                    {
                        "code": "ACSN",
                        "system": "https://hl7.org/fhir/valueset-identifier-type.html"
                    }
                ]
            },
            "use": "usual",
            "value": "72CE44C0-5D33-4452-BAD2-ECD6CA6A0DFF"
        },
        {
            "type": {
                "coding": [
                    {
                        "code": "FI",
                        "system": "https://hl7.org/fhir/valueset-identifier-type.html"
                    }
                ]
            },
            "use": "usual",
            "value": "hfcode"
        }
    ],
    "name": "hfName",
    "telecom": [
        {
            "system": "phone",
            "use": "home",
            "value": "hfPhone"
        },
        {
            "system": "fax",
            "use": "home",
            "value": "hfFax"
        },
        {
            "system": "email",
            "use": "home",
            "value": "hfMail"
        }
    ],
    "type": {
        "coding": [
            {
                "code": "PC",
                "system": "https://www.hl7.org/fhir/STU3/v3/ServiceDeliveryLocationRoleType/vs.html"
            }
        ]
    }
}