Data Model Libraries
    Preparing search index...

    Class ImmunizationRecommendationRecommendationComponent

    ImmunizationRecommendationRecommendationComponent Class

    FHIR Specification

    • Short: Vaccine administration recommendations
    • Definition: Vaccine administration recommendations.
    • Comment: A given instance of the .recommendation backbone element should correspond to a single recommended administration.

    FHIR ImmunizationRecommendation

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    vaccineCode? targetDisease? contraindicatedVaccineCode? forecastStatus forecastReason? dateCriterion? description? series? doseNumber? seriesDoses? supportingImmunization? supportingPatientInformation?

    Methods

    parse getVaccineCode setVaccineCode addVaccineCode hasVaccineCode getTargetDisease setTargetDisease addTargetDisease hasTargetDisease getContraindicatedVaccineCode setContraindicatedVaccineCode addContraindicatedVaccineCode hasContraindicatedVaccineCode getForecastStatus setForecastStatus hasForecastStatus getForecastReason setForecastReason addForecastReason hasForecastReason getDateCriterion setDateCriterion addDateCriterion hasDateCriterion getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getSeriesElement setSeriesElement hasSeriesElement getSeries setSeries hasSeries getDoseNumberElement setDoseNumberElement hasDoseNumberElement getDoseNumber setDoseNumber hasDoseNumber getSeriesDosesElement setSeriesDosesElement hasSeriesDosesElement getSeriesDoses setSeriesDoses hasSeriesDoses getSupportingImmunization setSupportingImmunization addSupportingImmunization hasSupportingImmunization getSupportingPatientInformation setSupportingPatientInformation addSupportingPatientInformation hasSupportingPatientInformation fhirType isEmpty isRequiredFieldsEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initVaccineCode initTargetDisease initContraindicatedVaccineCode initForecastReason initDateCriterion initSupportingImmunization initSupportingPatientInformation

    Constructors

    Properties

    vaccineCode?: CodeableConcept[]

    ImmunizationRecommendation.recommendation.vaccineCode Element

    FHIR Specification

    • Short: Vaccine or vaccine group recommendation applies to
    • Definition: Vaccine(s) or vaccine group that pertain to the recommendation.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    targetDisease?: CodeableConcept[]

    ImmunizationRecommendation.recommendation.targetDisease Element

    FHIR Specification

    • Short: Disease to be immunized against
    • Definition: The targeted disease for the recommendation.
    • Comment: A given instance of the .recommendation backbone element should correspond to a single recommended administration but sometimes that administration (e.g. MMR) will encompass multiple diseases, thus the targetDisease element is allowed to repeat.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    contraindicatedVaccineCode?: CodeableConcept[]

    ImmunizationRecommendation.recommendation.contraindicatedVaccineCode Element

    FHIR Specification

    • Short: Vaccine which is contraindicated to fulfill the recommendation
    • Definition: Vaccine(s) which should not be used to fulfill the recommendation.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    forecastStatus: null | CodeableConcept

    ImmunizationRecommendation.recommendation.forecastStatus Element

    FHIR Specification

    • Short: Vaccine recommendation status
    • Definition: Indicates the patient status with respect to the path to immunity for the target disease.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labeled as a modifier because the forecastStatus indicates whether a patient needs additional doses (due, overdue, etc.) or not (contraindicated, complete, etc.).
    • isSummary: true
    forecastReason?: CodeableConcept[]

    ImmunizationRecommendation.recommendation.forecastReason Element

    FHIR Specification

    • Short: Vaccine administration status reason
    • Definition: The reason for the assigned forecast status.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    dateCriterion?: ImmunizationRecommendationRecommendationDateCriterionComponent[]

    ImmunizationRecommendation.recommendation.dateCriterion Element

    FHIR Specification

    • Short: Dates governing proposed immunization
    • Definition: Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    description?: MarkdownType

    ImmunizationRecommendation.recommendation.description Element

    FHIR Specification

    • Short: Protocol details
    • Definition: Contains the description about the protocol under which the vaccine was administered.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    series?: StringType

    ImmunizationRecommendation.recommendation.series Element

    FHIR Specification

    • Short: Name of vaccination series
    • Definition: One possible path to achieve presumed immunity against a disease - within the context of an authority.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    doseNumber?: StringType

    ImmunizationRecommendation.recommendation.doseNumber Element

    FHIR Specification

    • Short: Recommended dose number within series
    • Definition: Nominal position of the recommended dose in a series as determined by the evaluation and forecasting process (e.g. dose 2 is the next recommended dose).
    • Comment: The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    seriesDoses?: StringType

    ImmunizationRecommendation.recommendation.seriesDoses Element

    FHIR Specification

    • Short: Recommended number of doses for immunity
    • Definition: The recommended number of doses to achieve immunity as determined by the evaluation and forecasting process.
    • Comment: The use of an integer is preferred if known.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    supportingImmunization?: Reference[]

    ImmunizationRecommendation.recommendation.supportingImmunization Element

    FHIR Specification

    supportingPatientInformation?: Reference[]

    ImmunizationRecommendation.recommendation.supportingPatientInformation Element

    FHIR Specification

    • Short: Patient observations supporting recommendation
    • Definition: Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided ImmunizationRecommendationRecommendationComponent JSON to instantiate the ImmunizationRecommendationRecommendationComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR ImmunizationRecommendationRecommendationComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ImmunizationRecommendationRecommendationComponent

      Returns undefined | ImmunizationRecommendationRecommendationComponent

      ImmunizationRecommendationRecommendationComponent data model or undefined for ImmunizationRecommendationRecommendationComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the supportingImmunization property.

      Parameters

      • value: undefined | Reference[]

        the supportingImmunization array value

      Returns this

      this

      @ReferenceTargets('ImmunizationRecommendation.recommendation.supportingImmunization', ['Immunization','ImmunizationEvaluation',])

      InvalidTypeError for invalid data type or reference value

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetVaccineCodesetVaccineCodeaddVaccineCodehasVaccineCodegetTargetDiseasesetTargetDiseaseaddTargetDiseasehasTargetDiseasegetContraindicatedVaccineCodesetContraindicatedVaccineCodeaddContraindicatedVaccineCodehasContraindicatedVaccineCodegetForecastStatussetForecastStatushasForecastStatusgetForecastReasonsetForecastReasonaddForecastReasonhasForecastReasongetDateCriterionsetDateCriterionaddDateCriterionhasDateCriteriongetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetSeriesElementsetSeriesElementhasSeriesElementgetSeriessetSerieshasSeriesgetDoseNumberElementsetDoseNumberElementhasDoseNumberElementgetDoseNumbersetDoseNumberhasDoseNumbergetSeriesDosesElementsetSeriesDosesElementhasSeriesDosesElementgetSeriesDosessetSeriesDoseshasSeriesDosesgetSupportingImmunizationsetSupportingImmunizationaddSupportingImmunizationhasSupportingImmunizationgetSupportingPatientInformationsetSupportingPatientInformationaddSupportingPatientInformationhasSupportingPatientInformationfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensiongetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitVaccineCodeinitTargetDiseaseinitContraindicatedVaccineCodeinitForecastReasoninitDateCriterioninitSupportingImmunizationinitSupportingPatientInformation