Health Connect Australia Provider Directory FHIR Implementation Guide

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

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.

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.

An Extension

Facilities or amenities available within, or in close proximity of, a location. Uses the NCTS Facility Amenity ValueSet (https://healthterminologies.gov.au/fhir/ValueSet/facility-amenity-1).

Alternate postal/mailing address for correspondence (PO Box or mailing address) that is distinct from the registered physical address.

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.

Unique code or number identifying the location to its users.

Organization label locations in registries, need to keep track of those.

Local Identifier for the Location attributed by Health Connect. Used for system reference and internal business logic.

Organization label locations in registries, need to keep track of those.

The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.

Indicates whether the location is still in use.

Name of the location as used by humans. Does not need to be unique.

If the name of a location changes, consider putting the old name in the alias column so that it can still be located through searches.

Other names or aliases by which this location is known, such as abbreviations, former names, or local names.

There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the location.

Over time locations and organizations go through many changes and can be known by different names.

For searching knowing previous names that the location was known by can be very useful.

Indicates whether the location is a fixed physical place, virtual location or a mobile service. Used to identify the type of location that meets their patient's needs.

The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.

The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.

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

Telecommunications form for 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.

Use of contact point.

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

The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.

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

Telecommunications form for 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.

Use of contact point.

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

Physical location.

This is primarily used for the physical address of the location. The Organization however uses the address property for administrative purposes.

If locations can be visited, we need to keep track of their address.

Physical form of the location, e.g. building, room, vehicle, road.

For purposes of showing relevant locations in queries, we need to categorize locations.

The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

For mobile applications and automated route-finding knowing the exact location of the Location is required.

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

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.

Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).

Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).

A reference to the organisation that holds a HPI-O and manages or is responsible for this location entry in the Provider Directory.

This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource.

Need to know who manages the location.

Another Location of which this Location is physically a part of.

For purposes of location, display and identification, knowing which locations are located within other locations is important.

Technical endpoints providing access to services operated for the location.

Organizations may have different systems at different locations that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.

Facilities or amenities available within, or in close proximity of, a location. Uses the NCTS Facility Amenity ValueSet (https://healthterminologies.gov.au/fhir/ValueSet/facility-amenity-1).

Alternate postal/mailing address for correspondence (PO Box or mailing address) that is distinct from the registered physical address.

Local Identifier for the Location attributed by Health Connect. Used for system reference and internal business logic.

Other names or aliases by which this location is known, such as abbreviations, former names, or local names.

Indicates whether the location is a fixed physical place, virtual location or a mobile service. Used to identify the type of location that meets their patient's needs.

A reference to the organisation that holds a HPI-O and manages or is responsible for this location entry in the Provider Directory.

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

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.

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.

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

A human language.

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.

An Extension

Facilities or amenities available within, or in close proximity of, a location. Uses the NCTS Facility Amenity ValueSet (https://healthterminologies.gov.au/fhir/ValueSet/facility-amenity-1).

Alternate postal/mailing address for correspondence (PO Box or mailing address) that is distinct from the registered physical address.

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.

Unique code or number identifying the location to its users.

Organization label locations in registries, need to keep track of those.

Local Identifier for the Location attributed by Health Connect. Used for system reference and internal business logic.

Organization label locations in registries, need to keep track of those.

The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.

Indicates whether the location is still in use.

The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.

The operational status if the location (where typically a bed/room).

Name of the location as used by humans. Does not need to be unique.

If the name of a location changes, consider putting the old name in the alias column so that it can still be located through searches.

Other names or aliases by which this location is known, such as abbreviations, former names, or local names.

There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the location.

Over time locations and organizations go through many changes and can be known by different names.

For searching knowing previous names that the location was known by can be very useful.

Description of the Location, which helps in finding or referencing the place.

Humans need additional information to verify a correct location has been identified.

Indicates whether a resource instance represents a specific location or a class of locations.

This is labeled as a modifier because whether or not the location is a class of locations changes how it can be used and understood.

Indicates whether a resource instance represents a specific location or a class of locations.

When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location.

Indicates whether the location is a fixed physical place, virtual location or a mobile service. Used to identify the type of location that meets their patient's needs.

The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.

The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.

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

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.

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.

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.

Use of contact point.

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

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.

The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.

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

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.

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.

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.

Use of contact point.

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

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.

Physical location.

This is primarily used for the physical address of the location. The Organization however uses the address property for administrative purposes.

If locations can be visited, we need to keep track of their address.

Physical form of the location, e.g. building, room, vehicle, road.

For purposes of showing relevant locations in queries, we need to categorize locations.

The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

For mobile applications and automated route-finding knowing the exact location of the Location is required.

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

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.

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

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.

Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).

Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).

Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).

A reference to the organisation that holds a HPI-O and manages or is responsible for this location entry in the Provider Directory.

This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource.

Need to know who manages the location.

Another Location of which this Location is physically a part of.

For purposes of location, display and identification, knowing which locations are located within other locations is important.

What days/times during a week is this location usually open.

This type of information is commonly found published in directories and on websites informing customers when the facility is available.

Specific services within the location may have their own hours which could be shorter (or longer) than the locations hours.

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

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.

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

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.

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

The days of the week.

The Location is open all day.

Time that the Location opens.

Time that the Location closes.

A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.

Technical endpoints providing access to services operated for the location.

Organizations may have different systems at different locations that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.