This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Definitions for the qicore-immunizationrec Profile.
ImmunizationRecommendation(QICore-ImmunizationRec) | |
Definition | A patient's point-in-time immunization and recommendation (i.e. forecasting a patient's immunization eligibility according to a published schedule) with optional supporting justification. |
Control | 0..* |
Type | ImmunizationRecommendation |
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. Bundles always have an id, though it is usually a generated UUID. |
ImmunizationRecommendation.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
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. |
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 as much as possible. |
ImmunizationRecommendation.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHALL be taken from http://tools.ietf.org/html/bcp47 |
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). |
ImmunizationRecommendation.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may 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 This element is affected by the following invariants: dom-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. |
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. |
ImmunizationRecommendation.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order 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. |
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. |
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. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
ImmunizationRecommendation.identifier | |
Definition | A unique identifier assigned to this particular recommendation record. |
Control | 0..* |
Type | Identifier |
ImmunizationRecommendation.patient | |
Definition | The patient for whom the recommendations are for. |
Control | 1..1 |
Type | Reference(QICore-Patient) |
Must Support | true |
ImmunizationRecommendation.recommendation | |
Definition | Vaccine administration recommendations. |
Control | 1..* |
Type | BackboneElement |
ImmunizationRecommendation.recommendation.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
ImmunizationRecommendation.recommendation.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
ImmunizationRecommendation.recommendation.date | |
Definition | The date the immunization recommendation was created. |
Control | 1..1 |
Type | dateTime |
Must Support | true |
ImmunizationRecommendation.recommendation.vaccineCode | |
Definition | Vaccine that pertains to the recommendation. |
Control | 1..1 |
Binding | This identifies the CVX code system The codes SHOULD be taken from Vaccine Administered Value Set |
Type | CodeableConcept |
Must Support | true |
ImmunizationRecommendation.recommendation.doseNumber | |
Definition | This indicates the next recommended dose number (e.g. dose 2 is the next recommended dose). |
Control | 0..1 |
Type | positiveInt |
Must Support | true |
Comments | May need other dose concepts such as administered vs. valid. |
ImmunizationRecommendation.recommendation.forecastStatus | |
Definition | Vaccine administration status. |
Control | 1..1 |
Binding | The patient's status with respect to a vaccination protocol For example codes, see Immunization Recommendation Status Codes |
Type | CodeableConcept |
ImmunizationRecommendation.recommendation.dateCriterion | |
Definition | Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc. |
Control | 0..* |
Type | BackboneElement |
ImmunizationRecommendation.recommendation.dateCriterion.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
ImmunizationRecommendation.recommendation.dateCriterion.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
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.) For example codes, see Immunization Recommendation Date Criterion Codes |
Type | CodeableConcept |
ImmunizationRecommendation.recommendation.dateCriterion.value | |
Definition | The date whose meaning is specified by dateCriterion.code. |
Control | 1..1 |
Type | dateTime |
ImmunizationRecommendation.recommendation.protocol | |
Definition | Contains information about the protocol under which the vaccine was administered. |
Control | 0..1 |
Type | BackboneElement |
ImmunizationRecommendation.recommendation.protocol.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
ImmunizationRecommendation.recommendation.protocol.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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. |
ImmunizationRecommendation.recommendation.protocol.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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
ImmunizationRecommendation.recommendation.protocol.doseSequence | |
Definition | Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol. |
Control | 0..1 |
Type | integer |
ImmunizationRecommendation.recommendation.protocol.description | |
Definition | Contains the description about the protocol under which the vaccine was administered. |
Control | 0..1 |
Type | string |
ImmunizationRecommendation.recommendation.protocol.authority | |
Definition | Indicates the authority who published the protocol. For example, ACIP. |
Control | 0..1 |
Type | Reference(QICore-Organization) |
ImmunizationRecommendation.recommendation.protocol.series | |
Definition | One possible path to achieve presumed immunity against a disease - within the context of an authority. |
Control | 0..1 |
Type | string |
ImmunizationRecommendation.recommendation.supportingImmunization | |
Definition | Immunization event history that supports the status and recommendation. |
Control | 0..* |
Type | Reference(QICore-Immunization) |
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 | Choice of: Reference(QICore-Observation), Reference(QICore-AllergyIntolerance) |