NPHCDA Immunization FHIR IG, published by https://nphcda.gov.ng. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Nigeria-FHIR-Community/ImmunizationIG/ and changes regularly. See the Directory of published versions

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

Resource Profile: NG-Imm RelatedPerson

Sibling that represents the mother’s other children as RelatedPersons.

Usages:

• Use this Profile: Nigeria Immunization Bundle
• Refer to this Profile: NG-Imm Patient
• Examples for this Profile: RelatedPerson/Child1, RelatedPerson/NgImmExampleSiblingRelatedPerson and RelatedPerson/Sister2

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.

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

This structure is derived from RelatedPerson

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson			RelatedPerson
implicitRules		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:siblingHealthStatus	S	0..1	CodeableConcept	NG-Imm Sibling's health status URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/sibling-health-status Binding: NG-Imm Sibling Health Status VS (required)
modifierExtension		0..0
active		0..0
patient	S	1..1	Reference(NG-Imm Patient)	The client this person is related to
relationship
text		0..1	string	The relationship of the sibling with the Client e.g. brother| sister Binding: NG-Imm Relationships VS (extensible)
name	S	1..*	HumanName	A name associated with the person
use		0..0
family		0..1	string	The surname of Client's sibling
given		1..*	string	The first name and other names of Client's sibling
gender		0..1	code	The sex of the Immunization client Binding: AdministrativeGender (required)
birthDate	S	0..1	date	The date the sibling was born
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
RelatedPerson.relationship.text	extensible	NGRelationshipsVS(a valid code from NG-Imm Relationships CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-relationship From this IG
RelatedPerson.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard

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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:siblingHealthStatus	S	0..1	CodeableConcept	NG-Imm Sibling's health status URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/sibling-health-status Binding: NG-Imm Sibling Health Status VS (required)
patient	SΣ	1..1	Reference(NG-Imm Patient)	The client this person is related to
name	SΣ	1..*	HumanName	A name associated with the person
family	Σ	0..1	string	The surname of Client's sibling
given	Σ	1..*	string	The first name and other names of Client's sibling This repeating element order: Given Names appear in the correct order for presenting the name
gender	Σ	0..1	code	The sex of the Immunization client Binding: AdministrativeGender (required)
birthDate	SΣ	0..1	date	The date the sibling was born
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RelatedPerson.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

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
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:siblingHealthStatus	S	0..1	CodeableConcept	NG-Imm Sibling's health status URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/sibling-health-status Binding: NG-Imm Sibling Health Status VS (required)
identifier	Σ	0..*	Identifier	A human identifier for this person
patient	SΣ	1..1	Reference(NG-Imm Patient)	The client this person is related to
relationship	Σ	0..*	CodeableConcept	The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related 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
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	The relationship of the sibling with the Client e.g. brother| sister Binding: NG-Imm Relationships VS (extensible)
name	SΣ	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
text	Σ	0..1	string	Text representation of the full name
family	Σ	0..1	string	The surname of Client's sibling
given	Σ	1..*	string	The first name and other names of Client's sibling 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	The sex of the Immunization client Binding: AdministrativeGender (required)
birthDate	SΣ	0..1	date	The date the sibling was born
address	Σ	0..*	Address	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	Conformance	ValueSet	URI
RelatedPerson.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.relationship	preferred	PatientRelationshipType http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype From the FHIR Standard
RelatedPerson.relationship.text	extensible	NGRelationshipsVS(a valid code from NG-Imm Relationships CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-relationship From this IG
RelatedPerson.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
RelatedPerson.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
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 RelatedPerson

Summary

Mandatory: 2 elements
Must-Support: 4 elements
Prohibited: 4 elements

Structures

This structure refers to these other structures:

• NG-Imm Patient (http://nphcda.gov.ng/ig/immunization/StructureDefinition/NgImmPatient)

Extensions

This structure refers to these extensions:

• http://nphcda.gov.ng/ig/immunization/StructureDefinition/sibling-health-status

Differential View

This structure is derived from RelatedPerson

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson			RelatedPerson
implicitRules		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:siblingHealthStatus	S	0..1	CodeableConcept	NG-Imm Sibling's health status URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/sibling-health-status Binding: NG-Imm Sibling Health Status VS (required)
modifierExtension		0..0
active		0..0
patient	S	1..1	Reference(NG-Imm Patient)	The client this person is related to
relationship
text		0..1	string	The relationship of the sibling with the Client e.g. brother| sister Binding: NG-Imm Relationships VS (extensible)
name	S	1..*	HumanName	A name associated with the person
use		0..0
family		0..1	string	The surname of Client's sibling
given		1..*	string	The first name and other names of Client's sibling
gender		0..1	code	The sex of the Immunization client Binding: AdministrativeGender (required)
birthDate	S	0..1	date	The date the sibling was born
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
RelatedPerson.relationship.text	extensible	NGRelationshipsVS(a valid code from NG-Imm Relationships CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-relationship From this IG
RelatedPerson.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard

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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:siblingHealthStatus	S	0..1	CodeableConcept	NG-Imm Sibling's health status URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/sibling-health-status Binding: NG-Imm Sibling Health Status VS (required)
patient	SΣ	1..1	Reference(NG-Imm Patient)	The client this person is related to
name	SΣ	1..*	HumanName	A name associated with the person
family	Σ	0..1	string	The surname of Client's sibling
given	Σ	1..*	string	The first name and other names of Client's sibling This repeating element order: Given Names appear in the correct order for presenting the name
gender	Σ	0..1	code	The sex of the Immunization client Binding: AdministrativeGender (required)
birthDate	SΣ	0..1	date	The date the sibling was born
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RelatedPerson.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Snapshot 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
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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:siblingHealthStatus	S	0..1	CodeableConcept	NG-Imm Sibling's health status URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/sibling-health-status Binding: NG-Imm Sibling Health Status VS (required)
identifier	Σ	0..*	Identifier	A human identifier for this person
patient	SΣ	1..1	Reference(NG-Imm Patient)	The client this person is related to
relationship	Σ	0..*	CodeableConcept	The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related 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
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	The relationship of the sibling with the Client e.g. brother| sister Binding: NG-Imm Relationships VS (extensible)
name	SΣ	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
text	Σ	0..1	string	Text representation of the full name
family	Σ	0..1	string	The surname of Client's sibling
given	Σ	1..*	string	The first name and other names of Client's sibling 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	The sex of the Immunization client Binding: AdministrativeGender (required)
birthDate	SΣ	0..1	date	The date the sibling was born
address	Σ	0..*	Address	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	Conformance	ValueSet	URI
RelatedPerson.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.relationship	preferred	PatientRelationshipType http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype From the FHIR Standard
RelatedPerson.relationship.text	extensible	NGRelationshipsVS(a valid code from NG-Imm Relationships CS) http://nphcda.gov.ng/ig/immunization/ValueSet/nigeria-relationship From this IG
RelatedPerson.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
RelatedPerson.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
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 RelatedPerson

Summary

Mandatory: 2 elements
Must-Support: 4 elements
Prohibited: 4 elements

Structures

This structure refers to these other structures:

• NG-Imm Patient (http://nphcda.gov.ng/ig/immunization/StructureDefinition/NgImmPatient)

Extensions

This structure refers to these extensions:

• http://nphcda.gov.ng/ig/immunization/StructureDefinition/sibling-health-status

Other representations of profile: CSV, Excel, Schematron