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 Patient

A study participant as held within a site tenant.

Supports operation of the study at a site: participant lookup at registration, prevention of duplicate enrolment, and linkage of clinical observations to the correct individual. This is not the form in which participant data leaves the tenant; see HRExportPatient.

Usages:

• Refer to this Profile: Healthy Route Blood Pressure, Healthy Route Reported Condition, Healthy Route Consent, Healthy Route Laboratory Report... Show 8 more, Healthy Route Document, Healthy Route Screening Visit, Healthy Route Retinal Imaging, Healthy Route Reported Medicine, Healthy Route Measurement, Healthy Route Study Participation, Healthy Route Investigation Request and Healthy Route Sample
• Examples for this Profile: Patient/ExampleParticipant

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:tenant	S This element must be supported.	1..1	Identifier	Owning site tenant URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant
Patient.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:participantId	S This element must be supported. Σ This element is included in summaries.	1..1	Identifier	OptimalHealth participant identifier
Patient.Slices for identifier.identifier:participantId.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.Slices for identifier.identifier:participantId.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.Slices for identifier.identifier:participantId.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.name	S This element must be supported. Σ This element is included in summaries.	1..1	HumanName	Participant name
Patient.name.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Patient.name.family	S This element must be supported. Σ This element is included in summaries.	1..1	string	Family name (often called 'Surname')
Patient.telecom	S This element must be supported. Σ This element is included in summaries.	0..*	ContactPoint	Contact number
Patient.gender	S This element must be supported. Σ This element is included in summaries.	1..1	code	Administrative gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	1..1	date	The date of birth for the individual
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual individual
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.identifier:participantId.​use	Base	required	IdentifierUse	📍5.0.0	FHIR Std.
Patient.name.use	Base	required	NameUse	📍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:tenant	S This element must be supported.	1..1	Identifier	Owning site tenant URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant
Patient.Slices for identifier	S This element must be supported.	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:participantId	S This element must be supported.	1..1	Identifier	OptimalHealth participant identifier
Patient.Slices for identifier.identifier:participantId.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.Slices for identifier.identifier:participantId.value	S This element must be supported.	1..1	string	The value that is unique
Patient.name	S This element must be supported.	1..1	HumanName	Participant name
Patient.name.family	S This element must be supported.	1..1	string	Family name (often called 'Surname')
Patient.telecom	S This element must be supported.	0..*	ContactPoint	Contact number
Patient.gender	S This element must be supported.	1..1	code	Administrative gender
Patient.birthDate	S This element must be supported.	1..1	date	The date of birth for the 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:tenant	S This element must be supported.	1..1	Identifier	Owning site tenant URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant
Patient.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:participantId	S This element must be supported. Σ This element is included in summaries.	1..1	Identifier	OptimalHealth participant identifier
Patient.Slices for identifier.identifier:participantId.id		0..1	id	Unique id for inter-element referencing
Patient.Slices for identifier.identifier:participantId.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:participantId.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.Slices for identifier.identifier:participantId.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.Slices for identifier.identifier:participantId.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.Slices for identifier.identifier:participantId.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.Slices for identifier.identifier:participantId.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Patient.Slices for identifier.identifier:participantId.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.name	S This element must be supported. Σ This element is included in summaries.	1..1	HumanName	Participant name
Patient.name.id		0..1	id	Unique id for inter-element referencing
Patient.name.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.name.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Patient.name.text	Σ This element is included in summaries.	0..1	string	Text representation of the full name
Patient.name.family	S This element must be supported. Σ This element is included in summaries.	1..1	string	Family name (often called 'Surname')
Patient.name.given	Σ This element is included in summaries.	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.prefix	Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix	Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Patient.telecom	S This element must be supported. Σ This element is included in summaries.	0..*	ContactPoint	Contact number
Patient.gender	S This element must be supported. Σ This element is included in summaries.	1..1	code	Administrative gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	1..1	date	The date of birth for the individual
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.address	Σ This element is included in summaries.	0..*	Address	An address for the individual
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.photo		0..*	Attachment	Image of the patient
Patient.contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.id		0..1	string	Unique id for inter-element referencing
Patient.contact.extension		0..*	Extension	Additional content defined by implementations
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name	C	0..1	HumanName	A name associated with the contact person
Patient.contact.telecom	C	0..*	ContactPoint	A contact detail for the person
Patient.contact.address	C	0..1	Address	Address for the contact person
Patient.contact.gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
Patient.contact.period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
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.generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
Patient.managingOrganization	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual individual
Patient.link.id		0..1	string	Unique id for inter-element referencing
Patient.link.extension		0..*	Extension	Additional content defined by implementations
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code
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:participantId.​use	Base	required	IdentifierUse	📍5.0.0	FHIR Std.
Patient.identifier:participantId.​type	Base	extensible	Identifier Type Codes	📍5.0.0	FHIR Std.
Patient.name.use	Base	required	NameUse	📍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: 10 elements
Must-Support: 10 elements

Extensions

This structure refers to these extensions:

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

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.identifier

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:tenant	S This element must be supported.	1..1	Identifier	Owning site tenant URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant
Patient.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:participantId	S This element must be supported. Σ This element is included in summaries.	1..1	Identifier	OptimalHealth participant identifier
Patient.Slices for identifier.identifier:participantId.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.Slices for identifier.identifier:participantId.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.Slices for identifier.identifier:participantId.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.name	S This element must be supported. Σ This element is included in summaries.	1..1	HumanName	Participant name
Patient.name.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Patient.name.family	S This element must be supported. Σ This element is included in summaries.	1..1	string	Family name (often called 'Surname')
Patient.telecom	S This element must be supported. Σ This element is included in summaries.	0..*	ContactPoint	Contact number
Patient.gender	S This element must be supported. Σ This element is included in summaries.	1..1	code	Administrative gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	1..1	date	The date of birth for the individual
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual individual
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.identifier:participantId.​use	Base	required	IdentifierUse	📍5.0.0	FHIR Std.
Patient.name.use	Base	required	NameUse	📍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:tenant	S This element must be supported.	1..1	Identifier	Owning site tenant URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant
Patient.Slices for identifier	S This element must be supported.	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:participantId	S This element must be supported.	1..1	Identifier	OptimalHealth participant identifier
Patient.Slices for identifier.identifier:participantId.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.Slices for identifier.identifier:participantId.value	S This element must be supported.	1..1	string	The value that is unique
Patient.name	S This element must be supported.	1..1	HumanName	Participant name
Patient.name.family	S This element must be supported.	1..1	string	Family name (often called 'Surname')
Patient.telecom	S This element must be supported.	0..*	ContactPoint	Contact number
Patient.gender	S This element must be supported.	1..1	code	Administrative gender
Patient.birthDate	S This element must be supported.	1..1	date	The date of birth for the 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:tenant	S This element must be supported.	1..1	Identifier	Owning site tenant URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant
Patient.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:participantId	S This element must be supported. Σ This element is included in summaries.	1..1	Identifier	OptimalHealth participant identifier
Patient.Slices for identifier.identifier:participantId.id		0..1	id	Unique id for inter-element referencing
Patient.Slices for identifier.identifier:participantId.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:participantId.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.Slices for identifier.identifier:participantId.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.Slices for identifier.identifier:participantId.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.Slices for identifier.identifier:participantId.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.Slices for identifier.identifier:participantId.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Patient.Slices for identifier.identifier:participantId.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.name	S This element must be supported. Σ This element is included in summaries.	1..1	HumanName	Participant name
Patient.name.id		0..1	id	Unique id for inter-element referencing
Patient.name.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.name.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Patient.name.text	Σ This element is included in summaries.	0..1	string	Text representation of the full name
Patient.name.family	S This element must be supported. Σ This element is included in summaries.	1..1	string	Family name (often called 'Surname')
Patient.name.given	Σ This element is included in summaries.	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.prefix	Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix	Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Patient.telecom	S This element must be supported. Σ This element is included in summaries.	0..*	ContactPoint	Contact number
Patient.gender	S This element must be supported. Σ This element is included in summaries.	1..1	code	Administrative gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	1..1	date	The date of birth for the individual
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.address	Σ This element is included in summaries.	0..*	Address	An address for the individual
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.photo		0..*	Attachment	Image of the patient
Patient.contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.id		0..1	string	Unique id for inter-element referencing
Patient.contact.extension		0..*	Extension	Additional content defined by implementations
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name	C	0..1	HumanName	A name associated with the contact person
Patient.contact.telecom	C	0..*	ContactPoint	A contact detail for the person
Patient.contact.address	C	0..1	Address	Address for the contact person
Patient.contact.gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
Patient.contact.period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
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.generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
Patient.managingOrganization	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual individual
Patient.link.id		0..1	string	Unique id for inter-element referencing
Patient.link.extension		0..*	Extension	Additional content defined by implementations
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code
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:participantId.​use	Base	required	IdentifierUse	📍5.0.0	FHIR Std.
Patient.identifier:participantId.​type	Base	extensible	Identifier Type Codes	📍5.0.0	FHIR Std.
Patient.name.use	Base	required	NameUse	📍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: 10 elements
Must-Support: 10 elements

Extensions

This structure refers to these extensions:

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

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.identifier

Other representations of profile: CSV, Excel, Schematron