FHIR R4 Resource - ActivityDefinition

openIMIS tables mapped - tblServices

FHIR R4 field	openIMIS field	notes	mapping status

FHIR R4 field	openIMIS field	notes	mapping status
identifier	tblServices.ServiceID / tblServices.ServiceUUID / tblServices.ServCode		mapped
status	string “active”	mandatory => only valid services are managed	mapped
date	tblServices.ValidityFrom	the last date changed	mapped
name	tblServices.ServCode	the code of the medical service.	mapped
title	tblServices.ServName	the name of the medical service.	mapped
useContext.code	one of [“gender”, “age”, “workflow”, “venue”]	see UsageContext	mapped
useContext.valueCodeableConcept.text	one of: tblServices.ServPatCat decomposed in “gender” and “age” tblServices.ServCategory for “workflow” code tblServices.ServCareType for “venue” code	if multiple values per code then duplicate the code for each value: ex. service available for man and women “gender” code “gender” and “age” codes can be found twice tblServices.ServPatCat is binary codded: Kids8+Adults4+Womens*2+Mens	mapped
topic	tblServices.ServType	extension for DefinitionTopic	mapped
code	tblServices.ServCode and tblServices.ServName	can replace name and title	mapped
frequency	tblServices.ServFrequency	mapped as extension.valueInteger: integer	mapped
unitPrice	tblServices.ServPrice	mapped as extension.valueMoney: Money	mapped

Other information might be required to map from tblServices through extensions based on future requirements.

Endpoint specification:

Example of endpoint URL:

http://localhost:8000/api_fhir_r4/ActivityDefinition

Supported HTTP operation:

POST - the operation currently not supported
Used to create a new medical service. List of supported fields can be found in the table which shows the mapping between openIMIS and FHIR. The body as JSON representation.
The response is:
- OperationOutcome which notice about the failure (list of possible errors);
- ActivityDefinition resource created (includes the generated IDs);
GET - by default return list of all available ActivityDefinition (medical services).
To fetch information about a specific object you should add the Service UUID to URL for instance:
http://localhost:8000/api_fhir_r4/ActivityDefinition/{ServiceUUID}
To search for an ActivityDefinition (service) resource based on ServiceCode, use query variable ‘identifier’ with the ServiceCode code value:
http://localhost:8000/api_fhir_r4/ActivityDefinition?identifier={ServiceCode}
PUT - the operation currently not supported
Used to update an ActivityDefinition (medical service).
DELETE - the operation currently not supported
Used to delete an ActivityDefinition (medical service).

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_issue_type_config	configuration of system and codes used to represent the specific types of operation outcome	"R4_fhir_issue_type_config":{ "fhir_code_for_exception":"exception", "fhir_code_for_not_found":"not-found", "fhir_code_for_informational":"informational" },

Example JSON representation of content:

{
    "resourceType": "ActivityDefinition",
    "date": "2017-01-01T00:00:00",
    "extension": [
        {
            "url": "unitPrice",
            "valueMoney": {
                "currency": "$",
                "value": 21000.0
            }
        },
        {
            "url": "frequency",
            "valueInteger": 0
        }
    ],
    "id": "503DBA38-D28C-4FCC-BC3B-EA912982911B",
    "identifier": [
        {
            "type": {
                "coding": [
                    {
                        "code": "UUID",
                        "system": "https://hl7.org/fhir/valueset-identifier-type.html"
                    }
                ]
            },
            "use": "usual",
            "value": "503DBA38-D28C-4FCC-BC3B-EA912982911B"
        },
        {
            "type": {
                "coding": [
                    {
                        "code": "SC",
                        "system": "https://hl7.org/fhir/valueset-identifier-type.html"
                    }
                ]
            },
            "use": "usual",
            "value": "M1"
        }
    ],
    "name": "M1",
    "status": "active",
    "title": "OBG Cervical Cerclage - Shrodikar",
    "topic": [
        {
            "coding": [
                {
                    "code": "DefinitionTopic",
                    "system": "http://terminology.hl7.org/CodeSystem/definition-topic"
                }
            ],
            "text": "C"
        }
    ],
    "useContext": [
        {
            "code": {
                "code": "useContextGender"
            },
            "valueCodeableConcept": {
                "coding": [
                    {
                        "code": "F",
                        "display": "Female"
                    }
                ],
                "text": "Male or Female"
            }
        },
        {
            "code": {
                "code": "useContextAge"
            },
            "valueCodeableConcept": {
                "coding": [
                    {
                        "code": "A",
                        "display": "Adult"
                    },
                    {
                        "code": "K",
                        "display": "Kid"
                    }
                ],
                "text": "Adult or Kid"
            }
        },
        {
            "code": {
                "code": "useContextWorkflow"
            },
            "valueCodeableConcept": {
                "coding": [
                    {
                        "code": "S",
                        "display": "Surgery"
                    }
                ],
                "text": "Workflow Setting"
            }
        },
        {
            "code": {
                "code": "useContextVenue"
            },
            "valueCodeableConcept": {
                "coding": [
                    {
                        "code": "B",
                        "display": "Both"
                    }
                ],
                "text": "Clinical Venue"
            }
        }
    ]
}

openIMIS

FHIR R4 - ActivityDefinition

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