Pan-Canadian Care Service Directory

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

Constraints

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

language

0..1

codeBinding

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

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Constraints

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

text

0..1

Narrative

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?

contained

0..*

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

extension

0..*

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

http://fhir.infoway-inforoute.ca/ca-ext/StructureDefinition/location-AcceptingNewPatients

Slicing

Unordered, Open, by url(Value)

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

acceptingnewpatients

0..*

Extension(Complex)

Element id

Location.extension:acceptingnewpatients

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

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
rim: n/a

modifierExtension

?! C

0..0

There are no (further) constraints on this element

Element id

Location.modifierExtension

Short description

Extension

Definition

An Extension

Data type

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

identifier

SO Σ

0..*

Identifier

Element 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

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

0..1

There are no (further) constraints on this element

Element id

Location.identifier.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

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Location.identifier.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

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Location.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

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.

Data type

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Constraints

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

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Location.identifier.type

Short description

Description of identifier

Definition

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

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.

Data type

Identifier Type Codes (extensible)

Binding

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

Constraints

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

system

SO Σ

1..1

Element id

Location.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

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

mustSupport element identified within the CA Core profile.

Data type

Constraints

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

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

value

SO Σ

1..1

Element id

Location.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

mustSupport element identified within the CA Core profile.

Data type

Constraints

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

Examples
General

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

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

period

0..1

There are no (further) constraints on this element

Element id

Location.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Constraints

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

assigner

0..1

Reference(Organization)

There are no (further) constraints on this element

Element id

Location.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

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.

Data type

Reference(Organization)

Constraints

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

status

SO Σ ?!

1..1

codeBinding

Element 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

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

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

operationalStatus

0..1

CodingBinding

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

name

SO Σ

1..1

Element 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

Constraints

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

Mappings

rim: .name

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

alias

0..*

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

Constraints

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

Mappings

rim: .name

description

0..1

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

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

codeBinding

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

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

type

SO Σ

2..*

CodeableConceptBinding

Element id

Location.type

Short description

One type must be set to: https://profiles.ihe.net/ITI/mCSD/CodeSystem/IHE.mCSD.Organization.Location.Types#facility

Definition

One type must be set to: https://profiles.ihe.net/ITI/mCSD/CodeSystem/IHE.mCSD.Organization.Location.Types#facility

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

v3.ServiceDeliveryLocationRoleType (extensible)

Slicing

Unordered, Open, by $this(Value)

Binding

Indicates the type of function performed at the location.

Constraints

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

Mappings

w5: FiveWs.class
rim: .code

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

facility

1..1

CodeableConceptBindingPattern

There are no (further) constraints on this element

Element id

Location.type:facility

Short description

A code that describes the type of Location.

Definition

A code that describes the type of Location.

Data type

v3.ServiceDeliveryLocationRoleType (extensible)

Binding

Indicates the type of function performed at the location.

Constraints

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

Pattern

{
  "coding": [
    {
      "system": "https://profiles.ihe.net/ITI/mCSD/CodeSystem/IHE.mCSD.Organization.Location.Types",
      "code": "facility"
    }
  ]
}

Mappings

w5: FiveWs.class
rim: .code

service

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Location.type:service

Short description

A code that describes the type of Location.

Definition

A code that describes the type of Location.

Data type

v3.ServiceDeliveryLocationRoleType (required)

Binding

Constraints

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

Mappings

w5: FiveWs.class
rim: .code

telecom

0..*

ContactPoint

Element 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 Core.

Data type

ContactPoint

Constraints

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

Mappings

rim: .telecom

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

0..1

There are no (further) constraints on this element

Element id

Location.telecom.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

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Location.telecom.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

system

SO Σ C

0..1

codeBinding

Element id

Location.telecom.system

Short description

phone | fax | email | pager | url | sms | other

Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Comments

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

Data type

Binding

Telecommunications form for contact point.

ContactPointSystem (required)

Conditions

The cardinality or value of this element may be affected by these constraints: cpt-2

Constraints

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

Mappings

v2: XTN.3
rim: ./scheme
servd: ./ContactPointType

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

value

SO Σ

1..1

Element id

Location.telecom.value

Short description

The actual contact point details

Definition

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Comments

Identified as a requirement and mustSupport element from the CA Core

Data type

Constraints

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

Mappings

v2: XTN.1 (or XTN.12)
rim: ./url
servd: ./Value

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Location.telecom.use

Short description

home | work | temp | old | mobile - purpose of this contact point

Definition

Identifies the purpose for the contact point.

Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Data type

Binding

Use of contact point.

ContactPointUse (required)

Constraints

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

Mappings

v2: XTN.2 - but often indicated by field
rim: unique(./use)
servd: ./ContactPointPurpose

rank

0..1

positiveInt

There are no (further) constraints on this element

Element id

Location.telecom.rank

Short description

Specify preferred order of use (1 = highest)

Definition

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Data type

positiveInt

Constraints

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

Mappings

v2: n/a
rim: n/a

period

0..1

There are no (further) constraints on this element

Element id

Location.telecom.period

Short description

Time period when the contact point was/is in use

Definition

Time period when the contact point was/is in use.

Data type

Constraints

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

Mappings

v2: N/A
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

address

0..1

Address

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

Identified as a query requirement for searching for provider associated by role in the CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated. <br> Please use this element for role-based searches for provider.</br>

Data type

Address

Constraints

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

Mappings

rim: .addr

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

0..1

There are no (further) constraints on this element

Element id

Location.address.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

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Location.address.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Location.address.use

Short description

home | work | temp | old | billing - purpose of this address

Definition

The purpose of this address.

Requirements

Allows an appropriate address to be chosen from a list of many.

Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Data type

Binding

The use of an address.

AddressUse (required)

Constraints

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

Examples
General

home

Mappings

v2: XAD.7
rim: unique(./use)
servd: ./AddressPurpose

type

0..1

codeBinding

There are no (further) constraints on this element

Element id

Location.address.type

Short description

postal | physical | both

Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Comments

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Data type

Binding

The type of an address (physical / postal).

AddressType (required)

Constraints

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

Examples
General

both

Mappings

v2: XAD.18
rim: unique(./use)
vcard: address type parameter

text

0..1

There are no (further) constraints on this element

Element id

Location.address.text

Short description

Text representation of the address

Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Data type

Constraints

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

Examples
General

137 Nowhere Street, Erewhon 9132

Mappings

v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
rim: ./formatted
vcard: address label parameter

line

SO Σ

0..*

Element id

Location.address.line

Short description

Street name, number, direction & P.O. Box etc.

Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

Comments

Identified as a query requirement for searching for provider associated by role in the CapabilityStatement.

Data type

Constraints

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

Examples
General

137 Nowhere Street

Mappings

v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
rim: AD.part[parttype = AL]
vcard: street
servd: ./StreetAddress (newline delimitted)

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

city

SO Σ

1..1

Element id

Location.address.city

Short description

Name of city, town etc.

Alternate names

Municpality

Definition

The name of the city, town, suburb, village or other community or delivery center.

Comments

Identified as a query requirement for searching for provider associated by role in the CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated. This element can be used in a chain search (query) for providers in a specific province or city.

Data type

Constraints

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

Examples
General

Erewhon

Mappings

v2: XAD.3
rim: AD.part[parttype = CTY]
vcard: locality
servd: ./Jurisdiction

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

district

0..1

There are no (further) constraints on this element

Element id

Location.address.district

Short description

District name (aka county)

Alternate names

County

Definition

The name of the administrative area (county).

Comments

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Data type

Constraints

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

Examples
General

Madison

Mappings

v2: XAD.9
rim: AD.part[parttype = CNT | CPA]

state

SO Σ

0..1

Element id

Location.address.state

Short description

Sub-unit of country (abbreviations ok)

Alternate names

Province, Territory

Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

Comments

Identified as a query requirement for searching for provider associated by role in the CapabilityStatement. This element can be used in a chain search (query) for providers in a specific province or city.

Data type

Constraints

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

Mappings

v2: XAD.4
rim: AD.part[parttype = STA]
vcard: region
servd: ./Region

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

postalCode

SO Σ

0..1

Element id

Location.address.postalCode

Short description

Postal code for area

Alternate names

Zip

Definition

A postal code designating a region defined by the postal service.

Comments

Identified as a query requirement for searching for provider associated by role in the CapabilityStatement.

Data type

Constraints

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

Examples
General

Mappings

v2: XAD.5
rim: AD.part[parttype = ZIP]
vcard: code
servd: ./PostalIdentificationCode

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

country

SO Σ

0..1

Element id

Location.address.country

Short description

Country (e.g. can be ISO 3166 2 or 3 letter code)

Definition

Country - a nation as commonly understood or generally accepted.

Comments

Identified as a query requirement for searching for provider associated by role in the CapabilityStatement. MustSupport applied to be in alignment with CA:eReC.

Data type

Constraints

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

Mappings

v2: XAD.6
rim: AD.part[parttype = CNT]
vcard: country
servd: ./Country

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

period

0..1

There are no (further) constraints on this element

Element id

Location.address.period

Short description

Time period when address was/is in use

Definition

Time period when address was/is in use.

Requirements

Allows addresses to be placed in historical context.

Data type

Constraints

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

Examples
General

{
  "start": "2010-03-23",
  "end": "2010-07-01"
}

Mappings

v2: XAD.12 / XAD.13 + XAD.14
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

physicalType

0..1

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

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

position

0..1

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

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

0..1

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

Mappings

rim: n/a

extension

0..*

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

Comments

Data type

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

Σ ?! C

0..*

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

Data type

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

longitude

1..1

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

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)

latitude

1..1

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

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)

altitude

0..1

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

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)

managingOrganization

SO Σ

1..1

Element id

Location.managingOrganization

Short description

The reference to the mCSD Organization resource for this facility.

Definition

The reference to the mCSD Organization resource for this facility.

Requirements

Need to know who manages 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

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]

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

partOf

0..1

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

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]

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

hoursOfOperation

0..*

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

Constraints

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

Mappings

rim: .effectiveTime

0..1

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

Mappings

rim: n/a

extension

0..*

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

Comments

Data type

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

Σ ?! C

0..*

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

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

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

daysOfWeek

0..*

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

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

allDay

0..1

boolean

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

openingTime

0..1

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

Constraints

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

Mappings

rim: .effectiveTime

closingTime

0..1

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

Constraints

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

Mappings

rim: .effectiveTime

availabilityExceptions

0..1

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

http://fhir.infoway-inforoute.ca/ca-ext/StructureDefinition/location-AcceptingNewPatients

Constraints

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

Mappings

rim: n/a

endpoint

0..*

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

FacilityLocation (Location)

MCSDFacilityLocation

acceptingnewpatients

Extension(Complex)

There are no (further) constraints on this element

Element id

Location.extension:acceptingnewpatients

Data type

Extension(Complex)

Extension URL

identifier

Element id

Location.identifier

Comments

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

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

system

1..1

Element id

Location.identifier.system

Comments

mustSupport element identified within the CA Core profile.

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

value

1..1

Element id

Location.identifier.value

Comments

mustSupport element identified within the CA Core profile.

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

status

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.

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

name

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.

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

type

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.

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

telecom

Element id

Location.telecom

Comments

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

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

system

Element id

Location.telecom.system

Comments

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

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

value

1..

Element id

Location.telecom.value

Comments

Identified as a requirement and mustSupport element from the CA Core

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

address

Element id

Location.address

Comments

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

line

Element id

Location.address.line

Comments

Identified as a query requirement for searching for provider associated by role in the CapabilityStatement.

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

city

1..

Element id

Location.address.city

Comments

Identified as a query requirement for searching for provider associated by role in the CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated. This element can be used in a chain search (query) for providers in a specific province or city.

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

state

Element id

Location.address.state

Comments

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

postalCode

Element id

Location.address.postalCode

Comments

Identified as a query requirement for searching for provider associated by role in the CapabilityStatement.

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

country

Element id

Location.address.country

Comments

Identified as a query requirement for searching for provider associated by role in the CapabilityStatement. MustSupport applied to be in alignment with CA:eReC.

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

managingOrganization

Element id

Location.managingOrganization

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

Obligations

Code	Actor
SHALL:able-to-populate SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client

partOf

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