org.hl7.fhir.dstu2016may.model

Class Schedule

java.lang.Object

org.hl7.fhir.dstu2016may.model.Base

org.hl7.fhir.dstu2016may.model.BaseResource

org.hl7.fhir.dstu2016may.model.Resource

org.hl7.fhir.dstu2016may.model.DomainResource

org.hl7.fhir.dstu2016may.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 slot(s) of time that may be available for booking appointments.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Reference	actor The resource this Schedule resource is providing availability information for.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	ACTOR Fluent Client search parameter constant for actor
protected Resource	actorTarget The actual object that is 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 ca.uhn.fhir.rest.gclient.DateClientParam	DATE Fluent Client search parameter constant for date
protected List<Identifier>	identifier External Ids for this item.
static ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER Fluent Client search parameter constant for identifier
static 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 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 ca.uhn.fhir.rest.gclient.TokenClientParam	TYPE Fluent Client search parameter constant for type

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

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu2016may.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
Schedule(Reference actor) Constructor

Method Summary

Modifier and Type	Method and Description
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()
Reference	getActor()
Resource	getActorTarget()
String	getComment()
StringType	getCommentElement()
List<Identifier>	getIdentifier()
Period	getPlanningHorizon()
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
CodeableConcept	getServiceCategory()
List<CodeableConcept>	getServiceType()
List<CodeableConcept>	getSpecialty()
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	setActor(Reference value)
Schedule	setActorTarget(Resource value)
Schedule	setComment(String value)
Schedule	setCommentElement(StringType value)
Schedule	setPlanningHorizon(Period value)
void	setProperty(int hash, String name, Base value)
void	setProperty(String name, Base value)
Schedule	setServiceCategory(CodeableConcept value)
protected Schedule	typedCopy()

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

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

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

getStructureFhirVersionEnum, setId

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

castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, 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.

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

actorTarget

protected Resource actorTarget

The actual object that is 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, 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 slot(s) 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_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

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

Constructor Detail

Schedule

public Schedule()

Constructor

Schedule

public Schedule(Reference actor)

Constructor

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)

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

hasServiceType

public boolean hasServiceType()

addServiceType

public CodeableConcept addServiceType()

Returns:

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

addServiceType

public Schedule addServiceType(CodeableConcept t)

getSpecialty

public List<CodeableConcept> getSpecialty()

Returns:

specialty (The specialty of a practitioner that would be required to perform the service requested in this appointment.)

hasSpecialty

public boolean hasSpecialty()

addSpecialty

public CodeableConcept addSpecialty()

Returns:

specialty (The specialty of a practitioner that would be required to perform the service requested in this appointment.)

addSpecialty

public Schedule addSpecialty(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.

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class DomainResource

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

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

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