Cross-version Extension for R3.Immunization.explanation for use in FHIR R4 - Definitions - FHIR Cross-Version Extensions package for FHIR R4 from FHIR R3 v0.0.1-snapshot-2

FHIR Cross-Version Extensions package for FHIR R4 from FHIR R3 - Version 0.0.1-snapshot-2. See the Directory of published versions

Extension: Ext_R3_Immunization_explanation - Detailed Descriptions

Page standards status: Informative

Maturity Level: 0

Definitions for the ext-R3-Immunization.explanation extension.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. Extension
Definition	Reasons why a vaccine was or was not administered.
Short	Administration/non-administration reasons
Comments	`Immunization.explanation` maps to R4 `Immunization`. Has no type mapping Changed from a single value to an array (max cardinality from 1 to *). So is mapped as RelatedTo.
Control	0..1
2. Extension.extension
Control	0..*
Slicing	This element introduces a set of slices on `Extension.extension`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: value @ url
4. Extension.extension:reason
Slice Name	reason
Definition	Reasons why a vaccine was administered.
Short	Why immunization occurred
Comments	`Immunization.explanation` maps to R4 `Immunization`. Has no type mapping Changed from a single value to an array (max cardinality from 1 to *). So is mapped as RelatedTo.
Control	0..*
6. Extension.extension:reason.url
Control	1..1
Fixed Value	`reason`
8. Extension.extension:reason.value[x]
Definition	Reasons why a vaccine was administered.
Short	Why immunization occurred
Comments	`Immunization.explanation` maps to R4 `Immunization`. Has no type mapping Changed from a single value to an array (max cardinality from 1 to *). So is mapped as RelatedTo.
Binding	For example codes, see R3_immunization_reason_for_R4 (0.0.1-snapshot-2) (example to `http://hl7.org/fhir/3.0/ValueSet/R3-immunization-reason-for-R4\|0.0.1-snapshot-2`) The reason why a vaccine was administered
Type	CodeableConcept
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
10. Extension.extension:reasonNotGiven
Slice Name	reasonNotGiven
Definition	Reason why a vaccine was not administered.
Short	Why immunization did not occur
Comments	`Immunization.explanation` maps to R4 `Immunization`. Has no type mapping Changed from a single value to an array (max cardinality from 1 to *). So is mapped as RelatedTo.
Control	0..*
12. Extension.extension:reasonNotGiven.url
Control	1..1
Fixed Value	`reasonNotGiven`
14. Extension.extension:reasonNotGiven.value[x]
Definition	Reason why a vaccine was not administered.
Short	Why immunization did not occur
Comments	`Immunization.explanation` maps to R4 `Immunization`. Has no type mapping Changed from a single value to an array (max cardinality from 1 to *). So is mapped as RelatedTo.
Binding	For example codes, see R3_no_immunization_reason_for_R4 (0.0.1-snapshot-2) (example to `http://hl7.org/fhir/3.0/ValueSet/R3-no-immunization-reason-for-R4\|0.0.1-snapshot-2`) The reason why a vaccine was not administered
Type	CodeableConcept
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
16. Extension.url
Control	1..1
Fixed Value	`http://hl7.org/fhir/3.0/StructureDefinition/extension-Immunization.explanation`

Guidance on how to interpret the contents of this table can be foundhere

0. Extension
Definition	Reasons why a vaccine was or was not administered. Optional Extension Element - found in all resources.
Short	Administration/non-administration reasonsOptional Extensions Element
Comments	`Immunization.explanation` maps to R4 `Immunization`. Has no type mapping Changed from a single value to an array (max cardinality from 1 to *). So is mapped as RelatedTo.
Control	0..1* This element is affected by the following invariants: ele-1
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.extension
Definition	An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	ExtensionAdditional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing	This element introduces a set of slices on `Extension.extension`. The slices areUnordered and ClosedOpen, and can be differentiated using the following discriminators: value @ url
4. Extension.extension:reason
Slice Name	reason
Definition	Reasons why a vaccine was administered.
Short	Why immunization occurredAdditional content defined by implementations
Comments	`Immunization.explanation` maps to R4 `Immunization`. Has no type mapping Changed from a single value to an array (max cardinality from 1 to *). So is mapped as RelatedTo.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. Extension.extension:reason.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`reason`
8. Extension.extension:reason.value[x]
Definition	Reasons why a vaccine was administered. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Why immunization occurredValue of extension
Comments	`Immunization.explanation` maps to R4 `Immunization`. Has no type mapping Changed from a single value to an array (max cardinality from 1 to *). So is mapped as RelatedTo.
Control	0..1
Binding	For example codes, see For codes, see R3_immunization_reason_for_R4 (0.0.1-snapshot-2) (example to `http://hl7.org/fhir/3.0/ValueSet/R3-immunization-reason-for-R4\|0.0.1-snapshot-2`) The reason why a vaccine was administered
Type	CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Extension.extension:reasonNotGiven
Slice Name	reasonNotGiven
Definition	Reason why a vaccine was not administered.
Short	Why immunization did not occurAdditional content defined by implementations
Comments	`Immunization.explanation` maps to R4 `Immunization`. Has no type mapping Changed from a single value to an array (max cardinality from 1 to *). So is mapped as RelatedTo.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. Extension.extension:reasonNotGiven.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`reasonNotGiven`
14. Extension.extension:reasonNotGiven.value[x]
Definition	Reason why a vaccine was not administered. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Why immunization did not occurValue of extension
Comments	`Immunization.explanation` maps to R4 `Immunization`. Has no type mapping Changed from a single value to an array (max cardinality from 1 to *). So is mapped as RelatedTo.
Control	0..1
Binding	For example codes, see For codes, see R3_no_immunization_reason_for_R4 (0.0.1-snapshot-2) (example to `http://hl7.org/fhir/3.0/ValueSet/R3-no-immunization-reason-for-R4\|0.0.1-snapshot-2`) The reason why a vaccine was not administered
Type	CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`http://hl7.org/fhir/3.0/StructureDefinition/extension-Immunization.explanation`

Guidance on how to interpret the contents of this table can be foundhere

0. Extension
Definition	Reasons why a vaccine was or was not administered.
Short	Administration/non-administration reasons
Comments	`Immunization.explanation` maps to R4 `Immunization`. Has no type mapping Changed from a single value to an array (max cardinality from 1 to *). So is mapped as RelatedTo.
Control	0..1 This element is affected by the following invariants: ele-1
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
2. Extension.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
4. Extension.extension
Definition	An Extension
Short	Extension
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing	This element introduces a set of slices on `Extension.extension`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: value @ url
6. Extension.extension:reason
Slice Name	reason
Definition	Reasons why a vaccine was administered.
Short	Why immunization occurred
Comments	`Immunization.explanation` maps to R4 `Immunization`. Has no type mapping Changed from a single value to an array (max cardinality from 1 to *). So is mapped as RelatedTo.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
8. Extension.extension:reason.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
10. Extension.extension:reason.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	Additional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing	This element introduces a set of slices on `Extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
12. Extension.extension:reason.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`reason`
14. Extension.extension:reason.value[x]
Definition	Reasons why a vaccine was administered.
Short	Why immunization occurred
Comments	`Immunization.explanation` maps to R4 `Immunization`. Has no type mapping Changed from a single value to an array (max cardinality from 1 to *). So is mapped as RelatedTo.
Control	0..1
Binding	For example codes, see R3_immunization_reason_for_R4 (0.0.1-snapshot-2) (example to `http://hl7.org/fhir/3.0/ValueSet/R3-immunization-reason-for-R4\|0.0.1-snapshot-2`) The reason why a vaccine was administered
Type	CodeableConcept
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
16. Extension.extension:reasonNotGiven
Slice Name	reasonNotGiven
Definition	Reason why a vaccine was not administered.
Short	Why immunization did not occur
Comments	`Immunization.explanation` maps to R4 `Immunization`. Has no type mapping Changed from a single value to an array (max cardinality from 1 to *). So is mapped as RelatedTo.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. Extension.extension:reasonNotGiven.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
20. Extension.extension:reasonNotGiven.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	Additional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing	This element introduces a set of slices on `Extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
22. Extension.extension:reasonNotGiven.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`reasonNotGiven`
24. Extension.extension:reasonNotGiven.value[x]
Definition	Reason why a vaccine was not administered.
Short	Why immunization did not occur
Comments	`Immunization.explanation` maps to R4 `Immunization`. Has no type mapping Changed from a single value to an array (max cardinality from 1 to *). So is mapped as RelatedTo.
Control	0..1
Binding	For example codes, see R3_no_immunization_reason_for_R4 (0.0.1-snapshot-2) (example to `http://hl7.org/fhir/3.0/ValueSet/R3-no-immunization-reason-for-R4\|0.0.1-snapshot-2`) The reason why a vaccine was not administered
Type	CodeableConcept
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`http://hl7.org/fhir/3.0/StructureDefinition/extension-Immunization.explanation`
28. Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	0..1
Type	Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)