Data Model Libraries
    Preparing search index...

    Class VisionPrescription

    VisionPrescription Class

    An authorization for the provision of glasses and/or contact lenses to a patient.

    FHIR Specification

    • Short: Prescription for vision correction products for a patient
    • Definition: An authorization for the provision of glasses and/or contact lenses to a patient.
    • FHIR Version: 4.3.0

    FHIR VisionPrescription

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? fmStatusEnum status created patient encounter? dateWritten prescriber lensSpecification

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getCreatedElement setCreatedElement hasCreatedElement getCreated setCreated hasCreated getPatient setPatient hasPatient getEncounter setEncounter hasEncounter getDateWrittenElement setDateWrittenElement hasDateWrittenElement getDateWritten setDateWritten hasDateWritten getPrescriber setPrescriber hasPrescriber getLensSpecification setLensSpecification addLensSpecification hasLensSpecification fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initLensSpecification

    Constructors

    Properties

    identifier?: Identifier[]

    VisionPrescription.identifier Element

    FHIR Specification

    • Short: Business Identifier for vision prescription
    • Definition: A unique identifier assigned to this vision prescription.
    • Requirements: Allows vision prescriptions to be distinguished and referenced.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    fmStatusEnum: FmStatusEnum

    FHIR CodeSystem: FmStatus

    FmStatusEnum

    status: null | EnumCodeType

    VisionPrescription.status Element

    FHIR Specification

    • Short: active | cancelled | draft | entered-in-error
    • Definition: The status of the resource instance.
    • Comment: This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
    • Requirements: Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: FmStatusEnum

    created: null | DateTimeType

    VisionPrescription.created Element

    FHIR Specification

    • Short: Response creation date
    • Definition: The date this resource was created.
    • Requirements: Need to record a timestamp for use by both the recipient and the issuer.
    • FHIR Type: dateTime
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    patient: null | Reference

    VisionPrescription.patient Element

    FHIR Specification

    • Short: Who prescription is for
    • Definition: A resource reference to the person to whom the vision prescription applies.
    • Requirements: Needed to identify the patient for whom the vision prescription has been issued.
    • FHIR Type: Reference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    encounter?: Reference

    VisionPrescription.encounter Element

    FHIR Specification

    • Short: Created during encounter / admission / stay
    • Definition: A reference to a resource that identifies the particular occurrence of contact between patient and health care provider during which the prescription was issued.
    • Requirements: Used in some jurisdictions to link clinical events to claim items.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    dateWritten: null | DateTimeType

    VisionPrescription.dateWritten Element

    FHIR Specification

    • Short: When prescription was authorized
    • Definition: The date (and perhaps time) when the prescription was written.
    • Comment: Jurisdictions determine the valid lifetime of a prescription. Typically vision prescriptions are valid for two years from the date written.
    • Requirements: Need to record a timestamp for use by both the recipient and the issuer.
    • FHIR Type: dateTime
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    prescriber: null | Reference

    VisionPrescription.prescriber Element

    FHIR Specification

    lensSpecification: null | VisionPrescriptionLensSpecificationComponent[]

    VisionPrescription.lensSpecification Element

    FHIR Specification

    • Short: Vision lens authorization
    • Definition: Contain the details of the individual lens specifications and serves as the authorization for the fullfillment by certified professionals.
    • FHIR Type: BackboneElement
    • Cardinality: 1..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR VisionPrescription

      • OptionaloptSourceField: string

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

      Returns undefined | VisionPrescription

      VisionPrescription data model or undefined for VisionPrescription

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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

    • 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

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetCreatedElementsetCreatedElementhasCreatedElementgetCreatedsetCreatedhasCreatedgetPatientsetPatienthasPatientgetEncountersetEncounterhasEncountergetDateWrittenElementsetDateWrittenElementhasDateWrittenElementgetDateWrittensetDateWrittenhasDateWrittengetPrescribersetPrescriberhasPrescribergetLensSpecificationsetLensSpecificationaddLensSpecificationhasLensSpecificationfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitLensSpecification