Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> HealthcareService C 0..* AUBaseHealthcareService A service offered by a publisher inv-pca-1: telecom use shall not be 'home' inv-pca-2: providedBy shall be a relative reference to an Organization inv-pca-3: location shall be a relative reference to a Location inv-pca-4: If eligibility contains 'coverage-restrictedResidents', then coverageArea shall be present inv-pca-5: exactly one type shall be preferred inv-pca-6: If present, au-timezone shall be the same as all other au-timezone codes that are present within all availableTime elements 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 contained S 0..* PcaServiceCoverageArea Contained inline pca-service-coverage-area resource Slices for extension Content/Rules for all slices pca-postal-address S 0..1 AustralianAddress Postal address URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address pca-referral-information-for-consumer S 0..1 markdown Referral instructions and information for consumers URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-consumer pca-referral-information-for-provider S 0..1 markdown Referral instructions and information for providers URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-provider pca-new-patient-availability S 1..1 CodeableConcept Whether the service is accepting new patients URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-new-patient-availability Binding: PCA New Patient Availability (required) pca-active-period S 0..1 Period Period when the healthcare service is active URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-active-period pca-bank-account S 0..* (Complex) Bank account details URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account pca-iar-levels-of-care S 0..* CodeableConcept Levels of care that the service provides URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-iar-levels-of-care Binding: PCA IAR Levels of Care (required) Slices for identifier S 1..* Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier External identifiers for this item Slice: Unordered, Open by value:system identifier:pca-hsi S 0..1 PcaHealthcareServiceIdentifier PCA Healthcare Service Identifier (PCA-HSI) issued by the PCA service active S 1..1 boolean Whether this HealthcareService record is in active use providedBy S 1..1 Reference(PCA Organization) Organization that provides this service type S 1..* CodeableConcept Type of service that may be delivered or performed Binding: PCA Healthcare Service Type (required) Slices for extension Content/Rules for all slices preferred S 0..1 boolean Whether this is the primary service type for this HealthcareService URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred location S 1..1 Reference(PCA Location) Location where service is provided name S 1..1 string Description of service as presented to a consumer while searching telecom S 0..* ContactPoint Contacts related to the healthcare service Slices for extension Content/Rules for all slices contactPurpose S 0..* CodeableConcept Contact purpose URL: http://hl7.org.au/fhir/StructureDefinition/contact-purpose Binding: Contact Purpose (extensible) coverageArea S 0..* Reference(PCA Service Coverage Area) {c} Location(s) service is intended for/available to serviceProvisionCode S 1..1 CodeableConcept Condition under which this service is available/offered Binding: PCA Service Provision Code (required) eligibility S 0..* BackboneElement Specific eligibility requirements required to use the service code S 1..1 CodeableConcept Coded value for the eligibility Binding: PCA Eligibility (required) communication S 0..* CodeableConcept The language that this service is offered in Binding: PCA Common Languages in Australia (required) referralMethod S 0..* CodeableConcept Ways that the service accepts referrals Binding: PCA Referral Method (required) appointmentRequired S 0..1 boolean If an appointment is required for access to this service availableTime SC 0..* BackboneElement Times the Service Site is available inv-pca-8: If an availableTime uses the availableTimeApplicability extension, then daysOfWeek shall not be present inv-pca-9: If an availableTime does not use the availableTimeApplicability extension, then daysOfWeek shall be present Slices for modifierExtension Content/Rules for all slices modifierExtension:availableTimeApplicability S 0..1 PcaAvailableTimeApplicability Indicates the period and reason that this instance of availableTime applies daysOfWeek S 0..* code mon | tue | wed | thu | fri | sat | sun allDay S 0..1 boolean Always available? e.g. 24 hour service availableStartTime S 0..1 time Opening time of day (ignored if allDay = true) Slices for extension Content/Rules for all slices extension:timeZone S 0..1 AustralianTimeZone AU time zone availableEndTime S 0..1 time Closing time of day (ignored if allDay = true) Slices for extension Content/Rules for all slices extension:timeZone S 0..1 AustralianTimeZone AU time zone notAvailable S 0..* BackboneElement Not available during this time due to provided reason description S 1..1 string Reason presented to the user explaining why time not available during S 0..1 Period Date range that the service is not available - can be open-ended if service is closing <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
This profile of HealthcareService defines a PCA Healthcare Service. A PCA Healthcare Service is a service offered at a location by a PCA publisher.
Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.
A service offered at a location by a publisher.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
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()
not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
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()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
providedBy shall be a relative reference to an Organization
location shall be a relative reference to a Location
If eligibility contains 'coverage-restrictedResidents', then coverageArea shall be present
eligibility.where(code.coding.code='coverage-restrictedResidents').exists() implies coverageArea.exists()
type.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-preferred' and value=true).count()=1
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)
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())
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
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.
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.
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
The base language in which the resource is written.
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).
Text summary of the resource, for human interpretation
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.
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.
Contained inline pca-service-coverage-area resource
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
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.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
Referral instructions and information for consumers
Referral instructions and information for consumers of a healthcare service.
Referral instructions and information for providers
Instructions and information for providers referring consumers to a healthcare service.
Whether the service is accepting new patients
Whether the service is accepting new patients.
Period when the healthcare service is active
Period when the healthcare service is active.
Bank account details for the healthcare servcie or practitioner role record.
Levels of care that the service provides
The levels of care that the service provides.
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).
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.
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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
CX / EI (occasionally, more often EI maps to a resource id or a URL)
II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
PCA Healthcare Service Identifier (PCA-HSI) issued by the PCA service
The PCA Healthcare Service Identifier (PCA-HSI) issued by the PCA service to each Healthcare Service.
Whether this HealthcareService record is in active use
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.
This element is labeled as a modifier because it may be used to mark that the resource was created in error.
This resource is generally assumed to be active if no value is provided for the active element
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
The organization that provides this healthcare service.
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.
Broad category of service being performed or delivered
Identifies the broad category of service being performed or delivered.
Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.
A category of the service(s) that could be provided.
Type of service that may be delivered or performed
The specific type of service that may be delivered or performed.
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
Additional content defined by implementations
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.
Whether this is the primary service type for this HealthcareService
Whether this is the primary service type for this HealthcareService.
A reference to a code defined by a terminology system.
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.
Allows for alternative encodings within a code system, and translations to other code systems.
fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Plain text representation of the concept
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.
Very often the text is the same as a displayName of one of the codings.
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.
C*E.9. But note many systems use C*E.2 for this
fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Specialties handled by the HealthcareService
Collection of specialties handled by the service site. This is more of a medical term.
The location where this healthcare service is provided.
Description of service as presented to a consumer while searching
Further description of the service as it would be presented to a consumer while searching.
Additional description and/or any specific issues not covered elsewhere
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.
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.
Extra details about the service that can't be placed in the other fields
Extra details about the service that can't be placed in the other fields.
Facilitates quick identification of the service
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.
Contacts related to the healthcare service
List of contacts related to this specific healthcare service.
If this is empty, then refer to the location's contacts.
Indicates a purpose for which the contact can be reached.
phone | fax | email | pager | url | sms | other
Telecommunications form for contact point - what communications system is required to make use of the contact.
Telecommunications form for contact point.
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Need to support legacy numbers that are not in a tightly controlled format.
home | work | temp | old | mobile - purpose of this contact point
Identifies the purpose for the contact point.
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
Specify preferred order of use (1 = highest)
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.
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Time period when the contact point was/is in use
Time period when the contact point was/is in use.
Location(s) service is intended for/available to
The location(s) that this service is available to (not where the service is provided).
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".
Condition under which this service is available/offered
The code that details the condition under which the healthcare service is available/offered.
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.
Specific eligibility requirements required to use the service
Does this service have specific eligibility requirements that need to be met in order to use the service?
Extensions that cannot be ignored even if unrecognized
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).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Describes the eligibility conditions for the service
Describes the eligibility conditions for the service.
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.
Programs that this service is applicable to
Programs that this service is applicable to.
Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….
Government or local programs that this service applies to.
Collection of characteristics (attributes)
Collection of characteristics (attributes).
These could be such things as is wheelchair accessible.
A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
The language that this service is offered in
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.
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.
Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.
If an appointment is required for access to this service
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.
A collection of times that the Service Site is available.
More detailed availability information may be provided in associated Schedule/Slot resources.
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())
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())
Indicates the period and reason that this instance of availableTime applies
Used to indicate a change in the pattern of availability during a particular period and the reason for the change.
This extension limits the period during which HealthcareService.availableTime applies.
Indicates which days of the week are available between the start and end Times.
Is this always available? (hence times are irrelevant) e.g. 24 hour service.
Opening time of day (ignored if allDay = true)
The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
The time zone is expected to be for where this HealthcareService is provided at.
unique id for the element within a resource (for internal references)
Closing time of day (ignored if allDay = true)
The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
Not available during this time due to provided reason
The HealthcareService is not available during this period of time due to the provided reason.
Reason presented to the user explaining why time not available
The reason that can be presented to the user as to why this time is not available.
Date range that the service is not available - can be open-ended if service is closing
Date range that the service is not available - can be open-ended if service is closing.
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.
Technical endpoints providing access to electronic services operated for the healthcare service
Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.