Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.Schedule

class HS.FHIR.DTL.vR4.Model.Resource.Schedule extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

A container for slots of time that may be available for booking appointments.

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 = Schedule;
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 = Schedule;
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 active as %Boolean (XMLNAME = "active", XMLPROJECTION = "ATTRIBUTE");
boolean

Whether this schedule is in active use.

Property methods: activeDisplayToLogical(), activeGet(), activeIsValid(), activeLogicalToDisplay(), activeLogicalToXSD(), activeNormalize(), activeSet(), activeXSDToLogical()
property actor as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "actor", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

Resource(s) that availability information is being provided for.

Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location

Property methods: actorBuildValueArray(), actorCollectionToDisplay(), actorCollectionToOdbc(), actorDisplayToCollection(), actorGet(), actorGetObject(), actorGetObjectId(), actorGetSwizzled(), actorIsValid(), actorOdbcToCollection(), actorSet(), actorSetObject(), actorSetObjectId()
property comment as %String (MAXLEN = 1000000, XMLNAME = "comment", XMLPROJECTION = "ATTRIBUTE");
string

Comments on availability.

Property methods: commentDisplayToLogical(), commentGet(), commentIsValid(), commentLogicalToDisplay(), commentLogicalToOdbc(), commentNormalize(), commentSet()
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 planningHorizon as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "planningHorizon", XMLPROJECTION = "ELEMENT");
Period

Period of time covered by schedule.

Property methods: planningHorizonGet(), planningHorizonGetSwizzled(), planningHorizonIsValid(), planningHorizonNewObject(), planningHorizonSet()
property serviceCategory as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "serviceCategory", XMLPROJECTION = "ELEMENT");
CodeableConcept

High-level category.

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

Specific service.

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 specialty as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "specialty", XMLPROJECTION = "ELEMENT");
CodeableConcept

Type of specialty needed.

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

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab