AU Core Implementation Guide
0.3.0-ballot - R1
AU Core Implementation Guide
0.3.0-ballot - R1
This page is part of the AU Core (v0.3.0-ballot: AU Core R1 Ballot 5) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-location | Version: 0.3.0-ballot | |||
| Standards status: Draft | Maturity Level: 0 | 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.
The following are supported usage scenarios for this profile:
A resource conforming to this profile:
No equivalent International Patient Access or International Patient Summary profile.
Conformance in reverse is not guaranteed, i.e. a resource conforming to US Core MAY NOT conform to AU Core.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseLocation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Location | C | 0..* | AUBaseLocation | A location in an Australian healthcare context au-core-loc-01: The location shall at least have a valid identifier or address or type |
  identifier | SC | 0..* | Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber | Unique code or number identifying the location to its users |
| name | S | 0..1 | string | Name of the location as used by humans |
| description | S | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name |
| mode | S | 0..1 | code | instance | kind |
| type | SC | 0..* | CodeableConcept | Type of function performed |
| address | SC | 0..1 | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
| physicalType | S | 0..1 | CodeableConcept | Physical form of the location |
  managingOrganization | S | 0..1 | Reference(AU Core Organization) | Organization responsible for provisioning and upkeep |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | C | 0..* | AUBaseLocation | A location in an Australian healthcare context au-core-loc-01: The location shall at least have a valid identifier or address or type |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier | SC | 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. |
| name | SΣ | 0..1 | string | Name of the location as used by humans |
| description | SΣ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name |
| mode | SΣ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. |
| type | SΣC | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible) |
| address | SC | 0..1 | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
| physicalType | SΣ | 0..1 | CodeableConcept | Physical form of the location Binding: Location Type (Physical) - AU Extended (preferred) |
| managingOrganization | SΣ | 0..1 | Reference(AU Core Organization) | Organization responsible for provisioning and upkeep |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1from the FHIR Standard | |
| Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1from the FHIR Standard | |
| Location.type | extensible | ServiceDeliveryLocationRoleTypeAUExtendedhttp://terminology.hl7.org.au/ValueSet/v3-ServiceDeliveryLocationRoleType-extended | |
| Location.physicalType | preferred | LocationPhysicalTypeAUExtendedhttp://terminology.hl7.org.au/ValueSet/location-physical-type-extended |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Location | C | 0..* | AUBaseLocation | A location in an Australian healthcare context au-core-loc-01: The location shall at least have a valid identifier or address or type | ||||
| 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 | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SC | 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 | SΣ | 0..1 | string | Name of the location as used by humans | ||||
| alias | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |||||
| description | SΣ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name | ||||
| mode | SΣ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. | ||||
| type | SΣC | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible) | ||||
| telecom | 0..* | ContactPoint | Contact details of the location | |||||
| address | SC | 0..1 | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
| physicalType | SΣ | 0..1 | CodeableConcept | Physical form of the location Binding: Location Type (Physical) - AU Extended (preferred) | ||||
 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 | SΣ | 0..1 | Reference(AU Core Organization) | Organization responsible for provisioning and upkeep | ||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Location.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1from the FHIR Standard | ||||
| Location.operationalStatus | preferred | Hl7VSBedStatushttp://terminology.hl7.org/ValueSet/v2-0116 | ||||
| Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1from the FHIR Standard | ||||
| Location.type | extensible | ServiceDeliveryLocationRoleTypeAUExtendedhttp://terminology.hl7.org.au/ValueSet/v3-ServiceDeliveryLocationRoleType-extended | ||||
| Location.physicalType | preferred | LocationPhysicalTypeAUExtendedhttp://terminology.hl7.org.au/ValueSet/location-physical-type-extended | ||||
| Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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: 8 elements
Structures
This structure refers to these other structures:
Maturity: 0
Differential View
This structure is derived from AUBaseLocation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | C | 0..* | AUBaseLocation | A location in an Australian healthcare context au-core-loc-01: The location shall at least have a valid identifier or address or type |
| identifier | SC | 0..* | Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber | Unique code or number identifying the location to its users |
| name | S | 0..1 | string | Name of the location as used by humans |
| description | S | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name |
| mode | S | 0..1 | code | instance | kind |
| type | SC | 0..* | CodeableConcept | Type of function performed |
| address | SC | 0..1 | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
| physicalType | S | 0..1 | CodeableConcept | Physical form of the location |
| managingOrganization | S | 0..1 | Reference(AU Core Organization) | Organization responsible for provisioning and upkeep |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | C | 0..* | AUBaseLocation | A location in an Australian healthcare context au-core-loc-01: The location shall at least have a valid identifier or address or type |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SC | 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. |
| name | SΣ | 0..1 | string | Name of the location as used by humans |
| description | SΣ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name |
| mode | SΣ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. |
| type | SΣC | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible) |
| address | SC | 0..1 | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
| physicalType | SΣ | 0..1 | CodeableConcept | Physical form of the location Binding: Location Type (Physical) - AU Extended (preferred) |
| managingOrganization | SΣ | 0..1 | Reference(AU Core Organization) | Organization responsible for provisioning and upkeep |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1from the FHIR Standard | |
| Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1from the FHIR Standard | |
| Location.type | extensible | ServiceDeliveryLocationRoleTypeAUExtendedhttp://terminology.hl7.org.au/ValueSet/v3-ServiceDeliveryLocationRoleType-extended | |
| Location.physicalType | preferred | LocationPhysicalTypeAUExtendedhttp://terminology.hl7.org.au/ValueSet/location-physical-type-extended |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Location | C | 0..* | AUBaseLocation | A location in an Australian healthcare context au-core-loc-01: The location shall at least have a valid identifier or address or type | ||||
| 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 | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SC | 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 | SΣ | 0..1 | string | Name of the location as used by humans | ||||
| alias | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |||||
| description | SΣ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name | ||||
| mode | SΣ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. | ||||
| type | SΣC | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible) | ||||
| telecom | 0..* | ContactPoint | Contact details of the location | |||||
| address | SC | 0..1 | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
| physicalType | SΣ | 0..1 | CodeableConcept | Physical form of the location Binding: Location Type (Physical) - AU Extended (preferred) | ||||
| 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 | SΣ | 0..1 | Reference(AU Core Organization) | Organization responsible for provisioning and upkeep | ||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Location.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1from the FHIR Standard | ||||
| Location.operationalStatus | preferred | Hl7VSBedStatushttp://terminology.hl7.org/ValueSet/v2-0116 | ||||
| Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1from the FHIR Standard | ||||
| Location.type | extensible | ServiceDeliveryLocationRoleTypeAUExtendedhttp://terminology.hl7.org.au/ValueSet/v3-ServiceDeliveryLocationRoleType-extended | ||||
| Location.physicalType | preferred | LocationPhysicalTypeAUExtendedhttp://terminology.hl7.org.au/ValueSet/location-physical-type-extended | ||||
| Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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: 8 elements
Structures
This structure refers to these other structures:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described 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) |
|---|---|---|---|
| address | SHALL | string |
|
| name | SHALL | string |
|
| address-city | SHOULD | string |
|
| address-state | SHOULD | string |
|
| address-postalcode | SHOULD | string |
|
| identifier | MAY | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
The following search parameters SHALL be supported:
SHALL support searching for a location based on text address using the address search parameter:
GET [base]/Location?address=[string]
Example:
Implementation Notes: Fetches a bundle of all Location resources matching the name (how to search by string)
SHALL support searching for a location based on text name using the name search parameter:
GET [base]/Location?name=[string]
Example:
Implementation Notes: Fetches a bundle of all Location resources matching the name (how to search by string)
The following search parameters SHOULD be supported:
SHOULD support searching for a location based on the address-city search parameter:
GET [base]/Location?address-city=[string]
Example:
Implementation Notes: Fetches a bundle of all Location resources for the city (how to search by string)
SHOULD support searching for a location based on the addresss-postalcode search parameter:
GET [base]/Location?addresss-postalcode=[string]
Example:
Implementation Notes: Fetches a bundle of all Location resources matching the post code (how to search by string)
SHOULD support searching for a location based on the address-state search parameter:
GET [base]/Location?address-state=[string]
Example:
Implementation Notes: Fetches a bundle of all Location resources matching the state (how to search by string)
IG © 2022+ HL7 Australia. Package hl7.fhir.au.core#0.3.0-ballot based on FHIR 4.0.1. Generated 2024-03-10
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change