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: IMMZ.C Register Client

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

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

Usages:

  • This Logical Model is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RegisterClientModel 0..* Base IMMZ.C Register Client
... identifier 1..1 Identifier 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 code Sex
... 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 C 0..1 Quantity Client's weight at birth in Kg.
Constraints: qty-3
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
.... unit Σ 0..1 string Unit representation
Required Pattern: kg
.... system ΣC 0..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
.... code Σ 0..1 code Coded form of the unit
Required Pattern: 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 string The ward where the client lives.
.... lga 0..1 string Local Government Authority where the client lives.
.... state 0..1 string The state where the client lives.
... 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 Purpose of the contact information (e.g., home, work, mobile).
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 Caregiver relationship coding.
..... text Σ 0..1 string Plain text representation of the concept
... 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.
... healthState 0..1 CodeableConcept Overall physical, mental, and emotional well-being of the mother.
... hivStatus 0..1 CodeableConcept HIV status of the client.
... pregnancyStatus 0..1 boolean Confirms whether the client is pregnant or not.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RegisterClientModel.weightAtBirth.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
From the FHIR Standard
RegisterClientModel.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
RegisterClientModel.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorRegisterClientModel.contact.telecomA system is required if a value is provided.
: value.empty() or system.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
qty-3errorRegisterClientModel.weightAtBirthIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RegisterClientModel 0..* Base IMMZ.C Register Client
... identifier 1..1 Identifier 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 code Sex
... 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.
.... unit 0..1 string Unit representation
Required Pattern: kg
.... system 0..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
.... code 0..1 code Coded form of the unit
Required Pattern: 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 string The ward where the client lives.
.... lga 0..1 string Local Government Authority where the client lives.
.... state 0..1 string The state where the client lives.
... 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.
..... use 0..1 code Purpose of the contact information (e.g., home, work, mobile).
.... relationship 0..1 CodeableConcept The relationship of the caregiver to the client.
..... coding 0..* Coding Caregiver relationship coding.
...... system 1..1 uri System for caregiver relationship codes.
...... code 1..1 code Caregiver relationship code.
...... display 1..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.
... healthState 0..1 CodeableConcept Overall physical, mental, and emotional well-being of the mother.
... hivStatus 0..1 CodeableConcept HIV status of the client.
... pregnancyStatus 0..1 boolean Confirms whether the client is pregnant or not.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RegisterClientModel 0..* Base IMMZ.C Register Client
... identifier 1..1 Identifier 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 code Sex
... 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 C 0..1 Quantity Client's weight at birth in Kg.
Constraints: qty-3
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
.... unit Σ 0..1 string Unit representation
Required Pattern: kg
.... system ΣC 0..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
.... code Σ 0..1 code Coded form of the unit
Required Pattern: 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 string The ward where the client lives.
.... lga 0..1 string Local Government Authority where the client lives.
.... state 0..1 string The state where the client lives.
... 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 Purpose of the contact information (e.g., home, work, mobile).
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 Caregiver relationship coding.
..... text Σ 0..1 string Plain text representation of the concept
... 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.
... healthState 0..1 CodeableConcept Overall physical, mental, and emotional well-being of the mother.
... hivStatus 0..1 CodeableConcept HIV status of the client.
... pregnancyStatus 0..1 boolean Confirms whether the client is pregnant or not.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RegisterClientModel.weightAtBirth.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
From the FHIR Standard
RegisterClientModel.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
RegisterClientModel.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorRegisterClientModel.contact.telecomA system is required if a value is provided.
: value.empty() or system.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
qty-3errorRegisterClientModel.weightAtBirthIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(17 nested mandatory elements)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RegisterClientModel 0..* Base IMMZ.C Register Client
... identifier 1..1 Identifier 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 code Sex
... 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 C 0..1 Quantity Client's weight at birth in Kg.
Constraints: qty-3
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
.... unit Σ 0..1 string Unit representation
Required Pattern: kg
.... system ΣC 0..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
.... code Σ 0..1 code Coded form of the unit
Required Pattern: 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 string The ward where the client lives.
.... lga 0..1 string Local Government Authority where the client lives.
.... state 0..1 string The state where the client lives.
... 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 Purpose of the contact information (e.g., home, work, mobile).
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 Caregiver relationship coding.
..... text Σ 0..1 string Plain text representation of the concept
... 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.
... healthState 0..1 CodeableConcept Overall physical, mental, and emotional well-being of the mother.
... hivStatus 0..1 CodeableConcept HIV status of the client.
... pregnancyStatus 0..1 boolean Confirms whether the client is pregnant or not.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RegisterClientModel.weightAtBirth.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
From the FHIR Standard
RegisterClientModel.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
RegisterClientModel.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorRegisterClientModel.contact.telecomA system is required if a value is provided.
: value.empty() or system.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
qty-3errorRegisterClientModel.weightAtBirthIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RegisterClientModel 0..* Base IMMZ.C Register Client
... identifier 1..1 Identifier 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 code Sex
... 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.
.... unit 0..1 string Unit representation
Required Pattern: kg
.... system 0..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
.... code 0..1 code Coded form of the unit
Required Pattern: 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 string The ward where the client lives.
.... lga 0..1 string Local Government Authority where the client lives.
.... state 0..1 string The state where the client lives.
... 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.
..... use 0..1 code Purpose of the contact information (e.g., home, work, mobile).
.... relationship 0..1 CodeableConcept The relationship of the caregiver to the client.
..... coding 0..* Coding Caregiver relationship coding.
...... system 1..1 uri System for caregiver relationship codes.
...... code 1..1 code Caregiver relationship code.
...... display 1..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.
... healthState 0..1 CodeableConcept Overall physical, mental, and emotional well-being of the mother.
... hivStatus 0..1 CodeableConcept HIV status of the client.
... pregnancyStatus 0..1 boolean Confirms whether the client is pregnant or not.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RegisterClientModel 0..* Base IMMZ.C Register Client
... identifier 1..1 Identifier 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 code Sex
... 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 C 0..1 Quantity Client's weight at birth in Kg.
Constraints: qty-3
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
.... unit Σ 0..1 string Unit representation
Required Pattern: kg
.... system ΣC 0..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
.... code Σ 0..1 code Coded form of the unit
Required Pattern: 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 string The ward where the client lives.
.... lga 0..1 string Local Government Authority where the client lives.
.... state 0..1 string The state where the client lives.
... 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 Purpose of the contact information (e.g., home, work, mobile).
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 Caregiver relationship coding.
..... text Σ 0..1 string Plain text representation of the concept
... 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.
... healthState 0..1 CodeableConcept Overall physical, mental, and emotional well-being of the mother.
... hivStatus 0..1 CodeableConcept HIV status of the client.
... pregnancyStatus 0..1 boolean Confirms whether the client is pregnant or not.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RegisterClientModel.weightAtBirth.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
From the FHIR Standard
RegisterClientModel.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
RegisterClientModel.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorRegisterClientModel.contact.telecomA system is required if a value is provided.
: value.empty() or system.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
qty-3errorRegisterClientModel.weightAtBirthIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(17 nested mandatory elements)

 

Other representations of profile: CSV, Excel