NPHCDA Immunization FHIR IG
0.7.0 - ci-build Nigeria flag

NPHCDA Immunization FHIR IG, published by https://nphcda.gov.ng. This guide is not an authorized publication; it is the continuous build for version 0.7.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/NPHCDA-ImmunizationIG/ and changes regularly. See the Directory of published versions

Logical Model: NG-Imm-A RegisterFacility

Official URL: https://nphcda.gov.ng/ig/StructureDefinition/register-facility-model Version: 0.7.0
Draft as of 2025-10-27 Computable Name: RegisterFacilityModel

IMMZ.A - A logical model representing a health facility being registered in the immunization system.

Usages:

  • This Logical Model 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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. register-facility-model 0..* Base NG-Imm-A RegisterFacility
... identifier 1..1 string Unique identifier for health facilities including the master facility list.
... facilityName 1..1 string The full name of the Organization/facility.
... alternateName 0..1 string The other names the Organization/facility is known for.
... facilityType 0..1 CodeableConcept The type of health facility.
... facilityStatus 0..1 boolean The Status of the health facility.
... facilityContactType 0..1 string The type of health facility contact Eg. email, fax, phone.
... facilityContactValue 0..1 string The actual value of the contact (eg. the phone number +23435565656).
... facilityaddress 0..1 BackboneElement Office address.
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... houseNumber 0..1 string The number of the house where the facility is.
.... village 0..1 string The village or street where the facility is.
.... city 0..1 string The town or city where the facility is .
.... ward 0..1 CodeableConcept The ward where the health facility is.
.... lga 0..1 CodeableConcept Local Government Authority where the facility is.
.... state 0..1 CodeableConcept The state where the health facility is.
... primarycontact 0..* BackboneElement The primary contact for the health facility
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 BackboneElement The full name of the contact.
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... family 1..1 string Family name of the contact.
..... given 1..1 string Given name of the contact.
.... telecom C 0..* ContactPoint Phone number of the contact.
Constraints: cpt-2
..... @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 ΣC 1..1 code Type of communication (e.g., phone, email).
Binding: ContactPointSystem (required): Telecommunications form for contact point.
..... value Σ 1..1 string The primary contact's number or email address.
..... 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
.... houseNumber 0..1 string The number of the primary contact.
.... village 0..1 string The village or street where the primary contact lives.
.... city 0..1 string The town or city where the primary contact resides.
.... ward 0..1 CodeableConcept The ward where the primary contact is.
.... lga 0..1 CodeableConcept Local Government Authority where the primary contact lives.
.... state 0..1 CodeableConcept The state where the primary contact is.
... longitude 0..1 string The Longitude of the health facility
... latitude 0..1 string The Latitude of the health facility

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
register-facility-model.​primarycontact.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
register-facility-model.​primarycontact.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpt-2 error register-facility-model.primarycontact.telecom A system is required if a value is provided. value.empty() or system.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 Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. register-facility-model 0..* Base NG-Imm-A RegisterFacility
... identifier 1..1 string Unique identifier for health facilities including the master facility list.
... facilityName 1..1 string The full name of the Organization/facility.
... alternateName 0..1 string The other names the Organization/facility is known for.
... facilityType 0..1 CodeableConcept The type of health facility.
... facilityStatus 0..1 boolean The Status of the health facility.
... facilityContactType 0..1 string The type of health facility contact Eg. email, fax, phone.
... facilityContactValue 0..1 string The actual value of the contact (eg. the phone number +23435565656).
... facilityaddress 0..1 BackboneElement Office address.
.... houseNumber 0..1 string The number of the house where the facility is.
.... village 0..1 string The village or street where the facility is.
.... city 0..1 string The town or city where the facility is .
.... ward 0..1 CodeableConcept The ward where the health facility is.
.... lga 0..1 CodeableConcept Local Government Authority where the facility is.
.... state 0..1 CodeableConcept The state where the health facility is.
... primarycontact 0..* BackboneElement The primary contact for the health facility
.... name 1..1 BackboneElement The full name of the contact.
..... family 1..1 string Family name of the contact.
..... given 1..1 string Given name of the contact.
.... telecom 0..* ContactPoint Phone number of the contact.
..... system 1..1 code Type of communication (e.g., phone, email).
..... value 1..1 string The primary contact's number or email address.
.... houseNumber 0..1 string The number of the primary contact.
.... village 0..1 string The village or street where the primary contact lives.
.... city 0..1 string The town or city where the primary contact resides.
.... ward 0..1 CodeableConcept The ward where the primary contact is.
.... lga 0..1 CodeableConcept Local Government Authority where the primary contact lives.
.... state 0..1 CodeableConcept The state where the primary contact is.
... longitude 0..1 string The Longitude of the health facility
... latitude 0..1 string The Latitude of the health facility

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. register-facility-model 0..* Base NG-Imm-A RegisterFacility
... identifier 1..1 string Unique identifier for health facilities including the master facility list.
... facilityName 1..1 string The full name of the Organization/facility.
... alternateName 0..1 string The other names the Organization/facility is known for.
... facilityType 0..1 CodeableConcept The type of health facility.
... facilityStatus 0..1 boolean The Status of the health facility.
... facilityContactType 0..1 string The type of health facility contact Eg. email, fax, phone.
... facilityContactValue 0..1 string The actual value of the contact (eg. the phone number +23435565656).
... facilityaddress 0..1 BackboneElement Office address.
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... houseNumber 0..1 string The number of the house where the facility is.
.... village 0..1 string The village or street where the facility is.
.... city 0..1 string The town or city where the facility is .
.... ward 0..1 CodeableConcept The ward where the health facility is.
.... lga 0..1 CodeableConcept Local Government Authority where the facility is.
.... state 0..1 CodeableConcept The state where the health facility is.
... primarycontact 0..* BackboneElement The primary contact for the health facility
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 BackboneElement The full name of the contact.
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... family 1..1 string Family name of the contact.
..... given 1..1 string Given name of the contact.
.... telecom C 0..* ContactPoint Phone number of the contact.
Constraints: cpt-2
..... @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 ΣC 1..1 code Type of communication (e.g., phone, email).
Binding: ContactPointSystem (required): Telecommunications form for contact point.
..... value Σ 1..1 string The primary contact's number or email address.
..... 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
.... houseNumber 0..1 string The number of the primary contact.
.... village 0..1 string The village or street where the primary contact lives.
.... city 0..1 string The town or city where the primary contact resides.
.... ward 0..1 CodeableConcept The ward where the primary contact is.
.... lga 0..1 CodeableConcept Local Government Authority where the primary contact lives.
.... state 0..1 CodeableConcept The state where the primary contact is.
... longitude 0..1 string The Longitude of the health facility
... latitude 0..1 string The Latitude of the health facility

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
register-facility-model.​primarycontact.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
register-facility-model.​primarycontact.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpt-2 error register-facility-model.primarycontact.telecom A system is required if a value is provided. value.empty() or system.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 Base

Summary

Mandatory: 0 element(7 nested mandatory elements)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. register-facility-model 0..* Base NG-Imm-A RegisterFacility
... identifier 1..1 string Unique identifier for health facilities including the master facility list.
... facilityName 1..1 string The full name of the Organization/facility.
... alternateName 0..1 string The other names the Organization/facility is known for.
... facilityType 0..1 CodeableConcept The type of health facility.
... facilityStatus 0..1 boolean The Status of the health facility.
... facilityContactType 0..1 string The type of health facility contact Eg. email, fax, phone.
... facilityContactValue 0..1 string The actual value of the contact (eg. the phone number +23435565656).
... facilityaddress 0..1 BackboneElement Office address.
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... houseNumber 0..1 string The number of the house where the facility is.
.... village 0..1 string The village or street where the facility is.
.... city 0..1 string The town or city where the facility is .
.... ward 0..1 CodeableConcept The ward where the health facility is.
.... lga 0..1 CodeableConcept Local Government Authority where the facility is.
.... state 0..1 CodeableConcept The state where the health facility is.
... primarycontact 0..* BackboneElement The primary contact for the health facility
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 BackboneElement The full name of the contact.
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... family 1..1 string Family name of the contact.
..... given 1..1 string Given name of the contact.
.... telecom C 0..* ContactPoint Phone number of the contact.
Constraints: cpt-2
..... @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 ΣC 1..1 code Type of communication (e.g., phone, email).
Binding: ContactPointSystem (required): Telecommunications form for contact point.
..... value Σ 1..1 string The primary contact's number or email address.
..... 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
.... houseNumber 0..1 string The number of the primary contact.
.... village 0..1 string The village or street where the primary contact lives.
.... city 0..1 string The town or city where the primary contact resides.
.... ward 0..1 CodeableConcept The ward where the primary contact is.
.... lga 0..1 CodeableConcept Local Government Authority where the primary contact lives.
.... state 0..1 CodeableConcept The state where the primary contact is.
... longitude 0..1 string The Longitude of the health facility
... latitude 0..1 string The Latitude of the health facility

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
register-facility-model.​primarycontact.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
register-facility-model.​primarycontact.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpt-2 error register-facility-model.primarycontact.telecom A system is required if a value is provided. value.empty() or system.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 Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. register-facility-model 0..* Base NG-Imm-A RegisterFacility
... identifier 1..1 string Unique identifier for health facilities including the master facility list.
... facilityName 1..1 string The full name of the Organization/facility.
... alternateName 0..1 string The other names the Organization/facility is known for.
... facilityType 0..1 CodeableConcept The type of health facility.
... facilityStatus 0..1 boolean The Status of the health facility.
... facilityContactType 0..1 string The type of health facility contact Eg. email, fax, phone.
... facilityContactValue 0..1 string The actual value of the contact (eg. the phone number +23435565656).
... facilityaddress 0..1 BackboneElement Office address.
.... houseNumber 0..1 string The number of the house where the facility is.
.... village 0..1 string The village or street where the facility is.
.... city 0..1 string The town or city where the facility is .
.... ward 0..1 CodeableConcept The ward where the health facility is.
.... lga 0..1 CodeableConcept Local Government Authority where the facility is.
.... state 0..1 CodeableConcept The state where the health facility is.
... primarycontact 0..* BackboneElement The primary contact for the health facility
.... name 1..1 BackboneElement The full name of the contact.
..... family 1..1 string Family name of the contact.
..... given 1..1 string Given name of the contact.
.... telecom 0..* ContactPoint Phone number of the contact.
..... system 1..1 code Type of communication (e.g., phone, email).
..... value 1..1 string The primary contact's number or email address.
.... houseNumber 0..1 string The number of the primary contact.
.... village 0..1 string The village or street where the primary contact lives.
.... city 0..1 string The town or city where the primary contact resides.
.... ward 0..1 CodeableConcept The ward where the primary contact is.
.... lga 0..1 CodeableConcept Local Government Authority where the primary contact lives.
.... state 0..1 CodeableConcept The state where the primary contact is.
... longitude 0..1 string The Longitude of the health facility
... latitude 0..1 string The Latitude of the health facility

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. register-facility-model 0..* Base NG-Imm-A RegisterFacility
... identifier 1..1 string Unique identifier for health facilities including the master facility list.
... facilityName 1..1 string The full name of the Organization/facility.
... alternateName 0..1 string The other names the Organization/facility is known for.
... facilityType 0..1 CodeableConcept The type of health facility.
... facilityStatus 0..1 boolean The Status of the health facility.
... facilityContactType 0..1 string The type of health facility contact Eg. email, fax, phone.
... facilityContactValue 0..1 string The actual value of the contact (eg. the phone number +23435565656).
... facilityaddress 0..1 BackboneElement Office address.
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... houseNumber 0..1 string The number of the house where the facility is.
.... village 0..1 string The village or street where the facility is.
.... city 0..1 string The town or city where the facility is .
.... ward 0..1 CodeableConcept The ward where the health facility is.
.... lga 0..1 CodeableConcept Local Government Authority where the facility is.
.... state 0..1 CodeableConcept The state where the health facility is.
... primarycontact 0..* BackboneElement The primary contact for the health facility
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 BackboneElement The full name of the contact.
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... family 1..1 string Family name of the contact.
..... given 1..1 string Given name of the contact.
.... telecom C 0..* ContactPoint Phone number of the contact.
Constraints: cpt-2
..... @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 ΣC 1..1 code Type of communication (e.g., phone, email).
Binding: ContactPointSystem (required): Telecommunications form for contact point.
..... value Σ 1..1 string The primary contact's number or email address.
..... 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
.... houseNumber 0..1 string The number of the primary contact.
.... village 0..1 string The village or street where the primary contact lives.
.... city 0..1 string The town or city where the primary contact resides.
.... ward 0..1 CodeableConcept The ward where the primary contact is.
.... lga 0..1 CodeableConcept Local Government Authority where the primary contact lives.
.... state 0..1 CodeableConcept The state where the primary contact is.
... longitude 0..1 string The Longitude of the health facility
... latitude 0..1 string The Latitude of the health facility

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
register-facility-model.​primarycontact.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
register-facility-model.​primarycontact.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpt-2 error register-facility-model.primarycontact.telecom A system is required if a value is provided. value.empty() or system.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 Base

Summary

Mandatory: 0 element(7 nested mandatory elements)

 

Other representations of profile: CSV, Excel