FHIR Clinical Guidelines (v1.0.0) (STU1)

Clinical Practice Guidelines, published by Clinical Decision Support WG. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/cqf-recommendations/ and changes regularly. See the Directory of published versions

D.4.1 StructureDefinition-cpg-location

Introduction:

Examples:

D.4.1.1 Formal Views of Profile Content

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.

Summary

Mandatory: 4 elements
Must-Support: 5 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationDetails and position information for a physical place
... identifier 0..*IdentifierUnique code or number identifying the location to its users
... status S1..1codeactive | suspended | inactive
... name S1..1stringName of the location as used by humans
... mode S1..1codeinstance | kind
Fixed Value: instance
... type S1..*CodeableConceptType of function performed
... managingOrganization S0..1Reference(CPGOrganization)Organization responsible for provisioning and upkeep

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationDetails and position information for a physical place
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... 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
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
... status ?!SΣ1..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: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).

... name SΣ1..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 SΣ1..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.


Fixed Value: instance
... type SΣ1..*CodeableConceptType 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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ0..1Reference(CPGOrganization)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Location)Another Location this one is physically a part of
... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanThe Location is open all day
.... openingTime 0..1timeTime that the Location opens
.... closingTime 0..1timeTime that the Location closes
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Summary

Mandatory: 4 elements
Must-Support: 5 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationDetails and position information for a physical place
... identifier 0..*IdentifierUnique code or number identifying the location to its users
... status S1..1codeactive | suspended | inactive
... name S1..1stringName of the location as used by humans
... mode S1..1codeinstance | kind
Fixed Value: instance
... type S1..*CodeableConceptType of function performed
... managingOrganization S0..1Reference(CPGOrganization)Organization responsible for provisioning and upkeep

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationDetails and position information for a physical place
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... 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
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
... status ?!SΣ1..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: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).

... name SΣ1..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 SΣ1..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.


Fixed Value: instance
... type SΣ1..*CodeableConceptType 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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ0..1Reference(CPGOrganization)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Location)Another Location this one is physically a part of
... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanThe Location is open all day
.... openingTime 0..1timeTime that the Location opens
.... closingTime 0..1timeTime that the Location closes
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet / Code
Location.languagepreferredCommonLanguages
Max Binding: AllLanguages
Location.statusrequiredLocationStatus
Location.operationalStatuspreferredHl7VSBedStatus
Location.moderequiredFixed Value: instance
Location.typeextensibleServiceDeliveryLocationRoleType
Location.physicalTypeexampleLocationType
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2LocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3LocationIf 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-4LocationIf 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-5LocationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6LocationA resource should have narrative for robust management
: text.`div`.exists()
ele-1Location.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Location.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Location.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Location.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Location.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.operationalStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.aliasAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.modeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.physicalTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.positionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.position.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Location.position.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Location.position.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Location.position.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Location.position.longitudeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.position.latitudeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.position.altitudeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.managingOrganizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.hoursOfOperationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.hoursOfOperation.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Location.hoursOfOperation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Location.hoursOfOperation.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Location.hoursOfOperation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Location.hoursOfOperation.daysOfWeekAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.hoursOfOperation.allDayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.hoursOfOperation.openingTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.hoursOfOperation.closingTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.availabilityExceptionsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.endpointAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())