FHIR R4 Resource - Medication

openIMIS tables mapped - tblItems

FHIR R4 field	openIMIS field	notes	mapping status

FHIR R4 field	openIMIS field	notes	mapping status
identifier	tblItems.ItemID / tblItems.ItemUUID / tblItems.ItemCode		mapped
code.coding	tblItems.ItemCode	The code of the medication. Duplicated in identifier.	mapped
code.text	tblItems.ItemName	The name of the medication.	mapped
form	tblItems.ItemPackage	string part: “tables”, “pieces”, etc.	mapped as whole package
amount	tblItems.ItemPackage	integer part: 1000, 100, etc If not possible to split then keep only form field ItemPackage was not split because not all notations in the demo database are uniformly entered. For instance row 145 and 151. Also there are some misspellings like in row 43.	not mapped but possible see notes
frequency	tblItems.ItemFrequency	mapped as extension.valueInteger: integer	mapped
extension.unitPrice	tblItems.ItemPrice	mapped as Money openIMIS extension to Medication url=unitPrice, valueMoney.value as tblItems.ItemPrice valueMoney.currency to be identified	mapped
extension.useContext.code	one of [“gender”, “age”, “venue”]	extension see UsageContext	mapped
extension.useContext.valueCodeableConcept.text	one of: tblItems.ItemPatCat decomposed in “gender” and “age” tblItems.ItemCareType 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
extension.topic	tblItems.ItemType	extension for DefinitionTopic	mapped

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

{
    "resourceType": "Medication",
    "code": {
        "coding": [
            {
                "code": "0001"
            }
        ],
        "text": "ACETYLSALICYLIC ACID (ASPIRIN)  TABS 300MG"
    },
    "extension": [
        {
            "url": "unitPrice",
            "valueMoney": {
                "currency": "$",
                "value": 10.0
            }
        },
        {
            "url": "frequency",
            "valueInteger": 0
        },
        {
            "url": "topic",
            "valueCodeableConcept": {
                "coding": [
                    {
                        "code": "DefinitionTopic",
                        "system": "http://terminology.hl7.org/CodeSystem/definition-topic"
                    }
                ],
                "text": "D"
            }
        },
        {
            "url": "useContextGender",
            "valueUsageContext": {
                "code": {
                    "code": "gender"
                },
                "valueCodeableConcept": {
                    "coding": [
                        {
                            "code": "M",
                            "display": "Male"
                        },
                        {
                            "code": "F",
                            "display": "Female"
                        }
                    ],
                    "text": "Male or Female"
                }
            }
        },
        {
            "url": "useContextAge",
            "valueUsageContext": {
                "code": {
                    "code": "age"
                },
                "valueCodeableConcept": {
                    "coding": [
                        {
                            "code": "A",
                            "display": "Adult"
                        },
                        {
                            "code": "K",
                            "display": "Kid"
                        }
                    ],
                    "text": "Adult or Kid"
                }
            }
        },
        {
            "url": "useContextVenue",
            "valueUsageContext": {
                "code": {
                    "code": "venue"
                },
                "valueCodeableConcept": {
                    "coding": [
                        {
                            "code": "O",
                            "display": "Out-patient"
                        }
                    ],
                    "text": "Clinical Venue"
                }
            }
        }
    ],
    "form": {
        "coding": [
            {
                "code": "package"
            }
        ],
        "text": "1000 TABLETS"
    },
    "id": "92F1654E-290D-4BEE-93B8-2639685ACEB3",
    "identifier": [
        {
            "type": {
                "coding": [
                    {
                        "code": "UUID",
                        "system": "https://hl7.org/fhir/valueset-identifier-type.html"
                    }
                ]
            },
            "use": "usual",
            "value": "92F1654E-290D-4BEE-93B8-2639685ACEB3"
        },
        {
            "type": {
                "coding": [
                    {
                        "code": "IC",
                        "system": "https://hl7.org/fhir/valueset-identifier-type.html"
                    }
                ]
            },
            "use": "usual",
            "value": "0001"
        }
    ]
}

Endpoint specification:

Example of endpoint URL:

http://localhost:8000/api_fhir_r4/Medication

Supported HTTP operation:

POST - the operation currently not supported
Used to create a new medication. 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);
- Medication resource created (includes the generated IDs)
GET - by default return list of all available Medication (medical items).
To fetch information about a specific object you should add the ItemUUID to URL for instance:
http://localhost:8000/api_fhir_r4/Medication/{ItemUUID}
To search for a Medication resource based on ItemCode, use query variable ‘identifier’ with the ItemCode code value:
http://localhost:8000/api_fhir_r4/Medication?identifier={ItemCode}
PUT - the operation currently not supported
Used to update a Medication (medical item).
DELETE - the operation currently not supported
Used to delete a Medication (medical item).

All references to a Medication resource (ex. from Claim) should be coded as Medication/{ItemUUID}.

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

openIMIS

FHIR R4 - Medication

Endpoint specification:

Example of endpoint URL:

Supported HTTP operation:

Module configuration used by the endpoint:

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

Please contact our Service Desk