Draft Immunization FHIR Implementation Guide, published by UP Manila SILab. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/UP-Manila-SILab/immunizationfhirig/ and changes regularly. See the Directory of published versions

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

Resource Profile: SEIR RelatedPerson

A profile for RelatedPerson resource specific to Philippine context, particularly for mother's information.

Usages:

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

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	PHCoreRelatedPerson	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
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..*	PHCorePhilHealthID, PHCorePhilSysID	A human identifier for this person
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
value	Σ	1..1	string	Mother's PhilHealth Identification Number / Mother's PhilSys Identification Number Example General: 123456
active	?!Σ	0..1	boolean	Whether this related person's record is in active use
patient	Σ	1..1	Reference(Patient)	Patient reference
relationship	Σ	1..*	CodeableConcept	Link of Patient and Mother Binding: Beneficiary Relationship Codes (required)
name	Σ	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	Σ	1..1	string	Mother's Maiden Last Name
given	Σ	1..*	string	Mother's Maiden First Name / Mother's Maiden Middle Name This repeating element order: Given Names appear in the correct order for presenting the name
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
RelatedPerson.relationship	Base	required	Relationship	📦4.0.1	FHIR Std.
RelatedPerson.name.use	Base	required	NameUse	📍4.0.1	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().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	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()

This structure is derived from PHCoreRelatedPerson

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	PHCoreRelatedPerson	A person that is related to a patient, but who is not a direct target of care
identifier		1..*	PHCorePhilHealthID, PHCorePhilSysID	A human identifier for this person
value		1..1	string	Mother's PhilHealth Identification Number / Mother's PhilSys Identification Number
patient		1..1	Reference(Patient)	Patient reference
relationship		1..*	CodeableConcept	Link of Patient and Mother Binding: Beneficiary Relationship Codes (required)
name		1..*	HumanName	A name associated with the person
family		1..1	string	Mother's Maiden Last Name
given		1..*	string	Mother's Maiden First Name / Mother's Maiden Middle Name
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.relationship	Base	required	Relationship	📦4.0.1	FHIR Std.

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	PHCoreRelatedPerson	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: 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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..*	PHCorePhilHealthID, PHCorePhilSysID	A human identifier for this person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Mother's PhilHealth Identification Number / Mother's PhilSys Identification Number 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 related person's record is in active use
patient	Σ	1..1	Reference(Patient)	Patient reference
relationship	Σ	1..*	CodeableConcept	Link of Patient and Mother Binding: Beneficiary Relationship Codes (required)
name	Σ	1..*	HumanName	A name associated with the person
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	Σ	1..1	string	Mother's Maiden Last Name
given	Σ	1..*	string	Mother's Maiden First Name / Mother's Maiden Middle Name 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	Σ	0..*	ContactPoint	A contact detail for the person
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	0..1	date	The date on which the related person was born
address	Σ	0..*	PHCoreAddress	Address where the related person can be contacted or visited
photo		0..*	Attachment	Image of the person
period		0..1	Period	Period of time that this relationship is considered valid
communication		0..*	BackboneElement	A language which may be used to communicate with 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 patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
RelatedPerson.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
RelatedPerson.identifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
RelatedPerson.relationship	Base	required	Relationship	📦4.0.1	FHIR Std.
RelatedPerson.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
RelatedPerson.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
RelatedPerson.communication.​language	Base	preferred	Common Languages	📍4.0.1	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().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	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()

This structure is derived from PHCoreRelatedPerson

Summary

Mandatory: 6 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	PHCoreRelatedPerson	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
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..*	PHCorePhilHealthID, PHCorePhilSysID	A human identifier for this person
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
value	Σ	1..1	string	Mother's PhilHealth Identification Number / Mother's PhilSys Identification Number Example General: 123456
active	?!Σ	0..1	boolean	Whether this related person's record is in active use
patient	Σ	1..1	Reference(Patient)	Patient reference
relationship	Σ	1..*	CodeableConcept	Link of Patient and Mother Binding: Beneficiary Relationship Codes (required)
name	Σ	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	Σ	1..1	string	Mother's Maiden Last Name
given	Σ	1..*	string	Mother's Maiden First Name / Mother's Maiden Middle Name This repeating element order: Given Names appear in the correct order for presenting the name
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
RelatedPerson.relationship	Base	required	Relationship	📦4.0.1	FHIR Std.
RelatedPerson.name.use	Base	required	NameUse	📍4.0.1	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().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	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

This structure is derived from PHCoreRelatedPerson

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	PHCoreRelatedPerson	A person that is related to a patient, but who is not a direct target of care
identifier		1..*	PHCorePhilHealthID, PHCorePhilSysID	A human identifier for this person
value		1..1	string	Mother's PhilHealth Identification Number / Mother's PhilSys Identification Number
patient		1..1	Reference(Patient)	Patient reference
relationship		1..*	CodeableConcept	Link of Patient and Mother Binding: Beneficiary Relationship Codes (required)
name		1..*	HumanName	A name associated with the person
family		1..1	string	Mother's Maiden Last Name
given		1..*	string	Mother's Maiden First Name / Mother's Maiden Middle Name
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.relationship	Base	required	Relationship	📦4.0.1	FHIR Std.

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	PHCoreRelatedPerson	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: 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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..*	PHCorePhilHealthID, PHCorePhilSysID	A human identifier for this person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Mother's PhilHealth Identification Number / Mother's PhilSys Identification Number 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 related person's record is in active use
patient	Σ	1..1	Reference(Patient)	Patient reference
relationship	Σ	1..*	CodeableConcept	Link of Patient and Mother Binding: Beneficiary Relationship Codes (required)
name	Σ	1..*	HumanName	A name associated with the person
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	Σ	1..1	string	Mother's Maiden Last Name
given	Σ	1..*	string	Mother's Maiden First Name / Mother's Maiden Middle Name 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	Σ	0..*	ContactPoint	A contact detail for the person
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	0..1	date	The date on which the related person was born
address	Σ	0..*	PHCoreAddress	Address where the related person can be contacted or visited
photo		0..*	Attachment	Image of the person
period		0..1	Period	Period of time that this relationship is considered valid
communication		0..*	BackboneElement	A language which may be used to communicate with 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 patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
RelatedPerson.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
RelatedPerson.identifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
RelatedPerson.relationship	Base	required	Relationship	📦4.0.1	FHIR Std.
RelatedPerson.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
RelatedPerson.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
RelatedPerson.communication.​language	Base	preferred	Common Languages	📍4.0.1	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().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	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()

This structure is derived from PHCoreRelatedPerson

Summary

Mandatory: 6 elements

Other representations of profile: CSV, Excel, Schematron