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: RegisterClientModel - Detailed Descriptions

Draft as of 2025-10-27

Definitions for the register-client-model logical model.

Guidance on how to interpret the contents of this table can be foundhere

0. register-client-model
Definition

IMMZ.C5 - A logical model representing a client being registered in the immunization system.

ShortNG-Imm-C5 RegisterClient
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. register-client-model.identifier
Definition

Unique identifier for clients including the national identification number, medical records number, immunization information system ID, and others.

ShortUnique identifier for clients including the national identification number, medical records number, immunization information system ID, and others.
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. register-client-model.name
Definition

The full name of the client.

ShortThe full name of the client.
Control1..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. register-client-model.name.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
8. register-client-model.name.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on register-client-model.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 10. register-client-model.name.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. register-client-model.name.family
    Definition

    Client's family name or last name.

    ShortClient's family name or last name.
    Control1..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    14. register-client-model.name.given
    Definition

    Client's first name or given name.

    ShortClient's first name or given name.
    Control1..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    16. register-client-model.sex
    Definition

    Documentation of a specific instance of sex information for the client.

    ShortSex
    Control1..1
    BindingThe codes SHOULD be taken from NG Gender or Sex VS
    (preferred to https://nphcda.gov.ng/ig/ValueSet/ng-gender-vs)
    TypeCodeableConcept
    18. register-client-model.dateOfBirth
    Definition

    Client's date of birth (DOB) if known. If unknown, use assigned DOB for administrative purposes.

    ShortClient's date of birth (DOB) if known. If unknown, use assigned DOB for administrative purposes.
    Control1..1
    Typedate
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    20. register-client-model.ageInWeeks
    Definition

    The client's calculated age (number of weeks) based on the date of birth and the visit date.

    ShortThe client's calculated age (number of weeks) based on the date of birth and the visit date.
    Control0..1
    Typeinteger
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    22. register-client-model.ageInMonths
    Definition

    The client's calculated age (number of months) based on the date of birth and the visit date.

    ShortThe client's calculated age (number of months) based on the date of birth and the visit date.
    Control0..1
    Typeinteger
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    24. register-client-model.ageInYears
    Definition

    The client's calculated age (number of years) based on the date of birth and the visit date.

    ShortThe client's calculated age (number of years) based on the date of birth and the visit date.
    Control0..1
    Typeinteger
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    26. register-client-model.weightAtBirth
    Definition

    Client's weight at birth in kg.

    ShortClient's weight at birth in kg.
    Control0..1
    TypeQuantity
    28. register-client-model.address
    Definition

    Client's residential address.

    ShortClient's residential address.
    Control0..1
    TypeBackboneElement
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. register-client-model.address.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    32. register-client-model.address.extension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on register-client-model.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 34. register-client-model.address.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      36. register-client-model.address.residentialAddress
      Definition

      Child's residential address.

      ShortChild's residential address.
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      38. register-client-model.address.houseNumber
      Definition

      The number of the house where the client lives.

      ShortThe number of the house where the client lives.
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      40. register-client-model.address.village
      Definition

      The village where the client lives.

      ShortThe village where the client lives.
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      42. register-client-model.address.town
      Definition

      The town or city where the client resides.

      ShortThe town or city where the client resides.
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      44. register-client-model.address.ward
      Definition

      The ward where the client lives.

      ShortThe ward where the client lives.
      Control0..1
      BindingThe codes SHOULD be taken from NG-Imm Wards VS
      (preferred to https://nphcda.gov.ng/ig/ValueSet/nigeria-wards)
      TypeCodeableConcept
      46. register-client-model.address.lga
      Definition

      Local Government Authority where the client lives.

      ShortLocal Government Authority where the client lives.
      Control0..1
      BindingThe codes SHOULD be taken from NG-Imm LGAs VS
      (preferred to https://nphcda.gov.ng/ig/ValueSet/nigeria-lgas)
      TypeCodeableConcept
      48. register-client-model.address.state
      Definition

      The state where the client lives.

      ShortThe state where the client lives.
      Control0..1
      BindingThe codes SHOULD be taken from NG-Imm States VS
      (preferred to https://nphcda.gov.ng/ig/ValueSet/nigeria-states)
      TypeCodeableConcept
      50. register-client-model.contact
      Definition

      The client's caregiver (person) which could be next of kin (e.g., partner, husband, mother, sibling, etc.).

      ShortThe client's caregiver (person) which could be next of kin (e.g., partner, husband, mother, sibling, etc.).
      Control0..*
      TypeBackboneElement
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      52. register-client-model.contact.id
      Definition

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      ShortUnique id for inter-element referencing
      Control0..1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      54. register-client-model.contact.extension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      ShortAdditional content defined by implementations
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on register-client-model.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 56. register-client-model.contact.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored even if unrecognized
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content, modifiers
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        58. register-client-model.contact.name
        Definition

        The full name of the caregiver.

        ShortThe full name of the caregiver.
        Control1..1
        TypeBackboneElement
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        60. register-client-model.contact.name.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        62. register-client-model.contact.name.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortAdditional content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingThis element introduces a set of slices on register-client-model.contact.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 64. register-client-model.contact.name.modifierExtension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

          ShortExtensions that cannot be ignored even if unrecognized
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
          Summarytrue
          Requirements

          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

          Alternate Namesextensions, user content, modifiers
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          66. register-client-model.contact.name.family
          Definition

          Family name of the caregiver.

          ShortFamily name of the caregiver.
          Control1..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          68. register-client-model.contact.name.given
          Definition

          Given name of the caregiver.

          ShortGiven name of the caregiver.
          Control1..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          70. register-client-model.contact.telecom
          Definition

          Phone number of the caregiver.

          ShortPhone number of the caregiver.
          Control0..*
          TypeContactPoint
          Invariantscpt-2: A system is required if a value is provided. (value.empty() or system.exists())
          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          72. register-client-model.contact.telecom.id
          Definition

          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          ShortUnique id for inter-element referencing
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          74. register-client-model.contact.telecom.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          ShortAdditional content defined by implementations
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on register-client-model.contact.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 76. register-client-model.contact.telecom.system
            Definition

            Type of communication (e.g., phone, email).


            Telecommunications form for contact point - what communications system is required to make use of the contact.

            ShortType of communication (e.g., phone, email).phone | fax | email | pager | url | sms | other
            Control10..1
            This element is affected by the following invariants: cpt-2
            BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
            (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

            Telecommunications form for contact point.

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            78. register-client-model.contact.telecom.value
            Definition

            Caregiver's contact number or address.


            The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

            ShortCaregiver's contact number or address.The actual contact point details
            Comments

            Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

            Control10..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Need to support legacy numbers that are not in a tightly controlled format.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            80. register-client-model.contact.telecom.use
            Definition

            Identifies the purpose for the contact point.

            Shorthome | work | temp | old | mobile - purpose of this contact point
            Comments

            Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

            Control0..1
            BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
            (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

            Use of contact point.

            Typecode
            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            82. register-client-model.contact.telecom.rank
            Definition

            Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

            ShortSpecify preferred order of use (1 = highest)
            Comments

            Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

            Control0..1
            TypepositiveInt
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            84. register-client-model.contact.telecom.period
            Definition

            Time period when the contact point was/is in use.

            ShortTime period when the contact point was/is in use
            Control0..1
            TypePeriod
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            86. register-client-model.contact.relationship
            Definition

            The relationship of the caregiver to the client.

            ShortThe relationship of the caregiver to the client.
            Control0..1
            TypeCodeableConcept
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            88. register-client-model.contact.relationship.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            90. register-client-model.contact.relationship.extension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            ShortAdditional content defined by implementations
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            SlicingThis element introduces a set of slices on register-client-model.contact.relationship.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 92. register-client-model.contact.relationship.coding
              Definition

              A reference to a code defined by a terminology system.

              ShortCode defined by a terminology system
              Comments

              Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

              Control0..*
              TypeCoding
              Is Modifierfalse
              Summarytrue
              Requirements

              Allows for alternative encodings within a code system, and translations to other code systems.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              94. register-client-model.contact.relationship.text
              Definition

              Caregiver relationship display text.


              A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

              ShortCaregiver relationship display text.Plain text representation of the concept
              Comments

              Very often the text is the same as a displayName of one of the codings.

              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              96. register-client-model.otherChildren
              Definition

              Any other children the mother has.

              ShortAny other children the mother has.
              Control0..*
              TypeBackboneElement
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              98. register-client-model.otherChildren.id
              Definition

              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              ShortUnique id for inter-element referencing
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              100. register-client-model.otherChildren.extension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              ShortAdditional content defined by implementations
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on register-client-model.otherChildren.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 102. register-client-model.otherChildren.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                ShortExtensions that cannot be ignored even if unrecognized
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                Summarytrue
                Requirements

                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                Alternate Namesextensions, user content, modifiers
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                104. register-client-model.otherChildren.name
                Definition

                The full name of the mother's other children.

                ShortThe full name of the mother's other children.
                Control1..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                106. register-client-model.otherChildren.birthYear
                Definition

                The year the mother's children were born.

                ShortThe year the mother's children were born.
                Control1..1
                Typeinteger
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                108. register-client-model.otherChildren.sex
                Definition

                Biological characteristics that define humans as female or male.

                ShortBiological characteristics that define humans as female or male.
                Control1..1
                BindingThe codes SHOULD be taken from NG Gender or Sex VS
                (preferred to https://nphcda.gov.ng/ig/ValueSet/ng-gender-vs)
                TypeCodeableConcept
                110. register-client-model.healthStatus
                Definition

                Overall physical, mental, and emotional well-being of the sibling.

                ShortOverall physical, mental, and emotional well-being of the sibling.
                Control0..1
                BindingThe codes SHOULD be taken from NG-Imm Sibling Health Status VS
                (preferred to https://nphcda.gov.ng/ig/ValueSet/nigeria-sibling-health-status)
                TypeCodeableConcept
                112. register-client-model.hivStatus
                Definition

                HIV status of the client.

                ShortHIV status of the client.
                Control0..1
                BindingThe codes SHOULD be taken from NG-Imm Client HIV Status VS
                (preferred to https://nphcda.gov.ng/ig/ValueSet/nigeria-hiv-status)
                TypeCodeableConcept
                114. register-client-model.pregnancyStatus
                Definition

                Confirms whether the client is pregnant or not.

                ShortConfirms whether the client is pregnant or not.
                Control0..1
                BindingThe codes SHOULD be taken from NG-Imm Clinical Status VS
                (preferred to https://nphcda.gov.ng/ig/ValueSet/nigeria-pregnancy-status)
                TypeCodeableConcept

                Guidance on how to interpret the contents of this table can be foundhere

                0. register-client-model
                Definition

                IMMZ.C5 - A logical model representing a client being registered in the immunization system.

                ShortNG-Imm-C5 RegisterClient
                Logical ModelInstances of this logical model are not marked to be the target of a Reference
                2. register-client-model.identifier
                Definition

                Unique identifier for clients including the national identification number, medical records number, immunization information system ID, and others.

                ShortUnique identifier for clients including the national identification number, medical records number, immunization information system ID, and others.
                NoteThis is a business identifier, not a resource identifier (see discussion)
                Control1..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                4. register-client-model.name
                Definition

                The full name of the client.

                ShortThe full name of the client.
                Control1..1
                TypeBackboneElement
                6. register-client-model.name.family
                Definition

                Client's family name or last name.

                ShortClient's family name or last name.
                Control1..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                8. register-client-model.name.given
                Definition

                Client's first name or given name.

                ShortClient's first name or given name.
                Control1..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                10. register-client-model.sex
                Definition

                Documentation of a specific instance of sex information for the client.

                ShortSex
                Control1..1
                BindingThe codes SHOULD be taken from NG Gender or Sex VS
                (preferred to https://nphcda.gov.ng/ig/ValueSet/ng-gender-vs)
                TypeCodeableConcept
                12. register-client-model.dateOfBirth
                Definition

                Client's date of birth (DOB) if known. If unknown, use assigned DOB for administrative purposes.

                ShortClient's date of birth (DOB) if known. If unknown, use assigned DOB for administrative purposes.
                Control1..1
                Typedate
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                14. register-client-model.ageInWeeks
                Definition

                The client's calculated age (number of weeks) based on the date of birth and the visit date.

                ShortThe client's calculated age (number of weeks) based on the date of birth and the visit date.
                Control0..1
                Typeinteger
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                16. register-client-model.ageInMonths
                Definition

                The client's calculated age (number of months) based on the date of birth and the visit date.

                ShortThe client's calculated age (number of months) based on the date of birth and the visit date.
                Control0..1
                Typeinteger
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                18. register-client-model.ageInYears
                Definition

                The client's calculated age (number of years) based on the date of birth and the visit date.

                ShortThe client's calculated age (number of years) based on the date of birth and the visit date.
                Control0..1
                Typeinteger
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                20. register-client-model.weightAtBirth
                Definition

                Client's weight at birth in kg.

                ShortClient's weight at birth in kg.
                Control0..1
                TypeQuantity
                22. register-client-model.address
                Definition

                Client's residential address.

                ShortClient's residential address.
                Control0..1
                TypeBackboneElement
                24. register-client-model.address.residentialAddress
                Definition

                Child's residential address.

                ShortChild's residential address.
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                26. register-client-model.address.houseNumber
                Definition

                The number of the house where the client lives.

                ShortThe number of the house where the client lives.
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                28. register-client-model.address.village
                Definition

                The village where the client lives.

                ShortThe village where the client lives.
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                30. register-client-model.address.town
                Definition

                The town or city where the client resides.

                ShortThe town or city where the client resides.
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                32. register-client-model.address.ward
                Definition

                The ward where the client lives.

                ShortThe ward where the client lives.
                Control0..1
                BindingThe codes SHOULD be taken from NG-Imm Wards VS
                (preferred to https://nphcda.gov.ng/ig/ValueSet/nigeria-wards)
                TypeCodeableConcept
                34. register-client-model.address.lga
                Definition

                Local Government Authority where the client lives.

                ShortLocal Government Authority where the client lives.
                Control0..1
                BindingThe codes SHOULD be taken from NG-Imm LGAs VS
                (preferred to https://nphcda.gov.ng/ig/ValueSet/nigeria-lgas)
                TypeCodeableConcept
                36. register-client-model.address.state
                Definition

                The state where the client lives.

                ShortThe state where the client lives.
                Control0..1
                BindingThe codes SHOULD be taken from NG-Imm States VS
                (preferred to https://nphcda.gov.ng/ig/ValueSet/nigeria-states)
                TypeCodeableConcept
                38. register-client-model.contact
                Definition

                The client's caregiver (person) which could be next of kin (e.g., partner, husband, mother, sibling, etc.).

                ShortThe client's caregiver (person) which could be next of kin (e.g., partner, husband, mother, sibling, etc.).
                Control0..*
                TypeBackboneElement
                40. register-client-model.contact.name
                Definition

                The full name of the caregiver.

                ShortThe full name of the caregiver.
                Control1..1
                TypeBackboneElement
                42. register-client-model.contact.name.family
                Definition

                Family name of the caregiver.

                ShortFamily name of the caregiver.
                Control1..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                44. register-client-model.contact.name.given
                Definition

                Given name of the caregiver.

                ShortGiven name of the caregiver.
                Control1..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                46. register-client-model.contact.telecom
                Definition

                Phone number of the caregiver.

                ShortPhone number of the caregiver.
                Control0..*
                TypeContactPoint
                48. register-client-model.contact.telecom.system
                Definition

                Type of communication (e.g., phone, email).

                ShortType of communication (e.g., phone, email).
                Control1..1
                Typecode
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                50. register-client-model.contact.telecom.value
                Definition

                Caregiver's contact number or address.

                ShortCaregiver's contact number or address.
                Control1..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                52. register-client-model.contact.relationship
                Definition

                The relationship of the caregiver to the client.

                ShortThe relationship of the caregiver to the client.
                Control0..1
                TypeCodeableConcept
                54. register-client-model.contact.relationship.text
                Definition

                Caregiver relationship display text.

                ShortCaregiver relationship display text.
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                56. register-client-model.otherChildren
                Definition

                Any other children the mother has.

                ShortAny other children the mother has.
                Control0..*
                TypeBackboneElement
                58. register-client-model.otherChildren.name
                Definition

                The full name of the mother's other children.

                ShortThe full name of the mother's other children.
                Control1..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                60. register-client-model.otherChildren.birthYear
                Definition

                The year the mother's children were born.

                ShortThe year the mother's children were born.
                Control1..1
                Typeinteger
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                62. register-client-model.otherChildren.sex
                Definition

                Biological characteristics that define humans as female or male.

                ShortBiological characteristics that define humans as female or male.
                Control1..1
                BindingThe codes SHOULD be taken from NG Gender or Sex VS
                (preferred to https://nphcda.gov.ng/ig/ValueSet/ng-gender-vs)
                TypeCodeableConcept
                64. register-client-model.healthStatus
                Definition

                Overall physical, mental, and emotional well-being of the sibling.

                ShortOverall physical, mental, and emotional well-being of the sibling.
                Control0..1
                BindingThe codes SHOULD be taken from NG-Imm Sibling Health Status VS
                (preferred to https://nphcda.gov.ng/ig/ValueSet/nigeria-sibling-health-status)
                TypeCodeableConcept
                66. register-client-model.hivStatus
                Definition

                HIV status of the client.

                ShortHIV status of the client.
                Control0..1
                BindingThe codes SHOULD be taken from NG-Imm Client HIV Status VS
                (preferred to https://nphcda.gov.ng/ig/ValueSet/nigeria-hiv-status)
                TypeCodeableConcept
                68. register-client-model.pregnancyStatus
                Definition

                Confirms whether the client is pregnant or not.

                ShortConfirms whether the client is pregnant or not.
                Control0..1
                BindingThe codes SHOULD be taken from NG-Imm Clinical Status VS
                (preferred to https://nphcda.gov.ng/ig/ValueSet/nigeria-pregnancy-status)
                TypeCodeableConcept

                Guidance on how to interpret the contents of this table can be foundhere

                0. register-client-model
                Definition

                IMMZ.C5 - A logical model representing a client being registered in the immunization system.

                ShortNG-Imm-C5 RegisterClient
                Control0..*
                Is Modifierfalse
                Logical ModelInstances of this logical model are not marked to be the target of a Reference
                2. register-client-model.identifier
                Definition

                Unique identifier for clients including the national identification number, medical records number, immunization information system ID, and others.

                ShortUnique identifier for clients including the national identification number, medical records number, immunization information system ID, and others.
                NoteThis is a business identifier, not a resource identifier (see discussion)
                Control1..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                4. register-client-model.name
                Definition

                The full name of the client.

                ShortThe full name of the client.
                Control1..1
                TypeBackboneElement
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                6. register-client-model.name.id
                Definition

                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                ShortUnique id for inter-element referencing
                Control0..1
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                8. register-client-model.name.extension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                ShortAdditional content defined by implementations
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                SlicingThis element introduces a set of slices on register-client-model.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 10. register-client-model.name.modifierExtension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                  ShortExtensions that cannot be ignored even if unrecognized
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                  Summarytrue
                  Requirements

                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                  Alternate Namesextensions, user content, modifiers
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  12. register-client-model.name.family
                  Definition

                  Client's family name or last name.

                  ShortClient's family name or last name.
                  Control1..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  14. register-client-model.name.given
                  Definition

                  Client's first name or given name.

                  ShortClient's first name or given name.
                  Control1..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  16. register-client-model.sex
                  Definition

                  Documentation of a specific instance of sex information for the client.

                  ShortSex
                  Control1..1
                  BindingThe codes SHOULD be taken from NG Gender or Sex VS
                  (preferred to https://nphcda.gov.ng/ig/ValueSet/ng-gender-vs)
                  TypeCodeableConcept
                  18. register-client-model.dateOfBirth
                  Definition

                  Client's date of birth (DOB) if known. If unknown, use assigned DOB for administrative purposes.

                  ShortClient's date of birth (DOB) if known. If unknown, use assigned DOB for administrative purposes.
                  Control1..1
                  Typedate
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  20. register-client-model.ageInWeeks
                  Definition

                  The client's calculated age (number of weeks) based on the date of birth and the visit date.

                  ShortThe client's calculated age (number of weeks) based on the date of birth and the visit date.
                  Control0..1
                  Typeinteger
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  22. register-client-model.ageInMonths
                  Definition

                  The client's calculated age (number of months) based on the date of birth and the visit date.

                  ShortThe client's calculated age (number of months) based on the date of birth and the visit date.
                  Control0..1
                  Typeinteger
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  24. register-client-model.ageInYears
                  Definition

                  The client's calculated age (number of years) based on the date of birth and the visit date.

                  ShortThe client's calculated age (number of years) based on the date of birth and the visit date.
                  Control0..1
                  Typeinteger
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  26. register-client-model.weightAtBirth
                  Definition

                  Client's weight at birth in kg.

                  ShortClient's weight at birth in kg.
                  Control0..1
                  TypeQuantity
                  28. register-client-model.address
                  Definition

                  Client's residential address.

                  ShortClient's residential address.
                  Control0..1
                  TypeBackboneElement
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  30. register-client-model.address.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  32. register-client-model.address.extension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  ShortAdditional content defined by implementations
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  SlicingThis element introduces a set of slices on register-client-model.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 34. register-client-model.address.modifierExtension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                    Summarytrue
                    Requirements

                    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                    Alternate Namesextensions, user content, modifiers
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    36. register-client-model.address.residentialAddress
                    Definition

                    Child's residential address.

                    ShortChild's residential address.
                    Control0..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    38. register-client-model.address.houseNumber
                    Definition

                    The number of the house where the client lives.

                    ShortThe number of the house where the client lives.
                    Control0..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    40. register-client-model.address.village
                    Definition

                    The village where the client lives.

                    ShortThe village where the client lives.
                    Control0..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    42. register-client-model.address.town
                    Definition

                    The town or city where the client resides.

                    ShortThe town or city where the client resides.
                    Control0..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    44. register-client-model.address.ward
                    Definition

                    The ward where the client lives.

                    ShortThe ward where the client lives.
                    Control0..1
                    BindingThe codes SHOULD be taken from NG-Imm Wards VS
                    (preferred to https://nphcda.gov.ng/ig/ValueSet/nigeria-wards)
                    TypeCodeableConcept
                    46. register-client-model.address.lga
                    Definition

                    Local Government Authority where the client lives.

                    ShortLocal Government Authority where the client lives.
                    Control0..1
                    BindingThe codes SHOULD be taken from NG-Imm LGAs VS
                    (preferred to https://nphcda.gov.ng/ig/ValueSet/nigeria-lgas)
                    TypeCodeableConcept
                    48. register-client-model.address.state
                    Definition

                    The state where the client lives.

                    ShortThe state where the client lives.
                    Control0..1
                    BindingThe codes SHOULD be taken from NG-Imm States VS
                    (preferred to https://nphcda.gov.ng/ig/ValueSet/nigeria-states)
                    TypeCodeableConcept
                    50. register-client-model.contact
                    Definition

                    The client's caregiver (person) which could be next of kin (e.g., partner, husband, mother, sibling, etc.).

                    ShortThe client's caregiver (person) which could be next of kin (e.g., partner, husband, mother, sibling, etc.).
                    Control0..*
                    TypeBackboneElement
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    52. register-client-model.contact.id
                    Definition

                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    54. register-client-model.contact.extension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    SlicingThis element introduces a set of slices on register-client-model.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 56. register-client-model.contact.modifierExtension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                      ShortExtensions that cannot be ignored even if unrecognized
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                      Summarytrue
                      Requirements

                      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                      Alternate Namesextensions, user content, modifiers
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      58. register-client-model.contact.name
                      Definition

                      The full name of the caregiver.

                      ShortThe full name of the caregiver.
                      Control1..1
                      TypeBackboneElement
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      60. register-client-model.contact.name.id
                      Definition

                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      ShortUnique id for inter-element referencing
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      62. register-client-model.contact.name.extension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                      ShortAdditional content defined by implementations
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      SlicingThis element introduces a set of slices on register-client-model.contact.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 64. register-client-model.contact.name.modifierExtension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        66. register-client-model.contact.name.family
                        Definition

                        Family name of the caregiver.

                        ShortFamily name of the caregiver.
                        Control1..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        68. register-client-model.contact.name.given
                        Definition

                        Given name of the caregiver.

                        ShortGiven name of the caregiver.
                        Control1..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        70. register-client-model.contact.telecom
                        Definition

                        Phone number of the caregiver.

                        ShortPhone number of the caregiver.
                        Control0..*
                        TypeContactPoint
                        Invariantscpt-2: A system is required if a value is provided. (value.empty() or system.exists())
                        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        72. register-client-model.contact.telecom.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        74. register-client-model.contact.telecom.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        SlicingThis element introduces a set of slices on register-client-model.contact.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 76. register-client-model.contact.telecom.system
                          Definition

                          Type of communication (e.g., phone, email).

                          ShortType of communication (e.g., phone, email).
                          Control1..1
                          This element is affected by the following invariants: cpt-2
                          BindingThe codes SHALL be taken from ContactPointSystem
                          (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                          Telecommunications form for contact point.

                          Typecode
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          78. register-client-model.contact.telecom.value
                          Definition

                          Caregiver's contact number or address.

                          ShortCaregiver's contact number or address.
                          Comments

                          Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

                          Control1..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          Need to support legacy numbers that are not in a tightly controlled format.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          80. register-client-model.contact.telecom.use
                          Definition

                          Identifies the purpose for the contact point.

                          Shorthome | work | temp | old | mobile - purpose of this contact point
                          Comments

                          Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                          Control0..1
                          BindingThe codes SHALL be taken from ContactPointUse
                          (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

                          Use of contact point.

                          Typecode
                          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          82. register-client-model.contact.telecom.rank
                          Definition

                          Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                          ShortSpecify preferred order of use (1 = highest)
                          Comments

                          Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

                          Control0..1
                          TypepositiveInt
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          84. register-client-model.contact.telecom.period
                          Definition

                          Time period when the contact point was/is in use.

                          ShortTime period when the contact point was/is in use
                          Control0..1
                          TypePeriod
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          86. register-client-model.contact.relationship
                          Definition

                          The relationship of the caregiver to the client.

                          ShortThe relationship of the caregiver to the client.
                          Control0..1
                          TypeCodeableConcept
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          88. register-client-model.contact.relationship.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          90. register-client-model.contact.relationship.extension
                          Definition

                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                          ShortAdditional content defined by implementations
                          Comments

                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                          Control0..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesextensions, user content
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          SlicingThis element introduces a set of slices on register-client-model.contact.relationship.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 92. register-client-model.contact.relationship.coding
                            Definition

                            A reference to a code defined by a terminology system.

                            ShortCode defined by a terminology system
                            Comments

                            Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                            Control0..*
                            TypeCoding
                            Is Modifierfalse
                            Summarytrue
                            Requirements

                            Allows for alternative encodings within a code system, and translations to other code systems.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            94. register-client-model.contact.relationship.text
                            Definition

                            Caregiver relationship display text.

                            ShortCaregiver relationship display text.
                            Comments

                            Very often the text is the same as a displayName of one of the codings.

                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            96. register-client-model.otherChildren
                            Definition

                            Any other children the mother has.

                            ShortAny other children the mother has.
                            Control0..*
                            TypeBackboneElement
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            98. register-client-model.otherChildren.id
                            Definition

                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                            ShortUnique id for inter-element referencing
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            100. register-client-model.otherChildren.extension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                            ShortAdditional content defined by implementations
                            Comments

                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                            Control0..*
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Alternate Namesextensions, user content
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            SlicingThis element introduces a set of slices on register-client-model.otherChildren.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 102. register-client-model.otherChildren.modifierExtension
                              Definition

                              May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                              Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                              ShortExtensions that cannot be ignored even if unrecognized
                              Comments

                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                              Control0..*
                              TypeExtension
                              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                              Summarytrue
                              Requirements

                              Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                              Alternate Namesextensions, user content, modifiers
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              104. register-client-model.otherChildren.name
                              Definition

                              The full name of the mother's other children.

                              ShortThe full name of the mother's other children.
                              Control1..1
                              Typestring
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              106. register-client-model.otherChildren.birthYear
                              Definition

                              The year the mother's children were born.

                              ShortThe year the mother's children were born.
                              Control1..1
                              Typeinteger
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              108. register-client-model.otherChildren.sex
                              Definition

                              Biological characteristics that define humans as female or male.

                              ShortBiological characteristics that define humans as female or male.
                              Control1..1
                              BindingThe codes SHOULD be taken from NG Gender or Sex VS
                              (preferred to https://nphcda.gov.ng/ig/ValueSet/ng-gender-vs)
                              TypeCodeableConcept
                              110. register-client-model.healthStatus
                              Definition

                              Overall physical, mental, and emotional well-being of the sibling.

                              ShortOverall physical, mental, and emotional well-being of the sibling.
                              Control0..1
                              BindingThe codes SHOULD be taken from NG-Imm Sibling Health Status VS
                              (preferred to https://nphcda.gov.ng/ig/ValueSet/nigeria-sibling-health-status)
                              TypeCodeableConcept
                              112. register-client-model.hivStatus
                              Definition

                              HIV status of the client.

                              ShortHIV status of the client.
                              Control0..1
                              BindingThe codes SHOULD be taken from NG-Imm Client HIV Status VS
                              (preferred to https://nphcda.gov.ng/ig/ValueSet/nigeria-hiv-status)
                              TypeCodeableConcept
                              114. register-client-model.pregnancyStatus
                              Definition

                              Confirms whether the client is pregnant or not.

                              ShortConfirms whether the client is pregnant or not.
                              Control0..1
                              BindingThe codes SHOULD be taken from NG-Imm Clinical Status VS
                              (preferred to https://nphcda.gov.ng/ig/ValueSet/nigeria-pregnancy-status)
                              TypeCodeableConcept