Get Health Care Facility

Owned by Wayne Naidoo (Unlicensed)
Last updated: Jun 22, 2012 by Ryan CrichtonVersion comment
2 min read

Query for a facility by ID.

Transaction Specification

URL: GET /ws/rest/v1/facility/$<fac-ID>

Description: Fetches a HC Facility’s data for the facility specified by the facility ID parameter.

Request

The GET request contains 1 required parameter in the URL for identification of the required facility.

Parameters

$<fac-ID>

The unique facility ID for the facility requested. This is usually fetched as part of a URL link from a query for facilities request.

Response

HTTP 200 - OK HTTP response body will contain the XML message defined below.

Data

See UC01.001MaintainHealthCareFacilities.doc

Message specification

The XML schema for the message can be found below:
See GetFacility.xsd

Error

HTTP 500 - Server Error - If the server encountered an error.

HTTP 400 - Bad Request - If the HL7 v2.5 message is malformed.

Orchestration

This section describes how this transaction is orchestrated through the HIM (interoperability layer) in order to complete this transaction.

  1. Call Get HC Facility

Sample Messaging Implementation

Scenario 1

Query for a facility by ID.

User Interface

TODO

Sample Request Message

GET https://hie.jembi.org:5000/ws/rest/v1/facility/999 HTTP/1.1

Sample Response Message

<facilityReport xsi:noNamespaceSchemaLocation="file:///C:/Users/Mead%20Walker/Documents/Global%20Aids%20Initiative/Kigali%20Meeting/RHEA%20Content/FacilitySchemas/SingleFacilityWithEdit.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <FOSAID>1234567890</FOSAID>
   <name>Kigali Health Clinic</name>
   <code>CS</code>
   <typeDescription>This is a placeholder for code = "oth"</typeDescription>
   <statusCode>1</statusCode>
   <dateOpened>
      <Year>2018</Year>
   </dateOpened>
   <categoryCode>4</categoryCode>
   <dateInaugurated>
      <Date>2003-10-23</Date>
   </dateInaugurated>
   <directorName>Robert Roosa</directorName>
   <directorNID>0987654321</directorNID>
   <directorEmail>DirKHC@moh.rw</directorEmail>
   <primaryReferralFacilityID>3334477889</primaryReferralFacilityID>
   <provinceCode>01</provinceCode>
   <districtCode>0102</districtCode>
   <sectorCode>010234</sectorCode>
   <cellCode>01023466</cellCode>
   <villageCode>0102346639</villageCode>
   <postOfficeBox>Box 3429</postOfficeBox>
   <email>KHCmainAccess@moh.rw</email>
   <streetName>Healthcare Lane</streetName>
   <streetNumber>3</streetNumber>
   <complement>Ground Floor</complement>
   <postalCode>3F34</postalCode>
   <countryCode>RW</countryCode>
   <latitude>23'3"</latitude>
   <longitude>29'4"</longitude>
   <cellularTelephone>345-444-2345</cellularTelephone>
   <businessTelephone>123-567-8901</businessTelephone>
   <targetPopulation>345200</targetPopulation>
   <yearpopulationEstimate>2007</yearpopulationEstimate>
   <catchmentAreaVillageCode>45678</catchmentAreaVillageCode>
   <catchmentAreaVillageCode>112</catchmentAreaVillageCode>
   <catchmentAreaVillageCode>Cxxxx</catchmentAreaVillageCode>
   <numberRooms>6</numberRooms>
   <numberPatientBeds>4</numberPatientBeds>
   <numberAmbulances>0</numberAmbulances>
   <numberCars>2</numberCars>
   <numberMotorcycles>3</numberMotorcycles>
   <electricitySourceCode>2</electricitySourceCode>
   <generatorKVA>350</generatorKVA>
   <waterSourceCode>7</waterSourceCode>
   <numberRefrigerators>1</numberRefrigerators>
   <numberComputers>3</numberComputers>
   <primaryInternetConnectionCode>1</primaryInternetConnectionCode>
   <secondaryInternetConnectionCode>2</secondaryInternetConnectionCode>
   <!--Additional field added-->
   <CFCode>123</CFCode>
   <CFSector>234</CFSector>
   <govtFosaCode>345</govtFosaCode>
   <PFBCode>432</PFBCode>
   <dateClosed/>
   <directorCellNumber>1234566789</directorCellNumber>
   <numberFunctioningComputers>3</numberFunctioningComputers>
   <dateModified/>
   <parentFOSAID/>
</facilityReport>