diff --git a/README.md b/README.md index b3d77f1..d5c4ef4 100755 --- a/README.md +++ b/README.md @@ -229,7 +229,7 @@ environment variables ### Run project -As document on the Info Gateway modules +As documented on the Info Gateway modules [section here](https://github.com/google/fhir-gateway#modules), the command to run is: @@ -346,6 +346,34 @@ Example: [GET] /LocationHierarchy?_id=&mode=list&_count=&_page=&_sort= ``` +##### LocationHierarchy Administrative Level Filters + +The LocationHierarchy endpoint supports filtering by administrative levels. This +is useful for querying locations at specific levels within the hierarchy. The +following search parameters are available: + +- `administrativeLevelMin`: Specifies the minimum administrative level to + include in the response. Locations at this level and above will be included. +- `administrativeLevelMax`: Specifies the maximum administrative level to + include in the response. Locations at this level and below will be included. + +Behavior based on parameters: + +- No Parameters Defined: The endpoint works as it does currently, returning the + full hierarchy. +- Only `administrativeLevelMin` Defined: The response will include all locations + from the specified minimum administrative level up to the root. +- Only `administrativeLevelMax` Defined: The response will include all locations + from the root down to the specified maximum administrative level. +- Both Parameters Defined: The response will include locations only within the + specified range of administrative levels. + +Example: + +``` +[GET] /LocationHierarchy?_id=&administrativeLevelMin=2&administrativeLevelMax=4&_count=&_page=&_sort= +``` + #### Important Note: Developers, please update your client applications accordingly to accommodate