Scope and Usage

The Zimbabwe Patient profile (ZimPatient) is the national core representation of a person receiving health services in Zimbabwe. It constrains the base FHIR R4 Patient resource to carry the demographic and identifying information required for interoperability across Zimbabwean health information systems.

This profile is intended to be referenced by every other resource in this Implementation Guide that points to a patient (for example Encounter.subject, Observation.subject, Condition.subject).

Must Support

The following elements are flagged Must Support — consuming systems are expected to be able to process them and producing systems should populate them where the data is available:

• identifier — national identifiers (see below)
• name (with family and given)
• gender, birthDate, maritalStatus
• telecom — phone / email contact points
• communication.language — the patient's preferred language
• contact — next of kin / emergency contact
• address (with province and district)
• deceased[x]
• the citizenship and place of birth extensions

Identifiers

A patient must carry at least one identifier. Identifiers are sliced by system into three nationally recognised types:

The National Identity and Passport Number formats are enforced by the NationalIdentityPattern and PassportNumberPattern invariants.

Note: the identifier system URLs above are interim values and should be replaced with the official MOHCC canonical identifier systems before publication.

Terminology

• Gender is bound (required) to ZimGenderVS.
• Marital status is bound (required) to ZimMaritalStatusVS.
• Address province (address.state) is bound (required) to ZimProvinceVS — the ten provinces of Zimbabwe as ISO 3166-2 codes.
• Preferred language (communication.language) is bound (preferred) to ZimLanguageVS — the official languages of Zimbabwe as BCP-47 codes.
• address.country is fixed to ZW.

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

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: NationalIdentityPattern, PassportNumberPattern, HealthIdPattern
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:citizenship	S	0..*	(Complex)	Patient citizenship URL: http://mohcc.gov.zw/fhir/core/StructureDefinition/citizenship
extension:placeofbirth	S	0..1	Address	Patient place of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:NationalIdentity	SΣ	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 .
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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: NI
display		1..1	string	Representation defined by the system Fixed Value: National unique individual identifier
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: National Identity
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://mohcc.gov.zw/identifiers/nationalID
identifier:HealthId	SΣ	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 Required Pattern: http://mohcc.gov.zw/identifiers/phid
identifier:PassportNumber	SΣ	0..*	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 .
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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PPN
display		1..1	string	Representation defined by the system Fixed Value: Passport number
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: Passport Number
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://mohcc.gov.zw/identifiers/passport
active	?!Σ	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.
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Σ	0..*	ContactPoint	A contact detail for the individual
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	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: Gender Value Set (required)
birthDate	SΣ	1..1	date	The date of birth for the individual
deceased[x]	?!SΣ	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
line	SΣ	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	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	SΣ	0..1	string	District name (aka county) Binding: Zimbabwe District Value Set (required) Example General: Madison
state	SΣ	0..1	string	Province Binding: Zimbabwe Province Value Set (required)
country	Σ	1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Required Pattern: ZW
maritalStatus	S	1..1	CodeableConcept	Marital (civil) status of a patient Binding: MaritalStatus Value Set (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 (extensible): The nature of the relationship between a patient and a contact person for that patient.
name	S	0..1	HumanName	A name associated with the contact person
telecom	S	0..*	ContactPoint	A contact detail for the person
communication	S	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
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: Zimbabwe Language Value Set (preferred)
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:NationalIdentity.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:NationalIdentity.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:HealthId.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:PassportNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:PassportNumber.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	Gender Value Set	📦0.1.0	This IG
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.district	Base	required	Zimbabwe District Value Set	📦0.1.0	This IG
Patient.address.state	Base	required	Zimbabwe Province Value Set	📦0.1.0	This IG
Patient.maritalStatus	Base	required	MaritalStatus Value Set	📦0.1.0	This IG
Patient.contact.relationship	Base	extensible	Patient Contact Relationship	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	preferred	Zimbabwe Language Value Set	📦0.1.0	This IG
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
HealthIdPattern	error	Patient	If present, the Health ID (PHID) must follow the format DDDSDDDX: three digits, one letter (A-Z excluding I and O), three digits, and a final Luhn check digit (a digit). This invariant enforces the structural format; the Luhn check digit value itself must be validated by the assigning system / application layer.	identifier.where(type.text = 'Health ID').all(value.matches('^[0-9]{3}[A-HJ-NP-Z][0-9]{3}[0-9]$'))
NationalIdentityPattern	error	Patient	If present, National Identity identifier.value must match the pattern: 2 digits, a hyphen, 5 or 6 digits, one letter (case-insensitive), then 2 digits (examples: 01-234567B89, 01-23456b78).	identifier.where(type.text = 'National Identity').all(value.matches('^\\d{2}-\\d{5,6}[A-Za-z]\\d{2}$'))
PassportNumberPattern	error	Patient	If present, Passport Number identifier.value must match the pattern: 2 uppercase letters followed by 6 or 7 digits (example: CN123456).	identifier.where(type.text = 'Passport Number').all(value.matches('^[A-Z]{2}\\d{6,7}$'))
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.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()

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: NationalIdentityPattern, PassportNumberPattern, HealthIdPattern
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:citizenship	S	0..*	(Complex)	Patient citizenship URL: http://mohcc.gov.zw/fhir/core/StructureDefinition/citizenship
extension:placeofbirth	S	0..1	Address	Patient place of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Slices for identifier	S	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:NationalIdentity	S	0..1	Identifier	An identifier for this patient
type		0..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: NI
display		1..1	string	Representation defined by the system Fixed Value: National unique individual identifier
text		0..1	string	Plain text representation of the concept Required Pattern: National Identity
system		1..1	uri	The namespace for the identifier value Required Pattern: http://mohcc.gov.zw/identifiers/nationalID
identifier:HealthId	S	0..1	Identifier	An identifier for this patient
type
text		0..1	string	Plain text representation of the concept Required Pattern: Health ID
system		1..1	uri	The namespace for the identifier value Required Pattern: http://mohcc.gov.zw/identifiers/phid
identifier:PassportNumber	S	0..*	Identifier	An identifier for this patient
type		0..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PPN
display		1..1	string	Representation defined by the system Fixed Value: Passport number
text		0..1	string	Plain text representation of the concept Required Pattern: Passport Number
system		1..1	uri	The namespace for the identifier value Required Pattern: http://mohcc.gov.zw/identifiers/passport
name	S	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	0..*	ContactPoint	A contact detail for the individual
system	S	1..1	code	phone | fax | email | pager | url | sms | other
value	S	1..1	string	The actual contact point details
gender	S	1..1	code	male | female | other | unknown Binding: Gender Value Set (required)
birthDate	S	1..1	date	The date of birth for the individual
deceased[x]	S	0..1	boolean, dateTime	Indicates if the individual is deceased or not
address	S	0..*	Address	An address for the individual
line	S	0..*	string	Street name, number, direction & P.O. Box etc.
city	S	0..1	string	Name of city, town etc.
district	S	0..1	string	District name (aka county) Binding: Zimbabwe District Value Set (required)
state	S	0..1	string	Province Binding: Zimbabwe Province Value Set (required)
country		1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Required Pattern: ZW
maritalStatus	S	1..1	CodeableConcept	Marital (civil) status of a patient Binding: MaritalStatus Value Set (required)
contact	S	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
relationship	S	0..*	CodeableConcept	The kind of relationship
name	S	0..1	HumanName	A name associated with the contact person
telecom	S	0..*	ContactPoint	A contact detail for the person
communication	S	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Zimbabwe Language Value Set (preferred)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Patient.gender	Base	required	Gender Value Set	📦0.1.0	This IG
Patient.address.district	Base	required	Zimbabwe District Value Set	📦0.1.0	This IG
Patient.address.state	Base	required	Zimbabwe Province Value Set	📦0.1.0	This IG
Patient.maritalStatus	Base	required	MaritalStatus Value Set	📦0.1.0	This IG
Patient.communication.​language	Base	preferred	Zimbabwe Language Value Set	📦0.1.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
HealthIdPattern	error	Patient	If present, the Health ID (PHID) must follow the format DDDSDDDX: three digits, one letter (A-Z excluding I and O), three digits, and a final Luhn check digit (a digit). This invariant enforces the structural format; the Luhn check digit value itself must be validated by the assigning system / application layer.	identifier.where(type.text = 'Health ID').all(value.matches('^[0-9]{3}[A-HJ-NP-Z][0-9]{3}[0-9]$'))
NationalIdentityPattern	error	Patient	If present, National Identity identifier.value must match the pattern: 2 digits, a hyphen, 5 or 6 digits, one letter (case-insensitive), then 2 digits (examples: 01-234567B89, 01-23456b78).	identifier.where(type.text = 'National Identity').all(value.matches('^\\d{2}-\\d{5,6}[A-Za-z]\\d{2}$'))
PassportNumberPattern	error	Patient	If present, Passport Number identifier.value must match the pattern: 2 uppercase letters followed by 6 or 7 digits (example: CN123456).	identifier.where(type.text = 'Passport Number').all(value.matches('^[A-Z]{2}\\d{6,7}$'))

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: NationalIdentityPattern, PassportNumberPattern, HealthIdPattern
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:citizenship	S	0..*	(Complex)	Patient citizenship URL: http://mohcc.gov.zw/fhir/core/StructureDefinition/citizenship
extension:placeofbirth	S	0..1	Address	Patient place of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:NationalIdentity	SΣ	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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: NI
display		1..1	string	Representation defined by the system Fixed Value: National unique individual identifier
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: National Identity
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://mohcc.gov.zw/identifiers/nationalID
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)
identifier:HealthId	SΣ	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.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: Health ID
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://mohcc.gov.zw/identifiers/phid
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)
identifier:PassportNumber	SΣ	0..*	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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PPN
display		1..1	string	Representation defined by the system Fixed Value: Passport number
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: Passport Number
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://mohcc.gov.zw/identifiers/passport
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	?!Σ	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	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Σ	0..*	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	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	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: Gender Value Set (required)
birthDate	SΣ	1..1	date	The date of birth for the individual
deceased[x]	?!SΣ	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	SΣ	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	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	SΣ	0..1	string	District name (aka county) Binding: Zimbabwe District Value Set (required) Example General: Madison
state	SΣ	0..1	string	Province Binding: Zimbabwe Province Value Set (required)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Required Pattern: ZW
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus	S	1..1	CodeableConcept	Marital (civil) status of a patient Binding: MaritalStatus Value Set (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 (extensible): The nature of the relationship between a patient and a contact person for that patient.
name	S	0..1	HumanName	A name associated with the contact person
telecom	S	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	S	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: Zimbabwe Language Value Set (preferred)
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.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.identifier:NationalIdentity.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:NationalIdentity.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:HealthId.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:HealthId.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:PassportNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:PassportNumber.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	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.district	Base	required	Zimbabwe District Value Set	📦0.1.0	This IG
Patient.address.state	Base	required	Zimbabwe Province Value Set	📦0.1.0	This IG
Patient.maritalStatus	Base	required	MaritalStatus Value Set	📦0.1.0	This IG
Patient.contact.relationship	Base	extensible	Patient Contact Relationship	📍4.0.1	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	preferred	Zimbabwe Language Value Set	📦0.1.0	This IG
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
HealthIdPattern	error	Patient	If present, the Health ID (PHID) must follow the format DDDSDDDX: three digits, one letter (A-Z excluding I and O), three digits, and a final Luhn check digit (a digit). This invariant enforces the structural format; the Luhn check digit value itself must be validated by the assigning system / application layer.	identifier.where(type.text = 'Health ID').all(value.matches('^[0-9]{3}[A-HJ-NP-Z][0-9]{3}[0-9]$'))
NationalIdentityPattern	error	Patient	If present, National Identity identifier.value must match the pattern: 2 digits, a hyphen, 5 or 6 digits, one letter (case-insensitive), then 2 digits (examples: 01-234567B89, 01-23456b78).	identifier.where(type.text = 'National Identity').all(value.matches('^\\d{2}-\\d{5,6}[A-Za-z]\\d{2}$'))
PassportNumberPattern	error	Patient	If present, Passport Number identifier.value must match the pattern: 2 uppercase letters followed by 6 or 7 digits (example: CN123456).	identifier.where(type.text = 'Passport Number').all(value.matches('^[A-Z]{2}\\d{6,7}$'))
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.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()

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: NationalIdentityPattern, PassportNumberPattern, HealthIdPattern
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:citizenship	S	0..*	(Complex)	Patient citizenship URL: http://mohcc.gov.zw/fhir/core/StructureDefinition/citizenship
extension:placeofbirth	S	0..1	Address	Patient place of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:NationalIdentity	SΣ	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 .
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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: NI
display		1..1	string	Representation defined by the system Fixed Value: National unique individual identifier
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: National Identity
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://mohcc.gov.zw/identifiers/nationalID
identifier:HealthId	SΣ	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 Required Pattern: http://mohcc.gov.zw/identifiers/phid
identifier:PassportNumber	SΣ	0..*	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 .
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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PPN
display		1..1	string	Representation defined by the system Fixed Value: Passport number
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: Passport Number
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://mohcc.gov.zw/identifiers/passport
active	?!Σ	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.
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Σ	0..*	ContactPoint	A contact detail for the individual
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	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: Gender Value Set (required)
birthDate	SΣ	1..1	date	The date of birth for the individual
deceased[x]	?!SΣ	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
line	SΣ	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	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	SΣ	0..1	string	District name (aka county) Binding: Zimbabwe District Value Set (required) Example General: Madison
state	SΣ	0..1	string	Province Binding: Zimbabwe Province Value Set (required)
country	Σ	1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Required Pattern: ZW
maritalStatus	S	1..1	CodeableConcept	Marital (civil) status of a patient Binding: MaritalStatus Value Set (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 (extensible): The nature of the relationship between a patient and a contact person for that patient.
name	S	0..1	HumanName	A name associated with the contact person
telecom	S	0..*	ContactPoint	A contact detail for the person
communication	S	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
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: Zimbabwe Language Value Set (preferred)
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:NationalIdentity.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:NationalIdentity.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:HealthId.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:PassportNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:PassportNumber.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	Gender Value Set	📦0.1.0	This IG
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.district	Base	required	Zimbabwe District Value Set	📦0.1.0	This IG
Patient.address.state	Base	required	Zimbabwe Province Value Set	📦0.1.0	This IG
Patient.maritalStatus	Base	required	MaritalStatus Value Set	📦0.1.0	This IG
Patient.contact.relationship	Base	extensible	Patient Contact Relationship	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	preferred	Zimbabwe Language Value Set	📦0.1.0	This IG
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
HealthIdPattern	error	Patient	If present, the Health ID (PHID) must follow the format DDDSDDDX: three digits, one letter (A-Z excluding I and O), three digits, and a final Luhn check digit (a digit). This invariant enforces the structural format; the Luhn check digit value itself must be validated by the assigning system / application layer.	identifier.where(type.text = 'Health ID').all(value.matches('^[0-9]{3}[A-HJ-NP-Z][0-9]{3}[0-9]$'))
NationalIdentityPattern	error	Patient	If present, National Identity identifier.value must match the pattern: 2 digits, a hyphen, 5 or 6 digits, one letter (case-insensitive), then 2 digits (examples: 01-234567B89, 01-23456b78).	identifier.where(type.text = 'National Identity').all(value.matches('^\\d{2}-\\d{5,6}[A-Za-z]\\d{2}$'))
PassportNumberPattern	error	Patient	If present, Passport Number identifier.value must match the pattern: 2 uppercase letters followed by 6 or 7 digits (example: CN123456).	identifier.where(type.text = 'Passport Number').all(value.matches('^[A-Z]{2}\\d{6,7}$'))
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.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()

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: NationalIdentityPattern, PassportNumberPattern, HealthIdPattern
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:citizenship	S	0..*	(Complex)	Patient citizenship URL: http://mohcc.gov.zw/fhir/core/StructureDefinition/citizenship
extension:placeofbirth	S	0..1	Address	Patient place of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Slices for identifier	S	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:NationalIdentity	S	0..1	Identifier	An identifier for this patient
type		0..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: NI
display		1..1	string	Representation defined by the system Fixed Value: National unique individual identifier
text		0..1	string	Plain text representation of the concept Required Pattern: National Identity
system		1..1	uri	The namespace for the identifier value Required Pattern: http://mohcc.gov.zw/identifiers/nationalID
identifier:HealthId	S	0..1	Identifier	An identifier for this patient
type
text		0..1	string	Plain text representation of the concept Required Pattern: Health ID
system		1..1	uri	The namespace for the identifier value Required Pattern: http://mohcc.gov.zw/identifiers/phid
identifier:PassportNumber	S	0..*	Identifier	An identifier for this patient
type		0..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PPN
display		1..1	string	Representation defined by the system Fixed Value: Passport number
text		0..1	string	Plain text representation of the concept Required Pattern: Passport Number
system		1..1	uri	The namespace for the identifier value Required Pattern: http://mohcc.gov.zw/identifiers/passport
name	S	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	0..*	ContactPoint	A contact detail for the individual
system	S	1..1	code	phone | fax | email | pager | url | sms | other
value	S	1..1	string	The actual contact point details
gender	S	1..1	code	male | female | other | unknown Binding: Gender Value Set (required)
birthDate	S	1..1	date	The date of birth for the individual
deceased[x]	S	0..1	boolean, dateTime	Indicates if the individual is deceased or not
address	S	0..*	Address	An address for the individual
line	S	0..*	string	Street name, number, direction & P.O. Box etc.
city	S	0..1	string	Name of city, town etc.
district	S	0..1	string	District name (aka county) Binding: Zimbabwe District Value Set (required)
state	S	0..1	string	Province Binding: Zimbabwe Province Value Set (required)
country		1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Required Pattern: ZW
maritalStatus	S	1..1	CodeableConcept	Marital (civil) status of a patient Binding: MaritalStatus Value Set (required)
contact	S	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
relationship	S	0..*	CodeableConcept	The kind of relationship
name	S	0..1	HumanName	A name associated with the contact person
telecom	S	0..*	ContactPoint	A contact detail for the person
communication	S	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Zimbabwe Language Value Set (preferred)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Patient.gender	Base	required	Gender Value Set	📦0.1.0	This IG
Patient.address.district	Base	required	Zimbabwe District Value Set	📦0.1.0	This IG
Patient.address.state	Base	required	Zimbabwe Province Value Set	📦0.1.0	This IG
Patient.maritalStatus	Base	required	MaritalStatus Value Set	📦0.1.0	This IG
Patient.communication.​language	Base	preferred	Zimbabwe Language Value Set	📦0.1.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
HealthIdPattern	error	Patient	If present, the Health ID (PHID) must follow the format DDDSDDDX: three digits, one letter (A-Z excluding I and O), three digits, and a final Luhn check digit (a digit). This invariant enforces the structural format; the Luhn check digit value itself must be validated by the assigning system / application layer.	identifier.where(type.text = 'Health ID').all(value.matches('^[0-9]{3}[A-HJ-NP-Z][0-9]{3}[0-9]$'))
NationalIdentityPattern	error	Patient	If present, National Identity identifier.value must match the pattern: 2 digits, a hyphen, 5 or 6 digits, one letter (case-insensitive), then 2 digits (examples: 01-234567B89, 01-23456b78).	identifier.where(type.text = 'National Identity').all(value.matches('^\\d{2}-\\d{5,6}[A-Za-z]\\d{2}$'))
PassportNumberPattern	error	Patient	If present, Passport Number identifier.value must match the pattern: 2 uppercase letters followed by 6 or 7 digits (example: CN123456).	identifier.where(type.text = 'Passport Number').all(value.matches('^[A-Z]{2}\\d{6,7}$'))

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: NationalIdentityPattern, PassportNumberPattern, HealthIdPattern
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:citizenship	S	0..*	(Complex)	Patient citizenship URL: http://mohcc.gov.zw/fhir/core/StructureDefinition/citizenship
extension:placeofbirth	S	0..1	Address	Patient place of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:NationalIdentity	SΣ	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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: NI
display		1..1	string	Representation defined by the system Fixed Value: National unique individual identifier
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: National Identity
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://mohcc.gov.zw/identifiers/nationalID
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)
identifier:HealthId	SΣ	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.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: Health ID
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://mohcc.gov.zw/identifiers/phid
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)
identifier:PassportNumber	SΣ	0..*	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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PPN
display		1..1	string	Representation defined by the system Fixed Value: Passport number
userSelected		0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Required Pattern: Passport Number
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://mohcc.gov.zw/identifiers/passport
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	?!Σ	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	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Σ	0..*	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	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	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: Gender Value Set (required)
birthDate	SΣ	1..1	date	The date of birth for the individual
deceased[x]	?!SΣ	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	SΣ	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	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	SΣ	0..1	string	District name (aka county) Binding: Zimbabwe District Value Set (required) Example General: Madison
state	SΣ	0..1	string	Province Binding: Zimbabwe Province Value Set (required)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Required Pattern: ZW
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus	S	1..1	CodeableConcept	Marital (civil) status of a patient Binding: MaritalStatus Value Set (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 (extensible): The nature of the relationship between a patient and a contact person for that patient.
name	S	0..1	HumanName	A name associated with the contact person
telecom	S	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	S	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: Zimbabwe Language Value Set (preferred)
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.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.identifier:NationalIdentity.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:NationalIdentity.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:HealthId.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:HealthId.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:PassportNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:PassportNumber.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	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.district	Base	required	Zimbabwe District Value Set	📦0.1.0	This IG
Patient.address.state	Base	required	Zimbabwe Province Value Set	📦0.1.0	This IG
Patient.maritalStatus	Base	required	MaritalStatus Value Set	📦0.1.0	This IG
Patient.contact.relationship	Base	extensible	Patient Contact Relationship	📍4.0.1	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	preferred	Zimbabwe Language Value Set	📦0.1.0	This IG
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
HealthIdPattern	error	Patient	If present, the Health ID (PHID) must follow the format DDDSDDDX: three digits, one letter (A-Z excluding I and O), three digits, and a final Luhn check digit (a digit). This invariant enforces the structural format; the Luhn check digit value itself must be validated by the assigning system / application layer.	identifier.where(type.text = 'Health ID').all(value.matches('^[0-9]{3}[A-HJ-NP-Z][0-9]{3}[0-9]$'))
NationalIdentityPattern	error	Patient	If present, National Identity identifier.value must match the pattern: 2 digits, a hyphen, 5 or 6 digits, one letter (case-insensitive), then 2 digits (examples: 01-234567B89, 01-23456b78).	identifier.where(type.text = 'National Identity').all(value.matches('^\\d{2}-\\d{5,6}[A-Za-z]\\d{2}$'))
PassportNumberPattern	error	Patient	If present, Passport Number identifier.value must match the pattern: 2 uppercase letters followed by 6 or 7 digits (example: CN123456).	identifier.where(type.text = 'Passport Number').all(value.matches('^[A-Z]{2}\\d{6,7}$'))
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.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()

This structure is derived from Patient

Summary

Mandatory: 7 elements(6 nested mandatory elements)
Must-Support: 26 elements

Extensions

This structure refers to these extensions:

• http://mohcc.gov.zw/fhir/core/StructureDefinition/citizenship
• http://hl7.org/fhir/StructureDefinition/patient-birthPlace|5.3.0

Slices

This structure defines the following Slices:

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