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.

This structure is derived from Location

Summary

Mandatory: 0 element (2 nested mandatory elements)

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location I0..*LocationDetails and position information for a physical place
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierUnique code or number identifying the location to its users
... status ?!ΣI0..1codeactive | suspended | inactive
Binding: LocationStatus (required)
... operationalStatus ΣI0..1CodingThe operational status of the location (typically only for a bed/room)
Binding: v2 BED STATUS (preferred)
... name ΣI0..1stringName of the location as used by humans
... alias I0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description ΣI0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode ΣI0..1codeinstance | kind
Binding: LocationMode (required)
... type ΣI0..1CodeableConceptType of function performed
Binding: V3 Value SetServiceDeliveryLocationRoleType (extensible)
... telecom I0..*ContactPointContact details of the location
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value ΣI1..1stringThe actual contact point details
.... use ?!ΣI0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank ΣI0..1positiveIntSpecify preferred order of use (1 = highest)
.... period ΣI0..1PeriodTime period when the contact point was/is in use
... address I0..1AddressPhysical location
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!ΣI0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General: home
.... type ΣI0..1codepostal | physical | both
Binding: AddressType (required)
Example General: both
.... text ΣI0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line ΣI0..*stringStreet 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 ΣI0..1stringName of city, town etc.
Example General: Erewhon
.... district ΣI0..1stringDistrict name (aka county)
Example General: Madison
.... state ΣI0..1stringSub-unit of country (abbreviations ok)
.... postalCode ΣI0..1stringPostal code for area
Example General: 9132
.... country ΣI0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period ΣI0..1PeriodTime 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 ΣI0..1CodeableConceptPhysical form of the location
Binding: LocationType (example)
... position I0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude I1..1decimalLongitude with WGS84 datum
.... latitude I1..1decimalLatitude with WGS84 datum
.... altitude I0..1decimalAltitude with WGS84 datum
... managingOrganization ΣI0..1Reference(Organization)Organization responsible for provisioning and upkeep
... partOf I0..1Reference(Location)Another Location this one is physically a part of
... hoursOfOperation I0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek I0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay I0..1booleanThe Location is open all day
.... openingTime I0..1timeTime that the Location opens
.... closingTime I0..1timeTime that the Location closes
... availabilityExceptions I0..1stringDescription of availability exceptions
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

This structure is derived from Location

Summary

Mandatory: 0 element (2 nested mandatory elements)

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location I0..*LocationDetails and position information for a physical place
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierUnique code or number identifying the location to its users
... status ?!ΣI0..1codeactive | suspended | inactive
Binding: LocationStatus (required)
... operationalStatus ΣI0..1CodingThe operational status of the location (typically only for a bed/room)
Binding: v2 BED STATUS (preferred)
... name ΣI0..1stringName of the location as used by humans
... alias I0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description ΣI0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode ΣI0..1codeinstance | kind
Binding: LocationMode (required)
... type ΣI0..1CodeableConceptType of function performed
Binding: V3 Value SetServiceDeliveryLocationRoleType (extensible)
... telecom I0..*ContactPointContact details of the location
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value ΣI1..1stringThe actual contact point details
.... use ?!ΣI0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank ΣI0..1positiveIntSpecify preferred order of use (1 = highest)
.... period ΣI0..1PeriodTime period when the contact point was/is in use
... address I0..1AddressPhysical location
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!ΣI0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General: home
.... type ΣI0..1codepostal | physical | both
Binding: AddressType (required)
Example General: both
.... text ΣI0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line ΣI0..*stringStreet 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 ΣI0..1stringName of city, town etc.
Example General: Erewhon
.... district ΣI0..1stringDistrict name (aka county)
Example General: Madison
.... state ΣI0..1stringSub-unit of country (abbreviations ok)
.... postalCode ΣI0..1stringPostal code for area
Example General: 9132
.... country ΣI0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period ΣI0..1PeriodTime 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 ΣI0..1CodeableConceptPhysical form of the location
Binding: LocationType (example)
... position I0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude I1..1decimalLongitude with WGS84 datum
.... latitude I1..1decimalLatitude with WGS84 datum
.... altitude I0..1decimalAltitude with WGS84 datum
... managingOrganization ΣI0..1Reference(Organization)Organization responsible for provisioning and upkeep
... partOf I0..1Reference(Location)Another Location this one is physically a part of
... hoursOfOperation I0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek I0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay I0..1booleanThe Location is open all day
.... openingTime I0..1timeTime that the Location opens
.... closingTime I0..1timeTime that the Location closes
... availabilityExceptions I0..1stringDescription of availability exceptions
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
Location.languagepreferredCommonLanguages
Max Binding: AllLanguages
Location.statusrequiredLocationStatus
Location.operationalStatuspreferredv2.0116
Location.moderequiredLocationMode
Location.typeextensiblev3.ServiceDeliveryLocationRoleType
Location.telecom.systemrequiredContactPointSystem
Location.telecom.userequiredContactPointUse
Location.address.userequiredAddressUse
Location.address.typerequiredAddressType
Location.physicalTypeexampleLocationType
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek

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.telecom.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Location.telecom.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Location.telecom.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.telecom.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.telecom.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.telecom.rankAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.telecom.periodAll 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.address.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Location.address.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Location.address.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.address.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.address.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.address.lineAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.address.cityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.address.districtAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.address.stateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.address.postalCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.address.countryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.address.periodAll 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())