Introduction
This page documents the implementation of the FHIR Location resource (DSTU2) for the OpenMRS FHIR Module.
- The FHIR Location Resource provides information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.
- For more information on the FHIR Location resource, please refer http://hl7-fhir.github.io/location.html
Populating the FHIR Location Resource
Shown below is how attributes of the FHIR Location Resource map to the attributes of the OpenMRS Location object. The left side of the relationship indicates the OpenMRS attribute; the right indicates the FHIR Location resource mapping.
Integer uuid :: n/a - goes in the URL e.g. [base]/Location/[locationId] String name :: Location.name String description :: Location.description String address1 :: Address.line String address2 :: Address.line String cityVillage :: Address.city String stateProvince :: Address.state String country :: Address.country String postalCode ::Address.zip String latitude :: Location.position.longitude String longitude :: Location.position.latitude String countyDistrict :: not mapped String address3 :: Address.line String address4 :: Address.line String address6 :: Address.line String address5 :: Address.line Location parentLocation :: Location.partOf Set<Location> childLocations :: not mapped
Example FHIR Location Resource
Shown below is a fleshed out FHIR Location Resource.
{ "resourceType": "Location", "id": "a846f32f-5401-4d53-871a-68354c22c3f9", "name": "South Wing, second floor", "description": "Second floor of the Old South Wing, formerly in use by Psychiatry", "address": { "use": "work", "line": [ "Galapagosweg 91, Building A","line 3", "line 4", "line 5" ], "city": "Den Burg", "postalCode": "9105 PZ", "country": "NLD", "state":"southern" }, "position": { "longitude": -83.6945691, "latitude": 42.25475478, }, "partOf": { "reference": "Location/c0937d4f-1691-11df-97a5-7038c432aabf" "display": "Mosoriot Hospital" }, "status": "active" }
Available RESTful web services for the Location Resource supported by the API
GET Requests
Read (GET Request) | |
---|---|
URL | Description |
/ws/fhir/Location/{id} | Returns a FHIR Location resource identified by a Location UUID Outcomes:
|
Search (GET Request) | |
/ws/fhir/Location?_id={id} | Search locations by given id |
/ws/fhir/Location?status={value} | Search locations by given status value whether active or not |
/ws/fhir/Location?name={value} | Search locations by name |
Delete (DELETE Request) | |
/ws/fhir/Location/{id} | Will delete a location with given id |
PUT(Update Request) | |
/ws/fhir/Location/{id} or /ws/fhir/Location/ | Send location resource in PUT request body for given URI specified with resource Id will update existing resource while request going to URI which doesn't have a URI will create a resource. |
POST Requests
None to date