Name Flags Card. Type Description & Constraints HealthcareService C 0..* HealthcareService A service offered by a subscriber to which a publisher can publish their own service offerings inv-pca-1: providedBy shall be a relative reference to an Organization inv-pca-2: coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits id S 0..1 id Logical id of this artifact meta S 0..1 Meta Metadata about the resource versionId S 0..1 id Version specific identifier lastUpdated S 0..1 instant When the resource version last changed Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url pca-current-information-use-statement S 1..1 Reference(PCA Information Use Statement) Reference to the current Information Use Statement of this Partner Service URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-current-information-use-statement Slices for identifier S 0..* Identifier External identifiers for this item Slice: Unordered, Open by value:system identifier:pca-psi S 0..1 PcaPartnerServiceIdentifier PCA Partner Service Identifier (PCA-PSI) active S 1..1 boolean Whether this partner service is in active use providedBy S 1..1 Reference(PCA Organization) Organization that provides this partner service category S 1..1 CodeableConcept Broad category of service being performed or delivered Binding: PCA Partner Service Category (required): The type of the partner service. name S 1..1 string Description of service as presented to a consumer while searching comment S 0..1 string Additional description and/or any specific issues not covered elsewhere telecom S 0..* ContactPoint Website for this service description S 0..1 string Description of element or resource URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-description system 1..1 code phone | fax | email | pager | url | sms | other Fixed Value: url value 1..1 string The actual contact point details coverageArea S 0..* Reference(Location) Location(s) service is intended for/available to id 0..0 extension 0..0 reference 0..0 type 0..0 identifier 0..0 display 1..1 string Text alternative for the resource Example Brisbane area postcode: 40 Documentation for this format
This profile of HealthcareService defines a PCA Partner Service. A PCA Partner Service is a service offered by a PCA subscriber to which PCA publishers can publish their service offerings (i.e. Healthcare Service).
Copyright © 2023 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 by a subscriber to which a publisher can publish their own service offerings
A service offered by a subscriber to which a publisher can publish their own service offerings.
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
coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits
coverageArea.exists() implies coverageArea.all(display.value.matches('^[0-9]{1,4}$'))
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())
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.
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.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
When the resource last changed - e.g. when the version changed.
This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http://hl7.org/fhir/R4/http.html#read) interaction.
Identifies where the resource comes from
A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](http://hl7.org/fhir/R4/provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
Profiles this resource claims to conform to
A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/R4/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/R4/structuredefinition-definitions.html#StructureDefinition.url).
It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
Security Labels applied to this resource
Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Security Labels from the Healthcare Privacy and Security Classification System.
Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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.
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.
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.
Reference to the current Information Use Statement of this Partner Service
Reference to the current Information Use Statement of this Partner Service.
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
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).
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
PCA Partner Service Identifier (PCA-PSI)
The PCA Partner Service Identifier (PCA-PSI) issued by the PCA service to each Partner Service.
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]
Whether this partner service is in active use
This flag is used to indicate if the partner service is active and currently receiving published data from PCA.
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
Organization that provides this partner service
The organization that provides this partner service.
This reference to the partner service's participating organisation will always be populated by PCA.
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.
Type of service that may be delivered or performed
The specific type of service that may be delivered or performed.
Additional details about where the content was created (e.g. clinical specialty).
Specialties handled by the HealthcareService
Collection of specialties handled by the service site. This is more of a medical term.
A specialty that a healthcare service may provide.
Location(s) where service may be provided
The location(s) where this healthcare service may be 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.
If this is empty, then refer to the location's contacts.
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".
Literal reference, Relative, internal or absolute URL
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Type the reference refers to (e.g. "Patient")
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Aa resource (or, for logical models, the URI of the logical model).
Logical reference, when literal reference is not known
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Plain text narrative that identifies the resource in addition to the resource reference.
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Conditions under which service is available/offered
The code(s) that detail the conditions 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
Coded values underwhich a specific service is made available.
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.
The methods of referral can be used when referring to a specific HealthCareService resource.
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.
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.
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.
Service is not available (seasonally or for a public holiday) from this date.
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.