Package org.hl7.fhir.r5.model

Class Schedule

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.model.Schedule

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class Schedule
extends DomainResource

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

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected BooleanType	active	Whether this schedule record is in active use or should not be used (such as was entered in error).
static final ca.uhn.fhir.rest.gclient.TokenClientParam	ACTIVE	Fluent Client search parameter constant for active
protected List<Reference>	actor	Slots that reference this schedule resource provide the availability details to these referenced resource(s).
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ACTOR	Fluent Client search parameter constant for actor
protected MarkdownType	comment	Comments on the availability to describe any extended information.
static final ca.uhn.fhir.rest.gclient.DateClientParam	DATE	Fluent Client search parameter constant for date
protected List<Identifier>	identifier	External Ids for this item.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_ACTOR	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SERVICE_TYPE_REFERENCE	Constant for fluent queries to be used to add include statements.
protected StringType	name	Further description of the schedule as it would be presented to a consumer while searching.
static final ca.uhn.fhir.rest.gclient.StringClientParam	NAME	Fluent Client search parameter constant for name
protected Period	planningHorizon	The period of time that the slots that reference this Schedule resource cover (even if none exist).
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SERVICE_CATEGORY	Fluent Client search parameter constant for service-category
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SERVICE_TYPE	Fluent Client search parameter constant for service-type
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SERVICE_TYPE_REFERENCE	Fluent Client search parameter constant for service-type-reference
protected List<CodeableConcept>	serviceCategory	A broad categorization of the service that is to be performed during this appointment.
protected List<CodeableReference>	serviceType	The specific service that is to be performed during this appointment.
static final String	SP_ACTIVE	Search parameter: active
static final String	SP_ACTOR	Search parameter: actor
static final String	SP_DATE	Search parameter: date
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_NAME	Search parameter: name
static final String	SP_SERVICE_CATEGORY	Search parameter: service-category
static final String	SP_SERVICE_TYPE	Search parameter: service-type
static final String	SP_SERVICE_TYPE_REFERENCE	Search parameter: service-type-reference
static final String	SP_SPECIALTY	Search parameter: specialty
protected List<CodeableConcept>	specialty	The specialty of a practitioner that would be required to perform the service requested in this appointment.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SPECIALTY	Fluent Client search parameter constant for specialty

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

contained, extension, modifierExtension, SP_TEXT, text, TEXT

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

id, implicitRules, language, meta

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

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Schedule()	Constructor
Schedule(Reference actor)	Constructor

Method Summary

Modifier and Type	Method	Description
Reference	addActor()
Schedule	addActor(Reference t)
Base	addChild(String name)
Identifier	addIdentifier()
Schedule	addIdentifier(Identifier t)
CodeableConcept	addServiceCategory()
Schedule	addServiceCategory(CodeableConcept t)
CodeableReference	addServiceType()
Schedule	addServiceType(CodeableReference t)
CodeableConcept	addSpecialty()
Schedule	addSpecialty(CodeableConcept t)
Schedule	copy()
void	copyValues(Schedule dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
boolean	getActive()
BooleanType	getActiveElement()
List<Reference>	getActor()
Reference	getActorFirstRep()
String	getComment()
MarkdownType	getCommentElement()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
String	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
StringType	getNameElement()
Period	getPlanningHorizon()
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
List<CodeableConcept>	getServiceCategory()
CodeableConcept	getServiceCategoryFirstRep()
List<CodeableReference>	getServiceType()
CodeableReference	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	hasName()
boolean	hasNameElement()
boolean	hasPlanningHorizon()
boolean	hasServiceCategory()
boolean	hasServiceType()
boolean	hasSpecialty()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Schedule	setActive(boolean value)
Schedule	setActiveElement(BooleanType value)
Schedule	setActor(List<Reference> theActor)
Schedule	setComment(String value)
Schedule	setCommentElement(MarkdownType value)
Schedule	setIdentifier(List<Identifier> theIdentifier)
Schedule	setName(String value)
Schedule	setNameElement(StringType value)
Schedule	setPlanningHorizon(Period value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Schedule	setServiceCategory(List<CodeableConcept> theServiceCategory)
Schedule	setServiceType(List<CodeableReference> theServiceType)
Schedule	setSpecialty(List<CodeableConcept> theSpecialty)
protected Schedule	typedCopy()

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

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setText

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

copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath

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

getStructureFhirVersionEnum, isResource, setId

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, 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.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

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 List<CodeableConcept> serviceCategory

A broad categorization of the service that is to be performed during this appointment.

serviceType

protected List<CodeableReference> 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.

name

protected StringType name

Further description of the schedule as it would be presented to a consumer while searching.

actor

protected List<Reference> actor

Slots that reference this schedule resource provide the availability details to these referenced resource(s).

planningHorizon

protected Period planningHorizon

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.

comment

protected MarkdownType comment

Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.

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 ca.uhn.fhir.rest.gclient.TokenClientParam ACTIVE

Fluent Client search parameter constant for active

Description: Is the schedule in active use
Type: token
Path: Schedule.active

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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.model.api.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: A Schedule Identifier
Type: token
Path: Schedule.identifier

SP_NAME

public static final String SP_NAME

Search parameter: name

Description: A portion of the Schedule name
Type: string
Path: Schedule.name

See Also:

• Constant Field Values

NAME

public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME

Fluent Client search parameter constant for name

Description: A portion of the Schedule name
Type: string
Path: Schedule.name

SP_SERVICE_CATEGORY

public static final String SP_SERVICE_CATEGORY

Search parameter: service-category

Description: High-level category
Type: token
Path: Schedule.serviceCategory

See Also:

• Constant Field Values

SERVICE_CATEGORY

public static final ca.uhn.fhir.rest.gclient.TokenClientParam SERVICE_CATEGORY

Fluent Client search parameter constant for service-category

Description: High-level category
Type: token
Path: Schedule.serviceCategory

SP_SERVICE_TYPE_REFERENCE

public static final String SP_SERVICE_TYPE_REFERENCE

Search parameter: service-type-reference

Description: The type (by HealthcareService) of appointments that can be booked into associated slot(s)
Type: reference
Path: Schedule.serviceType.reference

See Also:

• Constant Field Values

SERVICE_TYPE_REFERENCE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SERVICE_TYPE_REFERENCE

Fluent Client search parameter constant for service-type-reference

Description: The type (by HealthcareService) of appointments that can be booked into associated slot(s)
Type: reference
Path: Schedule.serviceType.reference

INCLUDE_SERVICE_TYPE_REFERENCE

public static final ca.uhn.fhir.model.api.Include INCLUDE_SERVICE_TYPE_REFERENCE

Constant for fluent queries to be used to add include statements. Specifies the path value of "Schedule:service-type-reference".

SP_SERVICE_TYPE

public static final String SP_SERVICE_TYPE

Search parameter: service-type

Description: The type (by coding) of appointments that can be booked into associated slot(s)
Type: token
Path: Schedule.serviceType.concept

See Also:

• Constant Field Values

SERVICE_TYPE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam SERVICE_TYPE

Fluent Client search parameter constant for service-type

Description: The type (by coding) of appointments that can be booked into associated slot(s)
Type: token
Path: Schedule.serviceType.concept

SP_SPECIALTY

public static final String SP_SPECIALTY

Search parameter: specialty

Description: Type of specialty needed
Type: token
Path: Schedule.specialty

See Also:

• Constant Field Values

SPECIALTY

public static final ca.uhn.fhir.rest.gclient.TokenClientParam SPECIALTY

Fluent Client search parameter constant for specialty

Description: Type of specialty needed
Type: token
Path: Schedule.specialty

Constructor Details

Schedule

public Schedule()

Constructor

Schedule

public Schedule(Reference actor)

Constructor

Method Details

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 {3}

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 List<CodeableConcept> getServiceCategory()

Returns:

serviceCategory (A broad categorization of the service that is to be performed during this appointment.)

setServiceCategory

public Schedule setServiceCategory(List<CodeableConcept> theServiceCategory)

Returns:

Returns a reference to this for easy method chaining

hasServiceCategory

public boolean hasServiceCategory()

addServiceCategory

public CodeableConcept addServiceCategory()

addServiceCategory

public Schedule addServiceCategory(CodeableConcept t)

getServiceCategoryFirstRep

public CodeableConcept getServiceCategoryFirstRep()

Returns:

The first repetition of repeating field serviceCategory, creating it if it does not already exist {3}

getServiceType

public List<CodeableReference> getServiceType()

Returns:

serviceType (The specific service that is to be performed during this appointment.)

setServiceType

public Schedule setServiceType(List<CodeableReference> theServiceType)

Returns:

Returns a reference to this for easy method chaining

hasServiceType

public boolean hasServiceType()

addServiceType

public CodeableReference addServiceType()

addServiceType

public Schedule addServiceType(CodeableReference t)

getServiceTypeFirstRep

public CodeableReference getServiceTypeFirstRep()

Returns:

The first repetition of repeating field serviceType, creating it if it does not already exist {3}

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 {3}

getNameElement

public StringType getNameElement()

Returns:

name (Further description of the schedule as it would be presented to a consumer while searching.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

hasNameElement

public boolean hasNameElement()

hasName

public boolean hasName()

setNameElement

public Schedule setNameElement(StringType value)

Parameters:

value - name (Further description of the schedule as it would be presented to a consumer while searching.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

getName

public String getName()

Returns:

Further description of the schedule as it would be presented to a consumer while searching.

setName

public Schedule setName(String value)

Parameters:

value - Further description of the schedule as it would be presented to a consumer while searching.

getActor

public List<Reference> getActor()

Returns:

actor (Slots that reference this schedule resource provide the availability details to these referenced resource(s).)

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 {3}

getPlanningHorizon

public Period getPlanningHorizon()

Returns:

planningHorizon (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.)

hasPlanningHorizon

public boolean hasPlanningHorizon()

setPlanningHorizon

public Schedule setPlanningHorizon(Period value)

Parameters:

value - planningHorizon (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.)

getCommentElement

public MarkdownType 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(MarkdownType 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> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

Returns:

the FHIR type name of the instance (not the java class name)

copy

public Schedule copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(Schedule dst)

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 org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource