Provider Connect Australia (PCA)
24.1.0.0 - active Australia flag

Provider Connect Australia (PCA) - Local Development build (v24.1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: PcaHealthcareService - Detailed Descriptions

Active as of 2024-05-28

Definitions for the pca-healthcare-service resource profile.

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

0. HealthcareService
Definition

A service offered at a location by a publisher.

ShortA service offered by a publisher
Invariantsinv-pca-1: telecom use shall not be 'home' (telecom.where(use = 'home').empty())
inv-pca-2: providedBy shall be a relative reference to an Organization (providedBy.reference.startsWith('Organization/'))
inv-pca-3: location shall be a relative reference to a Location (location.reference.startsWith('Location/'))
inv-pca-4: If eligibility contains 'coverage-restrictedResidents', then coverageArea shall be present (eligibility.where(code.coding.code='coverage-restrictedResidents').exists() implies coverageArea.exists())
inv-pca-5: exactly one type shall be preferred (type.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-preferred' and value=true).count()=1)
inv-pca-6: If present, au-timezone shall be the same as all other au-timezone codes that are present within all availableTime elements ((availableTime.availableStartTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone').exists() or availableTime.availableEndTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone').exists()) implies (((availableTime.availableStartTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone')) | (availableTime.availableEndTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone'))).distinct().count() = 1))
inv-pca-7: If one or more availableTime elements using the availableTimeApplicability extension are present, then at least one availableTime (without the availableTimeApplicability extension) shall be present ((availableTime.modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists()) implies (availableTime.count() > availableTime.modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').count()))
2. HealthcareService.contained
ShortContained inline pca-service-coverage-area resource
TypeResource(PCA Service Coverage Area)
Must Supporttrue
4. HealthcareService.extension:pca-postal-address
Slice Namepca-postal-address
Control0..1
TypeExtension(PCA Postal Address) (Extension Type: Address(Australian Address))
Must Supporttrue
6. HealthcareService.extension:pca-referral-information-for-consumer
Slice Namepca-referral-information-for-consumer
Control0..1
TypeExtension(PCA Referral Information For Consumer) (Extension Type: markdown)
Must Supporttrue
8. HealthcareService.extension:pca-referral-information-for-provider
Slice Namepca-referral-information-for-provider
Control0..1
TypeExtension(PCA Referral Information For Provider) (Extension Type: markdown)
Must Supporttrue
10. HealthcareService.extension:pca-new-patient-availability
Slice Namepca-new-patient-availability
Control1..1
TypeExtension(PCA New Patient Availability) (Extension Type: CodeableConcept)
Must Supporttrue
12. HealthcareService.extension:pca-active-period
Slice Namepca-active-period
Control0..1
TypeExtension(PCAActivePeriod) (Extension Type: Period)
Must Supporttrue
14. HealthcareService.extension:pca-bank-account
Slice Namepca-bank-account
Control0..*
TypeExtension(PCA Bank Account) (Complex Extension)
Must Supporttrue
16. HealthcareService.extension:pca-iar-levels-of-care
Slice Namepca-iar-levels-of-care
Control0..*
TypeExtension(PCA IAR Levels of Care) (Extension Type: CodeableConcept)
Must Supporttrue
18. HealthcareService.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..?
Must Supporttrue
SlicingThis element introduces a set of slices on HealthcareService.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ system
  • 20. HealthcareService.identifier:pca-hsi
    Slice Namepca-hsi
    ShortPCA Healthcare Service Identifier (PCA-HSI) issued by the PCA service
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1
    TypeIdentifier(PCA Healthcare Service Identifier (PCA-HSI))
    Must Supporttrue
    22. HealthcareService.active
    Control1..?
    Must Supporttrue
    24. HealthcareService.providedBy
    Control1..?
    TypeReference(PCA Organization)
    Must Supporttrue
    26. HealthcareService.type
    Control1..?
    BindingThe codes SHALL be taken from PCA Healthcare Service Type
    (required to http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-healthcare-service-type)
    Must Supporttrue
    28. HealthcareService.type.extension:preferred
    Slice Namepreferred
    Definition

    Whether this is the primary service type for this HealthcareService.

    ShortWhether this is the primary service type for this HealthcareService
    Control0..1
    TypeExtension(Preferred) (Extension Type: boolean)
    Must Supporttrue
    30. HealthcareService.location
    Definition

    The location where this healthcare service is provided.

    ShortLocation where service is provided
    Control1..1
    TypeReference(PCA Location)
    Must Supporttrue
    32. HealthcareService.name
    Control1..?
    Must Supporttrue
    34. HealthcareService.telecom
    Must Supporttrue
    36. HealthcareService.telecom.extension:contactPurpose
    Slice NamecontactPurpose
    TypeExtension(Contact Purpose) (Extension Type: CodeableConcept)
    Must Supporttrue
    38. HealthcareService.coverageArea
    TypeReference(PCA Service Coverage Area)contained
    Must Supporttrue
    40. HealthcareService.serviceProvisionCode
    Definition

    The code that details the condition under which the healthcare service is available/offered.

    ShortCondition under which this service is available/offered
    Control1..1
    BindingThe codes SHALL be taken from PCA Service Provision Code
    (required to http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-service-provision-code)
    Must Supporttrue
    42. HealthcareService.eligibility
    Must Supporttrue
    44. HealthcareService.eligibility.code
    Control1..?
    BindingThe codes SHALL be taken from PCA Eligibility
    (required to http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-eligibility)
    Must Supporttrue
    46. HealthcareService.communication
    BindingThe codes SHALL be taken from PCA Common Languages in Australia
    (required to http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-common-languages-australia)
    Must Supporttrue
    48. HealthcareService.referralMethod
    BindingThe codes SHALL be taken from PCA Referral Method
    (required to http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-referral-method)
    Must Supporttrue
    50. HealthcareService.appointmentRequired
    Must Supporttrue
    52. HealthcareService.availableTime
    Must Supporttrue
    Invariantsinv-pca-8: If an availableTime uses the availableTimeApplicability extension, then daysOfWeek shall not be present ((modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists()) implies (daysOfWeek.exists().not()))
    inv-pca-9: If an availableTime does not use the availableTimeApplicability extension, then daysOfWeek shall be present ((modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists().not()) implies (daysOfWeek.exists()))
    54. HealthcareService.availableTime.modifierExtension:availableTimeApplicability
    Slice NameavailableTimeApplicability
    Definition

    Used to indicate a change in the pattern of availability during a particular period and the reason for the change.

    ShortIndicates the period and reason that this instance of availableTime applies
    Control0..1
    TypeExtension(PCA Available Time Applicability) (Complex Extension)
    Must Supporttrue
    56. HealthcareService.availableTime.daysOfWeek
    Must Supporttrue
    58. HealthcareService.availableTime.allDay
    Must Supporttrue
    60. HealthcareService.availableTime.availableStartTime
    Must Supporttrue
    62. HealthcareService.availableTime.availableStartTime.extension:timeZone
    Slice NametimeZone
    Must Supporttrue
    64. HealthcareService.availableTime.availableEndTime
    Must Supporttrue
    66. HealthcareService.availableTime.availableEndTime.extension:timeZone
    Slice NametimeZone
    Must Supporttrue
    68. HealthcareService.notAvailable
    Must Supporttrue
    70. HealthcareService.notAvailable.description
    Must Supporttrue
    72. 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
    Must Supporttrue

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

    0. HealthcareService
    Definition

    A service offered at a location by a publisher.


    The details of a healthcare service available at a location.

    ShortA service offered by a publisherThe 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())
    inv-pca-1: telecom use shall not be 'home' (telecom.where(use = 'home').empty())
    inv-pca-2: providedBy shall be a relative reference to an Organization (providedBy.reference.startsWith('Organization/'))
    inv-pca-3: location shall be a relative reference to a Location (location.reference.startsWith('Location/'))
    inv-pca-4: If eligibility contains 'coverage-restrictedResidents', then coverageArea shall be present (eligibility.where(code.coding.code='coverage-restrictedResidents').exists() implies coverageArea.exists())
    inv-pca-5: exactly one type shall be preferred (type.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-preferred' and value=true).count()=1)
    inv-pca-6: If present, au-timezone shall be the same as all other au-timezone codes that are present within all availableTime elements ((availableTime.availableStartTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone').exists() or availableTime.availableEndTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone').exists()) implies (((availableTime.availableStartTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone')) | (availableTime.availableEndTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone'))).distinct().count() = 1))
    inv-pca-7: If one or more availableTime elements using the availableTimeApplicability extension are present, then at least one availableTime (without the availableTimeApplicability extension) shall be present ((availableTime.modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists()) implies (availableTime.count() > availableTime.modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').count()))
    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.contained
    Definition

    Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.


    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 pca-service-coverage-area resourceContained, 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(PCA Service Coverage Area)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Alternate Namesinline resources, anonymous resources, contained resources
    6. 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
    • 8. HealthcareService.extension:pca-postal-address
      Slice Namepca-postal-address
      Definition

      Postal address.

      ShortPostal address
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(PCA Postal Address) (Extension Type: Address(Australian Address))
      Is Modifierfalse
      Must Supporttrue
      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:pca-referral-information-for-consumer
      Slice Namepca-referral-information-for-consumer
      Definition

      Referral instructions and information for consumers of a healthcare service.

      ShortReferral instructions and information for consumers
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(PCA Referral Information For Consumer) (Extension Type: markdown)
      Is Modifierfalse
      Must Supporttrue
      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:pca-referral-information-for-provider
      Slice Namepca-referral-information-for-provider
      Definition

      Instructions and information for providers referring consumers to a healthcare service.

      ShortReferral instructions and information for providers
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(PCA Referral Information For Provider) (Extension Type: markdown)
      Is Modifierfalse
      Must Supporttrue
      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.extension:pca-new-patient-availability
      Slice Namepca-new-patient-availability
      Definition

      Whether the service is accepting new patients.

      ShortWhether the service is accepting new patients
      Control1..1
      This element is affected by the following invariants: ele-1
      TypeExtension(PCA New Patient Availability) (Extension Type: CodeableConcept)
      Is Modifierfalse
      Must Supporttrue
      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())
      16. HealthcareService.extension:pca-active-period
      Slice Namepca-active-period
      Definition

      Period when the healthcare service is active.

      ShortPeriod when the healthcare service is active
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(PCAActivePeriod) (Extension Type: Period)
      Is Modifierfalse
      Must Supporttrue
      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())
      18. HealthcareService.extension:pca-bank-account
      Slice Namepca-bank-account
      Definition

      Bank account details for the healthcare servcie or practitioner role record.

      ShortBank account details
      Control0..*
      This element is affected by the following invariants: ele-1
      TypeExtension(PCA Bank Account) (Complex Extension)
      Is Modifierfalse
      Must Supporttrue
      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:pca-iar-levels-of-care
      Slice Namepca-iar-levels-of-care
      Definition

      The levels of care that the service provides.

      ShortLevels of care that the service provides
      Control0..*
      This element is affected by the following invariants: ele-1
      TypeExtension(PCA IAR Levels of Care) (Extension Type: CodeableConcept)
      Is Modifierfalse
      Must Supporttrue
      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())
      22. 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())
      24. HealthcareService.identifier
      Definition

      External identifiers for this item.

      ShortExternal identifiers for this item
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control10..*
      This element is affected by the following invariants: ele-1
      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
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      SlicingThis element introduces a set of slices on HealthcareService.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ system
      • 26. HealthcareService.identifier:pca-hsi
        Slice Namepca-hsi
        Definition

        The PCA Healthcare Service Identifier (PCA-HSI) issued by the PCA service to each Healthcare Service.


        External identifiers for this item.

        ShortPCA Healthcare Service Identifier (PCA-HSI) issued by the PCA serviceExternal identifiers for this item
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..1*
        This element is affected by the following invariants: ele-1
        TypeIdentifier(PCA Healthcare Service Identifier (PCA-HSI))
        Is Modifierfalse
        Must Supporttrue
        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.

        Control10..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
        Must Supporttrue
        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.

        ShortOrganization 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(PCA Organization, 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.type
        Definition

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

        ShortType of service that may be delivered or performed
        Control10..*
        BindingThe codes SHALL be taken from For example codes, see PCA Healthcare Service Typehttp://hl7.org/fhir/ValueSet/service-type
        (required to http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-healthcare-service-type)
        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()))
        34. HealthcareService.type.extension:preferred
        Slice Namepreferred
        Definition

        Whether this is the primary service type for this HealthcareService.

        ShortWhether this is the primary service type for this HealthcareService
        Control0..1
        TypeExtension(Preferred) (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())
        36. HealthcareService.location
        Definition

        The location where this healthcare service is provided.


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

        ShortLocation where service is providedLocation(s) where service may be provided
        Control10..1*
        TypeReference(PCA Location, Location)
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        38. 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()))
        40. HealthcareService.telecom
        Definition

        List of contacts related to this specific healthcare service.

        ShortContacts 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()))
        42. HealthcareService.telecom.extension:contactPurpose
        Slice NamecontactPurpose
        Definition

        Indicates a purpose for which the contact can be reached.

        ShortContact purpose
        Control0..*
        TypeExtension(Contact Purpose) (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())
        44. HealthcareService.telecom.use
        Definition

        Identifies the purpose for the contact point.

        Shorthome | work | temp | old | mobile - purpose of this contact point
        Comments

        Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

        Control0..1
        BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
        (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

        Use of contact point.

        Typecode
        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

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

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

        ShortLocation(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(PCA Service Coverage Area, Location)contained
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        48. HealthcareService.serviceProvisionCode
        Definition

        The code that details the condition under which the healthcare service is available/offered.


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

        ShortCondition under which this service is available/offeredConditions 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.

        Control10..1*
        BindingThe codes SHALL be taken from For example codes, see PCA Service Provision Codehttp://hl7.org/fhir/ValueSet/service-provision-conditions
        (required to http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-service-provision-code)
        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.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()))
        52. 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())
        54. HealthcareService.eligibility.code
        Definition

        Coded value for the eligibility.

        ShortCoded value for the eligibility
        Control10..1
        BindingThe codes SHALL be taken from For example codes, see PCA Eligibility
        (required to http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-eligibility)
        TypeCodeableConcept
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        56. HealthcareService.communication
        Definition

        Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.

        ShortThe 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..*
        BindingThe codes SHALL be taken from The codes SHOULD be taken from PCA Common Languages in Australiahttp://hl7.org/fhir/ValueSet/languages
        (required to http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-common-languages-australia)
        TypeCodeableConcept
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        58. 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..*
        BindingThe codes SHALL be taken from For example codes, see PCA Referral Methodhttp://hl7.org/fhir/ValueSet/service-referral-method
        (required to http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-referral-method)
        TypeCodeableConcept
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        60. HealthcareService.appointmentRequired
        Definition

        Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.

        ShortIf 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()))
        62. 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()))
        inv-pca-8: If an availableTime uses the availableTimeApplicability extension, then daysOfWeek shall not be present ((modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists()) implies (daysOfWeek.exists().not()))
        inv-pca-9: If an availableTime does not use the availableTimeApplicability extension, then daysOfWeek shall be present ((modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists().not()) implies (daysOfWeek.exists()))
        64. HealthcareService.availableTime.modifierExtension
        Definition

        An Extension


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

        ShortExtensionExtensions 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())
        SlicingThis element introduces a set of slices on HealthcareService.availableTime.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 66. HealthcareService.availableTime.modifierExtension:availableTimeApplicability
          Slice NameavailableTimeApplicability
          Definition

          Used to indicate a change in the pattern of availability during a particular period and the reason for the change.

          ShortIndicates the period and reason that this instance of availableTime applies
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(PCA Available Time Applicability) (Complex Extension)
          Is Modifiertrue because This extension limits the period during which HealthcareService.availableTime applies.
          Must Supporttrue
          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())
          68. 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 DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1
          (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
          Must Supporttrue
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          70. 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()))
          72. 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()))
          74. HealthcareService.availableTime.availableStartTime.extension:timeZone
          Slice NametimeZone
          Definition

          Australian time zone.

          ShortAU time zone
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Australian Time Zone) (Extension Type: CodeableConcept)
          Is Modifierfalse
          Must Supporttrue
          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())
          76. 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()))
          78. HealthcareService.availableTime.availableEndTime.extension:timeZone
          Slice NametimeZone
          Definition

          Australian time zone.

          ShortAU time zone
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Australian Time Zone) (Extension Type: CodeableConcept)
          Is Modifierfalse
          Must Supporttrue
          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())
          80. 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()))
          82. 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())
          84. 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
          Must Supporttrue
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          86. 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
          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 found here

          0. HealthcareService
          Definition

          A service offered at a location by a publisher.

          ShortA service offered by a publisher
          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())
          inv-pca-1: telecom use shall not be 'home' (telecom.where(use = 'home').empty())
          inv-pca-2: providedBy shall be a relative reference to an Organization (providedBy.reference.startsWith('Organization/'))
          inv-pca-3: location shall be a relative reference to a Location (location.reference.startsWith('Location/'))
          inv-pca-4: If eligibility contains 'coverage-restrictedResidents', then coverageArea shall be present (eligibility.where(code.coding.code='coverage-restrictedResidents').exists() implies coverageArea.exists())
          inv-pca-5: exactly one type shall be preferred (type.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-preferred' and value=true).count()=1)
          inv-pca-6: If present, au-timezone shall be the same as all other au-timezone codes that are present within all availableTime elements ((availableTime.availableStartTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone').exists() or availableTime.availableEndTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone').exists()) implies (((availableTime.availableStartTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone')) | (availableTime.availableEndTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone'))).distinct().count() = 1))
          inv-pca-7: If one or more availableTime elements using the availableTimeApplicability extension are present, then at least one availableTime (without the availableTimeApplicability extension) shall be present ((availableTime.modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists()) implies (availableTime.count() > availableTime.modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').count()))
          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

          Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

          ShortContained inline pca-service-coverage-area resource
          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(PCA Service Coverage Area)
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          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:pca-postal-address
            Slice Namepca-postal-address
            Definition

            Postal address.

            ShortPostal address
            Control0..1
            This element is affected by the following invariants: ele-1
            TypeExtension(PCA Postal Address) (Extension Type: Address(Australian Address))
            Is Modifierfalse
            Must Supporttrue
            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:pca-referral-information-for-consumer
            Slice Namepca-referral-information-for-consumer
            Definition

            Referral instructions and information for consumers of a healthcare service.

            ShortReferral instructions and information for consumers
            Control0..1
            This element is affected by the following invariants: ele-1
            TypeExtension(PCA Referral Information For Consumer) (Extension Type: markdown)
            Is Modifierfalse
            Must Supporttrue
            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:pca-referral-information-for-provider
            Slice Namepca-referral-information-for-provider
            Definition

            Instructions and information for providers referring consumers to a healthcare service.

            ShortReferral instructions and information for providers
            Control0..1
            This element is affected by the following invariants: ele-1
            TypeExtension(PCA Referral Information For Provider) (Extension Type: markdown)
            Is Modifierfalse
            Must Supporttrue
            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:pca-new-patient-availability
            Slice Namepca-new-patient-availability
            Definition

            Whether the service is accepting new patients.

            ShortWhether the service is accepting new patients
            Control1..1
            This element is affected by the following invariants: ele-1
            TypeExtension(PCA New Patient Availability) (Extension Type: CodeableConcept)
            Is Modifierfalse
            Must Supporttrue
            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.extension:pca-active-period
            Slice Namepca-active-period
            Definition

            Period when the healthcare service is active.

            ShortPeriod when the healthcare service is active
            Control0..1
            This element is affected by the following invariants: ele-1
            TypeExtension(PCAActivePeriod) (Extension Type: Period)
            Is Modifierfalse
            Must Supporttrue
            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.extension:pca-bank-account
            Slice Namepca-bank-account
            Definition

            Bank account details for the healthcare servcie or practitioner role record.

            ShortBank account details
            Control0..*
            This element is affected by the following invariants: ele-1
            TypeExtension(PCA Bank Account) (Complex Extension)
            Is Modifierfalse
            Must Supporttrue
            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())
            28. HealthcareService.extension:pca-iar-levels-of-care
            Slice Namepca-iar-levels-of-care
            Definition

            The levels of care that the service provides.

            ShortLevels of care that the service provides
            Control0..*
            This element is affected by the following invariants: ele-1
            TypeExtension(PCA IAR Levels of Care) (Extension Type: CodeableConcept)
            Is Modifierfalse
            Must Supporttrue
            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())
            30. 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())
            32. HealthcareService.identifier
            Definition

            External identifiers for this item.

            ShortExternal identifiers for this item
            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control1..*
            This element is affected by the following invariants: ele-1
            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
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            SlicingThis element introduces a set of slices on HealthcareService.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ system
            • 34. HealthcareService.identifier:pca-hsi
              Slice Namepca-hsi
              Definition

              The PCA Healthcare Service Identifier (PCA-HSI) issued by the PCA service to each Healthcare Service.

              ShortPCA Healthcare Service Identifier (PCA-HSI) issued by the PCA service
              NoteThis is a business identifier, not a resource identifier (see discussion)
              Control0..1
              This element is affected by the following invariants: ele-1
              TypeIdentifier(PCA Healthcare Service Identifier (PCA-HSI))
              Is Modifierfalse
              Must Supporttrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              36. 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.

              Control1..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
              Must Supporttrue
              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()))
              38. HealthcareService.providedBy
              Definition

              The organization that provides this healthcare service.

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

              Control1..1
              TypeReference(PCA Organization)
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              40. 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()))
              42. HealthcareService.type
              Definition

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

              ShortType of service that may be delivered or performed
              Control1..*
              BindingThe codes SHALL be taken from PCA Healthcare Service Type
              (required to http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-healthcare-service-type)
              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()))
              44. 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
              46. 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
              • 48. HealthcareService.type.extension:preferred
                Slice Namepreferred
                Definition

                Whether this is the primary service type for this HealthcareService.

                ShortWhether this is the primary service type for this HealthcareService
                Control0..1
                TypeExtension(Preferred) (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())
                50. HealthcareService.type.coding
                Definition

                A reference to a code defined by a terminology system.

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

                Control0..*
                TypeCoding
                Is Modifierfalse
                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()))
                52. 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()))
                54. 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()))
                56. HealthcareService.location
                Definition

                The location where this healthcare service is provided.

                ShortLocation where service is provided
                Control1..1
                TypeReference(PCA Location)
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                58. 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()))
                60. HealthcareService.comment
                Definition

                Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.

                ShortAdditional 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
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                62. 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()))
                64. 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()))
                66. HealthcareService.telecom
                Definition

                List of contacts related to this specific healthcare service.

                ShortContacts 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()))
                68. HealthcareService.telecom.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
                70. HealthcareService.telecom.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.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 72. HealthcareService.telecom.extension:contactPurpose
                  Slice NamecontactPurpose
                  Definition

                  Indicates a purpose for which the contact can be reached.

                  ShortContact purpose
                  Control0..*
                  TypeExtension(Contact Purpose) (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())
                  74. HealthcareService.telecom.system
                  Definition

                  Telecommunications form for contact point - what communications system is required to make use of the contact.

                  Shortphone | fax | email | pager | url | sms | other
                  Control0..1
                  This element is affected by the following invariants: cpt-2
                  BindingThe codes SHALL be taken from ContactPointSystem
                  (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                  Telecommunications form for contact point.

                  Typecode
                  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()))
                  76. HealthcareService.telecom.value
                  Definition

                  The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

                  ShortThe actual contact point details
                  Comments

                  Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

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

                  Need to support legacy numbers that are not in a tightly controlled format.

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

                  Identifies the purpose for the contact point.

                  Shorthome | work | temp | old | mobile - purpose of this contact point
                  Comments

                  Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                  Control0..1
                  BindingThe codes SHALL be taken from ContactPointUse
                  (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

                  Use of contact point.

                  Typecode
                  Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

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

                  Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                  ShortSpecify preferred order of use (1 = highest)
                  Comments

                  Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

                  Control0..1
                  TypepositiveInt
                  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()))
                  82. HealthcareService.telecom.period
                  Definition

                  Time period when the contact point was/is in use.

                  ShortTime period when the contact point was/is in use
                  Control0..1
                  TypePeriod
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  84. HealthcareService.coverageArea
                  Definition

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

                  ShortLocation(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(PCA Service Coverage Area)contained
                  Is Modifierfalse
                  Must Supporttrue
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  86. HealthcareService.serviceProvisionCode
                  Definition

                  The code that details the condition under which the healthcare service is available/offered.

                  ShortCondition under which this 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.

                  Control1..1
                  BindingThe codes SHALL be taken from PCA Service Provision Code
                  (required to http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-service-provision-code)
                  TypeCodeableConcept
                  Is Modifierfalse
                  Must Supporttrue
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  88. 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()))
                  90. 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
                  92. 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())
                  94. 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())
                  96. HealthcareService.eligibility.code
                  Definition

                  Coded value for the eligibility.

                  ShortCoded value for the eligibility
                  Control1..1
                  BindingThe codes SHALL be taken from PCA Eligibility
                  (required to http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-eligibility)
                  TypeCodeableConcept
                  Is Modifierfalse
                  Must Supporttrue
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  98. 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()))
                  100. 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()))
                  102. 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()))
                  104. HealthcareService.communication
                  Definition

                  Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.

                  ShortThe 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..*
                  BindingThe codes SHALL be taken from PCA Common Languages in Australia
                  (required to http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-common-languages-australia)
                  TypeCodeableConcept
                  Is Modifierfalse
                  Must Supporttrue
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  106. 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..*
                  BindingThe codes SHALL be taken from PCA Referral Method
                  (required to http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-referral-method)
                  TypeCodeableConcept
                  Is Modifierfalse
                  Must Supporttrue
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  108. HealthcareService.appointmentRequired
                  Definition

                  Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.

                  ShortIf 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()))
                  110. 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()))
                  inv-pca-8: If an availableTime uses the availableTimeApplicability extension, then daysOfWeek shall not be present ((modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists()) implies (daysOfWeek.exists().not()))
                  inv-pca-9: If an availableTime does not use the availableTimeApplicability extension, then daysOfWeek shall be present ((modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists().not()) implies (daysOfWeek.exists()))
                  112. 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
                  114. 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())
                  116. HealthcareService.availableTime.modifierExtension
                  Definition

                  An Extension

                  ShortExtension
                  Control0..*
                  TypeExtension
                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                  Summarytrue
                  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.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 118. HealthcareService.availableTime.modifierExtension:availableTimeApplicability
                    Slice NameavailableTimeApplicability
                    Definition

                    Used to indicate a change in the pattern of availability during a particular period and the reason for the change.

                    ShortIndicates the period and reason that this instance of availableTime applies
                    Control0..1
                    This element is affected by the following invariants: ele-1
                    TypeExtension(PCA Available Time Applicability) (Complex Extension)
                    Is Modifiertrue because This extension limits the period during which HealthcareService.availableTime applies.
                    Must Supporttrue
                    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())
                    120. 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
                    Must Supporttrue
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    122. 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()))
                    124. 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()))
                    126. 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
                    128. 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
                    • 130. HealthcareService.availableTime.availableStartTime.extension:timeZone
                      Slice NametimeZone
                      Definition

                      Australian time zone.

                      ShortAU time zone
                      Control0..1
                      This element is affected by the following invariants: ele-1
                      TypeExtension(Australian Time Zone) (Extension Type: CodeableConcept)
                      Is Modifierfalse
                      Must Supporttrue
                      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())
                      132. 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
                      134. 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()))
                      136. 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
                      138. 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
                      • 140. HealthcareService.availableTime.availableEndTime.extension:timeZone
                        Slice NametimeZone
                        Definition

                        Australian time zone.

                        ShortAU time zone
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(Australian Time Zone) (Extension Type: CodeableConcept)
                        Is Modifierfalse
                        Must Supporttrue
                        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())
                        142. 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
                        144. 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()))
                        146. 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
                        148. 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())
                        150. 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())
                        152. 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
                        Must Supporttrue
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        154. 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
                        Must Supporttrue
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        156. 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()))
                        158. HealthcareService.endpoint
                        Definition

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

                        ShortTechnical endpoints providing access to electronic services operated for the healthcare service
                        Control0..*
                        TypeReference(Endpoint)
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))