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 Screening Visit

The single visit at which a participant is screened, measured and photographed, or one dated part of it.

Groups everything collected from one participant on one occasion, and records where it happened. The clinic a participant was seen in is a source of spectrum variation that has to survive to analysis, and it is a property of the visit rather than of the participant.

Usages:

• Refer to this Profile: Healthy Route Blood Pressure, Healthy Route Reported Condition, Healthy Route Laboratory Report, Healthy Route Screening Visit... Show 4 more, Healthy Route Retinal Imaging, Healthy Route Reported Medicine, Healthy Route Measurement and Healthy Route Investigation Request
• Examples for this Profile: Encounter/ExampleImagingEncounter, Encounter/ExampleSamplesEncounter and Encounter/ExampleScreeningVisit

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
Encounter		0..*	Encounter	An interaction during which services are provided to the patient
Encounter.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
Encounter.contained		0..*	Resource	Contained, inline Resources
Encounter.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for extension.extension:tenant	S This element must be supported.	1..1	Identifier	Owning site tenant URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant
Encounter.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Encounter.identifier	S This element must be supported. Σ This element is included in summaries.	0..*	Identifier	Identifier(s) by which this encounter is known
Encounter.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter.
Encounter.class	S This element must be supported. Σ This element is included in summaries.	1..*	CodeableConcept	Classification of patient encounter context - e.g. Inpatient, outpatient Binding: Encounter class (preferred): Classification of the encounter.
Encounter.type	S This element must be supported. Σ This element is included in summaries.	1..*	CodeableConcept	The visit, or which part of it Binding: Visit Part Value Set (required)
Encounter.subject	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(Healthy Route Patient)	The patient or group related to this encounter
Encounter.subjectStatus	S This element must be supported.	0..1	CodeableConcept	The current status of the subject in relation to the Encounter Binding: EncounterSubjectStatus (example): Current status of the subject within the encounter.
Encounter.partOf	S This element must be supported.	0..1	Reference(Healthy Route Screening Visit)	The visit this part belongs to
Encounter.serviceProvider	S This element must be supported.	1..1	Reference(Healthy Route Organization)	The organization (facility) responsible for this encounter
Encounter.participant	S This element must be supported. Σ This element is included in summaries. C	0..*	BackboneElement	Study team members present Constraints: enc-1, enc-2
Encounter.participant.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.participant.type	Σ This element is included in summaries. C	0..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.participant.actor	Σ This element is included in summaries. C	0..1	Reference(Healthy Route Practitioner | Healthy Route Patient)	The individual, device, or service participating in the encounter
Encounter.actualPeriod	S This element must be supported.	1..1	Period	When the visit happened
Encounter.location	S This element must be supported.	0..*	BackboneElement	List of locations where the patient has been
Encounter.location.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.location.location		1..1	Reference(Healthy Route Location)	Location the encounter takes place
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Encounter.status	Base	required	Encounter Status	📍5.0.0	FHIR Std.
Encounter.class	Base	preferred	Encounter class	📦2.0.1	THO v7.4
Encounter.type	Base	required	Visit Part Value Set	📦0.1.0	This IG
Encounter.subjectStatus	Base	example	Encounter Subject Status	📍5.0.0	FHIR Std.
Encounter.participant.​type	Base	extensible	Participant Type	📍5.0.0	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from Encounter

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	Encounter	An interaction during which services are provided to the patient
Encounter.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for extension.extension:tenant	S This element must be supported.	1..1	Identifier	Owning site tenant URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant
Encounter.identifier	S This element must be supported.	0..*	Identifier	Identifier(s) by which this encounter is known
Encounter.status	S This element must be supported.	1..1	code	planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
Encounter.class	S This element must be supported.	1..*	CodeableConcept	Classification of patient encounter context - e.g. Inpatient, outpatient
Encounter.type	S This element must be supported.	1..*	CodeableConcept	The visit, or which part of it Binding: Visit Part Value Set (required)
Encounter.subject	S This element must be supported.	1..1	Reference(Healthy Route Patient)	The patient or group related to this encounter
Encounter.subjectStatus	S This element must be supported.	0..1	CodeableConcept	The current status of the subject in relation to the Encounter
Encounter.partOf	S This element must be supported.	0..1	Reference(Healthy Route Screening Visit)	The visit this part belongs to
Encounter.serviceProvider	S This element must be supported.	1..1	Reference(Healthy Route Organization)	The organization (facility) responsible for this encounter
Encounter.participant	S This element must be supported.	0..*	BackboneElement	Study team members present
Encounter.participant.actor		0..1	Reference(Healthy Route Practitioner | Healthy Route Patient)	The individual, device, or service participating in the encounter
Encounter.actualPeriod	S This element must be supported.	1..1	Period	When the visit happened
Encounter.location	S This element must be supported.	0..*	BackboneElement	List of locations where the patient has been
Encounter.location.location		1..1	Reference(Healthy Route Location)	Location the encounter takes place
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Encounter.type	Base	required	Visit Part Value Set	📦0.1.0	This IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	Encounter	An interaction during which services are provided to the patient
Encounter.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Encounter.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Encounter.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
Encounter.language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
Encounter.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
Encounter.contained		0..*	Resource	Contained, inline Resources
Encounter.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for extension.extension:tenant	S This element must be supported.	1..1	Identifier	Owning site tenant URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant
Encounter.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Encounter.identifier	S This element must be supported. Σ This element is included in summaries.	0..*	Identifier	Identifier(s) by which this encounter is known
Encounter.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter.
Encounter.class	S This element must be supported. Σ This element is included in summaries.	1..*	CodeableConcept	Classification of patient encounter context - e.g. Inpatient, outpatient Binding: Encounter class (preferred): Classification of the encounter.
Encounter.priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
Encounter.type	S This element must be supported. Σ This element is included in summaries.	1..*	CodeableConcept	The visit, or which part of it Binding: Visit Part Value Set (required)
Encounter.serviceType	Σ This element is included in summaries.	0..*	CodeableReference(HealthcareService)	Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
Encounter.subject	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(Healthy Route Patient)	The patient or group related to this encounter
Encounter.subjectStatus	S This element must be supported.	0..1	CodeableConcept	The current status of the subject in relation to the Encounter Binding: EncounterSubjectStatus (example): Current status of the subject within the encounter.
Encounter.episodeOfCare	Σ This element is included in summaries.	0..*	Reference(EpisodeOfCare)	Episode(s) of care that this encounter should be recorded against
Encounter.basedOn		0..*	Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest)	The request that initiated this encounter
Encounter.careTeam		0..*	Reference(CareTeam)	The group(s) that are allocated to participate in this encounter
Encounter.partOf	S This element must be supported.	0..1	Reference(Healthy Route Screening Visit)	The visit this part belongs to
Encounter.serviceProvider	S This element must be supported.	1..1	Reference(Healthy Route Organization)	The organization (facility) responsible for this encounter
Encounter.participant	S This element must be supported. Σ This element is included in summaries. C	0..*	BackboneElement	Study team members present Constraints: enc-1, enc-2
Encounter.participant.id		0..1	string	Unique id for inter-element referencing
Encounter.participant.extension		0..*	Extension	Additional content defined by implementations
Encounter.participant.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.participant.type	Σ This element is included in summaries. C	0..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.participant.period		0..1	Period	Period of time during the encounter that the participant participated
Encounter.participant.actor	Σ This element is included in summaries. C	0..1	Reference(Healthy Route Practitioner | Healthy Route Patient)	The individual, device, or service participating in the encounter
Encounter.appointment	Σ This element is included in summaries.	0..*	Reference(Appointment)	The appointment that scheduled this encounter
Encounter.virtualService		0..*	VirtualServiceDetail	Connection details of a virtual service (e.g. conference call)
Encounter.actualPeriod	S This element must be supported.	1..1	Period	When the visit happened
Encounter.plannedStartDate		0..1	dateTime	The planned start date/time (or admission date) of the encounter
Encounter.plannedEndDate		0..1	dateTime	The planned end date/time (or discharge date) of the encounter
Encounter.length		0..1	Duration	Actual quantity of time the encounter lasted (less time absent)
Encounter.reason	Σ This element is included in summaries.	0..*	BackboneElement	The list of medical reasons that are expected to be addressed during the episode of care
Encounter.reason.id		0..1	string	Unique id for inter-element referencing
Encounter.reason.extension		0..*	Extension	Additional content defined by implementations
Encounter.reason.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.reason.use	Σ This element is included in summaries.	0..*	CodeableConcept	What the reason value should be used for/as Binding: EncounterReasonUse (example)
Encounter.reason.value	Σ This element is included in summaries.	0..*	CodeableReference(Condition | DiagnosticReport | Observation | ImmunizationRecommendation | Procedure)	Reason the encounter takes place (core or reference) Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
Encounter.diagnosis	Σ This element is included in summaries.	0..*	BackboneElement	The list of diagnosis relevant to this encounter
Encounter.diagnosis.id		0..1	string	Unique id for inter-element referencing
Encounter.diagnosis.extension		0..*	Extension	Additional content defined by implementations
Encounter.diagnosis.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.diagnosis.condition	Σ This element is included in summaries.	0..*	CodeableReference(Condition)	The diagnosis relevant to the encounter Binding: ConditionProblemDiagnosisCodes (example)
Encounter.diagnosis.use		0..*	CodeableConcept	Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: EncounterDiagnosisUse (preferred): The type of diagnosis this condition represents.
Encounter.account		0..*	Reference(Account)	The set of accounts that may be used for billing for this Encounter
Encounter.dietPreference		0..*	CodeableConcept	Diet preferences reported by the patient Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements.
Encounter.specialArrangement		0..*	CodeableConcept	Wheelchair, translator, stretcher, etc Binding: SpecialArrangements (preferred): Special arrangements.
Encounter.specialCourtesy		0..*	CodeableConcept	Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
Encounter.admission		0..1	BackboneElement	Details about the admission to a healthcare service
Encounter.admission.id		0..1	string	Unique id for inter-element referencing
Encounter.admission.extension		0..*	Extension	Additional content defined by implementations
Encounter.admission.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.admission.preAdmissionIdentifier		0..1	Identifier	Pre-admission identifier
Encounter.admission.origin		0..1	Reference(Location | Organization)	The location/organization from which the patient came before admission
Encounter.admission.admitSource		0..1	CodeableConcept	From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted.
Encounter.admission.reAdmission		0..1	CodeableConcept	Indicates that the patient is being re-admitted Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this admission encounter.
Encounter.admission.destination		0..1	Reference(Location | Organization)	Location/organization to which the patient is discharged
Encounter.admission.dischargeDisposition		0..1	CodeableConcept	Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition.
Encounter.location	S This element must be supported.	0..*	BackboneElement	List of locations where the patient has been
Encounter.location.id		0..1	string	Unique id for inter-element referencing
Encounter.location.extension		0..*	Extension	Additional content defined by implementations
Encounter.location.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.location.location		1..1	Reference(Healthy Route Location)	Location the encounter takes place
Encounter.location.status		0..1	code	planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.
Encounter.location.form		0..1	CodeableConcept	The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.) Binding: LocationForm (example): Physical form of the location.
Encounter.location.period		0..1	Period	Time period during which the patient was present at the location
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Encounter.language	Base	required	All Languages	📍5.0.0	FHIR Std.
Encounter.status	Base	required	Encounter Status	📍5.0.0	FHIR Std.
Encounter.class	Base	preferred	Encounter class	📦2.0.1	THO v7.4
Encounter.priority	Base	example	ActPriority	📦3.0.0	THO v7.4
Encounter.type	Base	required	Visit Part Value Set	📦0.1.0	This IG
Encounter.serviceType	Base	example	Service Type	📍5.0.0	FHIR Std.
Encounter.subjectStatus	Base	example	Encounter Subject Status	📍5.0.0	FHIR Std.
Encounter.participant.​type	Base	extensible	Participant Type	📍5.0.0	FHIR Std.
Encounter.reason.use	Base	example	Encounter Reason Use	📍5.0.0	FHIR Std.
Encounter.reason.value	Base	preferred	Encounter Reason Codes	📍5.0.0	FHIR Std.
Encounter.diagnosis.​condition	Base	example	Condition/Problem/Diagnosis Codes	📍5.0.0	FHIR Std.
Encounter.diagnosis.​use	Base	preferred	Encounter Diagnosis Use	📍5.0.0	FHIR Std.
Encounter.dietPreference	Base	example	Diet	📍5.0.0	FHIR Std.
Encounter.specialArrangement	Base	preferred	Special Arrangements	📍5.0.0	FHIR Std.
Encounter.specialCourtesy	Base	preferred	Special Courtesy	📍5.0.0	FHIR Std.
Encounter.admission.​admitSource	Base	preferred	Admit Source	📍5.0.0	FHIR Std.
Encounter.admission.​reAdmission	Base	example	hl7VS-re-admissionIndicator	📦3.0.0	THO v7.4
Encounter.admission.​dischargeDisposition	Base	example	Discharge Disposition	📍5.0.0	FHIR Std.
Encounter.location.status	Base	required	Encounter Location Status	📍5.0.0	FHIR Std.
Encounter.location.form	Base	example	Location Form	📍5.0.0	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from Encounter

Summary

Mandatory: 7 elements
Must-Support: 12 elements

Structures

This structure refers to these other structures:

• Healthy Route Patient (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-patient)
• Healthy Route Screening Visit (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-encounter)
• Healthy Route Organization (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-organization)
• Healthy Route Practitioner (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-practitioner)
• Healthy Route Location (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-location)

Extensions

This structure refers to these extensions:

• https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	Encounter	An interaction during which services are provided to the patient
Encounter.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
Encounter.contained		0..*	Resource	Contained, inline Resources
Encounter.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for extension.extension:tenant	S This element must be supported.	1..1	Identifier	Owning site tenant URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant
Encounter.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Encounter.identifier	S This element must be supported. Σ This element is included in summaries.	0..*	Identifier	Identifier(s) by which this encounter is known
Encounter.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter.
Encounter.class	S This element must be supported. Σ This element is included in summaries.	1..*	CodeableConcept	Classification of patient encounter context - e.g. Inpatient, outpatient Binding: Encounter class (preferred): Classification of the encounter.
Encounter.type	S This element must be supported. Σ This element is included in summaries.	1..*	CodeableConcept	The visit, or which part of it Binding: Visit Part Value Set (required)
Encounter.subject	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(Healthy Route Patient)	The patient or group related to this encounter
Encounter.subjectStatus	S This element must be supported.	0..1	CodeableConcept	The current status of the subject in relation to the Encounter Binding: EncounterSubjectStatus (example): Current status of the subject within the encounter.
Encounter.partOf	S This element must be supported.	0..1	Reference(Healthy Route Screening Visit)	The visit this part belongs to
Encounter.serviceProvider	S This element must be supported.	1..1	Reference(Healthy Route Organization)	The organization (facility) responsible for this encounter
Encounter.participant	S This element must be supported. Σ This element is included in summaries. C	0..*	BackboneElement	Study team members present Constraints: enc-1, enc-2
Encounter.participant.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.participant.type	Σ This element is included in summaries. C	0..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.participant.actor	Σ This element is included in summaries. C	0..1	Reference(Healthy Route Practitioner | Healthy Route Patient)	The individual, device, or service participating in the encounter
Encounter.actualPeriod	S This element must be supported.	1..1	Period	When the visit happened
Encounter.location	S This element must be supported.	0..*	BackboneElement	List of locations where the patient has been
Encounter.location.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.location.location		1..1	Reference(Healthy Route Location)	Location the encounter takes place
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Encounter.status	Base	required	Encounter Status	📍5.0.0	FHIR Std.
Encounter.class	Base	preferred	Encounter class	📦2.0.1	THO v7.4
Encounter.type	Base	required	Visit Part Value Set	📦0.1.0	This IG
Encounter.subjectStatus	Base	example	Encounter Subject Status	📍5.0.0	FHIR Std.
Encounter.participant.​type	Base	extensible	Participant Type	📍5.0.0	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

Differential View

This structure is derived from Encounter

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	Encounter	An interaction during which services are provided to the patient
Encounter.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for extension.extension:tenant	S This element must be supported.	1..1	Identifier	Owning site tenant URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant
Encounter.identifier	S This element must be supported.	0..*	Identifier	Identifier(s) by which this encounter is known
Encounter.status	S This element must be supported.	1..1	code	planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
Encounter.class	S This element must be supported.	1..*	CodeableConcept	Classification of patient encounter context - e.g. Inpatient, outpatient
Encounter.type	S This element must be supported.	1..*	CodeableConcept	The visit, or which part of it Binding: Visit Part Value Set (required)
Encounter.subject	S This element must be supported.	1..1	Reference(Healthy Route Patient)	The patient or group related to this encounter
Encounter.subjectStatus	S This element must be supported.	0..1	CodeableConcept	The current status of the subject in relation to the Encounter
Encounter.partOf	S This element must be supported.	0..1	Reference(Healthy Route Screening Visit)	The visit this part belongs to
Encounter.serviceProvider	S This element must be supported.	1..1	Reference(Healthy Route Organization)	The organization (facility) responsible for this encounter
Encounter.participant	S This element must be supported.	0..*	BackboneElement	Study team members present
Encounter.participant.actor		0..1	Reference(Healthy Route Practitioner | Healthy Route Patient)	The individual, device, or service participating in the encounter
Encounter.actualPeriod	S This element must be supported.	1..1	Period	When the visit happened
Encounter.location	S This element must be supported.	0..*	BackboneElement	List of locations where the patient has been
Encounter.location.location		1..1	Reference(Healthy Route Location)	Location the encounter takes place
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Encounter.type	Base	required	Visit Part Value Set	📦0.1.0	This IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	Encounter	An interaction during which services are provided to the patient
Encounter.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Encounter.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Encounter.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
Encounter.language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
Encounter.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
Encounter.contained		0..*	Resource	Contained, inline Resources
Encounter.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for extension.extension:tenant	S This element must be supported.	1..1	Identifier	Owning site tenant URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant
Encounter.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Encounter.identifier	S This element must be supported. Σ This element is included in summaries.	0..*	Identifier	Identifier(s) by which this encounter is known
Encounter.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter.
Encounter.class	S This element must be supported. Σ This element is included in summaries.	1..*	CodeableConcept	Classification of patient encounter context - e.g. Inpatient, outpatient Binding: Encounter class (preferred): Classification of the encounter.
Encounter.priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
Encounter.type	S This element must be supported. Σ This element is included in summaries.	1..*	CodeableConcept	The visit, or which part of it Binding: Visit Part Value Set (required)
Encounter.serviceType	Σ This element is included in summaries.	0..*	CodeableReference(HealthcareService)	Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
Encounter.subject	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(Healthy Route Patient)	The patient or group related to this encounter
Encounter.subjectStatus	S This element must be supported.	0..1	CodeableConcept	The current status of the subject in relation to the Encounter Binding: EncounterSubjectStatus (example): Current status of the subject within the encounter.
Encounter.episodeOfCare	Σ This element is included in summaries.	0..*	Reference(EpisodeOfCare)	Episode(s) of care that this encounter should be recorded against
Encounter.basedOn		0..*	Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest)	The request that initiated this encounter
Encounter.careTeam		0..*	Reference(CareTeam)	The group(s) that are allocated to participate in this encounter
Encounter.partOf	S This element must be supported.	0..1	Reference(Healthy Route Screening Visit)	The visit this part belongs to
Encounter.serviceProvider	S This element must be supported.	1..1	Reference(Healthy Route Organization)	The organization (facility) responsible for this encounter
Encounter.participant	S This element must be supported. Σ This element is included in summaries. C	0..*	BackboneElement	Study team members present Constraints: enc-1, enc-2
Encounter.participant.id		0..1	string	Unique id for inter-element referencing
Encounter.participant.extension		0..*	Extension	Additional content defined by implementations
Encounter.participant.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.participant.type	Σ This element is included in summaries. C	0..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.participant.period		0..1	Period	Period of time during the encounter that the participant participated
Encounter.participant.actor	Σ This element is included in summaries. C	0..1	Reference(Healthy Route Practitioner | Healthy Route Patient)	The individual, device, or service participating in the encounter
Encounter.appointment	Σ This element is included in summaries.	0..*	Reference(Appointment)	The appointment that scheduled this encounter
Encounter.virtualService		0..*	VirtualServiceDetail	Connection details of a virtual service (e.g. conference call)
Encounter.actualPeriod	S This element must be supported.	1..1	Period	When the visit happened
Encounter.plannedStartDate		0..1	dateTime	The planned start date/time (or admission date) of the encounter
Encounter.plannedEndDate		0..1	dateTime	The planned end date/time (or discharge date) of the encounter
Encounter.length		0..1	Duration	Actual quantity of time the encounter lasted (less time absent)
Encounter.reason	Σ This element is included in summaries.	0..*	BackboneElement	The list of medical reasons that are expected to be addressed during the episode of care
Encounter.reason.id		0..1	string	Unique id for inter-element referencing
Encounter.reason.extension		0..*	Extension	Additional content defined by implementations
Encounter.reason.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.reason.use	Σ This element is included in summaries.	0..*	CodeableConcept	What the reason value should be used for/as Binding: EncounterReasonUse (example)
Encounter.reason.value	Σ This element is included in summaries.	0..*	CodeableReference(Condition | DiagnosticReport | Observation | ImmunizationRecommendation | Procedure)	Reason the encounter takes place (core or reference) Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
Encounter.diagnosis	Σ This element is included in summaries.	0..*	BackboneElement	The list of diagnosis relevant to this encounter
Encounter.diagnosis.id		0..1	string	Unique id for inter-element referencing
Encounter.diagnosis.extension		0..*	Extension	Additional content defined by implementations
Encounter.diagnosis.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.diagnosis.condition	Σ This element is included in summaries.	0..*	CodeableReference(Condition)	The diagnosis relevant to the encounter Binding: ConditionProblemDiagnosisCodes (example)
Encounter.diagnosis.use		0..*	CodeableConcept	Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: EncounterDiagnosisUse (preferred): The type of diagnosis this condition represents.
Encounter.account		0..*	Reference(Account)	The set of accounts that may be used for billing for this Encounter
Encounter.dietPreference		0..*	CodeableConcept	Diet preferences reported by the patient Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements.
Encounter.specialArrangement		0..*	CodeableConcept	Wheelchair, translator, stretcher, etc Binding: SpecialArrangements (preferred): Special arrangements.
Encounter.specialCourtesy		0..*	CodeableConcept	Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
Encounter.admission		0..1	BackboneElement	Details about the admission to a healthcare service
Encounter.admission.id		0..1	string	Unique id for inter-element referencing
Encounter.admission.extension		0..*	Extension	Additional content defined by implementations
Encounter.admission.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.admission.preAdmissionIdentifier		0..1	Identifier	Pre-admission identifier
Encounter.admission.origin		0..1	Reference(Location | Organization)	The location/organization from which the patient came before admission
Encounter.admission.admitSource		0..1	CodeableConcept	From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted.
Encounter.admission.reAdmission		0..1	CodeableConcept	Indicates that the patient is being re-admitted Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this admission encounter.
Encounter.admission.destination		0..1	Reference(Location | Organization)	Location/organization to which the patient is discharged
Encounter.admission.dischargeDisposition		0..1	CodeableConcept	Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition.
Encounter.location	S This element must be supported.	0..*	BackboneElement	List of locations where the patient has been
Encounter.location.id		0..1	string	Unique id for inter-element referencing
Encounter.location.extension		0..*	Extension	Additional content defined by implementations
Encounter.location.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.location.location		1..1	Reference(Healthy Route Location)	Location the encounter takes place
Encounter.location.status		0..1	code	planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.
Encounter.location.form		0..1	CodeableConcept	The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.) Binding: LocationForm (example): Physical form of the location.
Encounter.location.period		0..1	Period	Time period during which the patient was present at the location
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Encounter.language	Base	required	All Languages	📍5.0.0	FHIR Std.
Encounter.status	Base	required	Encounter Status	📍5.0.0	FHIR Std.
Encounter.class	Base	preferred	Encounter class	📦2.0.1	THO v7.4
Encounter.priority	Base	example	ActPriority	📦3.0.0	THO v7.4
Encounter.type	Base	required	Visit Part Value Set	📦0.1.0	This IG
Encounter.serviceType	Base	example	Service Type	📍5.0.0	FHIR Std.
Encounter.subjectStatus	Base	example	Encounter Subject Status	📍5.0.0	FHIR Std.
Encounter.participant.​type	Base	extensible	Participant Type	📍5.0.0	FHIR Std.
Encounter.reason.use	Base	example	Encounter Reason Use	📍5.0.0	FHIR Std.
Encounter.reason.value	Base	preferred	Encounter Reason Codes	📍5.0.0	FHIR Std.
Encounter.diagnosis.​condition	Base	example	Condition/Problem/Diagnosis Codes	📍5.0.0	FHIR Std.
Encounter.diagnosis.​use	Base	preferred	Encounter Diagnosis Use	📍5.0.0	FHIR Std.
Encounter.dietPreference	Base	example	Diet	📍5.0.0	FHIR Std.
Encounter.specialArrangement	Base	preferred	Special Arrangements	📍5.0.0	FHIR Std.
Encounter.specialCourtesy	Base	preferred	Special Courtesy	📍5.0.0	FHIR Std.
Encounter.admission.​admitSource	Base	preferred	Admit Source	📍5.0.0	FHIR Std.
Encounter.admission.​reAdmission	Base	example	hl7VS-re-admissionIndicator	📦3.0.0	THO v7.4
Encounter.admission.​dischargeDisposition	Base	example	Discharge Disposition	📍5.0.0	FHIR Std.
Encounter.location.status	Base	required	Encounter Location Status	📍5.0.0	FHIR Std.
Encounter.location.form	Base	example	Location Form	📍5.0.0	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from Encounter

Summary

Mandatory: 7 elements
Must-Support: 12 elements

Structures

This structure refers to these other structures:

• Healthy Route Patient (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-patient)
• Healthy Route Screening Visit (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-encounter)
• Healthy Route Organization (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-organization)
• Healthy Route Practitioner (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-practitioner)
• Healthy Route Location (https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-location)

Extensions

This structure refers to these extensions:

• https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant

Other representations of profile: CSV, Excel, Schematron