Nigeria Immunization FHIR IG
0.1.0 - ci-build Nigeria flag

Nigeria Immunization FHIR IG, published by intellisoftkenya.com. 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/IntelliSOFT-Consulting/Nigeria-Immunization-FHIR-IG/ and changes regularly. See the Directory of published versions

Resource Profile: Related Person Profile - NEIR

Official URL: http://nhin.example.ng/StructureDefinition/NEIRRelatedPerson Version: 0.1.0
Draft as of 2025-08-11 Computable Name: NEIRRelatedPerson

Defines the RelatedPerson resource to represent parents, guardians, or caregivers associated with a child or dependent receiving immunization services in NEIR.

Usages:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... relationship SΣ 1..1 CodeableConcept The nature of the relationship
Binding: IMMZ.F.DE2 ValueSet for Client Relationship (required)
.... coding Σ 0..* Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 0..1 string Representation defined by the system
... name SΣ 0..* 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Σ 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 person
... gender SΣ 1..1 code male | female | other | unknown
Binding: IMMZ.C.DE5 ValueSet for Gender (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.relationshiprequiredRelatedPersonRelationshipTypeVS
http://nhin.example.ng/ValueSet/relatedPersonRelationshiptype-vs
From this IG
RelatedPerson.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
RelatedPerson.genderrequiredGenderVS
http://nhin.example.ng/ValueSet/gender-vs
From this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from RelatedPerson

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
... patient S 1..1 Reference(Patient Profile - NEIR) The patient this person is related to
... relationship S 1..1 CodeableConcept The nature of the relationship
Binding: IMMZ.F.DE2 ValueSet for Client Relationship (required)
.... coding
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
..... display S 0..1 string Representation defined by the system
... name S 0..* HumanName A name associated with the person
.... family S 0..1 string Family name (often called 'Surname')
.... given S 1..* string Given names (not always 'first'). Includes middle names
... gender S 1..1 code male | female | other | unknown
Binding: IMMZ.C.DE5 ValueSet for Gender (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
RelatedPerson.relationshiprequiredRelatedPersonRelationshipTypeVS
http://nhin.example.ng/ValueSet/relatedPersonRelationshiptype-vs
From this IG
RelatedPerson.genderrequiredGenderVS
http://nhin.example.ng/ValueSet/gender-vs
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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 Σ 0..* Identifier A human identifier for this person
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... patient SΣ 1..1 Reference(Patient Profile - NEIR) The patient this person is related to
... relationship SΣ 1..1 CodeableConcept The nature of the relationship
Binding: IMMZ.F.DE2 ValueSet for Client Relationship (required)
.... 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
..... 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Σ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... name SΣ 0..* 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 SΣ 0..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 person
... gender SΣ 1..1 code male | female | other | unknown
Binding: IMMZ.C.DE5 ValueSet for Gender (required)
... birthDate Σ 0..1 date The date on which the related person 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 BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
RelatedPerson.relationshiprequiredRelatedPersonRelationshipTypeVS
http://nhin.example.ng/ValueSet/relatedPersonRelationshiptype-vs
From this IG
RelatedPerson.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
RelatedPerson.genderrequiredGenderVS
http://nhin.example.ng/ValueSet/gender-vs
From this IG
RelatedPerson.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from RelatedPerson

Summary

Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 10 elements

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... relationship SΣ 1..1 CodeableConcept The nature of the relationship
Binding: IMMZ.F.DE2 ValueSet for Client Relationship (required)
.... coding Σ 0..* Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 0..1 string Representation defined by the system
... name SΣ 0..* 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Σ 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 person
... gender SΣ 1..1 code male | female | other | unknown
Binding: IMMZ.C.DE5 ValueSet for Gender (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.relationshiprequiredRelatedPersonRelationshipTypeVS
http://nhin.example.ng/ValueSet/relatedPersonRelationshiptype-vs
From this IG
RelatedPerson.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
RelatedPerson.genderrequiredGenderVS
http://nhin.example.ng/ValueSet/gender-vs
From this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from RelatedPerson

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
... patient S 1..1 Reference(Patient Profile - NEIR) The patient this person is related to
... relationship S 1..1 CodeableConcept The nature of the relationship
Binding: IMMZ.F.DE2 ValueSet for Client Relationship (required)
.... coding
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
..... display S 0..1 string Representation defined by the system
... name S 0..* HumanName A name associated with the person
.... family S 0..1 string Family name (often called 'Surname')
.... given S 1..* string Given names (not always 'first'). Includes middle names
... gender S 1..1 code male | female | other | unknown
Binding: IMMZ.C.DE5 ValueSet for Gender (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
RelatedPerson.relationshiprequiredRelatedPersonRelationshipTypeVS
http://nhin.example.ng/ValueSet/relatedPersonRelationshiptype-vs
From this IG
RelatedPerson.genderrequiredGenderVS
http://nhin.example.ng/ValueSet/gender-vs
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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 Σ 0..* Identifier A human identifier for this person
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... patient SΣ 1..1 Reference(Patient Profile - NEIR) The patient this person is related to
... relationship SΣ 1..1 CodeableConcept The nature of the relationship
Binding: IMMZ.F.DE2 ValueSet for Client Relationship (required)
.... 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
..... 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Σ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... name SΣ 0..* 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 SΣ 0..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 person
... gender SΣ 1..1 code male | female | other | unknown
Binding: IMMZ.C.DE5 ValueSet for Gender (required)
... birthDate Σ 0..1 date The date on which the related person 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 BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
RelatedPerson.relationshiprequiredRelatedPersonRelationshipTypeVS
http://nhin.example.ng/ValueSet/relatedPersonRelationshiptype-vs
From this IG
RelatedPerson.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
RelatedPerson.genderrequiredGenderVS
http://nhin.example.ng/ValueSet/gender-vs
From this IG
RelatedPerson.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from RelatedPerson

Summary

Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 10 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron