This page is part of the Immunization Decision Support Forecast FHIR IG (v0.2.0: STU 1 Ballot 2) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
Definitions for the StructureDefinition-immds-immunizationrecommendation Profile.
1. ImmunizationRecommendation | |
Definition | Defines constraints and extensions on the immunizationrecommendation resource for the minimal set of data to perform the Immunization Decision Support Forecast operation. |
Control | 0..* |
Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.div.exists()) |
2. ImmunizationRecommendation.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
3. ImmunizationRecommendation.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
4. ImmunizationRecommendation.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
5. ImmunizationRecommendation.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHOULD be taken from CommonLanguages Max Binding: AllLanguages |
Type | code |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
6. ImmunizationRecommendation.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 0..1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
7. ImmunizationRecommendation.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
8. ImmunizationRecommendation.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
9. ImmunizationRecommendation.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content |
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. |
10. ImmunizationRecommendation.identifier | |
Definition | A unique identifier assigned to this particular recommendation record. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
11. ImmunizationRecommendation.patient | |
Definition | The patient the recommendation(s) are for. |
Control | 1..1 |
Type | Reference(Patient) |
12. ImmunizationRecommendation.date | |
Definition | The date the immunization recommendation(s) were created. |
Control | 1..1 |
Type | dateTime |
13. ImmunizationRecommendation.authority | |
Definition | Indicates the authority who published the protocol (e.g. ACIP). |
Control | 0..1 |
Type | Reference(Organization) |
14. ImmunizationRecommendation.recommendation | |
Definition | Vaccine administration recommendations. |
Control | 1..* |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) imr-1: One of vaccineCode or targetDisease SHALL be present (: vaccineCode.exists() or targetDisease.exists()) |
15. ImmunizationRecommendation.recommendation.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
16. ImmunizationRecommendation.recommendation.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
17. ImmunizationRecommendation.recommendation.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
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. |
18. ImmunizationRecommendation.recommendation.vaccineCode | |
Definition | Vaccine(s) or vaccine group that pertain to the recommendation. |
Control | 0..* |
Binding | The type of vaccine administered. The codes SHALL be taken from US Core Vaccine Administered Value Set (CVX); other codes may be used where these codes are not suitable |
Type | CodeableConcept |
19. ImmunizationRecommendation.recommendation.targetDisease | |
Definition | The targeted disease for the recommendation. |
Control | 0..1 |
Binding | The disease that the recommended vaccination targets. The codes SHALL be taken from US Core Vaccine Administered Value Set (CVX); other codes may be used where these codes are not suitable |
Type | CodeableConcept |
20. ImmunizationRecommendation.recommendation.contraindicatedVaccineCode | |
Definition | Vaccine(s) which should not be used to fulfill the recommendation. |
Control | 0..* |
Binding | The type of vaccine administered. The codes SHALL be taken from US Core Vaccine Administered Value Set (CVX); other codes may be used where these codes are not suitable |
Type | CodeableConcept |
21. ImmunizationRecommendation.recommendation.forecastStatus | |
Definition | Indicates the patient status with respect to the path to immunity for the target disease. |
Control | 1..1 |
Binding | The patient's status with respect to a vaccination protocol. The codes SHALL be taken from ImmunizationRecommendationStatusCodes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Is Modifier | true |
22. ImmunizationRecommendation.recommendation.forecastReason | |
Definition | While an extensible value set is provided for this element, there is not a broadly agreed upon value set to use. Implementations will likely make extensive use of the text element within the CodeableConcept data type to convey information. |
Control | 0..* |
Binding | The reason for the patient's status with respect to a vaccination protocol. The codes SHALL be taken from ImmunizationRecommendationReasonCodes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
23. ImmunizationRecommendation.recommendation.dateCriterion | |
Definition | Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc. |
Control | 0..* |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
24. ImmunizationRecommendation.recommendation.dateCriterion.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
25. ImmunizationRecommendation.recommendation.dateCriterion.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
26. ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
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. |
27. ImmunizationRecommendation.recommendation.dateCriterion.code | |
Definition | Date classification of recommendation. For example, earliest date to give, latest date to give, etc. |
Control | 1..1 |
Binding | Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.). The codes SHALL be taken from ImmunizationRecommendationDateCriterionCodes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
28. ImmunizationRecommendation.recommendation.dateCriterion.value | |
Definition | The date whose meaning is specified by dateCriterion.code. |
Control | 1..1 |
Type | dateTime |
29. ImmunizationRecommendation.recommendation.description | |
Definition | Contains the description about the protocol under which the vaccine was administered. |
Control | 0..1 |
Type | string |
30. ImmunizationRecommendation.recommendation.series | |
Definition | One possible path to achieve presumed immunity against a disease - within the context of an authority. |
Control | 0..1 |
Type | string |
31. ImmunizationRecommendation.recommendation.doseNumber[x] | |
Definition | Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose). |
Control | 0..1 |
Type | Choice of: positiveInt, string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Comments | The use of an integer is prefered if known. A string should only be used in cases where an interger is not available (such as when documenting a recurring booster dose). |
32. ImmunizationRecommendation.recommendation.seriesDoses[x] | |
Definition | The recommended number of doses to achieve immunity. |
Control | 0..1 |
Type | Choice of: positiveInt, string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Comments | The use of an integer is prefered if known. A string should only be used in cases where an interger is not available (such as when documenting a recurring booster dose). |
33. ImmunizationRecommendation.recommendation.supportingImmunization | |
Definition | Immunization event history and/or evaluation that supports the status and recommendation. |
Control | 0..* |
Type | Reference(Immunization | ImmunizationEvaluation) |
34. ImmunizationRecommendation.recommendation.supportingPatientInformation | |
Definition | Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information. |
Control | 0..* |
Type | Reference(Resource) |