Australian Base Implementation Guide (AU Base 2)

This page is part of the Australian Base IG (v2.1.0: AU Base 2 on R4) based on FHIR R4. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-location

AU Base Location Profile [FMM Level 3]

This profile defines a location administration details structure that includes core localisation concepts for use in an Australian context.

Identifiers

These definitions represent common data held in the Location.identifier element:

  • National Association of Testing Authorities (NATA) Site Number [1]

Examples

Site at 33 Slobodian Street, Albion, QLD

Level 1, Green Building, Albion Hospital, QLD

Family medicine clinic at Sandy Bay Road, Strahan, TAS

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/au-location

This profile defines a location administration details structure that includes core localisation concepts for use in an Australian context.

This profile builds on Location.

This profile was published on Tue Jul 23 00:00:00 AEST 2019 as a active by Health Level Seven Australia (Patient Administration WG).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationA location in an Australian healthcare context
... identifier 0..*(Slice Definition)Unique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:nataSite 0..*IdentifierNational Association of Testing Authorities (NATA) Site Number
..... type
...... text 0..1stringNational Association of Testing Authorities (NATA) site number
Fixed Value: NATA Site Number
..... system 1..1uriNamespace for NATA site number
Fixed Value: http://hl7.org.au/id/nata-site
..... value 1..1stringNATA site number
Example NATA site number: 16289

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location I0..*LocationA location in an Australian healthcare context
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)Unique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:nataSite ΣI0..*IdentifierNational Association of Testing Authorities (NATA) Site Number
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI0..*CodingCode defined by a terminology system
...... text ΣI0..1stringNational Association of Testing Authorities (NATA) site number
Fixed Value: NATA Site Number
..... system ΣI1..1uriNamespace for NATA site number
Fixed Value: http://hl7.org.au/id/nata-site
..... value ΣI1..1stringNATA site number
Example General: 123456
Example NATA site number: 16289
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!ΣI0..1codeactive | suspended | inactive
Binding: LocationStatus (required)
... operationalStatus ΣI0..1CodingThe operational status of the location (typically only for a bed/room)
Binding: v2 BED STATUS (preferred)
... name ΣI0..1stringName of the location as used by humans
... alias I0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description ΣI0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode ΣI0..1codeinstance | kind
Binding: LocationMode (required)
... type ΣI0..*CodeableConceptType of function performed
Binding: V3 Value SetServiceDeliveryLocationRoleType (extensible)
... telecom I0..*ContactPointContact details of the location
... address I0..1AddressPhysical location
... physicalType ΣI0..1CodeableConceptPhysical form of the location
Binding: LocationType (example)
... position I0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude I1..1decimalLongitude with WGS84 datum
.... latitude I1..1decimalLatitude with WGS84 datum
.... altitude I0..1decimalAltitude with WGS84 datum
... managingOrganization ΣI0..1Reference(Organization)Organization responsible for provisioning and upkeep
... partOf I0..1Reference(Location)Another Location this one is physically a part of
... hoursOfOperation I0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek I0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay I0..1booleanThe Location is open all day
.... openingTime I0..1timeTime that the Location opens
.... closingTime I0..1timeTime that the Location closes
... availabilityExceptions I0..1stringDescription of availability exceptions
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationA location in an Australian healthcare context
... identifier 0..*(Slice Definition)Unique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:nataSite 0..*IdentifierNational Association of Testing Authorities (NATA) Site Number
..... type
...... text 0..1stringNational Association of Testing Authorities (NATA) site number
Fixed Value: NATA Site Number
..... system 1..1uriNamespace for NATA site number
Fixed Value: http://hl7.org.au/id/nata-site
..... value 1..1stringNATA site number
Example NATA site number: 16289

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location I0..*LocationA location in an Australian healthcare context
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)Unique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:nataSite ΣI0..*IdentifierNational Association of Testing Authorities (NATA) Site Number
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI0..*CodingCode defined by a terminology system
...... text ΣI0..1stringNational Association of Testing Authorities (NATA) site number
Fixed Value: NATA Site Number
..... system ΣI1..1uriNamespace for NATA site number
Fixed Value: http://hl7.org.au/id/nata-site
..... value ΣI1..1stringNATA site number
Example General: 123456
Example NATA site number: 16289
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!ΣI0..1codeactive | suspended | inactive
Binding: LocationStatus (required)
... operationalStatus ΣI0..1CodingThe operational status of the location (typically only for a bed/room)
Binding: v2 BED STATUS (preferred)
... name ΣI0..1stringName of the location as used by humans
... alias I0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description ΣI0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode ΣI0..1codeinstance | kind
Binding: LocationMode (required)
... type ΣI0..*CodeableConceptType of function performed
Binding: V3 Value SetServiceDeliveryLocationRoleType (extensible)
... telecom I0..*ContactPointContact details of the location
... address I0..1AddressPhysical location
... physicalType ΣI0..1CodeableConceptPhysical form of the location
Binding: LocationType (example)
... position I0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude I1..1decimalLongitude with WGS84 datum
.... latitude I1..1decimalLatitude with WGS84 datum
.... altitude I0..1decimalAltitude with WGS84 datum
... managingOrganization ΣI0..1Reference(Organization)Organization responsible for provisioning and upkeep
... partOf I0..1Reference(Location)Another Location this one is physically a part of
... hoursOfOperation I0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek I0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay I0..1booleanThe Location is open all day
.... openingTime I0..1timeTime that the Location opens
.... closingTime I0..1timeTime that the Location closes
... availabilityExceptions I0..1stringDescription of availability exceptions
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-location

not specified