Medtech ALEX® Implementation Guide
0.0.1 - draft International flag

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

Resource Profile: Location Profile

Official URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-location Version: 0.0.1
Active as of 2025-01-20 Computable Name: AlexLocation

The Location resource exposed by ALEX.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* AUBaseLocation A location in an Australian healthcare context
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... medtechPmsVersion S 1..1 string Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/location-medtechpms-version
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... identifier:hpio S 0..1 AlexHPIO Unique code or number identifying the location to its users
ele-1: All FHIR elements must have a @value or children
.... identifier:abn S 0..1 AUAustralianBusinessNumber Unique code or number identifying the location to its users
ele-1: All FHIR elements must have a @value or children
.... identifier:acn S 0..1 AUAustralianCompanyNumber Unique code or number identifying the location to its users
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 0..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.


ele-1: All FHIR elements must have a @value or children
... name SΣ 0..1 string Name of the location as used by humans
ele-1: All FHIR elements must have a @value or children
... description SΣ 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
ele-1: All FHIR elements must have a @value or children
... type SΣ 0..1 CodeableConcept Type of function performed
Binding: ANZSIC ValueSet (required)
ele-1: All FHIR elements must have a @value or children
... telecom S 0..3 ContactPoint Contact details of the location
ele-1: All FHIR elements must have a @value or children
... address S 0..1 AlexAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.typerequiredANZSIC (a valid code from ANZSIC CodeSystem)
https://alexapi.medtechglobal.com.au/fhir/ValueSet/anzsic-restricted-activity
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLocationIf 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-4errorLocationIf 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-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLocationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AUBaseLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* AUBaseLocation A location in an Australian healthcare context
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... medtechPmsVersion S 1..1 string Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/location-medtechpms-version
... Slices for identifier S 0..3 AlexHPIO, AUAustralianBusinessNumber, AUAustralianCompanyNumber Unique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:hpio S 0..1 AlexHPIO Unique code or number identifying the location to its users
.... identifier:abn S 0..1 AUAustralianBusinessNumber Unique code or number identifying the location to its users
.... identifier:acn S 0..1 AUAustralianCompanyNumber Unique code or number identifying the location to its users
... operationalStatus 0..0
... alias 0..0
... 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 0..0
... type S 0..1 CodeableConcept Type of function performed
Binding: ANZSIC ValueSet (required)
... telecom S 0..3 ContactPoint Contact details of the location
... address S 0..1 AlexAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... physicalType 0..0
... position 0..0
... managingOrganization 0..0
... partOf 0..0
... hoursOfOperation 0..0
... availabilityExceptions 0..0
... endpoint 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Location.typerequiredANZSIC (a valid code from ANZSIC CodeSystem)
https://alexapi.medtechglobal.com.au/fhir/ValueSet/anzsic-restricted-activity
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* AUBaseLocation A location in an Australian healthcare context
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... medtechPmsVersion S 1..1 string Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/location-medtechpms-version
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 0..3 AlexHPIO, AUAustralianBusinessNumber, AUAustralianCompanyNumber Unique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:hpio S 0..1 AlexHPIO Unique code or number identifying the location to its users
.... identifier:abn S 0..1 AUAustralianBusinessNumber Unique code or number identifying the location to its users
.... identifier:acn S 0..1 AUAustralianCompanyNumber 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
... type SΣ 0..1 CodeableConcept Type of function performed
Binding: ANZSIC ValueSet (required)
... telecom S 0..3 ContactPoint Contact details of the location
... address S 0..1 AlexAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.typerequiredANZSIC (a valid code from ANZSIC CodeSystem)
https://alexapi.medtechglobal.com.au/fhir/ValueSet/anzsic-restricted-activity
from this IG
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLocationIf 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-4errorLocationIf 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-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLocationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AUBaseLocation

Summary

Mandatory: 2 elements
Must-Support: 10 elements
Prohibited: 10 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Location.identifier

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* AUBaseLocation A location in an Australian healthcare context
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... medtechPmsVersion S 1..1 string Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/location-medtechpms-version
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... identifier:hpio S 0..1 AlexHPIO Unique code or number identifying the location to its users
ele-1: All FHIR elements must have a @value or children
.... identifier:abn S 0..1 AUAustralianBusinessNumber Unique code or number identifying the location to its users
ele-1: All FHIR elements must have a @value or children
.... identifier:acn S 0..1 AUAustralianCompanyNumber Unique code or number identifying the location to its users
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 0..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.


ele-1: All FHIR elements must have a @value or children
... name SΣ 0..1 string Name of the location as used by humans
ele-1: All FHIR elements must have a @value or children
... description SΣ 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
ele-1: All FHIR elements must have a @value or children
... type SΣ 0..1 CodeableConcept Type of function performed
Binding: ANZSIC ValueSet (required)
ele-1: All FHIR elements must have a @value or children
... telecom S 0..3 ContactPoint Contact details of the location
ele-1: All FHIR elements must have a @value or children
... address S 0..1 AlexAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.typerequiredANZSIC (a valid code from ANZSIC CodeSystem)
https://alexapi.medtechglobal.com.au/fhir/ValueSet/anzsic-restricted-activity
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLocationIf 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-4errorLocationIf 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-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLocationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from AUBaseLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* AUBaseLocation A location in an Australian healthcare context
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... medtechPmsVersion S 1..1 string Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/location-medtechpms-version
... Slices for identifier S 0..3 AlexHPIO, AUAustralianBusinessNumber, AUAustralianCompanyNumber Unique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:hpio S 0..1 AlexHPIO Unique code or number identifying the location to its users
.... identifier:abn S 0..1 AUAustralianBusinessNumber Unique code or number identifying the location to its users
.... identifier:acn S 0..1 AUAustralianCompanyNumber Unique code or number identifying the location to its users
... operationalStatus 0..0
... alias 0..0
... 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 0..0
... type S 0..1 CodeableConcept Type of function performed
Binding: ANZSIC ValueSet (required)
... telecom S 0..3 ContactPoint Contact details of the location
... address S 0..1 AlexAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... physicalType 0..0
... position 0..0
... managingOrganization 0..0
... partOf 0..0
... hoursOfOperation 0..0
... availabilityExceptions 0..0
... endpoint 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Location.typerequiredANZSIC (a valid code from ANZSIC CodeSystem)
https://alexapi.medtechglobal.com.au/fhir/ValueSet/anzsic-restricted-activity
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* AUBaseLocation A location in an Australian healthcare context
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... medtechPmsVersion S 1..1 string Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/location-medtechpms-version
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 0..3 AlexHPIO, AUAustralianBusinessNumber, AUAustralianCompanyNumber Unique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:hpio S 0..1 AlexHPIO Unique code or number identifying the location to its users
.... identifier:abn S 0..1 AUAustralianBusinessNumber Unique code or number identifying the location to its users
.... identifier:acn S 0..1 AUAustralianCompanyNumber 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
... type SΣ 0..1 CodeableConcept Type of function performed
Binding: ANZSIC ValueSet (required)
... telecom S 0..3 ContactPoint Contact details of the location
... address S 0..1 AlexAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.typerequiredANZSIC (a valid code from ANZSIC CodeSystem)
https://alexapi.medtechglobal.com.au/fhir/ValueSet/anzsic-restricted-activity
from this IG
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLocationIf 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-4errorLocationIf 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-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLocationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AUBaseLocation

Summary

Mandatory: 2 elements
Must-Support: 10 elements
Prohibited: 10 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Location.identifier

 

Other representations of profile: CSV, Excel, Schematron