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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: Healthy Route Location

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:

• Refer to this Profile: Healthy Route Screening Visit, Healthy Route Retinal Imaging, Healthy Route Location and Healthy Route Study
• Examples for this Profile: General Out-patient Clinic and Renal Clinic

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Location		0..*	Location	Details and position information for a place
Location.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Location.contained		0..*	Resource	Contained, inline Resources
Location.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Location.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
Location.name	S This element must be supported. Σ This element is included in summaries.	1..1	string	Name of the location as used by humans
Location.mode	S This element must be supported. Σ This element is included in summaries.	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
Location.type	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Kind of clinic Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
Location.address	S This element must be supported.	0..1	Address	Physical location
Location.managingOrganization	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(Healthy Route Organization)	Organization responsible for provisioning and upkeep
Location.partOf	S This element must be supported.	0..1	Reference(Healthy Route Location)	Another Location this one is physically a part of
Documentation for this format

Terminology Bindings

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.4

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from Location

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Location		0..*	Location	Details and position information for a place
Location.status	S This element must be supported.	1..1	code	active | suspended | inactive
Location.name	S This element must be supported.	1..1	string	Name of the location as used by humans
Location.mode	S This element must be supported.	1..1	code	instance | kind Required Pattern: instance
Location.type	S This element must be supported.	0..*	CodeableConcept	Kind of clinic
Location.address	S This element must be supported.	0..1	Address	Physical location
Location.managingOrganization	S This element must be supported.	1..1	Reference(Healthy Route Organization)	Organization responsible for provisioning and upkeep
Location.partOf	S This element must be supported.	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: Bindings Constraints Obligations
Location		0..*	Location	Details and position information for a place
Location.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Location.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Location.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Location.language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
Location.text		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
Location.contained		0..*	Resource	Contained, inline Resources
Location.extension		0..*	Extension	Additional content defined by implementations
Location.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Location.identifier	Σ This element is included in summaries.	0..*	Identifier	Unique code or number identifying the location to its users
Location.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
Location.operationalStatus	Σ This element is included in summaries.	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).
Location.name	S This element must be supported. Σ This element is included in summaries.	1..1	string	Name of the location as used by humans
Location.alias		0..*	string	A list of alternate names that the location is known as, or was known as, in the past
Location.description	Σ This element is included in summaries.	0..1	markdown	Additional details about the location that could be displayed as further information to identify the location beyond its name
Location.mode	S This element must be supported. Σ This element is included in summaries.	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
Location.type	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Kind of clinic Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
Location.contact		0..*	ExtendedContactDetail	Official contact details for the location
Location.address	S This element must be supported.	0..1	Address	Physical location
Location.form	Σ This element is included in summaries.	0..1	CodeableConcept	Physical form of the location Binding: LocationForm (example): Physical form of the location.
Location.position		0..1	BackboneElement	The absolute geographic location
Location.position.id		0..1	string	Unique id for inter-element referencing
Location.position.extension		0..*	Extension	Additional content defined by implementations
Location.position.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Location.position.longitude		1..1	decimal	Longitude with WGS84 datum
Location.position.latitude		1..1	decimal	Latitude with WGS84 datum
Location.position.altitude		0..1	decimal	Altitude with WGS84 datum
Location.managingOrganization	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(Healthy Route Organization)	Organization responsible for provisioning and upkeep
Location.partOf	S This element must be supported.	0..1	Reference(Healthy Route Location)	Another Location this one is physically a part of
Location.characteristic		0..*	CodeableConcept	Collection of characteristics (attributes) Binding: LocationCharacteristic (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
Location.hoursOfOperation		0..*	Availability	What days/times during a week is this location usually open (including exceptions)
Location.virtualService		0..*	VirtualServiceDetail	Connection details of a virtual service (e.g. conference call)
Location.endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the location
Documentation for this format

Terminology Bindings

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.4
Location.mode	Base	required	Location Mode	📍5.0.0	FHIR Std.
Location.type	Base	extensible	ServiceDeliveryLocationRoleType	📦3.0.0	THO v7.4
Location.form	Base	example	Location Form	📍5.0.0	FHIR Std.
Location.characteristic	Base	example	Location Characteristic	📍5.0.0	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from Location

Summary

Mandatory: 4 elements
Must-Support: 7 elements

Structures

This structure refers to these other structures:

• Healthy Route Organization (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-organization)
• Healthy Route Location (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-location)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Location		0..*	Location	Details and position information for a place
Location.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Location.contained		0..*	Resource	Contained, inline Resources
Location.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Location.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
Location.name	S This element must be supported. Σ This element is included in summaries.	1..1	string	Name of the location as used by humans
Location.mode	S This element must be supported. Σ This element is included in summaries.	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
Location.type	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Kind of clinic Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
Location.address	S This element must be supported.	0..1	Address	Physical location
Location.managingOrganization	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(Healthy Route Organization)	Organization responsible for provisioning and upkeep
Location.partOf	S This element must be supported.	0..1	Reference(Healthy Route Location)	Another Location this one is physically a part of
Documentation for this format

Terminology Bindings

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.4

Constraints

Id

Grade

Path(s)

Description

Expression

Differential View

This structure is derived from Location

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Location		0..*	Location	Details and position information for a place
Location.status	S This element must be supported.	1..1	code	active | suspended | inactive
Location.name	S This element must be supported.	1..1	string	Name of the location as used by humans
Location.mode	S This element must be supported.	1..1	code	instance | kind Required Pattern: instance
Location.type	S This element must be supported.	0..*	CodeableConcept	Kind of clinic
Location.address	S This element must be supported.	0..1	Address	Physical location
Location.managingOrganization	S This element must be supported.	1..1	Reference(Healthy Route Organization)	Organization responsible for provisioning and upkeep
Location.partOf	S This element must be supported.	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: Bindings Constraints Obligations
Location		0..*	Location	Details and position information for a place
Location.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Location.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Location.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Location.language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
Location.text		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
Location.contained		0..*	Resource	Contained, inline Resources
Location.extension		0..*	Extension	Additional content defined by implementations
Location.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Location.identifier	Σ This element is included in summaries.	0..*	Identifier	Unique code or number identifying the location to its users
Location.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
Location.operationalStatus	Σ This element is included in summaries.	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).
Location.name	S This element must be supported. Σ This element is included in summaries.	1..1	string	Name of the location as used by humans
Location.alias		0..*	string	A list of alternate names that the location is known as, or was known as, in the past
Location.description	Σ This element is included in summaries.	0..1	markdown	Additional details about the location that could be displayed as further information to identify the location beyond its name
Location.mode	S This element must be supported. Σ This element is included in summaries.	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
Location.type	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Kind of clinic Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
Location.contact		0..*	ExtendedContactDetail	Official contact details for the location
Location.address	S This element must be supported.	0..1	Address	Physical location
Location.form	Σ This element is included in summaries.	0..1	CodeableConcept	Physical form of the location Binding: LocationForm (example): Physical form of the location.
Location.position		0..1	BackboneElement	The absolute geographic location
Location.position.id		0..1	string	Unique id for inter-element referencing
Location.position.extension		0..*	Extension	Additional content defined by implementations
Location.position.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Location.position.longitude		1..1	decimal	Longitude with WGS84 datum
Location.position.latitude		1..1	decimal	Latitude with WGS84 datum
Location.position.altitude		0..1	decimal	Altitude with WGS84 datum
Location.managingOrganization	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(Healthy Route Organization)	Organization responsible for provisioning and upkeep
Location.partOf	S This element must be supported.	0..1	Reference(Healthy Route Location)	Another Location this one is physically a part of
Location.characteristic		0..*	CodeableConcept	Collection of characteristics (attributes) Binding: LocationCharacteristic (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
Location.hoursOfOperation		0..*	Availability	What days/times during a week is this location usually open (including exceptions)
Location.virtualService		0..*	VirtualServiceDetail	Connection details of a virtual service (e.g. conference call)
Location.endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the location
Documentation for this format

Terminology Bindings

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.4
Location.mode	Base	required	Location Mode	📍5.0.0	FHIR Std.
Location.type	Base	extensible	ServiceDeliveryLocationRoleType	📦3.0.0	THO v7.4
Location.form	Base	example	Location Form	📍5.0.0	FHIR Std.
Location.characteristic	Base	example	Location Characteristic	📍5.0.0	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from Location

Summary

Mandatory: 4 elements
Must-Support: 7 elements

Structures

This structure refers to these other structures:

• Healthy Route Organization (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-organization)
• Healthy Route Location (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-location)

Other representations of profile: CSV, Excel, Schematron