International Patient Summary Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/costateixeira/fhir-ips/ and changes regularly. See the Directory of published versions

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

Logical Model: Immunizations

Immunizations Section

Usage:

• Use this Logical Model Profile: ISO 27269 IPS

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
ImmunizationsSection		0..*	Base	Immunizations Instances of this logical model can be the target of a Reference
contentStatus		0..1	CodeableConcept	Immunizations content status
immunization		0..*	BackboneElement	Immunization ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
vaccineType		0..1	CodeableConcept	Vaccine for type of disease
targetDiseases		0..*	BackboneElement	Target diseases ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
targetDisease		0..1	CodeableConcept	Target disease
dateOfImmunization		0..1	dateTime	Date of immunization
dosesInSeries		0..1	Quantity	Number in a series of doses
productAdministered		0..1	BackboneElement	Product administered ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
brandName		0..1	string	Brand name
vaccineProphylaxisComponent		0..1	string	Vaccine/prophylaxis or its component
productAdministrationProcess		0..1	BackboneElement	Product administration process ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
performer		0..1	Reference()	Performer
routeOfAdministration		0..1	CodeableConcept	Route of administration
Documentation for this format

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 Base

Name	Flags	Card.	Type	Description & Constraints
ImmunizationsSection		0..*	Base	Immunizations Instances of this logical model can be the target of a Reference
contentStatus		0..1	CodeableConcept	Immunizations content status
immunization		0..*	BackboneElement	Immunization
vaccineType		0..1	CodeableConcept	Vaccine for type of disease
targetDiseases		0..*	BackboneElement	Target diseases
targetDisease		0..1	CodeableConcept	Target disease
dateOfImmunization		0..1	dateTime	Date of immunization
dosesInSeries		0..1	Quantity	Number in a series of doses
productAdministered		0..1	BackboneElement	Product administered
brandName		0..1	string	Brand name
vaccineProphylaxisComponent		0..1	string	Vaccine/prophylaxis or its component
productAdministrationProcess		0..1	BackboneElement	Product administration process
performer		0..1	Reference()	Performer
routeOfAdministration		0..1	CodeableConcept	Route of administration
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
ImmunizationsSection		0..*	Base	Immunizations Instances of this logical model can be the target of a Reference
contentStatus		0..1	CodeableConcept	Immunizations content status
immunization		0..*	BackboneElement	Immunization
@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	CodeableConcept	Vaccine for type of disease
targetDiseases		0..*	BackboneElement	Target diseases
@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
targetDisease		0..1	CodeableConcept	Target disease
dateOfImmunization		0..1	dateTime	Date of immunization
dosesInSeries		0..1	Quantity	Number in a series of doses
productAdministered		0..1	BackboneElement	Product administered
@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
brandName		0..1	string	Brand name
vaccineProphylaxisComponent		0..1	string	Vaccine/prophylaxis or its component
productAdministrationProcess		0..1	BackboneElement	Product administration process
@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
performer		0..1	Reference()	Performer
routeOfAdministration		0..1	CodeableConcept	Route of administration
Documentation for this format

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 Base

Summary

Maturity: 2

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
ImmunizationsSection		0..*	Base	Immunizations Instances of this logical model can be the target of a Reference
contentStatus		0..1	CodeableConcept	Immunizations content status
immunization		0..*	BackboneElement	Immunization ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
vaccineType		0..1	CodeableConcept	Vaccine for type of disease
targetDiseases		0..*	BackboneElement	Target diseases ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
targetDisease		0..1	CodeableConcept	Target disease
dateOfImmunization		0..1	dateTime	Date of immunization
dosesInSeries		0..1	Quantity	Number in a series of doses
productAdministered		0..1	BackboneElement	Product administered ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
brandName		0..1	string	Brand name
vaccineProphylaxisComponent		0..1	string	Vaccine/prophylaxis or its component
productAdministrationProcess		0..1	BackboneElement	Product administration process ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
performer		0..1	Reference()	Performer
routeOfAdministration		0..1	CodeableConcept	Route of administration
Documentation for this format

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()

Differential View

This structure is derived from Base

Name	Flags	Card.	Type	Description & Constraints
ImmunizationsSection		0..*	Base	Immunizations Instances of this logical model can be the target of a Reference
contentStatus		0..1	CodeableConcept	Immunizations content status
immunization		0..*	BackboneElement	Immunization
vaccineType		0..1	CodeableConcept	Vaccine for type of disease
targetDiseases		0..*	BackboneElement	Target diseases
targetDisease		0..1	CodeableConcept	Target disease
dateOfImmunization		0..1	dateTime	Date of immunization
dosesInSeries		0..1	Quantity	Number in a series of doses
productAdministered		0..1	BackboneElement	Product administered
brandName		0..1	string	Brand name
vaccineProphylaxisComponent		0..1	string	Vaccine/prophylaxis or its component
productAdministrationProcess		0..1	BackboneElement	Product administration process
performer		0..1	Reference()	Performer
routeOfAdministration		0..1	CodeableConcept	Route of administration
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
ImmunizationsSection		0..*	Base	Immunizations Instances of this logical model can be the target of a Reference
contentStatus		0..1	CodeableConcept	Immunizations content status
immunization		0..*	BackboneElement	Immunization
@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	CodeableConcept	Vaccine for type of disease
targetDiseases		0..*	BackboneElement	Target diseases
@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
targetDisease		0..1	CodeableConcept	Target disease
dateOfImmunization		0..1	dateTime	Date of immunization
dosesInSeries		0..1	Quantity	Number in a series of doses
productAdministered		0..1	BackboneElement	Product administered
@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
brandName		0..1	string	Brand name
vaccineProphylaxisComponent		0..1	string	Vaccine/prophylaxis or its component
productAdministrationProcess		0..1	BackboneElement	Product administration process
@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
performer		0..1	Reference()	Performer
routeOfAdministration		0..1	CodeableConcept	Route of administration
Documentation for this format

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 Base

Summary

Maturity: 2

Other representations of profile: CSV, Excel