Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions

• Content
• Detailed Descriptions
• XML
• JSON
• TTL

Resource Profile: Profile_R5_ImmunizationRecommendation_R4

This cross-version profile allows R5 ImmunizationRecommendation content to be represented via FHIR R4 ImmunizationRecommendation resources.

Usages:

• Refer to this Profile: R5: Reason this appointment is scheduled additional types, R5: Workflow authorization within which this event occurred (new), R5: Reason the encounter takes place (core or reference) additional types, R5: Authority that the immunization event is based on (new) and R5: Workflow authorization within which this event occurred (new)

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
patient	Σ	1..1	Reference(Patient)	Who this profile is for
date	Σ	1..1	dateTime	Date recommendation(s) created
recommendation	ΣC	1..*	BackboneElement	Vaccine administration recommendations Constraints: imr-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
forecastStatus	?!Σ	1..1	CodeableConcept	Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
ImmunizationRecommendation.​recommendation.forecastStatus	Base	example	Immunization Recommendation Status 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.patient, ImmunizationRecommendation.date, ImmunizationRecommendation.recommendation, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.forecastStatus	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.recommendation.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()

This structure is derived from ImmunizationRecommendation

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ImmunizationRecommendation		0..*	ImmunizationRecommendation(4.0.1)	Guidance or advice relating to an immunization
Documentation for this format

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	Business identifier
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..*	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	Σ	0..*	CodeableConcept	Vaccine or vaccine group recommendation applies to Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
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.
forecastReason	Σ	0..*	CodeableConcept	Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.
dateCriterion		0..*	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	Recommended date
description		0..1	string	Protocol details
series		0..1	string	Name of vaccination series
doseNumber[x]	Σ	0..1		Recommended dose number within series
doseNumberPositiveInt			positiveInt
doseNumberString			string
seriesDoses[x]		0..1		Recommended number of doses for immunity
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
supportingImmunization		0..*	Reference(Immunization | ImmunizationEvaluation)	Past immunizations supporting recommendation
supportingPatientInformation		0..*	Reference(Resource)	Patient observations supporting recommendation
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
ImmunizationRecommendation.​language	Base	preferred	Common Languages	📍4.0.1	tx.fhir.org
ImmunizationRecommendation.​recommendation.vaccineCode	Base	example	Vaccine Administered Value Set	📍4.0.1	FHIR Std.
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.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.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.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()

This structure is derived from ImmunizationRecommendation

Summary

Maturity: 0

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
patient	Σ	1..1	Reference(Patient)	Who this profile is for
date	Σ	1..1	dateTime	Date recommendation(s) created
recommendation	ΣC	1..*	BackboneElement	Vaccine administration recommendations Constraints: imr-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
forecastStatus	?!Σ	1..1	CodeableConcept	Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
ImmunizationRecommendation.​recommendation.forecastStatus	Base	example	Immunization Recommendation Status 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.patient, ImmunizationRecommendation.date, ImmunizationRecommendation.recommendation, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.forecastStatus	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.recommendation.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

This structure is derived from ImmunizationRecommendation

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ImmunizationRecommendation		0..*	ImmunizationRecommendation(4.0.1)	Guidance or advice relating to an immunization
Documentation for this format

Snapshot View

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	Business identifier
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..*	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	Σ	0..*	CodeableConcept	Vaccine or vaccine group recommendation applies to Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
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.
forecastReason	Σ	0..*	CodeableConcept	Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.
dateCriterion		0..*	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	Recommended date
description		0..1	string	Protocol details
series		0..1	string	Name of vaccination series
doseNumber[x]	Σ	0..1		Recommended dose number within series
doseNumberPositiveInt			positiveInt
doseNumberString			string
seriesDoses[x]		0..1		Recommended number of doses for immunity
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
supportingImmunization		0..*	Reference(Immunization | ImmunizationEvaluation)	Past immunizations supporting recommendation
supportingPatientInformation		0..*	Reference(Resource)	Patient observations supporting recommendation
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
ImmunizationRecommendation.​language	Base	preferred	Common Languages	📍4.0.1	tx.fhir.org
ImmunizationRecommendation.​recommendation.vaccineCode	Base	example	Vaccine Administered Value Set	📍4.0.1	FHIR Std.
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.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.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.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()

This structure is derived from ImmunizationRecommendation

Summary

Maturity: 0

Other representations of profile: CSV, Excel, Schematron