Package org.hl7.fhir.dstu3.model

Class Appointment

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

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 Appointment
extends DomainResource

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Appointment.AppointmentParticipantComponent
static enum	Appointment.AppointmentStatus
static class	Appointment.AppointmentStatusEnumFactory
static enum	Appointment.ParticipantRequired
static class	Appointment.ParticipantRequiredEnumFactory
static enum	Appointment.ParticipationStatus
static class	Appointment.ParticipationStatusEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ACTOR	Fluent Client search parameter constant for actor
static final ca.uhn.fhir.rest.gclient.TokenClientParam	APPOINTMENT_TYPE	Fluent Client search parameter constant for appointment-type
protected CodeableConcept	appointmentType	The style of appointment or patient that has been booked in the slot (not service type).
protected StringType	comment	Additional comments about the appointment.
protected DateTimeType	created	The date that this appointment was initially created.
static final ca.uhn.fhir.rest.gclient.DateClientParam	DATE	Fluent Client search parameter constant for date
protected StringType	description	The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list.
protected InstantType	end	Date/Time that the appointment is to conclude.
protected List<Identifier>	identifier	This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g.
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_INCOMINGREFERRAL	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_LOCATION	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PRACTITIONER	Constant for fluent queries to be used to add include statements.
protected List<Reference>	incomingReferral	The referral request this appointment is allocated to assess (incoming referral).
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	INCOMINGREFERRAL	Fluent Client search parameter constant for incomingreferral
protected List<ReferralRequest>	incomingReferralTarget	The actual objects that are the target of the reference (The referral request this appointment is allocated to assess (incoming referral).)
protected List<Reference>	indication	Reason the appointment has been scheduled to take place, as specified using information from another resource.
protected List<Resource>	indicationTarget	The actual objects that are the target of the reference (Reason the appointment has been scheduled to take place, as specified using information from another resource.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	LOCATION	Fluent Client search parameter constant for location
protected PositiveIntType	minutesDuration	Number of minutes that the appointment is to take.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	PART_STATUS	Fluent Client search parameter constant for part-status
protected List<Appointment.AppointmentParticipantComponent>	participant	List of participants involved in the appointment.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PRACTITIONER	Fluent Client search parameter constant for practitioner
protected UnsignedIntType	priority	The priority of the appointment.
protected List<CodeableConcept>	reason	The reason that this appointment is being scheduled.
protected List<Period>	requestedPeriod	A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SERVICE_TYPE	Fluent Client search parameter constant for service-type
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.
protected List<Reference>	slot	The slots from the participants' schedules that will be filled by the appointment.
protected List<Slot>	slotTarget	The actual objects that are the target of the reference (The slots from the participants' schedules that will be filled by the appointment.)
static final String	SP_ACTOR	Search parameter: actor
static final String	SP_APPOINTMENT_TYPE	Search parameter: appointment-type
static final String	SP_DATE	Search parameter: date
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_INCOMINGREFERRAL	Search parameter: incomingreferral
static final String	SP_LOCATION	Search parameter: location
static final String	SP_PART_STATUS	Search parameter: part-status
static final String	SP_PATIENT	Search parameter: patient
static final String	SP_PRACTITIONER	Search parameter: practitioner
static final String	SP_SERVICE_TYPE	Search parameter: service-type
static final String	SP_STATUS	Search parameter: status
protected List<CodeableConcept>	specialty	The specialty of a practitioner that would be required to perform the service requested in this appointment.
protected InstantType	start	Date/Time that the appointment is to take place.
protected Enumeration<Appointment.AppointmentStatus>	status	The overall status of the Appointment.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected List<Reference>	supportingInformation	Additional information to support the appointment provided when making the appointment.
protected List<Resource>	supportingInformationTarget	The actual objects that are the target of the reference (Additional information to support the appointment provided when making the appointment.)

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, 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
Appointment()	Constructor
Appointment(Enumeration<Appointment.AppointmentStatus> status)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Identifier	addIdentifier()
Appointment	addIdentifier(Identifier t)
Reference	addIncomingReferral()
Appointment	addIncomingReferral(Reference t)
ReferralRequest	addIncomingReferralTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Reference	addIndication()
Appointment	addIndication(Reference t)
Appointment.AppointmentParticipantComponent	addParticipant()
Appointment	addParticipant(Appointment.AppointmentParticipantComponent t)
CodeableConcept	addReason()
Appointment	addReason(CodeableConcept t)
Period	addRequestedPeriod()
Appointment	addRequestedPeriod(Period t)
CodeableConcept	addServiceType()
Appointment	addServiceType(CodeableConcept t)
Reference	addSlot()
Appointment	addSlot(Reference t)
Slot	addSlotTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
CodeableConcept	addSpecialty()
Appointment	addSpecialty(CodeableConcept t)
Reference	addSupportingInformation()
Appointment	addSupportingInformation(Reference t)
Appointment	copy()
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
CodeableConcept	getAppointmentType()
String	getComment()
StringType	getCommentElement()
Date	getCreated()
DateTimeType	getCreatedElement()
String	getDescription()
StringType	getDescriptionElement()
Date	getEnd()
InstantType	getEndElement()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<Reference>	getIncomingReferral()
Reference	getIncomingReferralFirstRep()
List<ReferralRequest>	getIncomingReferralTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
List<Reference>	getIndication()
Reference	getIndicationFirstRep()
List<Resource>	getIndicationTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
int	getMinutesDuration()
PositiveIntType	getMinutesDurationElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Appointment.AppointmentParticipantComponent>	getParticipant()
Appointment.AppointmentParticipantComponent	getParticipantFirstRep()
int	getPriority()
UnsignedIntType	getPriorityElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<CodeableConcept>	getReason()
CodeableConcept	getReasonFirstRep()
List<Period>	getRequestedPeriod()
Period	getRequestedPeriodFirstRep()
ResourceType	getResourceType()
CodeableConcept	getServiceCategory()
List<CodeableConcept>	getServiceType()
CodeableConcept	getServiceTypeFirstRep()
List<Reference>	getSlot()
Reference	getSlotFirstRep()
List<Slot>	getSlotTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
List<CodeableConcept>	getSpecialty()
CodeableConcept	getSpecialtyFirstRep()
Date	getStart()
InstantType	getStartElement()
Appointment.AppointmentStatus	getStatus()
Enumeration<Appointment.AppointmentStatus>	getStatusElement()
List<Reference>	getSupportingInformation()
Reference	getSupportingInformationFirstRep()
List<Resource>	getSupportingInformationTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
String[]	getTypesForProperty(int hash, String name)
boolean	hasAppointmentType()
boolean	hasComment()
boolean	hasCommentElement()
boolean	hasCreated()
boolean	hasCreatedElement()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasEnd()
boolean	hasEndElement()
boolean	hasIdentifier()
boolean	hasIncomingReferral()
boolean	hasIndication()
boolean	hasMinutesDuration()
boolean	hasMinutesDurationElement()
boolean	hasParticipant()
boolean	hasPriority()
boolean	hasPriorityElement()
boolean	hasReason()
boolean	hasRequestedPeriod()
boolean	hasServiceCategory()
boolean	hasServiceType()
boolean	hasSlot()
boolean	hasSpecialty()
boolean	hasStart()
boolean	hasStartElement()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSupportingInformation()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
Appointment	setAppointmentType(CodeableConcept value)
Appointment	setComment(String value)
Appointment	setCommentElement(StringType value)
Appointment	setCreated(Date value)
Appointment	setCreatedElement(DateTimeType value)
Appointment	setDescription(String value)
Appointment	setDescriptionElement(StringType value)
Appointment	setEnd(Date value)
Appointment	setEndElement(InstantType value)
Appointment	setIdentifier(List<Identifier> theIdentifier)
Appointment	setIncomingReferral(List<Reference> theIncomingReferral)
Appointment	setIndication(List<Reference> theIndication)
Appointment	setMinutesDuration(int value)
Appointment	setMinutesDurationElement(PositiveIntType value)
Appointment	setParticipant(List<Appointment.AppointmentParticipantComponent> theParticipant)
Appointment	setPriority(int value)
Appointment	setPriorityElement(UnsignedIntType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Appointment	setReason(List<CodeableConcept> theReason)
Appointment	setRequestedPeriod(List<Period> theRequestedPeriod)
Appointment	setServiceCategory(CodeableConcept value)
Appointment	setServiceType(List<CodeableConcept> theServiceType)
Appointment	setSlot(List<Reference> theSlot)
Appointment	setSpecialty(List<CodeableConcept> theSpecialty)
Appointment	setStart(Date value)
Appointment	setStartElement(InstantType value)
Appointment	setStatus(Appointment.AppointmentStatus value)
Appointment	setStatusElement(Enumeration<Appointment.AppointmentStatus> value)
Appointment	setSupportingInformation(List<Reference> theSupportingInformation)
protected Appointment	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

This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

status

protected Enumeration<Appointment.AppointmentStatus> status

The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.

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.

appointmentType

protected CodeableConcept appointmentType

The style of appointment or patient that has been booked in the slot (not service type).

reason

protected List<CodeableConcept> reason

The reason that this appointment is being scheduled. This is more clinical than administrative.

indication

protected List<Reference> indication

Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.

indicationTarget

protected List<Resource> indicationTarget

The actual objects that are the target of the reference (Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.)

priority

protected UnsignedIntType priority

The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).

description

protected StringType description

The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.

supportingInformation

protected List<Reference> supportingInformation

Additional information to support the appointment provided when making the appointment.

supportingInformationTarget

protected List<Resource> supportingInformationTarget

The actual objects that are the target of the reference (Additional information to support the appointment provided when making the appointment.)

start

protected InstantType start

Date/Time that the appointment is to take place.

end

protected InstantType end

Date/Time that the appointment is to conclude.

minutesDuration

protected PositiveIntType minutesDuration

Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).

slot

protected List<Reference> slot

The slots from the participants' schedules that will be filled by the appointment.

slotTarget

protected List<Slot> slotTarget

The actual objects that are the target of the reference (The slots from the participants' schedules that will be filled by the appointment.)

created

protected DateTimeType created

The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.

comment

protected StringType comment

Additional comments about the appointment.

incomingReferral

protected List<Reference> incomingReferral

The referral request this appointment is allocated to assess (incoming referral).

incomingReferralTarget

protected List<ReferralRequest> incomingReferralTarget

The actual objects that are the target of the reference (The referral request this appointment is allocated to assess (incoming referral).)

participant

protected List<Appointment.AppointmentParticipantComponent> participant

List of participants involved in the appointment.

requestedPeriod

protected List<Period> requestedPeriod

A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. When using these values, the minutes duration should be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time.

SP_DATE

public static final String SP_DATE

Search parameter: date

Description: Appointment date/time.
Type: date
Path: Appointment.start

See Also:

• Constant Field Values

DATE

public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE

Fluent Client search parameter constant for date

Description: Appointment date/time.
Type: date
Path: Appointment.start

SP_ACTOR

public static final String SP_ACTOR

Search parameter: actor

Description: Any one of the individuals participating in the appointment
Type: reference
Path: Appointment.participant.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: Any one of the individuals participating in the appointment
Type: reference
Path: Appointment.participant.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 "Appointment:actor".

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: An Identifier of the Appointment
Type: token
Path: Appointment.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: An Identifier of the Appointment
Type: token
Path: Appointment.identifier

SP_PRACTITIONER

public static final String SP_PRACTITIONER

Search parameter: practitioner

Description: One of the individuals of the appointment is this practitioner
Type: reference
Path: Appointment.participant.actor

See Also:

• Constant Field Values

PRACTITIONER

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

Fluent Client search parameter constant for practitioner

Description: One of the individuals of the appointment is this practitioner
Type: reference
Path: Appointment.participant.actor

INCLUDE_PRACTITIONER

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

Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:practitioner".

SP_INCOMINGREFERRAL

public static final String SP_INCOMINGREFERRAL

Search parameter: incomingreferral

Description: The ReferralRequest provided as information to allocate to the Encounter
Type: reference
Path: Appointment.incomingReferral

See Also:

• Constant Field Values

INCOMINGREFERRAL

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

Fluent Client search parameter constant for incomingreferral

Description: The ReferralRequest provided as information to allocate to the Encounter
Type: reference
Path: Appointment.incomingReferral

INCLUDE_INCOMINGREFERRAL

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

Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:incomingreferral".

SP_PART_STATUS

public static final String SP_PART_STATUS

Search parameter: part-status

Description: The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests.
Type: token
Path: Appointment.participant.status

See Also:

• Constant Field Values

PART_STATUS

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

Fluent Client search parameter constant for part-status

Description: The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests.
Type: token
Path: Appointment.participant.status

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: One of the individuals of the appointment is this patient
Type: reference
Path: Appointment.participant.actor

See Also:

• Constant Field Values

PATIENT

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

Fluent Client search parameter constant for patient

Description: One of the individuals of the appointment is this patient
Type: reference
Path: Appointment.participant.actor

INCLUDE_PATIENT

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

Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:patient".

SP_APPOINTMENT_TYPE

public static final String SP_APPOINTMENT_TYPE

Search parameter: appointment-type

Description: The style of appointment or patient that has been booked in the slot (not service type)
Type: token
Path: Appointment.appointmentType

See Also:

• Constant Field Values

APPOINTMENT_TYPE

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

Fluent Client search parameter constant for appointment-type

Description: The style of appointment or patient that has been booked in the slot (not service type)
Type: token
Path: Appointment.appointmentType

SP_SERVICE_TYPE

public static final String SP_SERVICE_TYPE

Search parameter: service-type

Description: The specific service that is to be performed during this appointment
Type: token
Path: Appointment.serviceType

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 specific service that is to be performed during this appointment
Type: token
Path: Appointment.serviceType

SP_LOCATION

public static final String SP_LOCATION

Search parameter: location

Description: This location is listed in the participants of the appointment
Type: reference
Path: Appointment.participant.actor

See Also:

• Constant Field Values

LOCATION

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

Fluent Client search parameter constant for location

Description: This location is listed in the participants of the appointment
Type: reference
Path: Appointment.participant.actor

INCLUDE_LOCATION

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

Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:location".

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: The overall status of the appointment
Type: token
Path: Appointment.status

See Also:

• Constant Field Values

STATUS

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

Fluent Client search parameter constant for status

Description: The overall status of the appointment
Type: token
Path: Appointment.status

Constructor Details

Appointment

public Appointment()

Constructor

Appointment

public Appointment(Enumeration<Appointment.AppointmentStatus> status)

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).)

setIdentifier

public Appointment setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public Appointment addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist

getStatusElement

public Enumeration<Appointment.AppointmentStatus> getStatusElement()

Returns:

status (The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

hasStatusElement

public boolean hasStatusElement()

hasStatus

public boolean hasStatus()

setStatusElement

public Appointment setStatusElement(Enumeration<Appointment.AppointmentStatus> value)

Parameters:

value - status (The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public Appointment.AppointmentStatus getStatus()

Returns:

The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.

setStatus

public Appointment setStatus(Appointment.AppointmentStatus value)

Parameters:

value - The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.

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 Appointment 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 Appointment setServiceType(List<CodeableConcept> theServiceType)

Returns:

Returns a reference to this for easy method chaining

hasServiceType

public boolean hasServiceType()

addServiceType

public CodeableConcept addServiceType()

addServiceType

public Appointment 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 Appointment setSpecialty(List<CodeableConcept> theSpecialty)

Returns:

Returns a reference to this for easy method chaining

hasSpecialty

public boolean hasSpecialty()

addSpecialty

public CodeableConcept addSpecialty()

addSpecialty

public Appointment addSpecialty(CodeableConcept t)

getSpecialtyFirstRep

public CodeableConcept getSpecialtyFirstRep()

Returns:

The first repetition of repeating field specialty, creating it if it does not already exist

getAppointmentType

public CodeableConcept getAppointmentType()

Returns:

appointmentType (The style of appointment or patient that has been booked in the slot (not service type).)

hasAppointmentType

public boolean hasAppointmentType()

setAppointmentType

public Appointment setAppointmentType(CodeableConcept value)

Parameters:

value - appointmentType (The style of appointment or patient that has been booked in the slot (not service type).)

getReason

public List<CodeableConcept> getReason()

Returns:

reason (The reason that this appointment is being scheduled. This is more clinical than administrative.)

setReason

public Appointment setReason(List<CodeableConcept> theReason)

Returns:

Returns a reference to this for easy method chaining

hasReason

public boolean hasReason()

addReason

public CodeableConcept addReason()

addReason

public Appointment addReason(CodeableConcept t)

getReasonFirstRep

public CodeableConcept getReasonFirstRep()

Returns:

The first repetition of repeating field reason, creating it if it does not already exist

getIndication

public List<Reference> getIndication()

Returns:

indication (Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.)

setIndication

public Appointment setIndication(List<Reference> theIndication)

Returns:

Returns a reference to this for easy method chaining

hasIndication

public boolean hasIndication()

addIndication

public Reference addIndication()

addIndication

public Appointment addIndication(Reference t)

getIndicationFirstRep

public Reference getIndicationFirstRep()

Returns:

The first repetition of repeating field indication, creating it if it does not already exist

getIndicationTarget

@Deprecated
public List<Resource> getIndicationTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getPriorityElement

public UnsignedIntType getPriorityElement()

Returns:

priority (The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value

hasPriorityElement

public boolean hasPriorityElement()

hasPriority

public boolean hasPriority()

setPriorityElement

public Appointment setPriorityElement(UnsignedIntType value)

Parameters:

value - priority (The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value

getPriority

public int getPriority()

Returns:

The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).

setPriority

public Appointment setPriority(int value)

Parameters:

value - The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).

getDescriptionElement

public StringType getDescriptionElement()

Returns:

description (The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

hasDescriptionElement

public boolean hasDescriptionElement()

hasDescription

public boolean hasDescription()

setDescriptionElement

public Appointment setDescriptionElement(StringType value)

Parameters:

value - description (The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

getDescription

public String getDescription()

Returns:

The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.

setDescription

public Appointment setDescription(String value)

Parameters:

value - The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.

getSupportingInformation

public List<Reference> getSupportingInformation()

Returns:

supportingInformation (Additional information to support the appointment provided when making the appointment.)

setSupportingInformation

public Appointment setSupportingInformation(List<Reference> theSupportingInformation)

Returns:

Returns a reference to this for easy method chaining

hasSupportingInformation

public boolean hasSupportingInformation()

addSupportingInformation

public Reference addSupportingInformation()

addSupportingInformation

public Appointment addSupportingInformation(Reference t)

getSupportingInformationFirstRep

public Reference getSupportingInformationFirstRep()

Returns:

The first repetition of repeating field supportingInformation, creating it if it does not already exist

getSupportingInformationTarget

@Deprecated
public List<Resource> getSupportingInformationTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getStartElement

public InstantType getStartElement()

Returns:

start (Date/Time that the appointment is to take place.). This is the underlying object with id, value and extensions. The accessor "getStart" gives direct access to the value

hasStartElement

public boolean hasStartElement()

hasStart

public boolean hasStart()

setStartElement

public Appointment setStartElement(InstantType value)

Parameters:

value - start (Date/Time that the appointment is to take place.). This is the underlying object with id, value and extensions. The accessor "getStart" gives direct access to the value

getStart

public Date getStart()

Returns:

Date/Time that the appointment is to take place.

setStart

public Appointment setStart(Date value)

Parameters:

value - Date/Time that the appointment is to take place.

getEndElement

public InstantType getEndElement()

Returns:

end (Date/Time that the appointment is to conclude.). This is the underlying object with id, value and extensions. The accessor "getEnd" gives direct access to the value

hasEndElement

public boolean hasEndElement()

hasEnd

public boolean hasEnd()

setEndElement

public Appointment setEndElement(InstantType value)

Parameters:

value - end (Date/Time that the appointment is to conclude.). This is the underlying object with id, value and extensions. The accessor "getEnd" gives direct access to the value

getEnd

public Date getEnd()

Returns:

Date/Time that the appointment is to conclude.

setEnd

public Appointment setEnd(Date value)

Parameters:

value - Date/Time that the appointment is to conclude.

getMinutesDurationElement

public PositiveIntType getMinutesDurationElement()

Returns:

minutesDuration (Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).). This is the underlying object with id, value and extensions. The accessor "getMinutesDuration" gives direct access to the value

hasMinutesDurationElement

public boolean hasMinutesDurationElement()

hasMinutesDuration

public boolean hasMinutesDuration()

setMinutesDurationElement

public Appointment setMinutesDurationElement(PositiveIntType value)

Parameters:

value - minutesDuration (Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).). This is the underlying object with id, value and extensions. The accessor "getMinutesDuration" gives direct access to the value

getMinutesDuration

public int getMinutesDuration()

Returns:

Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).

setMinutesDuration

public Appointment setMinutesDuration(int value)

Parameters:

value - Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).

getSlot

public List<Reference> getSlot()

Returns:

slot (The slots from the participants' schedules that will be filled by the appointment.)

setSlot

public Appointment setSlot(List<Reference> theSlot)

Returns:

Returns a reference to this for easy method chaining

hasSlot

public boolean hasSlot()

addSlot

public Reference addSlot()

addSlot

public Appointment addSlot(Reference t)

getSlotFirstRep

public Reference getSlotFirstRep()

Returns:

The first repetition of repeating field slot, creating it if it does not already exist

getSlotTarget

@Deprecated
public List<Slot> getSlotTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addSlotTarget

@Deprecated
public Slot addSlotTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getCreatedElement

public DateTimeType getCreatedElement()

Returns:

created (The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value

hasCreatedElement

public boolean hasCreatedElement()

hasCreated

public boolean hasCreated()

setCreatedElement

public Appointment setCreatedElement(DateTimeType value)

Parameters:

value - created (The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value

getCreated

public Date getCreated()

Returns:

The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.

setCreated

public Appointment setCreated(Date value)

Parameters:

value - The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.

getCommentElement

public StringType getCommentElement()

Returns:

comment (Additional comments about the appointment.). 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 Appointment setCommentElement(StringType value)

Parameters:

value - comment (Additional comments about the appointment.). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the value

getComment

public String getComment()

Returns:

Additional comments about the appointment.

setComment

public Appointment setComment(String value)

Parameters:

value - Additional comments about the appointment.

getIncomingReferral

public List<Reference> getIncomingReferral()

Returns:

incomingReferral (The referral request this appointment is allocated to assess (incoming referral).)

setIncomingReferral

public Appointment setIncomingReferral(List<Reference> theIncomingReferral)

Returns:

Returns a reference to this for easy method chaining

hasIncomingReferral

public boolean hasIncomingReferral()

addIncomingReferral

public Reference addIncomingReferral()

addIncomingReferral

public Appointment addIncomingReferral(Reference t)

getIncomingReferralFirstRep

public Reference getIncomingReferralFirstRep()

Returns:

The first repetition of repeating field incomingReferral, creating it if it does not already exist

getIncomingReferralTarget

@Deprecated
public List<ReferralRequest> getIncomingReferralTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addIncomingReferralTarget

@Deprecated
public ReferralRequest addIncomingReferralTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getParticipant

public List<Appointment.AppointmentParticipantComponent> getParticipant()

Returns:

participant (List of participants involved in the appointment.)

setParticipant

public Appointment setParticipant(List<Appointment.AppointmentParticipantComponent> theParticipant)

Returns:

Returns a reference to this for easy method chaining

hasParticipant

public boolean hasParticipant()

addParticipant

public Appointment.AppointmentParticipantComponent addParticipant()

addParticipant

public Appointment addParticipant(Appointment.AppointmentParticipantComponent t)

getParticipantFirstRep

public Appointment.AppointmentParticipantComponent getParticipantFirstRep()

Returns:

The first repetition of repeating field participant, creating it if it does not already exist

getRequestedPeriod

public List<Period> getRequestedPeriod()

Returns:

requestedPeriod (A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. When using these values, the minutes duration should be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time.)

setRequestedPeriod

public Appointment setRequestedPeriod(List<Period> theRequestedPeriod)

Returns:

Returns a reference to this for easy method chaining

hasRequestedPeriod

public boolean hasRequestedPeriod()

addRequestedPeriod

public Period addRequestedPeriod()

addRequestedPeriod

public Appointment addRequestedPeriod(Period t)

getRequestedPeriodFirstRep

public Period getRequestedPeriodFirstRep()

Returns:

The first repetition of repeating field requestedPeriod, creating it if it does not already exist

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

Specified by:

copy in class DomainResource

typedCopy

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