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: Medication - HPV Vaccine Details

Records the batch number for the vaccine.

Usage:

• Use this Resource Profile: Bundle - HPV
• Refer to this Resource Profile: Immunization - HPV Immunization
• Examples for this Resource Profile: Medication/HPVVaccineExample

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 Medication

Name	Flags	Card.	Type	Description & Constraints
Medication			Medication
code		1..1	CodeableConcept	Codes that identify this medication Binding: Vaccine Codes (extensible)
batch		1..1	BackboneElement	Details about packaged medications
lotNumber		1..1	string	Identifier assigned to batch
Documentation for this format

Terminology Bindings (Differential)

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

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	Medication	Definition of a Medication
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
code	Σ	1..1	CodeableConcept	Codes that identify this medication Binding: Vaccine Codes (extensible)
status	?!Σ	0..1	code	active | inactive | entered-in-error Binding: MedicationStatusCodes (required): A coded concept defining if the medication is in active use.
batch		1..1	BackboneElement	Details about packaged medications
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
lotNumber		1..1	string	Identifier assigned to batch
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Medication.code	extensible	VSVaccines http://moh.gov.zm/fhir/immunizations/ValueSet/vs-vaccines from this IG
Medication.status	required	MedicationStatusCodes http://hl7.org/fhir/ValueSet/medication-status|5.0.0 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Medication	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Medication	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	Medication	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	Medication	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Medication	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()

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	Medication	Definition of a Medication
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 for this medication
code	Σ	1..1	CodeableConcept	Codes that identify this medication Binding: Vaccine Codes (extensible)
status	?!Σ	0..1	code	active | inactive | entered-in-error Binding: MedicationStatusCodes (required): A coded concept defining if the medication is in active use.
marketingAuthorizationHolder	Σ	0..1	Reference(Organization)	Organization that has authorization to market medication
doseForm		0..1	CodeableConcept	powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.
totalVolume	Σ	0..1	Quantity	When the specified product code does not infer a package size, this is the specific amount of drug in the product
ingredient		0..*	BackboneElement	Active or inactive ingredient
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
item		1..1	CodeableReference(Substance | Medication)	The ingredient (substance or medication) that the ingredient.strength relates to Binding: SNOMEDCTMedicationCodes (example)
isActive		0..1	boolean	Active ingredient indicator
strength[x]		0..1		Quantity of ingredient present Binding: MedicationIngredientStrengthCodes (preferred): A coded concpet defining the strength of an ingredient.
strengthRatio			Ratio
strengthCodeableConcept			CodeableConcept
strengthQuantity			Quantity
batch		1..1	BackboneElement	Details about packaged medications
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
lotNumber		1..1	string	Identifier assigned to batch
expirationDate		0..1	dateTime	When batch will expire
definition		0..1	Reference(MedicationKnowledge)	Knowledge about this medication
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Medication.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Medication.code	extensible	VSVaccines http://moh.gov.zm/fhir/immunizations/ValueSet/vs-vaccines from this IG
Medication.status	required	MedicationStatusCodes http://hl7.org/fhir/ValueSet/medication-status|5.0.0 from the FHIR Standard
Medication.doseForm	example	SNOMEDCTFormCodes http://hl7.org/fhir/ValueSet/medication-form-codes from the FHIR Standard
Medication.ingredient.item	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard
Medication.ingredient.strength[x]	preferred	MedicationIngredientStrengthCodes http://hl7.org/fhir/ValueSet/medication-ingredientstrength from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Medication	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Medication	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	Medication	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	Medication	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Medication	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()

This structure is derived from Medication

Summary

Mandatory: 3 elements

Differential View

This structure is derived from Medication

Name	Flags	Card.	Type	Description & Constraints
Medication			Medication
code		1..1	CodeableConcept	Codes that identify this medication Binding: Vaccine Codes (extensible)
batch		1..1	BackboneElement	Details about packaged medications
lotNumber		1..1	string	Identifier assigned to batch
Documentation for this format

Terminology Bindings (Differential)

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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	Medication	Definition of a Medication
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
code	Σ	1..1	CodeableConcept	Codes that identify this medication Binding: Vaccine Codes (extensible)
status	?!Σ	0..1	code	active | inactive | entered-in-error Binding: MedicationStatusCodes (required): A coded concept defining if the medication is in active use.
batch		1..1	BackboneElement	Details about packaged medications
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
lotNumber		1..1	string	Identifier assigned to batch
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Medication.code	extensible	VSVaccines http://moh.gov.zm/fhir/immunizations/ValueSet/vs-vaccines from this IG
Medication.status	required	MedicationStatusCodes http://hl7.org/fhir/ValueSet/medication-status|5.0.0 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Medication	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Medication	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	Medication	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	Medication	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Medication	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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	Medication	Definition of a Medication
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 for this medication
code	Σ	1..1	CodeableConcept	Codes that identify this medication Binding: Vaccine Codes (extensible)
status	?!Σ	0..1	code	active | inactive | entered-in-error Binding: MedicationStatusCodes (required): A coded concept defining if the medication is in active use.
marketingAuthorizationHolder	Σ	0..1	Reference(Organization)	Organization that has authorization to market medication
doseForm		0..1	CodeableConcept	powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.
totalVolume	Σ	0..1	Quantity	When the specified product code does not infer a package size, this is the specific amount of drug in the product
ingredient		0..*	BackboneElement	Active or inactive ingredient
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
item		1..1	CodeableReference(Substance | Medication)	The ingredient (substance or medication) that the ingredient.strength relates to Binding: SNOMEDCTMedicationCodes (example)
isActive		0..1	boolean	Active ingredient indicator
strength[x]		0..1		Quantity of ingredient present Binding: MedicationIngredientStrengthCodes (preferred): A coded concpet defining the strength of an ingredient.
strengthRatio			Ratio
strengthCodeableConcept			CodeableConcept
strengthQuantity			Quantity
batch		1..1	BackboneElement	Details about packaged medications
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
lotNumber		1..1	string	Identifier assigned to batch
expirationDate		0..1	dateTime	When batch will expire
definition		0..1	Reference(MedicationKnowledge)	Knowledge about this medication
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Medication.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Medication.code	extensible	VSVaccines http://moh.gov.zm/fhir/immunizations/ValueSet/vs-vaccines from this IG
Medication.status	required	MedicationStatusCodes http://hl7.org/fhir/ValueSet/medication-status|5.0.0 from the FHIR Standard
Medication.doseForm	example	SNOMEDCTFormCodes http://hl7.org/fhir/ValueSet/medication-form-codes from the FHIR Standard
Medication.ingredient.item	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard
Medication.ingredient.strength[x]	preferred	MedicationIngredientStrengthCodes http://hl7.org/fhir/ValueSet/medication-ingredientstrength from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Medication	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Medication	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	Medication	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	Medication	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Medication	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()

This structure is derived from Medication

Summary

Mandatory: 3 elements

Other representations of profile: CSV, Excel, Schematron