ca.uhn.fhir.model.dstu.resource

Class Availability

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseResource

ca.uhn.fhir.model.dstu.resource.Availability

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions

public class Availability
extends BaseResource
implements IResource

HAPI/FHIR Availability Resource ((informative) A container for slot(s) of time that may be available for booking appointments)

Definition:

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/Availability

Field Summary

Fields

Modifier and Type	Field and Description
static Include	INCLUDE_INDIVIDUAL Constant for fluent queries to be used to add include statements.
static ReferenceClientParam	INDIVIDUAL Fluent Client search parameter constant for individual
static TokenClientParam	SLOTTYPE Fluent Client search parameter constant for slottype
static String	SP_INDIVIDUAL Search parameter constant for individual
static String	SP_SLOTTYPE Search parameter constant for slottype

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors

Constructor and Description
Availability()

Method Summary

Methods

Modifier and Type	Method and Description
IdentifierDt	addIdentifier() Adds and returns a new value for identifier (External Ids for this item)
Availability	addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel) Adds a new value for identifier (External Ids for this item)
Availability	addIdentifier(String theSystem, String theValue) Adds a new value for identifier (External Ids for this item)
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
ResourceReferenceDt	getAuthor() Gets the value(s) for author (Who authored the availability).
DateTimeDt	getAuthorDate() Gets the value(s) for authorDate (When this availability was created, or last revised).
StringDt	getComment() Gets the value(s) for comment (Comments on the availability to describe any extended information.
List<IdentifierDt>	getIdentifier() Gets the value(s) for identifier (External Ids for this item).
IdentifierDt	getIdentifierFirstRep() Gets the first repetition for identifier (External Ids for this item), creating it if it does not already exist.
ResourceReferenceDt	getIndividual() Gets the value(s) for individual (The type of resource this availability resource is providing availability information for).
PeriodDt	getPeriod() Gets the value(s) for period (The period of time that the slots that are attached to this availability resource cover (even if none exist)).
CodeableConceptDt	getType() Gets the value(s) for type (The type of appointments that can be booked into slots attached to this availability resource (ideally this would be an identifiable service - which is at a location, rather than the location itself) - change to CodeableConcept).
boolean	isEmpty()
Availability	setAuthor(ResourceReferenceDt theValue) Sets the value(s) for author (Who authored the availability)
Availability	setAuthorDate(Date theDate, TemporalPrecisionEnum thePrecision) Sets the value for authorDate (When this availability was created, or last revised)
Availability	setAuthorDate(DateTimeDt theValue) Sets the value(s) for authorDate (When this availability was created, or last revised)
Availability	setAuthorDateWithSecondsPrecision(Date theDate) Sets the value for authorDate (When this availability was created, or last revised)
Availability	setComment(String theString) Sets the value for comment (Comments on the availability to describe any extended information.
Availability	setComment(StringDt theValue) Sets the value(s) for comment (Comments on the availability to describe any extended information.
Availability	setIdentifier(List<IdentifierDt> theValue) Sets the value(s) for identifier (External Ids for this item)
Availability	setIndividual(ResourceReferenceDt theValue) Sets the value(s) for individual (The type of resource this availability resource is providing availability information for)
Availability	setPeriod(PeriodDt theValue) Sets the value(s) for period (The period of time that the slots that are attached to this availability resource cover (even if none exist))
Availability	setType(CodeableConceptDt theValue) Sets the value(s) for type (The type of appointments that can be booked into slots attached to this availability resource (ideally this would be an identifiable service - which is at a location, rather than the location itself) - change to CodeableConcept)

Methods inherited from class ca.uhn.fhir.model.api.BaseResource

getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource

getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

Field Detail

SP_INDIVIDUAL

public static final String SP_INDIVIDUAL

Search parameter constant for individual

Description: The individual to find an availability for
Type: reference
Path: Availability.individual

See Also:

Constant Field Values

INDIVIDUAL

public static final ReferenceClientParam INDIVIDUAL

Fluent Client search parameter constant for individual

Description: The individual to find an availability for
Type: reference
Path: Availability.individual

INCLUDE_INDIVIDUAL

public static final Include INCLUDE_INDIVIDUAL

Constant for fluent queries to be used to add include statements. Specifies the path value of "Availability.individual".

SP_SLOTTYPE

public static final String SP_SLOTTYPE

Search parameter constant for slottype

Description: The type of appointments that can be booked into associated slot(s)
Type: token
Path: Availability.type

See Also:

Constant Field Values

SLOTTYPE

public static final TokenClientParam SLOTTYPE

Fluent Client search parameter constant for slottype

Description: The type of appointments that can be booked into associated slot(s)
Type: token
Path: Availability.type

Constructor Detail

Availability

public Availability()

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IElement

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Description copied from interface: ICompositeElement

Returns a list containing all child elements matching a given type

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

Parameters:

theType - The type to match. If set to null, all child elements will be returned

getIdentifier

public List<IdentifierDt> getIdentifier()

Gets the value(s) for identifier (External Ids for this item). creating it if it does not exist. Will not return null.

Definition:

setIdentifier

public Availability setIdentifier(List<IdentifierDt> theValue)

Sets the value(s) for identifier (External Ids for this item)

Definition:

addIdentifier

public IdentifierDt addIdentifier()

Adds and returns a new value for identifier (External Ids for this item)

Definition:

getIdentifierFirstRep

public IdentifierDt getIdentifierFirstRep()

Gets the first repetition for identifier (External Ids for this item), creating it if it does not already exist.

Definition:

addIdentifier

public Availability addIdentifier(IdentifierUseEnum theUse,
                         String theSystem,
                         String theValue,
                         String theLabel)

Adds a new value for identifier (External Ids for this item)

Definition:

Returns:

Returns a reference to this object, to allow for simple chaining.

addIdentifier

public Availability addIdentifier(String theSystem,
                         String theValue)

Adds a new value for identifier (External Ids for this item)

Definition:

Returns:

Returns a reference to this object, to allow for simple chaining.

getType

public CodeableConceptDt getType()

Gets the value(s) for type (The type of appointments that can be booked into slots attached to this availability resource (ideally this would be an identifiable service - which is at a location, rather than the location itself) - change to CodeableConcept). creating it if it does not exist. Will not return null.

Definition:

setType

public Availability setType(CodeableConceptDt theValue)

Sets the value(s) for type (The type of appointments that can be booked into slots attached to this availability resource (ideally this would be an identifiable service - which is at a location, rather than the location itself) - change to CodeableConcept)

Definition:

getIndividual

public ResourceReferenceDt getIndividual()

Gets the value(s) for individual (The type of resource this availability resource is providing availability information for). creating it if it does not exist. Will not return null.

Definition:

setIndividual

public Availability setIndividual(ResourceReferenceDt theValue)

Sets the value(s) for individual (The type of resource this availability resource is providing availability information for)

Definition:

getPeriod

public PeriodDt getPeriod()

Gets the value(s) for period (The period of time that the slots that are attached to this availability resource cover (even if none exist)). creating it if it does not exist. Will not return null.

Definition:

setPeriod

public Availability setPeriod(PeriodDt theValue)

Sets the value(s) for period (The period of time that the slots that are attached to this availability resource cover (even if none exist))

Definition:

getComment

public StringDt getComment()

Gets the value(s) for comment (Comments on the availability to describe any extended information. Such as custom constraints on the slot(s) that may be associated). creating it if it does not exist. Will not return null.

Definition:

setComment

public Availability setComment(StringDt theValue)

Sets the value(s) for comment (Comments on the availability to describe any extended information. Such as custom constraints on the slot(s) that may be associated)

Definition:

setComment

public Availability setComment(String theString)

Sets the value for comment (Comments on the availability to describe any extended information. Such as custom constraints on the slot(s) that may be associated)

Definition:

getAuthor

public ResourceReferenceDt getAuthor()

Gets the value(s) for author (Who authored the availability). creating it if it does not exist. Will not return null.

Definition:

setAuthor

public Availability setAuthor(ResourceReferenceDt theValue)

Sets the value(s) for author (Who authored the availability)

Definition:

getAuthorDate

public DateTimeDt getAuthorDate()

Gets the value(s) for authorDate (When this availability was created, or last revised). creating it if it does not exist. Will not return null.

Definition:

setAuthorDate

public Availability setAuthorDate(DateTimeDt theValue)

Sets the value(s) for authorDate (When this availability was created, or last revised)

Definition:

setAuthorDateWithSecondsPrecision

public Availability setAuthorDateWithSecondsPrecision(Date theDate)

Sets the value for authorDate (When this availability was created, or last revised)

Definition:

setAuthorDate

public Availability setAuthorDate(Date theDate,
                         TemporalPrecisionEnum thePrecision)

Sets the value for authorDate (When this availability was created, or last revised)

Definition: