HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia - 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: ZM-Core Related Person Profile

Zambia related person profile for next of kin, caregivers, guardians, treatment supporters, and patient-linked contacts.

Usages:

• Refer to this Profile: ZM-Core Adverse Event Profile, ZM-Core MedicationRequest Profile and ZM-Core Service Request Profile

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and their representations.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	A human identifier for this person
active	?!SΣ	0..1	boolean	Whether this related person's record is in active use
patient	SΣ	1..1	Reference(ZM-Core Patient Profile)	The patient this person is related to
relationship	SΣ	1..*	CodeableConcept	The relationship of the related person to the patient Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
name	SΣ	1..*	HumanName	A name associated with the person
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
telecom	SΣ	0..*	ContactPoint	A contact detail for the person
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date on which the related person was born
address	SΣ	0..*	Address	Address where the related person can be contacted or visited
period	S	0..1	Period	Period of time that this relationship is considered valid
communication	S	0..*	BackboneElement	A language which may be used to communicate with the related person about the patient's 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 related person about the patient's health Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.relationship	Base	preferred	Patient Relationship Type	📍5.0.0	FHIR Std.
RelatedPerson.name.use	Base	required	NameUse	📍5.0.0	FHIR Std.
RelatedPerson.gender	Base	required	AdministrativeGender	📍5.0.0	FHIR Std.
RelatedPerson.communication.​language	Base	required	All Languages	📍5.0.0	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	RelatedPerson	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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	RelatedPerson	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	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	RelatedPerson	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()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care
identifier	S	0..*	Identifier	A human identifier for this person
active	S	0..1	boolean	Whether this related person's record is in active use
patient	S	1..1	Reference(ZM-Core Patient Profile)	The patient this person is related to
relationship	S	1..*	CodeableConcept	The relationship of the related person to the patient
name	S	1..*	HumanName	A name associated with the person
family	S	0..1	string	Family name (often called 'Surname')
given	S	0..*	string	Given names (not always 'first'). Includes middle names
telecom	S	0..*	ContactPoint	A contact detail for the person
gender	S	0..1	code	male | female | other | unknown
birthDate	S	0..1	date	The date on which the related person was born
address	S	0..*	Address	Address where the related person can be contacted or visited
period	S	0..1	Period	Period of time that this relationship is considered valid
communication	S	0..*	BackboneElement	A language which may be used to communicate with the related person about the patient's health
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care
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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	A human identifier for this person
active	?!SΣ	0..1	boolean	Whether this related person's record is in active use
patient	SΣ	1..1	Reference(ZM-Core Patient Profile)	The patient this person is related to
relationship	SΣ	1..*	CodeableConcept	The relationship of the related person to the patient Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
name	SΣ	1..*	HumanName	A name associated with the person
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | 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Σ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
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 person
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date on which the related person was born
address	SΣ	0..*	Address	Address where the related person can be contacted or visited
photo		0..*	Attachment	Image of the person
period	S	0..1	Period	Period of time that this relationship is considered valid
communication	S	0..*	BackboneElement	A language which may be used to communicate with the related person about the patient's 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 related person about the patient's health Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
preferred		0..1	boolean	Language preference indicator
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.language	Base	required	All Languages	📍5.0.0	FHIR Std.
RelatedPerson.relationship	Base	preferred	Patient Relationship Type	📍5.0.0	FHIR Std.
RelatedPerson.name.use	Base	required	NameUse	📍5.0.0	FHIR Std.
RelatedPerson.gender	Base	required	AdministrativeGender	📍5.0.0	FHIR Std.
RelatedPerson.communication.​language	Base	required	All Languages	📍5.0.0	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	RelatedPerson	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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	RelatedPerson	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	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	RelatedPerson	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()

Summary

Mandatory: 2 elements
Must-Support: 13 elements

Structures

This structure refers to these other structures:

• ZM-Core Patient Profile (http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-patient)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	A human identifier for this person
active	?!SΣ	0..1	boolean	Whether this related person's record is in active use
patient	SΣ	1..1	Reference(ZM-Core Patient Profile)	The patient this person is related to
relationship	SΣ	1..*	CodeableConcept	The relationship of the related person to the patient Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
name	SΣ	1..*	HumanName	A name associated with the person
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
telecom	SΣ	0..*	ContactPoint	A contact detail for the person
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date on which the related person was born
address	SΣ	0..*	Address	Address where the related person can be contacted or visited
period	S	0..1	Period	Period of time that this relationship is considered valid
communication	S	0..*	BackboneElement	A language which may be used to communicate with the related person about the patient's 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 related person about the patient's health Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.relationship	Base	preferred	Patient Relationship Type	📍5.0.0	FHIR Std.
RelatedPerson.name.use	Base	required	NameUse	📍5.0.0	FHIR Std.
RelatedPerson.gender	Base	required	AdministrativeGender	📍5.0.0	FHIR Std.
RelatedPerson.communication.​language	Base	required	All Languages	📍5.0.0	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	RelatedPerson	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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	RelatedPerson	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	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	RelatedPerson	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()

Differential View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care
identifier	S	0..*	Identifier	A human identifier for this person
active	S	0..1	boolean	Whether this related person's record is in active use
patient	S	1..1	Reference(ZM-Core Patient Profile)	The patient this person is related to
relationship	S	1..*	CodeableConcept	The relationship of the related person to the patient
name	S	1..*	HumanName	A name associated with the person
family	S	0..1	string	Family name (often called 'Surname')
given	S	0..*	string	Given names (not always 'first'). Includes middle names
telecom	S	0..*	ContactPoint	A contact detail for the person
gender	S	0..1	code	male | female | other | unknown
birthDate	S	0..1	date	The date on which the related person was born
address	S	0..*	Address	Address where the related person can be contacted or visited
period	S	0..1	Period	Period of time that this relationship is considered valid
communication	S	0..*	BackboneElement	A language which may be used to communicate with the related person about the patient's health
Documentation for this format

Snapshot ViewView

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care
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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	A human identifier for this person
active	?!SΣ	0..1	boolean	Whether this related person's record is in active use
patient	SΣ	1..1	Reference(ZM-Core Patient Profile)	The patient this person is related to
relationship	SΣ	1..*	CodeableConcept	The relationship of the related person to the patient Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
name	SΣ	1..*	HumanName	A name associated with the person
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | 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Σ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
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 person
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date on which the related person was born
address	SΣ	0..*	Address	Address where the related person can be contacted or visited
photo		0..*	Attachment	Image of the person
period	S	0..1	Period	Period of time that this relationship is considered valid
communication	S	0..*	BackboneElement	A language which may be used to communicate with the related person about the patient's 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 related person about the patient's health Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
preferred		0..1	boolean	Language preference indicator
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.language	Base	required	All Languages	📍5.0.0	FHIR Std.
RelatedPerson.relationship	Base	preferred	Patient Relationship Type	📍5.0.0	FHIR Std.
RelatedPerson.name.use	Base	required	NameUse	📍5.0.0	FHIR Std.
RelatedPerson.gender	Base	required	AdministrativeGender	📍5.0.0	FHIR Std.
RelatedPerson.communication.​language	Base	required	All Languages	📍5.0.0	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	RelatedPerson	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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	RelatedPerson	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	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	RelatedPerson	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()

Summary

Mandatory: 2 elements
Must-Support: 13 elements

Structures

This structure refers to these other structures:

• ZM-Core Patient Profile (http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-patient)

Other representations of profile: CSV, Excel, Schematron