Description
The openIMIS PolicyHolder object (from the openimis-be-policyholder_py module) is mapped to the FHIR R4 Group resource.
Mapping
FHIR R4 Resource - Organisation
openIMIS tables mapped - PolicyHolder
FHIR R4 field | openIMIS field | Notes | Mapping status |
|---|---|---|---|
mapped | |||
name | trade_name | required | mapped |
active | |||
alias | |||
type | |||
locations | locations | required | mapped |
address | address | required | mapped |
phone | phone | organisations contact phone | mapped |
fax | fax | organisation fax | mapped |
organisation email | mapped | ||
contact_name | contact_name | ||
legal_form | |||
activity_code | |||
accountancy_account | |||
bank_account | |||
payment_reference |
Endpoint specification
Example of endpoint URL
http://localhost:8000/api_fhir_r4/Organisation/
Supported HTTP operation
READ - GET HTTP method
By default, returns the list of all available Group resources. To fetch information about a specific object, you should add the UUID (e.g.02EEC-436C-495F-862U2-6FF68644D751) key to URL :
http://localhost:8000/api_fhir_r4/Organisation/02EEC-436C-495F-862U2-6FF68644D751
Should be used the GET HTTP method.
PUT - the operation currently supported
Updates the value of the specific object. List of supported fields can be found in the mapping table. Should be used the PUT HTTP method and the body as JSON representation (example can be found below). The requested URL needs to point to a specific object to do that you should add the UUID (e.g. 02EEC-436C-495F-862U2-6FF68644D751) key to URL for instance:
http://localhost:8000/api_fhir_r4/Organisation/02EEC-436C-495F-862U2-6FF68644D751
DELETE - the operation currently not supported
The operation can be used to remove the specific object from the database. Should be used the DELETE HTTP method. The requested URL needs to point to a specific object to do that you should add the UUID (e.g. 02EEC-436C-495F-862U2-6FF68644D751) key to URL for instance:
http://localhost:8000/api_fhir_r4/Organisation/02EEC-436C-495F-862U2-6FF68644D751
The DELETE operation will permanently remove the row from the database.
Example JSON representation of content:
{
"resourceType": "Organisation",
"address": [
{
"text": "5 Tsoka",
"type": "physical",
"use": "home"
}
],
"date_created": "1987-01-08",
"email":"davismutindi14@gmail.com",
"fax":"Fax",
"code":"SDFF-IK-3542",
"legal_form":"3240221",
"phone":"0791131347",
"accountancy_account":"1189209292993",
"bank_account":{
"bank":"IBAN",
"no":"PL00 0000 2345 0000 1000 2345 2345"
},
"identifier": [
{
"type": {
"coding": [
{
"code": "UUID",
"system": "https://hl7.org/fhir/valueset-identifier-type.html"
}
]
},
"use": "usual",
"value": "02EEC-436C-495F-862U2-6FF68644D751"
}
],
"name":"Organisation Test"
}
|