Australian Base Profiles Implementation Guide

This page is part of the Australian Base IG (v0.9.3: AU Base 1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-location

AU Base Location Profile [FMM Level 0]

This profile defines a location administration details structure that includes core localisation concepts.

Identifiers

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

  • NATA Site Number [1]

Examples

Site at 33 Slobodian Street, Albion, 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

Base profile for Australian context Location

This profile builds on Location.

This profile was published on Fri Aug 03 00:00:00 AEST 2018 as a draft by Health Level Seven Australia (Patient Administration WG).

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

This profile contains the following variations from Location:

  1. zero or more identifier sliced
    • zero or more identifier NATA Site Number
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*A physical location in an Australian healthcare context
... identifier IdentifierSlice: Unordered, Open by value:system, value:type
... identifier 0..*IdentifierNATA Site Number
.... type 1..1CodeableConcept
..... text 1..1stringNATA 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..1string
... managingOrganization 0..1Reference(AU Base Organisation)
... partOf 0..1Reference(AU Base Location)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location I0..*A physical location in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣIdentifierUnique code or number identifying the location to its users
Slice: Unordered, Open by value:system, value:type
... identifier Σ0..*IdentifierNATA Site Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ1..1stringNATA 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..1stringThe value that is unique
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!Σ0..1codeactive | suspended | inactive
Binding: LocationStatus (required)
... operationalStatus Σ0..1CodingThe Operational status of the location (typically only for a bed/room)
Binding: v2 Bed Status (preferred)
... name Σ0..1stringName of the location as used by humans
... alias 0..*stringA list of alternate names that the location is known as, or was known as in the past
... description Σ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode ?!Σ0..1codeinstance | kind
Binding: LocationMode (required)
... type Σ0..1CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible)
... telecom 0..*ContactPointContact details of the location
... address 0..1AddressPhysical location
... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example)
... position I0..1BackboneElementThe absolute geographic location
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization Σ0..1Reference(AU Base Organisation)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(AU Base Location)Another Location this one is physically part of
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

This profile contains the following variations from Location:

  1. zero or more identifier sliced
    • zero or more identifier NATA Site Number

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*A physical location in an Australian healthcare context
... identifier IdentifierSlice: Unordered, Open by value:system, value:type
... identifier 0..*IdentifierNATA Site Number
.... type 1..1CodeableConcept
..... text 1..1stringNATA 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..1string
... managingOrganization 0..1Reference(AU Base Organisation)
... partOf 0..1Reference(AU Base Location)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location I0..*A physical location in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣIdentifierUnique code or number identifying the location to its users
Slice: Unordered, Open by value:system, value:type
... identifier Σ0..*IdentifierNATA Site Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ1..1stringNATA 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..1stringThe value that is unique
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!Σ0..1codeactive | suspended | inactive
Binding: LocationStatus (required)
... operationalStatus Σ0..1CodingThe Operational status of the location (typically only for a bed/room)
Binding: v2 Bed Status (preferred)
... name Σ0..1stringName of the location as used by humans
... alias 0..*stringA list of alternate names that the location is known as, or was known as in the past
... description Σ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode ?!Σ0..1codeinstance | kind
Binding: LocationMode (required)
... type Σ0..1CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible)
... telecom 0..*ContactPointContact details of the location
... address 0..1AddressPhysical location
... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example)
... position I0..1BackboneElementThe absolute geographic location
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization Σ0..1Reference(AU Base Organisation)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(AU Base Location)Another Location this one is physically part of
... endpoint 0..*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