Zambia Immunizations FHIR Implementation Guide, published by Jembi Health Systems. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/jembi/Zambia-Immunizations/ and changes regularly. See the Directory of published versions

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

Resource Profile: Immunization Recommendation - Vaccine Next Dose Date

Used to represent the patient's suggested next dose date.

Usage:

• Use this Resource Profile: Bundle - COVAX
• Examples for this Resource Profile: ImmunizationRecommendation/VaccineNextDoseDateExample

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 ImmunizationRecommendation

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation			ImmunizationRecommendation
patient		1..1	Reference(Patient - COVAX Immunization Patient)	Who this profile is for
authority	S	0..1	Reference(Organization - Healthcare Service Provider Profile)	Who is responsible for protocol
recommendation		1..1	BackboneElement	Vaccine administration recommendations
vaccineCode		1..1	CodeableConcept	Vaccine or vaccine group recommendation applies to Binding: Vaccine Codes (extensible)
forecastStatus
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/immunization-recommendation-status
code		0..1	code	Symbol in syntax defined by the system Required Pattern: due
dateCriterion		1..1	BackboneElement	Dates governing proposed immunization
code		1..1	CodeableConcept	Type of date Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 30980-7
supportingImmunization		1..1	Reference(Immunization - Covax Immunization)	Past immunizations supporting recommendation
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
ImmunizationRecommendation.recommendation.vaccineCode	extensible	VSVaccines http://moh.gov.zm/fhir/immunizations/ValueSet/vs-vaccines from this IG

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation		0..*	ImmunizationRecommendation	Guidance or advice relating to an immunization
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
patient	Σ	1..1	Reference(Patient - COVAX Immunization Patient)	Who this profile is for
date	Σ	1..1	dateTime	Date recommendation(s) created
authority	S	0..1	Reference(Organization - Healthcare Service Provider Profile)	Who is responsible for protocol
recommendation	ΣC	1..1	BackboneElement	Vaccine administration recommendations imr-1: One of vaccineCode or targetDisease SHALL be present
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
vaccineCode	ΣC	1..1	CodeableConcept	Vaccine or vaccine group recommendation applies to Binding: Vaccine Codes (extensible)
forecastStatus	?!Σ	1..1	CodeableConcept	Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.
dateCriterion		1..1	BackboneElement	Dates governing proposed immunization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code		1..1	CodeableConcept	Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.). Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 30980-7
value		1..1	dateTime	Recommended date
supportingImmunization		1..1	Reference(Immunization - Covax Immunization)	Past immunizations supporting recommendation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ImmunizationRecommendation.recommendation.vaccineCode	extensible	VSVaccines http://moh.gov.zm/fhir/immunizations/ValueSet/vs-vaccines from this IG
ImmunizationRecommendation.recommendation.forecastStatus	example	ImmunizationRecommendationStatusCodes http://hl7.org/fhir/ValueSet/immunization-recommendation-status from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion.code	example	Pattern: LOINC Code 30980-7 http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	ImmunizationRecommendation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	ImmunizationRecommendation	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	ImmunizationRecommendation	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	ImmunizationRecommendation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	ImmunizationRecommendation	A resource should have narrative for robust management : text.`div`.exists()
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()
imr-1	error	ImmunizationRecommendation.recommendation	One of vaccineCode or targetDisease SHALL be present : vaccineCode.exists() or targetDisease.exists()

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation		0..*	ImmunizationRecommendation	Guidance or advice relating to an immunization
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business identifier
patient	Σ	1..1	Reference(Patient - COVAX Immunization Patient)	Who this profile is for
date	Σ	1..1	dateTime	Date recommendation(s) created
authority	S	0..1	Reference(Organization - Healthcare Service Provider Profile)	Who is responsible for protocol
recommendation	ΣC	1..1	BackboneElement	Vaccine administration recommendations imr-1: One of vaccineCode or targetDisease SHALL be present
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
vaccineCode	ΣC	1..1	CodeableConcept	Vaccine or vaccine group recommendation applies to Binding: Vaccine Codes (extensible)
targetDisease	ΣC	0..*	CodeableConcept	Disease to be immunized against Binding: ImmunizationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.
contraindicatedVaccineCode	Σ	0..*	CodeableConcept	Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
forecastStatus	?!Σ	1..1	CodeableConcept	Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/immunization-recommendation-status
version	Σ	0..1	string	Version of the system - if relevant
code	ΣC	0..1	code	Symbol in syntax defined by the system Required Pattern: due
display	ΣC	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
forecastReason	Σ	0..*	CodeableConcept	Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.
dateCriterion		1..1	BackboneElement	Dates governing proposed immunization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code		1..1	CodeableConcept	Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.). Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 30980-7
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
value		1..1	dateTime	Recommended date
description		0..1	markdown	Protocol details
series		0..1	string	Name of vaccination series
doseNumber	Σ	0..1	string	Recommended dose number within series
seriesDoses		0..1	string	Recommended number of doses for immunity
supportingImmunization		1..1	Reference(Immunization - Covax Immunization)	Past immunizations supporting recommendation
supportingPatientInformation		0..*	Reference(Resource)	Patient observations supporting recommendation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ImmunizationRecommendation.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
ImmunizationRecommendation.recommendation.vaccineCode	extensible	VSVaccines http://moh.gov.zm/fhir/immunizations/ValueSet/vs-vaccines from this IG
ImmunizationRecommendation.recommendation.targetDisease	example	ImmunizationTargetDiseaseCodes http://hl7.org/fhir/ValueSet/immunization-target-disease from the FHIR Standard
ImmunizationRecommendation.recommendation.contraindicatedVaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastStatus	example	ImmunizationRecommendationStatusCodes http://hl7.org/fhir/ValueSet/immunization-recommendation-status from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastReason	example	ImmunizationRecommendationReasonCodes http://hl7.org/fhir/ValueSet/immunization-recommendation-reason from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion.code	example	Pattern: LOINC Code 30980-7 http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	ImmunizationRecommendation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	ImmunizationRecommendation	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	ImmunizationRecommendation	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	ImmunizationRecommendation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	ImmunizationRecommendation	A resource should have narrative for robust management : text.`div`.exists()
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()
imr-1	error	ImmunizationRecommendation.recommendation	One of vaccineCode or targetDisease SHALL be present : vaccineCode.exists() or targetDisease.exists()

This structure is derived from ImmunizationRecommendation

Summary

Mandatory: 3 elements
Must-Support: 1 element

Structures

This structure refers to these other structures:

• Patient - COVAX Immunization Patient (http://moh.gov.zm/fhir/immunizations/StructureDefinition/covax-immunization-patient)
• Organization - Healthcare Service Provider Profile (http://moh.gov.zm/fhir/immunizations/StructureDefinition/healthcare-service-provider)
• Immunization - Covax Immunization (http://moh.gov.zm/fhir/immunizations/StructureDefinition/covax-immunization)

Differential View

This structure is derived from ImmunizationRecommendation

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation			ImmunizationRecommendation
patient		1..1	Reference(Patient - COVAX Immunization Patient)	Who this profile is for
authority	S	0..1	Reference(Organization - Healthcare Service Provider Profile)	Who is responsible for protocol
recommendation		1..1	BackboneElement	Vaccine administration recommendations
vaccineCode		1..1	CodeableConcept	Vaccine or vaccine group recommendation applies to Binding: Vaccine Codes (extensible)
forecastStatus
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/immunization-recommendation-status
code		0..1	code	Symbol in syntax defined by the system Required Pattern: due
dateCriterion		1..1	BackboneElement	Dates governing proposed immunization
code		1..1	CodeableConcept	Type of date Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 30980-7
supportingImmunization		1..1	Reference(Immunization - Covax Immunization)	Past immunizations supporting recommendation
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
ImmunizationRecommendation.recommendation.vaccineCode	extensible	VSVaccines http://moh.gov.zm/fhir/immunizations/ValueSet/vs-vaccines from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation		0..*	ImmunizationRecommendation	Guidance or advice relating to an immunization
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
patient	Σ	1..1	Reference(Patient - COVAX Immunization Patient)	Who this profile is for
date	Σ	1..1	dateTime	Date recommendation(s) created
authority	S	0..1	Reference(Organization - Healthcare Service Provider Profile)	Who is responsible for protocol
recommendation	ΣC	1..1	BackboneElement	Vaccine administration recommendations imr-1: One of vaccineCode or targetDisease SHALL be present
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
vaccineCode	ΣC	1..1	CodeableConcept	Vaccine or vaccine group recommendation applies to Binding: Vaccine Codes (extensible)
forecastStatus	?!Σ	1..1	CodeableConcept	Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.
dateCriterion		1..1	BackboneElement	Dates governing proposed immunization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code		1..1	CodeableConcept	Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.). Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 30980-7
value		1..1	dateTime	Recommended date
supportingImmunization		1..1	Reference(Immunization - Covax Immunization)	Past immunizations supporting recommendation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ImmunizationRecommendation.recommendation.vaccineCode	extensible	VSVaccines http://moh.gov.zm/fhir/immunizations/ValueSet/vs-vaccines from this IG
ImmunizationRecommendation.recommendation.forecastStatus	example	ImmunizationRecommendationStatusCodes http://hl7.org/fhir/ValueSet/immunization-recommendation-status from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion.code	example	Pattern: LOINC Code 30980-7 http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	ImmunizationRecommendation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	ImmunizationRecommendation	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	ImmunizationRecommendation	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	ImmunizationRecommendation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	ImmunizationRecommendation	A resource should have narrative for robust management : text.`div`.exists()
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()
imr-1	error	ImmunizationRecommendation.recommendation	One of vaccineCode or targetDisease SHALL be present : vaccineCode.exists() or targetDisease.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation		0..*	ImmunizationRecommendation	Guidance or advice relating to an immunization
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business identifier
patient	Σ	1..1	Reference(Patient - COVAX Immunization Patient)	Who this profile is for
date	Σ	1..1	dateTime	Date recommendation(s) created
authority	S	0..1	Reference(Organization - Healthcare Service Provider Profile)	Who is responsible for protocol
recommendation	ΣC	1..1	BackboneElement	Vaccine administration recommendations imr-1: One of vaccineCode or targetDisease SHALL be present
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
vaccineCode	ΣC	1..1	CodeableConcept	Vaccine or vaccine group recommendation applies to Binding: Vaccine Codes (extensible)
targetDisease	ΣC	0..*	CodeableConcept	Disease to be immunized against Binding: ImmunizationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.
contraindicatedVaccineCode	Σ	0..*	CodeableConcept	Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
forecastStatus	?!Σ	1..1	CodeableConcept	Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/immunization-recommendation-status
version	Σ	0..1	string	Version of the system - if relevant
code	ΣC	0..1	code	Symbol in syntax defined by the system Required Pattern: due
display	ΣC	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
forecastReason	Σ	0..*	CodeableConcept	Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.
dateCriterion		1..1	BackboneElement	Dates governing proposed immunization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code		1..1	CodeableConcept	Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.). Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 30980-7
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
value		1..1	dateTime	Recommended date
description		0..1	markdown	Protocol details
series		0..1	string	Name of vaccination series
doseNumber	Σ	0..1	string	Recommended dose number within series
seriesDoses		0..1	string	Recommended number of doses for immunity
supportingImmunization		1..1	Reference(Immunization - Covax Immunization)	Past immunizations supporting recommendation
supportingPatientInformation		0..*	Reference(Resource)	Patient observations supporting recommendation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ImmunizationRecommendation.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
ImmunizationRecommendation.recommendation.vaccineCode	extensible	VSVaccines http://moh.gov.zm/fhir/immunizations/ValueSet/vs-vaccines from this IG
ImmunizationRecommendation.recommendation.targetDisease	example	ImmunizationTargetDiseaseCodes http://hl7.org/fhir/ValueSet/immunization-target-disease from the FHIR Standard
ImmunizationRecommendation.recommendation.contraindicatedVaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastStatus	example	ImmunizationRecommendationStatusCodes http://hl7.org/fhir/ValueSet/immunization-recommendation-status from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastReason	example	ImmunizationRecommendationReasonCodes http://hl7.org/fhir/ValueSet/immunization-recommendation-reason from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion.code	example	Pattern: LOINC Code 30980-7 http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	ImmunizationRecommendation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	ImmunizationRecommendation	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	ImmunizationRecommendation	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	ImmunizationRecommendation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	ImmunizationRecommendation	A resource should have narrative for robust management : text.`div`.exists()
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()
imr-1	error	ImmunizationRecommendation.recommendation	One of vaccineCode or targetDisease SHALL be present : vaccineCode.exists() or targetDisease.exists()

This structure is derived from ImmunizationRecommendation

Summary

Mandatory: 3 elements
Must-Support: 1 element

Structures

This structure refers to these other structures:

• Patient - COVAX Immunization Patient (http://moh.gov.zm/fhir/immunizations/StructureDefinition/covax-immunization-patient)
• Organization - Healthcare Service Provider Profile (http://moh.gov.zm/fhir/immunizations/StructureDefinition/healthcare-service-provider)
• Immunization - Covax Immunization (http://moh.gov.zm/fhir/immunizations/StructureDefinition/covax-immunization)

Other representations of profile: CSV, Excel, Schematron