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: CareConnectLocation1

Official URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Location-1 Version: 0.1.0
Draft as of 2018-11-05 Computable Name: CareConnect-Location-1

Copyright/Legal: Copyright © 2016 HL7 UK Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html

The Location resource provides information and details on the physical location and the services provided.

CURATED BY INTEROPen see: http://www.interopen.org/careconnect-curation-methodology/

Usage:

Formal Views of Profile Content

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

This structure is derived from Location

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationDetails and position information for a physical place
... Slices for identifier 0..*IdentifierUnique code or number identifying the location to its users
Slice: Unordered, Open At End by value:system
.... identifier:odsSiteCode 0..1IdentifierODS Site code to identify the organisation at site level
..... system 1..1uriODS Code
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value 1..1stringThe ODS Site code name, to reflect the code used
..... assigner 0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... managingOrganization 0..1Reference(CareConnect-Organization-1)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(CareConnect-Location-1)Another Location this one is physically part of

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationDetails and position information for a physical place
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierUnique code or number identifying the location to its users
Slice: Unordered, Open At End by value:system
.... identifier:odsSiteCode Σ0..1IdentifierODS Site code to identify the organisation at site level
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriODS Code
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value Σ1..1stringThe ODS Site code name, to reflect the code used
Example General: 123456
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... mode ?!Σ0..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... managingOrganization Σ0..1Reference(CareConnect-Organization-1)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(CareConnect-Location-1)Another Location this one is physically part of

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Location.identifier:odsSiteCode.userequiredIdentifierUse
Location.statusrequiredLocationStatus
Location.moderequiredLocationMode

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorLocationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLocationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorLocationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationDetails and position information for a physical place
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierUnique code or number identifying the location to its users
Slice: Unordered, Open At End by value:system
.... identifier:odsSiteCode Σ0..1IdentifierODS Site code to identify the organisation at site level
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

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

..... system Σ1..1uriODS Code
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value Σ1..1stringThe ODS Site code name, to reflect the code used
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... status ?!Σ0..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... operationalStatus Σ0..1CodingThe Operational status of the location (typically only for a bed/room)
Binding: v2 Bed Status (preferred): The operational status if the location (where typically a bed/room)

... name Σ0..1stringName of the location as used by humans
... alias 0..*stringA list of alternate names that the location is known as, or was known as in the past
... description Σ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode ?!Σ0..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type Σ0..1CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.

... telecom 0..*ContactPointContact details of the location
... address 0..1AddressPhysical location
... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example): Physical form of the location

... position 0..1BackboneElementThe absolute geographic location
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization Σ0..1Reference(CareConnect-Organization-1)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(CareConnect-Location-1)Another Location this one is physically part of
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Location.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Location.identifier:odsSiteCode.userequiredIdentifierUse
Location.identifier:odsSiteCode.typeextensibleIdentifier Type Codes
Location.statusrequiredLocationStatus
Location.operationalStatuspreferredv2 Bed Status
Location.moderequiredLocationMode
Location.typeextensibleServiceDeliveryLocationRoleType
Location.physicalTypeexampleLocationType

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())

This structure is derived from Location

Summary

Mandatory: 0 element (2 nested mandatory elements)
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Location.identifier is sliced based on the value of value:system (Open at End)

Differential View

This structure is derived from Location

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationDetails and position information for a physical place
... Slices for identifier 0..*IdentifierUnique code or number identifying the location to its users
Slice: Unordered, Open At End by value:system
.... identifier:odsSiteCode 0..1IdentifierODS Site code to identify the organisation at site level
..... system 1..1uriODS Code
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value 1..1stringThe ODS Site code name, to reflect the code used
..... assigner 0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... managingOrganization 0..1Reference(CareConnect-Organization-1)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(CareConnect-Location-1)Another Location this one is physically part of

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationDetails and position information for a physical place
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierUnique code or number identifying the location to its users
Slice: Unordered, Open At End by value:system
.... identifier:odsSiteCode Σ0..1IdentifierODS Site code to identify the organisation at site level
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriODS Code
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value Σ1..1stringThe ODS Site code name, to reflect the code used
Example General: 123456
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... mode ?!Σ0..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... managingOrganization Σ0..1Reference(CareConnect-Organization-1)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(CareConnect-Location-1)Another Location this one is physically part of

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Location.identifier:odsSiteCode.userequiredIdentifierUse
Location.statusrequiredLocationStatus
Location.moderequiredLocationMode

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorLocationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLocationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorLocationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationDetails and position information for a physical place
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierUnique code or number identifying the location to its users
Slice: Unordered, Open At End by value:system
.... identifier:odsSiteCode Σ0..1IdentifierODS Site code to identify the organisation at site level
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

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

..... system Σ1..1uriODS Code
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value Σ1..1stringThe ODS Site code name, to reflect the code used
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... status ?!Σ0..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... operationalStatus Σ0..1CodingThe Operational status of the location (typically only for a bed/room)
Binding: v2 Bed Status (preferred): The operational status if the location (where typically a bed/room)

... name Σ0..1stringName of the location as used by humans
... alias 0..*stringA list of alternate names that the location is known as, or was known as in the past
... description Σ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode ?!Σ0..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type Σ0..1CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.

... telecom 0..*ContactPointContact details of the location
... address 0..1AddressPhysical location
... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example): Physical form of the location

... position 0..1BackboneElementThe absolute geographic location
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization Σ0..1Reference(CareConnect-Organization-1)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(CareConnect-Location-1)Another Location this one is physically part of
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Location.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Location.identifier:odsSiteCode.userequiredIdentifierUse
Location.identifier:odsSiteCode.typeextensibleIdentifier Type Codes
Location.statusrequiredLocationStatus
Location.operationalStatuspreferredv2 Bed Status
Location.moderequiredLocationMode
Location.typeextensibleServiceDeliveryLocationRoleType
Location.physicalTypeexampleLocationType

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())

This structure is derived from Location

Summary

Mandatory: 0 element (2 nested mandatory elements)
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Location.identifier is sliced based on the value of value:system (Open at End)

 

Other representations of profile: CSV, Excel, Schematron