Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: CareConnect-Location-1 - Detailed Descriptions

Draft as of 2018-11-05

Definitions for the CareConnect-Location-1 resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. Location
2. Location.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
SlicingThis element introduces a set of slices on Location.identifier. The slices are unordered and Open at End, and can be differentiated using the following discriminators:
  • value @ system
3. Location.identifier:odsSiteCode
SliceNameodsSiteCode
Definition

ODS Site code to identify the organisation at site level.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
4. Location.identifier:odsSiteCode.system
Control1..?
Fixed Valuehttps://fhir.nhs.uk/Id/ods-site-code
5. Location.identifier:odsSiteCode.value
Control1..?
6. Location.identifier:odsSiteCode.assigner
Control0..?
TypeReference(CareConnect-Organization-1)
7. Location.managingOrganization
TypeReference(CareConnect-Organization-1|Organization)
8. Location.partOf
TypeReference(CareConnect-Location-1|Location)

Guidance on how to interpret the contents of this table can be found here.

1. Location
Definition

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

Control0..*
InvariantsDefined on this element
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty())
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 (: contained.where(('#'+id in %resource.descendants().reference).not()).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())
2. Location.implicitRules
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.

Control0..1
Typeuri
Is Modifiertrue
Summarytrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

3. Location.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

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

4. Location.identifier
Definition

Unique code or number identifying the location to its users.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
Requirements

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

SlicingThis element introduces a set of slices on Location.identifier. The slices are unordered and Open at End, and can be differentiated using the following discriminators:
  • value @ system
5. Location.identifier:odsSiteCode
SliceNameodsSiteCode
Definition

ODS Site code to identify the organisation at site level.

Unique code or number identifying the location to its users.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1*
TypeIdentifier
Summarytrue
Requirements

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

6. Location.identifier:odsSiteCode.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue
Summarytrue
Requirements

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

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

7. Location.identifier:odsSiteCode.system
Definition

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

Control10..1
Typeuri
Summarytrue
Requirements

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

Fixed Valuehttps://fhir.nhs.uk/Id/ods-site-code
Example
General:http://www.acme.com/identifiers/patient
8. Location.identifier:odsSiteCode.value
Definition

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

Control10..1
Typestring
Summarytrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Example
General:123456
9. Location.identifier:odsSiteCode.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(CareConnect-Organization-1|Organization)
Summarytrue
Comments

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

10. Location.status
Definition

The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.

Control0..1
BindingThe codes SHALL be taken from LocationStatus

Indicates whether the location is still in use.

Typecode
Is Modifiertrue
Summarytrue
Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

11. Location.mode
Definition

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

Control0..1
BindingThe codes SHALL be taken from LocationMode

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

Typecode
Is Modifiertrue
Summarytrue
Requirements

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

Comments

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

12. Location.managingOrganization
Definition

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

Control0..1
TypeReference(CareConnect-Organization-1|Organization)
Summarytrue
Requirements

Need to know who manages the location.

Comments

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

13. Location.partOf
Definition

Another Location which this Location is physically part of.

Control0..1
TypeReference(CareConnect-Location-1|Location)
Requirements

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

Guidance on how to interpret the contents of this table can be found here.

1. Location
Definition

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

Control0..*
2. Location.id
Definition

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

Control0..1
Typeid
Summarytrue
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.

3. Location.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
Summarytrue
4. Location.implicitRules
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.

Control0..1
Typeuri
Is Modifiertrue
Summarytrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

5. Location.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable A human language
Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
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).

6. Location.text
Definition

A human-readable narrative that contains a summary of the resource, and may 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.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

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

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

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

8. Location.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

9. Location.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

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

10. Location.identifier
Definition

Unique code or number identifying the location to its users.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
Requirements

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

SlicingThis element introduces a set of slices on Location.identifier. The slices are unordered and Open at End, and can be differentiated using the following discriminators:
  • value @ system
11. Location.identifier:odsSiteCode
SliceNameodsSiteCode
Definition

ODS Site code to identify the organisation at site level.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Summarytrue
Requirements

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

12. Location.identifier:odsSiteCode.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
13. Location.identifier:odsSiteCode.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Location.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
14. Location.identifier:odsSiteCode.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Summarytrue
Requirements

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

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

15. Location.identifier:odsSiteCode.type
Definition

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

Control0..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Summarytrue
Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

16. Location.identifier:odsSiteCode.system
Definition

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

Control1..1
Typeuri
Summarytrue
Requirements

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

Fixed Valuehttps://fhir.nhs.uk/Id/ods-site-code
Example
General:http://www.acme.com/identifiers/patient
17. Location.identifier:odsSiteCode.value
Definition

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

Control1..1
Typestring
Summarytrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Example
General:123456
18. Location.identifier:odsSiteCode.period
Definition

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

Control0..1
TypePeriod
Summarytrue
19. Location.identifier:odsSiteCode.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(CareConnect-Organization-1)
Summarytrue
Comments

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

20. Location.status
Definition

The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.

Control0..1
BindingThe codes SHALL be taken from LocationStatus Indicates whether the location is still in use
Typecode
Is Modifiertrue
Summarytrue
Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

21. Location.operationalStatus
Definition

The Operational status covers operation values most relevant to beds (but can also apply to rooms/units/chair/etc such as an isolation unit/dialisys chair). This typically covers concepts such as contamination, housekeeping and other activities like maintenance.

Control0..1
BindingThe codes SHOULD be taken from v2 Bed Status The operational status if the location (where typically a bed/room
TypeCoding
Summarytrue
22. Location.name
Definition

Name of the location as used by humans. Does not need to be unique.

Control0..1
Typestring
Summarytrue
Comments

If the name of an location changes, consider putting the old name in the alias column so that it can still be located through searches.

23. Location.alias
Definition

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

Control0..*
Typestring
Requirements

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

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

Comments

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

24. Location.description
Definition

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

Control0..1
Typestring
Summarytrue
Requirements

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

25. Location.mode
Definition

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

Control0..1
BindingThe codes SHALL be taken from LocationMode Indicates whether a resource instance represents a specific location or a class of locations
Typecode
Is Modifiertrue
Summarytrue
Requirements

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

Comments

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

26. Location.type
Definition

Indicates the type of function performed at the location.

Control0..1
BindingThe codes SHALL be taken from ServiceDeliveryLocationRoleType; other codes may be used where these codes are not suitable Indicates the type of function performed at the location
TypeCodeableConcept
Summarytrue
27. Location.telecom
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.

Control0..*
TypeContactPoint
28. Location.address
Definition

Physical location.

Control0..1
TypeAddress
Requirements

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

Comments

This was kept as 0..1 as there is no use property on the address, so wouldn't be able to identify different address types.

29. Location.physicalType
Definition

Physical form of the location, e.g. building, room, vehicle, road.

Control0..1
BindingFor example codes, see LocationType Physical form of the locatio
TypeCodeableConcept
Summarytrue
Requirements

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

30. Location.position
Definition

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

Control0..1
TypeBackboneElement
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
31. Location.position.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
32. Location.position.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

33. Location.position.modifierExtension
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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Alternate Namesextensions, user content, modifiers
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.

34. Location.position.longitude
Definition

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

Control1..1
Typedecimal
35. Location.position.latitude
Definition

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

Control1..1
Typedecimal
36. Location.position.altitude
Definition

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

Control0..1
Typedecimal
37. Location.managingOrganization
Definition

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

Control0..1
TypeReference(CareConnect-Organization-1)
Summarytrue
Requirements

Need to know who manages the location.

Comments

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

38. Location.partOf
Definition

Another Location which this Location is physically part of.

Control0..1
TypeReference(CareConnect-Location-1)
Requirements

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

39. Location.endpoint
Definition

Technical endpoints providing access to services operated for the location.

Control0..*
TypeReference(Endpoint)
Requirements

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