Skip to main content
AskMe (beta)
Loading icon
Responses may be inaccurate. Learn more about AskMe.

HS.FHIR.DTL.vR4.Model.Resource.Appointment

class HS.FHIR.DTL.vR4.Model.Resource.Appointment extends HS.FHIR.DTL.vR4.Model.Base.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)

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = Appointment;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLPROJECTION = ELEMENT;
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = Appointment;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property appointmentType as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "appointmentType", XMLPROJECTION = "ELEMENT");
CodeableConcept

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

v2-0276 is the PREFERRED FHIR4 ValueSet for codes, but if you need to express meanings not found in v2-0276, you may use codes from any ValueSet.

Property methods: appointmentTypeGet(), appointmentTypeGetSwizzled(), appointmentTypeIsValid(), appointmentTypeNewObject(), appointmentTypeSet()
property basedOn as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
Reference

The service request this appointment is allocated to assess.

ServiceRequest

Property methods: basedOnBuildValueArray(), basedOnCollectionToDisplay(), basedOnCollectionToOdbc(), basedOnDisplayToCollection(), basedOnGet(), basedOnGetObject(), basedOnGetObjectId(), basedOnGetSwizzled(), basedOnIsValid(), basedOnOdbcToCollection(), basedOnSet(), basedOnSetObject(), basedOnSetObjectId()
property cancelationReason as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "cancelationReason", XMLPROJECTION = "ELEMENT");
CodeableConcept

The coded reason for the appointment being cancelled.

any FHIR4 code may be used; appointment-cancellation-reason shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: cancelationReasonGet(), cancelationReasonGetSwizzled(), cancelationReasonIsValid(), cancelationReasonNewObject(), cancelationReasonSet()
property comment as %String (MAXLEN = 1000000, XMLNAME = "comment", XMLPROJECTION = "ATTRIBUTE");
string

Additional comments.

Property methods: commentDisplayToLogical(), commentGet(), commentIsValid(), commentLogicalToDisplay(), commentLogicalToOdbc(), commentNormalize(), commentSet()
property created as %String (MAXLEN = 1000000, XMLNAME = "created", XMLPROJECTION = "ATTRIBUTE");
dateTime

The date that this appointment was initially created.

Property methods: createdDisplayToLogical(), createdGet(), createdIsValid(), createdLogicalToDisplay(), createdLogicalToOdbc(), createdNormalize(), createdSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");
string

Shown on a subject line in a meeting request, or appointment list.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property end as %String (MAXLEN = 1000000, XMLNAME = "end", XMLPROJECTION = "ATTRIBUTE");
instant

When appointment is to conclude.

Property methods: endDisplayToLogical(), endGet(), endIsValid(), endLogicalToDisplay(), endLogicalToOdbc(), endNormalize(), endSet()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

External Ids for this item.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property minutesDuration as %Integer (XMLNAME = "minutesDuration", XMLPROJECTION = "ATTRIBUTE");
positiveInt

Can be less than start/end (e.g. estimate)

Property methods: minutesDurationDisplayToLogical(), minutesDurationGet(), minutesDurationIsValid(), minutesDurationLogicalToDisplay(), minutesDurationNormalize(), minutesDurationSet(), minutesDurationXSDToLogical()
property participant as list of HS.FHIR.DTL.vR4.Model.Element.Appointment.participant (XMLNAME = "participant", XMLPROJECTION = "ELEMENT") [ Required ];
BackboneElement

Participants involved in appointment.

Property methods: participantBuildValueArray(), participantCollectionToDisplay(), participantCollectionToOdbc(), participantDisplayToCollection(), participantGet(), participantGetObject(), participantGetObjectId(), participantGetSwizzled(), participantIsValid(), participantOdbcToCollection(), participantSet(), participantSetObject(), participantSetObjectId()
property patientInstruction as %String (MAXLEN = 1000000, XMLNAME = "patientInstruction", XMLPROJECTION = "ATTRIBUTE");
string

Detailed information and instructions for the patient.

Property methods: patientInstructionDisplayToLogical(), patientInstructionGet(), patientInstructionIsValid(), patientInstructionLogicalToDisplay(), patientInstructionLogicalToOdbc(), patientInstructionNormalize(), patientInstructionSet()
property priority as %Integer (XMLNAME = "priority", XMLPROJECTION = "ATTRIBUTE");
unsignedInt

Used to make informed decisions if needing to re-prioritize.

Property methods: priorityDisplayToLogical(), priorityGet(), priorityIsValid(), priorityLogicalToDisplay(), priorityNormalize(), prioritySet(), priorityXSDToLogical()
property reasonCode as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

Coded reason this appointment is scheduled.

encounter-reason is the PREFERRED FHIR4 ValueSet for codes, but if you need to express meanings not found in encounter-reason, you may use codes from any ValueSet.

Property methods: reasonCodeBuildValueArray(), reasonCodeCollectionToDisplay(), reasonCodeCollectionToOdbc(), reasonCodeDisplayToCollection(), reasonCodeGet(), reasonCodeGetObject(), reasonCodeGetObjectId(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeOdbcToCollection(), reasonCodeSet(), reasonCodeSetObject(), reasonCodeSetObjectId()
property reasonReference as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");
Reference

Reason the appointment is to take place (resource)

Condition | Procedure | Observation | ImmunizationRecommendation

Property methods: reasonReferenceBuildValueArray(), reasonReferenceCollectionToDisplay(), reasonReferenceCollectionToOdbc(), reasonReferenceDisplayToCollection(), reasonReferenceGet(), reasonReferenceGetObject(), reasonReferenceGetObjectId(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceOdbcToCollection(), reasonReferenceSet(), reasonReferenceSetObject(), reasonReferenceSetObjectId()
property requestedPeriod as list of HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "requestedPeriod", XMLPROJECTION = "ELEMENT");
Period

Potential date/time interval(s) requested to allocate the appointment within.

Property methods: requestedPeriodBuildValueArray(), requestedPeriodCollectionToDisplay(), requestedPeriodCollectionToOdbc(), requestedPeriodDisplayToCollection(), requestedPeriodGet(), requestedPeriodGetObject(), requestedPeriodGetObjectId(), requestedPeriodGetSwizzled(), requestedPeriodIsValid(), requestedPeriodOdbcToCollection(), requestedPeriodSet(), requestedPeriodSetObject(), requestedPeriodSetObjectId()
property serviceCategory as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "serviceCategory", XMLPROJECTION = "ELEMENT");
CodeableConcept

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

any FHIR4 code may be used; service-category shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: serviceCategoryBuildValueArray(), serviceCategoryCollectionToDisplay(), serviceCategoryCollectionToOdbc(), serviceCategoryDisplayToCollection(), serviceCategoryGet(), serviceCategoryGetObject(), serviceCategoryGetObjectId(), serviceCategoryGetSwizzled(), serviceCategoryIsValid(), serviceCategoryOdbcToCollection(), serviceCategorySet(), serviceCategorySetObject(), serviceCategorySetObjectId()
property serviceType as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "serviceType", XMLPROJECTION = "ELEMENT");
CodeableConcept

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

any FHIR4 code may be used; service-type shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: serviceTypeBuildValueArray(), serviceTypeCollectionToDisplay(), serviceTypeCollectionToOdbc(), serviceTypeDisplayToCollection(), serviceTypeGet(), serviceTypeGetObject(), serviceTypeGetObjectId(), serviceTypeGetSwizzled(), serviceTypeIsValid(), serviceTypeOdbcToCollection(), serviceTypeSet(), serviceTypeSetObject(), serviceTypeSetObjectId()
property slot as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "slot", XMLPROJECTION = "ELEMENT");
Reference

The slots that this appointment is filling.

Slot

Property methods: slotBuildValueArray(), slotCollectionToDisplay(), slotCollectionToOdbc(), slotDisplayToCollection(), slotGet(), slotGetObject(), slotGetObjectId(), slotGetSwizzled(), slotIsValid(), slotOdbcToCollection(), slotSet(), slotSetObject(), slotSetObjectId()
property specialty as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "specialty", XMLPROJECTION = "ELEMENT");
CodeableConcept

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

c80-practice-codes is the PREFERRED FHIR4 ValueSet for codes, but if you need to express meanings not found in c80-practice-codes, you may use codes from any ValueSet.

Property methods: specialtyBuildValueArray(), specialtyCollectionToDisplay(), specialtyCollectionToOdbc(), specialtyDisplayToCollection(), specialtyGet(), specialtyGetObject(), specialtyGetObjectId(), specialtyGetSwizzled(), specialtyIsValid(), specialtyOdbcToCollection(), specialtySet(), specialtySetObject(), specialtySetObjectId()
property start as %String (MAXLEN = 1000000, XMLNAME = "start", XMLPROJECTION = "ATTRIBUTE");
instant

When appointment is to take place.

Property methods: startDisplayToLogical(), startGet(), startIsValid(), startLogicalToDisplay(), startLogicalToOdbc(), startNormalize(), startSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist

appointmentstatus|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend appointmentstatus|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property supportingInformation as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "supportingInformation", XMLPROJECTION = "ELEMENT");
Reference

Additional information to support the appointment.

Any FHIR4 Resource may be indicated by this Reference

Property methods: supportingInformationBuildValueArray(), supportingInformationCollectionToDisplay(), supportingInformationCollectionToOdbc(), supportingInformationDisplayToCollection(), supportingInformationGet(), supportingInformationGetObject(), supportingInformationGetObjectId(), supportingInformationGetSwizzled(), supportingInformationIsValid(), supportingInformationOdbcToCollection(), supportingInformationSet(), supportingInformationSetObject(), supportingInformationSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab