WHO SMART Guidelines - Measles Immunization
0.1.0 - ci-build
WHO SMART Guidelines - Measles Immunization, published by WHO. 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/WorldHealthOrganization/smart-example-immz and changes regularly. See the Directory of published versions
Active as of 2024-08-12 |
Definitions for the IMMZCRegisterClient logical model.
Guidance on how to interpret the contents of this table can be found here
0. IMMZCRegisterClient | |
Definition | Data elements for the IMMZ.C Register Client Data Dictionary. |
Short | IMMZ.C Register Client |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. IMMZCRegisterClient.uniqueId | |
Definition | Unique identifier for the client, according to the policies applicable to each country. There can be more than one unique identifier used to link records (e.g. national ID, health ID, immunization information system ID, medical record ID). |
Short | Unique identifier |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE1 |
4. IMMZCRegisterClient.name | |
Definition | The full name of the client |
Short | Name |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE2 |
Invariants | IMMZ-C-name-1: Only letters and special characters (period, dash) allowed. ($this.matches('[A-Za-z-.]*') ) |
6. IMMZCRegisterClient.sex | |
Definition | Documentation of a specific instance of sex information for the client |
Short | Sex |
Control | 1..1 |
Binding | The codes SHALL be taken from IMMZ.C.DE5 ValueSet for Sex (required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.C.DE5 ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE5 |
8. IMMZCRegisterClient.birthDate | |
Definition | Client's date of birth (DOB) if known; if unknown, use assigned DOB for administrative purposes |
Short | Date of birth |
Control | 0..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE10 |
10. IMMZCRegisterClient.caregiver | |
Definition | The client's caregiver (person) which could be next of kin (e.g. partner, husband, mother, sibling, etc.) |
Short | Caregiver |
Control | 0..* |
Type | BackboneElement |
Definitional Codes | Immunizations Concepts CodeSystem C.DE14 |
12. IMMZCRegisterClient.caregiver.name | |
Definition | The full name of the client's caregiver |
Short | Caregiver's full name |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE15 |
Invariants | IMMZ-C-name-1: Only letters and special characters (period, dash) allowed. ($this.matches('[A-Za-z-.]*') ) |
14. IMMZCRegisterClient.caregiver.firstName | |
Definition | First or given name of the client's caregiver |
Short | Caregiver's first name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE16 |
Invariants | IMMZ-C-name-1: Only letters and special characters (period, dash) allowed. ($this.matches('[A-Za-z-.]*') ) |
16. IMMZCRegisterClient.caregiver.familyName | |
Definition | Family name or last name of the client's caregiver |
Short | Caregiver's family name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE17 |
Invariants | IMMZ-C-name-1: Only letters and special characters (period, dash) allowed. ($this.matches('[A-Za-z-.]*') ) |
18. IMMZCRegisterClient.phone | |
Definition | Client's phone number |
Short | Contact phone number |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE18 |
20. IMMZCRegisterClient.administrativeArea | |
Definition | The name of the city/municipality/town/village of where the client lives |
Short | Administrative area |
Control | 0..1 |
Type | CodeableConcept |
Definitional Codes | Immunizations Concepts CodeSystem C.DE19 |
22. IMMZCRegisterClient.healthWorker | |
Definition | Is the client an active and participating health worker. This data element is used mainly for reporting and indicators purposes. |
Short | Active health worker |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE20 |
Guidance on how to interpret the contents of this table can be found here
0. IMMZCRegisterClient | |
Definition | Data elements for the IMMZ.C Register Client Data Dictionary. |
Short | IMMZ.C Register Client |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. IMMZCRegisterClient.uniqueId | |
Definition | Unique identifier for the client, according to the policies applicable to each country. There can be more than one unique identifier used to link records (e.g. national ID, health ID, immunization information system ID, medical record ID). |
Short | Unique identifier |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Definitional Codes | Immunizations Concepts CodeSystem C.DE1 |
4. IMMZCRegisterClient.name | |
Definition | The full name of the client |
Short | Name |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE2 |
Invariants | IMMZ-C-name-1: Only letters and special characters (period, dash) allowed. ($this.matches('[A-Za-z-.]*') ) |
6. IMMZCRegisterClient.sex | |
Definition | Documentation of a specific instance of sex information for the client |
Short | Sex |
Control | 1..1 |
Binding | The codes SHALL be taken from IMMZ.C.DE5 ValueSet for Sex (required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.C.DE5 ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE5 |
8. IMMZCRegisterClient.birthDate | |
Definition | Client's date of birth (DOB) if known; if unknown, use assigned DOB for administrative purposes |
Short | Date of birth |
Control | 0..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE10 |
10. IMMZCRegisterClient.caregiver | |
Definition | The client's caregiver (person) which could be next of kin (e.g. partner, husband, mother, sibling, etc.) |
Short | Caregiver |
Control | 0..* |
Type | BackboneElement |
Definitional Codes | Immunizations Concepts CodeSystem C.DE14 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
12. IMMZCRegisterClient.caregiver.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
14. IMMZCRegisterClient.caregiver.name | |
Definition | The full name of the client's caregiver |
Short | Caregiver's full name |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE15 |
Invariants | IMMZ-C-name-1: Only letters and special characters (period, dash) allowed. ($this.matches('[A-Za-z-.]*') ) |
16. IMMZCRegisterClient.caregiver.firstName | |
Definition | First or given name of the client's caregiver |
Short | Caregiver's first name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE16 |
Invariants | IMMZ-C-name-1: Only letters and special characters (period, dash) allowed. ($this.matches('[A-Za-z-.]*') ) |
18. IMMZCRegisterClient.caregiver.familyName | |
Definition | Family name or last name of the client's caregiver |
Short | Caregiver's family name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE17 |
Invariants | IMMZ-C-name-1: Only letters and special characters (period, dash) allowed. ($this.matches('[A-Za-z-.]*') ) |
20. IMMZCRegisterClient.phone | |
Definition | Client's phone number |
Short | Contact phone number |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE18 |
22. IMMZCRegisterClient.administrativeArea | |
Definition | The name of the city/municipality/town/village of where the client lives |
Short | Administrative area |
Control | 0..1 |
Type | CodeableConcept |
Definitional Codes | Immunizations Concepts CodeSystem C.DE19 |
24. IMMZCRegisterClient.healthWorker | |
Definition | Is the client an active and participating health worker. This data element is used mainly for reporting and indicators purposes. |
Short | Active health worker |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE20 |
Guidance on how to interpret the contents of this table can be found here
0. IMMZCRegisterClient | |
Definition | Data elements for the IMMZ.C Register Client Data Dictionary. |
Short | IMMZ.C Register Client |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. IMMZCRegisterClient.uniqueId | |
Definition | Unique identifier for the client, according to the policies applicable to each country. There can be more than one unique identifier used to link records (e.g. national ID, health ID, immunization information system ID, medical record ID). |
Short | Unique identifier |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Definitional Codes | Immunizations Concepts CodeSystem C.DE1 |
4. IMMZCRegisterClient.name | |
Definition | The full name of the client |
Short | Name |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE2 |
Invariants | IMMZ-C-name-1: Only letters and special characters (period, dash) allowed. ($this.matches('[A-Za-z-.]*') ) |
6. IMMZCRegisterClient.sex | |
Definition | Documentation of a specific instance of sex information for the client |
Short | Sex |
Control | 1..1 |
Binding | The codes SHALL be taken from IMMZ.C.DE5 ValueSet for Sex (required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.C.DE5 ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE5 |
8. IMMZCRegisterClient.birthDate | |
Definition | Client's date of birth (DOB) if known; if unknown, use assigned DOB for administrative purposes |
Short | Date of birth |
Control | 0..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE10 |
10. IMMZCRegisterClient.caregiver | |
Definition | The client's caregiver (person) which could be next of kin (e.g. partner, husband, mother, sibling, etc.) |
Short | Caregiver |
Control | 0..* |
Type | BackboneElement |
Definitional Codes | Immunizations Concepts CodeSystem C.DE14 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
12. IMMZCRegisterClient.caregiver.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
14. IMMZCRegisterClient.caregiver.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on IMMZCRegisterClient.caregiver.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
16. IMMZCRegisterClient.caregiver.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
18. IMMZCRegisterClient.caregiver.name | |
Definition | The full name of the client's caregiver |
Short | Caregiver's full name |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE15 |
Invariants | IMMZ-C-name-1: Only letters and special characters (period, dash) allowed. ($this.matches('[A-Za-z-.]*') ) |
20. IMMZCRegisterClient.caregiver.firstName | |
Definition | First or given name of the client's caregiver |
Short | Caregiver's first name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE16 |
Invariants | IMMZ-C-name-1: Only letters and special characters (period, dash) allowed. ($this.matches('[A-Za-z-.]*') ) |
22. IMMZCRegisterClient.caregiver.familyName | |
Definition | Family name or last name of the client's caregiver |
Short | Caregiver's family name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE17 |
Invariants | IMMZ-C-name-1: Only letters and special characters (period, dash) allowed. ($this.matches('[A-Za-z-.]*') ) |
24. IMMZCRegisterClient.phone | |
Definition | Client's phone number |
Short | Contact phone number |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE18 |
26. IMMZCRegisterClient.administrativeArea | |
Definition | The name of the city/municipality/town/village of where the client lives |
Short | Administrative area |
Control | 0..1 |
Type | CodeableConcept |
Definitional Codes | Immunizations Concepts CodeSystem C.DE19 |
28. IMMZCRegisterClient.healthWorker | |
Definition | Is the client an active and participating health worker. This data element is used mainly for reporting and indicators purposes. |
Short | Active health worker |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem C.DE20 |