FHIR Clinical Guidelines (v1.0.0) (STU1)
This page is part of the Clinical Guidelines (v1.0.0: STU 1) based on FHIR R4. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
The official URL for this profile is:
http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-location
CPG location represents the minimum expectations for communicating location information as part of a CPG case
This profile builds on Location.
This profile was published on Thu Jun 06 00:00:00 UTC 2019 as a draft by Health Level Seven, Inc. - CDS WG.
Description of Profiles, Differentials, and Snapshots.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Location | 0..* | Location | Details and position information for a physical place | |
  identifier | 0..* | Identifier | Unique code or number identifying the location to its users | |
| status | S | 1..1 | code | active | suspended | inactive |
| name | S | 1..1 | string | Name of the location as used by humans |
 mode | S | 1..1 | code | instance | kind Fixed Value: instance |
| type | S | 1..* | CodeableConcept | Type of function performed |
  managingOrganization | S | 0..1 | Reference(CPGOrganization) | Organization responsible for provisioning and upkeep |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | 0..* | Location | Details and position information for a physical place | |
| id | Σ | 0..1 | string | 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: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 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..* | Identifier | Unique code or number identifying the location to its users |
| status | ?!SΣ | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
| operationalStatus | Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room). |
| name | SΣ | 1..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 | SΣ | 1..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. Fixed Value: instance |
| type | SΣ | 1..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. |
| 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): Physical form of the location. |
| position | 0..1 | BackboneElement | The absolute geographic location | |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| 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 | SΣ | 0..1 | Reference(CPGOrganization) | Organization responsible for provisioning and upkeep |
| partOf | 0..1 | Reference(Location) | Another Location this one is physically a part of | |
| hoursOfOperation | 0..* | BackboneElement | What days/times during a week is this location usually open | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |
| allDay | 0..1 | boolean | The Location is open all day | |
| openingTime | 0..1 | time | Time that the Location opens | |
| closingTime | 0..1 | time | Time that the Location closes | |
| availabilityExceptions | 0..1 | string | Description of availability exceptions | |
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |
| Documentation for this format | ||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | 0..* | Location | Details and position information for a physical place | |
| identifier | 0..* | Identifier | Unique code or number identifying the location to its users | |
| status | S | 1..1 | code | active | suspended | inactive |
| name | S | 1..1 | string | Name of the location as used by humans |
| mode | S | 1..1 | code | instance | kind Fixed Value: instance |
| type | S | 1..* | CodeableConcept | Type of function performed |
| managingOrganization | S | 0..1 | Reference(CPGOrganization) | Organization responsible for provisioning and upkeep |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | 0..* | Location | Details and position information for a physical place | |
| id | Σ | 0..1 | string | 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: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 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..* | Identifier | Unique code or number identifying the location to its users |
| status | ?!SΣ | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
| operationalStatus | Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room). |
| name | SΣ | 1..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 | SΣ | 1..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. Fixed Value: instance |
| type | SΣ | 1..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. |
| 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): Physical form of the location. |
| position | 0..1 | BackboneElement | The absolute geographic location | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| 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 | SΣ | 0..1 | Reference(CPGOrganization) | Organization responsible for provisioning and upkeep |
| partOf | 0..1 | Reference(Location) | Another Location this one is physically a part of | |
| hoursOfOperation | 0..* | BackboneElement | What days/times during a week is this location usually open | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |
| allDay | 0..1 | boolean | The Location is open all day | |
| openingTime | 0..1 | time | Time that the Location opens | |
| closingTime | 0..1 | time | Time that the Location closes | |
| availabilityExceptions | 0..1 | string | Description of availability exceptions | |
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Location.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Location.status | required | LocationStatus |
| Location.operationalStatus | preferred | Hl7VSBedStatus |
| Location.mode | required | Fixed Value: instance |
| Location.type | extensible | ServiceDeliveryLocationRoleType |
| Location.physicalType | example | LocationType |
| Location.hoursOfOperation.daysOfWeek | required | DaysOfWeek |
| 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-3 | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | 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-5 | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Location | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | Location.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Location.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Location.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Location.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Location.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.operationalStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.alias | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.mode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.physicalType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.position | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.position.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Location.position.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Location.position.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Location.position.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Location.position.longitude | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.position.latitude | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.position.altitude | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.managingOrganization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.hoursOfOperation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.hoursOfOperation.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Location.hoursOfOperation.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Location.hoursOfOperation.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Location.hoursOfOperation.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Location.hoursOfOperation.daysOfWeek | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.hoursOfOperation.allDay | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.hoursOfOperation.openingTime | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.hoursOfOperation.closingTime | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.availabilityExceptions | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Location.endpoint | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
© HL7.org (Clinical Decision Support WG). hl7.fhir.uv.cpg#1.0.0 based on FHIR v4.0.1. Generated 2021-02-11.
Links: Home
| QA Report
| Version History
| 
| Propose a change