Package org.hl7.fhir.dstu3.model

Class Schedule

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:

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

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	The resource this Schedule resource is providing availability information for.
static final ca.uhn.fhir.rest.gclient.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 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.
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 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_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 final ca.uhn.fhir.rest.gclient.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

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Schedule()	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	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()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
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> children)
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, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

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

copyValues, getId, getIdBase, getIdElement, getIdPart, 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, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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.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 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 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_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_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 ca.uhn.fhir.rest.gclient.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 Details

Schedule

public Schedule()

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

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

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

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

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource