Health Connect Australia Provider Directory FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 0.1.0-preview built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/HealthConnect/ and changes regularly. See the Directory of published versions

Resource Profile: HCHealthcareService - Detailed Descriptions

Page standards status: Draft

Definitions for the hc-healthcareservice resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. HealthcareService
Definition

Health Connect entry for a healthcare service at a location by an organisation.


The details of a healthcare service available at a location.

ShortA healthcare service in an Australian healthcare contextThe details of a healthcare service available at a location
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. HealthcareService.implicitRules
Definition

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.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. HealthcareService.extension
Definition

An Extension


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.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control10..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on HealthcareService.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. HealthcareService.extension:hc-iar-levels-of-care
    Slice Namehc-iar-levels-of-care
    Definition

    Indicates the IAR (Initial Assessment and Referral) Levels of Care for a healthcare service. Patterned after PCA IAR Levels of Care extension.

    Context of Use: HealthcareService

    Codes from: http://ns.electronichealth.net.au/hc/CodeSystem/hc-iar-levels-of-care

    ShortHC IAR Levels of Care
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(HC IAR Levels of Care) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. HealthcareService.extension:hc-accept-new-patient
    Slice Namehc-accept-new-patient
    Definition

    Indicates if Healthcare service is accepting new patients. A value of True means the service is accepting new patients.

    ShortIndicates if Healthcare service is accepting new patients
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(HC Accept New Patient) (Extension Type: boolean)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. HealthcareService.extension:hc-referral-information-for-referrer
    Slice Namehc-referral-information-for-referrer
    Definition

    Information for referrers about referral requirements for this healthcare service.

    ShortReferral information for referrers
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(HC Referral Information for Referrer) (Extension Type: markdown)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. HealthcareService.extension:hcActivePeriod
    Slice NamehcActivePeriod
    Definition

    The time period during which the HealthcareService is considered active in the HealthConnect directory.

    ShortThe period during which the HealthcareService is active.
    Control1..1
    This element is affected by the following invariants: ele-1
    TypeExtension(HC Active Period) (Extension Type: Period)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    14. HealthcareService.modifierExtension
    Definition

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

    ShortExtensions that cannot be ignored
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    16. HealthcareService.identifier
    Definition

    Identifier for the organization that is used to identify the healthcare service across multiple disparate systems.


    External identifiers for this item.

    ShortExternal identifiers for this item
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..*
    TypeIdentifier(Identifier, AU HPI-O, AU Residential Aged Care Service Identifier)
    Is Modifierfalse
    Must Supporttrue
    Must Support TypesNo must-support rules about the choice of types/profiles
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. HealthcareService.active
    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.

    ShortWhether this HealthcareService record is in active use
    Comments

    This element is labeled as a modifier because it may be used to mark that the resource was created in error.

    Control0..1
    Typeboolean
    Is Modifiertrue because 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
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. HealthcareService.providedBy
    Definition

    The organization that provides this healthcare service.

    ShortProviding organisationOrganization that provides this service
    Comments

    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.

    Control10..1
    TypeReference(HC Organization, Organization)
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. HealthcareService.type
    Definition

    The specific type of service that may be delivered or performed.

    ShortA high-level descriptor describing the type of healthcare service(s) offered by the organisationType of service that may be delivered or performed
    Control10..*
    BindingThe codes SHALL be taken from For example codes, see Service Type .http://hl7.org/fhir/ValueSet/service-type|4.0.1
    (required to https://healthterminologies.gov.au/fhir/ValueSet/service-type-1)
    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Alternate Namesservice type
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    24. HealthcareService.type.coding
    Definition

    A reference to a code defined by a terminology system.

    ShortDescribes the service(s) offered. At least one coding is requiredCode defined by a terminology system
    Comments

    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

    Control10..*
    TypeCoding
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Requirements

    Allows for alternative encodings within a code system, and translations to other code systems.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. HealthcareService.type.coding.code
    Definition

    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

    ShortThe healthcare service type code from SNOMED-CT-AUSymbol in syntax defined by the system
    Control10..1
    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    Need to refer to a particular code in the system.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. HealthcareService.type.coding.display
    Definition

    A representation of the meaning of the code in the system, following the rules of the system.

    ShortThe display name of the healthcare service type from SNOMED-CT-AURepresentation defined by the system
    Control10..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. HealthcareService.location
    Definition

    The location where this healthcare service may be provided.


    The location(s) where this healthcare service may be provided.

    ShortSingle location for this serviceLocation(s) where service may be provided
    Control10..1*
    TypeReference(HC Location, Location)
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    32. HealthcareService.name
    Definition

    Further description of the service as it would be presented to a consumer while searching.

    ShortDescription of service as presented to a consumer while searching
    Control10..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. HealthcareService.comment
    Definition

    Additional details, that the service provider can add for their directory listing, as a free text, that is not covered by other available data elements.


    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.

    ShortAdditional description and/or any specific information about the healthcare service, not covered elsewhereAdditional description and/or any specific issues not covered elsewhere
    Comments

    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.

    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    36. HealthcareService.telecom
    Definition

    List of contacts related to this specific healthcare service.

    ShortPhone number, fax number, emailContacts related to the healthcare service
    Comments

    If this is empty, then refer to the location's contacts.

    Control0..*
    TypeContactPoint
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    38. HealthcareService.coverageArea
    Definition

    The location(s) that this service is available to (not where the service is provided).

    ShortThe location(s) that this healthcare service is available toLocation(s) service is intended for/available to
    Comments

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

    Control0..*
    TypeReference(HC Service Coverage Area, Location)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. HealthcareService.serviceProvisionCode
    Definition

    The code(s) that detail the conditions under which the healthcare service is available/offered.

    ShortConditions under which service is available/offered
    Comments

    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.

    Control0..*
    BindingThe codes SHALL be taken from For example codes, see HC Service Provision Codehttp://hl7.org/fhir/ValueSet/service-provision-conditions|4.0.1
    (required to http://ns.electronichealth.net.au/hc/ValueSet/hc-service-provision-code-vs)
    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. HealthcareService.eligibility
    Definition

    Does this service have specific eligibility requirements that need to be met in order to use the service?

    ShortSpecific eligibility requirements required to use the service
    Control0..*
    TypeBackboneElement
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    44. HealthcareService.eligibility.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    46. HealthcareService.eligibility.code
    Definition

    Eligibility requirements for the healthcare service, bound to the HealthConnect Service Eligibility ValueSet.


    Coded value for the eligibility.

    ShortEligibility requirements for the healthcare service.Coded value for the eligibility
    Control0..1
    BindingThe codes SHALL be taken from For example codes, see HC Service Eligibility ValueSet
    (required to http://ns.electronichealth.net.au/hc/ValueSet/hc-service-eligibility-vs)
    TypeCodeableConcept
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    48. HealthcareService.communication
    Definition

    Including the languages that the service is offered in, will help assist the requester / searcher in making informed decision and choose the service that meet their requirement when seeking healthcare service.


    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.

    ShortThe languages that this healthcare service is offered inThe language that this service is offered in
    Comments

    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.

    Control0..*
    BindingUnless not suitable, these codes SHALL be taken from The codes SHOULD be taken from Common Languages in Australia .http://hl7.org/fhir/ValueSet/languages|4.0.1
    (extensible to https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2)
    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    50. HealthcareService.appointmentRequired
    Definition

    Whether an appointment is required for this service, or walk-in accepted – Yes or No (Null value represent ‘no data available’).


    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.

    ShortWhether an appointment is required for this serviceIf an appointment is required for access to this service
    Control0..1
    Typeboolean
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    52. HealthcareService.availableTime
    Definition

    A collection of times that the Service Site is available.

    ShortTimes the Service Site is available
    Comments

    More detailed availability information may be provided in associated Schedule/Slot resources.

    Control0..*
    TypeBackboneElement
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    54. HealthcareService.availableTime.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    56. HealthcareService.availableTime.allDay
    Definition

    Is this always available? (hence times are irrelevant) e.g. 24 hour service.

    ShortAlways available? e.g. 24 hour service
    Control0..1
    Typeboolean
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    58. HealthcareService.availableTime.availableStartTime
    Definition

    The opening time of day. Note: If the AllDay flag is set, then this time is ignored.

    ShortOpening time of day (ignored if allDay = true)
    Comments

    The time zone is expected to be for where this HealthcareService is provided at.

    Control0..1
    Typetime
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    60. HealthcareService.availableTime.availableStartTime.extension:timeZone
    Slice NametimeZone
    Definition

    An IANA timezone code for the timezone offset per BCP 175. For data types allowing the offset (all except date and time), this extension SHALL agree with the offset if provided and cannot be used in place of the offset if the precision expressed requires an offset. Where an offset is provided, this extension provides a more legible display of the zone associated with the offset. Where an offset is not present, this extension can be used to provide zone information not otherwise available.

    ShortThe date on which an organisation commences offering a service
    Comments

    These are codes like "America/New_York" or "America/Los_Angeles". See https://www.iana.org/time-zones for the official source, and https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for more information.

    Control0..1
    TypeExtension(Timezone Code) (Extension Type: code)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    62. HealthcareService.availableTime.availableEndTime
    Definition

    The closing time of day. Note: If the AllDay flag is set, then this time is ignored.

    ShortClosing time of day (ignored if allDay = true)
    Comments

    The time zone is expected to be for where this HealthcareService is provided at.

    Control0..1
    Typetime
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    64. HealthcareService.availableTime.availableEndTime.extension:timeZone
    Slice NametimeZone
    Definition

    An IANA timezone code for the timezone offset per BCP 175. For data types allowing the offset (all except date and time), this extension SHALL agree with the offset if provided and cannot be used in place of the offset if the precision expressed requires an offset. Where an offset is provided, this extension provides a more legible display of the zone associated with the offset. Where an offset is not present, this extension can be used to provide zone information not otherwise available.

    ShortThe date on which an organisation ceases to offer a service
    Comments

    These are codes like "America/New_York" or "America/Los_Angeles". See https://www.iana.org/time-zones for the official source, and https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for more information.

    Control0..1
    TypeExtension(Timezone Code) (Extension Type: code)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    66. HealthcareService.notAvailable
    Definition

    The HealthcareService is not available during this period of time due to the provided reason.

    ShortNot available during this time due to provided reason
    Control0..*
    TypeBackboneElement
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    68. HealthcareService.notAvailable.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    70. HealthcareService.notAvailable.description
    Definition

    The reason that can be presented to the user as to why this time is not available.

    ShortReason presented to the user explaining why time not available
    Control1..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    72. HealthcareService.notAvailable.during
    Definition

    Date range that the service is not available - can be open-ended if service is closing.


    Service is not available (seasonally or for a public holiday) from this date.

    ShortDate range that the service is not available - can be open-ended if service is closingService not available from this date
    Control0..1
    TypePeriod
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    74. HealthcareService.endpoint
    Definition

    This will provide the linked endpoints that are related to this healthcare service, that can be discovered by other organisations for system-to-system electronic communication.


    Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.

    ShortReference to all linked endpoints that are related to this healthcare service for electronic communication or exchangeTechnical endpoints providing access to electronic services operated for the healthcare service
    Control0..1*
    TypeReference(HC Endpoint, Endpoint)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

    Guidance on how to interpret the contents of this table can be foundhere

    0. HealthcareService
    Definition

    Health Connect entry for a healthcare service at a location by an organisation.

    2. HealthcareService.extension
    Control1..?
    SlicingThis element introduces a set of slices on HealthcareService.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 4. HealthcareService.extension:hc-iar-levels-of-care
      Slice Namehc-iar-levels-of-care
      Control0..*
      TypeExtension(HC IAR Levels of Care) (Extension Type: CodeableConcept)
      Must Supporttrue
      6. HealthcareService.extension:hc-accept-new-patient
      Slice Namehc-accept-new-patient
      Definition

      Indicates if Healthcare service is accepting new patients. A value of True means the service is accepting new patients.

      ShortIndicates if Healthcare service is accepting new patients
      Control0..1
      TypeExtension(HC Accept New Patient) (Extension Type: boolean)
      Must Supporttrue
      8. HealthcareService.extension:hc-referral-information-for-referrer
      Slice Namehc-referral-information-for-referrer
      Definition

      Information for referrers about referral requirements for this healthcare service.

      ShortReferral information for referrers
      Control0..1
      TypeExtension(HC Referral Information for Referrer) (Extension Type: markdown)
      Must Supporttrue
      10. HealthcareService.extension:hcActivePeriod
      Slice NamehcActivePeriod
      Definition

      The time period during which the HealthcareService is considered active in the HealthConnect directory.

      ShortThe period during which the HealthcareService is active.
      Control1..1
      TypeExtension(HC Active Period) (Extension Type: Period)
      Must Supporttrue
      12. HealthcareService.providedBy
      ShortProviding organisation
      Control1..?
      TypeReference(HC Organization)
      Must Supporttrue
      14. HealthcareService.type
      ShortA high-level descriptor describing the type of healthcare service(s) offered by the organisation
      Control1..?
      BindingThe codes SHALL be taken from Service Type .
      (required to https://healthterminologies.gov.au/fhir/ValueSet/service-type-1)
      16. HealthcareService.type.coding
      ShortDescribes the service(s) offered. At least one coding is required
      Control1..?
      Must Supporttrue
      18. HealthcareService.type.coding.code
      ShortThe healthcare service type code from SNOMED-CT-AU
      Control1..?
      Must Supporttrue
      20. HealthcareService.type.coding.display
      ShortThe display name of the healthcare service type from SNOMED-CT-AU
      Control1..?
      Must Supporttrue
      22. HealthcareService.location
      Definition

      The location where this healthcare service may be provided.

      ShortSingle location for this service
      Control1..1
      TypeReference(HC Location)
      Must Supporttrue
      24. HealthcareService.comment
      Definition

      Additional details, that the service provider can add for their directory listing, as a free text, that is not covered by other available data elements.

      ShortAdditional description and/or any specific information about the healthcare service, not covered elsewhere
      Must Supporttrue
      26. HealthcareService.telecom
      ShortPhone number, fax number, email
      28. HealthcareService.coverageArea
      ShortThe location(s) that this healthcare service is available to
      TypeReference(HC Service Coverage Area)
      Must Supporttrue
      30. HealthcareService.serviceProvisionCode
      BindingThe codes SHALL be taken from HC Service Provision Code
      (required to http://ns.electronichealth.net.au/hc/ValueSet/hc-service-provision-code-vs)
      Must Supporttrue
      32. HealthcareService.eligibility
      Must Supporttrue
      34. HealthcareService.eligibility.code
      Definition

      Eligibility requirements for the healthcare service, bound to the HealthConnect Service Eligibility ValueSet.

      ShortEligibility requirements for the healthcare service.
      BindingThe codes SHALL be taken from HC Service Eligibility ValueSet
      (required to http://ns.electronichealth.net.au/hc/ValueSet/hc-service-eligibility-vs)
      36. HealthcareService.communication
      Definition

      Including the languages that the service is offered in, will help assist the requester / searcher in making informed decision and choose the service that meet their requirement when seeking healthcare service.

      ShortThe languages that this healthcare service is offered in
      Must Supporttrue
      38. HealthcareService.appointmentRequired
      Definition

      Whether an appointment is required for this service, or walk-in accepted – Yes or No (Null value represent ‘no data available’).

      ShortWhether an appointment is required for this service
      Must Supporttrue
      40. HealthcareService.availableTime
      Must Supporttrue
      42. HealthcareService.availableTime.allDay
      Must Supporttrue
      44. HealthcareService.availableTime.availableStartTime
      Must Supporttrue
      46. HealthcareService.availableTime.availableStartTime.extension:timeZone
      Slice NametimeZone
      ShortThe date on which an organisation commences offering a service
      48. HealthcareService.availableTime.availableEndTime
      Must Supporttrue
      50. HealthcareService.availableTime.availableEndTime.extension:timeZone
      Slice NametimeZone
      ShortThe date on which an organisation ceases to offer a service
      52. HealthcareService.notAvailable
      Must Supporttrue
      54. HealthcareService.notAvailable.during
      Definition

      Date range that the service is not available - can be open-ended if service is closing.

      ShortDate range that the service is not available - can be open-ended if service is closing
      56. HealthcareService.endpoint
      Definition

      This will provide the linked endpoints that are related to this healthcare service, that can be discovered by other organisations for system-to-system electronic communication.

      ShortReference to all linked endpoints that are related to this healthcare service for electronic communication or exchange
      Control0..1
      TypeReference(HC Endpoint)
      Must Supporttrue

      Guidance on how to interpret the contents of this table can be foundhere

      0. HealthcareService
      Definition

      Health Connect entry for a healthcare service at a location by an organisation.

      ShortA healthcare service in an Australian healthcare context
      Control0..*
      Is Modifierfalse
      Summaryfalse
      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
      dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
      dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
      dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
      dom-6: A resource should have narrative for robust management (text.`div`.exists())
      2. HealthcareService.id
      Definition

      The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      ShortLogical id of this artifact
      Comments

      The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

      Control0..1
      Typeid
      Is Modifierfalse
      Summarytrue
      4. HealthcareService.meta
      Definition

      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.

      ShortMetadata about the resource
      Control0..1
      TypeMeta
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      6. HealthcareService.implicitRules
      Definition

      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.

      ShortA set of rules under which this content was created
      Comments

      Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

      Control0..1
      Typeuri
      Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      8. HealthcareService.language
      Definition

      The base language in which the resource is written.

      ShortLanguage of the resource content
      Comments

      Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

      Control0..1
      BindingThe codes SHOULD be taken from CommonLanguages
      (preferred to http://hl7.org/fhir/ValueSet/languages)

      A human language.

      Additional BindingsPurpose
      AllLanguagesMax Binding
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      10. HealthcareService.text
      Definition

      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.

      ShortText summary of the resource, for human interpretation
      Comments

      Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

      Control0..1
      TypeNarrative
      Is Modifierfalse
      Summaryfalse
      Alternate Namesnarrative, html, xhtml, display
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      12. HealthcareService.contained
      Definition

      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.

      ShortContained, inline Resources
      Comments

      This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

      Control0..*
      TypeResource
      Is Modifierfalse
      Summaryfalse
      Alternate Namesinline resources, anonymous resources, contained resources
      14. HealthcareService.extension
      Definition

      An Extension

      ShortExtension
      Control1..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on HealthcareService.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 16. HealthcareService.extension:hc-iar-levels-of-care
        Slice Namehc-iar-levels-of-care
        Definition

        Indicates the IAR (Initial Assessment and Referral) Levels of Care for a healthcare service. Patterned after PCA IAR Levels of Care extension.

        Context of Use: HealthcareService

        Codes from: http://ns.electronichealth.net.au/hc/CodeSystem/hc-iar-levels-of-care

        ShortHC IAR Levels of Care
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(HC IAR Levels of Care) (Extension Type: CodeableConcept)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        18. HealthcareService.extension:hc-accept-new-patient
        Slice Namehc-accept-new-patient
        Definition

        Indicates if Healthcare service is accepting new patients. A value of True means the service is accepting new patients.

        ShortIndicates if Healthcare service is accepting new patients
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(HC Accept New Patient) (Extension Type: boolean)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        20. HealthcareService.extension:hc-referral-information-for-referrer
        Slice Namehc-referral-information-for-referrer
        Definition

        Information for referrers about referral requirements for this healthcare service.

        ShortReferral information for referrers
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(HC Referral Information for Referrer) (Extension Type: markdown)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        22. HealthcareService.extension:hcActivePeriod
        Slice NamehcActivePeriod
        Definition

        The time period during which the HealthcareService is considered active in the HealthConnect directory.

        ShortThe period during which the HealthcareService is active.
        Control1..1
        This element is affected by the following invariants: ele-1
        TypeExtension(HC Active Period) (Extension Type: Period)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        24. HealthcareService.modifierExtension
        Definition

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

        ShortExtensions that cannot be ignored
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
        Summaryfalse
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        26. HealthcareService.identifier
        Definition

        Identifier for the organization that is used to identify the healthcare service across multiple disparate systems.

        ShortExternal identifiers for this item
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..*
        TypeIdentifier(Identifier, AU HPI-O, AU Residential Aged Care Service Identifier)
        Is Modifierfalse
        Must Supporttrue
        Must Support TypesNo must-support rules about the choice of types/profiles
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        28. HealthcareService.active
        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.

        ShortWhether this HealthcareService record is in active use
        Comments

        This element is labeled as a modifier because it may be used to mark that the resource was created in error.

        Control0..1
        Typeboolean
        Is Modifiertrue because 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
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        30. HealthcareService.providedBy
        Definition

        The organization that provides this healthcare service.

        ShortProviding organisation
        Comments

        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.

        Control1..1
        TypeReference(HC Organization)
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        32. HealthcareService.category
        Definition

        Identifies the broad category of service being performed or delivered.

        ShortBroad category of service being performed or delivered
        Comments

        Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.

        Control0..*
        BindingFor example codes, see ServiceCategory
        (example to http://hl7.org/fhir/ValueSet/service-category)

        A category of the service(s) that could be provided.

        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Alternate Namesservice category
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        34. HealthcareService.type
        Definition

        The specific type of service that may be delivered or performed.

        ShortA high-level descriptor describing the type of healthcare service(s) offered by the organisation
        Control1..*
        BindingThe codes SHALL be taken from Service Type .
        (required to https://healthterminologies.gov.au/fhir/ValueSet/service-type-1)
        TypeCodeableConcept
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Alternate Namesservice type
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        36. HealthcareService.type.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        38. HealthcareService.type.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. 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.

        ShortAdditional content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingThis element introduces a set of slices on HealthcareService.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 40. HealthcareService.type.coding
          Definition

          A reference to a code defined by a terminology system.

          ShortDescribes the service(s) offered. At least one coding is required
          Comments

          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

          Control1..*
          TypeCoding
          Is Modifierfalse
          Must Supporttrue
          Summarytrue
          Requirements

          Allows for alternative encodings within a code system, and translations to other code systems.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          42. HealthcareService.type.coding.id
          Definition

          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          ShortUnique id for inter-element referencing
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          44. HealthcareService.type.coding.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element. 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.

          ShortAdditional content defined by implementations
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on HealthcareService.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 46. HealthcareService.type.coding.system
            Definition

            The identification of the code system that defines the meaning of the symbol in the code.

            ShortIdentity of the terminology system
            Comments

            The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

            Control0..1
            Typeuri
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Need to be unambiguous about the source of the definition of the symbol.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            48. HealthcareService.type.coding.version
            Definition

            The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

            ShortVersion of the system - if relevant
            Comments

            Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

            NoteThis is a business version Id, not a resource version Id (see discussion)
            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            50. HealthcareService.type.coding.code
            Definition

            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

            ShortThe healthcare service type code from SNOMED-CT-AU
            Control1..1
            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Requirements

            Need to refer to a particular code in the system.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            52. HealthcareService.type.coding.display
            Definition

            A representation of the meaning of the code in the system, following the rules of the system.

            ShortThe display name of the healthcare service type from SNOMED-CT-AU
            Control1..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Requirements

            Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            54. HealthcareService.type.coding.userSelected
            Definition

            Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

            ShortIf this coding was chosen directly by the user
            Comments

            Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

            Control0..1
            Typeboolean
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            56. HealthcareService.type.text
            Definition

            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

            ShortPlain text representation of the concept
            Comments

            Very often the text is the same as a displayName of one of the codings.

            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            58. HealthcareService.specialty
            Definition

            Collection of specialties handled by the service site. This is more of a medical term.

            ShortSpecialties handled by the HealthcareService
            Control0..*
            BindingThe codes SHOULD be taken from Clinical Specialty .
            (preferred to https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1)
            TypeCodeableConcept
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            60. HealthcareService.location
            Definition

            The location where this healthcare service may be provided.

            ShortSingle location for this service
            Control1..1
            TypeReference(HC Location)
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            62. HealthcareService.name
            Definition

            Further description of the service as it would be presented to a consumer while searching.

            ShortDescription of service as presented to a consumer while searching
            Control1..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            64. HealthcareService.comment
            Definition

            Additional details, that the service provider can add for their directory listing, as a free text, that is not covered by other available data elements.

            ShortAdditional description and/or any specific information about the healthcare service, not covered elsewhere
            Comments

            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.

            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            66. HealthcareService.extraDetails
            Definition

            Extra details about the service that can't be placed in the other fields.

            ShortExtra details about the service that can't be placed in the other fields
            Control0..1
            Typemarkdown
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            68. HealthcareService.photo
            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.

            ShortFacilitates quick identification of the service
            Control0..1
            TypeAttachment
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            70. HealthcareService.telecom
            Definition

            List of contacts related to this specific healthcare service.

            ShortPhone number, fax number, email
            Comments

            If this is empty, then refer to the location's contacts.

            Control0..*
            TypeContactPoint
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            72. HealthcareService.coverageArea
            Definition

            The location(s) that this service is available to (not where the service is provided).

            ShortThe location(s) that this healthcare service is available to
            Comments

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

            Control0..*
            TypeReference(HC Service Coverage Area)
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            74. HealthcareService.serviceProvisionCode
            Definition

            The code(s) that detail the conditions under which the healthcare service is available/offered.

            ShortConditions under which service is available/offered
            Comments

            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.

            Control0..*
            BindingThe codes SHALL be taken from HC Service Provision Code
            (required to http://ns.electronichealth.net.au/hc/ValueSet/hc-service-provision-code-vs)
            TypeCodeableConcept
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            76. HealthcareService.eligibility
            Definition

            Does this service have specific eligibility requirements that need to be met in order to use the service?

            ShortSpecific eligibility requirements required to use the service
            Control0..*
            TypeBackboneElement
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            78. HealthcareService.eligibility.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            80. HealthcareService.eligibility.extension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element. 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.

            ShortAdditional content defined by implementations
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            82. HealthcareService.eligibility.modifierExtension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).

            ShortExtensions that cannot be ignored even if unrecognized
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
            Summarytrue
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Namesextensions, user content, modifiers
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            84. HealthcareService.eligibility.code
            Definition

            Eligibility requirements for the healthcare service, bound to the HealthConnect Service Eligibility ValueSet.

            ShortEligibility requirements for the healthcare service.
            Control0..1
            BindingThe codes SHALL be taken from HC Service Eligibility ValueSet
            (required to http://ns.electronichealth.net.au/hc/ValueSet/hc-service-eligibility-vs)
            TypeCodeableConcept
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            86. HealthcareService.eligibility.comment
            Definition

            Describes the eligibility conditions for the service.

            ShortDescribes the eligibility conditions for the service
            Comments

            The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web page.

            Control0..1
            Typemarkdown
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            88. HealthcareService.program
            Definition

            Programs that this service is applicable to.

            ShortPrograms that this service is applicable to
            Comments

            Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….

            Control0..*
            BindingFor example codes, see Program
            (example to http://hl7.org/fhir/ValueSet/program)

            Government or local programs that this service applies to.

            TypeCodeableConcept
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            90. HealthcareService.characteristic
            Definition

            Collection of characteristics (attributes).

            ShortCollection of characteristics (attributes)
            Comments

            These could be such things as is wheelchair accessible.

            Control0..*
            Binding

            A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).

            TypeCodeableConcept
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            92. HealthcareService.communication
            Definition

            Including the languages that the service is offered in, will help assist the requester / searcher in making informed decision and choose the service that meet their requirement when seeking healthcare service.

            ShortThe languages that this healthcare service is offered in
            Comments

            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.

            Control0..*
            BindingUnless not suitable, these codes SHALL be taken from Common Languages in Australia .
            (extensible to https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2)
            TypeCodeableConcept
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            94. HealthcareService.referralMethod
            Definition

            Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.

            ShortWays that the service accepts referrals
            Control0..*
            BindingFor example codes, see ReferralMethod
            (example to http://hl7.org/fhir/ValueSet/service-referral-method)

            The methods of referral can be used when referring to a specific HealthCareService resource.

            TypeCodeableConcept
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            96. HealthcareService.appointmentRequired
            Definition

            Whether an appointment is required for this service, or walk-in accepted – Yes or No (Null value represent ‘no data available’).

            ShortWhether an appointment is required for this service
            Control0..1
            Typeboolean
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            98. HealthcareService.availableTime
            Definition

            A collection of times that the Service Site is available.

            ShortTimes the Service Site is available
            Comments

            More detailed availability information may be provided in associated Schedule/Slot resources.

            Control0..*
            TypeBackboneElement
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            100. HealthcareService.availableTime.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            102. HealthcareService.availableTime.extension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element. 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.

            ShortAdditional content defined by implementations
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            104. HealthcareService.availableTime.modifierExtension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).

            ShortExtensions that cannot be ignored even if unrecognized
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
            Summarytrue
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Namesextensions, user content, modifiers
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            106. HealthcareService.availableTime.daysOfWeek
            Definition

            Indicates which days of the week are available between the start and end Times.

            Shortmon | tue | wed | thu | fri | sat | sun
            Control0..*
            BindingThe codes SHALL be taken from DaysOfWeek
            (required to http://hl7.org/fhir/ValueSet/days-of-week|4.0.1)

            The days of the week.

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            108. HealthcareService.availableTime.allDay
            Definition

            Is this always available? (hence times are irrelevant) e.g. 24 hour service.

            ShortAlways available? e.g. 24 hour service
            Control0..1
            Typeboolean
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            110. HealthcareService.availableTime.availableStartTime
            Definition

            The opening time of day. Note: If the AllDay flag is set, then this time is ignored.

            ShortOpening time of day (ignored if allDay = true)
            Comments

            The time zone is expected to be for where this HealthcareService is provided at.

            Control0..1
            Typetime
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            112. HealthcareService.availableTime.availableStartTime.id
            Definition

            unique id for the element within a resource (for internal references)

            Shortxml:id (or equivalent in JSON)
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            114. HealthcareService.availableTime.availableStartTime.extension
            Definition

            An Extension

            ShortExtension
            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            SlicingThis element introduces a set of slices on HealthcareService.availableTime.availableStartTime.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 116. HealthcareService.availableTime.availableStartTime.extension:timeZone
              Slice NametimeZone
              Definition

              An IANA timezone code for the timezone offset per BCP 175. For data types allowing the offset (all except date and time), this extension SHALL agree with the offset if provided and cannot be used in place of the offset if the precision expressed requires an offset. Where an offset is provided, this extension provides a more legible display of the zone associated with the offset. Where an offset is not present, this extension can be used to provide zone information not otherwise available.

              ShortThe date on which an organisation commences offering a service
              Comments

              These are codes like "America/New_York" or "America/Los_Angeles". See https://www.iana.org/time-zones for the official source, and https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for more information.

              Control0..1
              TypeExtension(Timezone Code) (Extension Type: code)
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              118. HealthcareService.availableTime.availableStartTime.value
              Definition

              The actual value

              ShortPrimitive value for time
              Control0..1
              Typetime
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              120. HealthcareService.availableTime.availableEndTime
              Definition

              The closing time of day. Note: If the AllDay flag is set, then this time is ignored.

              ShortClosing time of day (ignored if allDay = true)
              Comments

              The time zone is expected to be for where this HealthcareService is provided at.

              Control0..1
              Typetime
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              122. HealthcareService.availableTime.availableEndTime.id
              Definition

              unique id for the element within a resource (for internal references)

              Shortxml:id (or equivalent in JSON)
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              124. HealthcareService.availableTime.availableEndTime.extension
              Definition

              An Extension

              ShortExtension
              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on HealthcareService.availableTime.availableEndTime.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 126. HealthcareService.availableTime.availableEndTime.extension:timeZone
                Slice NametimeZone
                Definition

                An IANA timezone code for the timezone offset per BCP 175. For data types allowing the offset (all except date and time), this extension SHALL agree with the offset if provided and cannot be used in place of the offset if the precision expressed requires an offset. Where an offset is provided, this extension provides a more legible display of the zone associated with the offset. Where an offset is not present, this extension can be used to provide zone information not otherwise available.

                ShortThe date on which an organisation ceases to offer a service
                Comments

                These are codes like "America/New_York" or "America/Los_Angeles". See https://www.iana.org/time-zones for the official source, and https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for more information.

                Control0..1
                TypeExtension(Timezone Code) (Extension Type: code)
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                128. HealthcareService.availableTime.availableEndTime.value
                Definition

                The actual value

                ShortPrimitive value for time
                Control0..1
                Typetime
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                130. HealthcareService.notAvailable
                Definition

                The HealthcareService is not available during this period of time due to the provided reason.

                ShortNot available during this time due to provided reason
                Control0..*
                TypeBackboneElement
                Is Modifierfalse
                Must Supporttrue
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                132. HealthcareService.notAvailable.id
                Definition

                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                ShortUnique id for inter-element referencing
                Control0..1
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                134. HealthcareService.notAvailable.extension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element. 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.

                ShortAdditional content defined by implementations
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                136. HealthcareService.notAvailable.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).

                ShortExtensions that cannot be ignored even if unrecognized
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                Summarytrue
                Requirements

                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                Alternate Namesextensions, user content, modifiers
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                138. HealthcareService.notAvailable.description
                Definition

                The reason that can be presented to the user as to why this time is not available.

                ShortReason presented to the user explaining why time not available
                Control1..1
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                140. HealthcareService.notAvailable.during
                Definition

                Date range that the service is not available - can be open-ended if service is closing.

                ShortDate range that the service is not available - can be open-ended if service is closing
                Control0..1
                TypePeriod
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                142. HealthcareService.availabilityExceptions
                Definition

                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.

                ShortDescription of availability exceptions
                Control0..1
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                144. HealthcareService.endpoint
                Definition

                This will provide the linked endpoints that are related to this healthcare service, that can be discovered by other organisations for system-to-system electronic communication.

                ShortReference to all linked endpoints that are related to this healthcare service for electronic communication or exchange
                Control0..1
                TypeReference(HC Endpoint)
                Is Modifierfalse
                Must Supporttrue
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))