AU Core Implementation Guide
2.0.0-ci-build - CI Build Australia flag

AU Core Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-core/ and changes regularly. See the Directory of published versions

Resource Profile: AU Core Location

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-location Version: 2.0.0-ci-build
Standards status: Trial-use Maturity Level: 2 Computable Name: AUCoreLocation

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for a Location resource to record, search, and fetch information about a location. It is based on the AU Base Location profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Location when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.

Usage Scenarios

The following are supported usage scenarios for this profile:

  • Record or update basic information for a location
  • Read information about a location referenced by another resource

Profile Specific Implementation Guidance

  • See guidance on the construction of an identifier on the relevant Identifier profile page and the section on Business Identifiers in AU Base.
  • See the AU Base Location profile for guidance on using a Location resource as part of defining a type of mobile or remotely delivered service.
  • When constructing an address
    • an international address can be represented using the core Address data type
    • an Australian address SHOULD be represented using the Australian Address data type profile

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 1.0.0:

  • The resource metadata has changed (description)
  • Formal Views of Profile Content

    Description of Profiles, Differentials, Snapshots and how the different presentations work.

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Location C 0..* AUBaseLocation A location in an Australian healthcare context
    Constraints: au-core-loc-01
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... identifier ΣC 0..* Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber Unique code or number identifying the location to its users
    ... name SOΣ 0..1 string Name of the location as used by humans
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... type SOΣC 0..* CodeableConcept Type of function performed
    Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... address SOC 0..1 Address, AustralianAddress Physical location
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... physicalType SOΣ 0..1 CodeableConcept Physical form of the location
    Binding: Location Type (Physical) - AU Extended (preferred)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... managingOrganization SOΣ 0..1 Reference(AU Core Organization) Organization responsible for provisioning and upkeep
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
    Location.type Base extensible ServiceDeliveryLocationRoleType - AU Extended 📦6.0.0-ci-build AU Base Implementation Guide vnull
    Location.physicalType Base preferred Location Type (Physical) - AU Extended 📦6.0.0-ci-build AU Base Implementation Guide vnull

    Constraints

    Id Grade Path(s) Description Expression
    au-core-loc-01 error Location The location shall at least have a valid identifier or address or type address.exists() or type.exists() or identifier.where(system.count() + value.count() >1).exists()
    dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error Location If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4 error Location If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5 error Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice Location A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    This structure is derived from AUBaseLocation

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Location C 0..* AUBaseLocation A location in an Australian healthcare context
    Constraints: au-core-loc-01
    ... identifier C 0..* Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber Unique code or number identifying the location to its users
    ... name SO 0..1 string Name of the location as used by humans
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... type SOC 0..* CodeableConcept Type of function performed
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... physicalType SO 0..1 CodeableConcept Physical form of the location
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... managingOrganization SO 0..1 Reference(AU Core Organization) Organization responsible for provisioning and upkeep
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    doco Documentation for this format

    Constraints

    Id Grade Path(s) Description Expression
    au-core-loc-01 error Location The location shall at least have a valid identifier or address or type address.exists() or type.exists() or identifier.where(system.count() + value.count() >1).exists()
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Location C 0..* AUBaseLocation A location in an Australian healthcare context
    Constraints: au-core-loc-01
    ... id Σ 0..1 id Logical id of this artifact
    ... meta Σ 0..1 Meta Metadata about the resource
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    ... contained 0..* Resource Contained, inline Resources
    ... extension 0..* Extension Additional content defined by implementations
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... identifier ΣC 0..* Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber Unique code or number identifying the location to its users
    ... status ?!Σ 0..1 code active | suspended | inactive
    Binding: LocationStatus (required): Indicates whether the location is still in use.
    ... operationalStatus Σ 0..1 Coding The operational status of the location (typically only for a bed/room)
    Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).
    ... name SOΣ 0..1 string Name of the location as used by humans
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... alias 0..* string A list of alternate names that the location is known as, or was known as, in the past
    ... description Σ 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
    ... mode Σ 0..1 code instance | kind
    Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
    ... type SOΣC 0..* CodeableConcept Type of function performed
    Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... telecom 0..* ContactPoint Contact details of the location
    ... address SOC 0..1 Address, AustralianAddress Physical location
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... physicalType SOΣ 0..1 CodeableConcept Physical form of the location
    Binding: Location Type (Physical) - AU Extended (preferred)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... position 0..1 BackboneElement The absolute geographic location
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... longitude 1..1 decimal Longitude with WGS84 datum
    .... latitude 1..1 decimal Latitude with WGS84 datum
    .... altitude 0..1 decimal Altitude with WGS84 datum
    ... managingOrganization SOΣ 0..1 Reference(AU Core Organization) Organization responsible for provisioning and upkeep
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... partOf 0..1 Reference(Location) Another Location this one is physically a part of
    ... hoursOfOperation 0..* BackboneElement What days/times during a week is this location usually open
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
    Binding: DaysOfWeek (required): The days of the week.
    .... allDay 0..1 boolean The Location is open all day
    .... openingTime 0..1 time Time that the Location opens
    .... closingTime 0..1 time Time that the Location closes
    ... availabilityExceptions 0..1 string Description of availability exceptions
    ... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Location.language Base preferred Common Languages 📦4.0.1 FHIR Std.
    Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
    Location.operationalStatus Base preferred hl7VS-bedStatus 📦2.0.0 THO v6.5
    Location.mode Base required LocationMode 📍4.0.1 FHIR Std.
    Location.type Base extensible ServiceDeliveryLocationRoleType - AU Extended 📦6.0.0-ci-build AU Base Implementation Guide vnull
    Location.physicalType Base preferred Location Type (Physical) - AU Extended 📦6.0.0-ci-build AU Base Implementation Guide vnull
    Location.hoursOfOperation.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    au-core-loc-01 error Location The location shall at least have a valid identifier or address or type address.exists() or type.exists() or identifier.where(system.count() + value.count() >1).exists()
    dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error Location If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4 error Location If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5 error Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice Location A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    This structure is derived from AUBaseLocation

    Summary

    Must-Support: 5 elements

    Structures

    This structure refers to these other structures:

    Maturity: 2

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Location C 0..* AUBaseLocation A location in an Australian healthcare context
    Constraints: au-core-loc-01
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... identifier ΣC 0..* Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber Unique code or number identifying the location to its users
    ... name SOΣ 0..1 string Name of the location as used by humans
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... type SOΣC 0..* CodeableConcept Type of function performed
    Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... address SOC 0..1 Address, AustralianAddress Physical location
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... physicalType SOΣ 0..1 CodeableConcept Physical form of the location
    Binding: Location Type (Physical) - AU Extended (preferred)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... managingOrganization SOΣ 0..1 Reference(AU Core Organization) Organization responsible for provisioning and upkeep
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
    Location.type Base extensible ServiceDeliveryLocationRoleType - AU Extended 📦6.0.0-ci-build AU Base Implementation Guide vnull
    Location.physicalType Base preferred Location Type (Physical) - AU Extended 📦6.0.0-ci-build AU Base Implementation Guide vnull

    Constraints

    Id Grade Path(s) Description Expression
    au-core-loc-01 error Location The location shall at least have a valid identifier or address or type address.exists() or type.exists() or identifier.where(system.count() + value.count() >1).exists()
    dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error Location If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4 error Location If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5 error Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice Location A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    Differential View

    This structure is derived from AUBaseLocation

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Location C 0..* AUBaseLocation A location in an Australian healthcare context
    Constraints: au-core-loc-01
    ... identifier C 0..* Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber Unique code or number identifying the location to its users
    ... name SO 0..1 string Name of the location as used by humans
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... type SOC 0..* CodeableConcept Type of function performed
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... physicalType SO 0..1 CodeableConcept Physical form of the location
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... managingOrganization SO 0..1 Reference(AU Core Organization) Organization responsible for provisioning and upkeep
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    doco Documentation for this format

    Constraints

    Id Grade Path(s) Description Expression
    au-core-loc-01 error Location The location shall at least have a valid identifier or address or type address.exists() or type.exists() or identifier.where(system.count() + value.count() >1).exists()

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Location C 0..* AUBaseLocation A location in an Australian healthcare context
    Constraints: au-core-loc-01
    ... id Σ 0..1 id Logical id of this artifact
    ... meta Σ 0..1 Meta Metadata about the resource
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    ... contained 0..* Resource Contained, inline Resources
    ... extension 0..* Extension Additional content defined by implementations
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... identifier ΣC 0..* Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber Unique code or number identifying the location to its users
    ... status ?!Σ 0..1 code active | suspended | inactive
    Binding: LocationStatus (required): Indicates whether the location is still in use.
    ... operationalStatus Σ 0..1 Coding The operational status of the location (typically only for a bed/room)
    Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).
    ... name SOΣ 0..1 string Name of the location as used by humans
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... alias 0..* string A list of alternate names that the location is known as, or was known as, in the past
    ... description Σ 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
    ... mode Σ 0..1 code instance | kind
    Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
    ... type SOΣC 0..* CodeableConcept Type of function performed
    Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... telecom 0..* ContactPoint Contact details of the location
    ... address SOC 0..1 Address, AustralianAddress Physical location
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... physicalType SOΣ 0..1 CodeableConcept Physical form of the location
    Binding: Location Type (Physical) - AU Extended (preferred)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... position 0..1 BackboneElement The absolute geographic location
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... longitude 1..1 decimal Longitude with WGS84 datum
    .... latitude 1..1 decimal Latitude with WGS84 datum
    .... altitude 0..1 decimal Altitude with WGS84 datum
    ... managingOrganization SOΣ 0..1 Reference(AU Core Organization) Organization responsible for provisioning and upkeep
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... partOf 0..1 Reference(Location) Another Location this one is physically a part of
    ... hoursOfOperation 0..* BackboneElement What days/times during a week is this location usually open
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
    Binding: DaysOfWeek (required): The days of the week.
    .... allDay 0..1 boolean The Location is open all day
    .... openingTime 0..1 time Time that the Location opens
    .... closingTime 0..1 time Time that the Location closes
    ... availabilityExceptions 0..1 string Description of availability exceptions
    ... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Location.language Base preferred Common Languages 📦4.0.1 FHIR Std.
    Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
    Location.operationalStatus Base preferred hl7VS-bedStatus 📦2.0.0 THO v6.5
    Location.mode Base required LocationMode 📍4.0.1 FHIR Std.
    Location.type Base extensible ServiceDeliveryLocationRoleType - AU Extended 📦6.0.0-ci-build AU Base Implementation Guide vnull
    Location.physicalType Base preferred Location Type (Physical) - AU Extended 📦6.0.0-ci-build AU Base Implementation Guide vnull
    Location.hoursOfOperation.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    au-core-loc-01 error Location The location shall at least have a valid identifier or address or type address.exists() or type.exists() or identifier.where(system.count() + value.count() >1).exists()
    dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error Location If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4 error Location If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5 error Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice Location A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    This structure is derived from AUBaseLocation

    Summary

    Must-Support: 5 elements

    Structures

    This structure refers to these other structures:

    Maturity: 2

     

    Other representations of profile: CSV, Excel, Schematron

    Notes:

    Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU Core CapabilityStatements for a complete list of supported RESTful interactions for this IG.

    FHIR search operations are described here and the syntax used to describe AU Core interactions is defined here.

    Any search parameter defined in FHIR may be 'allowed' by the system unless explicitly marked as "SHALL NOT". A few items are marked as MAY in this implementation guide to highlight their potential relevance.

    Parameter(s) Conformance Type(s) Requirements (when used alone or in combination)
    name SHALL string
    address SHOULD string
    address-city SHOULD string
    address-state SHOULD string
    address-postalcode SHOULD string

    Mandatory Search Parameters

    1. SHALL support searching based on text name using the name search parameter:

      GET [base]/Location?name=[string]

      Example:

      1. GET [base]/Location?name=Hospital

      Implementation Notes: Fetches a bundle of all Location resources matching the name (how to search by string)

    Optional Search Parameters:

    The following search parameters SHOULD be supported:

    1. SHOULD support searching based on text address using the address search parameter:

      GET [base]/Location?address=[string]

      Example:

      1. GET [base]/Location?address=QLD

      Implementation Notes: Fetches a bundle of all Location resources matching the address (how to search by string)

    2. SHOULD support searching using the address-city search parameter:

      GET [base]/Location?address-city=[string]

      Example:

      1. GET [base]/Location?address-city=Westmead

      Implementation Notes: Fetches a bundle of all Location resources for the city (how to search by string)

    3. SHOULD support searching using the addresss-postalcode search parameter:

      GET [base]/Location?addresss-postalcode=[string]

      Example:

      1. GET [base]/Location?addresss-postalcode=3005

      Implementation Notes: Fetches a bundle of all Location resources matching the post code (how to search by string)

    4. SHOULD support searching using the address-state search parameter:

      GET [base]/Location?address-state=[string]

      Example:

      1. GET [base]/Location?address-state=TAS

      Implementation Notes: Fetches a bundle of all Location resources matching the state (how to search by string)