GDHCN Trust Network - Personal Health Wallet, 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-trust-phw/ and changes regularly. See the Directory of published versions

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

Logical Model: PreQual ( Experimental )

Data elements for the Digital Vaccine Certificate using WHO Vaccine PreQualification database

Usages:

• This Logical Model is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DVCPreQual	C	0..*	DVC	PreQual Elements defined in Ancestors:name, dob, sex, nationality, nid, guardian, disease, integrityCheck, vaccineDetails, version Instances of this type can be the target of a Reference Constraints: nid-must-have-value
DVCPreQual.name		1..1	string	Name of the recipient of vaccine or prophylaxis
DVCPreQual.dob		1..1	date	Date of Birth
DVCPreQual.sex		1..1	code	Sex Binding: http://hl7.org/fhir/administrative-gender (extensible)
DVCPreQual.nationality		1..*	Coding	Nationality Binding: Iso316613 (extensible)
DVCPreQual.nid	C	0..*	Identifier	National Identification Document, if applicable Constraints: ident-1
DVCPreQual.nid.@id		0..1	id	Unique id for inter-element referencing
DVCPreQual.nid.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
DVCPreQual.nid.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
DVCPreQual.nid.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
DVCPreQual.nid.system	Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Binding: hl7VS-identifierType (extensible) Example General: http://www.acme.com/identifiers/patient
DVCPreQual.nid.value	Σ This element is included in summaries. C	0..1	string	The value that is unique Example General: 123456
DVCPreQual.nid.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
DVCPreQual.nid.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
DVCPreQual.guardian		0..1	string	Name of the parent or guardian. Required, if applicable
DVCPreQual.disease		1..*	Coding	Name of disease or condition Binding: http://id.who.int/icd/release/11/mms (extensible)
DVCPreQual.integrityCheck		0..*	BackboneElement	Integrity check value
DVCPreQual.integrityCheck.@id		0..1	id	Unique id for inter-element referencing
DVCPreQual.integrityCheck.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
DVCPreQual.integrityCheck.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
DVCPreQual.integrityCheck.cryptographicSignature		1..1	string	Cryptographic signature of the issuer
DVCPreQual.integrityCheck.kid		1..1	string	Key identifier for signature verification
DVCPreQual.vaccineDetails		1..*	DVCVaccineDetailsPreQual	Vaccine Details
DVCPreQual.version		1..1	string	Version Fixed Value: 0.1.0 (no extensions allowed)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
DVCPreQual.sex	Base	extensible	http://hl7.org/fhir/administrative-gender	Not State	Unknown
DVCPreQual.nationality	Base	extensible	Iso 3166 Part 1: 3 Letter Codes	📦5.0.0	FHIR Std.
DVCPreQual.nid.use	Base	required	IdentifierUse	📍5.0.0	FHIR Std.
DVCPreQual.nid.type	Base	extensible	Identifier Type Codes	📍5.0.0	FHIR Std.
DVCPreQual.nid.system	Base	extensible	hl7VS-identifierType	📦3.0.0	THO v7.3
DVCPreQual.disease	Base	extensible	http://id.who.int/icd/release/11/mms	Not State	Unknown

Constraints

Id	Grade	Path(s)	Description	Expression
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()
ident-1	warning	DVCPreQual.nid	Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason	value.exists()
nid-must-have-value	error	DVCPreQual	If National ID is present, it must have a value and a system	nid.empty() or (nid.value.exists() and nid.system.exists())

This structure is derived from DVC

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DVCPreQual		0..*	DVC	PreQual Elements defined in Ancestors:name, dob, sex, nationality, nid, guardian, disease, integrityCheck, vaccineDetails, version Instances of this type can be the target of a Reference
DVCPreQual.vaccineDetails		1..*	DVCVaccineDetailsPreQual	Vaccine Details
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DVCPreQual	C	0..*	DVC	PreQual Elements defined in Ancestors:name, dob, sex, nationality, nid, guardian, disease, integrityCheck, vaccineDetails, version Instances of this type can be the target of a Reference Constraints: nid-must-have-value
DVCPreQual.name		1..1	string	Name of the recipient of vaccine or prophylaxis
DVCPreQual.dob		1..1	date	Date of Birth
DVCPreQual.sex		1..1	code	Sex Binding: http://hl7.org/fhir/administrative-gender (extensible)
DVCPreQual.nationality		1..*	Coding	Nationality Binding: Iso316613 (extensible)
DVCPreQual.nid	C	0..*	Identifier	National Identification Document, if applicable Constraints: ident-1
DVCPreQual.nid.@id		0..1	id	Unique id for inter-element referencing
DVCPreQual.nid.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
DVCPreQual.nid.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
DVCPreQual.nid.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
DVCPreQual.nid.system	Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Binding: hl7VS-identifierType (extensible) Example General: http://www.acme.com/identifiers/patient
DVCPreQual.nid.value	Σ This element is included in summaries. C	0..1	string	The value that is unique Example General: 123456
DVCPreQual.nid.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
DVCPreQual.nid.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
DVCPreQual.guardian		0..1	string	Name of the parent or guardian. Required, if applicable
DVCPreQual.disease		1..*	Coding	Name of disease or condition Binding: http://id.who.int/icd/release/11/mms (extensible)
DVCPreQual.integrityCheck		0..*	BackboneElement	Integrity check value
DVCPreQual.integrityCheck.@id		0..1	id	Unique id for inter-element referencing
DVCPreQual.integrityCheck.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
DVCPreQual.integrityCheck.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
DVCPreQual.integrityCheck.cryptographicSignature		1..1	string	Cryptographic signature of the issuer
DVCPreQual.integrityCheck.kid		1..1	string	Key identifier for signature verification
DVCPreQual.vaccineDetails		1..*	DVCVaccineDetailsPreQual	Vaccine Details
DVCPreQual.version		1..1	string	Version Fixed Value: 0.1.0 (no extensions allowed)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
DVCPreQual.sex	Base	extensible	http://hl7.org/fhir/administrative-gender	Not State	Unknown
DVCPreQual.nationality	Base	extensible	Iso 3166 Part 1: 3 Letter Codes	📦5.0.0	FHIR Std.
DVCPreQual.nid.use	Base	required	IdentifierUse	📍5.0.0	FHIR Std.
DVCPreQual.nid.type	Base	extensible	Identifier Type Codes	📍5.0.0	FHIR Std.
DVCPreQual.nid.system	Base	extensible	hl7VS-identifierType	📦3.0.0	THO v7.3
DVCPreQual.disease	Base	extensible	http://id.who.int/icd/release/11/mms	Not State	Unknown

Constraints

Id	Grade	Path(s)	Description	Expression
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()
ident-1	warning	DVCPreQual.nid	Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason	value.exists()
nid-must-have-value	error	DVCPreQual	If National ID is present, it must have a value and a system	nid.empty() or (nid.value.exists() and nid.system.exists())

This structure is derived from DVC

Summary

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DVCPreQual	C	0..*	DVC	PreQual Elements defined in Ancestors:name, dob, sex, nationality, nid, guardian, disease, integrityCheck, vaccineDetails, version Instances of this type can be the target of a Reference Constraints: nid-must-have-value
DVCPreQual.name		1..1	string	Name of the recipient of vaccine or prophylaxis
DVCPreQual.dob		1..1	date	Date of Birth
DVCPreQual.sex		1..1	code	Sex Binding: http://hl7.org/fhir/administrative-gender (extensible)
DVCPreQual.nationality		1..*	Coding	Nationality Binding: Iso316613 (extensible)
DVCPreQual.nid	C	0..*	Identifier	National Identification Document, if applicable Constraints: ident-1
DVCPreQual.nid.@id		0..1	id	Unique id for inter-element referencing
DVCPreQual.nid.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
DVCPreQual.nid.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
DVCPreQual.nid.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
DVCPreQual.nid.system	Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Binding: hl7VS-identifierType (extensible) Example General: http://www.acme.com/identifiers/patient
DVCPreQual.nid.value	Σ This element is included in summaries. C	0..1	string	The value that is unique Example General: 123456
DVCPreQual.nid.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
DVCPreQual.nid.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
DVCPreQual.guardian		0..1	string	Name of the parent or guardian. Required, if applicable
DVCPreQual.disease		1..*	Coding	Name of disease or condition Binding: http://id.who.int/icd/release/11/mms (extensible)
DVCPreQual.integrityCheck		0..*	BackboneElement	Integrity check value
DVCPreQual.integrityCheck.@id		0..1	id	Unique id for inter-element referencing
DVCPreQual.integrityCheck.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
DVCPreQual.integrityCheck.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
DVCPreQual.integrityCheck.cryptographicSignature		1..1	string	Cryptographic signature of the issuer
DVCPreQual.integrityCheck.kid		1..1	string	Key identifier for signature verification
DVCPreQual.vaccineDetails		1..*	DVCVaccineDetailsPreQual	Vaccine Details
DVCPreQual.version		1..1	string	Version Fixed Value: 0.1.0 (no extensions allowed)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
DVCPreQual.sex	Base	extensible	http://hl7.org/fhir/administrative-gender	Not State	Unknown
DVCPreQual.nationality	Base	extensible	Iso 3166 Part 1: 3 Letter Codes	📦5.0.0	FHIR Std.
DVCPreQual.nid.use	Base	required	IdentifierUse	📍5.0.0	FHIR Std.
DVCPreQual.nid.type	Base	extensible	Identifier Type Codes	📍5.0.0	FHIR Std.
DVCPreQual.nid.system	Base	extensible	hl7VS-identifierType	📦3.0.0	THO v7.3
DVCPreQual.disease	Base	extensible	http://id.who.int/icd/release/11/mms	Not State	Unknown

Constraints

Id	Grade	Path(s)	Description	Expression
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()
ident-1	warning	DVCPreQual.nid	Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason	value.exists()
nid-must-have-value	error	DVCPreQual	If National ID is present, it must have a value and a system	nid.empty() or (nid.value.exists() and nid.system.exists())

Differential View

This structure is derived from DVC

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DVCPreQual		0..*	DVC	PreQual Elements defined in Ancestors:name, dob, sex, nationality, nid, guardian, disease, integrityCheck, vaccineDetails, version Instances of this type can be the target of a Reference
DVCPreQual.vaccineDetails		1..*	DVCVaccineDetailsPreQual	Vaccine Details
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DVCPreQual	C	0..*	DVC	PreQual Elements defined in Ancestors:name, dob, sex, nationality, nid, guardian, disease, integrityCheck, vaccineDetails, version Instances of this type can be the target of a Reference Constraints: nid-must-have-value
DVCPreQual.name		1..1	string	Name of the recipient of vaccine or prophylaxis
DVCPreQual.dob		1..1	date	Date of Birth
DVCPreQual.sex		1..1	code	Sex Binding: http://hl7.org/fhir/administrative-gender (extensible)
DVCPreQual.nationality		1..*	Coding	Nationality Binding: Iso316613 (extensible)
DVCPreQual.nid	C	0..*	Identifier	National Identification Document, if applicable Constraints: ident-1
DVCPreQual.nid.@id		0..1	id	Unique id for inter-element referencing
DVCPreQual.nid.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
DVCPreQual.nid.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
DVCPreQual.nid.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
DVCPreQual.nid.system	Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Binding: hl7VS-identifierType (extensible) Example General: http://www.acme.com/identifiers/patient
DVCPreQual.nid.value	Σ This element is included in summaries. C	0..1	string	The value that is unique Example General: 123456
DVCPreQual.nid.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
DVCPreQual.nid.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
DVCPreQual.guardian		0..1	string	Name of the parent or guardian. Required, if applicable
DVCPreQual.disease		1..*	Coding	Name of disease or condition Binding: http://id.who.int/icd/release/11/mms (extensible)
DVCPreQual.integrityCheck		0..*	BackboneElement	Integrity check value
DVCPreQual.integrityCheck.@id		0..1	id	Unique id for inter-element referencing
DVCPreQual.integrityCheck.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
DVCPreQual.integrityCheck.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
DVCPreQual.integrityCheck.cryptographicSignature		1..1	string	Cryptographic signature of the issuer
DVCPreQual.integrityCheck.kid		1..1	string	Key identifier for signature verification
DVCPreQual.vaccineDetails		1..*	DVCVaccineDetailsPreQual	Vaccine Details
DVCPreQual.version		1..1	string	Version Fixed Value: 0.1.0 (no extensions allowed)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
DVCPreQual.sex	Base	extensible	http://hl7.org/fhir/administrative-gender	Not State	Unknown
DVCPreQual.nationality	Base	extensible	Iso 3166 Part 1: 3 Letter Codes	📦5.0.0	FHIR Std.
DVCPreQual.nid.use	Base	required	IdentifierUse	📍5.0.0	FHIR Std.
DVCPreQual.nid.type	Base	extensible	Identifier Type Codes	📍5.0.0	FHIR Std.
DVCPreQual.nid.system	Base	extensible	hl7VS-identifierType	📦3.0.0	THO v7.3
DVCPreQual.disease	Base	extensible	http://id.who.int/icd/release/11/mms	Not State	Unknown

Constraints

Id	Grade	Path(s)	Description	Expression
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()
ident-1	warning	DVCPreQual.nid	Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason	value.exists()
nid-must-have-value	error	DVCPreQual	If National ID is present, it must have a value and a system	nid.empty() or (nid.value.exists() and nid.system.exists())

This structure is derived from DVC

Summary

Other representations of profile: CSV, Excel