IMMZ.C Register Client - WHO Immunization Implementation Guide v0.1.0

WHO Immunization Implementation Guide
0.1.0 - CI Build International flag

WHO Immunization Implementation Guide, published by World Health Organization (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-immunizations and changes regularly. See the Directory of published versions

Logical Model: IMMZ.C Register Client

Official URL: http://smart.who.int/ig/smart-immunizations/StructureDefinition/IMMZCRegisterClient				Version: 0.1.0
Active as of 2024-03-15				Computable Name: IMMZ_C_Register_Client

Data elements for the IMMZ.C Register Client 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.

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

This structure is derived from Base

Name	Flags	Card.	Type	Description & Constraints
IMMZCRegisterClient		0..*	Base	IMMZ.C Register Client Instances of this logical model are not marked to be the target of a Reference
uniqueId	Σ	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.
familyName	C	0..1	string	Last 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)
birthDate		0..1	date	Date of birth
caregiver		0..*	BackboneElement	Caregiver
name	C	1..1	string	Caregiver's full name IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
firstName	C	0..1	string	Caregiver's first name IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
familyName	C	0..1	string	Caregiver's family name IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
phone		1..1	string	Contact phone number
administrativeArea		0..1	CodeableConcept	Administrative area
healthWorker		1..1	boolean	Active health worker
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
IMMZCRegisterClient.sex	required	IMMZ_C_DE5 `http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.C.DE5` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
IMMZ-C-name-1	error	IMMZCRegisterClient.name, IMMZCRegisterClient.firstName, IMMZCRegisterClient.familyName, IMMZCRegisterClient.caregiver.name, IMMZCRegisterClient.caregiver.firstName, IMMZCRegisterClient.caregiver.familyName	Only letters and special characters (period, dash) allowed. : $this.matches('[A-Za-z-.]*')

Name	Flags	Card.	Type	Description & Constraints
IMMZCRegisterClient		0..*	Base	IMMZ.C Register Client Instances of this logical model are not marked to be the target of a Reference
uniqueId	Σ	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.
familyName	C	0..1	string	Last 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)
birthDate		0..1	date	Date of birth
caregiver		0..*	BackboneElement	Caregiver
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	C	1..1	string	Caregiver's full name IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
firstName	C	0..1	string	Caregiver's first name IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
familyName	C	0..1	string	Caregiver's family name IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
phone		1..1	string	Contact phone number
administrativeArea		0..1	CodeableConcept	Administrative area
healthWorker		1..1	boolean	Active health worker
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
IMMZCRegisterClient.sex	required	IMMZ_C_DE5 `http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.C.DE5` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
IMMZ-C-name-1	error	IMMZCRegisterClient.name, IMMZCRegisterClient.firstName, IMMZCRegisterClient.familyName, IMMZCRegisterClient.caregiver.name, IMMZCRegisterClient.caregiver.firstName, IMMZCRegisterClient.caregiver.familyName	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()

Name	Flags	Card.	Type	Description & Constraints
IMMZCRegisterClient		0..*	Base	IMMZ.C Register Client Instances of this logical model are not marked to be the target of a Reference
uniqueId	Σ	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.
familyName	C	0..1	string	Last 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)
birthDate		0..1	date	Date of birth
caregiver		0..*	BackboneElement	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
name	C	1..1	string	Caregiver's full name IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
firstName	C	0..1	string	Caregiver's first name IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
familyName	C	0..1	string	Caregiver's family name IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
phone		1..1	string	Contact phone number
administrativeArea		0..1	CodeableConcept	Administrative area
healthWorker		1..1	boolean	Active health worker
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
IMMZCRegisterClient.sex	required	IMMZ_C_DE5 `http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.C.DE5` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
IMMZ-C-name-1	error	IMMZCRegisterClient.name, IMMZCRegisterClient.firstName, IMMZCRegisterClient.familyName, IMMZCRegisterClient.caregiver.name, IMMZCRegisterClient.caregiver.firstName, IMMZCRegisterClient.caregiver.familyName	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

Summary

Mandatory: 0 element (6 nested mandatory elements)

Differential View

This structure is derived from Base

Name	Flags	Card.	Type	Description & Constraints
IMMZCRegisterClient		0..*	Base	IMMZ.C Register Client Instances of this logical model are not marked to be the target of a Reference
uniqueId	Σ	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.
familyName	C	0..1	string	Last 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)
birthDate		0..1	date	Date of birth
caregiver		0..*	BackboneElement	Caregiver
name	C	1..1	string	Caregiver's full name IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
firstName	C	0..1	string	Caregiver's first name IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
familyName	C	0..1	string	Caregiver's family name IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
phone		1..1	string	Contact phone number
administrativeArea		0..1	CodeableConcept	Administrative area
healthWorker		1..1	boolean	Active health worker
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
IMMZCRegisterClient.sex	required	IMMZ_C_DE5 `http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.C.DE5` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
IMMZ-C-name-1	error	IMMZCRegisterClient.name, IMMZCRegisterClient.firstName, IMMZCRegisterClient.familyName, IMMZCRegisterClient.caregiver.name, IMMZCRegisterClient.caregiver.firstName, IMMZCRegisterClient.caregiver.familyName	Only letters and special characters (period, dash) allowed. : $this.matches('[A-Za-z-.]*')

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
IMMZCRegisterClient		0..*	Base	IMMZ.C Register Client Instances of this logical model are not marked to be the target of a Reference
uniqueId	Σ	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.
familyName	C	0..1	string	Last 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)
birthDate		0..1	date	Date of birth
caregiver		0..*	BackboneElement	Caregiver
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	C	1..1	string	Caregiver's full name IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
firstName	C	0..1	string	Caregiver's first name IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
familyName	C	0..1	string	Caregiver's family name IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
phone		1..1	string	Contact phone number
administrativeArea		0..1	CodeableConcept	Administrative area
healthWorker		1..1	boolean	Active health worker
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
IMMZCRegisterClient.sex	required	IMMZ_C_DE5 `http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.C.DE5` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
IMMZ-C-name-1	error	IMMZCRegisterClient.name, IMMZCRegisterClient.firstName, IMMZCRegisterClient.familyName, IMMZCRegisterClient.caregiver.name, IMMZCRegisterClient.caregiver.firstName, IMMZCRegisterClient.caregiver.familyName	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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
IMMZCRegisterClient		0..*	Base	IMMZ.C Register Client Instances of this logical model are not marked to be the target of a Reference
uniqueId	Σ	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.
familyName	C	0..1	string	Last 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)
birthDate		0..1	date	Date of birth
caregiver		0..*	BackboneElement	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
name	C	1..1	string	Caregiver's full name IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
firstName	C	0..1	string	Caregiver's first name IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
familyName	C	0..1	string	Caregiver's family name IMMZ-C-name-1: Only letters and special characters (period, dash) allowed.
phone		1..1	string	Contact phone number
administrativeArea		0..1	CodeableConcept	Administrative area
healthWorker		1..1	boolean	Active health worker
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
IMMZCRegisterClient.sex	required	IMMZ_C_DE5 `http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.C.DE5` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
IMMZ-C-name-1	error	IMMZCRegisterClient.name, IMMZCRegisterClient.firstName, IMMZCRegisterClient.familyName, IMMZCRegisterClient.caregiver.name, IMMZCRegisterClient.caregiver.firstName, IMMZCRegisterClient.caregiver.familyName	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

Summary

Mandatory: 0 element (6 nested mandatory elements)

Other representations of profile: CSV, Excel

IG © 2021+ World Health Organization (WHO). Package who.fhir.immunization#0.1.0 based on FHIR 4.0.1. Generated 2024-03-15
Links: Table of Contents | QA Report | Version History | License