Data Model Libraries
    Preparing search index...

    Class ImmunizationProtocolAppliedComponent

    ImmunizationProtocolAppliedComponent Class

    FHIR Specification

    • Short: Protocol followed by the provider
    • Definition: The protocol (set of recommendations) being followed by the provider who administered the dose.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    series?: StringType

    Immunization.protocolApplied.series Element

    FHIR Specification

    • Short: Name of vaccine 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
    authority?: Reference

    Immunization.protocolApplied.authority Element

    FHIR Specification

    • Short: Who is responsible for publishing the recommendations
    • Definition: Indicates the authority who published the protocol (e.g. ACIP) that is being followed.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    targetDisease?: CodeableConcept[]

    Immunization.protocolApplied.targetDisease Element

    FHIR Specification

    • Short: Vaccine preventatable disease being targetted
    • Definition: The vaccine preventable disease the dose is being administered against.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    doseNumber: null | IDataType

    Immunization.protocolApplied.doseNumber[x] Element

    @ChoiceDataTypesMeta('Immunization.protocolApplied.doseNumber[x]', ['positiveInt','string',]

    FHIR Specification

    • Short: Dose number within series
    • Definition: Nominal position in a series.
    • 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 Types: 'positiveInt', 'string',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    seriesDoses?: IDataType

    Immunization.protocolApplied.seriesDoses[x] Element

    @ChoiceDataTypesMeta('Immunization.protocolApplied.seriesDoses[x]', ['positiveInt','string',]

    FHIR Specification

    • Short: Recommended number of doses for immunity
    • Definition: The recommended number of doses to achieve immunity.
    • 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 Types: 'positiveInt', 'string',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ImmunizationProtocolAppliedComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ImmunizationProtocolAppliedComponent

      ImmunizationProtocolAppliedComponent data model or undefined for ImmunizationProtocolAppliedComponent

      JsonError if the provided JSON is not a valid JSON object

    • 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