Healthy Route Implementation Guide
0.1.0 - ci-build
Healthy Route Implementation Guide, published by Savannah Informatics. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/savannahghi/healthy-route-ig/ and changes regularly. See the Directory of published versions
| Official URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-location | Version: 0.1.0 | |||
| Draft as of 2026-09-04 | Computable Name: HRLocation | |||
A clinic within a study site, where participants are approached.
Records where a participant was approached, which the protocols make a property of the recruitment rather than an incidental detail. Both protocols recruit from the general out-patient, hypertension, diabetes and renal clinics of their sites, and a cohort drawn mostly from a renal clinic is not the same cohort as one drawn mostly from general out-patients even when both come from the same hospital.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Location | Details and position information for a place | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!SΣ | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
![]() ![]() |
SΣ | 1..1 | string | Name of the location as used by humans |
![]() ![]() |
SΣ | 1..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. Required Pattern: instance |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Kind of clinic Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. |
![]() ![]() |
S | 0..1 | Address | Physical location |
![]() ![]() |
SΣ | 1..1 | Reference(Healthy Route Organization) | Organization responsible for provisioning and upkeep |
![]() ![]() |
S | 0..1 | Reference(Healthy Route Location) | Another Location this one is physically a part of |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Location.status | Base | required | Location Status | 📍5.0.0 | FHIR Std. |
| Location.mode | Base | required | Location Mode | 📍5.0.0 | FHIR Std. |
| Location.type | Base | extensible | ServiceDeliveryLocationRoleType | 📦3.0.0 | THO v7.3 |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Location
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Location | Details and position information for a place | |
![]() ![]() |
S | 1..1 | code | active | suspended | inactive |
![]() ![]() |
S | 1..1 | string | Name of the location as used by humans |
![]() ![]() |
S | 1..1 | code | instance | kind Required Pattern: instance |
![]() ![]() |
S | 0..* | CodeableConcept | Kind of clinic |
![]() ![]() |
S | 0..1 | Address | Physical location |
![]() ![]() |
S | 1..1 | Reference(Healthy Route Organization) | Organization responsible for provisioning and upkeep |
![]() ![]() |
S | 0..1 | Reference(Healthy Route Location) | Another Location this one is physically a part of |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Location | Details and position information for a place | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Unique code or number identifying the location to its users | ||||
![]() ![]() |
?!SΣ | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. | ||||
![]() ![]() |
Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room). | ||||
![]() ![]() |
SΣ | 1..1 | string | Name of the location as used by humans | ||||
![]() ![]() |
0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |||||
![]() ![]() |
Σ | 0..1 | markdown | Additional details about the location that could be displayed as further information to identify the location beyond its name | ||||
![]() ![]() |
SΣ | 1..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. Required Pattern: instance | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Kind of clinic Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. | ||||
![]() ![]() |
0..* | ExtendedContactDetail | Official contact details for the location | |||||
![]() ![]() |
S | 0..1 | Address | Physical location | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationForm (example): Physical form of the location. | ||||
![]() ![]() |
0..1 | BackboneElement | The absolute geographic location | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | decimal | Longitude with WGS84 datum | |||||
![]() ![]() ![]() |
1..1 | decimal | Latitude with WGS84 datum | |||||
![]() ![]() ![]() |
0..1 | decimal | Altitude with WGS84 datum | |||||
![]() ![]() |
SΣ | 1..1 | Reference(Healthy Route Organization) | Organization responsible for provisioning and upkeep | ||||
![]() ![]() |
S | 0..1 | Reference(Healthy Route Location) | Another Location this one is physically a part of | ||||
![]() ![]() |
0..* | CodeableConcept | Collection of characteristics (attributes) Binding: LocationCharacteristic (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | |||||
![]() ![]() |
0..* | Availability | What days/times during a week is this location usually open (including exceptions) | |||||
![]() ![]() |
0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |||||
![]() ![]() |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Location.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Location.status | Base | required | Location Status | 📍5.0.0 | FHIR Std. |
| Location.operationalStatus | Base | preferred | hl7VS-bedStatus | 📦3.0.0 | THO v7.3 |
| Location.mode | Base | required | Location Mode | 📍5.0.0 | FHIR Std. |
| Location.type | Base | extensible | ServiceDeliveryLocationRoleType | 📦3.0.0 | THO v7.3 |
| Location.form | Base | example | Location Form | 📍5.0.0 | FHIR Std. |
| Location.characteristic | Base | example | Location Characteristic | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Location
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Location | Details and position information for a place | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!SΣ | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
![]() ![]() |
SΣ | 1..1 | string | Name of the location as used by humans |
![]() ![]() |
SΣ | 1..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. Required Pattern: instance |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Kind of clinic Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. |
![]() ![]() |
S | 0..1 | Address | Physical location |
![]() ![]() |
SΣ | 1..1 | Reference(Healthy Route Organization) | Organization responsible for provisioning and upkeep |
![]() ![]() |
S | 0..1 | Reference(Healthy Route Location) | Another Location this one is physically a part of |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Location.status | Base | required | Location Status | 📍5.0.0 | FHIR Std. |
| Location.mode | Base | required | Location Mode | 📍5.0.0 | FHIR Std. |
| Location.type | Base | extensible | ServiceDeliveryLocationRoleType | 📦3.0.0 | THO v7.3 |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from Location
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Location | Details and position information for a place | |
![]() ![]() |
S | 1..1 | code | active | suspended | inactive |
![]() ![]() |
S | 1..1 | string | Name of the location as used by humans |
![]() ![]() |
S | 1..1 | code | instance | kind Required Pattern: instance |
![]() ![]() |
S | 0..* | CodeableConcept | Kind of clinic |
![]() ![]() |
S | 0..1 | Address | Physical location |
![]() ![]() |
S | 1..1 | Reference(Healthy Route Organization) | Organization responsible for provisioning and upkeep |
![]() ![]() |
S | 0..1 | Reference(Healthy Route Location) | Another Location this one is physically a part of |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Location | Details and position information for a place | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Unique code or number identifying the location to its users | ||||
![]() ![]() |
?!SΣ | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. | ||||
![]() ![]() |
Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room). | ||||
![]() ![]() |
SΣ | 1..1 | string | Name of the location as used by humans | ||||
![]() ![]() |
0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |||||
![]() ![]() |
Σ | 0..1 | markdown | Additional details about the location that could be displayed as further information to identify the location beyond its name | ||||
![]() ![]() |
SΣ | 1..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. Required Pattern: instance | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Kind of clinic Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. | ||||
![]() ![]() |
0..* | ExtendedContactDetail | Official contact details for the location | |||||
![]() ![]() |
S | 0..1 | Address | Physical location | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationForm (example): Physical form of the location. | ||||
![]() ![]() |
0..1 | BackboneElement | The absolute geographic location | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | decimal | Longitude with WGS84 datum | |||||
![]() ![]() ![]() |
1..1 | decimal | Latitude with WGS84 datum | |||||
![]() ![]() ![]() |
0..1 | decimal | Altitude with WGS84 datum | |||||
![]() ![]() |
SΣ | 1..1 | Reference(Healthy Route Organization) | Organization responsible for provisioning and upkeep | ||||
![]() ![]() |
S | 0..1 | Reference(Healthy Route Location) | Another Location this one is physically a part of | ||||
![]() ![]() |
0..* | CodeableConcept | Collection of characteristics (attributes) Binding: LocationCharacteristic (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | |||||
![]() ![]() |
0..* | Availability | What days/times during a week is this location usually open (including exceptions) | |||||
![]() ![]() |
0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |||||
![]() ![]() |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Location.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Location.status | Base | required | Location Status | 📍5.0.0 | FHIR Std. |
| Location.operationalStatus | Base | preferred | hl7VS-bedStatus | 📦3.0.0 | THO v7.3 |
| Location.mode | Base | required | Location Mode | 📍5.0.0 | FHIR Std. |
| Location.type | Base | extensible | ServiceDeliveryLocationRoleType | 📦3.0.0 | THO v7.3 |
| Location.form | Base | example | Location Form | 📍5.0.0 | FHIR Std. |
| Location.characteristic | Base | example | Location Characteristic | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Location
Other representations of profile: CSV, Excel, Schematron