HL7.FHIR.US.CDMH\CdmhLocation

Common Data Models Harmonization
1.0.0 - STU 1 Publication

This page is part of the Common Data Models Harmonization FHIR IG (v1.0.0: STU 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: CdmhLocation

Defining URL:

http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-location

Version:

1.0.0

Name:

CdmhLocation

Title:

CDMH Location

Status:

Draft as of 9/1/19

Definition:

This is the Location Resource profile for the IG.

Publisher:

HL7 International - Biomedical Research and Regulation Work Group

Copyright:

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-location

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from USCoreLocation

Summary

Must-Support: 1 element

This structure is derived from USCoreLocation

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	USCoreLocation	CDMH Location
type	S	0..1	CodeableConcept	Type of function performed Binding: PCORNet Facility Type (extensible): Facility Type of the location where care is delivered.
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	USCoreLocation	CDMH Location
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Σ	0..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	Σ	0..1	code	instance \| kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
type	SΣ	0..1	CodeableConcept	Type of function performed Binding: PCORNet Facility Type (extensible): Facility Type of the location where care is delivered.
telecom	S	0..*	ContactPoint	Contact details of the location
address	S	0..1	Address	Physical location
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal \| physical \| both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
postalCode	SΣ	0..1	string	US Zip Codes Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
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(US Core Organization Profile)	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

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	USCoreLocation	CDMH Location
status	?!Σ	0..1	code	active \| suspended \| inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
name	Σ	1..1	string	Name of the location as used by humans
type	Σ	0..1	CodeableConcept	Type of function performed Binding: PCORNet Facility Type (extensible): Facility Type of the location where care is delivered.
telecom		0..*	ContactPoint	Contact details of the location
address		0..1	Address	Physical location
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label
city	Σ	0..1	string	Name of city, town etc.
state	Σ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
postalCode	Σ	0..1	string	US Zip Codes
managingOrganization	Σ	0..1	Reference(US Core Organization Profile)	Organization responsible for provisioning and upkeep
Documentation for this format

This structure is derived from USCoreLocation

Summary

Must-Support: 1 element

Differential View

This structure is derived from USCoreLocation

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	USCoreLocation	CDMH Location
type	S	0..1	CodeableConcept	Type of function performed Binding: PCORNet Facility Type (extensible): Facility Type of the location where care is delivered.
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	USCoreLocation	CDMH Location
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Σ	0..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	Σ	0..1	code	instance \| kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
type	SΣ	0..1	CodeableConcept	Type of function performed Binding: PCORNet Facility Type (extensible): Facility Type of the location where care is delivered.
telecom	S	0..*	ContactPoint	Contact details of the location
address	S	0..1	Address	Physical location
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal \| physical \| both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
postalCode	SΣ	0..1	string	US Zip Codes Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
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(US Core Organization Profile)	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

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet
Location.language	preferred	CommonLanguages Max Binding: AllLanguages
Location.status	required	LocationStatus
Location.operationalStatus	preferred	Hl7VSBedStatus
Location.mode	required	LocationMode
Location.type	extensible	PCORNetFacilityType
Location.address.use	required	AddressUse
Location.address.type	required	AddressType
Location.address.state	extensible	UspsTwoLetterAlphabeticCodes
Location.physicalType	example	LocationType
Location.hoursOfOperation.daysOfWeek	required	DaysOfWeek

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-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.address.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Location.address.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Location.address.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Location.address.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Location.address.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Location.address.line	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Location.address.city	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Location.address.district	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Location.address.state	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Location.address.postalCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Location.address.country	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Location.address.period	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())

IG © 2019+ HL7 International - Biomedical Research and Regulation Work Group. Package hl7.fhir.us.cdmh#1.0.0 based on FHIR 4.0.1. Generated 2021-12-06
Links: Table of Contents | QA Report | Version History | Search | | Propose a change