Location

The FHIR resource Location is for Service Delivery Location of Immunization records and/or Supplemental Data.

idΣ1..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileΣ1..1canonical(StructureDefinition)
securityΣ0..1CodingBinding
tagΣ0..1Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..1Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
statusΣ ?!0..1codeBinding
operationalStatusΣ0..1CodingBinding
nameΣ0..1string
alias0..1string
descriptionΣ0..1string
modeΣ0..1codeBinding
typeΣ0..1CodeableConceptBinding
telecom0..1ContactPoint
address0..1Address
physicalTypeΣ0..1CodeableConcept
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
longitude1..1decimal
latitude1..1decimal
altitude0..1decimal
id0..1string
extensionI0..*Extension
referenceΣ I1..1string
typeΣ0..1uriBindingFixed Value
identifierΣ0..1Identifier
displayΣ0..1string
id1..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ0..1uriBindingFixed Value
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ1..1string
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
displayΣ0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
daysOfWeek0..*codeBinding
allDay0..1boolean
openingTime0..1time
closingTime0..1time
availabilityExceptions0..1string
endpoint0..1Reference(Endpoint)
Location
DefinitionFHIR resource applies for PIR Vaccine Administered Service Delivery Location (SDL)
Cardinality0...*
Invariants
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • 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
    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: 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: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
Mappings
  • rim: Entity. Role, or Act
  • rim: .Role[classCode=SDLC]
Location.id
DefinitionPIR internal Service Delivery Location (SDL) Identifier + PIR internal Immunization Organization (Immz Org) Identifier. SDL refers to the site where vaccine is being administered.
Cardinality1...1
Typestring
SummaryTrue
Comments

See Mappings

Mappings
  • source-PIR: (PIR Location Id) + 'org' + (PIR Imms Org ID)
  • source-PIR-Unknown: (UNK) + 'org' + (PIR Imms Org ID)
Location.meta
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality1...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Location.meta.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Location.meta.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Location.meta.versionId
DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
Cardinality0...1
Typeid
SummaryTrue
Comments

Use '2025.01.1' (This indicates FHIR changes on 2025-Jan).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Location.meta.lastUpdated
DefinitionWhen the resource last changed - e.g. when the version changed.
Cardinality0...1
Typeinstant
SummaryTrue
Comments

Updated: 1. Relax the previously crossed-out elements. 2 For element ID and IDENTIFIER, remove the counter when value = UNK. It used to be UNK1, or UNK2 or UNK3 etc., this counter is no longer needed as the associated Imms Org is now concatenated to the LOC ID (e.g. UNKorg81).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Location.meta.source
DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
Cardinality0...1
Typeuri
SummaryTrue
Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Location.meta.profile
DefinitionA list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).
Cardinality1...1
Typecanonical(StructureDefinition)
SummaryTrue
Comments

Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Location'

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Location.meta.security
DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Cardinality0...1
TypeCoding
Binding

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)
SummaryTrue
Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Location.meta.tag
DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
Cardinality0...1
TypeCoding
Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)
SummaryTrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Location.implicitRules
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Location.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Location.text
DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality0...1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
Location.contained
DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality0...1
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Mappings
  • rim: N/A
Location.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Location.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Location.identifier
DefinitionPIR internal Service Delivery Location (SDL) Identifier. SDL refers to the site where vaccine is being administered.
Cardinality1...1
TypeIdentifier
SummaryTrue
Requirements

Organization label locations in registries, need to keep track of those.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • rim: .id
Location.identifier.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Location.identifier.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Location.identifier.use
DefinitionThe purpose of this identifier.
Cardinality0...1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)
ModifierTrue
SummaryTrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Role.code or implied by context
Location.identifier.type
DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality0...1
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)
SummaryTrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
Location.identifier.system
DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality1...1
Typeuri
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

http://www.acme.com/identifiers/patient


Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
  • source-PIR: https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-service-delivery-location-id
Location.identifier.value
DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality1...1
Typestring
SummaryTrue
Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

123456


Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
  • source-PIR-Unknown: (UNK) + 'org' + (PIR Imms Org ID)
  • source-PIR-known: Extract from (imms.h33_vaccination_master.location_id)
Location.identifier.period
DefinitionTime period during which identifier is/was valid for use.
Cardinality0...1
TypePeriod
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
Location.identifier.assigner
DefinitionOrganization that issued/manages the identifier.
Cardinality0...1
TypeReference(Organization)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
Location.status
DefinitionThe status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
Cardinality0...1
Typecode
Binding

Indicates whether the location is still in use.

LocationStatus (required)
ModifierTrue
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.status
  • rim: .statusCode
Location.operationalStatus
DefinitionThe operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.
Cardinality0...1
TypeCoding
Binding

The operational status if the location (where typically a bed/room).

v2.0116 (preferred)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.status
  • rim: n/a
Location.name
DefinitionName of the Service Delivery Location where vaccine is being administered.
Cardinality0...1
Typestring
SummaryTrue
Comments

SDL - Derive name from location name (imms.h33_vaccination_master.location_id)

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .name
Location.alias
DefinitionA list of alternate names that the location is known as, or was known as, in the past.
Cardinality0...1
Typestring
Requirements

Over time locations and organizations go through many changes and can be known by different names.

For searching knowing previous names that the location was known by can be very useful.

Comments

There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the location.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .name
Location.description
DefinitionDescription of the Location, which helps in finding or referencing the place.
Cardinality0...1
Typestring
SummaryTrue
Requirements

Humans need additional information to verify a correct location has been identified.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .playingEntity[classCode=PLC determinerCode=INSTANCE].desc
Location.mode
DefinitionIndicates whether a resource instance represents a specific location or a class of locations.
Cardinality0...1
Typecode
Binding

Indicates whether a resource instance represents a specific location or a class of locations.

LocationMode (required)
SummaryTrue
Requirements

When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location.

Comments

This is labeled as a modifier because whether or not the location is a class of locations changes how it can be used and understood.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.class
  • rim: .playingEntity[classCode=PLC].determinerCode
Location.type
DefinitionIndicates the type of function performed at the location.
Cardinality0...1
TypeCodeableConcept
Binding

Indicates the type of function performed at the location.

v3.ServiceDeliveryLocationRoleType (extensible)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.class
  • rim: .code
Location.telecom
DefinitionThe contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
Cardinality0...1
TypeContactPoint
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .telecom
Location.address
DefinitionPhysical location.
Cardinality0...1
TypeAddress
Requirements

If locations can be visited, we need to keep track of their address.

Comments

Additional addresses should be recorded using another instance of the Location resource, or via the Organization.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .addr
Location.physicalType
DefinitionPhysical form of the location, e.g. building, room, vehicle, road.
Cardinality0...1
TypeCodeableConcept
Binding

Physical form of the location.

LocationType (example)
SummaryTrue
Requirements

For purposes of showing relevant locations in queries, we need to categorize locations.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.class
  • rim: .playingEntity [classCode=PLC].code
Location.position
DefinitionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
Cardinality0...1
TypeBackboneElement
Requirements

For mobile applications and automated route-finding knowing the exact location of the Location is required.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .playingEntity [classCode=PLC determinerCode=INSTANCE].positionText
Location.position.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Location.position.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Location.position.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Location.position.longitude
DefinitionLongitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).
Cardinality1...1
Typedecimal
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: (RIM Opted not to map the sub-elements of GPS location, is now an OBS)
Location.position.latitude
DefinitionLatitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).
Cardinality1...1
Typedecimal
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: (RIM Opted not to map the sub-elements of GPS location, is now an OBS)
Location.position.altitude
DefinitionAltitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).
Cardinality0...1
Typedecimal
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: (RIM Opted not to map the sub-elements of GPS location, is now an OBS)
Location.managingOrganization
DefinitionThe immunization organization responsible for the provisioning and upkeep of the service delivery location.
Cardinality1...1
TypeReference(Organization)
SummaryTrue
Requirements

Need to know who manages the location.

Comments

This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .scopingEntity[classCode=ORG determinerKind=INSTANCE]
Location.managingOrganization.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Location.managingOrganization.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Location.managingOrganization.reference
DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Cardinality1...1
Typestring
SummaryTrue
Comments

fullURL of Panorama + 'Organization' + (PIR Imms Org ID from vaccine_master)

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Location.managingOrganization.type
DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Cardinality0...1
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
SummaryTrue
Comments

Hardcode as "Organization"

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

Organization

Mappings
  • rim: N/A
Location.managingOrganization.identifier
DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Cardinality0...1
TypeIdentifier
SummaryTrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .identifier
Location.managingOrganization.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...1
Typestring
SummaryTrue
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Location.partOf
DefinitionAnother Location of which this Location is physically a part of.
Cardinality0...1
TypeReference(Location)
Requirements

For purposes of location, display and identification, knowing which locations are located within other locations is important.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .inboundLink[typeCode=PART].source[classCode=SDLC]
Location.partOf.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality1...1
Typestring
Comments

Apply "OrgLOCparentnnn" where "nnn" to be lookup from SDL-Pano Branch table, lookup the parent HA of the location.

Mappings
  • rim: n/a
Location.partOf.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Location.partOf.reference
DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Cardinality0...1
Typestring
SummaryTrue
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Location.partOf.type
DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Cardinality0...1
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
SummaryTrue
Comments

Hardcode as "Organization"

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

Organization

Mappings
  • rim: N/A
Location.partOf.identifier
DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Cardinality1...1
TypeIdentifier
SummaryTrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .identifier
Location.partOf.identifier.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Location.partOf.identifier.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Location.partOf.identifier.use
DefinitionThe purpose of this identifier.
Cardinality0...1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)
ModifierTrue
SummaryTrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Role.code or implied by context
Location.partOf.identifier.type
DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality0...1
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)
SummaryTrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
Location.partOf.identifier.system
DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality0...1
Typeuri
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

http://www.acme.com/identifiers/patient


Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Location.partOf.identifier.value
DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality1...1
Typestring
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

123456


Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Location.partOf.identifier.period
DefinitionTime period during which identifier is/was valid for use.
Cardinality0...1
TypePeriod
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
Location.partOf.identifier.assigner
DefinitionOrganization that issued/manages the identifier.
Cardinality0...1
TypeReference(Organization)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
Location.partOf.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...1
Typestring
SummaryTrue
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Location.hoursOfOperation
DefinitionWhat days/times during a week is this location usually open.
Cardinality0...1
TypeBackboneElement
Comments

This type of information is commonly found published in directories and on websites informing customers when the facility is available.

Specific services within the location may have their own hours which could be shorter (or longer) than the locations hours.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
Location.hoursOfOperation.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Location.hoursOfOperation.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Location.hoursOfOperation.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Location.hoursOfOperation.daysOfWeek
DefinitionIndicates which days of the week are available between the start and end Times.
Cardinality0...*
Typecode
Binding

The days of the week.

DaysOfWeek (required)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
Location.hoursOfOperation.allDay
DefinitionThe Location is open all day.
Cardinality0...1
Typeboolean
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
Location.hoursOfOperation.openingTime
DefinitionTime that the Location opens.
Cardinality0...1
Typetime
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
Location.hoursOfOperation.closingTime
DefinitionTime that the Location closes.
Cardinality0...1
Typetime
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
Location.availabilityExceptions
DefinitionA description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.
Cardinality0...1
Typestring
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Location.endpoint
DefinitionTechnical endpoints providing access to services operated for the location.
Cardinality0...1
TypeReference(Endpoint)
Requirements

Organizations may have different systems at different locations that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="3df5b741-a884-4eff-824d-5ea2c271e00f" />
    <meta>
        <versionId value="9" />
        <lastUpdated value="2025-01-24T23:36:53.6457832+00:00" />
    </meta>
    <url value="http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Location" />
    <name value="Location" />
    <status value="draft" />
    <date value="2022-02-23T01:28:09.8238214+00:00" />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <mapping>
        <identity value="w5" />
        <uri value="http://hl7.org/fhir/fivews" />
        <name value="FiveWs Pattern Mapping" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="Location" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Location" />
    <derivation value="constraint" />
    <differential>
        <element id="Location">
            <path value="Location" />
            <short value="FHIR resource applies for PIR Vaccine Administered SDL" />
            <definition value="FHIR resource applies for PIR Vaccine Administered Service Delivery Location (SDL)" />
        </element>
        <element id="Location.id">
            <path value="Location.id" />
            <short value="PIR internal SDL ID + PIR internal Immz Org" />
            <definition value="PIR internal Service Delivery Location (SDL) Identifier + PIR internal Immunization Organization (Immz Org) Identifier.  SDL refers to the site where vaccine is being administered." />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="(PIR Location Id)  + &#39;org&#39; + (PIR Imms Org ID)" />
            </mapping>
            <mapping>
                <identity value="source-PIR-Unknown" />
                <map value="(UNK)  + &#39;org&#39; + (PIR Imms Org ID)" />
            </mapping>
        </element>
        <element id="Location.meta">
            <path value="Location.meta" />
            <min value="1" />
        </element>
        <element id="Location.meta.versionId">
            <path value="Location.meta.versionId" />
            <comment value="Use &#39;2025.01.1&#39; (This indicates FHIR changes on 2025-Jan)." />
        </element>
        <element id="Location.meta.lastUpdated">
            <path value="Location.meta.lastUpdated" />
            <comment value="Updated: 1. Relax the previously crossed-out elements.  2 For element ID and IDENTIFIER, remove the counter when value = UNK.  It used to be UNK1, or UNK2 or UNK3 etc., this counter is no longer needed as the associated Imms Org is now concatenated to the LOC ID (e.g. UNKorg81)." />
        </element>
        <element id="Location.meta.profile">
            <path value="Location.meta.profile" />
            <comment value="Use &#39;http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Location&#39;" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="Location.meta.security">
            <path value="Location.meta.security" />
            <max value="1" />
        </element>
        <element id="Location.meta.tag">
            <path value="Location.meta.tag" />
            <max value="1" />
        </element>
        <element id="Location.contained">
            <path value="Location.contained" />
            <max value="1" />
        </element>
        <element id="Location.identifier">
            <path value="Location.identifier" />
            <short value="PIR internal SDL ID" />
            <definition value="PIR internal Service Delivery Location (SDL) Identifier.  SDL refers to the site where vaccine is being administered." />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="Location.identifier.system">
            <path value="Location.identifier.system" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-service-delivery-location-id" />
            </mapping>
        </element>
        <element id="Location.identifier.value">
            <path value="Location.identifier.value" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR-Unknown" />
                <map value="(UNK)  + &#39;org&#39; + (PIR Imms Org ID)" />
            </mapping>
            <mapping>
                <identity value="source-PIR-known" />
                <map value="Extract from (imms.h33_vaccination_master.location_id)" />
            </mapping>
        </element>
        <element id="Location.name">
            <path value="Location.name" />
            <short value="Name of the SDL" />
            <definition value="Name of the Service Delivery Location where vaccine is being administered." />
            <comment value="SDL - Derive name from location name (imms.h33_vaccination_master.location_id)" />
        </element>
        <element id="Location.alias">
            <path value="Location.alias" />
            <max value="1" />
        </element>
        <element id="Location.type">
            <path value="Location.type" />
            <max value="1" />
        </element>
        <element id="Location.telecom">
            <path value="Location.telecom" />
            <max value="1" />
        </element>
        <element id="Location.managingOrganization">
            <path value="Location.managingOrganization" />
            <short value="Immunization Organization responsible for the SDL" />
            <definition value="The immunization organization responsible for the provisioning and upkeep of the service delivery location." />
            <min value="1" />
        </element>
        <element id="Location.managingOrganization.reference">
            <path value="Location.managingOrganization.reference" />
            <comment value="fullURL of Panorama + &#39;Organization&#39; + (PIR Imms Org ID from vaccine_master)" />
            <min value="1" />
        </element>
        <element id="Location.managingOrganization.type">
            <path value="Location.managingOrganization.type" />
            <comment value="Hardcode as &quot;Organization&quot;" />
            <fixedUri value="Organization" />
        </element>
        <element id="Location.partOf.id">
            <path value="Location.partOf.id" />
            <comment value="Apply &quot;OrgLOCparentnnn&quot; where &quot;nnn&quot; to be lookup from SDL-Pano Branch table, lookup the parent HA of the location." />
            <min value="1" />
        </element>
        <element id="Location.partOf.type">
            <path value="Location.partOf.type" />
            <comment value="Hardcode as &quot;Organization&quot;" />
            <fixedUri value="Organization" />
        </element>
        <element id="Location.partOf.identifier">
            <path value="Location.partOf.identifier" />
            <min value="1" />
        </element>
        <element id="Location.partOf.identifier.value">
            <path value="Location.partOf.identifier.value" />
            <min value="1" />
        </element>
        <element id="Location.hoursOfOperation">
            <path value="Location.hoursOfOperation" />
            <max value="1" />
        </element>
        <element id="Location.endpoint">
            <path value="Location.endpoint" />
            <max value="1" />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "3df5b741-a884-4eff-824d-5ea2c271e00f",
    "meta": {
        "versionId": "9",
        "lastUpdated": "01/24/2025 23:36:53"
    },
    "url": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Location",
    "name": "Location",
    "status": "draft",
    "date": "02/23/2022 01:28:09",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "Location",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Location",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Location",
                "path": "Location",
                "short": "FHIR resource applies for PIR Vaccine Administered SDL",
                "definition": "FHIR resource applies for PIR Vaccine Administered Service Delivery Location (SDL)"
            },
            {
                "id": "Location.id",
                "path": "Location.id",
                "short": "PIR internal SDL ID + PIR internal Immz Org",
                "definition": "PIR internal Service Delivery Location (SDL) Identifier + PIR internal Immunization Organization (Immz Org) Identifier.  SDL refers to the site where vaccine is being administered.",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "(PIR Location Id)  + 'org' + (PIR Imms Org ID)"
                    },
                    {
                        "identity": "source-PIR-Unknown",
                        "map": "(UNK)  + 'org' + (PIR Imms Org ID)"
                    }
                ]
            },
            {
                "id": "Location.meta",
                "path": "Location.meta",
                "min": 1
            },
            {
                "id": "Location.meta.versionId",
                "path": "Location.meta.versionId",
                "comment": "Use '2025.01.1' (This indicates FHIR changes on 2025-Jan)."
            },
            {
                "id": "Location.meta.lastUpdated",
                "path": "Location.meta.lastUpdated",
                "comment": "Updated: 1. Relax the previously crossed-out elements.  2 For element ID and IDENTIFIER, remove the counter when value = UNK.  It used to be UNK1, or UNK2 or UNK3 etc., this counter is no longer needed as the associated Imms Org is now concatenated to the LOC ID (e.g. UNKorg81)."
            },
            {
                "id": "Location.meta.profile",
                "path": "Location.meta.profile",
                "comment": "Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Location'",
                "min": 1,
                "max": "1"
            },
            {
                "id": "Location.meta.security",
                "path": "Location.meta.security",
                "max": "1"
            },
            {
                "id": "Location.meta.tag",
                "path": "Location.meta.tag",
                "max": "1"
            },
            {
                "id": "Location.contained",
                "path": "Location.contained",
                "max": "1"
            },
            {
                "id": "Location.identifier",
                "path": "Location.identifier",
                "short": "PIR internal SDL ID",
                "definition": "PIR internal Service Delivery Location (SDL) Identifier.  SDL refers to the site where vaccine is being administered.",
                "min": 1,
                "max": "1"
            },
            {
                "id": "Location.identifier.system",
                "path": "Location.identifier.system",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-service-delivery-location-id"
                    }
                ]
            },
            {
                "id": "Location.identifier.value",
                "path": "Location.identifier.value",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR-Unknown",
                        "map": "(UNK)  + 'org' + (PIR Imms Org ID)"
                    },
                    {
                        "identity": "source-PIR-known",
                        "map": "Extract from (imms.h33_vaccination_master.location_id)"
                    }
                ]
            },
            {
                "id": "Location.name",
                "path": "Location.name",
                "short": "Name of the SDL",
                "definition": "Name of the Service Delivery Location where vaccine is being administered.",
                "comment": "SDL - Derive name from location name (imms.h33_vaccination_master.location_id)"
            },
            {
                "id": "Location.alias",
                "path": "Location.alias",
                "max": "1"
            },
            {
                "id": "Location.type",
                "path": "Location.type",
                "max": "1"
            },
            {
                "id": "Location.telecom",
                "path": "Location.telecom",
                "max": "1"
            },
            {
                "id": "Location.managingOrganization",
                "path": "Location.managingOrganization",
                "short": "Immunization Organization responsible for the SDL",
                "definition": "The immunization organization responsible for the provisioning and upkeep of the service delivery location.",
                "min": 1
            },
            {
                "id": "Location.managingOrganization.reference",
                "path": "Location.managingOrganization.reference",
                "comment": "fullURL of Panorama + 'Organization' + (PIR Imms Org ID from vaccine_master)",
                "min": 1
            },
            {
                "id": "Location.managingOrganization.type",
                "path": "Location.managingOrganization.type",
                "comment": "Hardcode as \"Organization\"",
                "fixedUri": "Organization"
            },
            {
                "id": "Location.partOf.id",
                "path": "Location.partOf.id",
                "comment": "Apply \"OrgLOCparentnnn\" where \"nnn\" to be lookup from SDL-Pano Branch table, lookup the parent HA of the location.",
                "min": 1
            },
            {
                "id": "Location.partOf.type",
                "path": "Location.partOf.type",
                "comment": "Hardcode as \"Organization\"",
                "fixedUri": "Organization"
            },
            {
                "id": "Location.partOf.identifier",
                "path": "Location.partOf.identifier",
                "min": 1
            },
            {
                "id": "Location.partOf.identifier.value",
                "path": "Location.partOf.identifier.value",
                "min": 1
            },
            {
                "id": "Location.hoursOfOperation",
                "path": "Location.hoursOfOperation",
                "max": "1"
            },
            {
                "id": "Location.endpoint",
                "path": "Location.endpoint",
                "max": "1"
            }
        ]
    }
}