Schedule (HAPI FHIR Structures - HL7.org DSTU2 1.3 API)

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

All Implemented Interfaces:

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

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String SP_ACTOR

static String SP_DATE

static String SP_IDENTIFIER

static String SP_TYPE

Fields
Modifier and Type	Field and Description
`static String`	`SP_ACTOR`
`static String`	`SP_DATE`
`static String`	`SP_IDENTIFIER`
`static String`	`SP_TYPE`

Constructor Summary

Constructors
Constructor and Description

Schedule()

Schedule(Reference actor)

Constructors
Constructor and Description
`Schedule()`
`Schedule(Reference actor)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Identifier`	`addIdentifier()`
`Schedule`	`addIdentifier(Identifier t)`
`CodeableConcept`	`addType()`
`Schedule`	`addType(CodeableConcept t)`
`Schedule`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`Reference`	`getActor()`
`Resource`	`getActorTarget()`
`String`	`getComment()`
`StringType`	`getCommentElement()`
`List<Identifier>`	`getIdentifier()`
`Period`	`getPlanningHorizon()`
`ResourceType`	`getResourceType()`
`List<CodeableConcept>`	`getType()`
`boolean`	`hasActor()`
`boolean`	`hasComment()`
`boolean`	`hasCommentElement()`
`boolean`	`hasIdentifier()`
`boolean`	`hasPlanningHorizon()`
`boolean`	`hasType()`
`boolean`	`isEmpty()`
`Schedule`	`setActor(Reference value)`
`Schedule`	`setActorTarget(Resource value)`
`Schedule`	`setComment(String value)`
`Schedule`	`setCommentElement(StringType value)`
`Schedule`	`setPlanningHorizon(Period value)`

Methods inherited from class org.hl7.fhir.instance.model.DomainResource
addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

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

Methods inherited from class org.hl7.fhir.instance.model.BaseResource
setId

Methods inherited from class org.hl7.fhir.instance.model.Base
children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasUserData, listChildrenByName, setUserData, setUserDataINN

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

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

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

- Field Detail
  - SP_ACTOR
```
public static final String SP_ACTOR
```
    See Also:
    
    Constant Field Values
  - SP_DATE
```
public static final String SP_DATE
```
    See Also:
    
    Constant Field Values
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - SP_TYPE
```
public static final String SP_TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Schedule
```
public Schedule()
```
  - Schedule
```
public Schedule(Reference actor)
```
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (External Ids for this item.)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
    Returns:
    
    identifier (External Ids for this item.)
  - addIdentifier
```
public Schedule addIdentifier(Identifier t)
```
  - getType
```
public List<CodeableConcept> getType()
```
    Returns:
    
    type (The schedule type can be used for the categorization of healthcare services or other appointment types.)
  - hasType
```
public boolean hasType()
```
  - addType
```
public CodeableConcept addType()
```
    Returns:
    
    type (The schedule type can be used for the categorization of healthcare services or other appointment types.)
  - addType
```
public Schedule addType(CodeableConcept t)
```
  - getActor
```
public 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, Device, Patient or RelatedPerson.)
  - hasActor
```
public boolean hasActor()
```
  - setActor
```
public Schedule setActor(Reference value)
```
    Parameters:
    
    value - actor (The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, Device, Patient or RelatedPerson.)
  - getActorTarget
```
public Resource getActorTarget()
```
    Returns:
    
    actor The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, Device, Patient or RelatedPerson.)
  - setActorTarget
```
public Schedule setActorTarget(Resource value)
```
    Parameters:
    
    value - actor The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, Device, Patient or RelatedPerson.)
  - 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 slot(s) 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 slot(s) 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 slot(s) 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 slot(s) that may be associated.
  - copy
```
public Schedule copy()
```
    Specified by:
    
    copy in class DomainResource
  - 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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class org.hl7.fhir.instance.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

Field Detail

SP_ACTOR

SP_DATE

SP_IDENTIFIER

SP_TYPE

Constructor Detail

Schedule

Schedule

Method Detail

getIdentifier

hasIdentifier

addIdentifier

addIdentifier

getType

hasType

addType

addType

getActor

hasActor

setActor

getActorTarget

setActorTarget

getPlanningHorizon

hasPlanningHorizon

setPlanningHorizon

getCommentElement

hasCommentElement

hasComment

setCommentElement

getComment

setComment

copy

equalsDeep

equalsShallow

isEmpty

getResourceType