HL7.FHIR.US.BSER\BSeR_ServiceDeliveryLocation

BSeR: Bidirectional Services_eReferral

This page is part of the Bidirectional Services eReferrals (BSeR) (v1.0.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

StructureDefinition: BSeR_ServiceDeliveryLocation

Service delivery location is physical place used by a referral initiating practitioner or referral recipient practitioner as the location to deliver services.

The official URL for this profile is:

http://hl7.org/fhir/us/bser/StructureDefinition/BSeR-ServiceDeliveryLocation

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
All

This structure is derived from Location

Summary

Mandatory: 0 element (2 nested mandatory elements)

This structure is derived from Location

Name	Card.	Type
Location	0..*	Location
identifier	0..*	Identifier
name	0..1	string
alias	0..*	string
type	0..1	CodeableConcept
telecom	0..*	ContactPoint
system	1..1	code
value	1..1	string
use	0..1	code
address	0..1	Address
use	0..1	code
text	0..1	string
line	0..*	string
city	0..1	string
state	0..1	string
postalCode	0..1	string
country	0..1	string
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Location	I	0..*	Location	Details and position information for a physical place
id	Σ	0..1	string	Logical id of this artifact
meta	ΣI	0..1	Meta	Metadata about the resource
implicitRules	?!ΣI	0..1	uri	A set of rules under which this content was created
language	I	0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!I	0..*	Extension	Extensions that cannot be ignored
identifier	ΣI	0..*	Identifier	Unique code or number identifying the location to its users
status	?!ΣI	0..1	code	active \| suspended \| inactive Binding: LocationStatus (required)
operationalStatus	ΣI	0..1	Coding	The operational status of the location (typically only for a bed/room) Binding: v2 BED STATUS (preferred)
name	ΣI	0..1	string	Name of the location as used by humans
alias	I	0..*	string	A list of alternate names that the location is known as, or was known as, in the past
description	ΣI	0..1	string	Additional details about the location that could be displayed as further information to identify the location beyond its name
mode	ΣI	0..1	code	instance \| kind Binding: LocationMode (required)
type	ΣI	0..1	CodeableConcept	Type of function performed Binding: V3 Value SetServiceDeliveryLocationRoleType (extensible)
telecom	I	0..*	ContactPoint	Contact details of the location
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣI	1..1	code	phone \| fax \| email \| pager \| url \| sms \| other Binding: ContactPointSystem (required)
value	ΣI	1..1	string	The actual contact point details
use	?!ΣI	0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: ContactPointUse (required)
rank	ΣI	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	ΣI	0..1	Period	Time period when the contact point was/is in use
address	I	0..1	Address	Physical location
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!ΣI	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required) Example General: home
type	ΣI	0..1	code	postal \| physical \| both Binding: AddressType (required) Example General: both
text	ΣI	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	ΣI	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	ΣI	0..1	string	Name of city, town etc. Example General: Erewhon
district	ΣI	0..1	string	District name (aka county) Example General: Madison
state	ΣI	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	ΣI	0..1	string	Postal code for area Example General: 9132
country	ΣI	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	ΣI	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23T00:00:00+00:00","end":"2010-07-01T00:00:00+00:00"}
physicalType	ΣI	0..1	CodeableConcept	Physical form of the location Binding: LocationType (example)
position	I	0..1	BackboneElement	The absolute geographic location
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
longitude	I	1..1	decimal	Longitude with WGS84 datum
latitude	I	1..1	decimal	Latitude with WGS84 datum
altitude	I	0..1	decimal	Altitude with WGS84 datum
managingOrganization	ΣI	0..1	Reference(Organization)	Organization responsible for provisioning and upkeep
partOf	I	0..1	Reference(Location)	Another Location this one is physically a part of
hoursOfOperation	I	0..*	BackboneElement	What days/times during a week is this location usually open
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
daysOfWeek	I	0..*	code	mon \| tue \| wed \| thu \| fri \| sat \| sun Binding: DaysOfWeek (required)
allDay	I	0..1	boolean	The Location is open all day
openingTime	I	0..1	time	Time that the Location opens
closingTime	I	0..1	time	Time that the Location closes
availabilityExceptions	I	0..1	string	Description of availability exceptions
endpoint	I	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the location
Documentation for this format

This structure is derived from Location

Summary

Mandatory: 0 element (2 nested mandatory elements)

Differential View

This structure is derived from Location

Name	Card.	Type
Location	0..*	Location
identifier	0..*	Identifier
name	0..1	string
alias	0..*	string
type	0..1	CodeableConcept
telecom	0..*	ContactPoint
system	1..1	code
value	1..1	string
use	0..1	code
address	0..1	Address
use	0..1	code
text	0..1	string
line	0..*	string
city	0..1	string
state	0..1	string
postalCode	0..1	string
country	0..1	string
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Location	I	0..*	Location	Details and position information for a physical place
id	Σ	0..1	string	Logical id of this artifact
meta	ΣI	0..1	Meta	Metadata about the resource
implicitRules	?!ΣI	0..1	uri	A set of rules under which this content was created
language	I	0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!I	0..*	Extension	Extensions that cannot be ignored
identifier	ΣI	0..*	Identifier	Unique code or number identifying the location to its users
status	?!ΣI	0..1	code	active \| suspended \| inactive Binding: LocationStatus (required)
operationalStatus	ΣI	0..1	Coding	The operational status of the location (typically only for a bed/room) Binding: v2 BED STATUS (preferred)
name	ΣI	0..1	string	Name of the location as used by humans
alias	I	0..*	string	A list of alternate names that the location is known as, or was known as, in the past
description	ΣI	0..1	string	Additional details about the location that could be displayed as further information to identify the location beyond its name
mode	ΣI	0..1	code	instance \| kind Binding: LocationMode (required)
type	ΣI	0..1	CodeableConcept	Type of function performed Binding: V3 Value SetServiceDeliveryLocationRoleType (extensible)
telecom	I	0..*	ContactPoint	Contact details of the location
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣI	1..1	code	phone \| fax \| email \| pager \| url \| sms \| other Binding: ContactPointSystem (required)
value	ΣI	1..1	string	The actual contact point details
use	?!ΣI	0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: ContactPointUse (required)
rank	ΣI	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	ΣI	0..1	Period	Time period when the contact point was/is in use
address	I	0..1	Address	Physical location
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!ΣI	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required) Example General: home
type	ΣI	0..1	code	postal \| physical \| both Binding: AddressType (required) Example General: both
text	ΣI	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	ΣI	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	ΣI	0..1	string	Name of city, town etc. Example General: Erewhon
district	ΣI	0..1	string	District name (aka county) Example General: Madison
state	ΣI	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	ΣI	0..1	string	Postal code for area Example General: 9132
country	ΣI	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	ΣI	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23T00:00:00+00:00","end":"2010-07-01T00:00:00+00:00"}
physicalType	ΣI	0..1	CodeableConcept	Physical form of the location Binding: LocationType (example)
position	I	0..1	BackboneElement	The absolute geographic location
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
longitude	I	1..1	decimal	Longitude with WGS84 datum
latitude	I	1..1	decimal	Latitude with WGS84 datum
altitude	I	0..1	decimal	Altitude with WGS84 datum
managingOrganization	ΣI	0..1	Reference(Organization)	Organization responsible for provisioning and upkeep
partOf	I	0..1	Reference(Location)	Another Location this one is physically a part of
hoursOfOperation	I	0..*	BackboneElement	What days/times during a week is this location usually open
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
daysOfWeek	I	0..*	code	mon \| tue \| wed \| thu \| fri \| sat \| sun Binding: DaysOfWeek (required)
allDay	I	0..1	boolean	The Location is open all day
openingTime	I	0..1	time	Time that the Location opens
closingTime	I	0..1	time	Time that the Location closes
availabilityExceptions	I	0..1	string	Description of availability exceptions
endpoint	I	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the location
Documentation for this format

Other representations of profile: Schematron

Terminology Bindings

Path	Conformance	ValueSet
Location.language	preferred	CommonLanguages Max Binding: AllLanguages
Location.status	required	LocationStatus
Location.operationalStatus	preferred	v2.0116
Location.mode	required	LocationMode
Location.type	extensible	v3.ServiceDeliveryLocationRoleType
Location.telecom.system	required	ContactPointSystem
Location.telecom.use	required	ContactPointUse
Location.address.use	required	AddressUse
Location.address.type	required	AddressType
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.telecom.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Location.telecom.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Location.telecom.system	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Location.telecom.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Location.telecom.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Location.telecom.rank	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Location.telecom.period	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 - Public Health Work Group. Package hl7.fhir.us.bser#1.0.0 based on FHIR 4.0.1. Generated 2020-03-02
Links: Table of Contents | QA Report | Search | Version History external | | Propose a change