Visit the HL7 website
Visit the FHIR website

Pan-Canadian Care Service Directory (1.0.0-DFT)

1.0.0-DFT   Canada flag
  • Table-of-Contents
  • Home
  • Business Context
    • Guidance
    • Usage Highlights
    • Use Cases
    • Guide Considerations
  • Technical Context
    • Overview
    • Background
    • Roles Description
    • Model Diagrams
    • Queries
    • Bulk Export
  • FHIR Artifacts
    • Endpoint
    • Extension DeliveryMethod
    • Extension UsageLicense
    • FacilityLocation
    • FacilityOrganization
    • HealthcareService
    • JurisdictionLocation
    • JurisdictionOrganization
    • Location
    • LocationDistance
    • Organization
    • OrganizationAffiliation
    • Practitioner
    • PractitionerRole
    • Capability Statements
    • Operations
    • Example - Queries
    • Example - Resources
  • Change Log
    1. Table-of-Contents
    2. FHIR Artifacts
    3. Location

DFT - The specification is currently in ballot review and subject to change. It is not ready for limited roll-out or production level use. For a full list of available versions, see the Directory of published versions

Location

Links

Profile

CA-CSD-Location

Derived from

https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.Location

Examples

ca-csd-example-location

Description

A Location is a physical place where care can be delivered. Examples of Locations include buildings, wards, rooms, and vehicles. A Location can also represent a jurisdiction such as a health region or zones. A Location will have attributes such as a unique identifier, and may have attributes such as hours of operation, geographic information (address, geocode), hours operation. A Location may be associated with an Organization. A Location may also be in a hierarchy with other Locations.

References to this resource

HealthcareService, Location, Location with Distance, FacilityLocation, JurisdictionLocation, OrganizationAffiliation, PractitionerRole

Resource Content

  • Tree view
  • Overview
  • XML
  • JSON
LocationIMCSDLocation
There are no (further) constraints on this element
Element id

Location

Short description

Details and position information for a physical place

Definition

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

Data type

MCSDLocation

Constraints
  • 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]
idΣ0..1id
There are no (further) constraints on this element
Element id

Location.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

id

metaΣ0..1Meta
There are no (further) constraints on this element
Element id

Location.meta

Short description

Metadata about the resource

Definition

The 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.

Data type

Meta

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
implicitRulesΣ ?!0..0uri
There are no (further) constraints on this element
Element id

Location.implicitRules

Short description

A set of rules under which this content was created

Definition

A 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.

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.

Data type

uri

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
language0..1codeBinding
There are no (further) constraints on this element
Element id

Location.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

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).

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
text0..1Narrative
There are no (further) constraints on this element
Element id

Location.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A 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.

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.

Data type

Narrative

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
contained0..*Resource
There are no (further) constraints on this element
Element id

Location.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These 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.

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.

Data type

Resource

Mappings
  • rim: N/A
extensionI0..*Extension
There are no (further) constraints on this element
Element id

Location.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May 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.

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.

Data type

Extension

Constraints
  • 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
modifierExtension?! I0..0Extension
There are no (further) constraints on this element
Element id

Location.modifierExtension

Short description

Extension

Definition

An Extension

Data type

Extension

Constraints
  • 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()
identifierS Σ0..*IdentifierElement id

Location.identifier

Short description

Unique code or number identifying the location to its users

Definition

Unique code or number identifying the location to its users.

Requirements

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

Comments

Identified as a query requirement through mCSD CapabilityStatement, and mustSupport element in the CA Baseline.

Data type

Identifier

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • rim: .id
statusS Σ ?!1..1codeBindingElement id

Location.status

Short description

The status code of the Location.

Definition

The status code of the Location: active | suspended | inactive

Comments

Identified as a query requirement through mCSD CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated.

Data type

code

Binding

Indicates whether the location is still in use.

LocationStatus (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.status
  • rim: .statusCode
operationalStatusΣ0..1CodingBinding
There are no (further) constraints on this element
Element id

Location.operationalStatus

Short description

The operational status of the location (typically only for a bed/room)

Definition

The 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.

Data type

Coding

Binding

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

v2.0116 (preferred)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.status
  • rim: n/a
nameS Σ1..1stringElement id

Location.name

Short description

The name of the Location.

Definition

The name of the Location.

Comments

Identified as a query requirement through mCSD CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .name
alias0..*string
There are no (further) constraints on this element
Element id

Location.alias

Short description

A list of alternate names that the location is known as, or was known as, in the past

Definition

A list of alternate names that the location is known as, or was known as, in the past.

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.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .name
descriptionΣ0..1string
There are no (further) constraints on this element
Element id

Location.description

Short description

Additional details about the location that could be displayed as further information to identify the location beyond its name

Definition

Description of the Location, which helps in finding or referencing the place.

Requirements

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

Data type

string

Constraints
  • 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
modeΣ0..1codeBinding
There are no (further) constraints on this element
Element id

Location.mode

Short description

instance | kind

Definition

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

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.

Data type

code

Binding

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

LocationMode (required)

Constraints
  • 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
typeS Σ1..*CodeableConceptBindingElement id

Location.type

Short description

A code that describes the type of Location.

Definition

A code that describes the type of Location.

Comments

Identified as a query requirement through mCSD CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated.

Data type

CodeableConcept

Binding

Indicates the type of function performed at the location.

v3.ServiceDeliveryLocationRoleType (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.class
  • rim: .code
telecomS0..*ContactPointElement id

Location.telecom

Short description

Contact details of the location

Definition

The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.

Comments

Identified as a requirement and mustSupport element from the CA baseline.

Data type

ContactPoint

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .telecom
address0..1Address
There are no (further) constraints on this element
Element id

Location.address

Short description

Physical location

Definition

Physical location.

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.

Data type

Address

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .addr
physicalTypeΣ0..1CodeableConcept
There are no (further) constraints on this element
Element id

Location.physicalType

Short description

A code that describes the physical form of the Location.

Definition

A code that describes the physical form of the Location.

Requirements

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

Data type

CodeableConcept

Binding

Physical form of the location.

LocationType (example)

Constraints
  • 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
position0..1BackboneElement
There are no (further) constraints on this element
Element id

Location.position

Short description

The absolute geographic location

Definition

The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

Requirements

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

Data type

BackboneElement

Constraints
  • 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
id0..1string
There are no (further) constraints on this element
Element id

Location.position.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionI0..*Extension
There are no (further) constraints on this element
Element id

Location.position.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May 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.

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.

Data type

Extension

Constraints
  • 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
modifierExtensionΣ ?! I0..*Extension
There are no (further) constraints on this element
Element id

Location.position.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May 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).

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.

Data type

Extension

Constraints
  • 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
longitude1..1decimal
There are no (further) constraints on this element
Element id

Location.position.longitude

Short description

Longitude with WGS84 datum

Definition

Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).

Data type

decimal

Constraints
  • 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)
latitude1..1decimal
There are no (further) constraints on this element
Element id

Location.position.latitude

Short description

Latitude with WGS84 datum

Definition

Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).

Data type

decimal

Constraints
  • 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)
altitude0..1decimal
There are no (further) constraints on this element
Element id

Location.position.altitude

Short description

Altitude with WGS84 datum

Definition

Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).

Data type

decimal

Constraints
  • 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)
managingOrganizationS Σ0..1Reference(Organization)Element id

Location.managingOrganization

Short description

Organization responsible for provisioning and upkeep

Definition

The organization responsible for the provisioning and upkeep of the location.

Requirements

Need to know who manages the location.

Comments

Identified as a query requirement through mCSD CapabilityStatement.

Data type

Reference(Organization)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .scopingEntity[classCode=ORG determinerKind=INSTANCE]
partOfS0..1Reference(Location)Element id

Location.partOf

Short description

Another Location this one is physically a part of

Definition

Another Location of which this Location is physically a part of.

Requirements

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

Comments

Identified as a query requirement through mCSD CapabilityStatement. Allows the search to return the location without having to go through the practitionerRole resource.

Data type

Reference(Location)

Constraints
  • 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]
hoursOfOperation0..*BackboneElement
There are no (further) constraints on this element
Element id

Location.hoursOfOperation

Short description

What days/times during a week is this location usually open

Definition

What days/times during a week is this location usually open.

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.

Data type

BackboneElement

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
id0..1string
There are no (further) constraints on this element
Element id

Location.hoursOfOperation.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionI0..*Extension
There are no (further) constraints on this element
Element id

Location.hoursOfOperation.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May 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.

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.

Data type

Extension

Constraints
  • 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
modifierExtensionΣ ?! I0..*Extension
There are no (further) constraints on this element
Element id

Location.hoursOfOperation.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May 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).

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.

Data type

Extension

Constraints
  • 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
daysOfWeek0..*codeBinding
There are no (further) constraints on this element
Element id

Location.hoursOfOperation.daysOfWeek

Short description

mon | tue | wed | thu | fri | sat | sun

Definition

Indicates which days of the week are available between the start and end Times.

Data type

code

Binding

The days of the week.

DaysOfWeek (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
allDay0..1boolean
There are no (further) constraints on this element
Element id

Location.hoursOfOperation.allDay

Short description

The Location is open all day

Definition

The Location is open all day.

Data type

boolean

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
openingTime0..1time
There are no (further) constraints on this element
Element id

Location.hoursOfOperation.openingTime

Short description

Time that the Location opens

Definition

Time that the Location opens.

Data type

time

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
closingTime0..1time
There are no (further) constraints on this element
Element id

Location.hoursOfOperation.closingTime

Short description

Time that the Location closes

Definition

Time that the Location closes.

Data type

time

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
availabilityExceptions0..1string
There are no (further) constraints on this element
Element id

Location.availabilityExceptions

Short description

Description of availability exceptions

Definition

A 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.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
endpoint0..*Reference(Endpoint)
There are no (further) constraints on this element
Element id

Location.endpoint

Short description

Technical endpoints providing access to services operated for the location

Definition

Technical endpoints providing access to services operated for the location.

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.

Data type

Reference(Endpoint)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
LocationMCSDLocation
There are no (further) constraints on this element
Data type

MCSDLocation

identifierS
There are no (further) constraints on this element
Element id

Location.identifier

Comments

Identified as a query requirement through mCSD CapabilityStatement, and mustSupport element in the CA Baseline.

statusS
There are no (further) constraints on this element
Element id

Location.status

Comments

Identified as a query requirement through mCSD CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated.

nameS
There are no (further) constraints on this element
Element id

Location.name

Comments

Identified as a query requirement through mCSD CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated.

typeS
There are no (further) constraints on this element
Element id

Location.type

Comments

Identified as a query requirement through mCSD CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated.

telecomS
There are no (further) constraints on this element
Element id

Location.telecom

Comments

Identified as a requirement and mustSupport element from the CA baseline.

managingOrganizationS
There are no (further) constraints on this element
Element id

Loction.managingOrganization

Comments

Identified as a query requirement through mCSD CapabilityStatement.

partOfSReference(Location)
There are no (further) constraints on this element
Element id

Location.partOf

Comments

Identified as a query requirement through mCSD CapabilityStatement. Allows the search to return the location without having to go through the practitionerRole resource.

Data type

Reference(Location)

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="CA-CSD-Location" />
    <extension url="http://hl7.org/fhir/StructureDefinition/obligation">
        <extension url="code">
            <valueCode value="SHALL:able-to-populate" />
        </extension>
        <extension url="code">
            <valueCode value="SHOULD:populate" />
        </extension>
        <extension url="elementId">
            <valueString value="Location.identifier" />
        </extension>
        <extension url="elementId">
            <valueString value="Location.status" />
        </extension>
        <extension url="elementId">
            <valueString value="Location.name" />
        </extension>
        <extension url="elementId">
            <valueString value="Location.type" />
        </extension>
        <extension url="elementId">
            <valueString value="Location.telecom" />
        </extension>
        <extension url="elementId">
            <valueString value="Location.managingOrganization" />
        </extension>
        <extension url="elementId">
            <valueString value="Location.partOf" />
        </extension>
        <extension url="actor">
            <valueCanonical value="http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server" />
        </extension>
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/obligation">
        <extension url="code">
            <valueCode value="SHALL:no-error" />
        </extension>
        <extension url="elementId">
            <valueString value="Location.identifier" />
        </extension>
        <extension url="elementId">
            <valueString value="Location.status" />
        </extension>
        <extension url="elementId">
            <valueString value="Location.name" />
        </extension>
        <extension url="elementId">
            <valueString value="Location.type" />
        </extension>
        <extension url="elementId">
            <valueString value="Location.telecom" />
        </extension>
        <extension url="elementId">
            <valueString value="Location.managingOrganization" />
        </extension>
        <extension url="elementId">
            <valueString value="Location.partOf" />
        </extension>
        <extension url="actor">
            <valueCanonical value="http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client" />
        </extension>
    </extension>
    <url value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Location" />
    <name value="Location" />
    <status value="draft" />
    <description value="A Location is a physical place where care can be delivered. Examples of Locations include buildings, wards, rooms, and vehicles.  A Location can also represent a jurisdiction such as a health region or zones.  A Location will have attributes such as a unique identifier, and may have attributes such as hours of operation, geographic information (address, geocode), hours operation. A Location may be associated with an Organization. A Location may also be in a hierarchy with other Locations." />
    <copyright value="Copyright &#169; 2024+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy)." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Location" />
    <baseDefinition value="https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.Location" />
    <derivation value="constraint" />
    <differential>
        <element id="Location.identifier">
            <path value="Location.identifier" />
            <comment value="Identified as a query requirement through mCSD CapabilityStatement, and mustSupport element in the CA Baseline." />
            <mustSupport value="true" />
        </element>
        <element id="Location.status">
            <path value="Location.status" />
            <comment value="Identified as a query requirement through mCSD CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated." />
            <mustSupport value="true" />
        </element>
        <element id="Location.name">
            <path value="Location.name" />
            <comment value="Identified as a query requirement through mCSD CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated." />
            <mustSupport value="true" />
        </element>
        <element id="Location.type">
            <path value="Location.type" />
            <comment value="Identified as a query requirement through mCSD CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated." />
            <mustSupport value="true" />
        </element>
        <element id="Location.telecom">
            <path value="Location.telecom" />
            <comment value="Identified as a requirement and mustSupport element from the CA baseline." />
            <mustSupport value="true" />
        </element>
        <element id="Loction.managingOrganization">
            <path value="Location.managingOrganization" />
            <comment value="Identified as a query requirement through mCSD CapabilityStatement." />
            <mustSupport value="true" />
        </element>
        <element id="Location.partOf">
            <path value="Location.partOf" />
            <comment value="Identified as a query requirement through mCSD CapabilityStatement. Allows the search to return the location without having to go through the practitionerRole resource." />
            <type>
                <code value="Reference" />
                <targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Location" />
            </type>
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "CA-CSD-Location",
    "extension":  [
        {
            "extension":  [
                {
                    "url": "code",
                    "valueCode": "SHALL:able-to-populate"
                },
                {
                    "url": "code",
                    "valueCode": "SHOULD:populate"
                },
                {
                    "url": "elementId",
                    "valueString": "Location.identifier"
                },
                {
                    "url": "elementId",
                    "valueString": "Location.status"
                },
                {
                    "url": "elementId",
                    "valueString": "Location.name"
                },
                {
                    "url": "elementId",
                    "valueString": "Location.type"
                },
                {
                    "url": "elementId",
                    "valueString": "Location.telecom"
                },
                {
                    "url": "elementId",
                    "valueString": "Location.managingOrganization"
                },
                {
                    "url": "elementId",
                    "valueString": "Location.partOf"
                },
                {
                    "url": "actor",
                    "valueCanonical": "http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server"
                }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
        },
        {
            "extension":  [
                {
                    "url": "code",
                    "valueCode": "SHALL:no-error"
                },
                {
                    "url": "elementId",
                    "valueString": "Location.identifier"
                },
                {
                    "url": "elementId",
                    "valueString": "Location.status"
                },
                {
                    "url": "elementId",
                    "valueString": "Location.name"
                },
                {
                    "url": "elementId",
                    "valueString": "Location.type"
                },
                {
                    "url": "elementId",
                    "valueString": "Location.telecom"
                },
                {
                    "url": "elementId",
                    "valueString": "Location.managingOrganization"
                },
                {
                    "url": "elementId",
                    "valueString": "Location.partOf"
                },
                {
                    "url": "actor",
                    "valueCanonical": "http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client"
                }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
        }
    ],
    "url": "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Location",
    "name": "Location",
    "status": "draft",
    "description": "A Location is a physical place where care can be delivered. Examples of Locations include buildings, wards, rooms, and vehicles.  A Location can also represent a jurisdiction such as a health region or zones.  A Location will have attributes such as a unique identifier, and may have attributes such as hours of operation, geographic information (address, geocode), hours operation. A Location may be associated with an Organization. A Location may also be in a hierarchy with other Locations.",
    "copyright": "Copyright © 2024+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy).",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Location",
    "baseDefinition": "https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.Location",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Location.identifier",
                "path": "Location.identifier",
                "comment": "Identified as a query requirement through mCSD CapabilityStatement, and mustSupport element in the CA Baseline.",
                "mustSupport": true
            },
            {
                "id": "Location.status",
                "path": "Location.status",
                "comment": "Identified as a query requirement through mCSD CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated.",
                "mustSupport": true
            },
            {
                "id": "Location.name",
                "path": "Location.name",
                "comment": "Identified as a query requirement through mCSD CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated.",
                "mustSupport": true
            },
            {
                "id": "Location.type",
                "path": "Location.type",
                "comment": "Identified as a query requirement through mCSD CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated.",
                "mustSupport": true
            },
            {
                "id": "Location.telecom",
                "path": "Location.telecom",
                "comment": "Identified as a requirement and mustSupport element from the CA baseline.",
                "mustSupport": true
            },
            {
                "id": "Loction.managingOrganization",
                "path": "Location.managingOrganization",
                "comment": "Identified as a query requirement through mCSD CapabilityStatement.",
                "mustSupport": true
            },
            {
                "id": "Location.partOf",
                "path": "Location.partOf",
                "comment": "Identified as a query requirement through mCSD CapabilityStatement. Allows the search to return the location without having to go through the practitionerRole resource.",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Location"
                        ]
                    }
                ],
                "mustSupport": true
            }
        ]
    }
}

Terminology bindings (Differential)

Terminology bindings (Snapshot)

PathConformanceValueSet
Location.languagepreferredhttp://hl7.org/fhir/ValueSet/languages
Location.statusrequiredhttp://hl7.org/fhir/ValueSet/location-status|4.0.1
Location.operationalStatuspreferredhttp://terminology.hl7.org/ValueSet/v2-0116
Location.moderequiredhttp://hl7.org/fhir/ValueSet/location-mode|4.0.1
Location.typeextensiblehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.physicalTypeexamplehttp://hl7.org/fhir/ValueSet/location-physical-type
Location.hoursOfOperation.daysOfWeekrequiredhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1
PathConformanceValueSet
Location.languagepreferredhttp://hl7.org/fhir/ValueSet/languages
Location.statusrequiredhttp://hl7.org/fhir/ValueSet/location-status|4.0.1
Location.operationalStatuspreferredhttp://terminology.hl7.org/ValueSet/v2-0116
Location.moderequiredhttp://hl7.org/fhir/ValueSet/location-mode|4.0.1
Location.typeextensiblehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.physicalTypeexamplehttp://hl7.org/fhir/ValueSet/location-physical-type
Location.hoursOfOperation.daysOfWeekrequiredhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1

Constraints

Obligations

ObligationsActorElement
SHALL:able-to-populate; SHOULD:populatehttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/serverLocation.identifier; Location.status; Location.name; Location.type; Location.telecom; Location.managingOrganization; Location.partOf
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/clientLocation.identifier; Location.status; Location.name; Location.type; Location.telecom; Location.managingOrganization; Location.partOf

Table of Contents | IG © based on FHIR R4 | Package package:ca.infoway.io.ca-csd@1.0.3-DFT | Version History
HL7® and FHIR® are the registered trademarks of Health Level Seven International