Skip to main content


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


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


property comment as %String (MAXLEN = 1000000, XMLNAME = "comment", XMLPROJECTION = "ATTRIBUTE");

Additional comments.

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

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");

When appointment is to conclude.

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

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");

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.vDSTU2.Model.Element.Appointment.participant (XMLNAME = "participant", XMLPROJECTION = "ELEMENT") [ Required ];

Participants involved in appointment.

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

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

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

Reason this appointment is scheduled.

encounter-reason is the REQUIRED FHIR2 ValueSet for codes; you may NOT extend encounter-reason and you may NOT use codes from other ValueSets.

Property methods: reasonGet(), reasonGetSwizzled(), reasonIsValid(), reasonNewObject(), reasonSet()
property slot as list of HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "slot", XMLPROJECTION = "ELEMENT");

If provided, then no schedule and start/end values MUST match slot.


Property methods: slotBuildValueArray(), slotCollectionToDisplay(), slotCollectionToOdbc(), slotDisplayToCollection(), slotGet(), slotGetObject(), slotGetObjectId(), slotGetSwizzled(), slotIsValid(), slotOdbcToCollection(), slotSet(), slotSetObject(), slotSetObjectId()
property start as %String (MAXLEN = 1000000, XMLNAME = "start", XMLPROJECTION = "ATTRIBUTE");

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 ];

proposed | pending | booked | arrived | fulfilled | cancelled | noshow

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

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property type as HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");

The type of appointment that is being booked.

c80-practice-codes is the PREFERRED FHIR2 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: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab