Private OptionalidentifierAppointment.identifier Element
FHIR Specification
IdentifierPrivate ReadonlyappointmentstatusFHIR CodeSystem: Appointmentstatus
PrivatestatusAppointment.status Element
FHIR Specification
codeCodeSystem Enumeration: AppointmentstatusEnum
Private OptionalcancellationAppointment.cancellationReason Element
FHIR Specification
CodeableConceptPrivate Optionalclass_Appointment.class Element
FHIR Specification
CodeableConceptPrivate OptionalserviceAppointment.serviceCategory Element
Private OptionalserviceAppointment.serviceType Element
FHIR Specification
CodeableReference
Private OptionalspecialtyAppointment.specialty Element
FHIR Specification
CodeableConceptPrivate OptionalappointmentAppointment.appointmentType Element
FHIR Specification
CodeableConceptPrivate OptionalreasonAppointment.reason Element
FHIR Specification
CodeableReference
Private OptionalpriorityAppointment.priority Element
FHIR Specification
CodeableConceptPrivate OptionaldescriptionAppointment.description Element
FHIR Specification
stringPrivate OptionalreplacesAppointment.replaces Element
FHIR Specification
Reference
Private OptionalvirtualAppointment.virtualService Element
FHIR Specification
VirtualServiceDetailPrivate OptionalsupportingAppointment.supportingInformation Element
FHIR Specification
Reference
Private OptionalpreviousAppointment.previousAppointment Element
FHIR Specification
Reference
Private OptionaloriginatingAppointment.originatingAppointment Element
FHIR Specification
Reference
Private OptionalstartAppointment.start Element
Private OptionalendAppointment.end Element
Private OptionalminutesAppointment.minutesDuration Element
FHIR Specification
positiveIntPrivate OptionalrequestedAppointment.requestedPeriod Element
FHIR Specification
PeriodPrivate OptionalslotAppointment.slot Element
FHIR Specification
Reference
Private OptionalaccountAppointment.account Element
FHIR Specification
Reference
Private OptionalcreatedAppointment.created Element
FHIR Specification
dateTimePrivate OptionalcancellationAppointment.cancellationDate Element
FHIR Specification
dateTimePrivate OptionalnoteAppointment.note Element
FHIR Specification
AnnotationPrivate OptionalpatientAppointment.patientInstruction Element
FHIR Specification
CodeableReference
Private OptionalbasedAppointment.basedOn Element
Private OptionalsubjectAppointment.subject Element
FHIR Specification
Reference
PrivateparticipantAppointment.participant Element
Private OptionalrecurrenceAppointment.recurrenceId Element
Private OptionaloccurrenceAppointment.occurrenceChanged Element
FHIR Specification
booleanPrivate OptionalrecurrenceAppointment.recurrenceTemplate Element
StaticparseParse the provided Appointment JSON to instantiate the Appointment data model.
JSON representing FHIR Appointment
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Appointment
Appointment data model or undefined for Appointment
JsonError if the provided JSON is not a valid JSON object
the identifier property value as a Identifier array
Assigns the provided Identifier array value to the identifier property.
the identifier array value
this
InvalidTypeError for invalid data types
Add the provided Identifier value to the identifier array property.
the identifier value
this
InvalidTypeError for invalid data types
true if the identifier property exists and has a value; false otherwise
the status property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: AppointmentstatusEnum
Assigns the provided EnumCodeType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: AppointmentstatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a CodeType if defined; else null
CodeSystem Enumeration: AppointmentstatusEnum
Assigns the provided PrimitiveType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: AppointmentstatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a fhirCode if defined; else null
CodeSystem Enumeration: AppointmentstatusEnum
Assigns the provided primitive value to the status property.
the status value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: AppointmentstatusEnum
true if the status property exists and has a value; false otherwise
the cancellationReason property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided CancellationReason object value to the cancellationReason property.
the cancellationReason object value
this
InvalidTypeError for invalid data types
true if the cancellationReason property exists and has a value; false otherwise
the class_ property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the class_ property.
the class_ array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the class_ array property.
the class_ value
this
InvalidTypeError for invalid data types
true if the class_ property exists and has a value; false otherwise
the serviceCategory property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the serviceCategory property.
the serviceCategory array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the serviceCategory array property.
the serviceCategory value
this
InvalidTypeError for invalid data types
true if the serviceCategory property exists and has a value; false otherwise
the serviceType property value as a CodeableReference array
Assigns the provided CodeableReference array value to the serviceType property.
the serviceType array value
this
InvalidTypeError for invalid data types
Add the provided CodeableReference value to the serviceType array property.
the serviceType value
this
InvalidTypeError for invalid data types
true if the serviceType property exists and has a value; false otherwise
the specialty property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the specialty property.
the specialty array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the specialty array property.
the specialty value
this
InvalidTypeError for invalid data types
true if the specialty property exists and has a value; false otherwise
the appointmentType property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided AppointmentType object value to the appointmentType property.
the appointmentType object value
this
InvalidTypeError for invalid data types
true if the appointmentType property exists and has a value; false otherwise
the reason property value as a CodeableReference array
Assigns the provided CodeableReference array value to the reason property.
the reason array value
this
InvalidTypeError for invalid data types
Add the provided CodeableReference value to the reason array property.
the reason value
this
InvalidTypeError for invalid data types
true if the reason property exists and has a value; false otherwise
the priority property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Priority object value to the priority property.
the priority object value
this
InvalidTypeError for invalid data types
true if the priority property exists and has a value; false otherwise
the description property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the description property.
the description value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the description property exists and has a value; false otherwise
the description property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the description property.
the description value
this
PrimitiveTypeError for invalid primitive types
true if the description property exists and has a value; false otherwise
the replaces property value as a Reference array
Assigns the provided Reference array value to the replaces property.
the replaces array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the replaces array property.
the replaces value
this
InvalidTypeError for invalid data type or reference value
true if the replaces property exists and has a value; false otherwise
the virtualService property value as a VirtualServiceDetail array
Assigns the provided VirtualServiceDetail array value to the virtualService property.
the virtualService array value
this
InvalidTypeError for invalid data types
Add the provided VirtualServiceDetail value to the virtualService array property.
the virtualService value
this
InvalidTypeError for invalid data types
true if the virtualService property exists and has a value; false otherwise
the supportingInformation property value as a Reference array
Assigns the provided Reference array value to the supportingInformation property.
the supportingInformation array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the supportingInformation array property.
the supportingInformation value
this
InvalidTypeError for invalid data type or reference value
true if the supportingInformation property exists and has a value; false otherwise
the previousAppointment property value as a Reference object; else an empty Reference object
Assigns the provided PreviousAppointment object value to the previousAppointment property.
the previousAppointment object value
this
InvalidTypeError for invalid data type or reference value
true if the previousAppointment property exists and has a value; false otherwise
the originatingAppointment property value as a Reference object; else an empty Reference object
Assigns the provided OriginatingAppointment object value to the originatingAppointment property.
the originatingAppointment object value
this
InvalidTypeError for invalid data type or reference value
true if the originatingAppointment property exists and has a value; false otherwise
the start property value as a InstantType object if defined; else an empty InstantType object
Assigns the provided PrimitiveType value to the start property.
the start value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the start property exists and has a value; false otherwise
the start property value as a fhirInstant if defined; else undefined
Assigns the provided primitive value to the start property.
the start value
this
PrimitiveTypeError for invalid primitive types
true if the start property exists and has a value; false otherwise
the end property value as a InstantType object if defined; else an empty InstantType object
Assigns the provided PrimitiveType value to the end property.
the end value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the end property exists and has a value; false otherwise
the end property value as a fhirInstant if defined; else undefined
Assigns the provided primitive value to the end property.
the end value
this
PrimitiveTypeError for invalid primitive types
true if the end property exists and has a value; false otherwise
the minutesDuration property value as a PositiveIntType object if defined; else an empty PositiveIntType object
Assigns the provided PrimitiveType value to the minutesDuration property.
the minutesDuration value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the minutesDuration property exists and has a value; false otherwise
the minutesDuration property value as a fhirPositiveInt if defined; else undefined
Assigns the provided primitive value to the minutesDuration property.
the minutesDuration value
this
PrimitiveTypeError for invalid primitive types
true if the minutesDuration property exists and has a value; false otherwise
the requestedPeriod property value as a Period array
Assigns the provided Period array value to the requestedPeriod property.
the requestedPeriod array value
this
InvalidTypeError for invalid data types
Add the provided Period value to the requestedPeriod array property.
the requestedPeriod value
this
InvalidTypeError for invalid data types
true if the requestedPeriod property exists and has a value; false otherwise
the slot property value as a Reference array
Assigns the provided Reference array value to the slot property.
the slot array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the slot array property.
the slot value
this
InvalidTypeError for invalid data type or reference value
true if the slot property exists and has a value; false otherwise
the account property value as a Reference array
Assigns the provided Reference array value to the account property.
the account array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the account array property.
the account value
this
InvalidTypeError for invalid data type or reference value
true if the account property exists and has a value; false otherwise
the created property value as a DateTimeType object if defined; else an empty DateTimeType object
Assigns the provided PrimitiveType value to the created property.
the created value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the created property exists and has a value; false otherwise
the created property value as a fhirDateTime if defined; else undefined
Assigns the provided primitive value to the created property.
the created value
this
PrimitiveTypeError for invalid primitive types
true if the created property exists and has a value; false otherwise
the cancellationDate property value as a DateTimeType object if defined; else an empty DateTimeType object
Assigns the provided PrimitiveType value to the cancellationDate property.
the cancellationDate value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the cancellationDate property exists and has a value; false otherwise
the cancellationDate property value as a fhirDateTime if defined; else undefined
Assigns the provided primitive value to the cancellationDate property.
the cancellationDate value
this
PrimitiveTypeError for invalid primitive types
true if the cancellationDate property exists and has a value; false otherwise
the note property value as a Annotation array
Assigns the provided Annotation array value to the note property.
the note array value
this
InvalidTypeError for invalid data types
Add the provided Annotation value to the note array property.
the note value
this
InvalidTypeError for invalid data types
true if the note property exists and has a value; false otherwise
the patientInstruction property value as a CodeableReference array
Assigns the provided CodeableReference array value to the patientInstruction property.
the patientInstruction array value
this
InvalidTypeError for invalid data types
Add the provided CodeableReference value to the patientInstruction array property.
the patientInstruction value
this
InvalidTypeError for invalid data types
true if the patientInstruction property exists and has a value; false otherwise
the basedOn property value as a Reference array
Assigns the provided Reference array value to the basedOn property.
the basedOn array value
this
@ReferenceTargets('Appointment.basedOn', ['CarePlan','DeviceRequest','MedicationRequest','ServiceRequest',])
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the basedOn array property.
the basedOn value
this
@ReferenceTargets('Appointment.basedOn', ['CarePlan','DeviceRequest','MedicationRequest','ServiceRequest',])
InvalidTypeError for invalid data type or reference value
true if the basedOn property exists and has a value; false otherwise
the subject property value as a Reference object; else an empty Reference object
Assigns the provided Subject object value to the subject property.
the subject object value
this
InvalidTypeError for invalid data type or reference value
true if the subject property exists and has a value; false otherwise
the participant property value as a AppointmentParticipantComponent array
Assigns the provided AppointmentParticipantComponent array value to the participant property.
the participant array value
this
InvalidTypeError for invalid data types
Add the provided AppointmentParticipantComponent value to the participant array property.
the participant value
this
InvalidTypeError for invalid data types
true if the participant property exists and has a value; false otherwise
the recurrenceId property value as a PositiveIntType object if defined; else an empty PositiveIntType object
Assigns the provided PrimitiveType value to the recurrenceId property.
the recurrenceId value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the recurrenceId property exists and has a value; false otherwise
the recurrenceId property value as a fhirPositiveInt if defined; else undefined
Assigns the provided primitive value to the recurrenceId property.
the recurrenceId value
this
PrimitiveTypeError for invalid primitive types
true if the recurrenceId property exists and has a value; false otherwise
the occurrenceChanged property value as a BooleanType object if defined; else an empty BooleanType object
Assigns the provided PrimitiveType value to the occurrenceChanged property.
the occurrenceChanged value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the occurrenceChanged property exists and has a value; false otherwise
the occurrenceChanged property value as a fhirBoolean if defined; else undefined
Assigns the provided primitive value to the occurrenceChanged property.
the occurrenceChanged value
this
PrimitiveTypeError for invalid primitive types
true if the occurrenceChanged property exists and has a value; false otherwise
the recurrenceTemplate property value as a AppointmentRecurrenceTemplateComponent array
Assigns the provided AppointmentRecurrenceTemplateComponent array value to the recurrenceTemplate property.
the recurrenceTemplate array value
this
InvalidTypeError for invalid data types
Add the provided AppointmentRecurrenceTemplateComponent value to the recurrenceTemplate array property.
the recurrenceTemplate value
this
InvalidTypeError for invalid data types
true if the recurrenceTemplate property exists and has a value; false otherwise
the FHIR type defined in the FHIR standard
true if the instance is empty; false otherwise
true if and only if the data model has required fields (min cardinality > 0)
and at least one of those required fields in the instance is empty; false otherwise
Creates a copy of the current instance.
the a new instance copied from the current instance
the JSON value or undefined if the instance is empty
the text property value as a Narrative
Assigns the provided value to the text property.
the text value
this
true if the text property exists and has a value; false otherwise
the contained property value as a Resource array
Assigns the provided Resource array value to the contained property.
the contained array value
this
Add the provided Resource value to the contained array property.
the contained value
this
true if the contained property exists and has a value; false otherwise
the array of extension values
Assigns the provided array of Extension values to the extension property.
array of Extensions
this
Determines if the extension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url; false otherwise
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the extension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the extension property array.
the Extension value to add to the extension property array
this
Removes the Extension having the provided url from the extension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the array of modifierExtension values
Assigns the provided array of Extension values to the modifierExtension property.
array of Extensions
this
Determines if the modifierExtension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the modifierExtension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the modifierExtension property array.
the Extension value to add to the modifierExtension property array
this
Removes the Extension having the provided url from the modifierExtension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the FHIR resource type as defined by the FHIR specification
the id property value as a PrimitiveType
Assigns the provided PrimitiveType value to the id property.
the id value
this
true if the id property exists and has a value; false otherwise
the id property value as a primitive value
Assigns the provided primitive value to the id property.
the id value
this
PrimitiveTypeError for invalid primitive types
true if the id property exists and has a value; false otherwise
the meta property value as a Meta
Assigns the provided value to the meta property.
the meta value
this
true if the meta property exists and has a value; false otherwise
the implicitRules property value as a PrimitiveType
Assigns the provided PrimitiveType value to the implicitRules property.
the implicitRules value
this
true if the implicitRules property exists and has a value; false otherwise
the implicitRules property value as a primitive value
Assigns the provided primitive value to the implicitRules property.
the implicitRules value
this
PrimitiveTypeError for invalid primitive types
true if the system property exists and has a value; false otherwise
the language property value as a PrimitiveType
Assigns the provided PrimitiveType value to the language property.
the language value
this
true if the language property exists and has a value; false otherwise
the language property value as a primitive value
Assigns the provided primitive value to the language property.
the language value
this
PrimitiveTypeError for invalid primitive types
true if the language property exists and has a value; false otherwise
true if the instance is a FHIR resource; false otherwise
true if the instance is a FHIR complex or primitive datatype; false otherwise
true if the instance is a FHIR complex datatype; false otherwise
true if the instance is a FHIR primitive datatype; false otherwise
true if the instance is a FHIR primitive boolean datatype; false otherwise
true if the instance is a FHIR primitive string-based datatype; false otherwise
true if the instance is a FHIR primitive number-based datatype; false otherwise
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
ProtectedcopyProtectedCopies the current instance's elements into the provided object.
the copied instance
PrivateinitInitialize the identifier property
PrivateinitInitialize the class_ property
PrivateinitInitialize the serviceCategory property
PrivateinitInitialize the serviceType property
PrivateinitInitialize the specialty property
PrivateinitInitialize the reason property
PrivateinitInitialize the replaces property
PrivateinitInitialize the virtualService property
PrivateinitInitialize the supportingInformation property
PrivateinitInitialize the requestedPeriod property
PrivateinitInitialize the slot property
PrivateinitInitialize the account property
PrivateinitInitialize the note property
PrivateinitInitialize the patientInstruction property
PrivateinitInitialize the basedOn property
PrivateinitInitialize the participant property
PrivateinitInitialize the recurrenceTemplate property
Appointment Class
Remarks
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).
FHIR Specification
See
FHIR Appointment