Schedule (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.dstu3.model.Base
- - org.hl7.fhir.dstu3.model.BaseResource
  - - org.hl7.fhir.dstu3.model.Resource
    - - org.hl7.fhir.dstu3.model.DomainResource
      - org.hl7.fhir.dstu3.model.Schedule

All Implemented Interfaces:

IElement, Serializable, IAnyResource, IBase, IBaseHasExtensions, IBaseHasModifierExtensions, IBaseResource, IDomainResource
```
public class Schedule
extends DomainResource
```
A container for slots of time that may be available for booking appointments.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected BooleanType`	`active` Whether this schedule record is in active use, or should not be used (such as was entered in error).
`static TokenClientParam`	`ACTIVE` Fluent Client search parameter constant for active
`protected List<Reference>`	`actor` The resource this Schedule resource is providing availability information for.
`static ReferenceClientParam`	`ACTOR` Fluent Client search parameter constant for actor
`protected List<Resource>`	`actorTarget` The actual objects that are the target of the reference (The resource this Schedule resource is providing availability information for.
`protected StringType`	`comment` Comments on the availability to describe any extended information.
`static DateClientParam`	`DATE` Fluent Client search parameter constant for date
`protected List<Identifier>`	`identifier` External Ids for this item.
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_ACTOR` Constant for fluent queries to be used to add include statements.
`protected Period`	`planningHorizon` The period of time that the slots that are attached to this Schedule resource cover (even if none exist).
`protected CodeableConcept`	`serviceCategory` A broad categorisation of the service that is to be performed during this appointment.
`protected List<CodeableConcept>`	`serviceType` The specific service that is to be performed during this appointment.
`static String`	`SP_ACTIVE` Search parameter: active
`static String`	`SP_ACTOR` Search parameter: actor
`static String`	`SP_DATE` Search parameter: date
`static String`	`SP_IDENTIFIER` Search parameter: identifier
`static String`	`SP_TYPE` Search parameter: type
`protected List<CodeableConcept>`	`specialty` The specialty of a practitioner that would be required to perform the service requested in this appointment.
`static TokenClientParam`	`TYPE` Fluent Client search parameter constant for type

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description

Schedule()
Constructor

Constructors
Constructor and Description
`Schedule()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Reference`	`addActor()`
`Schedule`	`addActor(Reference t)`
`Base`	`addChild(String name)`
`Identifier`	`addIdentifier()`
`Schedule`	`addIdentifier(Identifier t)`
`CodeableConcept`	`addServiceType()`
`Schedule`	`addServiceType(CodeableConcept t)`
`CodeableConcept`	`addSpecialty()`
`Schedule`	`addSpecialty(CodeableConcept t)`
`Schedule`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`boolean`	`getActive()`
`BooleanType`	`getActiveElement()`
`List<Reference>`	`getActor()`
`Reference`	`getActorFirstRep()`
`List<Resource>`	`getActorTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`String`	`getComment()`
`StringType`	`getCommentElement()`
`List<Identifier>`	`getIdentifier()`
`Identifier`	`getIdentifierFirstRep()`
`Period`	`getPlanningHorizon()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`ResourceType`	`getResourceType()`
`CodeableConcept`	`getServiceCategory()`
`List<CodeableConcept>`	`getServiceType()`
`CodeableConcept`	`getServiceTypeFirstRep()`
`List<CodeableConcept>`	`getSpecialty()`
`CodeableConcept`	`getSpecialtyFirstRep()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasActive()`
`boolean`	`hasActiveElement()`
`boolean`	`hasActor()`
`boolean`	`hasComment()`
`boolean`	`hasCommentElement()`
`boolean`	`hasIdentifier()`
`boolean`	`hasPlanningHorizon()`
`boolean`	`hasServiceCategory()`
`boolean`	`hasServiceType()`
`boolean`	`hasSpecialty()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`Schedule`	`setActive(boolean value)`
`Schedule`	`setActiveElement(BooleanType value)`
`Schedule`	`setActor(List<Reference> theActor)`
`Schedule`	`setComment(String value)`
`Schedule`	`setCommentElement(StringType value)`
`Schedule`	`setIdentifier(List<Identifier> theIdentifier)`
`Schedule`	`setPlanningHorizon(Period value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`Schedule`	`setServiceCategory(CodeableConcept value)`
`Schedule`	`setServiceType(List<CodeableConcept> theServiceType)`
`Schedule`	`setSpecialty(List<CodeableConcept> theSpecialty)`
`protected Schedule`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - identifier
```
protected List<Identifier> identifier
```
    External Ids for this item.
  - active
```
protected BooleanType active
```
    Whether this schedule record is in active use, or should not be used (such as was entered in error).
  - serviceCategory
```
protected CodeableConcept serviceCategory
```
    A broad categorisation of the service that is to be performed during this appointment.
  - serviceType
```
protected List<CodeableConcept> serviceType
```
    The specific service that is to be performed during this appointment.
  - specialty
```
protected List<CodeableConcept> specialty
```
    The specialty of a practitioner that would be required to perform the service requested in this appointment.
  - actor
```
protected List<Reference> actor
```
    The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson.
  - actorTarget
```
protected List<Resource> actorTarget
```
    The actual objects that are the target of the reference (The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson.)
  - planningHorizon
```
protected Period planningHorizon
```
    The period of time that the slots that are attached to 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.
  - comment
```
protected StringType comment
```
    Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.
  - SP_ACTOR
```
public static final String SP_ACTOR
```
    Search parameter: actor
    Description: The individual(HealthcareService, Practitioner, Location, ...) to find a Schedule for
    Type: reference
    Path: Schedule.actor
    
    See Also:
    
    Constant Field Values
  - ACTOR
```
public static final ReferenceClientParam ACTOR
```
    Fluent Client search parameter constant for actor
    Description: The individual(HealthcareService, Practitioner, Location, ...) to find a Schedule for
    Type: reference
    Path: Schedule.actor
  - INCLUDE_ACTOR
```
public static final Include INCLUDE_ACTOR
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Schedule:actor".
  - SP_DATE
```
public static final String SP_DATE
```
    Search parameter: date
    Description: Search for Schedule resources that have a period that contains this date specified
    Type: date
    Path: Schedule.planningHorizon
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description: Search for Schedule resources that have a period that contains this date specified
    Type: date
    Path: Schedule.planningHorizon
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter: identifier
    Description: A Schedule Identifier
    Type: token
    Path: Schedule.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: A Schedule Identifier
    Type: token
    Path: Schedule.identifier
  - SP_ACTIVE
```
public static final String SP_ACTIVE
```
    Search parameter: active
    Description: Is the schedule in active use
    Type: token
    Path: Schedule.active
    
    See Also:
    
    Constant Field Values
  - ACTIVE
```
public static final TokenClientParam ACTIVE
```
    Fluent Client search parameter constant for active
    Description: Is the schedule in active use
    Type: token
    Path: Schedule.active
  - SP_TYPE
```
public static final String SP_TYPE
```
    Search parameter: type
    Description: The type of appointments that can be booked into associated slot(s)
    Type: token
    Path: Schedule.serviceType
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final TokenClientParam TYPE
```
    Fluent Client search parameter constant for type
    Description: The type of appointments that can be booked into associated slot(s)
    Type: token
    Path: Schedule.serviceType
- Constructor Detail
  - Schedule
```
public Schedule()
```
    Constructor
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (External Ids for this item.)
  - setIdentifier
```
public Schedule setIdentifier(List<Identifier> theIdentifier)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
  - addIdentifier
```
public Schedule addIdentifier(Identifier t)
```
  - getIdentifierFirstRep
```
public Identifier getIdentifierFirstRep()
```
    Returns:
    
    The first repetition of repeating field identifier, creating it if it does not already exist
  - getActiveElement
```
public BooleanType getActiveElement()
```
    Returns:
    
    active (Whether this schedule record is in active use, or should not be used (such as was entered in error).). This is the underlying object with id, value and extensions. The accessor "getActive" gives direct access to the value
  - hasActiveElement
```
public boolean hasActiveElement()
```
  - hasActive
```
public boolean hasActive()
```
  - setActiveElement
```
public Schedule setActiveElement(BooleanType value)
```
    Parameters:
    
    value - active (Whether this schedule record is in active use, or should not be used (such as was entered in error).). This is the underlying object with id, value and extensions. The accessor "getActive" gives direct access to the value
  - getActive
```
public boolean getActive()
```
    Returns:
    
    Whether this schedule record is in active use, or should not be used (such as was entered in error).
  - setActive
```
public Schedule setActive(boolean value)
```
    Parameters:
    
    value - Whether this schedule record is in active use, or should not be used (such as was entered in error).
  - getServiceCategory
```
public CodeableConcept getServiceCategory()
```
    Returns:
    
    serviceCategory (A broad categorisation of the service that is to be performed during this appointment.)
  - hasServiceCategory
```
public boolean hasServiceCategory()
```
  - setServiceCategory
```
public Schedule setServiceCategory(CodeableConcept value)
```
    Parameters:
    
    value - serviceCategory (A broad categorisation of the service that is to be performed during this appointment.)
  - getServiceType
```
public List<CodeableConcept> getServiceType()
```
    Returns:
    
    serviceType (The specific service that is to be performed during this appointment.)
  - setServiceType
```
public Schedule setServiceType(List<CodeableConcept> theServiceType)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasServiceType
```
public boolean hasServiceType()
```
  - addServiceType
```
public CodeableConcept addServiceType()
```
  - addServiceType
```
public Schedule addServiceType(CodeableConcept t)
```
  - getServiceTypeFirstRep
```
public CodeableConcept getServiceTypeFirstRep()
```
    Returns:
    
    The first repetition of repeating field serviceType, creating it if it does not already exist
  - getSpecialty
```
public List<CodeableConcept> getSpecialty()
```
    Returns:
    
    specialty (The specialty of a practitioner that would be required to perform the service requested in this appointment.)
  - setSpecialty
```
public Schedule setSpecialty(List<CodeableConcept> theSpecialty)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasSpecialty
```
public boolean hasSpecialty()
```
  - addSpecialty
```
public CodeableConcept addSpecialty()
```
  - addSpecialty
```
public Schedule addSpecialty(CodeableConcept t)
```
  - getSpecialtyFirstRep
```
public CodeableConcept getSpecialtyFirstRep()
```
    Returns:
    
    The first repetition of repeating field specialty, creating it if it does not already exist
  - getActor
```
public List<Reference> getActor()
```
    Returns:
    
    actor (The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson.)
  - setActor
```
public Schedule setActor(List<Reference> theActor)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasActor
```
public boolean hasActor()
```
  - addActor
```
public Reference addActor()
```
  - addActor
```
public Schedule addActor(Reference t)
```
  - getActorFirstRep
```
public Reference getActorFirstRep()
```
    Returns:
    
    The first repetition of repeating field actor, creating it if it does not already exist
  - getActorTarget
```
@Deprecated
public List<Resource> getActorTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - getPlanningHorizon
```
public Period getPlanningHorizon()
```
    Returns:
    
    planningHorizon (The period of time that the slots that are attached to 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.)
  - hasPlanningHorizon
```
public boolean hasPlanningHorizon()
```
  - setPlanningHorizon
```
public Schedule setPlanningHorizon(Period value)
```
    Parameters:
    
    value - planningHorizon (The period of time that the slots that are attached to 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.)
  - getCommentElement
```
public StringType getCommentElement()
```
    Returns:
    
    comment (Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the value
  - hasCommentElement
```
public boolean hasCommentElement()
```
  - hasComment
```
public boolean hasComment()
```
  - setCommentElement
```
public Schedule setCommentElement(StringType value)
```
    Parameters:
    
    value - comment (Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the value
  - getComment
```
public String getComment()
```
    Returns:
    
    Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.
  - setComment
```
public Schedule setComment(String value)
```
    Parameters:
    
    value - Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class DomainResource
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws FHIRException
```
    Overrides:
    
    getProperty in class DomainResource
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws FHIRException
```
    Overrides:
    
    makeProperty in class DomainResource
    
    Throws:
    
    FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws FHIRException
```
    Overrides:
    
    getTypesForProperty in class DomainResource
    
    Throws:
    
    FHIRException
  - addChild
```
public Base addChild(String name)
              throws FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    Throws:
    
    FHIRException
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public Schedule copy()
```
    Specified by:
    
    copy in class DomainResource
  - typedCopy
```
protected Schedule typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class Schedule

Field Summary

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource

Fields inherited from class org.hl7.fhir.dstu3.model.Resource

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource

Methods inherited from class org.hl7.fhir.dstu3.model.Resource

Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource

Methods inherited from class org.hl7.fhir.dstu3.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Field Detail

identifier

active

serviceCategory

serviceType

specialty

actor

actorTarget

planningHorizon

comment

SP_ACTOR

ACTOR

INCLUDE_ACTOR

SP_DATE

DATE

SP_IDENTIFIER

IDENTIFIER

SP_ACTIVE

ACTIVE

SP_TYPE

TYPE

Constructor Detail

Schedule

Method Detail

getIdentifier

setIdentifier

hasIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getActiveElement

hasActiveElement

hasActive

setActiveElement

getActive

setActive

getServiceCategory

hasServiceCategory

setServiceCategory

getServiceType

setServiceType

hasServiceType

addServiceType

addServiceType

getServiceTypeFirstRep

getSpecialty

setSpecialty

hasSpecialty

addSpecialty

addSpecialty

getSpecialtyFirstRep

getActor

setActor

hasActor

addActor

addActor

getActorFirstRep

getActorTarget

getPlanningHorizon

hasPlanningHorizon

setPlanningHorizon

getCommentElement

hasCommentElement

hasComment