NHSD Implementation Guide - Outbound
4.0.1 - active

NHSD Implementation Guide - Outbound - Local Development build (v4.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: NHSDLocation - Detailed Descriptions

Draft as of 2023-09-14

Definitions for the nhsd-location resource profile.

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

0. Location
Definition

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

ShortAustralian location detailsDetails and position information for a physical place
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.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-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-6: A resource should have narrative for robust management (text.div.exists())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.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-6: A resource should have narrative for robust management (text.`div`.exists())
2. Location.id
Definition

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

ShortLogical FHIR id for unique identification of the location resource within the FHIR bundleLogical 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.

Control10..1
Typeidstring
Is Modifierfalse
Summarytrue
4. Location.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 on LocationMetadata about the resource
Control10..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Location.meta.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..01
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
8. Location.meta.extension
Definition

An Extension


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.

ShortExtensionAdditional 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..0*
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())
SlicingThis element introduces a set of slices on Location.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 10. Location.meta.versionId
    Definition

    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.

    ShortVersion specific identifier
    Comments

    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.

    Control0..01
    Typeid
    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()))
    12. Location.meta.lastUpdated
    Definition

    When the resource last changed - e.g. when the version changed.

    ShortThe time when the resource was last updatedWhen the resource version last changed
    Comments

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


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

    Control10..1
    Typeinstant
    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()))
    14. Location.meta.source
    Definition

    A uri that identifies the source system of the resource. This provides a minimal amount of Provenance 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.


    A uri that identifies the source system of the resource. This provides a minimal amount of Provenance 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.

    ShortIdentifies where the resource comes from
    Comments

    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.

    Control0..01
    Typeuri
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Location.meta.profile
    Definition

    A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.


    A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

    ShortProfiles this resource claims to conform to
    Comments

    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.

    Control0..0*
    Typecanonical(StructureDefinition)
    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()))
    18. Location.meta.security
    Definition

    Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

    ShortSecurity Labels applied to this resource
    Comments

    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.

    Control0..0*
    BindingUnless not suitable, these codes SHALL be taken from All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels
    (extensible to http://hl7.org/fhir/ValueSet/security-labels)

    Security Labels from the Healthcare Privacy and Security Classification System.

    TypeCoding
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. Location.meta.tag
    Definition

    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.

    ShortTags applied to this resource
    Comments

    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.

    Control0..0*
    BindingFor example codes, see CommonTagshttp://hl7.org/fhir/ValueSet/common-tags
    (example to http://hl7.org/fhir/ValueSet/common-tags)

    Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

    TypeCoding
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. Location.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..01
    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()))
    24. Location.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..01
    BindingThe codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages
    (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()))
    26. Location.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..01
    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()))
    28. Location.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..0*
    TypeResource
    Is Modifierfalse
    Summaryfalse
    Alternate Namesinline resources, anonymous resources, contained resources
    30. Location.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())
    32. Location.identifier
    Definition

    Unique code or number identifying the location to its users.

    ShortNHSD entry Location identifiersUnique code or number identifying the location to its users
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..*
    TypeIdentifier(Identifier, AU Location Specific Practice Number)
    Is Modifierfalse
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on Location.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ system
    • 34. Location.identifier:nataSite
      Slice NamenataSite
      Definition

      Identifier of a location associated with accreditation by National Association of Testing Authorities (NATA).


      Unique code or number identifying the location to its users.

      ShortNational Association of Testing Authorities (NATA) Site NumberUnique code or number identifying the location to its users
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..0*
      TypeIdentifier
      Is Modifierfalse
      Summarytrue
      Requirements

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

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      39. Location.identifier:rid
      Slice Namerid
      Definition

      NHSD Location Resource Identifier


      Unique code or number identifying the location to its users.

      ShortUnique code or number identifying the location to its users
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..1*
      TypeIdentifier(nhsd-resource-identifier)
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

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

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      41. Location.status
      Definition

      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.

      Shortactive | inactiveactive | suspended | inactive
      Control10..1
      BindingThe codes SHALL be taken from LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1
      (required to http://hl7.org/fhir/ValueSet/location-status|4.0.0)

      Indicates whether the location is still in use.

      Typecode
      Is Modifiertrue because This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      43. Location.operationalStatus
      Definition

      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.

      ShortThe operational status of the location (typically only for a bed/room)
      Control0..01
      BindingThe codes SHOULD be taken from hl7VS-bedStatushttp://terminology.hl7.org/ValueSet/v2-0116
      (preferred to http://terminology.hl7.org/ValueSet/v2-0116)

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

      TypeCoding
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      45. Location.name
      Definition

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

      ShortName of the locationName of the location as used by humans
      Comments

      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.

      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()))
      47. Location.alias
      Definition

      A list of alternate names that the location is known as, or was known as, in the past.

      ShortA list of alternate names that the location is known as, or was known as, in the past
      Comments

      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.

      Control0..0*
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Requirements

      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.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      49. Location.mode
      Definition

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

      Shortinstance | kind
      Comments

      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.

      Control0..1
      BindingThe codes SHALL be taken from LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1
      (required to http://hl7.org/fhir/ValueSet/location-mode|4.0.0)

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

      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      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.

      Fixed Valueinstance
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      51. Location.type
      Definition

      Indicates the type of function performed at the location.

      ShortType of role - NHSD defaults this to WORK for physical location. NHSD maps all MOBL locations as home visit location regardless of further granularity of a mobile location.Type of function performed
      Control0..*
      BindingUnless not suitable, these codes SHALL be taken from ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
      (extensible to http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType)

      Indicates the type of function performed at the location.

      TypeCodeableConcept
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      53. Location.telecom
      Definition

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

      ShortContact details of the location
      Control0..0*
      TypeContactPoint
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      55. Location.address
      Definition

      Physical location.

      ShortPhysical Address of the location where the Healthcare Service is providedPhysical location
      Comments

      Additional addresses should be recorded using another instance of the Location resource, or via the Organization.

      Control10..1
      TypeAddress(NHSD Address)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

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

      LabelLocation
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      57. Location.address.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..01
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      59. Location.address.extension
      Definition

      An Extension


      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.

      ShortExtensionAdditional 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..0*
      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())
      SlicingThis element introduces a set of slices on Location.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 61. Location.address.use
        Definition

        The purpose of this address.

        Shorthome | work | temp | old | billing - purpose of this address
        Comments

        Applications can assume that an address is current unless it explicitly says that it is temporary or old.

        Control0..01
        BindingThe codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1
        (required to http://hl7.org/fhir/ValueSet/address-use|4.0.0)

        The use of an address.

        Typecode
        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Allows an appropriate address to be chosen from a list of many.

        ExampleGeneral: home
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        63. Location.address.type
        Definition

        Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

        Shortpostal | physical | both
        Comments

        The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).


        The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

        Control0..01
        BindingThe codes SHALL be taken from AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1
        (required to http://hl7.org/fhir/ValueSet/address-type|4.0.0)

        The type of an address (physical / postal).

        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        ExampleGeneral: both
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        65. Location.address.text
        Definition

        Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

        ShortText representation of the address
        Comments

        Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

        Control0..01
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        A renderable, unencoded form.

        ExampleGeneral: 137 Nowhere Street, Erewhon 9132
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        67. Location.address.line
        Definition

        This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

        ShortStreet name, number, direction & P.O. Box etc.
        Control0..0*
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        ExampleGeneral: 137 Nowhere Street
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        69. Location.address.city
        Definition

        The name of the city, town, suburb, village or other community or delivery center.

        ShortName of city, town etc.
        Control0..01
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Alternate NamesMunicpality
        ExampleGeneral: Erewhon
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        71. Location.address.district
        Definition

        The name of the administrative area (county).

        ShortDistrict name (aka county)
        Comments

        District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

        Control0..01
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Alternate NamesCounty
        ExampleGeneral: Madison
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        73. Location.address.state
        Definition

        Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

        ShortSub-unit of country (abbreviations ok)
        Control0..01
        BindingThe codes SHALL be taken from For codes, see Australian States and Territories
        (required to http://hl7.org.au/fhir/pd/ValueSet/au-physical-states-territories)

        well known state representation

        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Alternate NamesProvince, Territory
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        75. Location.address.postalCode
        Definition

        A postal code designating a region defined by the postal service.

        ShortPostal code for area
        Control0..01
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Alternate NamesZip
        ExampleGeneral: 9132
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        77. Location.address.country
        Definition

        Country - a nation as commonly understood or generally accepted.

        ShortCountry (e.g. can be ISO 3166 2 or 3 letter code)
        Comments

        ISO 3166 3 letter codes can be used in place of a human readable country name.

        Control0..01
        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()))
        79. Location.address.period
        Definition

        Time period when address was/is in use.

        ShortTime period when address was/is in use
        Control0..01
        TypePeriod
        Is Modifierfalse
        Summarytrue
        Requirements

        Allows addresses to be placed in historical context.

        ExampleGeneral: { "start" : "2010-03-23T00:00:00+11:00", "end" : "2010-07-01T00:00:00+10:00" }
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        81. Location.physicalType
        Definition

        Provides context to the Location of the Services - noting if they are PHYSICAL, VIRTUAL (eg. Phone, Online) or HOME (eg. Delivery or Home Doctor) services. Within the context of a HealthcareService.coverageArea, the type is noted as an AREA.


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

        ShortLocation definition of the Service HOME / VIRTUAL / PHYSICALPhysical form of the location
        Control0..1
        BindingThe codes SHALL be taken from For example codes, see Location Typehttp://hl7.org/fhir/ValueSet/location-physical-type
        (required to http://fhir.nhsd.com.au/ValueSet/valueset-au-location-physicalType)
        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Requirements

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

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        83. Location.managingOrganization
        Definition

        The organization responsible for the provisioning and upkeep of the location, which also cover the Organisation that operates at the Location


        The organization responsible for the provisioning and upkeep of the location.

        ShortThis is a reference to service providing Organization (same as the organisation reference in the connected healthcare service resource)Organization responsible for provisioning and upkeep
        Comments

        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.

        Control0..1
        TypeReference(NHSD Organisation, Organization)
        Is Modifierfalse
        Summarytrue
        Requirements

        Need to know who manages the location.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        85. Location.partOf
        Definition

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

        ShortAnother Location this one is physically a part of
        Control0..01
        TypeReference(Location)
        Is Modifierfalse
        Summaryfalse
        Requirements

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

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        87. Location.hoursOfOperation
        Definition

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

        ShortWhat days/times during a week is this location usually open
        Comments

        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.

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

        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.

        ShortDescription of availability exceptions
        Control0..01
        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()))
        92. Location.endpoint
        Definition

        Technical endpoints providing access to services operated for the location.

        ShortTechnical endpoints providing access to services operated for the location
        Control0..0*
        TypeReference(Endpoint)
        Is Modifierfalse
        Summaryfalse
        Requirements

        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.

        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 foundhere

        0. Location
        ShortAustralian location details
        2. Location.id
        ShortLogical FHIR id for unique identification of the location resource within the FHIR bundle
        Control1..?
        4. Location.meta
        ShortMetadata on Location
        Control1..?
        6. Location.meta.id
        Control0..0
        8. Location.meta.extension
        Control0..0
        10. Location.meta.versionId
        Control0..0
        12. Location.meta.lastUpdated
        ShortThe time when the resource was last updated
        Control1..?
        14. Location.meta.source
        Control0..0
        16. Location.meta.profile
        Control0..0
        18. Location.meta.security
        Control0..0
        20. Location.meta.tag
        Control0..0
        22. Location.implicitRules
        Control0..0
        24. Location.language
        Control0..0
        26. Location.text
        Control0..0
        28. Location.contained
        Control0..0
        30. Location.identifier
        ShortNHSD entry Location identifiers
        NoteThis is a business identifier, not a resource identifier (see discussion)
        TypeIdentifier(Identifier, AU Location Specific Practice Number)
        SlicingThis element introduces a set of slices on Location.identifier. The slices areUnordered and Open, and defines no disciminators to differentiate the slices
        32. Location.identifier:nataSite
        Slice NamenataSite
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..0
        34. Location.identifier:rid
        Slice Namerid
        Definition

        NHSD Location Resource Identifier

        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..1
        TypeIdentifier(nhsd-resource-identifier)
        Is Modifierfalse
        Must Supporttrue
        36. Location.status
        Shortactive | inactive
        Control1..?
        38. Location.operationalStatus
        Control0..0
        40. Location.name
        ShortName of the location
        42. Location.alias
        Control0..0
        44. Location.mode
        Fixed Valueinstance
        46. Location.type
        ShortType of role - NHSD defaults this to WORK for physical location. NHSD maps all MOBL locations as home visit location regardless of further granularity of a mobile location.
        48. Location.telecom
        Control0..0
        50. Location.address
        ShortPhysical Address of the location where the Healthcare Service is provided
        TypeAddress(NHSD Address)
        LabelLocation
        52. Location.address.id
        Control0..0
        54. Location.address.extension
        Control0..0
        56. Location.address.use
        Control0..0
        58. Location.address.type
        Control0..0
        60. Location.address.text
        Control0..0
        62. Location.address.line
        Control0..0
        64. Location.address.city
        Control0..0
        66. Location.address.district
        Control0..0
        68. Location.address.state
        Control0..0
        70. Location.address.postalCode
        Control0..0
        72. Location.address.country
        Control0..0
        74. Location.address.period
        Control0..0
        76. Location.physicalType
        Definition

        Provides context to the Location of the Services - noting if they are PHYSICAL, VIRTUAL (eg. Phone, Online) or HOME (eg. Delivery or Home Doctor) services. Within the context of a HealthcareService.coverageArea, the type is noted as an AREA.

        ShortLocation definition of the Service HOME / VIRTUAL / PHYSICAL
        BindingThe codes SHALL be taken from Location Type
        (required to http://fhir.nhsd.com.au/ValueSet/valueset-au-location-physicalType)
        78. Location.position
        80. Location.position.id
        Control0..0
        82. Location.position.extension
        Control0..0
        84. Location.position.modifierExtension
        Control0..0
        86. Location.position.altitude
        Control0..0
        88. Location.managingOrganization
        Definition

        The organization responsible for the provisioning and upkeep of the location, which also cover the Organisation that operates at the Location

        ShortThis is a reference to service providing Organization (same as the organisation reference in the connected healthcare service resource)
        TypeReference(NHSD Organisation)
        90. Location.partOf
        Control0..0
        92. Location.hoursOfOperation
        Control0..0
        94. Location.availabilityExceptions
        Control0..0
        96. Location.endpoint
        Control0..0

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

        0. Location
        Definition

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

        ShortAustralian location details
        Control0..*
        Is Modifierfalse
        Summaryfalse
        Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.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-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-6: A resource should have narrative for robust management (text.div.exists())
        dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
        2. Location.id
        Definition

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

        ShortLogical FHIR id for unique identification of the location resource within the FHIR bundle
        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.

        Control1..1
        Typeid
        Is Modifierfalse
        Summarytrue
        4. Location.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 on Location
        Control1..1
        TypeMeta
        Is Modifierfalse
        Summarytrue
        6. Location.meta.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..0
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        8. Location.meta.extension
        Definition

        An Extension

        ShortExtension
        Control0..0
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        SlicingThis element introduces a set of slices on Location.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 10. Location.meta.versionId
          Definition

          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.

          ShortVersion specific identifier
          Comments

          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.

          Control0..0
          Typeid
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          12. Location.meta.lastUpdated
          Definition

          When the resource last changed - e.g. when the version changed.

          ShortThe time when the resource was last updated
          Comments

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

          Control1..1
          Typeinstant
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          14. Location.meta.source
          Definition

          A uri that identifies the source system of the resource. This provides a minimal amount of Provenance 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.

          ShortIdentifies where the resource comes from
          Comments

          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.

          Control0..0
          Typeuri
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          16. Location.meta.profile
          Definition

          A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

          ShortProfiles this resource claims to conform to
          Comments

          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.

          Control0..0
          Typecanonical(StructureDefinition)
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          18. Location.meta.security
          Definition

          Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

          ShortSecurity Labels applied to this resource
          Comments

          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.

          Control0..0
          BindingUnless not suitable, these codes SHALL be taken from All Security Labels
          (extensible to http://hl7.org/fhir/ValueSet/security-labels)

          Security Labels from the Healthcare Privacy and Security Classification System.

          TypeCoding
          Is Modifierfalse
          Summarytrue
          20. Location.meta.tag
          Definition

          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.

          ShortTags applied to this resource
          Comments

          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.

          Control0..0
          BindingFor example codes, see CommonTags
          (example to http://hl7.org/fhir/ValueSet/common-tags)

          Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

          TypeCoding
          Is Modifierfalse
          Summarytrue
          22. Location.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..0
          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
          24. Location.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..0
          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
          26. Location.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..0
          TypeNarrative
          Is Modifierfalse
          Summaryfalse
          Alternate Namesnarrative, html, xhtml, display
          28. Location.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..0
          TypeResource
          Is Modifierfalse
          Summaryfalse
          Alternate Namesinline resources, anonymous resources, contained resources
          30. Location.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
          32. Location.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
          34. Location.identifier
          Definition

          Unique code or number identifying the location to its users.

          ShortNHSD entry Location identifiers
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..*
          TypeIdentifier(Identifier, AU Location Specific Practice Number)
          Is Modifierfalse
          Summarytrue
          Requirements

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

          SlicingThis element introduces a set of slices on Location.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ system
          • 36. Location.identifier:nataSite
            Slice NamenataSite
            Definition

            Identifier of a location associated with accreditation by National Association of Testing Authorities (NATA).

            ShortNational Association of Testing Authorities (NATA) Site Number
            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control0..0
            TypeIdentifier
            Is Modifierfalse
            Summarytrue
            Requirements

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

            50. Location.identifier:rid
            Slice Namerid
            Definition

            NHSD Location Resource Identifier

            ShortUnique code or number identifying the location to its users
            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control0..1
            TypeIdentifier(nhsd-resource-identifier)
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Requirements

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

            52. Location.status
            Definition

            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.

            Shortactive | inactive
            Control1..1
            BindingThe codes SHALL be taken from LocationStatus
            (required to http://hl7.org/fhir/ValueSet/location-status|4.0.0)

            Indicates whether the location is still in use.

            Typecode
            Is Modifiertrue because This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            54. Location.operationalStatus
            Definition

            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.

            ShortThe operational status of the location (typically only for a bed/room)
            Control0..0
            BindingThe codes SHOULD be taken from hl7VS-bedStatus
            (preferred to http://terminology.hl7.org/ValueSet/v2-0116)

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

            TypeCoding
            Is Modifierfalse
            Summarytrue
            56. Location.name
            Definition

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

            ShortName of the location
            Comments

            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.

            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            58. Location.alias
            Definition

            A list of alternate names that the location is known as, or was known as, in the past.

            ShortA list of alternate names that the location is known as, or was known as, in the past
            Comments

            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.

            Control0..0
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Requirements

            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.

            60. Location.description
            Definition

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

            ShortAdditional details about the location that could be displayed as further information to identify the location beyond its name
            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

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

            62. Location.mode
            Definition

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

            Shortinstance | kind
            Comments

            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.

            Control0..1
            BindingThe codes SHALL be taken from LocationMode
            (required to http://hl7.org/fhir/ValueSet/location-mode|4.0.0)

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

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            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.

            Fixed Valueinstance
            64. Location.type
            Definition

            Indicates the type of function performed at the location.

            ShortType of role - NHSD defaults this to WORK for physical location. NHSD maps all MOBL locations as home visit location regardless of further granularity of a mobile location.
            Control0..*
            BindingUnless not suitable, these codes SHALL be taken from ServiceDeliveryLocationRoleType
            (extensible to http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType)

            Indicates the type of function performed at the location.

            TypeCodeableConcept
            Is Modifierfalse
            Summarytrue
            66. Location.telecom
            Definition

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

            ShortContact details of the location
            Control0..0
            TypeContactPoint
            Is Modifierfalse
            Summaryfalse
            68. Location.address
            Definition

            Physical location.

            ShortPhysical Address of the location where the Healthcare Service is provided
            Comments

            Additional addresses should be recorded using another instance of the Location resource, or via the Organization.

            Control1..1
            TypeAddress(NHSD Address)
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Requirements

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

            LabelLocation
            70. Location.address.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..0
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            72. Location.address.extension
            Definition

            An Extension

            ShortExtension
            Control0..0
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            SlicingThis element introduces a set of slices on Location.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 74. Location.address.use
              Definition

              The purpose of this address.

              Shorthome | work | temp | old | billing - purpose of this address
              Comments

              Applications can assume that an address is current unless it explicitly says that it is temporary or old.

              Control0..0
              BindingThe codes SHALL be taken from AddressUse
              (required to http://hl7.org/fhir/ValueSet/address-use|4.0.0)

              The use of an address.

              Typecode
              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Allows an appropriate address to be chosen from a list of many.

              ExampleGeneral: home
              76. Location.address.type
              Definition

              Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

              Shortpostal | physical | both
              Comments

              The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

              Control0..0
              BindingThe codes SHALL be taken from AddressType
              (required to http://hl7.org/fhir/ValueSet/address-type|4.0.0)

              The type of an address (physical / postal).

              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              ExampleGeneral: both
              78. Location.address.text
              Definition

              Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

              ShortText representation of the address
              Comments

              Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

              Control0..0
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              A renderable, unencoded form.

              ExampleGeneral: 137 Nowhere Street, Erewhon 9132
              80. Location.address.line
              Definition

              This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

              ShortStreet name, number, direction & P.O. Box etc.
              Control0..0
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              ExampleGeneral: 137 Nowhere Street
              82. Location.address.city
              Definition

              The name of the city, town, suburb, village or other community or delivery center.

              ShortName of city, town etc.
              Control0..0
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Alternate NamesMunicpality
              ExampleGeneral: Erewhon
              84. Location.address.district
              Definition

              The name of the administrative area (county).

              ShortDistrict name (aka county)
              Comments

              District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

              Control0..0
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Alternate NamesCounty
              ExampleGeneral: Madison
              86. Location.address.state
              Definition

              Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

              ShortSub-unit of country (abbreviations ok)
              Control0..0
              BindingThe codes SHALL be taken from Australian States and Territories
              (required to http://hl7.org.au/fhir/pd/ValueSet/au-physical-states-territories)

              well known state representation

              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Alternate NamesProvince, Territory
              88. Location.address.postalCode
              Definition

              A postal code designating a region defined by the postal service.

              ShortPostal code for area
              Control0..0
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Alternate NamesZip
              ExampleGeneral: 9132
              90. Location.address.country
              Definition

              Country - a nation as commonly understood or generally accepted.

              ShortCountry (e.g. can be ISO 3166 2 or 3 letter code)
              Comments

              ISO 3166 3 letter codes can be used in place of a human readable country name.

              Control0..0
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              92. Location.address.period
              Definition

              Time period when address was/is in use.

              ShortTime period when address was/is in use
              Control0..0
              TypePeriod
              Is Modifierfalse
              Summarytrue
              Requirements

              Allows addresses to be placed in historical context.

              ExampleGeneral: { "start" : "2010-03-23T00:00:00+11:00", "end" : "2010-07-01T00:00:00+10:00" }
              94. Location.physicalType
              Definition

              Provides context to the Location of the Services - noting if they are PHYSICAL, VIRTUAL (eg. Phone, Online) or HOME (eg. Delivery or Home Doctor) services. Within the context of a HealthcareService.coverageArea, the type is noted as an AREA.

              ShortLocation definition of the Service HOME / VIRTUAL / PHYSICAL
              Control0..1
              BindingThe codes SHALL be taken from Location Type
              (required to http://fhir.nhsd.com.au/ValueSet/valueset-au-location-physicalType)
              TypeCodeableConcept
              Is Modifierfalse
              Summarytrue
              Requirements

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

              96. Location.position
              Definition

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

              ShortThe absolute geographic location
              Control0..1
              TypeBackboneElement
              Is Modifierfalse
              Summaryfalse
              Requirements

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

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              98. Location.position.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..0
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              100. Location.position.extension
              Definition

              An Extension

              ShortExtension
              Control0..0
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              102. Location.position.modifierExtension
              Definition

              An Extension

              ShortExtension
              Control0..0
              TypeExtension
              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
              Summarytrue
              104. Location.position.longitude
              Definition

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

              ShortLongitude with WGS84 datum
              Control1..1
              Typedecimal
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              106. Location.position.latitude
              Definition

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

              ShortLatitude with WGS84 datum
              Control1..1
              Typedecimal
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              108. Location.position.altitude
              Definition

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

              ShortAltitude with WGS84 datum
              Control0..0
              Typedecimal
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              110. Location.managingOrganization
              Definition

              The organization responsible for the provisioning and upkeep of the location, which also cover the Organisation that operates at the Location

              ShortThis is a reference to service providing Organization (same as the organisation reference in the connected healthcare service resource)
              Comments

              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.

              Control0..1
              TypeReference(NHSD Organisation)
              Is Modifierfalse
              Summarytrue
              Requirements

              Need to know who manages the location.

              112. Location.partOf
              Definition

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

              ShortAnother Location this one is physically a part of
              Control0..0
              TypeReference(Location)
              Is Modifierfalse
              Summaryfalse
              Requirements

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

              114. Location.hoursOfOperation
              Definition

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

              ShortWhat days/times during a week is this location usually open
              Comments

              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.

              Control0..0
              TypeBackboneElement
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              123. Location.availabilityExceptions
              Definition

              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.

              ShortDescription of availability exceptions
              Control0..0
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              125. Location.endpoint
              Definition

              Technical endpoints providing access to services operated for the location.

              ShortTechnical endpoints providing access to services operated for the location
              Control0..0
              TypeReference(Endpoint)
              Is Modifierfalse
              Summaryfalse
              Requirements

              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.