FHIR R4 Resource - Location

OpenIMIS openIMIS tables - tblHF, tblLocations

Mapping Overview Table

Search capabilities

Search by Location/HF Code

You can search a Location or HF based on code by using the identifier query parameter:

http://localhost:8000/api_fhir_R4/Location?identifier=[LocationCode|HFCode]

Search by Location Level

You can search all the locations or HFs based on level by using the physicaltype query parameter:

http://localhost:8000/api_fhir_R4/Location?physicaltype=[R|D|W|V|H]

Search all the children of a Location

You can search all the locations or HFs based on the parent location by using the partof query parameter:

http://localhost:8000/api_fhir_R4/Location?partof=[LocationUUID]

Endpoint specification:

Example of endpoint URL:

...

• CREATE - used to create new FHIR Location (HF). List of supported fields can be found in the table which shows the mapping between OpenIMIS openIMIS and FHIR. Should be used the POST HTTP method and the body as JSON representation (example can be found below).

  Note:

  • the `offline` model attribute isn't currently covered by the current API. By the default value is False (can be modified by the module configuration).

  • the `care_type` model attribute isn't currently covered by the current API. By the default value is "B" - both (can be modified by the module configuration).

  • the `validity_from` attribute is set as the current value of date when the object is created

  • the `audit_user_id` - the user which interact with the FHIR API is the `TechnicalUser` (Backend security - Models and Concepts) which hasn't representation in tblUsers. That's why the value of the `audit_user_id` attribute is set based on the following algorithm:
    1) Try to get that value from the 'auditUserId' query parameter

    2) If missing get that value then use the value from the module configuration (by default 1)

• READ - by default return list of all available resources. To fetch information about a specific object you should add the primary key to URL for instance:

  Code Block
  http://localhost:8000/api_fhir_R4/Location/

  1

  [UUID]

  , where "1UUID" is the value of the primary keyLocation/HF UUID field. Should be used the GET HTTP method.

• UPDATE - update the value of the specific object. List of supported fields can be found in the table which shows the mapping between OpenIMIS openIMIS and FHIR. 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 primary key to URL for instance:

  Code Block
  http://localhost:8000/api_fhir_R4/Location/

  1

  [UUID]

  , where "1UUID" is the value of the primary keyLocation/HF UUID field.
  Note:

  • the `offline` model attribute isn't updated

  • the `care_type` model attribute isn't updated

  • the UPDATE operation will update the specific row of the database and doesn't create the history of changes (like in the legacy OpenIMISopenIMIS)

• DELETE - 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 primary key to URL for instance:

  Code Block
  http://localhost:8000/api_fhir_R4/Location/

  1

  [UUID]

  , where "1UUID" is the value of the primary keyLocation/HF UUID field.
  Note:
  - the DELETE operation will permanently remove the row from the database

...

Example JSON representation of content:

{  
   "resourceType":"Location",
   "address":{  
      "text":"HfAddress",
      "type":"physical",
      "use":"home"
   },
   "identifier":[  
      {  
         "type":{  
            "coding":[  
               {  
                  "code":"ACSN",
                  "system":"https://hl7.org/fhir/valueset-identifier-type.html"
               }
            ]
         },
         "use":"usual",
         "value":"11"
      },
      {  
         "type":{  
            "coding":[  
               {  
                  "code":"FI",
                  "system":"https://hl7.org/fhir/valueset-identifier-type.html"
               }
            ]
         },
         "use":"usual",
         "value":"hfcode"
      }
   ],
   "name":"hfName",
   "telecom":[  
      {  
         "system":"phone",
         "use":"home",
         "value":"hfPhone"
      },
      {  
         "system":"fax",
         "use":"home",
         "value":"hfFax"
      },
      {  
         "system":"email",
         "use":"home",
         "value":"hfMail"
      }
   ],
   "type":{  
      "coding":[  
         {  
            "code":"PC",
            "system":"https://hl7.org/fhir/v3/ServiceDeliveryLocationRoleType/vs.html"
         }
      ]
   }
}