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
• XML
• JSON
• TTL

Resource Profile: Healthy Route Patient (Export)

A study participant in the form transferred out of a site tenant.

Defines the Patient content permitted to leave a tenant. Direct identifiers are constrained to a cardinality of 0..0 so that a resource containing them fails validation against this profile.

Usages:

• This Profile is not used by any profiles in this Specification

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
Patient		0..*	Patient	Information about an individual or animal receiving health care services
Patient.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
Patient.contained		0..*	Resource	Contained, inline Resources
Patient.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
Patient.Slices for extension.extension:ageYears	S This element must be supported.	1..1	integer	Age in completed years URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-age-years
Patient.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Patient.identifier	S This element must be supported. Σ This element is included in summaries.	1..1	Identifier	OptimalHealth participant identifier
Patient.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Required Pattern: https://fhir.savannahghi.org/sid/optimalhealth-participant
Patient.identifier.value	S This element must be supported. Σ This element is included in summaries. C	1..1	string	The value that is unique Example General: 123456
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.gender	S This element must be supported. Σ This element is included in summaries.	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.identifier.use	Base	required	IdentifierUse	📍5.0.0	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍5.0.0	FHIR Std.
Patient.link.type	Base	required	Link Type	📍5.0.0	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
Patient.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
Patient.Slices for extension.extension:ageYears	S This element must be supported.	1..1	integer	Age in completed years URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-age-years
Patient.identifier	S This element must be supported.	1..1	Identifier	OptimalHealth participant identifier
Patient.identifier.system	S This element must be supported.	1..1	uri	The namespace for the identifier value Required Pattern: https://fhir.savannahghi.org/sid/optimalhealth-participant
Patient.identifier.value	S This element must be supported.	1..1	string	The value that is unique
Patient.name		0..0		A name associated with the patient
Patient.telecom		0..0		A contact detail for the individual
Patient.gender	S This element must be supported.	1..1	code	male | female | other | unknown
Patient.birthDate		0..0		The date of birth for the individual
Patient.deceased[x]		0..0		Indicates if the individual is deceased or not
Patient.address		0..0		An address for the individual
Patient.photo		0..0		Image of the patient
Patient.contact		0..0		A contact party (e.g. guardian, partner, friend) for the patient
Patient.generalPractitioner		0..0		Patient's nominated primary care provider
Patient.link		0..0		Link to a Patient or RelatedPerson resource that concerns the same actual individual
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
Patient.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Patient.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Patient.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
Patient.language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
Patient.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
Patient.contained		0..*	Resource	Contained, inline Resources
Patient.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
Patient.Slices for extension.extension:ageYears	S This element must be supported.	1..1	integer	Age in completed years URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-age-years
Patient.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Patient.identifier	S This element must be supported. Σ This element is included in summaries.	1..1	Identifier	OptimalHealth participant identifier
Patient.identifier.id		0..1	id	Unique id for inter-element referencing
Patient.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.identifier.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Required Pattern: https://fhir.savannahghi.org/sid/optimalhealth-participant
Patient.identifier.value	S This element must be supported. Σ This element is included in summaries. C	1..1	string	The value that is unique Example General: 123456
Patient.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Patient.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.gender	S This element must be supported. Σ This element is included in summaries.	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x]		0..1		Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean			boolean
Patient.multipleBirth[x].multipleBirthInteger			integer
Patient.communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
Patient.communication.id		0..1	string	Unique id for inter-element referencing
Patient.communication.extension		0..*	Extension	Additional content defined by implementations
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
Patient.communication.preferred		0..1	boolean	Language preference indicator
Patient.managingOrganization	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.language	Base	required	All Languages	📍5.0.0	FHIR Std.
Patient.identifier.use	Base	required	IdentifierUse	📍5.0.0	FHIR Std.
Patient.identifier.type	Base	extensible	Identifier Type Codes	📍5.0.0	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍5.0.0	FHIR Std.
Patient.maritalStatus	Base	extensible	Marital Status Codes	📍5.0.0	FHIR Std.
Patient.contact.relationship	Base	extensible	Patient Contact Relationship	📍5.0.0	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍5.0.0	FHIR Std.
Patient.communication.​language	Base	required	All Languages	📍5.0.0	FHIR Std.
Patient.link.type	Base	required	Link Type	📍5.0.0	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from Patient

Summary

Mandatory: 6 elements
Must-Support: 5 elements
Prohibited: 9 elements

Extensions

This structure refers to these extensions:

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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
Patient.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
Patient.contained		0..*	Resource	Contained, inline Resources
Patient.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
Patient.Slices for extension.extension:ageYears	S This element must be supported.	1..1	integer	Age in completed years URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-age-years
Patient.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Patient.identifier	S This element must be supported. Σ This element is included in summaries.	1..1	Identifier	OptimalHealth participant identifier
Patient.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Required Pattern: https://fhir.savannahghi.org/sid/optimalhealth-participant
Patient.identifier.value	S This element must be supported. Σ This element is included in summaries. C	1..1	string	The value that is unique Example General: 123456
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.gender	S This element must be supported. Σ This element is included in summaries.	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.identifier.use	Base	required	IdentifierUse	📍5.0.0	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍5.0.0	FHIR Std.
Patient.link.type	Base	required	Link Type	📍5.0.0	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

Differential View

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
Patient.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
Patient.Slices for extension.extension:ageYears	S This element must be supported.	1..1	integer	Age in completed years URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-age-years
Patient.identifier	S This element must be supported.	1..1	Identifier	OptimalHealth participant identifier
Patient.identifier.system	S This element must be supported.	1..1	uri	The namespace for the identifier value Required Pattern: https://fhir.savannahghi.org/sid/optimalhealth-participant
Patient.identifier.value	S This element must be supported.	1..1	string	The value that is unique
Patient.name		0..0		A name associated with the patient
Patient.telecom		0..0		A contact detail for the individual
Patient.gender	S This element must be supported.	1..1	code	male | female | other | unknown
Patient.birthDate		0..0		The date of birth for the individual
Patient.deceased[x]		0..0		Indicates if the individual is deceased or not
Patient.address		0..0		An address for the individual
Patient.photo		0..0		Image of the patient
Patient.contact		0..0		A contact party (e.g. guardian, partner, friend) for the patient
Patient.generalPractitioner		0..0		Patient's nominated primary care provider
Patient.link		0..0		Link to a Patient or RelatedPerson resource that concerns the same actual individual
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
Patient.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Patient.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Patient.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
Patient.language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
Patient.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
Patient.contained		0..*	Resource	Contained, inline Resources
Patient.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
Patient.Slices for extension.extension:ageYears	S This element must be supported.	1..1	integer	Age in completed years URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-age-years
Patient.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Patient.identifier	S This element must be supported. Σ This element is included in summaries.	1..1	Identifier	OptimalHealth participant identifier
Patient.identifier.id		0..1	id	Unique id for inter-element referencing
Patient.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.identifier.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Required Pattern: https://fhir.savannahghi.org/sid/optimalhealth-participant
Patient.identifier.value	S This element must be supported. Σ This element is included in summaries. C	1..1	string	The value that is unique Example General: 123456
Patient.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Patient.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.gender	S This element must be supported. Σ This element is included in summaries.	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x]		0..1		Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean			boolean
Patient.multipleBirth[x].multipleBirthInteger			integer
Patient.communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
Patient.communication.id		0..1	string	Unique id for inter-element referencing
Patient.communication.extension		0..*	Extension	Additional content defined by implementations
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
Patient.communication.preferred		0..1	boolean	Language preference indicator
Patient.managingOrganization	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.language	Base	required	All Languages	📍5.0.0	FHIR Std.
Patient.identifier.use	Base	required	IdentifierUse	📍5.0.0	FHIR Std.
Patient.identifier.type	Base	extensible	Identifier Type Codes	📍5.0.0	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍5.0.0	FHIR Std.
Patient.maritalStatus	Base	extensible	Marital Status Codes	📍5.0.0	FHIR Std.
Patient.contact.relationship	Base	extensible	Patient Contact Relationship	📍5.0.0	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍5.0.0	FHIR Std.
Patient.communication.​language	Base	required	All Languages	📍5.0.0	FHIR Std.
Patient.link.type	Base	required	Link Type	📍5.0.0	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from Patient

Summary

Mandatory: 6 elements
Must-Support: 5 elements
Prohibited: 9 elements

Extensions

This structure refers to these extensions:

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

Other representations of profile: CSV, Excel, Schematron