Appointment

@POJOBoilerplate
class Appointment(val id: Option[String], val end: Option[ZonedDateTime], val meta: Option[Meta], val text: Option[Narrative], val slot: LitSeq[Reference], val start: Option[ZonedDateTime], val status: APPOINTMENTSTATUS, val created: Option[FHIRDateTime], val comment: Option[String], val basedOn: LitSeq[Reference], val language: Option[LANGUAGES], val priority: Option[UnsignedInt], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val specialty: LitSeq[CodeableConcept], val identifier: LitSeq[Identifier], val reasonCode: LitSeq[CodeableConcept], val serviceType: LitSeq[CodeableConcept], val description: Option[String], val implicitRules: Option[UriStr], val serviceCategory: LitSeq[CodeableConcept], val appointmentType: Option[CodeableConcept], val reasonReference: LitSeq[Reference], val minutesDuration: Option[PositiveInt], val requestedPeriod: LitSeq[Period], val modifierExtension: LitSeq[Extension], val cancelationReason: Option[CodeableConcept], val patientInstruction: Option[String], val supportingInformation: LitSeq[Reference], val participant: NonEmptyLitSeq[Participant], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) 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).

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
appointmentType
  • The style of appointment or patient that has been booked in the slot (not service type).
basedOn
  • The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).
cancelationReason
  • 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.
comment
  • Additional comments about the appointment.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
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.
description
  • The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.
end
  • Date/Time that the appointment is to conclude.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
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).
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
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.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
participant
  • List of participants involved in the appointment.
patientInstruction
  • While Appointment.comment 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).
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).
reasonCode
  • The coded reason that this appointment is being scheduled. This is more clinical than administrative.
reasonReference
  • Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
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.
serviceCategory
  • A broad categorization of the service that is to be performed during this appointment.
serviceType
  • The specific service that is to be performed during this appointment.
slot
  • The slots from the participants' schedules that will be filled by the appointment.
specialty
  • The specialty of a practitioner that would be required to perform the service requested in this appointment.
start
  • Date/Time that the appointment is to take place.
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.
supportingInformation
  • Additional information to support the appointment provided when making the appointment.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields end, slot, start, status, created, comment, basedOn, priority, specialty, identifier, reasonCode, serviceType, description, serviceCategory, appointmentType, reasonReference, minutesDuration, requestedPeriod, cancelationReason, patientInstruction, supportingInformation, participant.

Companion:
object
class Resource
class FHIRObject
trait FHIRComponent
trait Utils
class Object
trait Matchable
class Any

Type members

Inherited classlikes

object extensions
Inherited from:
FHIRObject
object ids
Inherited from:
FHIRObject

Inherited types

type FieldToElementLookup = TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
Inherited from:
FHIRObject

Value members

Inherited methods

final def >>[T](fn: T => T)(implicit tt: LTag[T]): Appointment

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_] or an Option[_]
  • It may require a type parameter sometimes (e.g. sampleResource >>[BUNDLE_TYPE] { (_: BUNDLE_TYPE) => BUNDLE_TYPE.SEARCHSET } )
Inherited from:
FHIRObject
final def >>=[T, F[_] : Monad](fn: T => F[T])(implicit evidence$7: Monad[F], tt: LTag[T]): F[Appointment]
Inherited from:
FHIRObject
final def ^^[From, To](fn: From => To)(implicit tt: LTag[From]): LitSeq[To]

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Inherited from:
FHIRObject
final def ^^^[T](implicit tt: LTag[T]): LitSeq[T]
Inherited from:
FHIRObject
def companionClassName[T](tag: LTag[T]): String
Inherited from:
Utils
def companionOf[T <: FHIRObject : ClassTag](implicit evidence$1: ClassTag[T], tag: LTag[T]): CompanionFor[T]
Inherited from:
Utils
def constructor: Constructor[_]
Inherited from:
FHIRComponent
def decodeMethodFor[T <: FHIRObject : ClassTag](implicit evidence$2: ClassTag[T], tag: LTag[T], params: DecoderParams): HCursor => Try[T]
Inherited from:
Utils
override def equals(obj: Any): Boolean
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def fields: Seq[FHIRComponentField[_]]
Inherited from:
FHIRObject
def getFieldByClass[T](name: String, clazz: Class[T]): LitSeq[T]
Inherited from:
FHIRComponent
def getFieldByType[T : LTag](name: String): LitSeq[T]
Inherited from:
FHIRComponent
def getIdentifier: Option[String]
Inherited from:
Resource
def getMostSpecificIdentifier: Option[String]
Inherited from:
Resource
def getVersionedIdentifier: Option[String]
Inherited from:
Resource
override def hashCode(): Int
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def modifyField[T : LTag, Up >: Appointment <: FHIRObject](fieldName: String, modify: T => T)(implicit evidence$5: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def modifyFieldUnsafe[T, Up >: Appointment <: FHIRObject](fieldName: String, modify: T => T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
final def nodalExtract[From, To](klass: Class[From], fn: From => To): LitSeq[To]

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Inherited from:
FHIRObject
final def nodalGetByClass[Target](klass: Class[Target]): LitSeq[Target]

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Inherited from:
FHIRObject
final def nodalMap[T](klass: Class[T], fn: T => T): Appointment

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_], an Option[_], or any 'subtyped' type (eg PositiveInt). You should ensure, if T is a supertype of multiple valid choice values (e.g. T =:= Object), that the return value of fn retains the same type as the input value.
Inherited from:
FHIRObject
def setFromField[T, UpType >: Appointment <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(newVal: T): UpType
Inherited from:
FHIRObject
def thisClassName: String
Inherited from:
FHIRObject
def toClass[T](klass: Class[T]): Option[T]
Inherited from:
FHIRObject
override def toString: String
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def toType[T](implicit ct: ClassTag[T]): Option[T]
Inherited from:
FHIRObject
def updateFromField[T, UpType >: Appointment <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(fn: T => T): UpType
Inherited from:
FHIRObject
def updatePrimitiveAttributes(fn: FieldToElementLookup => FieldToElementLookup): Appointment
Inherited from:
FHIRObject
def withField[T : LTag, Up >: Appointment <: FHIRObject](fieldName: String, value: T)(implicit evidence$6: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFieldUnsafe[T, Up >: Appointment <: FHIRObject](fieldName: String, value: T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFields[Up >: Appointment <: FHIRObject](replacementFields: (String, Any)*)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withPrimitiveAttributes(a: FieldToElementLookup): Appointment
Inherited from:
FHIRObject

Concrete fields

val appointmentType: Option[CodeableConcept]
val basedOn: LitSeq[Reference]
val cancelationReason: Option[CodeableConcept]
val comment: Option[String]
override val contained: LitSeq[Resource]
val created: Option[FHIRDateTime]
val description: Option[String]
val end: Option[ZonedDateTime]
override val extension: LitSeq[Extension]
override val id: Option[String]
val identifier: LitSeq[Identifier]
override val implicitRules: Option[UriStr]
override val language: Option[LANGUAGES]
override val meta: Option[Meta]
val minutesDuration: Option[PositiveInt]
override val modifierExtension: LitSeq[Extension]
val participant: NonEmptyLitSeq[Participant]
val patientInstruction: Option[String]
override val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
val priority: Option[UnsignedInt]
val reasonCode: LitSeq[CodeableConcept]
val reasonReference: LitSeq[Reference]
val requestedPeriod: LitSeq[Period]
val serviceCategory: LitSeq[CodeableConcept]
val serviceType: LitSeq[CodeableConcept]
val slot: LitSeq[Reference]
val specialty: LitSeq[CodeableConcept]
val start: Option[ZonedDateTime]
val supportingInformation: LitSeq[Reference]
override val text: Option[Narrative]
override val thisTypeName: String

Inherited fields

val companion: CompanionFor[Appointment]
Inherited from:
FHIRObject