Kenya Core FHIR Implementation Guide (IG), published by IntelliSOFT Consulting. 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/IntelliSOFT-Consulting/Kenya-core-FHIR-IG/ and changes regularly. See the Directory of published versions

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

Resource Profile: KenyaCore Patient Profile

This profile represents the constraints applied to the Patient resource based on the International Patient Summary (IPS) FHIR Implementation Guide. It describes the minimum expectations for the Patient resource when used in the IPS composition or as a referenced resource.

Usages:

• This Profile is not used by any profiles in this Implementation Guide

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
id	ΣC	1..1	id	Logical id of this artifact Constraints: sha-patient-id-format
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension	S	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:citizenship		0..1	CodeableConcept	Patient Ethnicity Extension URL: http://example.org/StructureDefinition/patient-ethnicity-extension Binding: Nationality Value Set (required)
extension:personWithDisability		0..1	boolean	Person With Disability Extension URL: http://example.org/StructureDefinition/person-with-disability-extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣC	1..*	Identifier	An identifier for this patient Slice: Unordered, Closed by value:system Constraints: sha-patient-min-identifier
identifier:shaNumber	Σ	0..1	Identifier	SHA Number
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/shanumber
value	ΣC	1..1	string	SHA Number value Constraints: sha-number-format Example General: 123456
identifier:phoneNumber	Σ	0..1	Identifier	Phone Number
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/phonenumber
value	ΣC	1..1	string	Phone number value Constraints: kenya-phone-format Example General: 123456
identifier:householdNumber	Σ	0..1	Identifier	Household Number
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/householdnumber
value	ΣC	1..1	string	Household number value Constraints: household-number-format Example General: 123456
identifier:nationalId	Σ	0..1	Identifier	National ID
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/nationalid
value	ΣC	1..1	string	National ID value Constraints: national-id-format Example General: 123456
active	?!SΣ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	1..*	HumanName	A name associated with the patient
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Full name in text format
family	Σ	1..1	string	Family name (surname)
given	SΣ	1..*	string	Given names (first and middle names) This repeating element order: Given Names appear in the correct order for presenting the name
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual
gender	SΣ	1..1	code	male | female | other | unknown Binding: Administrative Gender Value Set (required)
birthDate	SΣC	1..1	date	Date of birth Constraints: valid-birth-date
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	0..*	Address	An address for the individual
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
country	SΣ	0..1	string	Country of the address Binding: country (??) (required)
maritalStatus	S	0..1	CodeableConcept	Marital status of the patient Binding: Marital Status Codes (required)
contact	SC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship	S	0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (required)
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.identifier:shaNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:phoneNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:householdNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:nationalId.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	Administrative Gender Value Set	📦0.1.0	This IG
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.country	Base	required	http://hl7.org/fhir/ValueSet/country	Not State	Unknown
Patient.maritalStatus	Base	required	MaritalStatus	📦4.0.1	FHIR Std.
Patient.contact.relationship	Base	required	Patient Contact Relationship	📦4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
household-number-format	warning	Patient.identifier:householdNumber.value	Household number should match format: HH[timestamp]-[sequence]	matches('^HH\d{13}-\d+$')
kenya-phone-format	warning	Patient.identifier:phoneNumber.value	Phone number should be valid Kenya format	matches('^\\+254\d{9}$')
national-id-format	warning	Patient.identifier:nationalId.value	National ID should be 8 digits	matches('^\d{8}$')
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization	name.exists() or telecom.exists() or address.exists() or organization.exists()
sha-number-format	warning	Patient.identifier:shaNumber.value	SHA Number should match format: CR[timestamp]-[sequence]	matches('^CR\d{13}-\d+$')
sha-patient-id-format	warning	Patient.id	Patient ID should match SHA format: CR[timestamp]-[sequence]	matches('^CR\d{13}-\d+$')
sha-patient-min-identifier	error	Patient.identifier	Must have at least one identifier (SHA number, phone number, household number, or national ID)	identifier.where(system='https://fhir.sha.go.ke/fhir/identifier/shanumber' or system='https://fhir.sha.go.ke/fhir/identifier/phonenumber' or system='https://fhir.sha.go.ke/fhir/identifier/householdnumber' or system='https://fhir.sha.go.ke/fhir/identifier/nationalid').exists()
valid-birth-date	error	Patient.birthDate	Birth date should be valid and not in the future	$this <= today()

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
id	C	1..1	id	Logical id of this artifact Constraints: sha-patient-id-format
meta
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Fixed Value: https://fhir.sha.go.ke/fhir/StructureDefinition/patient|1.0.0
Slices for extension	S	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:citizenship		0..1	CodeableConcept	Patient Ethnicity Extension URL: http://example.org/StructureDefinition/patient-ethnicity-extension Binding: Nationality Value Set (required)
extension:personWithDisability		0..1	boolean	Person With Disability Extension URL: http://example.org/StructureDefinition/person-with-disability-extension
Slices for identifier	SC	1..*	Identifier	An identifier for this patient Slice: Unordered, Closed by value:system Constraints: sha-patient-min-identifier
identifier:shaNumber		0..1	Identifier	SHA Number
use		0..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
system		1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/shanumber
value	C	1..1	string	SHA Number value Constraints: sha-number-format
identifier:phoneNumber		0..1	Identifier	Phone Number
use		0..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
system		1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/phonenumber
value	C	1..1	string	Phone number value Constraints: kenya-phone-format
identifier:householdNumber		0..1	Identifier	Household Number
use		0..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
system		1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/householdnumber
value	C	1..1	string	Household number value Constraints: household-number-format
identifier:nationalId		0..1	Identifier	National ID
use		0..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
system		1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/nationalid
value	C	1..1	string	National ID value Constraints: national-id-format
active	S	0..1	boolean	Whether this patient's record is in active use
name	S	1..*	HumanName	A name associated with the patient
text		0..1	string	Full name in text format
family		1..1	string	Family name (surname)
given	S	1..*	string	Given names (first and middle names)
telecom	S	0..*	ContactPoint	A contact detail for the individual
gender	S	1..1	code	male | female | other | unknown Binding: Administrative Gender Value Set (required)
birthDate	SC	1..1	date	Date of birth Constraints: valid-birth-date
address	S	0..*	Address	An address for the individual
country	S	0..1	string	Country of the address Binding: country (??) (required)
maritalStatus	S	0..1	CodeableConcept	Marital status of the patient Binding: Marital Status Codes (required)
contact	S	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
relationship	S	0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Patient.gender	Base	required	Administrative Gender Value Set	📦0.1.0	This IG
Patient.address.country	Base	required	http://hl7.org/fhir/ValueSet/country	Not State	Unknown
Patient.maritalStatus	Base	required	MaritalStatus	📦4.0.1	FHIR Std.
Patient.contact.relationship	Base	required	Patient Contact Relationship	📦4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
household-number-format	warning	Patient.identifier:householdNumber.value	Household number should match format: HH[timestamp]-[sequence]	matches('^HH\d{13}-\d+$')
kenya-phone-format	warning	Patient.identifier:phoneNumber.value	Phone number should be valid Kenya format	matches('^\\+254\d{9}$')
national-id-format	warning	Patient.identifier:nationalId.value	National ID should be 8 digits	matches('^\d{8}$')
sha-number-format	warning	Patient.identifier:shaNumber.value	SHA Number should match format: CR[timestamp]-[sequence]	matches('^CR\d{13}-\d+$')
sha-patient-id-format	warning	Patient.id	Patient ID should match SHA format: CR[timestamp]-[sequence]	matches('^CR\d{13}-\d+$')
sha-patient-min-identifier	error	Patient.identifier	Must have at least one identifier (SHA number, phone number, household number, or national ID)	identifier.where(system='https://fhir.sha.go.ke/fhir/identifier/shanumber' or system='https://fhir.sha.go.ke/fhir/identifier/phonenumber' or system='https://fhir.sha.go.ke/fhir/identifier/householdnumber' or system='https://fhir.sha.go.ke/fhir/identifier/nationalid').exists()
valid-birth-date	error	Patient.birthDate	Birth date should be valid and not in the future	$this <= today()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
id	ΣC	1..1	id	Logical id of this artifact Constraints: sha-patient-id-format
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Fixed Value: https://fhir.sha.go.ke/fhir/StructureDefinition/patient|1.0.0
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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	S	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:citizenship		0..1	CodeableConcept	Patient Ethnicity Extension URL: http://example.org/StructureDefinition/patient-ethnicity-extension Binding: Nationality Value Set (required)
extension:personWithDisability		0..1	boolean	Person With Disability Extension URL: http://example.org/StructureDefinition/person-with-disability-extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣC	1..*	Identifier	An identifier for this patient Slice: Unordered, Closed by value:system Constraints: sha-patient-min-identifier
identifier:shaNumber	Σ	0..1	Identifier	SHA Number
id		0..1	string	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 . Fixed Value: official
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/shanumber
value	ΣC	1..1	string	SHA Number value Constraints: sha-number-format 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)
identifier:phoneNumber	Σ	0..1	Identifier	Phone Number
id		0..1	string	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 . Fixed Value: official
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/phonenumber
value	ΣC	1..1	string	Phone number value Constraints: kenya-phone-format 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)
identifier:householdNumber	Σ	0..1	Identifier	Household Number
id		0..1	string	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 . Fixed Value: official
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/householdnumber
value	ΣC	1..1	string	Household number value Constraints: household-number-format 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)
identifier:nationalId	Σ	0..1	Identifier	National ID
id		0..1	string	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 . Fixed Value: official
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/nationalid
value	ΣC	1..1	string	National ID value Constraints: national-id-format 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	?!SΣ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	1..*	HumanName	A name associated with the patient
id		0..1	string	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 | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Full name in text format
family	Σ	1..1	string	Family name (surname)
given	SΣ	1..*	string	Given names (first and middle names) This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual
gender	SΣ	1..1	code	male | female | other | unknown Binding: Administrative Gender Value Set (required)
birthDate	SΣC	1..1	date	Date of birth Constraints: valid-birth-date
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	0..*	Address	An address for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	SΣ	0..1	string	Country of the address Binding: country (??) (required)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus	S	0..1	CodeableConcept	Marital status of the patient Binding: Marital Status Codes (required)
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	SC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
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
relationship	S	0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (required)
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
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
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Patient.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Patient.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.identifier:shaNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:shaNumber.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:phoneNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:phoneNumber.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:householdNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:householdNumber.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:nationalId.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:nationalId.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	Administrative Gender Value Set	📦0.1.0	This IG
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.address.country	Base	required	http://hl7.org/fhir/ValueSet/country	Not State	Unknown
Patient.maritalStatus	Base	required	MaritalStatus	📦4.0.1	FHIR Std.
Patient.contact.relationship	Base	required	Patient Contact Relationship	📦4.0.1	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
household-number-format	warning	Patient.identifier:householdNumber.value	Household number should match format: HH[timestamp]-[sequence]	matches('^HH\d{13}-\d+$')
kenya-phone-format	warning	Patient.identifier:phoneNumber.value	Phone number should be valid Kenya format	matches('^\\+254\d{9}$')
national-id-format	warning	Patient.identifier:nationalId.value	National ID should be 8 digits	matches('^\d{8}$')
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization	name.exists() or telecom.exists() or address.exists() or organization.exists()
sha-number-format	warning	Patient.identifier:shaNumber.value	SHA Number should match format: CR[timestamp]-[sequence]	matches('^CR\d{13}-\d+$')
sha-patient-id-format	warning	Patient.id	Patient ID should match SHA format: CR[timestamp]-[sequence]	matches('^CR\d{13}-\d+$')
sha-patient-min-identifier	error	Patient.identifier	Must have at least one identifier (SHA number, phone number, household number, or national ID)	identifier.where(system='https://fhir.sha.go.ke/fhir/identifier/shanumber' or system='https://fhir.sha.go.ke/fhir/identifier/phonenumber' or system='https://fhir.sha.go.ke/fhir/identifier/householdnumber' or system='https://fhir.sha.go.ke/fhir/identifier/nationalid').exists()
valid-birth-date	error	Patient.birthDate	Birth date should be valid and not in the future	$this <= today()

This structure is derived from Patient

Summary

Mandatory: 7 elements(9 nested mandatory elements)
Must-Support: 13 elements
Fixed: 9 elements

Extensions

This structure refers to these extensions:

• http://example.org/StructureDefinition/patient-ethnicity-extension
• http://example.org/StructureDefinition/person-with-disability-extension

Slices

This structure defines the following Slices:

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

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
id	ΣC	1..1	id	Logical id of this artifact Constraints: sha-patient-id-format
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension	S	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:citizenship		0..1	CodeableConcept	Patient Ethnicity Extension URL: http://example.org/StructureDefinition/patient-ethnicity-extension Binding: Nationality Value Set (required)
extension:personWithDisability		0..1	boolean	Person With Disability Extension URL: http://example.org/StructureDefinition/person-with-disability-extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣC	1..*	Identifier	An identifier for this patient Slice: Unordered, Closed by value:system Constraints: sha-patient-min-identifier
identifier:shaNumber	Σ	0..1	Identifier	SHA Number
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/shanumber
value	ΣC	1..1	string	SHA Number value Constraints: sha-number-format Example General: 123456
identifier:phoneNumber	Σ	0..1	Identifier	Phone Number
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/phonenumber
value	ΣC	1..1	string	Phone number value Constraints: kenya-phone-format Example General: 123456
identifier:householdNumber	Σ	0..1	Identifier	Household Number
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/householdnumber
value	ΣC	1..1	string	Household number value Constraints: household-number-format Example General: 123456
identifier:nationalId	Σ	0..1	Identifier	National ID
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/nationalid
value	ΣC	1..1	string	National ID value Constraints: national-id-format Example General: 123456
active	?!SΣ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	1..*	HumanName	A name associated with the patient
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Full name in text format
family	Σ	1..1	string	Family name (surname)
given	SΣ	1..*	string	Given names (first and middle names) This repeating element order: Given Names appear in the correct order for presenting the name
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual
gender	SΣ	1..1	code	male | female | other | unknown Binding: Administrative Gender Value Set (required)
birthDate	SΣC	1..1	date	Date of birth Constraints: valid-birth-date
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	0..*	Address	An address for the individual
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
country	SΣ	0..1	string	Country of the address Binding: country (??) (required)
maritalStatus	S	0..1	CodeableConcept	Marital status of the patient Binding: Marital Status Codes (required)
contact	SC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship	S	0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (required)
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.identifier:shaNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:phoneNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:householdNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:nationalId.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	Administrative Gender Value Set	📦0.1.0	This IG
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.country	Base	required	http://hl7.org/fhir/ValueSet/country	Not State	Unknown
Patient.maritalStatus	Base	required	MaritalStatus	📦4.0.1	FHIR Std.
Patient.contact.relationship	Base	required	Patient Contact Relationship	📦4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
household-number-format	warning	Patient.identifier:householdNumber.value	Household number should match format: HH[timestamp]-[sequence]	matches('^HH\d{13}-\d+$')
kenya-phone-format	warning	Patient.identifier:phoneNumber.value	Phone number should be valid Kenya format	matches('^\\+254\d{9}$')
national-id-format	warning	Patient.identifier:nationalId.value	National ID should be 8 digits	matches('^\d{8}$')
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization	name.exists() or telecom.exists() or address.exists() or organization.exists()
sha-number-format	warning	Patient.identifier:shaNumber.value	SHA Number should match format: CR[timestamp]-[sequence]	matches('^CR\d{13}-\d+$')
sha-patient-id-format	warning	Patient.id	Patient ID should match SHA format: CR[timestamp]-[sequence]	matches('^CR\d{13}-\d+$')
sha-patient-min-identifier	error	Patient.identifier	Must have at least one identifier (SHA number, phone number, household number, or national ID)	identifier.where(system='https://fhir.sha.go.ke/fhir/identifier/shanumber' or system='https://fhir.sha.go.ke/fhir/identifier/phonenumber' or system='https://fhir.sha.go.ke/fhir/identifier/householdnumber' or system='https://fhir.sha.go.ke/fhir/identifier/nationalid').exists()
valid-birth-date	error	Patient.birthDate	Birth date should be valid and not in the future	$this <= today()

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
id	C	1..1	id	Logical id of this artifact Constraints: sha-patient-id-format
meta
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Fixed Value: https://fhir.sha.go.ke/fhir/StructureDefinition/patient|1.0.0
Slices for extension	S	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:citizenship		0..1	CodeableConcept	Patient Ethnicity Extension URL: http://example.org/StructureDefinition/patient-ethnicity-extension Binding: Nationality Value Set (required)
extension:personWithDisability		0..1	boolean	Person With Disability Extension URL: http://example.org/StructureDefinition/person-with-disability-extension
Slices for identifier	SC	1..*	Identifier	An identifier for this patient Slice: Unordered, Closed by value:system Constraints: sha-patient-min-identifier
identifier:shaNumber		0..1	Identifier	SHA Number
use		0..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
system		1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/shanumber
value	C	1..1	string	SHA Number value Constraints: sha-number-format
identifier:phoneNumber		0..1	Identifier	Phone Number
use		0..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
system		1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/phonenumber
value	C	1..1	string	Phone number value Constraints: kenya-phone-format
identifier:householdNumber		0..1	Identifier	Household Number
use		0..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
system		1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/householdnumber
value	C	1..1	string	Household number value Constraints: household-number-format
identifier:nationalId		0..1	Identifier	National ID
use		0..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
system		1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/nationalid
value	C	1..1	string	National ID value Constraints: national-id-format
active	S	0..1	boolean	Whether this patient's record is in active use
name	S	1..*	HumanName	A name associated with the patient
text		0..1	string	Full name in text format
family		1..1	string	Family name (surname)
given	S	1..*	string	Given names (first and middle names)
telecom	S	0..*	ContactPoint	A contact detail for the individual
gender	S	1..1	code	male | female | other | unknown Binding: Administrative Gender Value Set (required)
birthDate	SC	1..1	date	Date of birth Constraints: valid-birth-date
address	S	0..*	Address	An address for the individual
country	S	0..1	string	Country of the address Binding: country (??) (required)
maritalStatus	S	0..1	CodeableConcept	Marital status of the patient Binding: Marital Status Codes (required)
contact	S	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
relationship	S	0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Patient.gender	Base	required	Administrative Gender Value Set	📦0.1.0	This IG
Patient.address.country	Base	required	http://hl7.org/fhir/ValueSet/country	Not State	Unknown
Patient.maritalStatus	Base	required	MaritalStatus	📦4.0.1	FHIR Std.
Patient.contact.relationship	Base	required	Patient Contact Relationship	📦4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
household-number-format	warning	Patient.identifier:householdNumber.value	Household number should match format: HH[timestamp]-[sequence]	matches('^HH\d{13}-\d+$')
kenya-phone-format	warning	Patient.identifier:phoneNumber.value	Phone number should be valid Kenya format	matches('^\\+254\d{9}$')
national-id-format	warning	Patient.identifier:nationalId.value	National ID should be 8 digits	matches('^\d{8}$')
sha-number-format	warning	Patient.identifier:shaNumber.value	SHA Number should match format: CR[timestamp]-[sequence]	matches('^CR\d{13}-\d+$')
sha-patient-id-format	warning	Patient.id	Patient ID should match SHA format: CR[timestamp]-[sequence]	matches('^CR\d{13}-\d+$')
sha-patient-min-identifier	error	Patient.identifier	Must have at least one identifier (SHA number, phone number, household number, or national ID)	identifier.where(system='https://fhir.sha.go.ke/fhir/identifier/shanumber' or system='https://fhir.sha.go.ke/fhir/identifier/phonenumber' or system='https://fhir.sha.go.ke/fhir/identifier/householdnumber' or system='https://fhir.sha.go.ke/fhir/identifier/nationalid').exists()
valid-birth-date	error	Patient.birthDate	Birth date should be valid and not in the future	$this <= today()

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
id	ΣC	1..1	id	Logical id of this artifact Constraints: sha-patient-id-format
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Fixed Value: https://fhir.sha.go.ke/fhir/StructureDefinition/patient|1.0.0
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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	S	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:citizenship		0..1	CodeableConcept	Patient Ethnicity Extension URL: http://example.org/StructureDefinition/patient-ethnicity-extension Binding: Nationality Value Set (required)
extension:personWithDisability		0..1	boolean	Person With Disability Extension URL: http://example.org/StructureDefinition/person-with-disability-extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣC	1..*	Identifier	An identifier for this patient Slice: Unordered, Closed by value:system Constraints: sha-patient-min-identifier
identifier:shaNumber	Σ	0..1	Identifier	SHA Number
id		0..1	string	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 . Fixed Value: official
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/shanumber
value	ΣC	1..1	string	SHA Number value Constraints: sha-number-format 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)
identifier:phoneNumber	Σ	0..1	Identifier	Phone Number
id		0..1	string	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 . Fixed Value: official
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/phonenumber
value	ΣC	1..1	string	Phone number value Constraints: kenya-phone-format 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)
identifier:householdNumber	Σ	0..1	Identifier	Household Number
id		0..1	string	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 . Fixed Value: official
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/householdnumber
value	ΣC	1..1	string	Household number value Constraints: household-number-format 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)
identifier:nationalId	Σ	0..1	Identifier	National ID
id		0..1	string	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 . Fixed Value: official
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.sha.go.ke/fhir/identifier/nationalid
value	ΣC	1..1	string	National ID value Constraints: national-id-format 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	?!SΣ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	1..*	HumanName	A name associated with the patient
id		0..1	string	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 | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Full name in text format
family	Σ	1..1	string	Family name (surname)
given	SΣ	1..*	string	Given names (first and middle names) This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual
gender	SΣ	1..1	code	male | female | other | unknown Binding: Administrative Gender Value Set (required)
birthDate	SΣC	1..1	date	Date of birth Constraints: valid-birth-date
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	0..*	Address	An address for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	SΣ	0..1	string	Country of the address Binding: country (??) (required)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus	S	0..1	CodeableConcept	Marital status of the patient Binding: Marital Status Codes (required)
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	SC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
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
relationship	S	0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (required)
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
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
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Patient.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Patient.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.identifier:shaNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:shaNumber.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:phoneNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:phoneNumber.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:householdNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:householdNumber.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:nationalId.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:nationalId.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	Administrative Gender Value Set	📦0.1.0	This IG
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.address.country	Base	required	http://hl7.org/fhir/ValueSet/country	Not State	Unknown
Patient.maritalStatus	Base	required	MaritalStatus	📦4.0.1	FHIR Std.
Patient.contact.relationship	Base	required	Patient Contact Relationship	📦4.0.1	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
household-number-format	warning	Patient.identifier:householdNumber.value	Household number should match format: HH[timestamp]-[sequence]	matches('^HH\d{13}-\d+$')
kenya-phone-format	warning	Patient.identifier:phoneNumber.value	Phone number should be valid Kenya format	matches('^\\+254\d{9}$')
national-id-format	warning	Patient.identifier:nationalId.value	National ID should be 8 digits	matches('^\d{8}$')
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization	name.exists() or telecom.exists() or address.exists() or organization.exists()
sha-number-format	warning	Patient.identifier:shaNumber.value	SHA Number should match format: CR[timestamp]-[sequence]	matches('^CR\d{13}-\d+$')
sha-patient-id-format	warning	Patient.id	Patient ID should match SHA format: CR[timestamp]-[sequence]	matches('^CR\d{13}-\d+$')
sha-patient-min-identifier	error	Patient.identifier	Must have at least one identifier (SHA number, phone number, household number, or national ID)	identifier.where(system='https://fhir.sha.go.ke/fhir/identifier/shanumber' or system='https://fhir.sha.go.ke/fhir/identifier/phonenumber' or system='https://fhir.sha.go.ke/fhir/identifier/householdnumber' or system='https://fhir.sha.go.ke/fhir/identifier/nationalid').exists()
valid-birth-date	error	Patient.birthDate	Birth date should be valid and not in the future	$this <= today()

This structure is derived from Patient

Summary

Mandatory: 7 elements(9 nested mandatory elements)
Must-Support: 13 elements
Fixed: 9 elements

Extensions

This structure refers to these extensions:

• http://example.org/StructureDefinition/patient-ethnicity-extension
• http://example.org/StructureDefinition/person-with-disability-extension

Slices

This structure defines the following Slices:

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