WHO Immunization Implementation Guide
0.2.0 - ci-build

WHO Immunization Implementation Guide, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-immunizations/ and changes regularly. See the Directory of published versions

Logical Model: IMMZ.C Client registration

Official URL: http://smart.who.int/immunizations/StructureDefinition/IMMZCClientregistration Version: 0.2.0
Active as of 2024-12-18 Computable Name: IMMZ_C_Client_registration

Data elements for the IMMZ.C Client registration Data Dictionary.

Usage:

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

Formal Views of Profile Content

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

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. IMMZCClientregistration 0..* Base IMMZ.C Client registration
Instances of this logical model are not marked to be the target of a Reference
... uniqueIdentifier 1..1 string Unique identifier
... name C 1..1 string Name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
... firstName C 0..1 string First name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
... sex 1..1 code Sex
Binding: IMMZ.C.DE5 ValueSet for Sex (required)
... dateOfBirth 1..1 string Date of birth
... age C 0..1 string Age
IMMZ-C-age-1: Required if date of birth is entered.
... caregiversMultiple 0..* BackboneElement Caregivers (multiple)
.... caregiversFullName C 0..1 string Caregiver's full name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
.... caregiversFirstName C 0..1 string Caregiver's first name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
.... caregiversFamilyName C 0..1 string Caregiver's family name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
... contactPhoneNumber 1..1 string Contact phone number
... address 1..1 string Address

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
IMMZCClientregistration.sexrequiredIMMZ_C_DE5
http://smart.who.int/immunizations/ValueSet/IMMZ.C.DE5
from this IG

Constraints

IdGradePath(s)DetailsRequirements
IMMZ-C-age-1errorIMMZCClientregistration.ageRequired if date of birth is entered.
: not(%resource.dateOfBirth.exists()) or $this.exists()
IMMZ-C-name-1errorIMMZCClientregistration.name, IMMZCClientregistration.firstName, IMMZCClientregistration.familyName, IMMZCClientregistration.caregiversMultiple.caregiversFullName, IMMZCClientregistration.caregiversMultiple.caregiversFirstName, IMMZCClientregistration.caregiversMultiple.caregiversFamilyNameOnly letters and special characters (period, dash) allowed.
: $this.matches('[A-Za-z-.]*')
NameFlagsCard.TypeDescription & Constraintsdoco
.. IMMZCClientregistration 0..* Base IMMZ.C Client registration
Instances of this logical model are not marked to be the target of a Reference
... uniqueIdentifier 1..1 string Unique identifier
... name C 1..1 string Name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
... firstName C 0..1 string First name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
... sex 1..1 code Sex
Binding: IMMZ.C.DE5 ValueSet for Sex (required)
... dateOfBirth 1..1 string Date of birth
... age C 0..1 string Age
IMMZ-C-age-1: Required if date of birth is entered.
... caregiversMultiple 0..* BackboneElement Caregivers (multiple)
ele-1: All FHIR elements must have a @value or children
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... caregiversFullName C 0..1 string Caregiver's full name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
.... caregiversFirstName C 0..1 string Caregiver's first name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
.... caregiversFamilyName C 0..1 string Caregiver's family name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
... contactPhoneNumber 1..1 string Contact phone number
... address 1..1 string Address

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
IMMZCClientregistration.sexrequiredIMMZ_C_DE5
http://smart.who.int/immunizations/ValueSet/IMMZ.C.DE5
from this IG

Constraints

IdGradePath(s)DetailsRequirements
IMMZ-C-age-1errorIMMZCClientregistration.ageRequired if date of birth is entered.
: not(%resource.dateOfBirth.exists()) or $this.exists()
IMMZ-C-name-1errorIMMZCClientregistration.name, IMMZCClientregistration.firstName, IMMZCClientregistration.familyName, IMMZCClientregistration.caregiversMultiple.caregiversFullName, IMMZCClientregistration.caregiversMultiple.caregiversFirstName, IMMZCClientregistration.caregiversMultiple.caregiversFamilyNameOnly letters and special characters (period, dash) allowed.
: $this.matches('[A-Za-z-.]*')
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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. IMMZCClientregistration 0..* Base IMMZ.C Client registration
Instances of this logical model are not marked to be the target of a Reference
... uniqueIdentifier 1..1 string Unique identifier
... name C 1..1 string Name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
... firstName C 0..1 string First name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
... sex 1..1 code Sex
Binding: IMMZ.C.DE5 ValueSet for Sex (required)
... dateOfBirth 1..1 string Date of birth
... age C 0..1 string Age
IMMZ-C-age-1: Required if date of birth is entered.
... caregiversMultiple 0..* BackboneElement Caregivers (multiple)
.... @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
.... caregiversFullName C 0..1 string Caregiver's full name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
.... caregiversFirstName C 0..1 string Caregiver's first name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
.... caregiversFamilyName C 0..1 string Caregiver's family name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
... contactPhoneNumber 1..1 string Contact phone number
... address 1..1 string Address

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
IMMZCClientregistration.sexrequiredIMMZ_C_DE5
http://smart.who.int/immunizations/ValueSet/IMMZ.C.DE5
from this IG

Constraints

IdGradePath(s)DetailsRequirements
IMMZ-C-age-1errorIMMZCClientregistration.ageRequired if date of birth is entered.
: not(%resource.dateOfBirth.exists()) or $this.exists()
IMMZ-C-name-1errorIMMZCClientregistration.name, IMMZCClientregistration.firstName, IMMZCClientregistration.familyName, IMMZCClientregistration.caregiversMultiple.caregiversFullName, IMMZCClientregistration.caregiversMultiple.caregiversFirstName, IMMZCClientregistration.caregiversMultiple.caregiversFamilyNameOnly letters and special characters (period, dash) allowed.
: $this.matches('[A-Za-z-.]*')
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()

This structure is derived from Base

Summary

Mandatory: 0 element(6 nested mandatory elements)

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. IMMZCClientregistration 0..* Base IMMZ.C Client registration
Instances of this logical model are not marked to be the target of a Reference
... uniqueIdentifier 1..1 string Unique identifier
... name C 1..1 string Name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
... firstName C 0..1 string First name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
... sex 1..1 code Sex
Binding: IMMZ.C.DE5 ValueSet for Sex (required)
... dateOfBirth 1..1 string Date of birth
... age C 0..1 string Age
IMMZ-C-age-1: Required if date of birth is entered.
... caregiversMultiple 0..* BackboneElement Caregivers (multiple)
.... caregiversFullName C 0..1 string Caregiver's full name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
.... caregiversFirstName C 0..1 string Caregiver's first name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
.... caregiversFamilyName C 0..1 string Caregiver's family name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
... contactPhoneNumber 1..1 string Contact phone number
... address 1..1 string Address

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
IMMZCClientregistration.sexrequiredIMMZ_C_DE5
http://smart.who.int/immunizations/ValueSet/IMMZ.C.DE5
from this IG

Constraints

IdGradePath(s)DetailsRequirements
IMMZ-C-age-1errorIMMZCClientregistration.ageRequired if date of birth is entered.
: not(%resource.dateOfBirth.exists()) or $this.exists()
IMMZ-C-name-1errorIMMZCClientregistration.name, IMMZCClientregistration.firstName, IMMZCClientregistration.familyName, IMMZCClientregistration.caregiversMultiple.caregiversFullName, IMMZCClientregistration.caregiversMultiple.caregiversFirstName, IMMZCClientregistration.caregiversMultiple.caregiversFamilyNameOnly letters and special characters (period, dash) allowed.
: $this.matches('[A-Za-z-.]*')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. IMMZCClientregistration 0..* Base IMMZ.C Client registration
Instances of this logical model are not marked to be the target of a Reference
... uniqueIdentifier 1..1 string Unique identifier
... name C 1..1 string Name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
... firstName C 0..1 string First name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
... sex 1..1 code Sex
Binding: IMMZ.C.DE5 ValueSet for Sex (required)
... dateOfBirth 1..1 string Date of birth
... age C 0..1 string Age
IMMZ-C-age-1: Required if date of birth is entered.
... caregiversMultiple 0..* BackboneElement Caregivers (multiple)
ele-1: All FHIR elements must have a @value or children
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... caregiversFullName C 0..1 string Caregiver's full name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
.... caregiversFirstName C 0..1 string Caregiver's first name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
.... caregiversFamilyName C 0..1 string Caregiver's family name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
... contactPhoneNumber 1..1 string Contact phone number
... address 1..1 string Address

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
IMMZCClientregistration.sexrequiredIMMZ_C_DE5
http://smart.who.int/immunizations/ValueSet/IMMZ.C.DE5
from this IG

Constraints

IdGradePath(s)DetailsRequirements
IMMZ-C-age-1errorIMMZCClientregistration.ageRequired if date of birth is entered.
: not(%resource.dateOfBirth.exists()) or $this.exists()
IMMZ-C-name-1errorIMMZCClientregistration.name, IMMZCClientregistration.firstName, IMMZCClientregistration.familyName, IMMZCClientregistration.caregiversMultiple.caregiversFullName, IMMZCClientregistration.caregiversMultiple.caregiversFirstName, IMMZCClientregistration.caregiversMultiple.caregiversFamilyNameOnly letters and special characters (period, dash) allowed.
: $this.matches('[A-Za-z-.]*')
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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. IMMZCClientregistration 0..* Base IMMZ.C Client registration
Instances of this logical model are not marked to be the target of a Reference
... uniqueIdentifier 1..1 string Unique identifier
... name C 1..1 string Name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
... firstName C 0..1 string First name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
... sex 1..1 code Sex
Binding: IMMZ.C.DE5 ValueSet for Sex (required)
... dateOfBirth 1..1 string Date of birth
... age C 0..1 string Age
IMMZ-C-age-1: Required if date of birth is entered.
... caregiversMultiple 0..* BackboneElement Caregivers (multiple)
.... @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
.... caregiversFullName C 0..1 string Caregiver's full name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
.... caregiversFirstName C 0..1 string Caregiver's first name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
.... caregiversFamilyName C 0..1 string Caregiver's family name
IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
... contactPhoneNumber 1..1 string Contact phone number
... address 1..1 string Address

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
IMMZCClientregistration.sexrequiredIMMZ_C_DE5
http://smart.who.int/immunizations/ValueSet/IMMZ.C.DE5
from this IG

Constraints

IdGradePath(s)DetailsRequirements
IMMZ-C-age-1errorIMMZCClientregistration.ageRequired if date of birth is entered.
: not(%resource.dateOfBirth.exists()) or $this.exists()
IMMZ-C-name-1errorIMMZCClientregistration.name, IMMZCClientregistration.firstName, IMMZCClientregistration.familyName, IMMZCClientregistration.caregiversMultiple.caregiversFullName, IMMZCClientregistration.caregiversMultiple.caregiversFirstName, IMMZCClientregistration.caregiversMultiple.caregiversFamilyNameOnly letters and special characters (period, dash) allowed.
: $this.matches('[A-Za-z-.]*')
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()

This structure is derived from Base

Summary

Mandatory: 0 element(6 nested mandatory elements)

 

Other representations of profile: CSV, Excel