This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON

Resource Profile: CRMI LocationDefinition

Represents the definition of a location, suitable for use in various contexts, such as a facility definition

Usage:

• Refer to this Resource Profile: CRMI PractitionerRoleDefinition
• Examples for this Resource Profile: ANCLocation

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Location

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	Location	Details and position information for a physical place
identifier		0..0
status	S	0..0
name	S	1..1	string	Name of the location as used by humans
mode	S	1..1	code	instance | kind Fixed Value: kind
type	S	1..*	CodeableConcept	Type 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
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	Location	Details and position information for a physical place
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
name	SΣ	1..1	string	Name of the location as used by humans
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: kind
type	SΣ	1..*	CodeableConcept	Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Location.mode	required	Fixed Value: kind
Location.type	extensible	ServiceDeliveryLocationRoleType

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Location	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	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	error	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	error	Location	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Location	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
Location		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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
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: kind
type	SΣ	1..*	CodeableConcept	Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
physicalType	Σ	0..1	CodeableConcept	Physical form of the location Binding: LocationType (example): Physical form of the location.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Location.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Location.operationalStatus	preferred	Hl7VSBedStatus
Location.mode	required	Fixed Value: kind
Location.type	extensible	ServiceDeliveryLocationRoleType
Location.physicalType	example	LocationType
Location.hoursOfOperation.daysOfWeek	required	DaysOfWeek

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Location

Summary

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

Maturity: 3

Differential View

This structure is derived from Location

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	Location	Details and position information for a physical place
identifier		0..0
status	S	0..0
name	S	1..1	string	Name of the location as used by humans
mode	S	1..1	code	instance | kind Fixed Value: kind
type	S	1..*	CodeableConcept	Type 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
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	Location	Details and position information for a physical place
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
name	SΣ	1..1	string	Name of the location as used by humans
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: kind
type	SΣ	1..*	CodeableConcept	Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Location.mode	required	Fixed Value: kind
Location.type	extensible	ServiceDeliveryLocationRoleType

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Location	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	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	error	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	error	Location	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Location	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Location		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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
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: kind
type	SΣ	1..*	CodeableConcept	Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
physicalType	Σ	0..1	CodeableConcept	Physical form of the location Binding: LocationType (example): Physical form of the location.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Location.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Location.operationalStatus	preferred	Hl7VSBedStatus
Location.mode	required	Fixed Value: kind
Location.type	extensible	ServiceDeliveryLocationRoleType
Location.physicalType	example	LocationType
Location.hoursOfOperation.daysOfWeek	required	DaysOfWeek

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Location

Summary

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

Maturity: 3

Other representations of profile: CSV, Excel, Schematron