oncologyfhirigkenya - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: Oncology Kenya Patient

Customized patient profile for oncology care in Kenya. This profile is part of the Oncology Implementation Guide for Kenya (Oncology-IG-Kenya) — a draft version (0.1.0) dated 2025-06-18. It models key patient elements aligned with Kenya’s national cancer registry, SHA (Smart Health Authority), DHIS2, and local care workflows. This guide demonstrates how HL7® FHIR® can be applied to transform cancer care, from screening to palliative support. It is a proof-of-concept created independently by a Kenyan digital health enthusiast, with no official endorsement, to inspire innovation using open health standards and locally relevant data modeling.

Usages:

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

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	Patient	Information about an individual or animal receiving health care services Constraints: pat-1, pat-2, pat-3, pat-4
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:nationality		0..1	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
extension:educationLevel		0..1	(Complex)	Patient Education Level URL: https://oncology.ig.kenya/StructureDefinition/patient-educationLevel
extension:occupation		0..1	CodeableConcept	Patient Occupation URL: https://oncology.ig.kenya/StructureDefinition/patient-occupation
Slices for identifier	S	2..*	Identifier	At least National ID and SHA ID must be provided Slice: Unordered, Open by pattern:system
identifier:nationalID	S	1..1	Identifier	An identifier for this patient
system		1..1	uri	The namespace for the identifier value Fixed Value: http://gov.ke/national-id
value	S	1..1	string	The value that is unique
identifier:shaID	S	1..1	Identifier	An identifier for this patient
system		1..1	uri	The namespace for the identifier value Fixed Value: https://sha.go.ke/ids/patient
value	S	1..1	string	The value that is unique
identifier:facilityUPI		0..1	Identifier	An identifier for this patient
system		1..1	uri	The namespace for the identifier value Fixed Value: http://facility.health.go.ke/upi
active	S	1..1	boolean	Whether this patient's record is in active use
name	S	1..1	HumanName	A name associated with the patient
family	S	1..1	string	Family name (often called 'Surname')
given	S	1..*	string	Given names (not always 'first'). Includes middle names
telecom	S	1..*	ContactPoint	A contact detail for the individual
system		1..1	code	phone | fax | email | pager | url | sms | other
value		1..1	string	The actual contact point details
gender	S	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required)
birthDate	S	1..1	date	The date of birth for the individual
address	S	1..1	Address	An address for the individual
line	S	1..1	string	Street name, number, direction & P.O. Box etc.
district	S	1..1	string	District name (aka county)
state	S	1..1	string	Sub-unit of country (abbreviations ok)
country		0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Fixed Value: KE
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: http://terminology.health.go.ke/ValueSet/marital-status-kenya (extensible)
Slices for multipleBirth[x]		0..1	boolean, integer	Whether patient is part of a multiple birth Slice: Unordered, Open by type:$this
multipleBirth[x]:multipleBirthBoolean		0..1	boolean	Whether patient is part of a multiple birth
multipleBirth[x]:multipleBirthInteger		0..1	integer	Whether patient is part of a multiple birth
photo	S	0..*	Attachment	Image of the patient
contact	S	1..1	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
relationship	S	1..*	CodeableConcept	The kind of relationship Binding: patient-contact-relationship (??) (extensible)
name	S	1..1	HumanName	A name associated with the contact person
telecom	S	1..1	ContactPoint	A contact detail for the person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required)
generalPractitioner	S	1..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	S	1..1	Reference(Organization)	Organization that is the custodian of the patient record
link	S	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
other	S	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)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.maritalStatus	extensible	http://terminology.health.go.ke/ValueSet/marital-status-kenya http://terminology.health.go.ke/ValueSet/marital-status-kenya
Patient.contact.relationship	extensible	http://hl7.org/fhir/ValueSet/patient-contact-relationship http://hl7.org/fhir/ValueSet/patient-contact-relationship
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
pat-1	error	Patient	Must have at least one given name and one family name : name.given.exists() and name.family.exists()
pat-2	error	Patient	telecom must include both system and value : telecom.system.exists() and telecom.value.exists()
pat-3	error	Patient	If contact is present, it must have relationship and name : contact.relationship.exists() and contact.name.exists()
pat-4	error	Patient	address must have line, district, and state : address.line.exists() and address.district.exists() and address.state.exists()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	Patient	Information about an individual or animal receiving health care services Constraints: pat-1, pat-2, pat-3, pat-4
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:nationality		0..1	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
extension:educationLevel		0..1	(Complex)	Patient Education Level URL: https://oncology.ig.kenya/StructureDefinition/patient-educationLevel
extension:occupation		0..1	CodeableConcept	Patient Occupation URL: https://oncology.ig.kenya/StructureDefinition/patient-occupation
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	2..*	Identifier	At least National ID and SHA ID must be provided Slice: Unordered, Open by pattern:system
identifier:nationalID	SΣ	1..1	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://gov.ke/national-id
value	SΣ	1..1	string	The value that is unique Example General: 123456
identifier:shaID	SΣ	1..1	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://sha.go.ke/ids/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
identifier:facilityUPI	Σ	0..1	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://facility.health.go.ke/upi
active	?!SΣ	1..1	boolean	Whether this patient's record is in active use
name	SΣ	1..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.
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	1..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
telecom	SΣ	1..*	ContactPoint	A contact detail for the individual
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	1..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required)
birthDate	SΣ	1..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	1..1	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
line	SΣ	1..1	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
district	SΣ	1..1	string	District name (aka county) Example General: Madison
state	SΣ	1..1	string	Sub-unit of country (abbreviations ok)
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Fixed Value: KE
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: http://terminology.health.go.ke/ValueSet/marital-status-kenya (extensible)
Slices for multipleBirth[x]		0..1		Whether patient is part of a multiple birth Slice: Unordered, Closed by type:$this
multipleBirthBoolean			boolean
multipleBirthInteger			integer
multipleBirth[x]:multipleBirthBoolean		0..1	boolean	Whether patient is part of a multiple birth
multipleBirth[x]:multipleBirthInteger		0..1	integer	Whether patient is part of a multiple birth
photo	S	0..*	Attachment	Image of the patient
contact	SC	1..1	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	1..*	CodeableConcept	The kind of relationship Binding: patient-contact-relationship (??) (extensible)
name	S	1..1	HumanName	A name associated with the contact person
telecom	S	1..1	ContactPoint	A contact detail for the person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required)
generalPractitioner	S	1..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	SΣ	1..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!SΣ	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	SΣ	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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.identifier:nationalID.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:shaID.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:facilityUPI.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 From the FHIR Standard
Patient.maritalStatus	extensible	http://terminology.health.go.ke/ValueSet/marital-status-kenya http://terminology.health.go.ke/ValueSet/marital-status-kenya
Patient.contact.relationship	extensible	http://hl7.org/fhir/ValueSet/patient-contact-relationship http://hl7.org/fhir/ValueSet/patient-contact-relationship
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
pat-1	error	Patient, Patient.contact	Must have at least one given name and one family name : name.given.exists() and name.family.exists()
pat-2	error	Patient	telecom must include both system and value : telecom.system.exists() and telecom.value.exists()
pat-3	error	Patient	If contact is present, it must have relationship and name : contact.relationship.exists() and contact.name.exists()
pat-4	error	Patient	address must have line, district, and state : address.line.exists() and address.district.exists() and address.state.exists()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	Patient	Information about an individual or animal receiving health care services Constraints: pat-1, pat-2, pat-3, pat-4
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
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		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:nationality		0..1	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
extension:educationLevel		0..1	(Complex)	Patient Education Level URL: https://oncology.ig.kenya/StructureDefinition/patient-educationLevel
extension:occupation		0..1	CodeableConcept	Patient Occupation URL: https://oncology.ig.kenya/StructureDefinition/patient-occupation
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	2..*	Identifier	At least National ID and SHA ID must be provided Slice: Unordered, Open by pattern:system
identifier:nationalID	SΣ	1..1	Identifier	An identifier for this 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 | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
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: http://gov.ke/national-id
value	SΣ	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)
identifier:shaID	SΣ	1..1	Identifier	An identifier for this 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 | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
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://sha.go.ke/ids/patient
value	SΣ	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)
identifier:facilityUPI	Σ	0..1	Identifier	An identifier for this 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 | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
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: http://facility.health.go.ke/upi
value	Σ	0..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	?!SΣ	1..1	boolean	Whether this patient's record is in active use
name	SΣ	1..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	Text representation of the full name
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	1..*	string	Given names (not always 'first'). Includes 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Σ	1..*	ContactPoint	A contact detail 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
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	1..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required)
birthDate	SΣ	1..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	1..1	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	SΣ	1..1	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	SΣ	1..1	string	District name (aka county) Example General: Madison
state	SΣ	1..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Fixed Value: KE
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: http://terminology.health.go.ke/ValueSet/marital-status-kenya (extensible)
Slices for multipleBirth[x]		0..1		Whether patient is part of a multiple birth Slice: Unordered, Closed by type:$this
multipleBirthBoolean			boolean
multipleBirthInteger			integer
multipleBirth[x]:multipleBirthBoolean		0..1	boolean	Whether patient is part of a multiple birth
multipleBirth[x]:multipleBirthInteger		0..1	integer	Whether patient is part of a multiple birth
photo	S	0..*	Attachment	Image of the patient
contact	SC	1..1	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	1..*	CodeableConcept	The kind of relationship Binding: patient-contact-relationship (??) (extensible)
name	S	1..1	HumanName	A name associated with the contact person
telecom	S	1..1	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)
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	S	1..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	SΣ	1..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!SΣ	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	SΣ	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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.identifier:nationalID.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:nationalID.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.identifier:shaID.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:shaID.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.identifier:facilityUPI.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:facilityUPI.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 From the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 From the FHIR Standard
Patient.maritalStatus	extensible	http://terminology.health.go.ke/ValueSet/marital-status-kenya http://terminology.health.go.ke/ValueSet/marital-status-kenya
Patient.contact.relationship	extensible	http://hl7.org/fhir/ValueSet/patient-contact-relationship http://hl7.org/fhir/ValueSet/patient-contact-relationship
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
pat-1	error	Patient, Patient.contact	Must have at least one given name and one family name : name.given.exists() and name.family.exists()
pat-2	error	Patient	telecom must include both system and value : telecom.system.exists() and telecom.value.exists()
pat-3	error	Patient	If contact is present, it must have relationship and name : contact.relationship.exists() and contact.name.exists()
pat-4	error	Patient	address must have line, district, and state : address.line.exists() and address.district.exists() and address.state.exists()

This structure is derived from Patient

Summary

Mandatory: 25 elements(1 nested mandatory element)
Must-Support: 25 elements
Fixed: 4 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/patient-nationality
• https://oncology.ig.kenya/StructureDefinition/patient-educationLevel
• https://oncology.ig.kenya/StructureDefinition/patient-occupation

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.identifier
• The element 1 is sliced based on the value of Patient.multipleBirth[x]

Differential View

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	Patient	Information about an individual or animal receiving health care services Constraints: pat-1, pat-2, pat-3, pat-4
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:nationality		0..1	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
extension:educationLevel		0..1	(Complex)	Patient Education Level URL: https://oncology.ig.kenya/StructureDefinition/patient-educationLevel
extension:occupation		0..1	CodeableConcept	Patient Occupation URL: https://oncology.ig.kenya/StructureDefinition/patient-occupation
Slices for identifier	S	2..*	Identifier	At least National ID and SHA ID must be provided Slice: Unordered, Open by pattern:system
identifier:nationalID	S	1..1	Identifier	An identifier for this patient
system		1..1	uri	The namespace for the identifier value Fixed Value: http://gov.ke/national-id
value	S	1..1	string	The value that is unique
identifier:shaID	S	1..1	Identifier	An identifier for this patient
system		1..1	uri	The namespace for the identifier value Fixed Value: https://sha.go.ke/ids/patient
value	S	1..1	string	The value that is unique
identifier:facilityUPI		0..1	Identifier	An identifier for this patient
system		1..1	uri	The namespace for the identifier value Fixed Value: http://facility.health.go.ke/upi
active	S	1..1	boolean	Whether this patient's record is in active use
name	S	1..1	HumanName	A name associated with the patient
family	S	1..1	string	Family name (often called 'Surname')
given	S	1..*	string	Given names (not always 'first'). Includes middle names
telecom	S	1..*	ContactPoint	A contact detail for the individual
system		1..1	code	phone | fax | email | pager | url | sms | other
value		1..1	string	The actual contact point details
gender	S	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required)
birthDate	S	1..1	date	The date of birth for the individual
address	S	1..1	Address	An address for the individual
line	S	1..1	string	Street name, number, direction & P.O. Box etc.
district	S	1..1	string	District name (aka county)
state	S	1..1	string	Sub-unit of country (abbreviations ok)
country		0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Fixed Value: KE
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: http://terminology.health.go.ke/ValueSet/marital-status-kenya (extensible)
Slices for multipleBirth[x]		0..1	boolean, integer	Whether patient is part of a multiple birth Slice: Unordered, Open by type:$this
multipleBirth[x]:multipleBirthBoolean		0..1	boolean	Whether patient is part of a multiple birth
multipleBirth[x]:multipleBirthInteger		0..1	integer	Whether patient is part of a multiple birth
photo	S	0..*	Attachment	Image of the patient
contact	S	1..1	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
relationship	S	1..*	CodeableConcept	The kind of relationship Binding: patient-contact-relationship (??) (extensible)
name	S	1..1	HumanName	A name associated with the contact person
telecom	S	1..1	ContactPoint	A contact detail for the person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required)
generalPractitioner	S	1..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	S	1..1	Reference(Organization)	Organization that is the custodian of the patient record
link	S	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
other	S	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)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.maritalStatus	extensible	http://terminology.health.go.ke/ValueSet/marital-status-kenya http://terminology.health.go.ke/ValueSet/marital-status-kenya
Patient.contact.relationship	extensible	http://hl7.org/fhir/ValueSet/patient-contact-relationship http://hl7.org/fhir/ValueSet/patient-contact-relationship
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
pat-1	error	Patient	Must have at least one given name and one family name : name.given.exists() and name.family.exists()
pat-2	error	Patient	telecom must include both system and value : telecom.system.exists() and telecom.value.exists()
pat-3	error	Patient	If contact is present, it must have relationship and name : contact.relationship.exists() and contact.name.exists()
pat-4	error	Patient	address must have line, district, and state : address.line.exists() and address.district.exists() and address.state.exists()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	Patient	Information about an individual or animal receiving health care services Constraints: pat-1, pat-2, pat-3, pat-4
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:nationality		0..1	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
extension:educationLevel		0..1	(Complex)	Patient Education Level URL: https://oncology.ig.kenya/StructureDefinition/patient-educationLevel
extension:occupation		0..1	CodeableConcept	Patient Occupation URL: https://oncology.ig.kenya/StructureDefinition/patient-occupation
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	2..*	Identifier	At least National ID and SHA ID must be provided Slice: Unordered, Open by pattern:system
identifier:nationalID	SΣ	1..1	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://gov.ke/national-id
value	SΣ	1..1	string	The value that is unique Example General: 123456
identifier:shaID	SΣ	1..1	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://sha.go.ke/ids/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
identifier:facilityUPI	Σ	0..1	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://facility.health.go.ke/upi
active	?!SΣ	1..1	boolean	Whether this patient's record is in active use
name	SΣ	1..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.
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	1..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
telecom	SΣ	1..*	ContactPoint	A contact detail for the individual
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	1..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required)
birthDate	SΣ	1..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	1..1	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
line	SΣ	1..1	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
district	SΣ	1..1	string	District name (aka county) Example General: Madison
state	SΣ	1..1	string	Sub-unit of country (abbreviations ok)
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Fixed Value: KE
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: http://terminology.health.go.ke/ValueSet/marital-status-kenya (extensible)
Slices for multipleBirth[x]		0..1		Whether patient is part of a multiple birth Slice: Unordered, Closed by type:$this
multipleBirthBoolean			boolean
multipleBirthInteger			integer
multipleBirth[x]:multipleBirthBoolean		0..1	boolean	Whether patient is part of a multiple birth
multipleBirth[x]:multipleBirthInteger		0..1	integer	Whether patient is part of a multiple birth
photo	S	0..*	Attachment	Image of the patient
contact	SC	1..1	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	1..*	CodeableConcept	The kind of relationship Binding: patient-contact-relationship (??) (extensible)
name	S	1..1	HumanName	A name associated with the contact person
telecom	S	1..1	ContactPoint	A contact detail for the person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required)
generalPractitioner	S	1..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	SΣ	1..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!SΣ	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	SΣ	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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.identifier:nationalID.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:shaID.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:facilityUPI.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 From the FHIR Standard
Patient.maritalStatus	extensible	http://terminology.health.go.ke/ValueSet/marital-status-kenya http://terminology.health.go.ke/ValueSet/marital-status-kenya
Patient.contact.relationship	extensible	http://hl7.org/fhir/ValueSet/patient-contact-relationship http://hl7.org/fhir/ValueSet/patient-contact-relationship
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
pat-1	error	Patient, Patient.contact	Must have at least one given name and one family name : name.given.exists() and name.family.exists()
pat-2	error	Patient	telecom must include both system and value : telecom.system.exists() and telecom.value.exists()
pat-3	error	Patient	If contact is present, it must have relationship and name : contact.relationship.exists() and contact.name.exists()
pat-4	error	Patient	address must have line, district, and state : address.line.exists() and address.district.exists() and address.state.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	Patient	Information about an individual or animal receiving health care services Constraints: pat-1, pat-2, pat-3, pat-4
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
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		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:nationality		0..1	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
extension:educationLevel		0..1	(Complex)	Patient Education Level URL: https://oncology.ig.kenya/StructureDefinition/patient-educationLevel
extension:occupation		0..1	CodeableConcept	Patient Occupation URL: https://oncology.ig.kenya/StructureDefinition/patient-occupation
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	2..*	Identifier	At least National ID and SHA ID must be provided Slice: Unordered, Open by pattern:system
identifier:nationalID	SΣ	1..1	Identifier	An identifier for this 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 | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
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: http://gov.ke/national-id
value	SΣ	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)
identifier:shaID	SΣ	1..1	Identifier	An identifier for this 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 | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
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://sha.go.ke/ids/patient
value	SΣ	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)
identifier:facilityUPI	Σ	0..1	Identifier	An identifier for this 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 | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
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: http://facility.health.go.ke/upi
value	Σ	0..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	?!SΣ	1..1	boolean	Whether this patient's record is in active use
name	SΣ	1..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	Text representation of the full name
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	1..*	string	Given names (not always 'first'). Includes 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Σ	1..*	ContactPoint	A contact detail 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
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	1..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required)
birthDate	SΣ	1..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	1..1	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	SΣ	1..1	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	SΣ	1..1	string	District name (aka county) Example General: Madison
state	SΣ	1..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Fixed Value: KE
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: http://terminology.health.go.ke/ValueSet/marital-status-kenya (extensible)
Slices for multipleBirth[x]		0..1		Whether patient is part of a multiple birth Slice: Unordered, Closed by type:$this
multipleBirthBoolean			boolean
multipleBirthInteger			integer
multipleBirth[x]:multipleBirthBoolean		0..1	boolean	Whether patient is part of a multiple birth
multipleBirth[x]:multipleBirthInteger		0..1	integer	Whether patient is part of a multiple birth
photo	S	0..*	Attachment	Image of the patient
contact	SC	1..1	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	1..*	CodeableConcept	The kind of relationship Binding: patient-contact-relationship (??) (extensible)
name	S	1..1	HumanName	A name associated with the contact person
telecom	S	1..1	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)
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	S	1..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	SΣ	1..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!SΣ	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	SΣ	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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.identifier:nationalID.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:nationalID.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.identifier:shaID.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:shaID.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.identifier:facilityUPI.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:facilityUPI.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 From the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 From the FHIR Standard
Patient.maritalStatus	extensible	http://terminology.health.go.ke/ValueSet/marital-status-kenya http://terminology.health.go.ke/ValueSet/marital-status-kenya
Patient.contact.relationship	extensible	http://hl7.org/fhir/ValueSet/patient-contact-relationship http://hl7.org/fhir/ValueSet/patient-contact-relationship
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
pat-1	error	Patient, Patient.contact	Must have at least one given name and one family name : name.given.exists() and name.family.exists()
pat-2	error	Patient	telecom must include both system and value : telecom.system.exists() and telecom.value.exists()
pat-3	error	Patient	If contact is present, it must have relationship and name : contact.relationship.exists() and contact.name.exists()
pat-4	error	Patient	address must have line, district, and state : address.line.exists() and address.district.exists() and address.state.exists()

This structure is derived from Patient

Summary

Mandatory: 25 elements(1 nested mandatory element)
Must-Support: 25 elements
Fixed: 4 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/patient-nationality
• https://oncology.ig.kenya/StructureDefinition/patient-educationLevel
• https://oncology.ig.kenya/StructureDefinition/patient-occupation

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.identifier
• The element 1 is sliced based on the value of Patient.multipleBirth[x]