Data Model Libraries
    Preparing search index...

    Class HealthcareService

    HealthcareService Class

    The details of a healthcare service available at a location or in a catalog. In the case where there is a hierarchy of services (for example, Lab -> Pathology -> Wound Cultures), this can be represented using a set of linked HealthcareServices.

    FHIR Specification

    • Short: The details of a healthcare service available at a location
    • Definition: The details of a healthcare service available at a location.
    • FHIR Version: 5.0.0

    FHIR HealthcareService

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? active? providedBy? offeredIn? category? type_? specialty? location? name? comment? extraDetails? photo? contact? coverageArea? serviceProvisionCode? eligibility? program? characteristic? communication? referralMethod? appointmentRequired? availability? endpoint?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getActiveElement setActiveElement hasActiveElement getActive setActive hasActive getProvidedBy setProvidedBy hasProvidedBy getOfferedIn setOfferedIn addOfferedIn hasOfferedIn getCategory setCategory addCategory hasCategory getType setType addType hasType getSpecialty setSpecialty addSpecialty hasSpecialty getLocation setLocation addLocation hasLocation getNameElement setNameElement hasNameElement getName setName hasName getCommentElement setCommentElement hasCommentElement getComment setComment hasComment getExtraDetailsElement setExtraDetailsElement hasExtraDetailsElement getExtraDetails setExtraDetails hasExtraDetails getPhoto setPhoto hasPhoto getContact setContact addContact hasContact getCoverageArea setCoverageArea addCoverageArea hasCoverageArea getServiceProvisionCode setServiceProvisionCode addServiceProvisionCode hasServiceProvisionCode getEligibility setEligibility addEligibility hasEligibility getProgram setProgram addProgram hasProgram getCharacteristic setCharacteristic addCharacteristic hasCharacteristic getCommunication setCommunication addCommunication hasCommunication getReferralMethod setReferralMethod addReferralMethod hasReferralMethod getAppointmentRequiredElement setAppointmentRequiredElement hasAppointmentRequiredElement getAppointmentRequired setAppointmentRequired hasAppointmentRequired getAvailability setAvailability addAvailability hasAvailability getEndpoint setEndpoint addEndpoint hasEndpoint fhirType isEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isRequiredFieldsEmpty isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initOfferedIn initCategory initType initSpecialty initLocation initContact initCoverageArea initServiceProvisionCode initEligibility initProgram initCharacteristic initCommunication initReferralMethod initAvailability initEndpoint

    Constructors

    Properties

    identifier?: Identifier[]

    HealthcareService.identifier Element

    FHIR Specification

    • Short: External identifiers for this item
    • Definition: External identifiers for this item.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    active?: BooleanType

    HealthcareService.active Element

    FHIR Specification

    • Short: Whether this HealthcareService record is in active use
    • Definition: 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.
    • Comment: This element is labeled as a modifier because it may be used to mark that the resource was created in error.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
    • isSummary: true
    providedBy?: Reference

    HealthcareService.providedBy Element

    FHIR Specification

    • Short: Organization that provides this service
    • Definition: The organization that provides this healthcare service.
    • Comment: This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such. If the Location does not have a managing Organization, then this property should be populated.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    offeredIn?: Reference[]

    HealthcareService.offeredIn Element

    FHIR Specification

    • Short: The service within which this service is offered
    • Definition: When the HealthcareService is representing a specific, schedulable service, the availableIn property can refer to a generic service.
    • Comment: For example, if there is a generic Radiology service that offers CT Scans, MRIs, etc. You could have HealthcareService resources for the CT Scans and MRIs, which have an offeredIn reference to the Radiology HealthcareService.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    category?: CodeableConcept[]

    HealthcareService.category Element

    FHIR Specification

    • Short: Broad category of service being performed or delivered
    • Definition: Identifies the broad category of service being performed or delivered.
    • Comment: Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Private Optionaltype_

    type_?: CodeableConcept[]

    HealthcareService.type Element

    FHIR Specification

    • Short: Type of service that may be delivered or performed
    • Definition: The specific type of service that may be delivered or performed.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    specialty?: CodeableConcept[]

    HealthcareService.specialty Element

    FHIR Specification

    • Short: Specialties handled by the HealthcareService
    • Definition: Collection of specialties handled by the Healthcare service. This is more of a medical term.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    location?: Reference[]

    HealthcareService.location Element

    FHIR Specification

    • Short: Location(s) where service may be provided
    • Definition: The location(s) where this healthcare service may be provided.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    name?: StringType

    HealthcareService.name Element

    FHIR Specification

    • Short: Description of service as presented to a consumer while searching
    • Definition: Further description of the service as it would be presented to a consumer while searching.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    comment?: MarkdownType

    HealthcareService.comment Element

    FHIR Specification

    • Short: Additional description and/or any specific issues not covered elsewhere
    • Definition: 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.
    • Comment: Would expect that a user would not see this information on a search results, and it would only be available when viewing the complete details of the service.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    extraDetails?: MarkdownType

    HealthcareService.extraDetails Element

    FHIR Specification

    • Short: Extra details about the service that can't be placed in the other fields
    • Definition: Extra details about the service that can't be placed in the other fields.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    photo?: Attachment

    HealthcareService.photo Element

    FHIR Specification

    • Short: Facilitates quick identification of the service
    • Definition: 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.
    • FHIR Type: Attachment
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    contact?: ExtendedContactDetail[]

    HealthcareService.contact Element

    FHIR Specification

    • Short: Official contact details for the HealthcareService
    • Definition: The contact details of communication devices available relevant to the specific HealthcareService. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.
    • Comment: The address/telecom use code 'home' are not to be used. Note that these contacts are not the contact details of people who provide the service (that would be through PractitionerRole), these are official contacts for the HealthcareService itself for specific purposes. E.g. Mailing Addresses, Billing Addresses, Contact numbers for Booking or Billing Enquiries, general web address, web address for online bookings etc. If this is empty (or the type of interest is empty), refer to the location's contacts.
    • Requirements: Need to keep track of both simple contact details and also assigned contacts within larger organizations.
    • FHIR Type: ExtendedContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    coverageArea?: Reference[]

    HealthcareService.coverageArea Element

    FHIR Specification

    • Short: Location(s) service is intended for/available to
    • Definition: The location(s) that this service is available to (not where the service is provided).
    • Comment: The locations referenced by the coverage area can include both specific locations, including areas, and also conceptual domains too (mode = kind), such as a physical area (tri-state area) and some other attribute (covered by Example Care Organization). These types of Locations are often not managed by any specific organization. This could also include generic locations such as "in-home".
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    serviceProvisionCode?: CodeableConcept[]

    HealthcareService.serviceProvisionCode Element

    FHIR Specification

    • Short: Conditions under which service is available/offered
    • Definition: The code(s) that detail the conditions under which the healthcare service is available/offered.
    • Comment: The provision means being commissioned by, contractually obliged or financially sourced. Types of costings that may apply to this healthcare service, such if the service may be available for free, some discounts available, or fees apply.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    eligibility?: HealthcareServiceEligibilityComponent[]

    HealthcareService.eligibility Element

    FHIR Specification

    • Short: Specific eligibility requirements required to use the service
    • Definition: Does this service have specific eligibility requirements that need to be met in order to use the service?
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    program?: CodeableConcept[]

    HealthcareService.program Element

    FHIR Specification

    • Short: Programs that this service is applicable to
    • Definition: Programs that this service is applicable to.
    • Comment: Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ....
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    characteristic?: CodeableConcept[]

    HealthcareService.characteristic Element

    FHIR Specification

    • Short: Collection of characteristics (attributes)
    • Definition: Collection of characteristics (attributes).
    • Comment: These could be such things as is wheelchair accessible.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    communication?: CodeableConcept[]

    HealthcareService.communication Element

    FHIR Specification

    • Short: The language that this service is offered in
    • Definition: 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.
    • Comment: When using this property it indicates that the service is available with this language, it is not derived from the practitioners, and not all are required to use this language, just that this language is available while scheduling.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    referralMethod?: CodeableConcept[]

    HealthcareService.referralMethod Element

    FHIR Specification

    • Short: Ways that the service accepts referrals
    • Definition: Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    appointmentRequired?: BooleanType

    HealthcareService.appointmentRequired Element

    FHIR Specification

    • Short: If an appointment is required for access to this service
    • Definition: 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.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    availability?: Availability[]

    HealthcareService.availability Element

    FHIR Specification

    • Short: Times the healthcare service is available (including exceptions)
    • Definition: A collection of times that the healthcare service is available.
    • Comment: More detailed availability information may be provided in associated Schedule/Slot resources. Systems may choose to render availability differently than it is exchanged on the interface. For example, rather than "Mon, Tue, Wed, Thur, Fri from 9am-12am; Mon, Tue, Wed, Thur, Fri from 1pm-5pm" as would be implied by two availableTime repetitions, an application could render this information as "Mon-Fri 9-12am and 1-5pm". The NotAvailableTime(s) included indicate the general days/periods where the service is not available (for things such as public holidays).
    • FHIR Type: Availability
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    endpoint?: Reference[]

    HealthcareService.endpoint Element

    FHIR Specification

    • Short: Technical endpoints providing access to electronic services operated for the healthcare service
    • Definition: Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided HealthcareService JSON to instantiate the HealthcareService data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR HealthcareService

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to HealthcareService

      Returns undefined | HealthcareService

      HealthcareService data model or undefined for HealthcareService

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      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

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      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

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetActiveElementsetActiveElementhasActiveElementgetActivesetActivehasActivegetProvidedBysetProvidedByhasProvidedBygetOfferedInsetOfferedInaddOfferedInhasOfferedIngetCategorysetCategoryaddCategoryhasCategorygetTypesetTypeaddTypehasTypegetSpecialtysetSpecialtyaddSpecialtyhasSpecialtygetLocationsetLocationaddLocationhasLocationgetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetCommentElementsetCommentElementhasCommentElementgetCommentsetCommenthasCommentgetExtraDetailsElementsetExtraDetailsElementhasExtraDetailsElementgetExtraDetailssetExtraDetailshasExtraDetailsgetPhotosetPhotohasPhotogetContactsetContactaddContacthasContactgetCoverageAreasetCoverageAreaaddCoverageAreahasCoverageAreagetServiceProvisionCodesetServiceProvisionCodeaddServiceProvisionCodehasServiceProvisionCodegetEligibilitysetEligibilityaddEligibilityhasEligibilitygetProgramsetProgramaddProgramhasProgramgetCharacteristicsetCharacteristicaddCharacteristichasCharacteristicgetCommunicationsetCommunicationaddCommunicationhasCommunicationgetReferralMethodsetReferralMethodaddReferralMethodhasReferralMethodgetAppointmentRequiredElementsetAppointmentRequiredElementhasAppointmentRequiredElementgetAppointmentRequiredsetAppointmentRequiredhasAppointmentRequiredgetAvailabilitysetAvailabilityaddAvailabilityhasAvailabilitygetEndpointsetEndpointaddEndpointhasEndpointfhirTypeisEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisRequiredFieldsEmptyisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitOfferedIninitCategoryinitTypeinitSpecialtyinitLocationinitContactinitCoverageAreainitServiceProvisionCodeinitEligibilityinitPrograminitCharacteristicinitCommunicationinitReferralMethodinitAvailabilityinitEndpoint