MediRecords FHIR Implementation Guide
1.4.1 - release


Resource Profile: MR Location Admission

Defining URL:https://fhir.medirecords.com/StructureDefinition/mr-location-admission
Version:1.4.1
Name:MRLocationAdmission
Title:MR Location Admission
Status:Active as of 2024-10-28 02:34:31+0000
Definition:

MediRecords Location profile to record a location in the context of Admission. It may refer to a Ward, Room or Bed

Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

https://fhir.medirecords.com/StructureDefinition/mr-location-admission

Formal Views of Profile Content

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

This structure is derived from AUBaseLocation

Summary

Mandatory: 6 elements (2 nested mandatory elements)
Must-Support: 10 elements

Structures

This structure refers to these other structures:

This structure is derived from AUBaseLocation

NameFlagsCard.TypeDescription & Constraintsdoco
​.. Location C0..*AUBaseLocationA location in an Australian healthcare context
inv-mr-location-operationalStatus-01: OperationalStatus is required if physicalType is bed (bd)
inv-mr-location-type-01: Type is required if physicalType is ward (wa)
​... meta
​.... profile S1..*canonical(StructureDefinition)Profiles this resource claims to conform to
​... identifier S1..1Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumberLocation identifier which may be organization scoped or location scoped
​.... system 1..1uriThe namespace for the identifier value
Example Organization or Location scoped: https://fhir.medirecords.com/organization-scoped/<organization id> or https://fhir.medirecords.com/location-scoped/<location id>
​.... value 1..1stringWard, bed or room number
​... status SC1..1codeMedirecords supports only active and inactive status
inv-mr-location-status-01: Medirecords supports only active and inactive status
​.... code 0..1codeCode representative of bed status: U (Available) | K (Dirty) | C (Out Of Order) | R (Reserved) | V (Virtual) | O (Occupied)
​.... display 0..1stringUnoccupied | Contaminated | Closed | Reserved | Virtual | Occupied
​... name S0..1stringName of ward or room
​... description S0..1stringDescription of ward, room or bed
​... type S0..1CodeableConceptWard specialty type, required if physicalType is ward (wa)
Binding: MediRecords Location Ward Specialty ValueSet (extensible)
​.... coding 0..1CodingCode representative of selected ward specialty type
​.... text 1..1stringDescription of selected ward specialty type
​... physicalType S1..1CodeableConceptIndicates if the location is a ward (wa), room (ro) or bed (bd)
Binding: MediRecords Location Physical Type ValueSet (required)
​... managingOrganization S1..1Reference(MR Organisation)Organization responsible for provisioning and upkeep
​... partOf S0..1Reference(MR Location Admission)The ward or room that this location is physically a part of

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*AUBaseLocationA location in an Australian healthcare context
inv-mr-location-operationalStatus-01: OperationalStatus is required if physicalType is bed (bd)
inv-mr-location-type-01: Type is required if physicalType is ward (wa)
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile SΣ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..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 S1..1Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumberLocation identifier which may be organization scoped or location scoped
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example Organization or Location scoped: https://fhir.medirecords.com/organization-scoped/<organization id> or https://fhir.medirecords.com/location-scoped/<location id>
.... value Σ1..1stringWard, bed or room number
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 ?!SΣC1..1codeMedirecords supports only active and inactive status
Binding: LocationStatus (required): Indicates whether the location is still in use.


inv-mr-location-status-01: Medirecords supports only active and inactive status
... operationalStatus SΣ0..1CodingBed status, required if physicalType is bed (bd)
Binding: MediRecords Location Bed Status ValueSet (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system Σ0..1uriIdentity of the terminology system
.... version Σ0..1stringVersion of the system - if relevant
.... code Σ0..1codeCode representative of bed status: U (Available) | K (Dirty) | C (Out Of Order) | R (Reserved) | V (Virtual) | O (Occupied)
.... display Σ0..1stringUnoccupied | Contaminated | Closed | Reserved | Virtual | Occupied
.... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... name SΣ0..1stringName of ward or room
... alias 0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description SΣ0..1stringDescription of ward, room or bed
... mode Σ0..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type SΣ0..1CodeableConceptWard specialty type, required if physicalType is ward (wa)
Binding: MediRecords Location Ward Specialty ValueSet (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..1CodingCode representative of selected ward specialty type
.... text Σ1..1stringDescription of selected ward specialty type
... telecom 0..*ContactPointContact details of the location
... address 0..1Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... physicalType SΣ1..1CodeableConceptIndicates if the location is a ward (wa), room (ro) or bed (bd)
Binding: MediRecords Location Physical Type ValueSet (required)
... position 0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ1..1Reference(MR Organisation)Organization responsible for provisioning and upkeep
... partOf S0..1Reference(MR Location Admission)The ward or room that this location is physically a part of
... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanThe Location is open all day
.... openingTime 0..1timeTime that the Location opens
.... closingTime 0..1timeTime that the Location closes
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
​.. Location 0..*AUBaseLocationA location in an Australian healthcare context
​... meta Σ0..1MetaMetadata about the resource
​.... profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
​... identifier 1..1Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumberLocation identifier which may be organization scoped or location scoped
​... status ?!ΣC1..1codeMedirecords supports only active and inactive status
Binding: LocationStatus (required): Indicates whether the location is still in use.


inv-mr-location-status-01: Medirecords supports only active and inactive status
​... name Σ0..1stringName of ward or room
​... description Σ0..1stringDescription of ward, room or bed
​... type Σ0..1CodeableConceptWard specialty type, required if physicalType is ward (wa)
Binding: MediRecords Location Ward Specialty ValueSet (extensible)
​... physicalType Σ1..1CodeableConceptIndicates if the location is a ward (wa), room (ro) or bed (bd)
Binding: MediRecords Location Physical Type ValueSet (required)
​... managingOrganization Σ1..1Reference(MR Organisation)Organization responsible for provisioning and upkeep
​... partOf 0..1Reference(MR Location Admission)The ward or room that this location is physically a part of

doco Documentation for this format

This structure is derived from AUBaseLocation

Summary

Mandatory: 6 elements (2 nested mandatory elements)
Must-Support: 10 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from AUBaseLocation

NameFlagsCard.TypeDescription & Constraintsdoco
​.. Location C0..*AUBaseLocationA location in an Australian healthcare context
inv-mr-location-operationalStatus-01: OperationalStatus is required if physicalType is bed (bd)
inv-mr-location-type-01: Type is required if physicalType is ward (wa)
​... meta
​.... profile S1..*canonical(StructureDefinition)Profiles this resource claims to conform to
​... identifier S1..1Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumberLocation identifier which may be organization scoped or location scoped
​.... system 1..1uriThe namespace for the identifier value
Example Organization or Location scoped: https://fhir.medirecords.com/organization-scoped/<organization id> or https://fhir.medirecords.com/location-scoped/<location id>
​.... value 1..1stringWard, bed or room number
​... status SC1..1codeMedirecords supports only active and inactive status
inv-mr-location-status-01: Medirecords supports only active and inactive status
​.... code 0..1codeCode representative of bed status: U (Available) | K (Dirty) | C (Out Of Order) | R (Reserved) | V (Virtual) | O (Occupied)
​.... display 0..1stringUnoccupied | Contaminated | Closed | Reserved | Virtual | Occupied
​... name S0..1stringName of ward or room
​... description S0..1stringDescription of ward, room or bed
​... type S0..1CodeableConceptWard specialty type, required if physicalType is ward (wa)
Binding: MediRecords Location Ward Specialty ValueSet (extensible)
​.... coding 0..1CodingCode representative of selected ward specialty type
​.... text 1..1stringDescription of selected ward specialty type
​... physicalType S1..1CodeableConceptIndicates if the location is a ward (wa), room (ro) or bed (bd)
Binding: MediRecords Location Physical Type ValueSet (required)
​... managingOrganization S1..1Reference(MR Organisation)Organization responsible for provisioning and upkeep
​... partOf S0..1Reference(MR Location Admission)The ward or room that this location is physically a part of

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*AUBaseLocationA location in an Australian healthcare context
inv-mr-location-operationalStatus-01: OperationalStatus is required if physicalType is bed (bd)
inv-mr-location-type-01: Type is required if physicalType is ward (wa)
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile SΣ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..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 S1..1Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumberLocation identifier which may be organization scoped or location scoped
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example Organization or Location scoped: https://fhir.medirecords.com/organization-scoped/<organization id> or https://fhir.medirecords.com/location-scoped/<location id>
.... value Σ1..1stringWard, bed or room number
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 ?!SΣC1..1codeMedirecords supports only active and inactive status
Binding: LocationStatus (required): Indicates whether the location is still in use.


inv-mr-location-status-01: Medirecords supports only active and inactive status
... operationalStatus SΣ0..1CodingBed status, required if physicalType is bed (bd)
Binding: MediRecords Location Bed Status ValueSet (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system Σ0..1uriIdentity of the terminology system
.... version Σ0..1stringVersion of the system - if relevant
.... code Σ0..1codeCode representative of bed status: U (Available) | K (Dirty) | C (Out Of Order) | R (Reserved) | V (Virtual) | O (Occupied)
.... display Σ0..1stringUnoccupied | Contaminated | Closed | Reserved | Virtual | Occupied
.... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... name SΣ0..1stringName of ward or room
... alias 0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description SΣ0..1stringDescription of ward, room or bed
... mode Σ0..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type SΣ0..1CodeableConceptWard specialty type, required if physicalType is ward (wa)
Binding: MediRecords Location Ward Specialty ValueSet (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..1CodingCode representative of selected ward specialty type
.... text Σ1..1stringDescription of selected ward specialty type
... telecom 0..*ContactPointContact details of the location
... address 0..1Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... physicalType SΣ1..1CodeableConceptIndicates if the location is a ward (wa), room (ro) or bed (bd)
Binding: MediRecords Location Physical Type ValueSet (required)
... position 0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ1..1Reference(MR Organisation)Organization responsible for provisioning and upkeep
... partOf S0..1Reference(MR Location Admission)The ward or room that this location is physically a part of
... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanThe Location is open all day
.... openingTime 0..1timeTime that the Location opens
.... closingTime 0..1timeTime that the Location closes
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Location.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Location.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Location.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.operationalStatusextensibleMRLocationBedStatusValueSet
https://fhir.medirecords.com/ValueSet/mr-location-bed-status
from this IG
Location.moderequiredLocationMode
http://hl7.org/fhir/ValueSet/location-mode|4.0.1
from the FHIR Standard
Location.typeextensibleMRLocationWardSpecialtyValueSet
https://fhir.medirecords.com/ValueSet/mr-location-ward-specialty
from this IG
Location.physicalTyperequiredMrLocationPhysicalTypeValueSet
https://fhir.medirecords.com/ValueSet/mr-location-physical-type
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()
inv-mr-location-operationalStatus-01errorLocationOperationalStatus is required if physicalType is bed (bd)
: operationalStatus.exists() implies (Location.physicalType.coding.system = 'http://terminology.hl7.org/CodeSystem/location-physical-type' and Location.physicalType.coding.code = 'bd')
inv-mr-location-status-01errorLocation.statusMedirecords supports only active and inactive status
: $this.exists() implies ($this = 'active' or $this = 'inactive')
inv-mr-location-type-01errorLocationType is required if physicalType is ward (wa)
: type.exists() implies (Location.physicalType.coding.system = 'http://terminology.hl7.org/CodeSystem/location-physical-type' and Location.physicalType.coding.code = 'wa')