Nigeria Immunization FHIR IG
0.1.0 - ci-build Nigeria flag

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

Logical Model: RegisterClientModel - Detailed Descriptions

Draft as of 2025-08-11

Definitions for the RegisterClientModel logical model.

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

0. RegisterClientModel
Definition

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

ShortIMMZ.C Register Client
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. RegisterClientModel.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
TypeIdentifier
4. RegisterClientModel.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. RegisterClientModel.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. RegisterClientModel.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 RegisterClientModel.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 10. RegisterClientModel.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. RegisterClientModel.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
    Definitional CodesIMMZ.C CodeSystem for Register Client DE4
    14. RegisterClientModel.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
    Definitional CodesIMMZ.C CodeSystem for Register Client DE3
    16. RegisterClientModel.sex
    Definition

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

    ShortSex
    Control1..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Definitional CodesIMMZ.C CodeSystem for Register Client DE5
    18. RegisterClientModel.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
    Definitional CodesIMMZ.C CodeSystem for Register Client DE8
    20. RegisterClientModel.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
    Definitional CodesIMMZ.C CodeSystem for Register Client DE9
    22. RegisterClientModel.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
    Definitional CodesIMMZ.C CodeSystem for Register Client DE10
    24. RegisterClientModel.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
    Definitional CodesIMMZ.C CodeSystem for Register Client DE11
    26. RegisterClientModel.weightAtBirth
    Definition

    Client's weight at birth in Kg.

    ShortClient's weight at birth in Kg.
    Control0..1
    TypeQuantity
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    qty-3: If a code for the unit is present, the system SHALL also be present (code.empty() or system.exists())
    28. RegisterClientModel.weightAtBirth.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
    30. RegisterClientModel.weightAtBirth.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 RegisterClientModel.weightAtBirth.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 32. RegisterClientModel.weightAtBirth.value
      Definition

      The value of the measured amount. The value includes an implicit precision in the presentation of the value.

      ShortNumerical value (with implicit precision)
      Comments

      The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

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

      Precision is handled implicitly in almost all cases of measurement.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      34. RegisterClientModel.weightAtBirth.comparator
      Definition

      How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

      Short< | <= | >= | > - how to understand the value
      Control0..1
      BindingThe codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
      (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)

      How the Quantity should be understood and represented.

      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

      Meaning if MissingIf there is no comparator, then there is no modification of the value
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      36. RegisterClientModel.weightAtBirth.unit
      Definition

      A human-readable form of the unit.

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

      There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

      Pattern Valuekg
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      38. RegisterClientModel.weightAtBirth.system
      Definition

      The identification of the system that provides the coded form of the unit.

      ShortSystem that defines coded unit form
      Control0..1
      This element is affected by the following invariants: qty-3
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need to know the system that defines the coded form of the unit.

      Pattern Valuehttp://unitsofmeasure.org
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      40. RegisterClientModel.weightAtBirth.code
      Definition

      A computer processable form of the unit in some unit representation system.

      ShortCoded form of the unit
      Comments

      The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

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

      Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

      Pattern Valuekg
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      42. RegisterClientModel.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()))
      44. RegisterClientModel.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
      46. RegisterClientModel.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 RegisterClientModel.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 48. RegisterClientModel.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())
        50. RegisterClientModel.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
        Definitional CodesIMMZ.C CodeSystem for Register Client DE13
        52. RegisterClientModel.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
        Definitional CodesIMMZ.C CodeSystem for Register Client DE14
        54. RegisterClientModel.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
        Definitional CodesIMMZ.C CodeSystem for Register Client DE15
        56. RegisterClientModel.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
        Definitional CodesIMMZ.C CodeSystem for Register Client DE16
        58. RegisterClientModel.address.ward
        Definition

        The ward where the client lives.

        ShortThe ward where the client lives.
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Definitional CodesIMMZ.C CodeSystem for Register Client DE17
        60. RegisterClientModel.address.lga
        Definition

        Local Government Authority where the client lives.

        ShortLocal Government Authority where the client lives.
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Definitional CodesIMMZ.C CodeSystem for Register Client DE18
        62. RegisterClientModel.address.state
        Definition

        The state where the client lives.

        ShortThe state where the client lives.
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Definitional CodesIMMZ.C CodeSystem for Register Client DE19
        64. RegisterClientModel.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()))
        66. RegisterClientModel.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
        68. RegisterClientModel.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 RegisterClientModel.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 70. RegisterClientModel.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())
          72. RegisterClientModel.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()))
          74. RegisterClientModel.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
          76. RegisterClientModel.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 RegisterClientModel.contact.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 78. RegisterClientModel.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())
            80. RegisterClientModel.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
            82. RegisterClientModel.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
            84. RegisterClientModel.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()))
            86. RegisterClientModel.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
            88. RegisterClientModel.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 RegisterClientModel.contact.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 90. RegisterClientModel.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()))
              92. RegisterClientModel.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()))
              94. RegisterClientModel.contact.telecom.use
              Definition

              Purpose of the contact information (e.g., home, work, mobile).


              Identifies the purpose for the contact point.

              ShortPurpose of the contact information (e.g., home, work, mobile).home | 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()))
              96. RegisterClientModel.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()))
              98. RegisterClientModel.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()))
              100. RegisterClientModel.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()))
              102. RegisterClientModel.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
              104. RegisterClientModel.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 RegisterClientModel.contact.relationship.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 106. RegisterClientModel.contact.relationship.coding
                Definition

                Caregiver relationship coding.


                A reference to a code defined by a terminology system.

                ShortCaregiver relationship coding.Code 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()))
                108. RegisterClientModel.contact.relationship.text
                Definition

                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.

                ShortPlain 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()))
                110. RegisterClientModel.contact.relationship.coding.system
                Definition

                System for caregiver relationship codes.

                ShortSystem for caregiver relationship codes.
                Control1..1
                Typeuri
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                112. RegisterClientModel.contact.relationship.coding.code
                Definition

                Caregiver relationship code.

                ShortCaregiver relationship code.
                Control1..1
                Typecode
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                114. RegisterClientModel.contact.relationship.coding.display
                Definition

                Caregiver relationship display text.

                ShortCaregiver relationship display text.
                Control1..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                116. RegisterClientModel.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()))
                118. RegisterClientModel.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
                120. RegisterClientModel.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 RegisterClientModel.otherChildren.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 122. RegisterClientModel.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())
                  124. RegisterClientModel.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
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE28
                  126. RegisterClientModel.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
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE29
                  128. RegisterClientModel.otherChildren.sex
                  Definition

                  Biological characteristics that define humans as female or male.

                  ShortBiological characteristics that define humans as female or male.
                  Control1..1
                  TypeCodeableConcept
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE30
                  130. RegisterClientModel.healthState
                  Definition

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

                  ShortOverall physical, mental, and emotional well-being of the mother.
                  Control0..1
                  TypeCodeableConcept
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE31
                  132. RegisterClientModel.hivStatus
                  Definition

                  HIV status of the client.

                  ShortHIV status of the client.
                  Control0..1
                  TypeCodeableConcept
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE37
                  134. RegisterClientModel.pregnancyStatus
                  Definition

                  Confirms whether the client is pregnant or not.

                  ShortConfirms whether the client is pregnant or not.
                  Control0..1
                  Typeboolean
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE41

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

                  0. RegisterClientModel
                  Definition

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

                  ShortIMMZ.C Register Client
                  Logical ModelInstances of this logical model are not marked to be the target of a Reference
                  2. RegisterClientModel.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
                  TypeIdentifier
                  4. RegisterClientModel.name
                  Definition

                  The full name of the client.

                  ShortThe full name of the client.
                  Control1..1
                  TypeBackboneElement
                  6. RegisterClientModel.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
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE4
                  8. RegisterClientModel.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
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE3
                  10. RegisterClientModel.sex
                  Definition

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

                  ShortSex
                  Control1..1
                  Typecode
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE5
                  12. RegisterClientModel.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
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE8
                  14. RegisterClientModel.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
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE9
                  16. RegisterClientModel.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
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE10
                  18. RegisterClientModel.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
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE11
                  20. RegisterClientModel.weightAtBirth
                  Definition

                  Client's weight at birth in Kg.

                  ShortClient's weight at birth in Kg.
                  Control0..1
                  TypeQuantity
                  22. RegisterClientModel.weightAtBirth.unit
                  Pattern Valuekg
                  24. RegisterClientModel.weightAtBirth.system
                  Pattern Valuehttp://unitsofmeasure.org
                  26. RegisterClientModel.weightAtBirth.code
                  Pattern Valuekg
                  28. RegisterClientModel.address
                  Definition

                  Client's residential address.

                  ShortClient's residential address.
                  Control0..1
                  TypeBackboneElement
                  30. RegisterClientModel.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
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE13
                  32. RegisterClientModel.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
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE14
                  34. RegisterClientModel.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
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE15
                  36. RegisterClientModel.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
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE16
                  38. RegisterClientModel.address.ward
                  Definition

                  The ward where the client lives.

                  ShortThe ward where the client lives.
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE17
                  40. RegisterClientModel.address.lga
                  Definition

                  Local Government Authority where the client lives.

                  ShortLocal Government Authority where the client lives.
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE18
                  42. RegisterClientModel.address.state
                  Definition

                  The state where the client lives.

                  ShortThe state where the client lives.
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE19
                  44. RegisterClientModel.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
                  46. RegisterClientModel.contact.name
                  Definition

                  The full name of the caregiver.

                  ShortThe full name of the caregiver.
                  Control1..1
                  TypeBackboneElement
                  48. RegisterClientModel.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
                  50. RegisterClientModel.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
                  52. RegisterClientModel.contact.telecom
                  Definition

                  Phone number of the caregiver.

                  ShortPhone number of the caregiver.
                  Control0..*
                  TypeContactPoint
                  54. RegisterClientModel.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
                  56. RegisterClientModel.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
                  58. RegisterClientModel.contact.telecom.use
                  Definition

                  Purpose of the contact information (e.g., home, work, mobile).

                  ShortPurpose of the contact information (e.g., home, work, mobile).
                  Control0..1
                  Typecode
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  60. RegisterClientModel.contact.relationship
                  Definition

                  The relationship of the caregiver to the client.

                  ShortThe relationship of the caregiver to the client.
                  Control0..1
                  TypeCodeableConcept
                  62. RegisterClientModel.contact.relationship.coding
                  Definition

                  Caregiver relationship coding.

                  ShortCaregiver relationship coding.
                  Control0..*
                  TypeCoding
                  64. RegisterClientModel.contact.relationship.coding.system
                  Definition

                  System for caregiver relationship codes.

                  ShortSystem for caregiver relationship codes.
                  Control1..1
                  Typeuri
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  66. RegisterClientModel.contact.relationship.coding.code
                  Definition

                  Caregiver relationship code.

                  ShortCaregiver relationship code.
                  Control1..1
                  Typecode
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  68. RegisterClientModel.contact.relationship.coding.display
                  Definition

                  Caregiver relationship display text.

                  ShortCaregiver relationship display text.
                  Control1..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  70. RegisterClientModel.otherChildren
                  Definition

                  Any other children the mother has.

                  ShortAny other children the mother has.
                  Control0..*
                  TypeBackboneElement
                  72. RegisterClientModel.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
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE28
                  74. RegisterClientModel.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
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE29
                  76. RegisterClientModel.otherChildren.sex
                  Definition

                  Biological characteristics that define humans as female or male.

                  ShortBiological characteristics that define humans as female or male.
                  Control1..1
                  TypeCodeableConcept
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE30
                  78. RegisterClientModel.healthState
                  Definition

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

                  ShortOverall physical, mental, and emotional well-being of the mother.
                  Control0..1
                  TypeCodeableConcept
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE31
                  80. RegisterClientModel.hivStatus
                  Definition

                  HIV status of the client.

                  ShortHIV status of the client.
                  Control0..1
                  TypeCodeableConcept
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE37
                  82. RegisterClientModel.pregnancyStatus
                  Definition

                  Confirms whether the client is pregnant or not.

                  ShortConfirms whether the client is pregnant or not.
                  Control0..1
                  Typeboolean
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Definitional CodesIMMZ.C CodeSystem for Register Client DE41

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

                  0. RegisterClientModel
                  Definition

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

                  ShortIMMZ.C Register Client
                  Control0..*
                  Is Modifierfalse
                  Logical ModelInstances of this logical model are not marked to be the target of a Reference
                  2. RegisterClientModel.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
                  TypeIdentifier
                  4. RegisterClientModel.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. RegisterClientModel.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. RegisterClientModel.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 RegisterClientModel.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 10. RegisterClientModel.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. RegisterClientModel.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
                    Definitional CodesIMMZ.C CodeSystem for Register Client DE4
                    14. RegisterClientModel.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
                    Definitional CodesIMMZ.C CodeSystem for Register Client DE3
                    16. RegisterClientModel.sex
                    Definition

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

                    ShortSex
                    Control1..1
                    Typecode
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Definitional CodesIMMZ.C CodeSystem for Register Client DE5
                    18. RegisterClientModel.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
                    Definitional CodesIMMZ.C CodeSystem for Register Client DE8
                    20. RegisterClientModel.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
                    Definitional CodesIMMZ.C CodeSystem for Register Client DE9
                    22. RegisterClientModel.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
                    Definitional CodesIMMZ.C CodeSystem for Register Client DE10
                    24. RegisterClientModel.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
                    Definitional CodesIMMZ.C CodeSystem for Register Client DE11
                    26. RegisterClientModel.weightAtBirth
                    Definition

                    Client's weight at birth in Kg.

                    ShortClient's weight at birth in Kg.
                    Control0..1
                    TypeQuantity
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    qty-3: If a code for the unit is present, the system SHALL also be present (code.empty() or system.exists())
                    28. RegisterClientModel.weightAtBirth.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
                    30. RegisterClientModel.weightAtBirth.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 RegisterClientModel.weightAtBirth.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 32. RegisterClientModel.weightAtBirth.value
                      Definition

                      The value of the measured amount. The value includes an implicit precision in the presentation of the value.

                      ShortNumerical value (with implicit precision)
                      Comments

                      The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

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

                      Precision is handled implicitly in almost all cases of measurement.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      34. RegisterClientModel.weightAtBirth.comparator
                      Definition

                      How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

                      Short< | <= | >= | > - how to understand the value
                      Control0..1
                      BindingThe codes SHALL be taken from QuantityComparator
                      (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)

                      How the Quantity should be understood and represented.

                      Typecode
                      Is Modifiertrue because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

                      Meaning if MissingIf there is no comparator, then there is no modification of the value
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      36. RegisterClientModel.weightAtBirth.unit
                      Definition

                      A human-readable form of the unit.

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

                      There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

                      Pattern Valuekg
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      38. RegisterClientModel.weightAtBirth.system
                      Definition

                      The identification of the system that provides the coded form of the unit.

                      ShortSystem that defines coded unit form
                      Control0..1
                      This element is affected by the following invariants: qty-3
                      Typeuri
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Need to know the system that defines the coded form of the unit.

                      Pattern Valuehttp://unitsofmeasure.org
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      40. RegisterClientModel.weightAtBirth.code
                      Definition

                      A computer processable form of the unit in some unit representation system.

                      ShortCoded form of the unit
                      Comments

                      The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

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

                      Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

                      Pattern Valuekg
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      42. RegisterClientModel.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()))
                      44. RegisterClientModel.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
                      46. RegisterClientModel.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 RegisterClientModel.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 48. RegisterClientModel.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())
                        50. RegisterClientModel.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
                        Definitional CodesIMMZ.C CodeSystem for Register Client DE13
                        52. RegisterClientModel.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
                        Definitional CodesIMMZ.C CodeSystem for Register Client DE14
                        54. RegisterClientModel.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
                        Definitional CodesIMMZ.C CodeSystem for Register Client DE15
                        56. RegisterClientModel.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
                        Definitional CodesIMMZ.C CodeSystem for Register Client DE16
                        58. RegisterClientModel.address.ward
                        Definition

                        The ward where the client lives.

                        ShortThe ward where the client lives.
                        Control0..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Definitional CodesIMMZ.C CodeSystem for Register Client DE17
                        60. RegisterClientModel.address.lga
                        Definition

                        Local Government Authority where the client lives.

                        ShortLocal Government Authority where the client lives.
                        Control0..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Definitional CodesIMMZ.C CodeSystem for Register Client DE18
                        62. RegisterClientModel.address.state
                        Definition

                        The state where the client lives.

                        ShortThe state where the client lives.
                        Control0..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Definitional CodesIMMZ.C CodeSystem for Register Client DE19
                        64. RegisterClientModel.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()))
                        66. RegisterClientModel.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
                        68. RegisterClientModel.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 RegisterClientModel.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 70. RegisterClientModel.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())
                          72. RegisterClientModel.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()))
                          74. RegisterClientModel.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
                          76. RegisterClientModel.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 RegisterClientModel.contact.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 78. RegisterClientModel.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())
                            80. RegisterClientModel.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
                            82. RegisterClientModel.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
                            84. RegisterClientModel.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()))
                            86. RegisterClientModel.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
                            88. RegisterClientModel.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 RegisterClientModel.contact.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 90. RegisterClientModel.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()))
                              92. RegisterClientModel.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()))
                              94. RegisterClientModel.contact.telecom.use
                              Definition

                              Purpose of the contact information (e.g., home, work, mobile).

                              ShortPurpose of the contact information (e.g., home, work, mobile).
                              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()))
                              96. RegisterClientModel.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()))
                              98. RegisterClientModel.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()))
                              100. RegisterClientModel.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()))
                              102. RegisterClientModel.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
                              104. RegisterClientModel.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 RegisterClientModel.contact.relationship.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 106. RegisterClientModel.contact.relationship.coding
                                Definition

                                Caregiver relationship coding.

                                ShortCaregiver relationship coding.
                                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()))
                                108. RegisterClientModel.contact.relationship.text
                                Definition

                                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.

                                ShortPlain 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()))
                                110. RegisterClientModel.contact.relationship.coding.system
                                Definition

                                System for caregiver relationship codes.

                                ShortSystem for caregiver relationship codes.
                                Control1..1
                                Typeuri
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                112. RegisterClientModel.contact.relationship.coding.code
                                Definition

                                Caregiver relationship code.

                                ShortCaregiver relationship code.
                                Control1..1
                                Typecode
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                114. RegisterClientModel.contact.relationship.coding.display
                                Definition

                                Caregiver relationship display text.

                                ShortCaregiver relationship display text.
                                Control1..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                116. RegisterClientModel.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()))
                                118. RegisterClientModel.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
                                120. RegisterClientModel.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 RegisterClientModel.otherChildren.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 122. RegisterClientModel.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())
                                  124. RegisterClientModel.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
                                  Definitional CodesIMMZ.C CodeSystem for Register Client DE28
                                  126. RegisterClientModel.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
                                  Definitional CodesIMMZ.C CodeSystem for Register Client DE29
                                  128. RegisterClientModel.otherChildren.sex
                                  Definition

                                  Biological characteristics that define humans as female or male.

                                  ShortBiological characteristics that define humans as female or male.
                                  Control1..1
                                  TypeCodeableConcept
                                  Definitional CodesIMMZ.C CodeSystem for Register Client DE30
                                  130. RegisterClientModel.healthState
                                  Definition

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

                                  ShortOverall physical, mental, and emotional well-being of the mother.
                                  Control0..1
                                  TypeCodeableConcept
                                  Definitional CodesIMMZ.C CodeSystem for Register Client DE31
                                  132. RegisterClientModel.hivStatus
                                  Definition

                                  HIV status of the client.

                                  ShortHIV status of the client.
                                  Control0..1
                                  TypeCodeableConcept
                                  Definitional CodesIMMZ.C CodeSystem for Register Client DE37
                                  134. RegisterClientModel.pregnancyStatus
                                  Definition

                                  Confirms whether the client is pregnant or not.

                                  ShortConfirms whether the client is pregnant or not.
                                  Control0..1
                                  Typeboolean
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Definitional CodesIMMZ.C CodeSystem for Register Client DE41