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/tree/costateixeira-update-readme and changes regularly. See the Directory of published versions
Logical Model: IMMZ.C4.Create client record
| Official URL: http://smart.who.int/immunizations/StructureDefinition/IMMZC4 | Version: 0.2.0 | |||
| Active as of 2024-12-18 | Computable Name: IMMZ_C4_Create_client_record | |||
Data elements for the IMMZ.C4.Create client record Data Dictionary Activity. Identical to IMMZ.C5.3.Update client details.
Usages:
- This Logical Model 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.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  IMMZC4 |
0..* | Base | IMMZ.C4.Create client record | |
  uniqueIdentifier |
1..1 | string | Unique identifier | |
| name |
C | 1..1 | string | Name Constraints: IMMZ-C-name-1 |
| firstName |
C | 0..1 | string | First name Constraints: IMMZ-C-name-1 |
| familyName |
C | 0..1 | string | Family name Constraints: IMMZ-C-name-1 |
| 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 Constraints: IMMZ-C-age-1 |
  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 Constraints: IMMZ-C-name-1 |
| caregiversFirstName |
C | 0..1 | string | Caregiver's first name Constraints: IMMZ-C-name-1 |
 caregiversFamilyName |
C | 0..1 | string | Caregiver's family name Constraints: IMMZ-C-name-1 |
| contactPhoneNumber |
1..1 | string | Contact phone number | |
| address |
1..1 | string | Address | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| IMMZC4.sex | required | IMMZ_C_DE5http://smart.who.int/immunizations/ValueSet/IMMZ.C.DE5From this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| IMMZ-C-age-1 | error | IMMZC4.age | Required if date of birth is entered. : not(%resource.dateOfBirth.exists()) or $this.exists() | |
| IMMZ-C-name-1 | error | IMMZC4.name, IMMZC4.firstName, IMMZC4.familyName, IMMZC4.caregiversMultiple.caregiversFullName, IMMZC4.caregiversMultiple.caregiversFirstName, IMMZC4.caregiversMultiple.caregiversFamilyName | Only letters and special characters (period, dash) allowed. : $this.matches('[A-Za-z-.]*') | |
| 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: |
|---|---|---|---|---|
| IMMZC4 |
0..* | Base | IMMZ.C4.Create client record | |
| uniqueIdentifier |
1..1 | string | Unique identifier | |
| name |
C | 1..1 | string | Name Constraints: IMMZ-C-name-1 |
| firstName |
C | 0..1 | string | First name Constraints: IMMZ-C-name-1 |
| familyName |
C | 0..1 | string | Family name Constraints: IMMZ-C-name-1 |
| 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 Constraints: IMMZ-C-age-1 |
| caregiversMultiple |
0..* | BackboneElement | Caregivers (multiple) | |
| caregiversFullName |
C | 0..1 | string | Caregiver's full name Constraints: IMMZ-C-name-1 |
| caregiversFirstName |
C | 0..1 | string | Caregiver's first name Constraints: IMMZ-C-name-1 |
| caregiversFamilyName |
C | 0..1 | string | Caregiver's family name Constraints: IMMZ-C-name-1 |
| contactPhoneNumber |
1..1 | string | Contact phone number | |
| address |
1..1 | string | Address | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| IMMZC4.sex | required | IMMZ_C_DE5http://smart.who.int/immunizations/ValueSet/IMMZ.C.DE5From this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| IMMZ-C-age-1 | error | IMMZC4.age | Required if date of birth is entered. : not(%resource.dateOfBirth.exists()) or $this.exists() | |
| IMMZ-C-name-1 | error | IMMZC4.name, IMMZC4.firstName, IMMZC4.familyName, IMMZC4.caregiversMultiple.caregiversFullName, IMMZC4.caregiversMultiple.caregiversFirstName, IMMZC4.caregiversMultiple.caregiversFamilyName | Only letters and special characters (period, dash) allowed. : $this.matches('[A-Za-z-.]*') |
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| IMMZC4 |
0..* | Base | IMMZ.C4.Create client record | |
| uniqueIdentifier |
1..1 | string | Unique identifier | |
| name |
C | 1..1 | string | Name Constraints: IMMZ-C-name-1 |
| firstName |
C | 0..1 | string | First name Constraints: IMMZ-C-name-1 |
| familyName |
C | 0..1 | string | Family name Constraints: IMMZ-C-name-1 |
| 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 Constraints: IMMZ-C-age-1 |
| 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 Constraints: IMMZ-C-name-1 |
| caregiversFirstName |
C | 0..1 | string | Caregiver's first name Constraints: IMMZ-C-name-1 |
| caregiversFamilyName |
C | 0..1 | string | Caregiver's family name Constraints: IMMZ-C-name-1 |
| contactPhoneNumber |
1..1 | string | Contact phone number | |
| address |
1..1 | string | Address | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| IMMZC4.sex | required | IMMZ_C_DE5http://smart.who.int/immunizations/ValueSet/IMMZ.C.DE5From this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| IMMZ-C-age-1 | error | IMMZC4.age | Required if date of birth is entered. : not(%resource.dateOfBirth.exists()) or $this.exists() | |
| IMMZ-C-name-1 | error | IMMZC4.name, IMMZC4.firstName, IMMZC4.familyName, IMMZC4.caregiversMultiple.caregiversFullName, IMMZC4.caregiversMultiple.caregiversFirstName, IMMZC4.caregiversMultiple.caregiversFamilyName | Only letters and special characters (period, dash) allowed. : $this.matches('[A-Za-z-.]*') | |
| 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: |
|---|---|---|---|---|
| IMMZC4 |
0..* | Base | IMMZ.C4.Create client record | |
| uniqueIdentifier |
1..1 | string | Unique identifier | |
| name |
C | 1..1 | string | Name Constraints: IMMZ-C-name-1 |
| firstName |
C | 0..1 | string | First name Constraints: IMMZ-C-name-1 |
| familyName |
C | 0..1 | string | Family name Constraints: IMMZ-C-name-1 |
| 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 Constraints: IMMZ-C-age-1 |
| 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 Constraints: IMMZ-C-name-1 |
| caregiversFirstName |
C | 0..1 | string | Caregiver's first name Constraints: IMMZ-C-name-1 |
| caregiversFamilyName |
C | 0..1 | string | Caregiver's family name Constraints: IMMZ-C-name-1 |
| contactPhoneNumber |
1..1 | string | Contact phone number | |
| address |
1..1 | string | Address | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| IMMZC4.sex | required | IMMZ_C_DE5http://smart.who.int/immunizations/ValueSet/IMMZ.C.DE5From this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| IMMZ-C-age-1 | error | IMMZC4.age | Required if date of birth is entered. : not(%resource.dateOfBirth.exists()) or $this.exists() | |
| IMMZ-C-name-1 | error | IMMZC4.name, IMMZC4.firstName, IMMZC4.familyName, IMMZC4.caregiversMultiple.caregiversFullName, IMMZC4.caregiversMultiple.caregiversFirstName, IMMZC4.caregiversMultiple.caregiversFamilyName | Only letters and special characters (period, dash) allowed. : $this.matches('[A-Za-z-.]*') | |
| 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: |
|---|---|---|---|---|
| IMMZC4 |
0..* | Base | IMMZ.C4.Create client record | |
| uniqueIdentifier |
1..1 | string | Unique identifier | |
| name |
C | 1..1 | string | Name Constraints: IMMZ-C-name-1 |
| firstName |
C | 0..1 | string | First name Constraints: IMMZ-C-name-1 |
| familyName |
C | 0..1 | string | Family name Constraints: IMMZ-C-name-1 |
| 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 Constraints: IMMZ-C-age-1 |
| caregiversMultiple |
0..* | BackboneElement | Caregivers (multiple) | |
| caregiversFullName |
C | 0..1 | string | Caregiver's full name Constraints: IMMZ-C-name-1 |
| caregiversFirstName |
C | 0..1 | string | Caregiver's first name Constraints: IMMZ-C-name-1 |
| caregiversFamilyName |
C | 0..1 | string | Caregiver's family name Constraints: IMMZ-C-name-1 |
| contactPhoneNumber |
1..1 | string | Contact phone number | |
| address |
1..1 | string | Address | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| IMMZC4.sex | required | IMMZ_C_DE5http://smart.who.int/immunizations/ValueSet/IMMZ.C.DE5From this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| IMMZ-C-age-1 | error | IMMZC4.age | Required if date of birth is entered. : not(%resource.dateOfBirth.exists()) or $this.exists() | |
| IMMZ-C-name-1 | error | IMMZC4.name, IMMZC4.firstName, IMMZC4.familyName, IMMZC4.caregiversMultiple.caregiversFullName, IMMZC4.caregiversMultiple.caregiversFirstName, IMMZC4.caregiversMultiple.caregiversFamilyName | Only letters and special characters (period, dash) allowed. : $this.matches('[A-Za-z-.]*') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| IMMZC4 |
0..* | Base | IMMZ.C4.Create client record | |
| uniqueIdentifier |
1..1 | string | Unique identifier | |
| name |
C | 1..1 | string | Name Constraints: IMMZ-C-name-1 |
| firstName |
C | 0..1 | string | First name Constraints: IMMZ-C-name-1 |
| familyName |
C | 0..1 | string | Family name Constraints: IMMZ-C-name-1 |
| 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 Constraints: IMMZ-C-age-1 |
| 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 Constraints: IMMZ-C-name-1 |
| caregiversFirstName |
C | 0..1 | string | Caregiver's first name Constraints: IMMZ-C-name-1 |
| caregiversFamilyName |
C | 0..1 | string | Caregiver's family name Constraints: IMMZ-C-name-1 |
| contactPhoneNumber |
1..1 | string | Contact phone number | |
| address |
1..1 | string | Address | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| IMMZC4.sex | required | IMMZ_C_DE5http://smart.who.int/immunizations/ValueSet/IMMZ.C.DE5From this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| IMMZ-C-age-1 | error | IMMZC4.age | Required if date of birth is entered. : not(%resource.dateOfBirth.exists()) or $this.exists() | |
| IMMZ-C-name-1 | error | IMMZC4.name, IMMZC4.firstName, IMMZC4.familyName, IMMZC4.caregiversMultiple.caregiversFullName, IMMZC4.caregiversMultiple.caregiversFirstName, IMMZC4.caregiversMultiple.caregiversFamilyName | Only letters and special characters (period, dash) allowed. : $this.matches('[A-Za-z-.]*') | |
| 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