INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions
StructureDefinition: CareConnect-Location-1
The Location resource provides information and details on the physical location and the services provided.
The official URL for this profile is:
https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Location-1
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
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:
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Location-1
Slices
This structure defines the following Slices:
- The element Location.identifier is sliced based on the value of value:system (Open at End)
This structure is derived from Location
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Location | 0..* | Location | ||
  identifier | 0..* | (Slice Definition) | Slice: Unordered, Open At End by value:system | |
   identifier:odsSiteCode | 0..1 | Identifier | ODS Site code to identify the organisation at site level | |
   system | 1..1 | uri | ODS Code Fixed Value: https://fhir.nhs.uk/Id/ods-site-code | |
| value | 1..1 | string | The ODS Site code name, to reflect the code used | |
  assigner | 0..1 | Reference(CareConnect-Organization-1) | ||
 managingOrganization | 0..1 | Reference(CareConnect-Organization-1) | ||
 partOf | 0..1 | Reference(CareConnect-Location-1) | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | I | 0..* | Location | Details and position information for a physical place |
 id | Σ | 0..1 | id | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | (Slice Definition) | Unique code or number identifying the location to its users Slice: Unordered, Open At End by value:system |
| identifier:odsSiteCode | Σ | 0..1 | Identifier | ODS Site code to identify the organisation at site level |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | Σ | 1..1 | uri | ODS Code Fixed Value: https://fhir.nhs.uk/Id/ods-site-code |
| value | Σ | 1..1 | string | The ODS Site code name, to reflect the code used Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) |
| status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required) |
| operationalStatus | Σ | 0..1 | Coding | The Operational status of the location (typically only for a bed/room) Binding: v2 Bed Status (preferred) |
| name | Σ | 0..1 | string | Name of the location as used by humans |
| alias | 0..* | string | A list of alternate names that the location is known as, or was known as in the past | |
| description | Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name |
| mode | ?!Σ | 0..1 | code | instance | kind Binding: LocationMode (required) |
| type | Σ | 0..1 | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible) |
| telecom | 0..* | ContactPoint | Contact details of the location | |
| address | 0..1 | Address | Physical location | |
| physicalType | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example) |
| position | I | 0..1 | BackboneElement | The absolute geographic location |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| longitude | 1..1 | decimal | Longitude with WGS84 datum | |
| latitude | 1..1 | decimal | Latitude with WGS84 datum | |
| altitude | 0..1 | decimal | Altitude with WGS84 datum | |
| managingOrganization | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization responsible for provisioning and upkeep |
| partOf | 0..1 | Reference(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 | |
| Documentation for this format | ||||
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:
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Location-1
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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | 0..* | Location | ||
| identifier | 0..* | (Slice Definition) | Slice: Unordered, Open At End by value:system | |
| identifier:odsSiteCode | 0..1 | Identifier | ODS Site code to identify the organisation at site level | |
| system | 1..1 | uri | ODS Code Fixed Value: https://fhir.nhs.uk/Id/ods-site-code | |
| value | 1..1 | string | The ODS Site code name, to reflect the code used | |
| assigner | 0..1 | Reference(CareConnect-Organization-1) | ||
| managingOrganization | 0..1 | Reference(CareConnect-Organization-1) | ||
| partOf | 0..1 | Reference(CareConnect-Location-1) | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | I | 0..* | Location | Details and position information for a physical place |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | (Slice Definition) | Unique code or number identifying the location to its users Slice: Unordered, Open At End by value:system |
| identifier:odsSiteCode | Σ | 0..1 | Identifier | ODS Site code to identify the organisation at site level |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | Σ | 1..1 | uri | ODS Code Fixed Value: https://fhir.nhs.uk/Id/ods-site-code |
| value | Σ | 1..1 | string | The ODS Site code name, to reflect the code used Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) |
| status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required) |
| operationalStatus | Σ | 0..1 | Coding | The Operational status of the location (typically only for a bed/room) Binding: v2 Bed Status (preferred) |
| name | Σ | 0..1 | string | Name of the location as used by humans |
| alias | 0..* | string | A list of alternate names that the location is known as, or was known as in the past | |
| description | Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name |
| mode | ?!Σ | 0..1 | code | instance | kind Binding: LocationMode (required) |
| type | Σ | 0..1 | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible) |
| telecom | 0..* | ContactPoint | Contact details of the location | |
| address | 0..1 | Address | Physical location | |
| physicalType | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example) |
| position | I | 0..1 | BackboneElement | The absolute geographic location |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| longitude | 1..1 | decimal | Longitude with WGS84 datum | |
| latitude | 1..1 | decimal | Latitude with WGS84 datum | |
| altitude | 0..1 | decimal | Altitude with WGS84 datum | |
| managingOrganization | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization responsible for provisioning and upkeep |
| partOf | 0..1 | Reference(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 | |
| Documentation for this format | ||||
Other representations of profile: Schematron
Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet |
| Location.language | extensible | Common Languages Max Binding: All Languages |
| Location.identifier:odsSiteCode.use | required | IdentifierUse |
| Location.identifier:odsSiteCode.type | extensible | Identifier Type Codes |
| Location.status | required | LocationStatus |
| Location.operationalStatus | preferred | v2 Bed Status |
| Location.mode | required | LocationMode |
| Location.type | extensible | ServiceDeliveryLocationRoleType |
| Location.physicalType | example | LocationType |
Constraints
Constraints
| Id | Path | Details | Requirements |
| dom-2 | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | Location | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-3 | Location | 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() | |
| ele-1 | Location.position | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |