FR Document Core (FHIR), published by Agence du Numérique en Santé (ANS) - 2-10 Rue d'Oradour-sur-Glane, 75015 Paris. 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/ansforge/interop-IG-fhir-document-core/ and changes regularly. See the Directory of published versions

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

Resource Profile: ImmunizationRecommendation - FR Immunization Recommendation Document

FRImmunizationRecommendationDocument permet de décrire une vaccination prévue ou proposée.

• Une vaccination proposée est une proposition qui est utilisée dans la prise de décisions (elle peut apparaître comme une contribution ou un résultat provenant de l'aide à la décision clinique).
• Une vaccination prévue dépend d'un plan accepté et à venir.
• Ce profil hérite de la structuration, des contraintes et des vocabulaires définis dans le profil FRVaccinationDocument.

Usages:

• Refer to this Profile: MedicationRequest - FR Medication Request Document

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ImmunizationRecommendation		0..*	ImmunizationRecommendation(4.0.1)	Guidance or advice relating to an immunization
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
identifier	Σ	0..*	Identifier	Identifiant
patient	Σ	1..1	Reference(Patient)	Who this profile is for
date	Σ	1..1	dateTime	Date recommendation(s) created
recommendation	ΣC	1..1	BackboneElement	Vaccine administration recommendations Constraints: imr-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
vaccineCode	SΣ	0..*	CodeableConcept	Vaccin. Code du produit de santé Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
Slices for coding	Σ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:cis	Σ	1..1	Coding	Code defined by a terminology system Binding: FRValueSetVaccineCodeCISDocument (0.1.0) (required)
coding:translation	Σ	0..*	Coding	Code defined by a terminology system Binding: FRValueSetMedicationTranslationDocument (0.1.0) (required)
system	Σ	1..1	uri	Identity of the terminology system
forecastStatus	?!Σ	1..1	CodeableConcept	Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. 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		0..1	uri	Identity of the terminology system
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: complete
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
dateCriterion		1..1	BackboneElement	Dates governing proposed immunization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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.).
value		1..1	dateTime	Période de vaccination souhaitable
description	S	0..1	string	Commentaire
Slices for seriesDoses[x]		0..1		Recommended number of doses for immunity Slice: Unordered, Open by type:$this
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
seriesDoses[x]:seriesDosesPositiveInt	S	0..1	positiveInt	Recommended number of doses for immunity
supportingImmunization		0..*	Reference(Immunization - FR Immunization Document(0.1.0))	Past immunizations supporting recommendation
supportingPatientInformation		0..*	Reference(MedicationRequest - FR Medication Request Document(0.1.0))	Prescription
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
ImmunizationRecommendation.​recommendation.vaccineCode	Base	example	Vaccine Administered Value Set	📍4.0.1	FHIR Std.
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:cis	Base	required	ValueSet – FR ValueSet Codes vaccins CIS (BDPM)	📍0.1.0	This IG
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:translation	Base	required	ValueSet - FR ValueSet Medication Translation Document	📍0.1.0	This IG
ImmunizationRecommendation.​recommendation.forecastStatus	Base	example	Immunization Recommendation Status Codes	📍4.0.1	FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion.​code	Base	example	Immunization Recommendation Date Criterion Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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	ImmunizationRecommendation.implicitRules, ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.identifier, ImmunizationRecommendation.patient, ImmunizationRecommendation.date, ImmunizationRecommendation.recommendation, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.vaccineCode, ImmunizationRecommendation.recommendation.vaccineCode.coding, ImmunizationRecommendation.recommendation.vaccineCode.coding:cis, ImmunizationRecommendation.recommendation.vaccineCode.coding:translation, ImmunizationRecommendation.recommendation.vaccineCode.coding:translation.system, ImmunizationRecommendation.recommendation.forecastStatus, ImmunizationRecommendation.recommendation.dateCriterion, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension, ImmunizationRecommendation.recommendation.dateCriterion.code, ImmunizationRecommendation.recommendation.dateCriterion.value, ImmunizationRecommendation.recommendation.description, ImmunizationRecommendation.recommendation.seriesDoses[x], ImmunizationRecommendation.recommendation.seriesDoses[x]:seriesDosesPositiveInt, ImmunizationRecommendation.recommendation.supportingImmunization, ImmunizationRecommendation.recommendation.supportingPatientInformation	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension	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    Filter: Bindings Constraints Obligations
ImmunizationRecommendation		0..*	ImmunizationRecommendation(4.0.1)	Guidance or advice relating to an immunization
identifier		0..*	Identifier	Identifiant
recommendation		1..1	BackboneElement	Vaccine administration recommendations
vaccineCode	S	0..*	CodeableConcept	Vaccin. Code du produit de santé
Slices for coding		1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:cis		1..1	Coding	Code defined by a terminology system Binding: FRValueSetVaccineCodeCISDocument (0.1.0) (required)
coding:translation		0..*	Coding	Code defined by a terminology system Binding: FRValueSetMedicationTranslationDocument (0.1.0) (required)
system		1..1	uri	Identity of the terminology system
forecastStatus		1..1	CodeableConcept	Vaccine recommendation status Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
code		1..1	code	Symbol in syntax defined by the system Fixed Value: complete
dateCriterion		1..1	BackboneElement	Dates governing proposed immunization
value		1..1	dateTime	Période de vaccination souhaitable
description	S	0..1	string	Commentaire
Slices for seriesDoses[x]		0..1	positiveInt, string	Recommended number of doses for immunity Slice: Unordered, Open by type:$this
seriesDoses[x]:seriesDosesPositiveInt	S	0..1	positiveInt	Recommended number of doses for immunity
supportingImmunization		0..*	Reference(Immunization - FR Immunization Document(0.1.0))	Past immunizations supporting recommendation
supportingPatientInformation		0..*	Reference(MedicationRequest - FR Medication Request Document(0.1.0))	Prescription
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:cis	Base	required	ValueSet – FR ValueSet Codes vaccins CIS (BDPM)	📍0.1.0	This IG
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:translation	Base	required	ValueSet - FR ValueSet Medication Translation Document	📍0.1.0	This IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ImmunizationRecommendation		0..*	ImmunizationRecommendation(4.0.1)	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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
identifier	Σ	0..*	Identifier	Identifiant
patient	Σ	1..1	Reference(Patient)	Who this profile is for
date	Σ	1..1	dateTime	Date recommendation(s) created
authority		0..1	Reference(Organization)	Who is responsible for protocol
recommendation	ΣC	1..1	BackboneElement	Vaccine administration recommendations Constraints: imr-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
vaccineCode	SΣ	0..*	CodeableConcept	Vaccin. Code du produit de santé Binding: VaccineAdministeredValueSet (example): The type of vaccine 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 Constraints: ext-1
Slices for coding	Σ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:cis	Σ	1..1	Coding	Code defined by a terminology system Binding: FRValueSetVaccineCodeCISDocument (0.1.0) (required)
coding:translation	Σ	0..*	Coding	Code defined by a terminology system Binding: FRValueSetMedicationTranslationDocument (0.1.0) (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
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
targetDisease	Σ	0..1	CodeableConcept	Disease to be immunized against Binding: ImmunizationRecommendationTargetDiseaseCodes (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. 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		0..1	uri	Identity of the terminology system
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: complete
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
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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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.).
value		1..1	dateTime	Période de vaccination souhaitable
description	S	0..1	string	Commentaire
series		0..1	string	Name of vaccination series
doseNumber[x]	Σ	0..1		Recommended dose number within series
doseNumberPositiveInt			positiveInt
doseNumberString			string
Slices for seriesDoses[x]		0..1		Recommended number of doses for immunity Slice: Unordered, Open by type:$this
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
seriesDoses[x]:seriesDosesPositiveInt	S	0..1	positiveInt	Recommended number of doses for immunity
supportingImmunization		0..*	Reference(Immunization - FR Immunization Document(0.1.0))	Past immunizations supporting recommendation
supportingPatientInformation		0..*	Reference(MedicationRequest - FR Medication Request Document(0.1.0))	Prescription
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
ImmunizationRecommendation.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
ImmunizationRecommendation.​recommendation.vaccineCode	Base	example	Vaccine Administered Value Set	📍4.0.1	FHIR Std.
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:cis	Base	required	ValueSet – FR ValueSet Codes vaccins CIS (BDPM)	📍0.1.0	This IG
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:translation	Base	required	ValueSet - FR ValueSet Medication Translation Document	📍0.1.0	This IG
ImmunizationRecommendation.​recommendation.targetDisease	Base	example	Immunization Recommendation Target Disease Codes	📍4.0.1	FHIR Std.
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode	Base	example	Vaccine Administered Value Set	📍4.0.1	FHIR Std.
ImmunizationRecommendation.​recommendation.forecastStatus	Base	example	Immunization Recommendation Status Codes	📍4.0.1	FHIR Std.
ImmunizationRecommendation.​recommendation.forecastReason	Base	example	Immunization Recommendation Reason Codes	📍4.0.1	FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion.​code	Base	example	Immunization Recommendation Date Criterion Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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	ImmunizationRecommendation.meta, ImmunizationRecommendation.implicitRules, ImmunizationRecommendation.language, ImmunizationRecommendation.text, ImmunizationRecommendation.extension, ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.identifier, ImmunizationRecommendation.patient, ImmunizationRecommendation.date, ImmunizationRecommendation.authority, ImmunizationRecommendation.recommendation, ImmunizationRecommendation.recommendation.extension, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.vaccineCode, ImmunizationRecommendation.recommendation.vaccineCode.extension, ImmunizationRecommendation.recommendation.vaccineCode.coding, ImmunizationRecommendation.recommendation.vaccineCode.coding:cis, ImmunizationRecommendation.recommendation.vaccineCode.coding:translation, ImmunizationRecommendation.recommendation.vaccineCode.coding:translation.extension, ImmunizationRecommendation.recommendation.vaccineCode.coding:translation.system, ImmunizationRecommendation.recommendation.vaccineCode.coding:translation.version, ImmunizationRecommendation.recommendation.vaccineCode.coding:translation.code, ImmunizationRecommendation.recommendation.vaccineCode.coding:translation.display, ImmunizationRecommendation.recommendation.vaccineCode.coding:translation.userSelected, ImmunizationRecommendation.recommendation.vaccineCode.text, ImmunizationRecommendation.recommendation.targetDisease, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode, ImmunizationRecommendation.recommendation.forecastStatus, ImmunizationRecommendation.recommendation.forecastReason, ImmunizationRecommendation.recommendation.dateCriterion, ImmunizationRecommendation.recommendation.dateCriterion.extension, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension, ImmunizationRecommendation.recommendation.dateCriterion.code, ImmunizationRecommendation.recommendation.dateCriterion.value, ImmunizationRecommendation.recommendation.description, ImmunizationRecommendation.recommendation.series, ImmunizationRecommendation.recommendation.doseNumber[x], ImmunizationRecommendation.recommendation.seriesDoses[x], ImmunizationRecommendation.recommendation.seriesDoses[x]:seriesDosesPositiveInt, ImmunizationRecommendation.recommendation.supportingImmunization, ImmunizationRecommendation.recommendation.supportingPatientInformation	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	ImmunizationRecommendation.extension, ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.recommendation.extension, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.vaccineCode.extension, ImmunizationRecommendation.recommendation.vaccineCode.coding:translation.extension, ImmunizationRecommendation.recommendation.dateCriterion.extension, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension	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()

Summary

Mandatory: 1 element(3 nested mandatory elements)
Must-Support: 3 elements

Structures

This structure refers to these other structures:

• Immunization - FR Immunization Document (https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-immunization-document|0.1.0)
• MedicationRequest - FR Medication Request Document (https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-medication-request-document|0.1.0)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of ImmunizationRecommendation.recommendation.vaccineCode.coding
• The element 1 is sliced based on the value of ImmunizationRecommendation.recommendation.seriesDoses[x]

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ImmunizationRecommendation		0..*	ImmunizationRecommendation(4.0.1)	Guidance or advice relating to an immunization
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
identifier	Σ	0..*	Identifier	Identifiant
patient	Σ	1..1	Reference(Patient)	Who this profile is for
date	Σ	1..1	dateTime	Date recommendation(s) created
recommendation	ΣC	1..1	BackboneElement	Vaccine administration recommendations Constraints: imr-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
vaccineCode	SΣ	0..*	CodeableConcept	Vaccin. Code du produit de santé Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
Slices for coding	Σ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:cis	Σ	1..1	Coding	Code defined by a terminology system Binding: FRValueSetVaccineCodeCISDocument (0.1.0) (required)
coding:translation	Σ	0..*	Coding	Code defined by a terminology system Binding: FRValueSetMedicationTranslationDocument (0.1.0) (required)
system	Σ	1..1	uri	Identity of the terminology system
forecastStatus	?!Σ	1..1	CodeableConcept	Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. 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		0..1	uri	Identity of the terminology system
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: complete
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
dateCriterion		1..1	BackboneElement	Dates governing proposed immunization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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.).
value		1..1	dateTime	Période de vaccination souhaitable
description	S	0..1	string	Commentaire
Slices for seriesDoses[x]		0..1		Recommended number of doses for immunity Slice: Unordered, Open by type:$this
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
seriesDoses[x]:seriesDosesPositiveInt	S	0..1	positiveInt	Recommended number of doses for immunity
supportingImmunization		0..*	Reference(Immunization - FR Immunization Document(0.1.0))	Past immunizations supporting recommendation
supportingPatientInformation		0..*	Reference(MedicationRequest - FR Medication Request Document(0.1.0))	Prescription
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
ImmunizationRecommendation.​recommendation.vaccineCode	Base	example	Vaccine Administered Value Set	📍4.0.1	FHIR Std.
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:cis	Base	required	ValueSet – FR ValueSet Codes vaccins CIS (BDPM)	📍0.1.0	This IG
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:translation	Base	required	ValueSet - FR ValueSet Medication Translation Document	📍0.1.0	This IG
ImmunizationRecommendation.​recommendation.forecastStatus	Base	example	Immunization Recommendation Status Codes	📍4.0.1	FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion.​code	Base	example	Immunization Recommendation Date Criterion Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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	ImmunizationRecommendation.implicitRules, ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.identifier, ImmunizationRecommendation.patient, ImmunizationRecommendation.date, ImmunizationRecommendation.recommendation, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.vaccineCode, ImmunizationRecommendation.recommendation.vaccineCode.coding, ImmunizationRecommendation.recommendation.vaccineCode.coding:cis, ImmunizationRecommendation.recommendation.vaccineCode.coding:translation, ImmunizationRecommendation.recommendation.vaccineCode.coding:translation.system, ImmunizationRecommendation.recommendation.forecastStatus, ImmunizationRecommendation.recommendation.dateCriterion, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension, ImmunizationRecommendation.recommendation.dateCriterion.code, ImmunizationRecommendation.recommendation.dateCriterion.value, ImmunizationRecommendation.recommendation.description, ImmunizationRecommendation.recommendation.seriesDoses[x], ImmunizationRecommendation.recommendation.seriesDoses[x]:seriesDosesPositiveInt, ImmunizationRecommendation.recommendation.supportingImmunization, ImmunizationRecommendation.recommendation.supportingPatientInformation	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension	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()

Differential View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ImmunizationRecommendation		0..*	ImmunizationRecommendation(4.0.1)	Guidance or advice relating to an immunization
identifier		0..*	Identifier	Identifiant
recommendation		1..1	BackboneElement	Vaccine administration recommendations
vaccineCode	S	0..*	CodeableConcept	Vaccin. Code du produit de santé
Slices for coding		1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:cis		1..1	Coding	Code defined by a terminology system Binding: FRValueSetVaccineCodeCISDocument (0.1.0) (required)
coding:translation		0..*	Coding	Code defined by a terminology system Binding: FRValueSetMedicationTranslationDocument (0.1.0) (required)
system		1..1	uri	Identity of the terminology system
forecastStatus		1..1	CodeableConcept	Vaccine recommendation status Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
code		1..1	code	Symbol in syntax defined by the system Fixed Value: complete
dateCriterion		1..1	BackboneElement	Dates governing proposed immunization
value		1..1	dateTime	Période de vaccination souhaitable
description	S	0..1	string	Commentaire
Slices for seriesDoses[x]		0..1	positiveInt, string	Recommended number of doses for immunity Slice: Unordered, Open by type:$this
seriesDoses[x]:seriesDosesPositiveInt	S	0..1	positiveInt	Recommended number of doses for immunity
supportingImmunization		0..*	Reference(Immunization - FR Immunization Document(0.1.0))	Past immunizations supporting recommendation
supportingPatientInformation		0..*	Reference(MedicationRequest - FR Medication Request Document(0.1.0))	Prescription
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:cis	Base	required	ValueSet – FR ValueSet Codes vaccins CIS (BDPM)	📍0.1.0	This IG
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:translation	Base	required	ValueSet - FR ValueSet Medication Translation Document	📍0.1.0	This IG

Snapshot ViewView

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ImmunizationRecommendation		0..*	ImmunizationRecommendation(4.0.1)	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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
identifier	Σ	0..*	Identifier	Identifiant
patient	Σ	1..1	Reference(Patient)	Who this profile is for
date	Σ	1..1	dateTime	Date recommendation(s) created
authority		0..1	Reference(Organization)	Who is responsible for protocol
recommendation	ΣC	1..1	BackboneElement	Vaccine administration recommendations Constraints: imr-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
vaccineCode	SΣ	0..*	CodeableConcept	Vaccin. Code du produit de santé Binding: VaccineAdministeredValueSet (example): The type of vaccine 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 Constraints: ext-1
Slices for coding	Σ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:cis	Σ	1..1	Coding	Code defined by a terminology system Binding: FRValueSetVaccineCodeCISDocument (0.1.0) (required)
coding:translation	Σ	0..*	Coding	Code defined by a terminology system Binding: FRValueSetMedicationTranslationDocument (0.1.0) (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
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
targetDisease	Σ	0..1	CodeableConcept	Disease to be immunized against Binding: ImmunizationRecommendationTargetDiseaseCodes (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. 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		0..1	uri	Identity of the terminology system
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: complete
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
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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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.).
value		1..1	dateTime	Période de vaccination souhaitable
description	S	0..1	string	Commentaire
series		0..1	string	Name of vaccination series
doseNumber[x]	Σ	0..1		Recommended dose number within series
doseNumberPositiveInt			positiveInt
doseNumberString			string
Slices for seriesDoses[x]		0..1		Recommended number of doses for immunity Slice: Unordered, Open by type:$this
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
seriesDoses[x]:seriesDosesPositiveInt	S	0..1	positiveInt	Recommended number of doses for immunity
supportingImmunization		0..*	Reference(Immunization - FR Immunization Document(0.1.0))	Past immunizations supporting recommendation
supportingPatientInformation		0..*	Reference(MedicationRequest - FR Medication Request Document(0.1.0))	Prescription
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
ImmunizationRecommendation.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
ImmunizationRecommendation.​recommendation.vaccineCode	Base	example	Vaccine Administered Value Set	📍4.0.1	FHIR Std.
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:cis	Base	required	ValueSet – FR ValueSet Codes vaccins CIS (BDPM)	📍0.1.0	This IG
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:translation	Base	required	ValueSet - FR ValueSet Medication Translation Document	📍0.1.0	This IG
ImmunizationRecommendation.​recommendation.targetDisease	Base	example	Immunization Recommendation Target Disease Codes	📍4.0.1	FHIR Std.
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode	Base	example	Vaccine Administered Value Set	📍4.0.1	FHIR Std.
ImmunizationRecommendation.​recommendation.forecastStatus	Base	example	Immunization Recommendation Status Codes	📍4.0.1	FHIR Std.
ImmunizationRecommendation.​recommendation.forecastReason	Base	example	Immunization Recommendation Reason Codes	📍4.0.1	FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion.​code	Base	example	Immunization Recommendation Date Criterion Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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	ImmunizationRecommendation.meta, ImmunizationRecommendation.implicitRules, ImmunizationRecommendation.language, ImmunizationRecommendation.text, ImmunizationRecommendation.extension, ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.identifier, ImmunizationRecommendation.patient, ImmunizationRecommendation.date, ImmunizationRecommendation.authority, ImmunizationRecommendation.recommendation, ImmunizationRecommendation.recommendation.extension, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.vaccineCode, ImmunizationRecommendation.recommendation.vaccineCode.extension, ImmunizationRecommendation.recommendation.vaccineCode.coding, ImmunizationRecommendation.recommendation.vaccineCode.coding:cis, ImmunizationRecommendation.recommendation.vaccineCode.coding:translation, ImmunizationRecommendation.recommendation.vaccineCode.coding:translation.extension, ImmunizationRecommendation.recommendation.vaccineCode.coding:translation.system, ImmunizationRecommendation.recommendation.vaccineCode.coding:translation.version, ImmunizationRecommendation.recommendation.vaccineCode.coding:translation.code, ImmunizationRecommendation.recommendation.vaccineCode.coding:translation.display, ImmunizationRecommendation.recommendation.vaccineCode.coding:translation.userSelected, ImmunizationRecommendation.recommendation.vaccineCode.text, ImmunizationRecommendation.recommendation.targetDisease, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode, ImmunizationRecommendation.recommendation.forecastStatus, ImmunizationRecommendation.recommendation.forecastReason, ImmunizationRecommendation.recommendation.dateCriterion, ImmunizationRecommendation.recommendation.dateCriterion.extension, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension, ImmunizationRecommendation.recommendation.dateCriterion.code, ImmunizationRecommendation.recommendation.dateCriterion.value, ImmunizationRecommendation.recommendation.description, ImmunizationRecommendation.recommendation.series, ImmunizationRecommendation.recommendation.doseNumber[x], ImmunizationRecommendation.recommendation.seriesDoses[x], ImmunizationRecommendation.recommendation.seriesDoses[x]:seriesDosesPositiveInt, ImmunizationRecommendation.recommendation.supportingImmunization, ImmunizationRecommendation.recommendation.supportingPatientInformation	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	ImmunizationRecommendation.extension, ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.recommendation.extension, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.vaccineCode.extension, ImmunizationRecommendation.recommendation.vaccineCode.coding:translation.extension, ImmunizationRecommendation.recommendation.dateCriterion.extension, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension	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()

Summary

Mandatory: 1 element(3 nested mandatory elements)
Must-Support: 3 elements

Structures

This structure refers to these other structures:

• Immunization - FR Immunization Document (https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-immunization-document|0.1.0)
• MedicationRequest - FR Medication Request Document (https://interop.esante.gouv.fr/ig/fhir/document-core/StructureDefinition/fr-medication-request-document|0.1.0)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of ImmunizationRecommendation.recommendation.vaccineCode.coding
• The element 1 is sliced based on the value of ImmunizationRecommendation.recommendation.seriesDoses[x]

Other representations of profile: CSV, Excel, Schematron