HS.FHIRModel.R4.HealthcareService
class HS.FHIRModel.R4.HealthcareService extends HS.FHIRModel.FHIRClassSuper
******************************************* HealthcareService generated class schema
*****************************************
The details of a healthcare service available at a location.
Property Inventory
- _active
- _appointmentRequired
- _availabilityExceptions
- _comment
- _extraDetails
- _implicitRules
- _language
- _name
- active
- appointmentRequired
- availabilityExceptions
- availableTime
- category
- characteristic
- comment
- communication
- contained
- coverageArea
- eligibility
- endpoint
- extension
- extraDetails
- fhirID
- identifier
- implicitRules
- language
- location
- meta
- modifierExtension
- name
- notAvailable
- photo
- program
- providedBy
- referralMethod
- resourceType
- serviceProvisionCode
- specialty
- telecom
- text
- type
Method Inventory
- IncludeAvailableTime()
- IncludeCategory()
- IncludeCharacteristic()
- IncludeCommunication()
- IncludeContained()
- IncludeCoverageArea()
- IncludeEligibility()
- IncludeEndpoint()
- IncludeExtension()
- IncludeIdentifier()
- IncludeLocation()
- IncludeMeta()
- IncludeModifierExtension()
- IncludeNotAvailable()
- IncludePhoto()
- IncludeProgram()
- IncludeProvidedBy()
- IncludeReferralMethod()
- IncludeServiceProvisionCode()
- IncludeSpecialty()
- IncludeTelecom()
- IncludeText()
- IncludeType()
- _getProperties()
- fromDao()
- toDao()
Parameters
parameter XMLTYPE = R4_HEALTHCARESERVICE;
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 HS.FHIRModel.R4.Element;
Extensions for active
Property methods: _activeGet(), _activeGetSwizzled(), _activeIsValid(), _activeNewObject(), _activeSet()
property _appointmentRequired as HS.FHIRModel.R4.Element;
Extensions for appointmentRequired
Property methods: _appointmentRequiredGet(), _appointmentRequiredGetSwizzled(), _appointmentRequiredIsValid(), _appointmentRequiredNewObject(), _appointmentRequiredSet()
property _availabilityExceptions as HS.FHIRModel.R4.Element;
Extensions for availabilityExceptions
Property methods: _availabilityExceptionsGet(), _availabilityExceptionsGetSwizzled(), _availabilityExceptionsIsValid(), _availabilityExceptionsNewObject(), _availabilityExceptionsSet()
property _comment as HS.FHIRModel.R4.Element;
Extensions for comment
Property methods: _commentGet(), _commentGetSwizzled(), _commentIsValid(), _commentNewObject(), _commentSet()
property _extraDetails as HS.FHIRModel.R4.Element;
Extensions for extraDetails
Property methods: _extraDetailsGet(), _extraDetailsGetSwizzled(), _extraDetailsIsValid(), _extraDetailsNewObject(), _extraDetailsSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _name as HS.FHIRModel.R4.Element;
Extensions for name
Property methods: _nameGet(), _nameGetSwizzled(), _nameIsValid(), _nameNewObject(), _nameSet()
property active as %Boolean;
This flag is used to mark the record to not be used. This is not
used when a center is closed for maintenance, or for holidays, the
notAvailable period is to be used for this.
Property methods: activeDisplayToLogical(), activeGet(), activeIsValid(), activeLogicalToDisplay(), activeLogicalToXSD(), activeNormalize(), activeSet(), activeXSDToLogical()
property appointmentRequired as %Boolean;
Indicates whether or not a prospective consumer will require an appointment
for a particular service at a site to be provided by the Organization.
Indicates if an appointment is required for access to this service.
Property methods: appointmentRequiredDisplayToLogical(), appointmentRequiredGet(), appointmentRequiredIsValid(), appointmentRequiredLogicalToDisplay(), appointmentRequiredLogicalToXSD(), appointmentRequiredNormalize(), appointmentRequiredSet(), appointmentRequiredXSDToLogical()
property availabilityExceptions as %String;
A description of site availability exceptions, e.g. public holiday
availability. Succinctly describing all possible exceptions to normal
site availability as details in the available Times and not available
Times.
Property methods: availabilityExceptionsDisplayToLogical(), availabilityExceptionsGet(), availabilityExceptionsIsValid(), availabilityExceptionsLogicalToDisplay(), availabilityExceptionsLogicalToOdbc(), availabilityExceptionsNormalize(), availabilityExceptionsSet()
property availableTime as HS.FHIRModel.R4.HealthcareServiceX.SeqOfHealthcareServiceXAvailableTime;
A collection of times that the Service Site is available.
Property methods: availableTimeGet(), availableTimeGetSwizzled(), availableTimeIsValid(), availableTimeNewObject(), availableTimeSet()
property category as HS.FHIRModel.R4.SeqOfCodeableConcept;
Identifies the broad category of service being performed or delivered.
Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property characteristic as HS.FHIRModel.R4.SeqOfCodeableConcept;
Collection of characteristics (attributes).
Property methods: characteristicGet(), characteristicGetSwizzled(), characteristicIsValid(), characteristicNewObject(), characteristicSet()
property comment as %String;
Any additional description of the service and/or any specific issues
not covered by the other attributes, which can be displayed as further
detail under the serviceName.
Property methods: commentDisplayToLogical(), commentGet(), commentIsValid(), commentLogicalToDisplay(), commentLogicalToOdbc(), commentNormalize(), commentSet()
property communication as HS.FHIRModel.R4.SeqOfCodeableConcept;
Some services are specifically made available in multiple languages,
this property permits a directory to declare the languages this
is offered in. Typically this is only provided where a service operates
in communities with mixed languages used.
Property methods: communicationGet(), communicationGetSwizzled(), communicationIsValid(), communicationNewObject(), communicationSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
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.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property coverageArea as HS.FHIRModel.R4.SeqOfReference;
The location(s) that this service is available to (not where the
service is provided).
Property methods: coverageAreaGet(), coverageAreaGetSwizzled(), coverageAreaIsValid(), coverageAreaNewObject(), coverageAreaSet()
property eligibility as HS.FHIRModel.R4.HealthcareServiceX.SeqOfHealthcareServiceXEligibility;
Does this service have specific eligibility requirements that need
to be met in order to use the service?
Property methods: eligibilityGet(), eligibilityGetSwizzled(), eligibilityIsValid(), eligibilityNewObject(), eligibilitySet()
property endpoint as HS.FHIRModel.R4.SeqOfReference;
Technical endpoints providing access to services operated for the
specific healthcare services defined at this resource.
Property methods: endpointGet(), endpointGetSwizzled(), endpointIsValid(), endpointNewObject(), endpointSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
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.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property extraDetails as %String;
Extra details about the service that can't be placed in the other
fields.
Property methods: extraDetailsDisplayToLogical(), extraDetailsGet(), extraDetailsIsValid(), extraDetailsLogicalToDisplay(), extraDetailsLogicalToOdbc(), extraDetailsNormalize(), extraDetailsSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource.
Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
External identifiers for this item.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
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.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property location as HS.FHIRModel.R4.SeqOfReference;
The location(s) where this healthcare service may be provided.
Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property meta as HS.FHIRModel.R4.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.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
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).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property name as %String;
Further description of the service as it would be presented to a
consumer while searching.
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property notAvailable as HS.FHIRModel.R4.HealthcareServiceX.SeqOfHealthcareServiceXNotAvailable;
The HealthcareService is not available during this period of time
due to the provided reason.
Property methods: notAvailableGet(), notAvailableGetSwizzled(), notAvailableIsValid(), notAvailableNewObject(), notAvailableSet()
property photo as HS.FHIRModel.R4.Attachment;
If there is a photo/symbol associated with this HealthcareService,
it may be included here to facilitate quick identification of the
service in a list.
Property methods: photoGet(), photoGetSwizzled(), photoIsValid(), photoNewObject(), photoSet()
property program as HS.FHIRModel.R4.SeqOfCodeableConcept;
Programs that this service is applicable to.
Property methods: programGet(), programGetSwizzled(), programIsValid(), programNewObject(), programSet()
property providedBy as HS.FHIRModel.R4.Reference;
The organization that provides this healthcare service.
Property methods: providedByGet(), providedByGetSwizzled(), providedByIsValid(), providedByNewObject(), providedBySet()
property referralMethod as HS.FHIRModel.R4.SeqOfCodeableConcept;
Ways that the service accepts referrals, if this is not provided
then it is implied that no referral is required.
Property methods: referralMethodGet(), referralMethodGetSwizzled(), referralMethodIsValid(), referralMethodNewObject(), referralMethodSet()
property resourceType as %String [ InitialExpression = "HealthcareService" , Required ];
This is a HealthcareService resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property serviceProvisionCode as HS.FHIRModel.R4.SeqOfCodeableConcept;
The code(s) that detail the conditions under which the healthcare
service is available/offered.
Property methods: serviceProvisionCodeGet(), serviceProvisionCodeGetSwizzled(), serviceProvisionCodeIsValid(), serviceProvisionCodeNewObject(), serviceProvisionCodeSet()
property specialty as HS.FHIRModel.R4.SeqOfCodeableConcept;
Collection of specialties handled by the service site. This is more
of a medical term.
Property methods: specialtyGet(), specialtyGetSwizzled(), specialtyIsValid(), specialtyNewObject(), specialtySet()
property telecom as HS.FHIRModel.R4.SeqOfContactPoint;
List of contacts related to this specific healthcare service.
Property methods: telecomGet(), telecomGetSwizzled(), telecomIsValid(), telecomNewObject(), telecomSet()
property text as HS.FHIRModel.R4.Narrative;
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.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property type as HS.FHIRModel.R4.SeqOfCodeableConcept;
The specific type of service that may be delivered or performed.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
Methods
method IncludeAvailableTime()
method IncludeCategory()
method IncludeCharacteristic()
method IncludeCommunication()
method IncludeContained()
method IncludeCoverageArea()
method IncludeEligibility()
method IncludeEndpoint()
method IncludeExtension()
method IncludeIdentifier()
method IncludeLocation()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeNotAvailable()
method IncludePhoto()
method IncludeProgram()
method IncludeProvidedBy()
method IncludeReferralMethod()
method IncludeServiceProvisionCode()
method IncludeSpecialty()
method IncludeTelecom()
method IncludeText()
method IncludeType()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class
in the definition order that they were discovered in the
the HL7FHIR JSchema document
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.HealthcareService
method toDao() as %DynamicAbstractObject
Inherited description: >
The toDao() method casts the set to a DAO.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- add()
- addAll()
- apply()
- clear()
- contains()
- containsAll()
- get()
- iterator()
- put()
- putAll()
- putAllIfAbsent()
- putIfAbsent()
- remove()
- removeAll()
- removeIf()
- rename()
- replace()
- replaceAll()
- size()
- toString()