Data Model Libraries
    Preparing search index...

    ImmunizationEducationComponent Class

    FHIR Specification

    • Short: Educational material presented to patient
    • Definition: Educational material presented to the patient (or guardian) at the time of vaccine administration.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    documentType?: StringType

    Immunization.education.documentType Element

    FHIR Specification

    • Short: Educational material document identifier
    • Definition: Identifier of the material presented to the patient.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    reference?: UriType

    Immunization.education.reference Element

    FHIR Specification

    • Short: Educational material reference pointer
    • Definition: Reference pointer to the educational material given to the patient if the information was on line.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    publicationDate?: DateTimeType

    Immunization.education.publicationDate Element

    FHIR Specification

    • Short: Educational material publication date
    • Definition: Date the educational material was published.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    presentationDate?: DateTimeType

    Immunization.education.presentationDate Element

    FHIR Specification

    • Short: Educational material presentation date
    • Definition: Date the educational material was given to the patient.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ImmunizationEducationComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ImmunizationEducationComponent

      ImmunizationEducationComponent data model or undefined for ImmunizationEducationComponent

      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 and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

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