FHIR R4 Resource - Medication
openIMIS tables mapped - tblItems
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 |
amount | tblItems.ItemPackage | integer part: 1000, 100, etc If not possible to split then keep only form field | mapped |
unitPrice | tblItems.ItemPrice | mapped as Money | mapped |
Other information might be required to map from tblItems through extensions based on future requirements.
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 |
---|---|---|
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":{ }, |
R4_fhir_issue_type_config | configuration of system and codes used to represent the specific types of operation outcome | "R4_fhir_issue_type_config":{ |
Example JSON representation of content:
{ "resourceType": "Medication", "amount": 1000, "code": { "coding": [ { "code": "0001" } ], "text": "ACETYLSALICYLIC ACID (ASPIRIN) TABS 300MG" }, "extension": [ { "valueUnitPrice": 10.0 } ], "form": "TABLETS", "id": "71EFB78B-64EE-4A68-BE29-87DAF566EB20", "identifier": [ { "type": { "coding": [ { "code": "ACSN", "system": "https://hl7.org/fhir/valueset-identifier-type.html" } ] }, "use": "usual", "value": "71EFB78B-64EE-4A68-BE29-87DAF566EB20" }, { "type": { "coding": [ { "code": "ACSN", "system": "https://hl7.org/fhir/valueset-identifier-type.html" } ] }, "use": "usual", "value": "0001" } ] } |