FHIR R4 Resource - HealthcareServiceActivityDefinition
openIMIS tables mapped - tblServices
FHIR R4 field | openIMIS field | notes | mapping status |
|---|---|---|---|
identifier | tblServices.ServiceID / tblServices.ServiceUUID / tblServices.ServCode | not mapped | |
status | string “active” | mandatory => only valid services are managed | not mapped |
date | tblServices.ValidityFrom | the last date changed | not mapped |
name | tblServices.ServCode | the code of the medical service. | not mapped |
title | tblServices.ServName | the name of the medical service. | not mapped |
useContext.code | one of [“gender”, “age”, “workflow”, “venue”] | see UsageContext | not mapped |
useContext.valueCodeableConcept.text | one of:
| if multiple values per code then duplicate the code for each value: ex. service available for man and women “gender” code | not mapped |
topic | tblServices.ServType | extension for DefinitionTopic | not mapped |
code | tblServices.ServCode and tblServices.ServName | can replace name and title | not mapped |
unitPrice | tblServices.ServPrice | mapped as Money | not 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 |
|---|---|---|
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:
As in the other resources there is an error and therefore this file is shown.
{
"resourceType": "OperationOutcome",
"issue": [
{
"code": "exception",
"details": {
"text": "Missing `resourceType` attribute"
},
"severity": "fatal"
}
]
}
|