NPHCDA Immunization FHIR IG
0.7.0 - ci-build
NPHCDA Immunization FHIR IG
0.7.0 - ci-build
NPHCDA Immunization FHIR IG, published by https://nphcda.gov.ng. This guide is not an authorized publication; it is the continuous build for version 0.7.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Nigeria-FHIR-Community/NPHCDA-ImmunizationIG/ and changes regularly. See the Directory of published versions
| Official URL: https://nphcda.gov.ng/ig/StructureDefinition/register-client-model | Version: 0.7.0 | |||
| Draft as of 2025-10-27 | Computable Name: RegisterClientModel | |||
IMMZ.C5 - A logical model representing a client being registered in the immunization system.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  register-client-model |
0..* | Base | NG-Imm-C5 RegisterClient | |
  identifier |
1..1 | string | Unique identifier for clients including the national identification number, medical records number, immunization information system ID, and others. | |
  name |
1..1 | BackboneElement | The full name of the client. | |
 @id |
0..1 | string | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| family |
1..1 | string | Client's family name or last name. | |
 given |
1..1 | string | Client's first name or given name. | |
| sex |
1..1 | CodeableConcept | Sex Binding: NG Gender or Sex VS (preferred) | |
| dateOfBirth |
1..1 | date | Client's date of birth (DOB) if known. If unknown, use assigned DOB for administrative purposes. | |
| ageInWeeks |
0..1 | integer | The client's calculated age (number of weeks) based on the date of birth and the visit date. | |
| ageInMonths |
0..1 | integer | The client's calculated age (number of months) based on the date of birth and the visit date. | |
| ageInYears |
0..1 | integer | The client's calculated age (number of years) based on the date of birth and the visit date. | |
| weightAtBirth |
0..1 | Quantity | Client's weight at birth in kg. | |
| address |
0..1 | BackboneElement | Client's residential address. | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| residentialAddress |
0..1 | string | Child's residential address. | |
| houseNumber |
0..1 | string | The number of the house where the client lives. | |
| village |
0..1 | string | The village where the client lives. | |
| town |
0..1 | string | The town or city where the client resides. | |
| ward |
0..1 | CodeableConcept | The ward where the client lives. Binding: NG-Imm Wards VS (preferred) | |
| lga |
0..1 | CodeableConcept | Local Government Authority where the client lives. Binding: NG-Imm LGAs VS (preferred) | |
| state |
0..1 | CodeableConcept | The state where the client lives. Binding: NG-Imm States VS (preferred) | |
| contact |
0..* | BackboneElement | The client's caregiver (person) which could be next of kin (e.g., partner, husband, mother, sibling, etc.). | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
1..1 | BackboneElement | The full name of the caregiver. | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| family |
1..1 | string | Family name of the caregiver. | |
| given |
1..1 | string | Given name of the caregiver. | |
| telecom |
C | 0..* | ContactPoint | Phone number of the caregiver. Constraints: cpt-2 |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
ΣC | 1..1 | code | Type of communication (e.g., phone, email). Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value |
Σ | 1..1 | string | Caregiver's contact number or address. |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use |
 relationship |
0..1 | CodeableConcept | The relationship of the caregiver to the client. | |
 @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system |
| text |
Σ | 0..1 | string | Caregiver relationship display text. |
| otherChildren |
0..* | BackboneElement | Any other children the mother has. | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
1..1 | string | The full name of the mother's other children. | |
| birthYear |
1..1 | integer | The year the mother's children were born. | |
| sex |
1..1 | CodeableConcept | Biological characteristics that define humans as female or male. Binding: NG Gender or Sex VS (preferred) | |
| healthStatus |
0..1 | CodeableConcept | Overall physical, mental, and emotional well-being of the sibling. Binding: NG-Imm Sibling Health Status VS (preferred) | |
| hivStatus |
0..1 | CodeableConcept | HIV status of the client. Binding: NG-Imm Client HIV Status VS (preferred) | |
| pregnancyStatus |
0..1 | CodeableConcept | Confirms whether the client is pregnant or not. Binding: NG-Imm Clinical Status VS (preferred) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| register-client-model.sex | Base | preferred | NG Gender or Sex VS | 📦0.7.0 | This IG |
| register-client-model.address.ward | Base | preferred | NG-Imm Wards VS | 📦0.7.0 | This IG |
| register-client-model.address.lga | Base | preferred | NG-Imm LGAs VS | 📦0.7.0 | This IG |
| register-client-model.address.state | Base | preferred | NG-Imm States VS | 📦0.7.0 | This IG |
| register-client-model.contact.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| register-client-model.contact.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| register-client-model.otherChildren.sex | Base | preferred | NG Gender or Sex VS | 📦0.7.0 | This IG |
| register-client-model.healthStatus | Base | preferred | NG-Imm Sibling Health Status VS | 📦0.7.0 | This IG |
| register-client-model.hivStatus | Base | preferred | NG-Imm Client HIV Status VS | 📦0.7.0 | This IG |
| register-client-model.pregnancyStatus | Base | preferred | NG-Imm Clinical Status VS | 📦0.7.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| cpt-2 | error | register-client-model.contact.telecom | A system is required if a value is provided. |
value.empty() or system.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| register-client-model |
0..* | Base | NG-Imm-C5 RegisterClient | |
| identifier |
1..1 | string | Unique identifier for clients including the national identification number, medical records number, immunization information system ID, and others. | |
| name |
1..1 | BackboneElement | The full name of the client. | |
| family |
1..1 | string | Client's family name or last name. | |
| given |
1..1 | string | Client's first name or given name. | |
| sex |
1..1 | CodeableConcept | Sex Binding: NG Gender or Sex VS (preferred) | |
| dateOfBirth |
1..1 | date | Client's date of birth (DOB) if known. If unknown, use assigned DOB for administrative purposes. | |
| ageInWeeks |
0..1 | integer | The client's calculated age (number of weeks) based on the date of birth and the visit date. | |
| ageInMonths |
0..1 | integer | The client's calculated age (number of months) based on the date of birth and the visit date. | |
| ageInYears |
0..1 | integer | The client's calculated age (number of years) based on the date of birth and the visit date. | |
| weightAtBirth |
0..1 | Quantity | Client's weight at birth in kg. | |
| address |
0..1 | BackboneElement | Client's residential address. | |
| residentialAddress |
0..1 | string | Child's residential address. | |
| houseNumber |
0..1 | string | The number of the house where the client lives. | |
| village |
0..1 | string | The village where the client lives. | |
| town |
0..1 | string | The town or city where the client resides. | |
| ward |
0..1 | CodeableConcept | The ward where the client lives. Binding: NG-Imm Wards VS (preferred) | |
| lga |
0..1 | CodeableConcept | Local Government Authority where the client lives. Binding: NG-Imm LGAs VS (preferred) | |
| state |
0..1 | CodeableConcept | The state where the client lives. Binding: NG-Imm States VS (preferred) | |
| contact |
0..* | BackboneElement | The client's caregiver (person) which could be next of kin (e.g., partner, husband, mother, sibling, etc.). | |
| name |
1..1 | BackboneElement | The full name of the caregiver. | |
| family |
1..1 | string | Family name of the caregiver. | |
| given |
1..1 | string | Given name of the caregiver. | |
| telecom |
0..* | ContactPoint | Phone number of the caregiver. | |
| system |
1..1 | code | Type of communication (e.g., phone, email). | |
| value |
1..1 | string | Caregiver's contact number or address. | |
| relationship |
0..1 | CodeableConcept | The relationship of the caregiver to the client. | |
| text |
0..1 | string | Caregiver relationship display text. | |
| otherChildren |
0..* | BackboneElement | Any other children the mother has. | |
| name |
1..1 | string | The full name of the mother's other children. | |
| birthYear |
1..1 | integer | The year the mother's children were born. | |
| sex |
1..1 | CodeableConcept | Biological characteristics that define humans as female or male. Binding: NG Gender or Sex VS (preferred) | |
| healthStatus |
0..1 | CodeableConcept | Overall physical, mental, and emotional well-being of the sibling. Binding: NG-Imm Sibling Health Status VS (preferred) | |
| hivStatus |
0..1 | CodeableConcept | HIV status of the client. Binding: NG-Imm Client HIV Status VS (preferred) | |
| pregnancyStatus |
0..1 | CodeableConcept | Confirms whether the client is pregnant or not. Binding: NG-Imm Clinical Status VS (preferred) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| register-client-model.sex | Base | preferred | NG Gender or Sex VS | 📦0.7.0 | This IG |
| register-client-model.address.ward | Base | preferred | NG-Imm Wards VS | 📦0.7.0 | This IG |
| register-client-model.address.lga | Base | preferred | NG-Imm LGAs VS | 📦0.7.0 | This IG |
| register-client-model.address.state | Base | preferred | NG-Imm States VS | 📦0.7.0 | This IG |
| register-client-model.otherChildren.sex | Base | preferred | NG Gender or Sex VS | 📦0.7.0 | This IG |
| register-client-model.healthStatus | Base | preferred | NG-Imm Sibling Health Status VS | 📦0.7.0 | This IG |
| register-client-model.hivStatus | Base | preferred | NG-Imm Client HIV Status VS | 📦0.7.0 | This IG |
| register-client-model.pregnancyStatus | Base | preferred | NG-Imm Clinical Status VS | 📦0.7.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| register-client-model |
0..* | Base | NG-Imm-C5 RegisterClient | |
| identifier |
1..1 | string | Unique identifier for clients including the national identification number, medical records number, immunization information system ID, and others. | |
| name |
1..1 | BackboneElement | The full name of the client. | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| family |
1..1 | string | Client's family name or last name. | |
| given |
1..1 | string | Client's first name or given name. | |
| sex |
1..1 | CodeableConcept | Sex Binding: NG Gender or Sex VS (preferred) | |
| dateOfBirth |
1..1 | date | Client's date of birth (DOB) if known. If unknown, use assigned DOB for administrative purposes. | |
| ageInWeeks |
0..1 | integer | The client's calculated age (number of weeks) based on the date of birth and the visit date. | |
| ageInMonths |
0..1 | integer | The client's calculated age (number of months) based on the date of birth and the visit date. | |
| ageInYears |
0..1 | integer | The client's calculated age (number of years) based on the date of birth and the visit date. | |
| weightAtBirth |
0..1 | Quantity | Client's weight at birth in kg. | |
| address |
0..1 | BackboneElement | Client's residential address. | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| residentialAddress |
0..1 | string | Child's residential address. | |
| houseNumber |
0..1 | string | The number of the house where the client lives. | |
| village |
0..1 | string | The village where the client lives. | |
| town |
0..1 | string | The town or city where the client resides. | |
| ward |
0..1 | CodeableConcept | The ward where the client lives. Binding: NG-Imm Wards VS (preferred) | |
| lga |
0..1 | CodeableConcept | Local Government Authority where the client lives. Binding: NG-Imm LGAs VS (preferred) | |
| state |
0..1 | CodeableConcept | The state where the client lives. Binding: NG-Imm States VS (preferred) | |
| contact |
0..* | BackboneElement | The client's caregiver (person) which could be next of kin (e.g., partner, husband, mother, sibling, etc.). | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
1..1 | BackboneElement | The full name of the caregiver. | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| family |
1..1 | string | Family name of the caregiver. | |
| given |
1..1 | string | Given name of the caregiver. | |
| telecom |
C | 0..* | ContactPoint | Phone number of the caregiver. Constraints: cpt-2 |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
ΣC | 1..1 | code | Type of communication (e.g., phone, email). Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value |
Σ | 1..1 | string | Caregiver's contact number or address. |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use |
| relationship |
0..1 | CodeableConcept | The relationship of the caregiver to the client. | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system |
| text |
Σ | 0..1 | string | Caregiver relationship display text. |
| otherChildren |
0..* | BackboneElement | Any other children the mother has. | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
1..1 | string | The full name of the mother's other children. | |
| birthYear |
1..1 | integer | The year the mother's children were born. | |
| sex |
1..1 | CodeableConcept | Biological characteristics that define humans as female or male. Binding: NG Gender or Sex VS (preferred) | |
| healthStatus |
0..1 | CodeableConcept | Overall physical, mental, and emotional well-being of the sibling. Binding: NG-Imm Sibling Health Status VS (preferred) | |
| hivStatus |
0..1 | CodeableConcept | HIV status of the client. Binding: NG-Imm Client HIV Status VS (preferred) | |
| pregnancyStatus |
0..1 | CodeableConcept | Confirms whether the client is pregnant or not. Binding: NG-Imm Clinical Status VS (preferred) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| register-client-model.sex | Base | preferred | NG Gender or Sex VS | 📦0.7.0 | This IG |
| register-client-model.address.ward | Base | preferred | NG-Imm Wards VS | 📦0.7.0 | This IG |
| register-client-model.address.lga | Base | preferred | NG-Imm LGAs VS | 📦0.7.0 | This IG |
| register-client-model.address.state | Base | preferred | NG-Imm States VS | 📦0.7.0 | This IG |
| register-client-model.contact.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| register-client-model.contact.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| register-client-model.otherChildren.sex | Base | preferred | NG Gender or Sex VS | 📦0.7.0 | This IG |
| register-client-model.healthStatus | Base | preferred | NG-Imm Sibling Health Status VS | 📦0.7.0 | This IG |
| register-client-model.hivStatus | Base | preferred | NG-Imm Client HIV Status VS | 📦0.7.0 | This IG |
| register-client-model.pregnancyStatus | Base | preferred | NG-Imm Clinical Status VS | 📦0.7.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| cpt-2 | error | register-client-model.contact.telecom | A system is required if a value is provided. |
value.empty() or system.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Base
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| register-client-model |
0..* | Base | NG-Imm-C5 RegisterClient | |
| identifier |
1..1 | string | Unique identifier for clients including the national identification number, medical records number, immunization information system ID, and others. | |
| name |
1..1 | BackboneElement | The full name of the client. | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| family |
1..1 | string | Client's family name or last name. | |
| given |
1..1 | string | Client's first name or given name. | |
| sex |
1..1 | CodeableConcept | Sex Binding: NG Gender or Sex VS (preferred) | |
| dateOfBirth |
1..1 | date | Client's date of birth (DOB) if known. If unknown, use assigned DOB for administrative purposes. | |
| ageInWeeks |
0..1 | integer | The client's calculated age (number of weeks) based on the date of birth and the visit date. | |
| ageInMonths |
0..1 | integer | The client's calculated age (number of months) based on the date of birth and the visit date. | |
| ageInYears |
0..1 | integer | The client's calculated age (number of years) based on the date of birth and the visit date. | |
| weightAtBirth |
0..1 | Quantity | Client's weight at birth in kg. | |
| address |
0..1 | BackboneElement | Client's residential address. | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| residentialAddress |
0..1 | string | Child's residential address. | |
| houseNumber |
0..1 | string | The number of the house where the client lives. | |
| village |
0..1 | string | The village where the client lives. | |
| town |
0..1 | string | The town or city where the client resides. | |
| ward |
0..1 | CodeableConcept | The ward where the client lives. Binding: NG-Imm Wards VS (preferred) | |
| lga |
0..1 | CodeableConcept | Local Government Authority where the client lives. Binding: NG-Imm LGAs VS (preferred) | |
| state |
0..1 | CodeableConcept | The state where the client lives. Binding: NG-Imm States VS (preferred) | |
| contact |
0..* | BackboneElement | The client's caregiver (person) which could be next of kin (e.g., partner, husband, mother, sibling, etc.). | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
1..1 | BackboneElement | The full name of the caregiver. | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| family |
1..1 | string | Family name of the caregiver. | |
| given |
1..1 | string | Given name of the caregiver. | |
| telecom |
C | 0..* | ContactPoint | Phone number of the caregiver. Constraints: cpt-2 |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
ΣC | 1..1 | code | Type of communication (e.g., phone, email). Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value |
Σ | 1..1 | string | Caregiver's contact number or address. |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use |
| relationship |
0..1 | CodeableConcept | The relationship of the caregiver to the client. | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system |
| text |
Σ | 0..1 | string | Caregiver relationship display text. |
| otherChildren |
0..* | BackboneElement | Any other children the mother has. | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
1..1 | string | The full name of the mother's other children. | |
| birthYear |
1..1 | integer | The year the mother's children were born. | |
| sex |
1..1 | CodeableConcept | Biological characteristics that define humans as female or male. Binding: NG Gender or Sex VS (preferred) | |
| healthStatus |
0..1 | CodeableConcept | Overall physical, mental, and emotional well-being of the sibling. Binding: NG-Imm Sibling Health Status VS (preferred) | |
| hivStatus |
0..1 | CodeableConcept | HIV status of the client. Binding: NG-Imm Client HIV Status VS (preferred) | |
| pregnancyStatus |
0..1 | CodeableConcept | Confirms whether the client is pregnant or not. Binding: NG-Imm Clinical Status VS (preferred) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| register-client-model.sex | Base | preferred | NG Gender or Sex VS | 📦0.7.0 | This IG |
| register-client-model.address.ward | Base | preferred | NG-Imm Wards VS | 📦0.7.0 | This IG |
| register-client-model.address.lga | Base | preferred | NG-Imm LGAs VS | 📦0.7.0 | This IG |
| register-client-model.address.state | Base | preferred | NG-Imm States VS | 📦0.7.0 | This IG |
| register-client-model.contact.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| register-client-model.contact.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| register-client-model.otherChildren.sex | Base | preferred | NG Gender or Sex VS | 📦0.7.0 | This IG |
| register-client-model.healthStatus | Base | preferred | NG-Imm Sibling Health Status VS | 📦0.7.0 | This IG |
| register-client-model.hivStatus | Base | preferred | NG-Imm Client HIV Status VS | 📦0.7.0 | This IG |
| register-client-model.pregnancyStatus | Base | preferred | NG-Imm Clinical Status VS | 📦0.7.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| cpt-2 | error | register-client-model.contact.telecom | A system is required if a value is provided. |
value.empty() or system.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| register-client-model |
0..* | Base | NG-Imm-C5 RegisterClient | |
| identifier |
1..1 | string | Unique identifier for clients including the national identification number, medical records number, immunization information system ID, and others. | |
| name |
1..1 | BackboneElement | The full name of the client. | |
| family |
1..1 | string | Client's family name or last name. | |
| given |
1..1 | string | Client's first name or given name. | |
| sex |
1..1 | CodeableConcept | Sex Binding: NG Gender or Sex VS (preferred) | |
| dateOfBirth |
1..1 | date | Client's date of birth (DOB) if known. If unknown, use assigned DOB for administrative purposes. | |
| ageInWeeks |
0..1 | integer | The client's calculated age (number of weeks) based on the date of birth and the visit date. | |
| ageInMonths |
0..1 | integer | The client's calculated age (number of months) based on the date of birth and the visit date. | |
| ageInYears |
0..1 | integer | The client's calculated age (number of years) based on the date of birth and the visit date. | |
| weightAtBirth |
0..1 | Quantity | Client's weight at birth in kg. | |
| address |
0..1 | BackboneElement | Client's residential address. | |
| residentialAddress |
0..1 | string | Child's residential address. | |
| houseNumber |
0..1 | string | The number of the house where the client lives. | |
| village |
0..1 | string | The village where the client lives. | |
| town |
0..1 | string | The town or city where the client resides. | |
| ward |
0..1 | CodeableConcept | The ward where the client lives. Binding: NG-Imm Wards VS (preferred) | |
| lga |
0..1 | CodeableConcept | Local Government Authority where the client lives. Binding: NG-Imm LGAs VS (preferred) | |
| state |
0..1 | CodeableConcept | The state where the client lives. Binding: NG-Imm States VS (preferred) | |
| contact |
0..* | BackboneElement | The client's caregiver (person) which could be next of kin (e.g., partner, husband, mother, sibling, etc.). | |
| name |
1..1 | BackboneElement | The full name of the caregiver. | |
| family |
1..1 | string | Family name of the caregiver. | |
| given |
1..1 | string | Given name of the caregiver. | |
| telecom |
0..* | ContactPoint | Phone number of the caregiver. | |
| system |
1..1 | code | Type of communication (e.g., phone, email). | |
| value |
1..1 | string | Caregiver's contact number or address. | |
| relationship |
0..1 | CodeableConcept | The relationship of the caregiver to the client. | |
| text |
0..1 | string | Caregiver relationship display text. | |
| otherChildren |
0..* | BackboneElement | Any other children the mother has. | |
| name |
1..1 | string | The full name of the mother's other children. | |
| birthYear |
1..1 | integer | The year the mother's children were born. | |
| sex |
1..1 | CodeableConcept | Biological characteristics that define humans as female or male. Binding: NG Gender or Sex VS (preferred) | |
| healthStatus |
0..1 | CodeableConcept | Overall physical, mental, and emotional well-being of the sibling. Binding: NG-Imm Sibling Health Status VS (preferred) | |
| hivStatus |
0..1 | CodeableConcept | HIV status of the client. Binding: NG-Imm Client HIV Status VS (preferred) | |
| pregnancyStatus |
0..1 | CodeableConcept | Confirms whether the client is pregnant or not. Binding: NG-Imm Clinical Status VS (preferred) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| register-client-model.sex | Base | preferred | NG Gender or Sex VS | 📦0.7.0 | This IG |
| register-client-model.address.ward | Base | preferred | NG-Imm Wards VS | 📦0.7.0 | This IG |
| register-client-model.address.lga | Base | preferred | NG-Imm LGAs VS | 📦0.7.0 | This IG |
| register-client-model.address.state | Base | preferred | NG-Imm States VS | 📦0.7.0 | This IG |
| register-client-model.otherChildren.sex | Base | preferred | NG Gender or Sex VS | 📦0.7.0 | This IG |
| register-client-model.healthStatus | Base | preferred | NG-Imm Sibling Health Status VS | 📦0.7.0 | This IG |
| register-client-model.hivStatus | Base | preferred | NG-Imm Client HIV Status VS | 📦0.7.0 | This IG |
| register-client-model.pregnancyStatus | Base | preferred | NG-Imm Clinical Status VS | 📦0.7.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| register-client-model |
0..* | Base | NG-Imm-C5 RegisterClient | |
| identifier |
1..1 | string | Unique identifier for clients including the national identification number, medical records number, immunization information system ID, and others. | |
| name |
1..1 | BackboneElement | The full name of the client. | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| family |
1..1 | string | Client's family name or last name. | |
| given |
1..1 | string | Client's first name or given name. | |
| sex |
1..1 | CodeableConcept | Sex Binding: NG Gender or Sex VS (preferred) | |
| dateOfBirth |
1..1 | date | Client's date of birth (DOB) if known. If unknown, use assigned DOB for administrative purposes. | |
| ageInWeeks |
0..1 | integer | The client's calculated age (number of weeks) based on the date of birth and the visit date. | |
| ageInMonths |
0..1 | integer | The client's calculated age (number of months) based on the date of birth and the visit date. | |
| ageInYears |
0..1 | integer | The client's calculated age (number of years) based on the date of birth and the visit date. | |
| weightAtBirth |
0..1 | Quantity | Client's weight at birth in kg. | |
| address |
0..1 | BackboneElement | Client's residential address. | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| residentialAddress |
0..1 | string | Child's residential address. | |
| houseNumber |
0..1 | string | The number of the house where the client lives. | |
| village |
0..1 | string | The village where the client lives. | |
| town |
0..1 | string | The town or city where the client resides. | |
| ward |
0..1 | CodeableConcept | The ward where the client lives. Binding: NG-Imm Wards VS (preferred) | |
| lga |
0..1 | CodeableConcept | Local Government Authority where the client lives. Binding: NG-Imm LGAs VS (preferred) | |
| state |
0..1 | CodeableConcept | The state where the client lives. Binding: NG-Imm States VS (preferred) | |
| contact |
0..* | BackboneElement | The client's caregiver (person) which could be next of kin (e.g., partner, husband, mother, sibling, etc.). | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
1..1 | BackboneElement | The full name of the caregiver. | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| family |
1..1 | string | Family name of the caregiver. | |
| given |
1..1 | string | Given name of the caregiver. | |
| telecom |
C | 0..* | ContactPoint | Phone number of the caregiver. Constraints: cpt-2 |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
ΣC | 1..1 | code | Type of communication (e.g., phone, email). Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value |
Σ | 1..1 | string | Caregiver's contact number or address. |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use |
| relationship |
0..1 | CodeableConcept | The relationship of the caregiver to the client. | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system |
| text |
Σ | 0..1 | string | Caregiver relationship display text. |
| otherChildren |
0..* | BackboneElement | Any other children the mother has. | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
1..1 | string | The full name of the mother's other children. | |
| birthYear |
1..1 | integer | The year the mother's children were born. | |
| sex |
1..1 | CodeableConcept | Biological characteristics that define humans as female or male. Binding: NG Gender or Sex VS (preferred) | |
| healthStatus |
0..1 | CodeableConcept | Overall physical, mental, and emotional well-being of the sibling. Binding: NG-Imm Sibling Health Status VS (preferred) | |
| hivStatus |
0..1 | CodeableConcept | HIV status of the client. Binding: NG-Imm Client HIV Status VS (preferred) | |
| pregnancyStatus |
0..1 | CodeableConcept | Confirms whether the client is pregnant or not. Binding: NG-Imm Clinical Status VS (preferred) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| register-client-model.sex | Base | preferred | NG Gender or Sex VS | 📦0.7.0 | This IG |
| register-client-model.address.ward | Base | preferred | NG-Imm Wards VS | 📦0.7.0 | This IG |
| register-client-model.address.lga | Base | preferred | NG-Imm LGAs VS | 📦0.7.0 | This IG |
| register-client-model.address.state | Base | preferred | NG-Imm States VS | 📦0.7.0 | This IG |
| register-client-model.contact.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| register-client-model.contact.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| register-client-model.otherChildren.sex | Base | preferred | NG Gender or Sex VS | 📦0.7.0 | This IG |
| register-client-model.healthStatus | Base | preferred | NG-Imm Sibling Health Status VS | 📦0.7.0 | This IG |
| register-client-model.hivStatus | Base | preferred | NG-Imm Client HIV Status VS | 📦0.7.0 | This IG |
| register-client-model.pregnancyStatus | Base | preferred | NG-Imm Clinical Status VS | 📦0.7.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| cpt-2 | error | register-client-model.contact.telecom | A system is required if a value is provided. |
value.empty() or system.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Base