Provider Connect Australia (PCA)
24.2.0.0 - active

Provider Connect Australia (PCA) - Local Development build (v24.2.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-09-23

Definitions for the pca-healthcare-service resource profile.

- Differential Elements Table
- Key Elements Table
- Snapshot Elements Table

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.
Short | A service offered by a publisher
Invariants | 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.contained
Short | Contained inline pca-service-coverage-area resource
Type | Resource(PCA Service Coverage Area)
Must Support | true
4. HealthcareService.extension:pca-postal-address
Slice Name | pca-postal-address
Control | 0..1
Type | Extension(PCA Postal Address) (Extension Type: Address(Australian Address))
Must Support | true
6. HealthcareService.extension:pca-key-contact
Slice Name | pca-key-contact
Control | 0..*
Type | Extension(PCA Key Contact) (Complex Extension)
Must Support | true
8. HealthcareService.extension:pca-referral-information-for-consumer
Slice Name | pca-referral-information-for-consumer
Control | 0..1
Type | Extension(PCA Referral Information For Consumer) (Extension Type: markdown)
Must Support | true
10. HealthcareService.extension:pca-referral-information-for-provider
Slice Name | pca-referral-information-for-provider
Control | 0..1
Type | Extension(PCA Referral Information For Provider) (Extension Type: markdown)
Must Support | true
12. HealthcareService.extension:pca-new-patient-availability
Slice Name | pca-new-patient-availability
Control | 1..1
Type | Extension(PCA New Patient Availability) (Extension Type: CodeableConcept)
Must Support | true
14. HealthcareService.extension:pca-active-period
Slice Name | pca-active-period
Control | 0..1
Type | Extension(PCAActivePeriod) (Extension Type: Period)
Must Support | true
16. HealthcareService.extension:pca-bank-account
Slice Name | pca-bank-account
Control | 0..*
Type | Extension(PCA Bank Account) (Complex Extension)
Must Support | true
18. HealthcareService.extension:pca-iar-levels-of-care
Slice Name | pca-iar-levels-of-care
Control | 0..*
Type | Extension(PCA IAR Levels of Care) (Extension Type: CodeableConcept)
Must Support | true
20. HealthcareService.identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..?
Must Support | true
Slicing | This element introduces a set of slices on `HealthcareService.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
22. HealthcareService.identifier:pca-hsi
Slice Name | pca-hsi
Short | PCA Healthcare Service Identifier (PCA-HSI) issued by the PCA service
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier(PCA Healthcare Service Identifier (PCA-HSI))
Must Support | true
24. HealthcareService.active
Control | 1..?
Must Support | true
26. HealthcareService.providedBy
Control | 1..?
Type | Reference(PCA Organization)
Must Support | true
28. HealthcareService.type
Control | 1..?
Binding | The 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 Support | true
30. HealthcareService.type.extension:preferred
Slice Name | preferred
Definition | Whether this is the primary service type for this HealthcareService.
Short | Whether this is the primary service type for this HealthcareService
Control | 0..1
Type | Extension(Preferred) (Extension Type: boolean)
Must Support | true
32. HealthcareService.location
Definition | The location where this healthcare service is provided.
Short | Location where service is provided
Control | 1..1
Type | Reference(PCA Location)
Must Support | true
34. HealthcareService.name
Control | 1..?
Must Support | true
36. HealthcareService.comment
Must Support | true
38. HealthcareService.telecom
Must Support | true
40. HealthcareService.telecom.extension:contactPurpose
Slice Name | contactPurpose
Type | Extension(Contact Purpose) (Extension Type: CodeableConcept)
Must Support | true
42. HealthcareService.coverageArea
Type | Reference(PCA Service Coverage Area)contained
Must Support | true
44. HealthcareService.serviceProvisionCode
Definition | The code that details the condition under which the healthcare service is available/offered.
Short | Condition under which this service is available/offered
Control | 1..1
Binding | The 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 Support | true
46. HealthcareService.eligibility
Must Support | true
48. HealthcareService.eligibility.code
Control | 1..?
Binding | The codes SHALL be taken from PCA Eligibility (required to `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-eligibility` )
Must Support | true
50. HealthcareService.communication
Binding | The 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 Support | true
52. HealthcareService.referralMethod
Binding | The codes SHALL be taken from PCA Referral Method (required to `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-referral-method` )
Must Support | true
54. HealthcareService.appointmentRequired
Must Support | true
56. HealthcareService.availableTime
Must Support | true
Invariants | 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())`)
58. HealthcareService.availableTime.modifierExtension:availableTimeApplicability
Slice Name | availableTimeApplicability
Definition | Used to indicate a change in the pattern of availability during a particular period and the reason for the change.
Short | Indicates the period and reason that this instance of availableTime applies
Control | 0..1
Type | Extension(PCA Available Time Applicability) (Complex Extension)
Must Support | true
60. HealthcareService.availableTime.daysOfWeek
Must Support | true
62. HealthcareService.availableTime.allDay
Must Support | true
64. HealthcareService.availableTime.availableStartTime
Must Support | true
66. HealthcareService.availableTime.availableStartTime.extension:timeZone
Slice Name | timeZone
Must Support | true
68. HealthcareService.availableTime.availableEndTime
Must Support | true
70. HealthcareService.availableTime.availableEndTime.extension:timeZone
Slice Name | timeZone
Must Support | true
72. HealthcareService.notAvailable
Must Support | true
74. HealthcareService.notAvailable.description
Must Support | true
76. HealthcareService.notAvailable.during
Definition | Date range that the service is not available - can be open-ended if service is closing.
Short | Date range that the service is not available - can be open-ended if service is closing
Must Support | true

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.
Short | A service offered by a publisherThe details of a healthcare service available at a location
Control | 0..*
Is Modifier | false
Summary | false
Invariants | dom-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.
Short | A 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.
Control | 0..1
Type | uri
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-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.
Short | Contained 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.
Control | 0..*
Type | Resource(PCA Service Coverage Area)
Is Modifier | false
Must Support | true
Summary | false
Alternate Names | inline 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.
Short | ExtensionAdditional 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.
Control | 10..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This 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 Name | pca-postal-address
Definition | Postal address.
Short | Postal address
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(PCA Postal Address) (Extension Type: Address(Australian Address))
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. HealthcareService.extension:pca-key-contact
Slice Name | pca-key-contact
Definition | Key contact details for the PCA healthcare service record.
Short | Key Contact details
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(PCA Key Contact) (Complex Extension)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
12. HealthcareService.extension:pca-referral-information-for-consumer
Slice Name | pca-referral-information-for-consumer
Definition | Referral instructions and information for consumers of a healthcare service.
Short | Referral instructions and information for consumers
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(PCA Referral Information For Consumer) (Extension Type: markdown)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. HealthcareService.extension:pca-referral-information-for-provider
Slice Name | pca-referral-information-for-provider
Definition | Instructions and information for providers referring consumers to a healthcare service.
Short | Referral instructions and information for providers
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(PCA Referral Information For Provider) (Extension Type: markdown)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. HealthcareService.extension:pca-new-patient-availability
Slice Name | pca-new-patient-availability
Definition | Whether the service is accepting new patients.
Short | Whether the service is accepting new patients
Control | 1..1 This element is affected by the following invariants: ele-1
Type | Extension(PCA New Patient Availability) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. HealthcareService.extension:pca-active-period
Slice Name | pca-active-period
Definition | Period when the healthcare service is active.
Short | Period when the healthcare service is active
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(PCAActivePeriod) (Extension Type: Period)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. HealthcareService.extension:pca-bank-account
Slice Name | pca-bank-account
Definition | Bank account details for the healthcare service, practitioner or practitioner role record.
Short | Bank account details
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(PCA Bank Account) (Complex Extension)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
22. HealthcareService.extension:pca-iar-levels-of-care
Slice Name | pca-iar-levels-of-care
Definition | The levels of care that the service provides.
Short | Levels of care that the service provides
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(PCA IAR Levels of Care) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
24. HealthcareService.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
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 Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
26. HealthcareService.identifier
Definition | External identifiers for this item.
Short | External identifiers for this item
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 10..* This element is affected by the following invariants: ele-1
Type | Identifier(Identifier, AU HPI-O, AU Residential Aged Care Service Identifier)
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `HealthcareService.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
28. HealthcareService.identifier:pca-hsi
Slice Name | pca-hsi
Definition | The PCA Healthcare Service Identifier (PCA-HSI) issued by the PCA service to each Healthcare Service. External identifiers for this item.
Short | PCA Healthcare Service Identifier (PCA-HSI) issued by the PCA serviceExternal identifiers for this item
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1* This element is affected by the following invariants: ele-1
Type | Identifier(PCA Healthcare Service Identifier (PCA-HSI))
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. 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.
Short | Whether 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.
Control | 10..1
Type | boolean
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. HealthcareService.providedBy
Definition | The organization that provides this healthcare service.
Short | Organization 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.
Control | 10..1
Type | Reference(PCA Organization, Organization)
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. HealthcareService.type
Definition | The specific type of service that may be delivered or performed.
Short | Type of service that may be delivered or performed
Control | 10..*
Binding | The codes SHALL be taken from For example codes, see PCA Healthcare Service Type http://hl7.org/fhir/ValueSet/service-type (required to `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-healthcare-service-type` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | service type
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. HealthcareService.type.extension:preferred
Slice Name | preferred
Definition | Whether this is the primary service type for this HealthcareService.
Short | Whether this is the primary service type for this HealthcareService
Control | 0..1
Type | Extension(Preferred) (Extension Type: boolean)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
38. HealthcareService.location
Definition | The location where this healthcare service is provided. The location(s) where this healthcare service may be provided.
Short | Location where service is providedLocation(s) where service may be provided
Control | 10..1*
Type | Reference(PCA Location, Location)
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. HealthcareService.name
Definition | Further description of the service as it would be presented to a consumer while searching.
Short | Description of service as presented to a consumer while searching
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. 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.
Short | Additional 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.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. HealthcareService.telecom
Definition | List of contacts related to this specific healthcare service.
Short | Contacts related to the healthcare service
Comments | If this is empty, then refer to the location's contacts.
Control | 0..*
Type | ContactPoint
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. HealthcareService.telecom.extension:contactPurpose
Slice Name | contactPurpose
Definition | Indicates a purpose for which the contact can be reached.
Short | Contact purpose
Control | 0..*
Type | Extension(Contact Purpose) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
48. HealthcareService.telecom.use
Definition | Identifies the purpose for the contact point.
Short | home | 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.
Control | 0..1
Binding | The codes SHALL be taken from ContactPointUse http://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.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. HealthcareService.coverageArea
Definition | The location(s) that this service is available to (not where the service is provided).
Short | Location(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".
Control | 0..*
Type | Reference(PCA Service Coverage Area, Location)contained
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. 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.
Short | Condition 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.
Control | 10..1*
Binding | The codes SHALL be taken from For example codes, see PCA Service Provision Code http://hl7.org/fhir/ValueSet/service-provision-conditions (required to `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-service-provision-code` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. HealthcareService.eligibility
Definition | Does this service have specific eligibility requirements that need to be met in order to use the service?
Short | Specific eligibility requirements required to use the service
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
58. HealthcareService.eligibility.code
Definition | Coded value for the eligibility.
Short | Coded value for the eligibility
Control | 10..1
Binding | The codes SHALL be taken from For example codes, see PCA Eligibility (required to `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-eligibility` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. 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.
Short | The 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.
Control | 0..*
Binding | The codes SHALL be taken from The codes SHOULD be taken from PCA Common Languages in Australia http://hl7.org/fhir/ValueSet/languages (required to `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-common-languages-australia` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. HealthcareService.referralMethod
Definition | Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.
Short | Ways that the service accepts referrals
Control | 0..*
Binding | The codes SHALL be taken from For example codes, see PCA Referral Method http://hl7.org/fhir/ValueSet/service-referral-method (required to `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-referral-method` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. 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.
Short | If an appointment is required for access to this service
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. HealthcareService.availableTime
Definition | A collection of times that the Service Site is available.
Short | Times the Service Site is available
Comments | More detailed availability information may be provided in associated Schedule/Slot resources.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-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())`)
68. 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).
Short | ExtensionExtensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This 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
70. HealthcareService.availableTime.modifierExtension:availableTimeApplicability
Slice Name | availableTimeApplicability
Definition | Used to indicate a change in the pattern of availability during a particular period and the reason for the change.
Short | Indicates the period and reason that this instance of availableTime applies
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(PCA Available Time Applicability) (Complex Extension)
Is Modifier | true because This extension limits the period during which HealthcareService.availableTime applies.
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
72. HealthcareService.availableTime.daysOfWeek
Definition | Indicates which days of the week are available between the start and end Times.
Short | mon | tue | wed | thu | fri | sat | sun
Control | 0..*
Binding | The codes SHALL be taken from DaysOfWeek http://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.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. HealthcareService.availableTime.allDay
Definition | Is this always available? (hence times are irrelevant) e.g. 24 hour service.
Short | Always available? e.g. 24 hour service
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. HealthcareService.availableTime.availableStartTime
Definition | The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
Short | Opening time of day (ignored if allDay = true)
Comments | The time zone is expected to be for where this HealthcareService is provided at.
Control | 0..1
Type | time
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. HealthcareService.availableTime.availableStartTime.extension:timeZone
Slice Name | timeZone
Definition | Australian time zone.
Short | AU time zone
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Australian Time Zone) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
80. HealthcareService.availableTime.availableEndTime
Definition | The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
Short | Closing time of day (ignored if allDay = true)
Comments | The time zone is expected to be for where this HealthcareService is provided at.
Control | 0..1
Type | time
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. HealthcareService.availableTime.availableEndTime.extension:timeZone
Slice Name | timeZone
Definition | Australian time zone.
Short | AU time zone
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Australian Time Zone) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
84. HealthcareService.notAvailable
Definition | The HealthcareService is not available during this period of time due to the provided reason.
Short | Not available during this time due to provided reason
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
88. HealthcareService.notAvailable.description
Definition | The reason that can be presented to the user as to why this time is not available.
Short | Reason presented to the user explaining why time not available
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. 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.
Short | Date range that the service is not available - can be open-ended if service is closingService not available from this date
Control | 0..1
Type | Period
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-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.
Short | A service offered by a publisher
Control | 0..*
Is Modifier | false
Summary | false
Invariants | dom-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.
Short | Logical 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.
Control | 0..1
Type | id
Is Modifier | false
Summary | true
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.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Summary | true
Invariants | ele-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.
Short | A 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.
Control | 0..1
Type | uri
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-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.
Short | Language 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).
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-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.
Short | Text 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.
Control | 0..1
Type | Narrative
Is Modifier | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-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.
Short | Contained 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.
Control | 0..*
Type | Resource(PCA Service Coverage Area)
Is Modifier | false
Must Support | true
Summary | false
14. HealthcareService.extension
Definition | An Extension
Short | Extension
Control | 1..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This 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 Name | pca-postal-address
Definition | Postal address.
Short | Postal address
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(PCA Postal Address) (Extension Type: Address(Australian Address))
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. HealthcareService.extension:pca-key-contact
Slice Name | pca-key-contact
Definition | Key contact details for the PCA healthcare service record.
Short | Key Contact details
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(PCA Key Contact) (Complex Extension)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
20. HealthcareService.extension:pca-referral-information-for-consumer
Slice Name | pca-referral-information-for-consumer
Definition | Referral instructions and information for consumers of a healthcare service.
Short | Referral instructions and information for consumers
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(PCA Referral Information For Consumer) (Extension Type: markdown)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
22. HealthcareService.extension:pca-referral-information-for-provider
Slice Name | pca-referral-information-for-provider
Definition | Instructions and information for providers referring consumers to a healthcare service.
Short | Referral instructions and information for providers
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(PCA Referral Information For Provider) (Extension Type: markdown)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
24. HealthcareService.extension:pca-new-patient-availability
Slice Name | pca-new-patient-availability
Definition | Whether the service is accepting new patients.
Short | Whether the service is accepting new patients
Control | 1..1 This element is affected by the following invariants: ele-1
Type | Extension(PCA New Patient Availability) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
26. HealthcareService.extension:pca-active-period
Slice Name | pca-active-period
Definition | Period when the healthcare service is active.
Short | Period when the healthcare service is active
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(PCAActivePeriod) (Extension Type: Period)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
28. HealthcareService.extension:pca-bank-account
Slice Name | pca-bank-account
Definition | Bank account details for the healthcare service, practitioner or practitioner role record.
Short | Bank account details
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(PCA Bank Account) (Complex Extension)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
30. HealthcareService.extension:pca-iar-levels-of-care
Slice Name | pca-iar-levels-of-care
Definition | The levels of care that the service provides.
Short | Levels of care that the service provides
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(PCA IAR Levels of Care) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
32. 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
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 Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
34. HealthcareService.identifier
Definition | External identifiers for this item.
Short | External identifiers for this item
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..* This element is affected by the following invariants: ele-1
Type | Identifier(Identifier, AU HPI-O, AU Residential Aged Care Service Identifier)
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `HealthcareService.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
36. HealthcareService.identifier:pca-hsi
Slice Name | pca-hsi
Definition | The PCA Healthcare Service Identifier (PCA-HSI) issued by the PCA service to each Healthcare Service.
Short | PCA Healthcare Service Identifier (PCA-HSI) issued by the PCA service
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Identifier(PCA Healthcare Service Identifier (PCA-HSI))
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
38. 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.
Short | Whether 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.
Control | 1..1
Type | boolean
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. HealthcareService.providedBy
Definition | The organization that provides this healthcare service.
Short | Organization 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.
Control | 1..1
Type | Reference(PCA Organization)
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
42. HealthcareService.category
Definition | Identifies the broad category of service being performed or delivered.
Short | Broad 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.
Control | 0..*
Binding | For example codes, see ServiceCategory (example to `http://hl7.org/fhir/ValueSet/service-category` ) A category of the service(s) that could be provided.
Type | CodeableConcept
Is Modifier | false
Summary | true
Alternate Names | service category
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
44. HealthcareService.type
Definition | The specific type of service that may be delivered or performed.
Short | Type of service that may be delivered or performed
Control | 1..*
Binding | The codes SHALL be taken from PCA Healthcare Service Type (required to `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-healthcare-service-type` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | service type
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
46. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
48. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This 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
50. HealthcareService.type.extension:preferred
Slice Name | preferred
Definition | Whether this is the primary service type for this HealthcareService.
Short | Whether this is the primary service type for this HealthcareService
Control | 0..1
Type | Extension(Preferred) (Extension Type: boolean)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
52. HealthcareService.type.coding
Definition | A reference to a code defined by a terminology system.
Short | Code 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.
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. 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.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
56. HealthcareService.specialty
Definition | Collection of specialties handled by the service site. This is more of a medical term.
Short | Specialties handled by the HealthcareService
Control | 0..*
Binding | The codes SHOULD be taken from Clinical Specialty (preferred to `https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1` )
Type | CodeableConcept
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
58. HealthcareService.location
Definition | The location where this healthcare service is provided.
Short | Location where service is provided
Control | 1..1
Type | Reference(PCA Location)
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. HealthcareService.name
Definition | Further description of the service as it would be presented to a consumer while searching.
Short | Description of service as presented to a consumer while searching
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
62. 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.
Short | Additional 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.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. HealthcareService.extraDetails
Definition | Extra details about the service that can't be placed in the other fields.
Short | Extra details about the service that can't be placed in the other fields
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
66. 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.
Short | Facilitates quick identification of the service
Control | 0..1
Type | Attachment
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
68. HealthcareService.telecom
Definition | List of contacts related to this specific healthcare service.
Short | Contacts related to the healthcare service
Comments | If this is empty, then refer to the location's contacts.
Control | 0..*
Type | ContactPoint
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
70. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
72. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This 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
74. HealthcareService.telecom.extension:contactPurpose
Slice Name | contactPurpose
Definition | Indicates a purpose for which the contact can be reached.
Short | Contact purpose
Control | 0..*
Type | Extension(Contact Purpose) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
76. HealthcareService.telecom.system
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact.
Short | phone | fax | email | pager | url | sms | other
Control | 0..1 This element is affected by the following invariants: cpt-2
Binding | The codes SHALL be taken from ContactPointSystem (required to `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` ) Telecommunications form for contact point.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
78. 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).
Short | The 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.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to support legacy numbers that are not in a tightly controlled format.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
80. HealthcareService.telecom.use
Definition | Identifies the purpose for the contact point.
Short | home | 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.
Control | 0..1
Binding | The codes SHALL be taken from ContactPointUse (required to `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` ) Use of contact point.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
82. 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.
Short | Specify 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.
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
84. HealthcareService.telecom.period
Definition | Time period when the contact point was/is in use.
Short | Time period when the contact point was/is in use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
86. HealthcareService.coverageArea
Definition | The location(s) that this service is available to (not where the service is provided).
Short | Location(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".
Control | 0..*
Type | Reference(PCA Service Coverage Area)contained
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
88. HealthcareService.serviceProvisionCode
Definition | The code that details the condition under which the healthcare service is available/offered.
Short | Condition 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.
Control | 1..1
Binding | The codes SHALL be taken from PCA Service Provision Code (required to `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-service-provision-code` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
90. HealthcareService.eligibility
Definition | Does this service have specific eligibility requirements that need to be met in order to use the service?
Short | Specific eligibility requirements required to use the service
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
92. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
94. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
96. 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
98. HealthcareService.eligibility.code
Definition | Coded value for the eligibility.
Short | Coded value for the eligibility
Control | 1..1
Binding | The codes SHALL be taken from PCA Eligibility (required to `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-eligibility` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
100. HealthcareService.eligibility.comment
Definition | Describes the eligibility conditions for the service.
Short | Describes 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.
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
102. HealthcareService.program
Definition | Programs that this service is applicable to.
Short | Programs 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, ….
Control | 0..*
Binding | For example codes, see Program (example to `http://hl7.org/fhir/ValueSet/program` ) Government or local programs that this service applies to.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
104. HealthcareService.characteristic
Definition | Collection of characteristics (attributes).
Short | Collection of characteristics (attributes)
Comments | These could be such things as is wheelchair accessible.
Control | 0..*
Binding | A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
106. 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.
Short | The 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.
Control | 0..*
Binding | The 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` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
108. HealthcareService.referralMethod
Definition | Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.
Short | Ways that the service accepts referrals
Control | 0..*
Binding | The codes SHALL be taken from PCA Referral Method (required to `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-referral-method` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
110. 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.
Short | If an appointment is required for access to this service
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
112. HealthcareService.availableTime
Definition | A collection of times that the Service Site is available.
Short | Times the Service Site is available
Comments | More detailed availability information may be provided in associated Schedule/Slot resources.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-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())`)
114. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
116. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
118. HealthcareService.availableTime.modifierExtension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This 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
120. HealthcareService.availableTime.modifierExtension:availableTimeApplicability
Slice Name | availableTimeApplicability
Definition | Used to indicate a change in the pattern of availability during a particular period and the reason for the change.
Short | Indicates the period and reason that this instance of availableTime applies
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(PCA Available Time Applicability) (Complex Extension)
Is Modifier | true because This extension limits the period during which HealthcareService.availableTime applies.
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
122. HealthcareService.availableTime.daysOfWeek
Definition | Indicates which days of the week are available between the start and end Times.
Short | mon | tue | wed | thu | fri | sat | sun
Control | 0..*
Binding | The codes SHALL be taken from DaysOfWeek (required to `http://hl7.org/fhir/ValueSet/days-of-week|4.0.1` ) The days of the week.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
124. HealthcareService.availableTime.allDay
Definition | Is this always available? (hence times are irrelevant) e.g. 24 hour service.
Short | Always available? e.g. 24 hour service
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
126. HealthcareService.availableTime.availableStartTime
Definition | The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
Short | Opening time of day (ignored if allDay = true)
Comments | The time zone is expected to be for where this HealthcareService is provided at.
Control | 0..1
Type | time
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
128. HealthcareService.availableTime.availableStartTime.id
Definition | unique id for the element within a resource (for internal references)
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
130. HealthcareService.availableTime.availableStartTime.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This 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
132. HealthcareService.availableTime.availableStartTime.extension:timeZone
Slice Name | timeZone
Definition | Australian time zone.
Short | AU time zone
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Australian Time Zone) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
134. HealthcareService.availableTime.availableStartTime.value
Definition | The actual value
Short | Primitive value for time
Control | 0..1
Type | time
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
136. HealthcareService.availableTime.availableEndTime
Definition | The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
Short | Closing time of day (ignored if allDay = true)
Comments | The time zone is expected to be for where this HealthcareService is provided at.
Control | 0..1
Type | time
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
138. HealthcareService.availableTime.availableEndTime.id
Definition | unique id for the element within a resource (for internal references)
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
140. HealthcareService.availableTime.availableEndTime.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This 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
142. HealthcareService.availableTime.availableEndTime.extension:timeZone
Slice Name | timeZone
Definition | Australian time zone.
Short | AU time zone
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Australian Time Zone) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
144. HealthcareService.availableTime.availableEndTime.value
Definition | The actual value
Short | Primitive value for time
Control | 0..1
Type | time
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
146. HealthcareService.notAvailable
Definition | The HealthcareService is not available during this period of time due to the provided reason.
Short | Not available during this time due to provided reason
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
148. 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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
150. 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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
152. 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
154. HealthcareService.notAvailable.description
Definition | The reason that can be presented to the user as to why this time is not available.
Short | Reason presented to the user explaining why time not available
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
156. HealthcareService.notAvailable.during
Definition | Date range that the service is not available - can be open-ended if service is closing.
Short | Date range that the service is not available - can be open-ended if service is closing
Control | 0..1
Type | Period
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
158. 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.
Short | Description of availability exceptions
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
160. HealthcareService.endpoint
Definition | Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.
Short | Technical endpoints providing access to electronic services operated for the healthcare service
Control | 0..*
Type | Reference(Endpoint)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)