AU Base Implementation Guide
4.2.2-ci-build - CI Build Australia flag

This page is part of the Australian Base IG (v4.2.1-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.1.0. For a full list of available versions, see the Directory of published versions

Resource Profile: AUBaseHealthcareService - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 3

Definitions for the au-healthcareservice resource profile.

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

0. HealthcareService
ShortA healthcare service in an Australian healthcare context
2. HealthcareService.identifier
Definition

External identifiers for this item.

ShortExternal identifiers for this item
NoteThis is a business identifier, not a resource identifier (see discussion)
TypeIdentifier(Identifier, AU HPI-O, AU Residential Aged Care Service Identifier)
4. HealthcareService.type
BindingThe codes SHOULD be taken from Service Type .
(preferred to https://healthterminologies.gov.au/fhir/ValueSet/service-type-1)
6. HealthcareService.specialty
BindingThe codes SHOULD be taken from Clinical Specialty .
(preferred to https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1)
8. HealthcareService.serviceProvisionCode
BindingThe codes SHOULD be taken from Service Provision Conditions Australian Concepts
(preferred to http://terminology.hl7.org.au/ValueSet/service-provision-conditions)
10. HealthcareService.availableTime
12. HealthcareService.availableTime.availableStartTime
14. HealthcareService.availableTime.availableStartTime.extension:timeZone
Slice NametimeZone
Control0..1
TypeExtension(Australian Time Zone) (Extension Type: CodeableConcept)
16. HealthcareService.availableTime.availableEndTime
18. HealthcareService.availableTime.availableEndTime.extension:timeZone
Slice NametimeZone
Control0..1
TypeExtension(Australian Time Zone) (Extension Type: CodeableConcept)

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

0. HealthcareService
Definition

The details of a healthcare service available at a location.

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

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

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

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

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

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

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

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

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

External identifiers for this item.

ShortExternal identifiers for this item
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
This element is affected by the following invariants: ele-1
TypeIdentifier(Identifier, AU HPI-O, AU Residential Aged Care Service Identifier)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. HealthcareService.active
Definition

This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.

ShortWhether this HealthcareService record is in active use
Comments

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

Control0..1
Typeboolean
Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. HealthcareService.type
Definition

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

ShortType of service that may be delivered or performed
Control0..*
BindingThe codes SHOULD be taken from For example codes, see Service Type .http://hl7.org/fhir/ValueSet/service-type
(preferred to https://healthterminologies.gov.au/fhir/ValueSet/service-type-1)
TypeCodeableConcept
Is Modifierfalse
Summarytrue
Alternate Namesservice type
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. HealthcareService.specialty
Definition

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

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

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

ShortConditions under which service is available/offered
Comments

The provision means being commissioned by, contractually obliged or financially sourced. Types of costings that may apply to this healthcare service, such if the service may be available for free, some discounts available, or fees apply.

Control0..*
BindingThe codes SHOULD be taken from For example codes, see Service Provision Conditions Australian Conceptshttp://hl7.org/fhir/ValueSet/service-provision-conditions
(preferred to http://terminology.hl7.org.au/ValueSet/service-provision-conditions)
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

0. HealthcareService
Definition

The details of a healthcare service available at a location.

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

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

ShortLogical id of this artifact
Comments

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

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

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

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

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

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

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

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

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

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

A human language.

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

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

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

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

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

ShortContained, inline Resources
Comments

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

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

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.

ShortAdditional content defined by implementations
Comments

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

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

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

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

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

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

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

External identifiers for this item.

ShortExternal identifiers for this item
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
This element is affected by the following invariants: ele-1
TypeIdentifier(Identifier, AU HPI-O, AU Residential Aged Care Service Identifier)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. HealthcareService.active
Definition

This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.

ShortWhether this HealthcareService record is in active use
Comments

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

Control0..1
Typeboolean
Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. HealthcareService.providedBy
Definition

The organization that provides this healthcare service.

ShortOrganization that provides this service
Comments

This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such. If the Location does not have a managing Organization, then this property should be populated.

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

Identifies the broad category of service being performed or delivered.

ShortBroad category of service being performed or delivered
Comments

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

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

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

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

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

ShortType of service that may be delivered or performed
Control0..*
BindingThe codes SHOULD be taken from Service Type .
(preferred to https://healthterminologies.gov.au/fhir/ValueSet/service-type-1)
TypeCodeableConcept
Is Modifierfalse
Summarytrue
Alternate Namesservice type
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. HealthcareService.specialty
Definition

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

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

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

ShortLocation(s) where service may be provided
Control0..*
TypeReference(Location)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. HealthcareService.name
Definition

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

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

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

ShortAdditional description and/or any specific issues not covered elsewhere
Comments

Would expect that a user would not see this information on a search results, and it would only be available when viewing the complete details of the service.

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

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

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

If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.

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

List of contacts related to this specific healthcare service.

ShortContacts related to the healthcare service
Comments

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

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

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

ShortLocation(s) service is intended for/available to
Comments

The locations referenced by the coverage area can include both specific locations, including areas, and also conceptual domains too (mode = kind), such as a physical area (tri-state area) and some other attribute (covered by Example Care Organization). These types of Locations are often not managed by any specific organization. This could also include generic locations such as "in-home".

Control0..*
TypeReference(Location)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. HealthcareService.serviceProvisionCode
Definition

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

ShortConditions under which service is available/offered
Comments

The provision means being commissioned by, contractually obliged or financially sourced. Types of costings that may apply to this healthcare service, such if the service may be available for free, some discounts available, or fees apply.

Control0..*
BindingThe codes SHOULD be taken from Service Provision Conditions Australian Concepts
(preferred to http://terminology.hl7.org.au/ValueSet/service-provision-conditions)
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. HealthcareService.eligibility
Definition

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

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

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

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

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

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

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

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

Coded value for the eligibility.

ShortCoded value for the eligibility
Control0..1
Binding

Coded values underwhich a specific service is made available.

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

Describes the eligibility conditions for the service.

ShortDescribes the eligibility conditions for the service
Comments

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

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

Programs that this service is applicable to.

ShortPrograms that this service is applicable to
Comments

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

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

Government or local programs that this service applies to.

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

Collection of characteristics (attributes).

ShortCollection of characteristics (attributes)
Comments

These could be such things as is wheelchair accessible.

Control0..*
Binding

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

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

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

ShortThe language that this service is offered in
Comments

When using this property it indicates that the service is available with this language, it is not derived from the practitioners, and not all are required to use this language, just that this language is available while scheduling.

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

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. HealthcareService.referralMethod
Definition

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

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

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

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

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

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

A collection of times that the Service Site is available.

ShortTimes the Service Site is available
Comments

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

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

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

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

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

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

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

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

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

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

The days of the week.

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

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

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

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

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

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

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

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

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

An Extension

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

    Australian time zone.

    ShortAU time zone
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Australian Time Zone) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    88. HealthcareService.availableTime.availableStartTime.value
    Definition

    The actual value

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

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

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

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

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

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

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

    An Extension

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

      Australian time zone.

      ShortAU time zone
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(Australian Time Zone) (Extension Type: CodeableConcept)
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      98. HealthcareService.availableTime.availableEndTime.value
      Definition

      The actual value

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

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

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

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

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

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      ShortAdditional content defined by implementations
      Comments

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

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

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

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

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

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

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

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

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

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

      ShortService not available from this date
      Control0..1
      TypePeriod
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      112. HealthcareService.availabilityExceptions
      Definition

      A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.

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

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

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