Data Model Libraries
    Preparing search index...

    Class Schedule

    Schedule Class

    A container for slots of time that may be available for booking appointments.

    FHIR Specification

    • Short: A container for slots of time that may be available for booking appointments
    • Definition: A container for slots of time that may be available for booking appointments.
    • FHIR Version: 4.3.0

    FHIR Schedule

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? active? serviceCategory? serviceType? specialty? actor planningHorizon? comment?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getActiveElement setActiveElement hasActiveElement getActive setActive hasActive getServiceCategory setServiceCategory addServiceCategory hasServiceCategory getServiceType setServiceType addServiceType hasServiceType getSpecialty setSpecialty addSpecialty hasSpecialty getActor setActor addActor hasActor getPlanningHorizon setPlanningHorizon hasPlanningHorizon getCommentElement setCommentElement hasCommentElement getComment setComment hasComment 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 initServiceCategory initServiceType initSpecialty initActor

    Constructors

    Properties

    identifier?: Identifier[]

    Schedule.identifier Element

    FHIR Specification

    • Short: External Ids for this item
    • Definition: External Ids for this item.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    active?: BooleanType

    Schedule.active Element

    FHIR Specification

    • Short: Whether this schedule is in active use
    • Definition: Whether this schedule record is in active use or should not be used (such as was entered in error).
    • Comment: This element is labeled as a modifier because it may be used to mark that the resource was created in error.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
    • isSummary: true
    serviceCategory?: CodeableConcept[]

    Schedule.serviceCategory Element

    FHIR Specification

    • Short: High-level category
    • Definition: A broad categorization of the service that is to be performed during this appointment.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    serviceType?: CodeableConcept[]

    Schedule.serviceType Element

    FHIR Specification

    • Short: Specific service
    • Definition: The specific service that is to be performed during this appointment.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    specialty?: CodeableConcept[]

    Schedule.specialty Element

    FHIR Specification

    • Short: Type of specialty needed
    • Definition: The specialty of a practitioner that would be required to perform the service requested in this appointment.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    actor: null | Reference[]

    Schedule.actor Element

    FHIR Specification

    planningHorizon?: Period

    Schedule.planningHorizon Element

    FHIR Specification

    • Short: Period of time covered by schedule
    • Definition: The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    comment?: StringType

    Schedule.comment Element

    FHIR Specification

    • Short: Comments on availability
    • Definition: Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR Schedule

      • OptionaloptSourceField: string

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

      Returns undefined | Schedule

      Schedule data model or undefined for Schedule

      JsonError if the provided JSON is not a valid JSON object

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

      Parameters

      • value: undefined | null | Reference[]

        the actor array value

      Returns this

      this

      @ReferenceTargets('Schedule.actor', ['Patient','Practitioner','PractitionerRole','RelatedPerson','Device','HealthcareService','Location',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the actor array property.

      Parameters

      Returns this

      this

      @ReferenceTargets('Schedule.actor', ['Patient','Practitioner','PractitionerRole','RelatedPerson','Device','HealthcareService','Location',])

      InvalidTypeError for invalid data type or reference value

    • 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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetActiveElementsetActiveElementhasActiveElementgetActivesetActivehasActivegetServiceCategorysetServiceCategoryaddServiceCategoryhasServiceCategorygetServiceTypesetServiceTypeaddServiceTypehasServiceTypegetSpecialtysetSpecialtyaddSpecialtyhasSpecialtygetActorsetActoraddActorhasActorgetPlanningHorizonsetPlanningHorizonhasPlanningHorizongetCommentElementsetCommentElementhasCommentElementgetCommentsetCommenthasCommentfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitServiceCategoryinitServiceTypeinitSpecialtyinitActor