Healthy Route Implementation Guide
0.1.0 - ci-build

Healthy Route Implementation Guide, published by Savannah Informatics. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/savannahghi/healthy-route-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Healthy Route Patient (Export)

Official URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-export-patient Version: 0.1.0
Draft as of 2026-09-04 Computable Name: HRExportPatient

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ageYears S 1..1 integer Age in completed years
URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-age-years
... identifier SΣ 1..1 Identifier OptimalHealth participant identifier
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system SΣ 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.savannahghi.org/sid/optimalhealth-participant
.... value SΣC 1..1 string The value that is unique
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... gender SΣ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

doco 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ageYears S 1..1 integer Age in completed years
URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-age-years
... identifier S 1..1 Identifier OptimalHealth participant identifier
.... system S 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.savannahghi.org/sid/optimalhealth-participant
.... value S 1..1 string The value that is unique
... name 0..0 A name associated with the patient
... gender S 1..1 code male | female | other | unknown
... birthDate 0..0 The date of birth for the individual
... deceased[x] 0..0 Indicates if the individual is deceased or not
... address 0..0 An address for the individual
... photo 0..0 Image of the patient
... contact 0..0 A contact party (e.g. guardian, partner, friend) for the patient
... generalPractitioner 0..0 Patient's nominated primary care provider
... link 0..0 Link to a Patient or RelatedPerson resource that concerns the same actual individual

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

doco 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:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ageYears S 1..1 integer Age in completed years
URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-age-years
... identifier SΣ 1..1 Identifier OptimalHealth participant identifier
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system SΣ 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.savannahghi.org/sid/optimalhealth-participant
.... value SΣC 1..1 string The value that is unique
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... gender SΣ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

doco 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ageYears S 1..1 integer Age in completed years
URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-age-years
... identifier S 1..1 Identifier OptimalHealth participant identifier
.... system S 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.savannahghi.org/sid/optimalhealth-participant
.... value S 1..1 string The value that is unique
... name 0..0 A name associated with the patient
... gender S 1..1 code male | female | other | unknown
... birthDate 0..0 The date of birth for the individual
... deceased[x] 0..0 Indicates if the individual is deceased or not
... address 0..0 An address for the individual
... photo 0..0 Image of the patient
... contact 0..0 A contact party (e.g. guardian, partner, friend) for the patient
... generalPractitioner 0..0 Patient's nominated primary care provider
... link 0..0 Link to a Patient or RelatedPerson resource that concerns the same actual individual

doco Documentation for this format

Snapshot View

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

doco 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:

 

Other representations of profile: CSV, Excel, Schematron