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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Logical Model: IMMZ.D1 Capture Client History for Hepatitis B

Data elements for the IMMZ.D1 Capture Client History Data Dictionary for Hepatitis B.

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 IMMZ_D1_Client_History

Name	Flags	Card.	Type	Description & Constraints
IMMZD1ClientHistoryHepatitisB		0..*	IMMZ_D1_Client_History	Elements defined in Ancestors:patient, type, completedPrimarySeries, booster, dateSeriesCompleted, hivStatus, pretermBirth, immunocompromised, onART, vaccineHistory IMMZ.D1 Capture Client History for Hepatitis B Instances of this logical model are not marked to be the target of a Reference
vaccineHistory
vaccineType		0..1	Coding	Vaccine type Binding: IMMZ.Z.DE6 Hepatitis B containing vaccines (required)
birth		1..1	boolean	Birth dose
birthweight		1..1	integer	Birth weight in grams
hepbtype		1..1	Coding	Type of hepatitis B dose Binding: IMMZ.D1.DE99 ValueSet for Type of hepatitis B dose (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
IMMZD1ClientHistoryHepatitisB.vaccineHistory.vaccineType	required	IMMZ_Z_DE6 http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.Z.DE6 from this IG
IMMZD1ClientHistoryHepatitisB.hepbtype	required	IMMZ_D1_DE99 http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE99 from this IG

Name	Flags	Card.	Type	Description & Constraints
IMMZD1ClientHistoryHepatitisB		0..*	IMMZ_D1_Client_History	Elements defined in Ancestors:patient, type, completedPrimarySeries, booster, dateSeriesCompleted, hivStatus, pretermBirth, immunocompromised, onART, vaccineHistory IMMZ.D1 Capture Client History for Hepatitis B Instances of this logical model are not marked to be the target of a Reference
patient		1..1	Reference()	Patient
type		1..*	Coding	Type of dose Binding: IMMZ.D1.DE103 ValueSet for Type of dose (required)
dateSeriesCompleted		1..1	date	Date when primary vaccination series was completed
birth		1..1	boolean	Birth dose
birthweight		1..1	integer	Birth weight in grams
hepbtype		1..1	Coding	Type of hepatitis B dose Binding: IMMZ.D1.DE99 ValueSet for Type of hepatitis B dose (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
IMMZD1ClientHistoryHepatitisB.type	required	IMMZ_D1_DE103 http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE103 from this IG
IMMZD1ClientHistoryHepatitisB.hepbtype	required	IMMZ_D1_DE99 http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE99 from this IG

Name	Flags	Card.	Type	Description & Constraints
IMMZD1ClientHistoryHepatitisB		0..*	IMMZ_D1_Client_History	Elements defined in Ancestors:patient, type, completedPrimarySeries, booster, dateSeriesCompleted, hivStatus, pretermBirth, immunocompromised, onART, vaccineHistory IMMZ.D1 Capture Client History for Hepatitis B Instances of this logical model are not marked to be the target of a Reference
patient		1..1	Reference()	Patient
type		1..*	Coding	Type of dose Binding: IMMZ.D1.DE103 ValueSet for Type of dose (required)
completedPrimarySeries		0..1	boolean	Completed the primary vaccination series
booster		0..1	boolean	Completed the booster series
dateSeriesCompleted		1..1	date	Date when primary vaccination series was completed
hivStatus		0..1	Coding	HIV status Binding: IMMZ.D1.DE10 ValueSet for HIV status (required)
pretermBirth		0..1	boolean	Preterm birth
immunocompromised		0..1	boolean	Immunocompromised
onART		0..1	boolean	Currently on ART
vaccineHistory		0..*	BackboneElement	Vaccine History
@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
vaccineType		0..1	Coding	Vaccine type Binding: IMMZ.Z.DE6 Hepatitis B containing vaccines (required)
vaccineDate		0..1	date	Date and time of vaccination
birth		1..1	boolean	Birth dose
birthweight		1..1	integer	Birth weight in grams
hepbtype		1..1	Coding	Type of hepatitis B dose Binding: IMMZ.D1.DE99 ValueSet for Type of hepatitis B dose (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
IMMZD1ClientHistoryHepatitisB.type	required	IMMZ_D1_DE103 http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE103 from this IG
IMMZD1ClientHistoryHepatitisB.hivStatus	required	IMMZ_D1_DE10 http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE10 from this IG
IMMZD1ClientHistoryHepatitisB.vaccineHistory.vaccineType	required	IMMZ_Z_DE6 http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.Z.DE6 from this IG
IMMZD1ClientHistoryHepatitisB.hepbtype	required	IMMZ_D1_DE99 http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE99 from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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 IMMZ_D1_Client_History

Summary

Mandatory: 0 element(3 nested mandatory elements)

Differential View

This structure is derived from IMMZ_D1_Client_History

Name	Flags	Card.	Type	Description & Constraints
IMMZD1ClientHistoryHepatitisB		0..*	IMMZ_D1_Client_History	Elements defined in Ancestors:patient, type, completedPrimarySeries, booster, dateSeriesCompleted, hivStatus, pretermBirth, immunocompromised, onART, vaccineHistory IMMZ.D1 Capture Client History for Hepatitis B Instances of this logical model are not marked to be the target of a Reference
vaccineHistory
vaccineType		0..1	Coding	Vaccine type Binding: IMMZ.Z.DE6 Hepatitis B containing vaccines (required)
birth		1..1	boolean	Birth dose
birthweight		1..1	integer	Birth weight in grams
hepbtype		1..1	Coding	Type of hepatitis B dose Binding: IMMZ.D1.DE99 ValueSet for Type of hepatitis B dose (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
IMMZD1ClientHistoryHepatitisB.vaccineHistory.vaccineType	required	IMMZ_Z_DE6 http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.Z.DE6 from this IG
IMMZD1ClientHistoryHepatitisB.hepbtype	required	IMMZ_D1_DE99 http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE99 from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
IMMZD1ClientHistoryHepatitisB		0..*	IMMZ_D1_Client_History	Elements defined in Ancestors:patient, type, completedPrimarySeries, booster, dateSeriesCompleted, hivStatus, pretermBirth, immunocompromised, onART, vaccineHistory IMMZ.D1 Capture Client History for Hepatitis B Instances of this logical model are not marked to be the target of a Reference
patient		1..1	Reference()	Patient
type		1..*	Coding	Type of dose Binding: IMMZ.D1.DE103 ValueSet for Type of dose (required)
dateSeriesCompleted		1..1	date	Date when primary vaccination series was completed
birth		1..1	boolean	Birth dose
birthweight		1..1	integer	Birth weight in grams
hepbtype		1..1	Coding	Type of hepatitis B dose Binding: IMMZ.D1.DE99 ValueSet for Type of hepatitis B dose (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
IMMZD1ClientHistoryHepatitisB.type	required	IMMZ_D1_DE103 http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE103 from this IG
IMMZD1ClientHistoryHepatitisB.hepbtype	required	IMMZ_D1_DE99 http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE99 from this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
IMMZD1ClientHistoryHepatitisB		0..*	IMMZ_D1_Client_History	Elements defined in Ancestors:patient, type, completedPrimarySeries, booster, dateSeriesCompleted, hivStatus, pretermBirth, immunocompromised, onART, vaccineHistory IMMZ.D1 Capture Client History for Hepatitis B Instances of this logical model are not marked to be the target of a Reference
patient		1..1	Reference()	Patient
type		1..*	Coding	Type of dose Binding: IMMZ.D1.DE103 ValueSet for Type of dose (required)
completedPrimarySeries		0..1	boolean	Completed the primary vaccination series
booster		0..1	boolean	Completed the booster series
dateSeriesCompleted		1..1	date	Date when primary vaccination series was completed
hivStatus		0..1	Coding	HIV status Binding: IMMZ.D1.DE10 ValueSet for HIV status (required)
pretermBirth		0..1	boolean	Preterm birth
immunocompromised		0..1	boolean	Immunocompromised
onART		0..1	boolean	Currently on ART
vaccineHistory		0..*	BackboneElement	Vaccine History
@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
vaccineType		0..1	Coding	Vaccine type Binding: IMMZ.Z.DE6 Hepatitis B containing vaccines (required)
vaccineDate		0..1	date	Date and time of vaccination
birth		1..1	boolean	Birth dose
birthweight		1..1	integer	Birth weight in grams
hepbtype		1..1	Coding	Type of hepatitis B dose Binding: IMMZ.D1.DE99 ValueSet for Type of hepatitis B dose (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
IMMZD1ClientHistoryHepatitisB.type	required	IMMZ_D1_DE103 http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE103 from this IG
IMMZD1ClientHistoryHepatitisB.hivStatus	required	IMMZ_D1_DE10 http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE10 from this IG
IMMZD1ClientHistoryHepatitisB.vaccineHistory.vaccineType	required	IMMZ_Z_DE6 http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.Z.DE6 from this IG
IMMZD1ClientHistoryHepatitisB.hepbtype	required	IMMZ_D1_DE99 http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE99 from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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 IMMZ_D1_Client_History

Summary

Mandatory: 0 element(3 nested mandatory elements)

Other representations of profile: CSV, Excel