Package org.hl7.fhir.r5.model

Class Appointment

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.model.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 class	Appointment.AppointmentRecurrenceTemplateComponent
static class	Appointment.AppointmentRecurrenceTemplateMonthlyTemplateComponent
static class	Appointment.AppointmentRecurrenceTemplateWeeklyTemplateComponent
static class	Appointment.AppointmentRecurrenceTemplateYearlyTemplateComponent
static enum	Appointment.AppointmentStatus
static class	Appointment.AppointmentStatusEnumFactory
static enum	Appointment.ParticipationStatus
static class	Appointment.ParticipationStatusEnumFactory

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

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

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Reference>	account	The set of accounts that is expected to be used for billing the activities that result from this Appointment.
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).
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	BASED_ON	Fluent Client search parameter constant for based-on
protected List<Reference>	basedOn	The request this appointment is allocated to assess (e.g. incoming referral or procedure request).
protected DateTimeType	cancellationDate	The date/time describing when the appointment was cancelled.
protected CodeableConcept	cancellationReason	The coded reason for the appointment being cancelled.
protected List<CodeableConcept>	class_	Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
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.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	GROUP	Fluent Client search parameter constant for group
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).
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_BASED_ON	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_GROUP	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.
static final ca.uhn.fhir.model.api.Include	INCLUDE_REASON_REFERENCE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SERVICE_TYPE_REFERENCE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SLOT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SUBJECT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SUPPORTING_INFO	Constant for fluent queries to be used to add include statements.
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.
protected List<Annotation>	note	Additional notes/comments about the appointment.
protected BooleanType	occurrenceChanged	This appointment varies from the recurring pattern.
protected Reference	originatingAppointment	The originating appointment in a recurring set of related appointments.
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
protected List<CodeableReference>	patientInstruction	While Appointment.note contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PRACTITIONER	Fluent Client search parameter constant for practitioner
protected Reference	previousAppointment	The previous appointment in a series of related appointments.
protected CodeableConcept	priority	The priority of the appointment.
protected List<CodeableReference>	reason	The reason that this appointment is being scheduled.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	REASON_CODE	Fluent Client search parameter constant for reason-code
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	REASON_REFERENCE	Fluent Client search parameter constant for reason-reference
protected PositiveIntType	recurrenceId	The sequence number that identifies a specific appointment in a recurring pattern.
protected List<Appointment.AppointmentRecurrenceTemplateComponent>	recurrenceTemplate	The details of the recurrence pattern or template that is used to generate recurring appointments.
protected List<Reference>	replaces	Appointment replaced by this Appointment in cases where there is a cancellation, the details of the cancellation can be found in the cancellationReason property (on the referenced resource).
static final ca.uhn.fhir.rest.gclient.DateClientParam	REQUESTED_PERIOD	Fluent Client search parameter constant for requested-period
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_CATEGORY	Fluent Client search parameter constant for service-category
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SERVICE_TYPE	Fluent Client search parameter constant for service-type
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SERVICE_TYPE_REFERENCE	Fluent Client search parameter constant for service-type-reference
protected List<CodeableConcept>	serviceCategory	A broad categorization of the service that is to be performed during this appointment.
protected List<CodeableReference>	serviceType	The specific service that is to be performed during this appointment.
protected List<Reference>	slot	The slots from the participants' schedules that will be filled by the appointment.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SLOT	Fluent Client search parameter constant for slot
static final String	SP_ACTOR	Search parameter: actor
static final String	SP_APPOINTMENT_TYPE	Search parameter: appointment-type
static final String	SP_BASED_ON	Search parameter: based-on
static final String	SP_DATE	Search parameter: date
static final String	SP_GROUP	Search parameter: group
static final String	SP_IDENTIFIER	Search parameter: identifier
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_REASON_CODE	Search parameter: reason-code
static final String	SP_REASON_REFERENCE	Search parameter: reason-reference
static final String	SP_REQUESTED_PERIOD	Search parameter: requested-period
static final String	SP_SERVICE_CATEGORY	Search parameter: service-category
static final String	SP_SERVICE_TYPE	Search parameter: service-type
static final String	SP_SERVICE_TYPE_REFERENCE	Search parameter: service-type-reference
static final String	SP_SLOT	Search parameter: slot
static final String	SP_SPECIALTY	Search parameter: specialty
static final String	SP_STATUS	Search parameter: status
static final String	SP_SUBJECT	Search parameter: subject
static final String	SP_SUPPORTING_INFO	Search parameter: supporting-info
protected List<CodeableConcept>	specialty	The specialty of a practitioner that would be required to perform the service requested in this appointment.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SPECIALTY	Fluent Client search parameter constant for specialty
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 Reference	subject	The patient or group associated with the appointment, if they are to be present (usually) then they should also be included in the participant backbone element.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUBJECT	Fluent Client search parameter constant for subject
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUPPORTING_INFO	Fluent Client search parameter constant for supporting-info
protected List<Reference>	supportingInformation	Additional information to support the appointment provided when making the appointment.
protected List<VirtualServiceDetail>	virtualService	Connection details of a virtual service (e.g. conference call).

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

contained, extension, modifierExtension, SP_TEXT, text, TEXT

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

id, implicitRules, language, meta

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

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

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Appointment()	Constructor
Appointment(Appointment.AppointmentStatus status, Appointment.AppointmentParticipantComponent participant)	Constructor

Method Summary

Modifier and Type	Method	Description
Reference	addAccount()
Appointment	addAccount(Reference t)
Reference	addBasedOn()
Appointment	addBasedOn(Reference t)
Base	addChild(String name)
CodeableConcept	addClass_()
Appointment	addClass_(CodeableConcept t)
Identifier	addIdentifier()
Appointment	addIdentifier(Identifier t)
Annotation	addNote()
Appointment	addNote(Annotation t)
Appointment.AppointmentParticipantComponent	addParticipant()
Appointment	addParticipant(Appointment.AppointmentParticipantComponent t)
CodeableReference	addPatientInstruction()
Appointment	addPatientInstruction(CodeableReference t)
CodeableReference	addReason()
Appointment	addReason(CodeableReference t)
Appointment.AppointmentRecurrenceTemplateComponent	addRecurrenceTemplate()
Appointment	addRecurrenceTemplate(Appointment.AppointmentRecurrenceTemplateComponent t)
Reference	addReplaces()
Appointment	addReplaces(Reference t)
Period	addRequestedPeriod()
Appointment	addRequestedPeriod(Period t)
CodeableConcept	addServiceCategory()
Appointment	addServiceCategory(CodeableConcept t)
CodeableReference	addServiceType()
Appointment	addServiceType(CodeableReference t)
Reference	addSlot()
Appointment	addSlot(Reference t)
CodeableConcept	addSpecialty()
Appointment	addSpecialty(CodeableConcept t)
Reference	addSupportingInformation()
Appointment	addSupportingInformation(Reference t)
VirtualServiceDetail	addVirtualService()
Appointment	addVirtualService(VirtualServiceDetail t)
Appointment	copy()
void	copyValues(Appointment dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<Reference>	getAccount()
Reference	getAccountFirstRep()
CodeableConcept	getAppointmentType()
List<Reference>	getBasedOn()
Reference	getBasedOnFirstRep()
Date	getCancellationDate()
DateTimeType	getCancellationDateElement()
CodeableConcept	getCancellationReason()
List<CodeableConcept>	getClass_()
CodeableConcept	getClass_FirstRep()
Date	getCreated()
DateTimeType	getCreatedElement()
String	getDescription()
StringType	getDescriptionElement()
Date	getEnd()
InstantType	getEndElement()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
int	getMinutesDuration()
PositiveIntType	getMinutesDurationElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Annotation>	getNote()
Annotation	getNoteFirstRep()
boolean	getOccurrenceChanged()
BooleanType	getOccurrenceChangedElement()
Reference	getOriginatingAppointment()
List<Appointment.AppointmentParticipantComponent>	getParticipant()
Appointment.AppointmentParticipantComponent	getParticipantFirstRep()
List<CodeableReference>	getPatientInstruction()
CodeableReference	getPatientInstructionFirstRep()
Reference	getPreviousAppointment()
CodeableConcept	getPriority()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<CodeableReference>	getReason()
CodeableReference	getReasonFirstRep()
int	getRecurrenceId()
PositiveIntType	getRecurrenceIdElement()
List<Appointment.AppointmentRecurrenceTemplateComponent>	getRecurrenceTemplate()
Appointment.AppointmentRecurrenceTemplateComponent	getRecurrenceTemplateFirstRep()
List<Reference>	getReplaces()
Reference	getReplacesFirstRep()
List<Period>	getRequestedPeriod()
Period	getRequestedPeriodFirstRep()
ResourceType	getResourceType()
List<CodeableConcept>	getServiceCategory()
CodeableConcept	getServiceCategoryFirstRep()
List<CodeableReference>	getServiceType()
CodeableReference	getServiceTypeFirstRep()
List<Reference>	getSlot()
Reference	getSlotFirstRep()
List<CodeableConcept>	getSpecialty()
CodeableConcept	getSpecialtyFirstRep()
Date	getStart()
InstantType	getStartElement()
Appointment.AppointmentStatus	getStatus()
Enumeration<Appointment.AppointmentStatus>	getStatusElement()
Reference	getSubject()
List<Reference>	getSupportingInformation()
Reference	getSupportingInformationFirstRep()
String[]	getTypesForProperty(int hash, String name)
List<VirtualServiceDetail>	getVirtualService()
VirtualServiceDetail	getVirtualServiceFirstRep()
boolean	hasAccount()
boolean	hasAppointmentType()
boolean	hasBasedOn()
boolean	hasCancellationDate()
boolean	hasCancellationDateElement()
boolean	hasCancellationReason()
boolean	hasClass_()
boolean	hasCreated()
boolean	hasCreatedElement()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasEnd()
boolean	hasEndElement()
boolean	hasIdentifier()
boolean	hasMinutesDuration()
boolean	hasMinutesDurationElement()
boolean	hasNote()
boolean	hasOccurrenceChanged()
boolean	hasOccurrenceChangedElement()
boolean	hasOriginatingAppointment()
boolean	hasParticipant()
boolean	hasPatientInstruction()
boolean	hasPreviousAppointment()
boolean	hasPriority()
boolean	hasReason()
boolean	hasRecurrenceId()
boolean	hasRecurrenceIdElement()
boolean	hasRecurrenceTemplate()
boolean	hasReplaces()
boolean	hasRequestedPeriod()
boolean	hasServiceCategory()
boolean	hasServiceType()
boolean	hasSlot()
boolean	hasSpecialty()
boolean	hasStart()
boolean	hasStartElement()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubject()
boolean	hasSupportingInformation()
boolean	hasVirtualService()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Appointment	setAccount(List<Reference> theAccount)
Appointment	setAppointmentType(CodeableConcept value)
Appointment	setBasedOn(List<Reference> theBasedOn)
Appointment	setCancellationDate(Date value)
Appointment	setCancellationDateElement(DateTimeType value)
Appointment	setCancellationReason(CodeableConcept value)
Appointment	setClass_(List<CodeableConcept> theClass_)
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	setMinutesDuration(int value)
Appointment	setMinutesDurationElement(PositiveIntType value)
Appointment	setNote(List<Annotation> theNote)
Appointment	setOccurrenceChanged(boolean value)
Appointment	setOccurrenceChangedElement(BooleanType value)
Appointment	setOriginatingAppointment(Reference value)
Appointment	setParticipant(List<Appointment.AppointmentParticipantComponent> theParticipant)
Appointment	setPatientInstruction(List<CodeableReference> thePatientInstruction)
Appointment	setPreviousAppointment(Reference value)
Appointment	setPriority(CodeableConcept value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Appointment	setReason(List<CodeableReference> theReason)
Appointment	setRecurrenceId(int value)
Appointment	setRecurrenceIdElement(PositiveIntType value)
Appointment	setRecurrenceTemplate(List<Appointment.AppointmentRecurrenceTemplateComponent> theRecurrenceTemplate)
Appointment	setReplaces(List<Reference> theReplaces)
Appointment	setRequestedPeriod(List<Period> theRequestedPeriod)
Appointment	setServiceCategory(List<CodeableConcept> theServiceCategory)
Appointment	setServiceType(List<CodeableReference> 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	setSubject(Reference value)
Appointment	setSupportingInformation(List<Reference> theSupportingInformation)
Appointment	setVirtualService(List<VirtualServiceDetail> theVirtualService)
protected Appointment	typedCopy()

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

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

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

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

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

getStructureFhirVersionEnum, isResource, setId

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN, setXhtml

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.

cancellationReason

protected CodeableConcept cancellationReason

The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.

class_

protected List<CodeableConcept> class_

Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.

serviceCategory

protected List<CodeableConcept> serviceCategory

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

serviceType

protected List<CodeableReference> serviceType

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

specialty

protected List<CodeableConcept> specialty

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

appointmentType

protected CodeableConcept appointmentType

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

reason

protected List<CodeableReference> reason

The reason that this appointment is being scheduled. This is more clinical than administrative. This can be coded, or 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 CodeableConcept 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 note field.

replaces

protected List<Reference> replaces

Appointment replaced by this Appointment in cases where there is a cancellation, the details of the cancellation can be found in the cancellationReason property (on the referenced resource).

virtualService

protected List<VirtualServiceDetail> virtualService

Connection details of a virtual service (e.g. conference call).

supportingInformation

protected List<Reference> supportingInformation

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

previousAppointment

protected Reference previousAppointment

The previous appointment in a series of related appointments.

originatingAppointment

protected Reference originatingAppointment

The originating appointment in a recurring set of related appointments.

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. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.

requestedPeriod

protected List<Period> requestedPeriod

A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.

slot

protected List<Reference> slot

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

account

protected List<Reference> account

The set of accounts that is expected to be used for billing the activities that result from this 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.

cancellationDate

protected DateTimeType cancellationDate

The date/time describing when the appointment was cancelled.

note

protected List<Annotation> note

Additional notes/comments about the appointment.

patientInstruction

protected List<CodeableReference> patientInstruction

While Appointment.note contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).

basedOn

protected List<Reference> basedOn

The request this appointment is allocated to assess (e.g. incoming referral or procedure request).

subject

protected Reference subject

The patient or group associated with the appointment, if they are to be present (usually) then they should also be included in the participant backbone element.

participant

protected List<Appointment.AppointmentParticipantComponent> participant

List of participants involved in the appointment.

recurrenceId

protected PositiveIntType recurrenceId

The sequence number that identifies a specific appointment in a recurring pattern.

occurrenceChanged

protected BooleanType occurrenceChanged

This appointment varies from the recurring pattern.

recurrenceTemplate

protected List<Appointment.AppointmentRecurrenceTemplateComponent> recurrenceTemplate

The details of the recurrence pattern or template that is used to generate recurring appointments.

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

public static final String SP_BASED_ON

Search parameter: based-on

Description: The service request this appointment is allocated to assess
Type: reference
Path: Appointment.basedOn

See Also:

• Constant Field Values

BASED_ON

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

Fluent Client search parameter constant for based-on

Description: The service request this appointment is allocated to assess
Type: reference
Path: Appointment.basedOn

INCLUDE_BASED_ON

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

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

SP_GROUP

public static final String SP_GROUP

Search parameter: group

Description: One of the individuals of the appointment is this patient
Type: reference
Path: Appointment.participant.actor.where(resolve() is Group) | Appointment.subject.where(resolve() is Group)

See Also:

• Constant Field Values

GROUP

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

Fluent Client search parameter constant for group

Description: One of the individuals of the appointment is this patient
Type: reference
Path: Appointment.participant.actor.where(resolve() is Group) | Appointment.subject.where(resolve() is Group)

INCLUDE_GROUP

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

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

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.where(resolve() is Location)

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.where(resolve() is Location)

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_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_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.where(resolve() is Practitioner)

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.where(resolve() is Practitioner)

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_REASON_CODE

public static final String SP_REASON_CODE

Search parameter: reason-code

Description: Reference to a concept (by class)
Type: token
Path: Appointment.reason.concept

See Also:

• Constant Field Values

REASON_CODE

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

Fluent Client search parameter constant for reason-code

Description: Reference to a concept (by class)
Type: token
Path: Appointment.reason.concept

SP_REASON_REFERENCE

public static final String SP_REASON_REFERENCE

Search parameter: reason-reference

Description: Reference to a resource (by instance)
Type: reference
Path: Appointment.reason.reference

See Also:

• Constant Field Values

REASON_REFERENCE

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

Fluent Client search parameter constant for reason-reference

Description: Reference to a resource (by instance)
Type: reference
Path: Appointment.reason.reference

INCLUDE_REASON_REFERENCE

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

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

SP_REQUESTED_PERIOD

public static final String SP_REQUESTED_PERIOD

Search parameter: requested-period

Description: During what period was the Appointment requested to take place
Type: date
Path: requestedPeriod

See Also:

• Constant Field Values

REQUESTED_PERIOD

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

Fluent Client search parameter constant for requested-period

Description: During what period was the Appointment requested to take place
Type: date
Path: requestedPeriod

SP_SERVICE_CATEGORY

public static final String SP_SERVICE_CATEGORY

Search parameter: service-category

Description: A broad categorization of the service that is to be performed during this appointment
Type: token
Path: Appointment.serviceCategory

See Also:

• Constant Field Values

SERVICE_CATEGORY

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

Fluent Client search parameter constant for service-category

Description: A broad categorization of the service that is to be performed during this appointment
Type: token
Path: Appointment.serviceCategory

SP_SERVICE_TYPE_REFERENCE

public static final String SP_SERVICE_TYPE_REFERENCE

Search parameter: service-type-reference

Description: The specific service (by HealthcareService) that is to be performed during this appointment
Type: reference
Path: Appointment.serviceType.reference

See Also:

• Constant Field Values

SERVICE_TYPE_REFERENCE

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

Fluent Client search parameter constant for service-type-reference

Description: The specific service (by HealthcareService) that is to be performed during this appointment
Type: reference
Path: Appointment.serviceType.reference

INCLUDE_SERVICE_TYPE_REFERENCE

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

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

SP_SERVICE_TYPE

public static final String SP_SERVICE_TYPE

Search parameter: service-type

Description: The specific service (by coding) that is to be performed during this appointment
Type: token
Path: Appointment.serviceType.concept

See Also:

• Constant Field Values

SERVICE_TYPE

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

Fluent Client search parameter constant for service-type

Description: The specific service (by coding) that is to be performed during this appointment
Type: token
Path: Appointment.serviceType.concept

SP_SLOT

public static final String SP_SLOT

Search parameter: slot

Description: The slots that this appointment is filling
Type: reference
Path: Appointment.slot

See Also:

• Constant Field Values

SLOT

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

Fluent Client search parameter constant for slot

Description: The slots that this appointment is filling
Type: reference
Path: Appointment.slot

INCLUDE_SLOT

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

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

SP_SPECIALTY

public static final String SP_SPECIALTY

Search parameter: specialty

Description: The specialty of a practitioner that would be required to perform the service requested in this appointment
Type: token
Path: Appointment.specialty

See Also:

• Constant Field Values

SPECIALTY

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

Fluent Client search parameter constant for specialty

Description: The specialty of a practitioner that would be required to perform the service requested in this appointment
Type: token
Path: Appointment.specialty

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

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter: subject

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

See Also:

• Constant Field Values

SUBJECT

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

Fluent Client search parameter constant for subject

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

INCLUDE_SUBJECT

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

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

SP_SUPPORTING_INFO

public static final String SP_SUPPORTING_INFO

Search parameter: supporting-info

Description: Additional information to support the appointment
Type: reference
Path: Appointment.supportingInformation

See Also:

• Constant Field Values

SUPPORTING_INFO

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

Fluent Client search parameter constant for supporting-info

Description: Additional information to support the appointment
Type: reference
Path: Appointment.supportingInformation

INCLUDE_SUPPORTING_INFO

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

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

SP_DATE

public static final String SP_DATE

Search parameter: date

Description: Multiple Resources: [AdverseEvent](adverseevent.html): When the event occurred [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded [Appointment](appointment.html): Appointment date/time. [AuditEvent](auditevent.html): Time when the event was recorded [CarePlan](careplan.html): Time period plan covers [CareTeam](careteam.html): A date within the coverage time period. [ClinicalImpression](clinicalimpression.html): When the assessment was documented [Composition](composition.html): Composition editing time [Consent](consent.html): When consent was agreed to [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report [DocumentReference](documentreference.html): When this document reference was created [Encounter](encounter.html): A date within the actualPeriod the Encounter lasted [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated [Flag](flag.html): Time period when flag is active [Immunization](immunization.html): Vaccination (non)-Administration Date [ImmunizationEvaluation](immunizationevaluation.html): Date the evaluation was generated [ImmunizationRecommendation](immunizationrecommendation.html): Date recommendation(s) created [Invoice](invoice.html): Invoice date / posting date [List](list.html): When the list was prepared [MeasureReport](measurereport.html): The date of the measure report [NutritionIntake](nutritionintake.html): Date when patient was taking (or not taking) the medication [Observation](observation.html): Clinically relevant time/time-period for observation [Procedure](procedure.html): When the procedure occurred or is occurring [ResearchSubject](researchsubject.html): Start and end of participation [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
Type: date
Path: AdverseEvent.occurrence.ofType(dateTime) | AdverseEvent.occurrence.ofType(Period) | AdverseEvent.occurrence.ofType(Timing) | AllergyIntolerance.recordedDate | (start | requestedPeriod.start).first() | AuditEvent.recorded | CarePlan.period | ClinicalImpression.date | Composition.date | Consent.date | DiagnosticReport.effective.ofType(dateTime) | DiagnosticReport.effective.ofType(Period) | DocumentReference.date | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence.ofType(dateTime)) | ImmunizationEvaluation.date | ImmunizationRecommendation.date | Invoice.date | List.date | MeasureReport.date | NutritionIntake.occurrence.ofType(dateTime) | NutritionIntake.occurrence.ofType(Period) | Observation.effective.ofType(dateTime) | Observation.effective.ofType(Period) | Observation.effective.ofType(Timing) | Observation.effective.ofType(instant) | Procedure.occurrence.ofType(dateTime) | Procedure.occurrence.ofType(Period) | Procedure.occurrence.ofType(Timing) | ResearchSubject.period | (RiskAssessment.occurrence.ofType(dateTime)) | SupplyRequest.authoredOn

See Also:

• Constant Field Values

DATE

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

Fluent Client search parameter constant for date

Description: Multiple Resources: [AdverseEvent](adverseevent.html): When the event occurred [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded [Appointment](appointment.html): Appointment date/time. [AuditEvent](auditevent.html): Time when the event was recorded [CarePlan](careplan.html): Time period plan covers [CareTeam](careteam.html): A date within the coverage time period. [ClinicalImpression](clinicalimpression.html): When the assessment was documented [Composition](composition.html): Composition editing time [Consent](consent.html): When consent was agreed to [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report [DocumentReference](documentreference.html): When this document reference was created [Encounter](encounter.html): A date within the actualPeriod the Encounter lasted [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated [Flag](flag.html): Time period when flag is active [Immunization](immunization.html): Vaccination (non)-Administration Date [ImmunizationEvaluation](immunizationevaluation.html): Date the evaluation was generated [ImmunizationRecommendation](immunizationrecommendation.html): Date recommendation(s) created [Invoice](invoice.html): Invoice date / posting date [List](list.html): When the list was prepared [MeasureReport](measurereport.html): The date of the measure report [NutritionIntake](nutritionintake.html): Date when patient was taking (or not taking) the medication [Observation](observation.html): Clinically relevant time/time-period for observation [Procedure](procedure.html): When the procedure occurred or is occurring [ResearchSubject](researchsubject.html): Start and end of participation [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
Type: date
Path: AdverseEvent.occurrence.ofType(dateTime) | AdverseEvent.occurrence.ofType(Period) | AdverseEvent.occurrence.ofType(Timing) | AllergyIntolerance.recordedDate | (start | requestedPeriod.start).first() | AuditEvent.recorded | CarePlan.period | ClinicalImpression.date | Composition.date | Consent.date | DiagnosticReport.effective.ofType(dateTime) | DiagnosticReport.effective.ofType(Period) | DocumentReference.date | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence.ofType(dateTime)) | ImmunizationEvaluation.date | ImmunizationRecommendation.date | Invoice.date | List.date | MeasureReport.date | NutritionIntake.occurrence.ofType(dateTime) | NutritionIntake.occurrence.ofType(Period) | Observation.effective.ofType(dateTime) | Observation.effective.ofType(Period) | Observation.effective.ofType(Timing) | Observation.effective.ofType(instant) | Procedure.occurrence.ofType(dateTime) | Procedure.occurrence.ofType(Period) | Procedure.occurrence.ofType(Timing) | ResearchSubject.period | (RiskAssessment.occurrence.ofType(dateTime)) | SupplyRequest.authoredOn

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Multiple Resources: [Account](account.html): Account number [AdverseEvent](adverseevent.html): Business identifier for the event [AllergyIntolerance](allergyintolerance.html): External ids for this item [Appointment](appointment.html): An Identifier of the Appointment [AppointmentResponse](appointmentresponse.html): An Identifier in this appointment response [Basic](basic.html): Business identifier [BodyStructure](bodystructure.html): Bodystructure identifier [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [ChargeItem](chargeitem.html): Business Identifier for item [Claim](claim.html): The primary identifier of the financial resource [ClaimResponse](claimresponse.html): The identity of the ClaimResponse [ClinicalImpression](clinicalimpression.html): Business identifier [Communication](communication.html): Unique identifier [CommunicationRequest](communicationrequest.html): Unique identifier [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [Contract](contract.html): The identity of the contract [Coverage](coverage.html): The primary identifier of the insured and the coverage [CoverageEligibilityRequest](coverageeligibilityrequest.html): The business identifier of the Eligibility [CoverageEligibilityResponse](coverageeligibilityresponse.html): The business identifier [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DeviceUsage](deviceusage.html): Search by identifier [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EnrollmentRequest](enrollmentrequest.html): The business identifier of the Enrollment [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [ExplanationOfBenefit](explanationofbenefit.html): The business identifier of the Explanation of Benefit [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Flag](flag.html): Business identifier [Goal](goal.html): External Ids for this goal [GuidanceResponse](guidanceresponse.html): The identifier of the guidance response [ImagingSelection](imagingselection.html): Identifiers for the imaging selection [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [ImmunizationEvaluation](immunizationevaluation.html): ID of the evaluation [ImmunizationRecommendation](immunizationrecommendation.html): Business identifier [Invoice](invoice.html): Business Identifier for item [List](list.html): Business identifier [MeasureReport](measurereport.html): External identifier of the measure report to be returned [Medication](medication.html): Returns medications with this external identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationStatement](medicationstatement.html): Return statements with this external identifier [MolecularSequence](molecularsequence.html): The unique identity for a particular sequence [NutritionIntake](nutritionintake.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Person](person.html): A person Identifier [Procedure](procedure.html): A unique identifier for a procedure [QuestionnaireResponse](questionnaireresponse.html): The unique identifier for the questionnaire response [RelatedPerson](relatedperson.html): An Identifier of the RelatedPerson [RequestOrchestration](requestorchestration.html): External identifiers for the request orchestration [ResearchSubject](researchsubject.html): Business Identifier for research subject in a study [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [Specimen](specimen.html): The unique identifier associated with the specimen [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [Task](task.html): Search for a task instance by its business identifier [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: Account.identifier | AdverseEvent.identifier | AllergyIntolerance.identifier | Appointment.identifier | AppointmentResponse.identifier | Basic.identifier | BodyStructure.identifier | CarePlan.identifier | CareTeam.identifier | ChargeItem.identifier | Claim.identifier | ClaimResponse.identifier | ClinicalImpression.identifier | Communication.identifier | CommunicationRequest.identifier | Composition.identifier | Condition.identifier | Consent.identifier | Contract.identifier | Coverage.identifier | CoverageEligibilityRequest.identifier | CoverageEligibilityResponse.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DeviceUsage.identifier | DiagnosticReport.identifier | DocumentReference.identifier | Encounter.identifier | EnrollmentRequest.identifier | EpisodeOfCare.identifier | ExplanationOfBenefit.identifier | FamilyMemberHistory.identifier | Flag.identifier | Goal.identifier | GuidanceResponse.identifier | ImagingSelection.identifier | ImagingStudy.identifier | Immunization.identifier | ImmunizationEvaluation.identifier | ImmunizationRecommendation.identifier | Invoice.identifier | List.identifier | MeasureReport.identifier | Medication.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.identifier | MolecularSequence.identifier | NutritionIntake.identifier | NutritionOrder.identifier | Observation.identifier | Person.identifier | Procedure.identifier | QuestionnaireResponse.identifier | RelatedPerson.identifier | RequestOrchestration.identifier | ResearchSubject.identifier | RiskAssessment.identifier | ServiceRequest.identifier | Specimen.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | Task.identifier | VisionPrescription.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: Multiple Resources: [Account](account.html): Account number [AdverseEvent](adverseevent.html): Business identifier for the event [AllergyIntolerance](allergyintolerance.html): External ids for this item [Appointment](appointment.html): An Identifier of the Appointment [AppointmentResponse](appointmentresponse.html): An Identifier in this appointment response [Basic](basic.html): Business identifier [BodyStructure](bodystructure.html): Bodystructure identifier [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [ChargeItem](chargeitem.html): Business Identifier for item [Claim](claim.html): The primary identifier of the financial resource [ClaimResponse](claimresponse.html): The identity of the ClaimResponse [ClinicalImpression](clinicalimpression.html): Business identifier [Communication](communication.html): Unique identifier [CommunicationRequest](communicationrequest.html): Unique identifier [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [Contract](contract.html): The identity of the contract [Coverage](coverage.html): The primary identifier of the insured and the coverage [CoverageEligibilityRequest](coverageeligibilityrequest.html): The business identifier of the Eligibility [CoverageEligibilityResponse](coverageeligibilityresponse.html): The business identifier [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DeviceUsage](deviceusage.html): Search by identifier [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EnrollmentRequest](enrollmentrequest.html): The business identifier of the Enrollment [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [ExplanationOfBenefit](explanationofbenefit.html): The business identifier of the Explanation of Benefit [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Flag](flag.html): Business identifier [Goal](goal.html): External Ids for this goal [GuidanceResponse](guidanceresponse.html): The identifier of the guidance response [ImagingSelection](imagingselection.html): Identifiers for the imaging selection [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [ImmunizationEvaluation](immunizationevaluation.html): ID of the evaluation [ImmunizationRecommendation](immunizationrecommendation.html): Business identifier [Invoice](invoice.html): Business Identifier for item [List](list.html): Business identifier [MeasureReport](measurereport.html): External identifier of the measure report to be returned [Medication](medication.html): Returns medications with this external identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationStatement](medicationstatement.html): Return statements with this external identifier [MolecularSequence](molecularsequence.html): The unique identity for a particular sequence [NutritionIntake](nutritionintake.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Person](person.html): A person Identifier [Procedure](procedure.html): A unique identifier for a procedure [QuestionnaireResponse](questionnaireresponse.html): The unique identifier for the questionnaire response [RelatedPerson](relatedperson.html): An Identifier of the RelatedPerson [RequestOrchestration](requestorchestration.html): External identifiers for the request orchestration [ResearchSubject](researchsubject.html): Business Identifier for research subject in a study [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [Specimen](specimen.html): The unique identifier associated with the specimen [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [Task](task.html): Search for a task instance by its business identifier [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: Account.identifier | AdverseEvent.identifier | AllergyIntolerance.identifier | Appointment.identifier | AppointmentResponse.identifier | Basic.identifier | BodyStructure.identifier | CarePlan.identifier | CareTeam.identifier | ChargeItem.identifier | Claim.identifier | ClaimResponse.identifier | ClinicalImpression.identifier | Communication.identifier | CommunicationRequest.identifier | Composition.identifier | Condition.identifier | Consent.identifier | Contract.identifier | Coverage.identifier | CoverageEligibilityRequest.identifier | CoverageEligibilityResponse.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DeviceUsage.identifier | DiagnosticReport.identifier | DocumentReference.identifier | Encounter.identifier | EnrollmentRequest.identifier | EpisodeOfCare.identifier | ExplanationOfBenefit.identifier | FamilyMemberHistory.identifier | Flag.identifier | Goal.identifier | GuidanceResponse.identifier | ImagingSelection.identifier | ImagingStudy.identifier | Immunization.identifier | ImmunizationEvaluation.identifier | ImmunizationRecommendation.identifier | Invoice.identifier | List.identifier | MeasureReport.identifier | Medication.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.identifier | MolecularSequence.identifier | NutritionIntake.identifier | NutritionOrder.identifier | Observation.identifier | Person.identifier | Procedure.identifier | QuestionnaireResponse.identifier | RelatedPerson.identifier | RequestOrchestration.identifier | ResearchSubject.identifier | RiskAssessment.identifier | ServiceRequest.identifier | Specimen.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | Task.identifier | VisionPrescription.identifier

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: Multiple Resources: [Account](account.html): The entity that caused the expenses [AdverseEvent](adverseevent.html): Subject impacted by event [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [Appointment](appointment.html): One of the individuals of the appointment is this patient [AppointmentResponse](appointmentresponse.html): This Response is for this Patient [AuditEvent](auditevent.html): Where the activity involved patient data [Basic](basic.html): Identifies the focus of this resource [BodyStructure](bodystructure.html): Who this is about [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ChargeItem](chargeitem.html): Individual service was done for/to [Claim](claim.html): Patient receiving the products or services [ClaimResponse](claimresponse.html): The subject of care [ClinicalImpression](clinicalimpression.html): Patient assessed [Communication](communication.html): Focus of message [CommunicationRequest](communicationrequest.html): Focus of message [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [Contract](contract.html): The identity of the subject of the contract (if a patient) [Coverage](coverage.html): Retrieve coverages for a patient [CoverageEligibilityRequest](coverageeligibilityrequest.html): The reference to the patient [CoverageEligibilityResponse](coverageeligibilityresponse.html): The reference to the patient [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EnrollmentRequest](enrollmentrequest.html): The party to be enrolled [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [ExplanationOfBenefit](explanationofbenefit.html): The reference to the patient [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [GuidanceResponse](guidanceresponse.html): The identity of a patient to search for guidance response results [ImagingSelection](imagingselection.html): Who the study is about [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [ImmunizationEvaluation](immunizationevaluation.html): The patient being evaluated [ImmunizationRecommendation](immunizationrecommendation.html): Who this profile is for [Invoice](invoice.html): Recipient(s) of goods and services [List](list.html): If all resources have the same subject [MeasureReport](measurereport.html): The identity of a patient to search for individual measure report results for [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationStatement](medicationstatement.html): Returns statements for a specific patient. [MolecularSequence](molecularsequence.html): The subject that the sequence is about [NutritionIntake](nutritionintake.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Person](person.html): The Person links to this Patient [Procedure](procedure.html): Search by subject - a patient [Provenance](provenance.html): Where the activity involved patient data [QuestionnaireResponse](questionnaireresponse.html): The patient that is the subject of the questionnaire response [RelatedPerson](relatedperson.html): The patient this related person is related to [RequestOrchestration](requestorchestration.html): The identity of a patient to search for request orchestrations [ResearchSubject](researchsubject.html): Who or what is part of study [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [Specimen](specimen.html): The patient the specimen comes from [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [Task](task.html): Search by patient [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: Account.subject.where(resolve() is Patient) | AdverseEvent.subject.where(resolve() is Patient) | AllergyIntolerance.patient | Appointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient) | AppointmentResponse.actor.where(resolve() is Patient) | AuditEvent.patient | Basic.subject.where(resolve() is Patient) | BodyStructure.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ChargeItem.subject.where(resolve() is Patient) | Claim.patient | ClaimResponse.patient | ClinicalImpression.subject.where(resolve() is Patient) | Communication.subject.where(resolve() is Patient) | CommunicationRequest.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | Contract.subject.where(resolve() is Patient) | Coverage.beneficiary | CoverageEligibilityRequest.patient | CoverageEligibilityResponse.patient | DetectedIssue.subject.where(resolve() is Patient) | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EnrollmentRequest.candidate | EpisodeOfCare.patient | ExplanationOfBenefit.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | GuidanceResponse.subject.where(resolve() is Patient) | ImagingSelection.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | ImmunizationEvaluation.patient | ImmunizationRecommendation.patient | Invoice.subject.where(resolve() is Patient) | List.subject.where(resolve() is Patient) | MeasureReport.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationStatement.subject.where(resolve() is Patient) | MolecularSequence.subject.where(resolve() is Patient) | NutritionIntake.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Person.link.target.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | Provenance.patient | QuestionnaireResponse.subject.where(resolve() is Patient) | RelatedPerson.patient | RequestOrchestration.subject.where(resolve() is Patient) | ResearchSubject.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | Specimen.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | Task.for.where(resolve() is Patient) | VisionPrescription.patient

See Also:

• Constant Field Values

PATIENT

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

Fluent Client search parameter constant for patient

Description: Multiple Resources: [Account](account.html): The entity that caused the expenses [AdverseEvent](adverseevent.html): Subject impacted by event [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [Appointment](appointment.html): One of the individuals of the appointment is this patient [AppointmentResponse](appointmentresponse.html): This Response is for this Patient [AuditEvent](auditevent.html): Where the activity involved patient data [Basic](basic.html): Identifies the focus of this resource [BodyStructure](bodystructure.html): Who this is about [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ChargeItem](chargeitem.html): Individual service was done for/to [Claim](claim.html): Patient receiving the products or services [ClaimResponse](claimresponse.html): The subject of care [ClinicalImpression](clinicalimpression.html): Patient assessed [Communication](communication.html): Focus of message [CommunicationRequest](communicationrequest.html): Focus of message [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [Contract](contract.html): The identity of the subject of the contract (if a patient) [Coverage](coverage.html): Retrieve coverages for a patient [CoverageEligibilityRequest](coverageeligibilityrequest.html): The reference to the patient [CoverageEligibilityResponse](coverageeligibilityresponse.html): The reference to the patient [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EnrollmentRequest](enrollmentrequest.html): The party to be enrolled [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [ExplanationOfBenefit](explanationofbenefit.html): The reference to the patient [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [GuidanceResponse](guidanceresponse.html): The identity of a patient to search for guidance response results [ImagingSelection](imagingselection.html): Who the study is about [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [ImmunizationEvaluation](immunizationevaluation.html): The patient being evaluated [ImmunizationRecommendation](immunizationrecommendation.html): Who this profile is for [Invoice](invoice.html): Recipient(s) of goods and services [List](list.html): If all resources have the same subject [MeasureReport](measurereport.html): The identity of a patient to search for individual measure report results for [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationStatement](medicationstatement.html): Returns statements for a specific patient. [MolecularSequence](molecularsequence.html): The subject that the sequence is about [NutritionIntake](nutritionintake.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Person](person.html): The Person links to this Patient [Procedure](procedure.html): Search by subject - a patient [Provenance](provenance.html): Where the activity involved patient data [QuestionnaireResponse](questionnaireresponse.html): The patient that is the subject of the questionnaire response [RelatedPerson](relatedperson.html): The patient this related person is related to [RequestOrchestration](requestorchestration.html): The identity of a patient to search for request orchestrations [ResearchSubject](researchsubject.html): Who or what is part of study [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [Specimen](specimen.html): The patient the specimen comes from [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [Task](task.html): Search by patient [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: Account.subject.where(resolve() is Patient) | AdverseEvent.subject.where(resolve() is Patient) | AllergyIntolerance.patient | Appointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient) | AppointmentResponse.actor.where(resolve() is Patient) | AuditEvent.patient | Basic.subject.where(resolve() is Patient) | BodyStructure.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ChargeItem.subject.where(resolve() is Patient) | Claim.patient | ClaimResponse.patient | ClinicalImpression.subject.where(resolve() is Patient) | Communication.subject.where(resolve() is Patient) | CommunicationRequest.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | Contract.subject.where(resolve() is Patient) | Coverage.beneficiary | CoverageEligibilityRequest.patient | CoverageEligibilityResponse.patient | DetectedIssue.subject.where(resolve() is Patient) | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EnrollmentRequest.candidate | EpisodeOfCare.patient | ExplanationOfBenefit.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | GuidanceResponse.subject.where(resolve() is Patient) | ImagingSelection.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | ImmunizationEvaluation.patient | ImmunizationRecommendation.patient | Invoice.subject.where(resolve() is Patient) | List.subject.where(resolve() is Patient) | MeasureReport.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationStatement.subject.where(resolve() is Patient) | MolecularSequence.subject.where(resolve() is Patient) | NutritionIntake.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Person.link.target.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | Provenance.patient | QuestionnaireResponse.subject.where(resolve() is Patient) | RelatedPerson.patient | RequestOrchestration.subject.where(resolve() is Patient) | ResearchSubject.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | Specimen.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | Task.for.where(resolve() is Patient) | VisionPrescription.patient

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

Constructor Details

Appointment

public Appointment()

Constructor

Appointment

public Appointment(Appointment.AppointmentStatus status,
 Appointment.AppointmentParticipantComponent participant)

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

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.

getCancellationReason

public CodeableConcept getCancellationReason()

Returns:

cancellationReason (The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.)

hasCancellationReason

public boolean hasCancellationReason()

setCancellationReason

public Appointment setCancellationReason(CodeableConcept value)

Parameters:

value - cancellationReason (The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.)

getClass_

public List<CodeableConcept> getClass_()

Returns:

class_ (Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.)

setClass_

public Appointment setClass_(List<CodeableConcept> theClass_)

Returns:

Returns a reference to this for easy method chaining

hasClass_

public boolean hasClass_()

addClass_

public CodeableConcept addClass_()

addClass_

public Appointment addClass_(CodeableConcept t)

getClass_FirstRep

public CodeableConcept getClass_FirstRep()

Returns:

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

getServiceCategory

public List<CodeableConcept> getServiceCategory()

Returns:

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

setServiceCategory

public Appointment setServiceCategory(List<CodeableConcept> theServiceCategory)

Returns:

Returns a reference to this for easy method chaining

hasServiceCategory

public boolean hasServiceCategory()

addServiceCategory

public CodeableConcept addServiceCategory()

addServiceCategory

public Appointment addServiceCategory(CodeableConcept t)

getServiceCategoryFirstRep

public CodeableConcept getServiceCategoryFirstRep()

Returns:

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

getServiceType

public List<CodeableReference> getServiceType()

Returns:

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

setServiceType

public Appointment setServiceType(List<CodeableReference> theServiceType)

Returns:

Returns a reference to this for easy method chaining

hasServiceType

public boolean hasServiceType()

addServiceType

public CodeableReference addServiceType()

addServiceType

public Appointment addServiceType(CodeableReference t)

getServiceTypeFirstRep

public CodeableReference getServiceTypeFirstRep()

Returns:

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

getSpecialty

public List<CodeableConcept> getSpecialty()

Returns:

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

setSpecialty

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

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

Returns:

reason (The reason that this appointment is being scheduled. This is more clinical than administrative. This can be coded, or 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.)

setReason

public Appointment setReason(List<CodeableReference> theReason)

Returns:

Returns a reference to this for easy method chaining

hasReason

public boolean hasReason()

addReason

public CodeableReference addReason()

addReason

public Appointment addReason(CodeableReference t)

getReasonFirstRep

public CodeableReference getReasonFirstRep()

Returns:

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

getPriority

public CodeableConcept getPriority()

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

hasPriority

public boolean hasPriority()

setPriority

public Appointment setPriority(CodeableConcept 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).)

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 note 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 note 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 note 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 note field.

getReplaces

public List<Reference> getReplaces()

Returns:

replaces (Appointment replaced by this Appointment in cases where there is a cancellation, the details of the cancellation can be found in the cancellationReason property (on the referenced resource).)

setReplaces

public Appointment setReplaces(List<Reference> theReplaces)

Returns:

Returns a reference to this for easy method chaining

hasReplaces

public boolean hasReplaces()

addReplaces

public Reference addReplaces()

addReplaces

public Appointment addReplaces(Reference t)

getReplacesFirstRep

public Reference getReplacesFirstRep()

Returns:

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

getVirtualService

public List<VirtualServiceDetail> getVirtualService()

Returns:

virtualService (Connection details of a virtual service (e.g. conference call).)

setVirtualService

public Appointment setVirtualService(List<VirtualServiceDetail> theVirtualService)

Returns:

Returns a reference to this for easy method chaining

hasVirtualService

public boolean hasVirtualService()

addVirtualService

public VirtualServiceDetail addVirtualService()

addVirtualService

public Appointment addVirtualService(VirtualServiceDetail t)

getVirtualServiceFirstRep

public VirtualServiceDetail getVirtualServiceFirstRep()

Returns:

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

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

getPreviousAppointment

public Reference getPreviousAppointment()

Returns:

previousAppointment (The previous appointment in a series of related appointments.)

hasPreviousAppointment

public boolean hasPreviousAppointment()

setPreviousAppointment

public Appointment setPreviousAppointment(Reference value)

Parameters:

value - previousAppointment (The previous appointment in a series of related appointments.)

getOriginatingAppointment

public Reference getOriginatingAppointment()

Returns:

originatingAppointment (The originating appointment in a recurring set of related appointments.)

hasOriginatingAppointment

public boolean hasOriginatingAppointment()

setOriginatingAppointment

public Appointment setOriginatingAppointment(Reference value)

Parameters:

value - originatingAppointment (The originating appointment in a recurring set of related appointments.)

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. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.). 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. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.). 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. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.

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. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.

getRequestedPeriod

public List<Period> getRequestedPeriod()

Returns:

requestedPeriod (A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.)

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

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

getAccount

public List<Reference> getAccount()

Returns:

account (The set of accounts that is expected to be used for billing the activities that result from this Appointment.)

setAccount

public Appointment setAccount(List<Reference> theAccount)

Returns:

Returns a reference to this for easy method chaining

hasAccount

public boolean hasAccount()

addAccount

public Reference addAccount()

addAccount

public Appointment addAccount(Reference t)

getAccountFirstRep

public Reference getAccountFirstRep()

Returns:

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

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.

getCancellationDateElement

public DateTimeType getCancellationDateElement()

Returns:

cancellationDate (The date/time describing when the appointment was cancelled.). This is the underlying object with id, value and extensions. The accessor "getCancellationDate" gives direct access to the value

hasCancellationDateElement

public boolean hasCancellationDateElement()

hasCancellationDate

public boolean hasCancellationDate()

setCancellationDateElement

public Appointment setCancellationDateElement(DateTimeType value)

Parameters:

value - cancellationDate (The date/time describing when the appointment was cancelled.). This is the underlying object with id, value and extensions. The accessor "getCancellationDate" gives direct access to the value

getCancellationDate

public Date getCancellationDate()

Returns:

The date/time describing when the appointment was cancelled.

setCancellationDate

public Appointment setCancellationDate(Date value)

Parameters:

value - The date/time describing when the appointment was cancelled.

getNote

public List<Annotation> getNote()

Returns:

note (Additional notes/comments about the appointment.)

setNote

public Appointment setNote(List<Annotation> theNote)

Returns:

Returns a reference to this for easy method chaining

hasNote

public boolean hasNote()

addNote

public Annotation addNote()

addNote

public Appointment addNote(Annotation t)

getNoteFirstRep

public Annotation getNoteFirstRep()

Returns:

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

getPatientInstruction

public List<CodeableReference> getPatientInstruction()

Returns:

patientInstruction (While Appointment.note contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).)

setPatientInstruction

public Appointment setPatientInstruction(List<CodeableReference> thePatientInstruction)

Returns:

Returns a reference to this for easy method chaining

hasPatientInstruction

public boolean hasPatientInstruction()

addPatientInstruction

public CodeableReference addPatientInstruction()

addPatientInstruction

public Appointment addPatientInstruction(CodeableReference t)

getPatientInstructionFirstRep

public CodeableReference getPatientInstructionFirstRep()

Returns:

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

getBasedOn

public List<Reference> getBasedOn()

Returns:

basedOn (The request this appointment is allocated to assess (e.g. incoming referral or procedure request).)

setBasedOn

public Appointment setBasedOn(List<Reference> theBasedOn)

Returns:

Returns a reference to this for easy method chaining

hasBasedOn

public boolean hasBasedOn()

addBasedOn

public Reference addBasedOn()

addBasedOn

public Appointment addBasedOn(Reference t)

getBasedOnFirstRep

public Reference getBasedOnFirstRep()

Returns:

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

getSubject

public Reference getSubject()

Returns:

subject (The patient or group associated with the appointment, if they are to be present (usually) then they should also be included in the participant backbone element.)

hasSubject

public boolean hasSubject()

setSubject

public Appointment setSubject(Reference value)

Parameters:

value - subject (The patient or group associated with the appointment, if they are to be present (usually) then they should also be included in the participant backbone element.)

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

getRecurrenceIdElement

public PositiveIntType getRecurrenceIdElement()

Returns:

recurrenceId (The sequence number that identifies a specific appointment in a recurring pattern.). This is the underlying object with id, value and extensions. The accessor "getRecurrenceId" gives direct access to the value

hasRecurrenceIdElement

public boolean hasRecurrenceIdElement()

hasRecurrenceId

public boolean hasRecurrenceId()

setRecurrenceIdElement

public Appointment setRecurrenceIdElement(PositiveIntType value)

Parameters:

value - recurrenceId (The sequence number that identifies a specific appointment in a recurring pattern.). This is the underlying object with id, value and extensions. The accessor "getRecurrenceId" gives direct access to the value

getRecurrenceId

public int getRecurrenceId()

Returns:

The sequence number that identifies a specific appointment in a recurring pattern.

setRecurrenceId

public Appointment setRecurrenceId(int value)

Parameters:

value - The sequence number that identifies a specific appointment in a recurring pattern.

getOccurrenceChangedElement

public BooleanType getOccurrenceChangedElement()

Returns:

occurrenceChanged (This appointment varies from the recurring pattern.). This is the underlying object with id, value and extensions. The accessor "getOccurrenceChanged" gives direct access to the value

hasOccurrenceChangedElement

public boolean hasOccurrenceChangedElement()

hasOccurrenceChanged

public boolean hasOccurrenceChanged()

setOccurrenceChangedElement

public Appointment setOccurrenceChangedElement(BooleanType value)

Parameters:

value - occurrenceChanged (This appointment varies from the recurring pattern.). This is the underlying object with id, value and extensions. The accessor "getOccurrenceChanged" gives direct access to the value

getOccurrenceChanged

public boolean getOccurrenceChanged()

Returns:

This appointment varies from the recurring pattern.

setOccurrenceChanged

public Appointment setOccurrenceChanged(boolean value)

Parameters:

value - This appointment varies from the recurring pattern.

getRecurrenceTemplate

public List<Appointment.AppointmentRecurrenceTemplateComponent> getRecurrenceTemplate()

Returns:

recurrenceTemplate (The details of the recurrence pattern or template that is used to generate recurring appointments.)

setRecurrenceTemplate

public Appointment setRecurrenceTemplate(List<Appointment.AppointmentRecurrenceTemplateComponent> theRecurrenceTemplate)

Returns:

Returns a reference to this for easy method chaining

hasRecurrenceTemplate

public boolean hasRecurrenceTemplate()

addRecurrenceTemplate

public Appointment.AppointmentRecurrenceTemplateComponent addRecurrenceTemplate()

addRecurrenceTemplate

public Appointment addRecurrenceTemplate(Appointment.AppointmentRecurrenceTemplateComponent t)

getRecurrenceTemplateFirstRep

public Appointment.AppointmentRecurrenceTemplateComponent getRecurrenceTemplateFirstRep()

Returns:

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

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

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

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

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

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

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

Overrides:

removeChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

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

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

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

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

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

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

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

Overrides:

fhirType in class DomainResource

Returns:

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

copy

public Appointment copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(Appointment dst)

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