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

D.4.1 StructureDefinition-cpg-locationdefinition

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-locationdefinition

CPG location represents the minimum expectations for communicating a definitional location as part of computable guideline content

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: 3 elements
Must-Support: 4 elements
Fixed Value: 1 element
Prohibited: 10 elements

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationDetails and position information for a physical place
... identifier 0..0
... status S0..0
... name S1..1stringName of the location as used by humans
... mode S1..1codeinstance | kind
Fixed Value: kind
... type S1..*CodeableConceptType of function performed
... telecom 0..0
... address 0..0
... position 0..0
... managingOrganization 0..0
... partOf 0..0
... hoursOfOperation 0..0
... availabilityExceptions 0..0
... endpoint 0..0

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
... 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: kind
... type SΣ1..*CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example): Physical form of the location.


doco Documentation for this format

Summary

Mandatory: 3 elements
Must-Support: 4 elements
Fixed Value: 1 element
Prohibited: 10 elements

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationDetails and position information for a physical place
... identifier 0..0
... status S0..0
... name S1..1stringName of the location as used by humans
... mode S1..1codeinstance | kind
Fixed Value: kind
... type S1..*CodeableConceptType of function performed
... telecom 0..0
... address 0..0
... position 0..0
... managingOrganization 0..0
... partOf 0..0
... hoursOfOperation 0..0
... availabilityExceptions 0..0
... endpoint 0..0

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
... 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: kind
... type SΣ1..*CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example): Physical form of the location.


doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet / Code
Location.languagepreferredCommonLanguages
Max Binding: AllLanguages
Location.operationalStatuspreferredHl7VSBedStatus
Location.moderequiredFixed Value: kind
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.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.physicalTypeAll 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.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())