Description

The openIMIS Family object (from the openimis-be-insuree_py module) is mapped to the FHIR R4 Group resource.

Mapping

FHIR R4 Resource - Group

openIMIS tables mapped - tblFamilies, tblInsuree

FHIR R4 field	openIMIS field	Notes	Mapping status
identifier	tblFamilies.FamilyUUID		mapped
type	static value = “person”	required	mapped
actual	static value = True	required	mapped
name	tblFamilies.InsureeID → tblInsuree.LastName	name field contains values that are being mapped for head of the family’s LastName	mapped
quantity	SUM(tblInsuree.FamilyID == tblFamilies.FamilyID)	count of Group.member list	mapped
member		list of family members	mapped
member.entity	tblInsuree.InsureeUUID where tblInsuree.FamilyID == tblFamilies.FamilyID	reference/Patient/UUID	mapped
member.inactive	static value = False	preparation for Insuree status feature	mapped

Endpoint specification

Example of endpoint URL

http://localhost:8000/api_fhir_r4/Group/

Supported HTTP operation

READ - GET HTTP method

By default, returns the list of all available Group resources. To fetch information about a specific object, you should add the UUID (e.g. 01DB0819-69F6-44F9-BF3D-0BCC5D4803E2) key to URL :

http://localhost:8000/api_fhir_r4/Group/01DB0819-69F6-44F9-BF3D-0BCC5D4803E2

Should be used the GET HTTP method.

PUT - the operation currently not supported
DELETE - the operation currently not supported

Module configuration used by the endpoint:

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" }

Example JSON representation of content:

{
    "resourceType": "Group",
    "id": "427d0e23-86e6-4530-8945-94cc1b0a2a6d",
    "identifier": [
        {
            "type": {
                "coding": [
                    {
                        "code": "UUID",
                        "system": "https://hl7.org/fhir/valueset-identifier-type.html"
                    }
                ]
            },
            "use": "usual",
            "value": "427d0e23-86e6-4530-8945-94cc1b0a2a6d"
        }
    ],
    "type" : "person", 
    "actual" : true, 
    "name" : "Duby", 
    "quantity" : 3, 
    "member" : [
        { 
            "entity" : { 
                "reference": "Patient/fe60343b-8f31-45bd-87ab-1df11efa4493"
            },
            "inactive" : False 
        },
        { 
            "entity" : { 
                "reference": "Patient/3e391896-89d5-4152-a0a4-2b2f858f89f7"
            },
            "inactive" : False 
        },
        { 
            "entity" : { 
                "reference": "Patient/e680ab4c-6a16-48a5-89d2-2c0225b02e24"
            },
            "inactive" : False 
        },
    ],
}