FHIR R4 Resource - HealthcareService
openIMIS tables - tblHF
Mapping Overview Table
FHIR R4 field | openIMIS field | Notes | mapping status |
---|---|---|---|
tblHF.HfId / tblHF.HFCode / tblHF.HfUUID | Reference to FHIR HealthcareService from other resources is done through UUID field | mapped | |
tblHF.HFName | mapped | ||
tblHF.HFLevel | type.coding contains one of ['H', ‘C', 'D'] type.text is one of ['hospital’, ‘hospital center’, ‘dispensary’] | mapped | |
tblHF.HFCareType | type.coding contains one of ['I', ‘O', 'B'] type.text is one of ['in-patient’, ‘out-patient’, ‘both’] | mapped | |
tblHF.HFSublevel | link to tblHFSublevel:
| mapped | |
tblHF.LocationId | reference to Location/UUID | mapped | |
tblHF.HFAddress | mapped | ||
tblHF.Phone / tblHF.Fax / tblHF.eMail | telecom field contains values that are being mapped for Phone, Fax and Email fields | mapped | |
tblHF.LegalForm | link to tblLegalForms:
| mapped | |
[reference tblLocation] | all tblLocations->tblHFCatchment->tblHF with ValidityTo=null | mapped |
Search capabilities
Search by HF Code
You can search a Location or HF based on code by using the identifier
query parameter:
http://localhost:8000/api_fhir_R4/HealthcareService?identifier=[HFCode]
Endpoint specification:
Example of endpoint URL:
http://localhost:8000/api_fhir_R4/HealthcareService/
Supported HTTP operation:
POST - not available
GET - by default return list of all available resources. To fetch information about a specific object you should add the UUID key to URL for instance:
http://localhost:8000/api_fhir_R4/HealthcareService/[UUID]
UPDATE - not available
DELETE - not available
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_location_role_type | configuration of system and codes used to represent the specific types of location role | "R4_fhir_location_role_type":{ |
R4_fhir_hf_service_type | configuration of system and codes used to represent the specific types of services | "R4_fhir_hf_service_type":{ |
default_value_of_HF_offline_attribute | default value for 'offline' attribute used for creating new HF object | "default_value_of_location_offline_attribute": False, |
default_value_of_HF_care_type | default value for 'care_type' attribute used for creating new HF object | "default_value_of_location_care_type": "B" |
Example JSON representation of content:
{ "resourceType": "HealthcareService", "category": [ { "coding": [ { "code": "HOSP", "system": "http://hl7.org/fhir/v3/ServiceDeliveryLocationRoleType/vs.html" } ], "text": "hospital" } ], "coverageArea": [ { "reference": "Location/BEE392F1-07D8-482F-B601-6C8BBA0BF2A9" }, { "reference": "Location/7D0E1238-F0DA-43D0-A0AF-FE3B344284CA" } ], "extraDetails": { "text": "Lantern Road 21\r\nP.O.Box 3425", "type": "physical", "use": "home" }, "id": "FABA2038-0E24-4557-B1BD-08584C48FA0D", "identifier": [ { "type": { "coding": [ { "code": "UUID", "system": "https://hl7.org/fhir/valueset-identifier-type.html" } ] }, "use": "usual", "value": "FABA2038-0E24-4557-B1BD-08584C48FA0D" }, { "type": { "coding": [ { "code": "FI", "system": "https://hl7.org/fhir/valueset-identifier-type.html" } ] }, "use": "usual", "value": "JMHOS001" } ], "location": [ { "reference": "Location/C341D6E0-6E86-4259-AEA4-6C90449B85EE" } ], "name": "Jambero District Hospital", "program": [ { "coding": [ { "code": "G" } ], "text": "Government" } ], "type": [ { "coding": [ { "code": "B", "system": "http://hl7.org/fhir/valueset-service-type.html" } ], "text": "both" } ] } |