openIMIS tables - tblHF

Mapping Overview Table

FHIR R4 field	openIMIS field	Notes	mapping status

FHIR R4 field	openIMIS field	Notes	mapping status
identifier	tblHF.HfId / tblHF.HFCode / tblHF.HfUUID	Reference to FHIR HealthcareService from other resources is done through UUID field	mapped
name	tblHF.HFName		mapped
category	tblHF.HFLevel	type.coding contains one of ['H', ‘C', 'D'] type.text is one of ['hospital’, ‘hospital center’, ‘dispensary’]	mapped
type	tblHF.HFCareType	type.coding contains one of ['I', ‘O', 'B'] type.text is one of ['in-patient’, ‘out-patient’, ‘both’]	mapped
specialty	tblHF.HFSublevel	link to tblHFSublevel: coding.code as HFSublevel (id) text as HFSublevelDesc	mapped
location	tblHF.LocationId	reference to Location/UUID	mapped
extraDetails	tblHF.HFAddress		mapped
telecom	tblHF.Phone / tblHF.Fax / tblHF.eMail	telecom field contains values that are being mapped for Phone, Fax and Email fields	mapped
program	tblHF.LegalForm	link to tblLegalForms: coding.code as LegalFormCode (id) text as LegalForms	mapped
coverageArea	list of [reference tblLocation]	all tblLocations->tblHFCatchment->tblHF with ValidityTo=null	mapped

Search capabilities

Search by HF Code

You can search a Location or HF based on code by using the identifier query parameter:

http://localhost:8000/api_fhir_r4/HealthcareService?identifier=[HFCode]

Endpoint specification:

Example of endpoint URL:

http://localhost:8000/api_fhir_R4/HealthcareService/

Supported HTTP operation:

POST - not available
GET - by default return list of all available resources. To fetch information about a specific object you should add the UUID key to URL for instance:
http://localhost:8000/api_fhir_r4/HealthcareService/[UUID]
UPDATE - not available
DELETE - not available

Module configuration used by the endpoint:

Configuration key	Description	Default value

Configuration key	Description	Default value
default_audit_user_id	default value which will be used for 'audit_user_id' field	"default_audit_user_id": 1,
R4_fhir_identifier_type_config	configuration of system and codes used to represent the specific types of identifiers	"R4_fhir_identifier_type_config":{ "system":"https://hl7.org/fhir/valueset-identifier-type.html", "fhir_code_for_imis_db_uuid_type":"UUID", "fhir_code_for_imis_db_id_type":"ACSN", "fhir_code_for_imis_chfid_type":"SB", "fhir_code_for_imis_passport_type":"PPN", "fhir_code_for_imis_facility_id_type":"FI", "fhir_code_for_imis_claim_admin_code_type":"FILL", "fhir_code_for_imis_claim_code_type":"MR", "fhir_code_for_imis_location_code_type":"LC", "fhir_code_for_imis_diagnosis_code_type":"DC", "fhir_code_for_imis_item_code_type":"IC", "fhir_code_for_imis_service_code_type":"SC" },
R4_fhir_location_role_type	configuration of system and codes used to represent the specific types of location role	"R4_fhir_location_role_type":{ "system":"https://hl7.org/fhir/v3/ServiceDeliveryLocationRoleType/vs.html", "fhir_code_for_hospital":"H", "fhir_code_for_dispensary":"D", "fhir_code_for_health_center":"C", },
R4_fhir_hf_service_type	configuration of system and codes used to represent the specific types of services	"R4_fhir_hf_service_type":{ "system":"http://hl7.org/fhir/valueset-service-type.html", "fhir_code_for_in_patient":"I", "fhir_code_for_out_patient":"O", "fhir_code_for_both":"B", },
default_value_of_HF_offline_attribute	default value for 'offline' attribute used for creating new HF object	"default_value_of_location_offline_attribute": False,
default_value_of_HF_care_type	default value for 'care_type' attribute used for creating new HF object	"default_value_of_location_care_type": "B"

Example JSON representation of content:

{
    "resourceType": "HealthcareService",
    "category": [
        {
            "coding": [
                {
                    "code": "H",
                    "system": "http://hl7.org/fhir/v3/ServiceDeliveryLocationRoleType/vs.html"
                }
            ],
            "text": "Hospital"
        }
    ],
    "coverageArea": [
        {
            "reference": "Location/BEE392F1-07D8-482F-B601-6C8BBA0BF2A9"
        },
        {
            "reference": "Location/7D0E1238-F0DA-43D0-A0AF-FE3B344284CA"
        }
    ],
    "extraDetails": {
        "text": "Lantern Road 21\r\nP.O.Box 3425",
        "type": "physical",
        "use": "home"
    },
    "id": "FABA2038-0E24-4557-B1BD-08584C48FA0D",
    "identifier": [
        {
            "type": {
                "coding": [
                    {
                        "code": "UUID",
                        "system": "https://hl7.org/fhir/valueset-identifier-type.html"
                    }
                ]
            },
            "use": "usual",
            "value": "FABA2038-0E24-4557-B1BD-08584C48FA0D"
        },
        {
            "type": {
                "coding": [
                    {
                        "code": "FI",
                        "system": "https://hl7.org/fhir/valueset-identifier-type.html"
                    }
                ]
            },
            "use": "usual",
            "value": "JMHOS001"
        }
    ],
    "location": [
        {
            "reference": "Location/C341D6E0-6E86-4259-AEA4-6C90449B85EE"
        }
    ],
    "name": "Jambero District Hospital",
    "program": [
        {
            "coding": [
                {
                    "code": "G"
                }
            ],
            "text": "Government"
        }
    ],
    "type": [
        {
            "coding": [
                {
                    "code": "B",
                    "system": "http://hl7.org/fhir/valueset-service-type.html"
                }
            ],
            "text": "Both"
        }
    ]
}

openIMIS

FHIR R4 - HealthcareService

Mapping Overview Table

Search capabilities

Search by HF Code

Endpoint specification:

Example of endpoint URL:

Supported HTTP operation:

Module configuration used by the endpoint:

Example JSON representation of content:

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

Please contact our Service Desk