fhir-human-services-directory
1.0.0-ballot - STU Ballot US

This page is part of the FHIR IG Human Services Directory (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: HSDSLocation

Official URL: http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-Location Version: 1.0.0-ballot
Active as of 2022-12-08 Computable Name: HSDSLocation

The HSDSLocation resource describes the physical place where community-based services are provided, practitioners are employed, organizations are based, etc. Locations can range in scope from a room in a building to a geographic region/area.

Usage:

Formal Views of Profile Content

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

This structure is derived from PlannetLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*PlannetLocationDetails and position information for a physical place
... id 0..1idLogical id of this artifact
... meta 0..1MetaMetadata about the resource
.... lastUpdated 1..1instantWhen the resource version last changed
... text 0..1NarrativeText summary of the resource, for human interpretation
... extension:accessibility 0..*AccessibilityAccessibility
... extension:region 0..1boundary-geojsonA boundary shape that represents the outside edge of the location (in GeoJSON format)
... identifier 0..*IdentifierUnique code or number identifying the location to its users
.... id 0..1stringUnique id for inter-element referencing
.... use 0..1codeusual | official | temp | secondary | old (If known)
Fixed Value: official
.... type 0..1CodeableConceptDescription of identifier
.... system 0..1uriThe namespace for the identifier value
.... value 0..1stringThe value that is unique
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1Reference(Organization)Organization that issued id (may be just text)
... status 1..1codeactive | suspended | inactive
... name 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
... type 0..*CodeableConceptType of function performed
... telecom 0..*ContactPointContact details of the location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
.... extension:via-intermediary 0..*ViaIntermediaryVia Intermediary
.... system 0..1codephone | fax | email | pager | url | sms | other
.... value 0..1stringThe actual contact point details
.... use 0..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: work
.... rank 0..1positiveIntSpecify preferred order of use (1 = highest)
.... period 0..1PeriodTime period when the contact point was/is in use
... address 0..1AddressPhysical location
.... id 0..1stringUnique id for inter-element referencing
.... use 0..1codehome | work | temp | old | billing - purpose of this address
Fixed Value: work
.... type 0..1codepostal | physical | both
.... text 0..1stringText representation of the address
.... line 0..*stringStreet name, number, direction & P.O. Box etc.
.... city 0..1stringName of city, town etc.
.... district 0..1stringDistrict name (aka county)
.... state 0..1stringSub-unit of country (abbreviations ok)
.... postalCode 0..1stringUS Zip Codes
.... country 0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period 0..1PeriodTime period when address was/is in use
... physicalType 0..1CodeableConceptPhysical form of the location
... position 0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization 0..1Reference(HSDSOrganization)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Plan-Net Location)Another Location this one is physically a part of
... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
.... allDay 0..1booleanThe Location is open all day
.... openingTime 0..1timeTime that the Location opens
.... closingTime 0..1timeTime that the Location closes
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Plan-Net Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*PlannetLocationDetails and position information for a physical place
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... lastUpdated Σ1..1instantWhen the resource version last changed
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... newpatients SC0..*(Complex)New Patients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
... accessibility S0..*CodeableConceptAccessibility
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/accessibility
Binding: Accessibility VS (extensible)
... region S0..1AttachmentA boundary shape that represents the outside edge of the location (in GeoJSON format)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
.... id 0..1stringUnique id for inter-element referencing
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.


Fixed Value: active
... name SΣ1..1stringName of the location as used by humans
... alias S0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description SΣ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... type SΣ0..*CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


... telecom S0..*ContactPointContact details of the location
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... contactpoint-availabletime S0..*(Complex)Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
.... via-intermediary S0..*Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization)Via Intermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: work
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address S0..1AddressPhysical location
.... id 0..1stringUnique id for inter-element referencing
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Fixed Value: work
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*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 SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example): Physical form of the location.

... position S0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ0..1Reference(HSDSOrganization)Organization responsible for provisioning and upkeep
... partOf S0..1Reference(Plan-Net Location)Another Location this one is physically a part of
... hoursOfOperation S0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek S0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay S0..1booleanThe Location is open all day
.... openingTime S0..1timeTime that the Location opens
.... closingTime S0..1timeTime that the Location closes
... availabilityExceptions S0..1stringDescription of availability exceptions
... endpoint S0..*Reference(Plan-Net Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Location.identifier.userequiredFixed Value: official
Location.identifier.typeextensibleIdentifier Type Codes
Location.statusrequiredFixed Value: active
Location.typeextensibleServiceDeliveryLocationRoleType
Location.telecom.systemrequiredContactPointSystem
Location.telecom.userequiredFixed Value: work
Location.address.userequiredFixed Value: work
Location.address.typerequiredAddressType
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes
Location.physicalTypeexampleLocationType
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLocationIf 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-4errorLocationIf 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-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLocationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
new-patients-characteristicserrorLocation.extension:newpatientsIf no new patients are accepted, no characteristics are allowed
: extension('acceptingPatients').valueCodeableConcept.coding.exists(code = 'no') implies extension('characteristics').empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*PlannetLocationDetails and position information for a physical place
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... newpatients SC0..*(Complex)New Patients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
... accessibility S0..*CodeableConceptAccessibility
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/accessibility
Binding: Accessibility VS (extensible)
... region S0..1AttachmentA boundary shape that represents the outside edge of the location (in GeoJSON format)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.


Fixed Value: active
... 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 S0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description SΣ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... type SΣ0..*CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


... telecom S0..*ContactPointContact details of the location
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... contactpoint-availabletime S0..*(Complex)Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
.... via-intermediary S0..*Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization)Via Intermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: work
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address S0..1AddressPhysical location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Fixed Value: work
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*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 SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example): Physical form of the location.

... position S0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ0..1Reference(HSDSOrganization)Organization responsible for provisioning and upkeep
... partOf S0..1Reference(Plan-Net Location)Another Location this one is physically a part of
... hoursOfOperation S0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek S0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay S0..1booleanThe Location is open all day
.... openingTime S0..1timeTime that the Location opens
.... closingTime S0..1timeTime that the Location closes
... availabilityExceptions S0..1stringDescription of availability exceptions
... endpoint S0..*Reference(Plan-Net Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Location.meta.securityextensibleAll Security Labels
Location.meta.tagexampleCommonTags
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Location.identifier.userequiredFixed Value: official
Location.identifier.typeextensibleIdentifier Type Codes
Location.statusrequiredFixed Value: active
Location.operationalStatuspreferredHl7VSBedStatus
Location.typeextensibleServiceDeliveryLocationRoleType
Location.telecom.systemrequiredContactPointSystem
Location.telecom.userequiredFixed Value: work
Location.address.userequiredFixed Value: work
Location.address.typerequiredAddressType
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes
Location.physicalTypeexampleLocationType
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
new-patients-characteristicserrorLocation.extension:newpatientsIf no new patients are accepted, no characteristics are allowed
: extension('acceptingPatients').valueCodeableConcept.coding.exists(code = 'no') implies extension('characteristics').empty()

This structure is derived from PlannetLocation

Summary

Fixed Value: 3 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from PlannetLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*PlannetLocationDetails and position information for a physical place
... id 0..1idLogical id of this artifact
... meta 0..1MetaMetadata about the resource
.... lastUpdated 1..1instantWhen the resource version last changed
... text 0..1NarrativeText summary of the resource, for human interpretation
... extension:accessibility 0..*AccessibilityAccessibility
... extension:region 0..1boundary-geojsonA boundary shape that represents the outside edge of the location (in GeoJSON format)
... identifier 0..*IdentifierUnique code or number identifying the location to its users
.... id 0..1stringUnique id for inter-element referencing
.... use 0..1codeusual | official | temp | secondary | old (If known)
Fixed Value: official
.... type 0..1CodeableConceptDescription of identifier
.... system 0..1uriThe namespace for the identifier value
.... value 0..1stringThe value that is unique
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1Reference(Organization)Organization that issued id (may be just text)
... status 1..1codeactive | suspended | inactive
... name 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
... type 0..*CodeableConceptType of function performed
... telecom 0..*ContactPointContact details of the location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
.... extension:via-intermediary 0..*ViaIntermediaryVia Intermediary
.... system 0..1codephone | fax | email | pager | url | sms | other
.... value 0..1stringThe actual contact point details
.... use 0..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: work
.... rank 0..1positiveIntSpecify preferred order of use (1 = highest)
.... period 0..1PeriodTime period when the contact point was/is in use
... address 0..1AddressPhysical location
.... id 0..1stringUnique id for inter-element referencing
.... use 0..1codehome | work | temp | old | billing - purpose of this address
Fixed Value: work
.... type 0..1codepostal | physical | both
.... text 0..1stringText representation of the address
.... line 0..*stringStreet name, number, direction & P.O. Box etc.
.... city 0..1stringName of city, town etc.
.... district 0..1stringDistrict name (aka county)
.... state 0..1stringSub-unit of country (abbreviations ok)
.... postalCode 0..1stringUS Zip Codes
.... country 0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period 0..1PeriodTime period when address was/is in use
... physicalType 0..1CodeableConceptPhysical form of the location
... position 0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization 0..1Reference(HSDSOrganization)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Plan-Net Location)Another Location this one is physically a part of
... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
.... allDay 0..1booleanThe Location is open all day
.... openingTime 0..1timeTime that the Location opens
.... closingTime 0..1timeTime that the Location closes
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Plan-Net Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*PlannetLocationDetails and position information for a physical place
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... lastUpdated Σ1..1instantWhen the resource version last changed
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... newpatients SC0..*(Complex)New Patients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
... accessibility S0..*CodeableConceptAccessibility
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/accessibility
Binding: Accessibility VS (extensible)
... region S0..1AttachmentA boundary shape that represents the outside edge of the location (in GeoJSON format)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
.... id 0..1stringUnique id for inter-element referencing
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.


Fixed Value: active
... name SΣ1..1stringName of the location as used by humans
... alias S0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description SΣ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... type SΣ0..*CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


... telecom S0..*ContactPointContact details of the location
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... contactpoint-availabletime S0..*(Complex)Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
.... via-intermediary S0..*Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization)Via Intermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: work
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address S0..1AddressPhysical location
.... id 0..1stringUnique id for inter-element referencing
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Fixed Value: work
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*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 SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example): Physical form of the location.

... position S0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ0..1Reference(HSDSOrganization)Organization responsible for provisioning and upkeep
... partOf S0..1Reference(Plan-Net Location)Another Location this one is physically a part of
... hoursOfOperation S0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek S0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay S0..1booleanThe Location is open all day
.... openingTime S0..1timeTime that the Location opens
.... closingTime S0..1timeTime that the Location closes
... availabilityExceptions S0..1stringDescription of availability exceptions
... endpoint S0..*Reference(Plan-Net Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Location.identifier.userequiredFixed Value: official
Location.identifier.typeextensibleIdentifier Type Codes
Location.statusrequiredFixed Value: active
Location.typeextensibleServiceDeliveryLocationRoleType
Location.telecom.systemrequiredContactPointSystem
Location.telecom.userequiredFixed Value: work
Location.address.userequiredFixed Value: work
Location.address.typerequiredAddressType
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes
Location.physicalTypeexampleLocationType
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLocationIf 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-4errorLocationIf 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-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLocationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
new-patients-characteristicserrorLocation.extension:newpatientsIf no new patients are accepted, no characteristics are allowed
: extension('acceptingPatients').valueCodeableConcept.coding.exists(code = 'no') implies extension('characteristics').empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*PlannetLocationDetails and position information for a physical place
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... newpatients SC0..*(Complex)New Patients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
... accessibility S0..*CodeableConceptAccessibility
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/accessibility
Binding: Accessibility VS (extensible)
... region S0..1AttachmentA boundary shape that represents the outside edge of the location (in GeoJSON format)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.


Fixed Value: active
... 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 S0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description SΣ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... type SΣ0..*CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


... telecom S0..*ContactPointContact details of the location
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... contactpoint-availabletime S0..*(Complex)Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
.... via-intermediary S0..*Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization)Via Intermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: work
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address S0..1AddressPhysical location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Fixed Value: work
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*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 SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example): Physical form of the location.

... position S0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ0..1Reference(HSDSOrganization)Organization responsible for provisioning and upkeep
... partOf S0..1Reference(Plan-Net Location)Another Location this one is physically a part of
... hoursOfOperation S0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek S0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay S0..1booleanThe Location is open all day
.... openingTime S0..1timeTime that the Location opens
.... closingTime S0..1timeTime that the Location closes
... availabilityExceptions S0..1stringDescription of availability exceptions
... endpoint S0..*Reference(Plan-Net Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Location.meta.securityextensibleAll Security Labels
Location.meta.tagexampleCommonTags
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Location.identifier.userequiredFixed Value: official
Location.identifier.typeextensibleIdentifier Type Codes
Location.statusrequiredFixed Value: active
Location.operationalStatuspreferredHl7VSBedStatus
Location.typeextensibleServiceDeliveryLocationRoleType
Location.telecom.systemrequiredContactPointSystem
Location.telecom.userequiredFixed Value: work
Location.address.userequiredFixed Value: work
Location.address.typerequiredAddressType
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes
Location.physicalTypeexampleLocationType
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
new-patients-characteristicserrorLocation.extension:newpatientsIf no new patients are accepted, no characteristics are allowed
: extension('acceptingPatients').valueCodeableConcept.coding.exists(code = 'no') implies extension('characteristics').empty()

This structure is derived from PlannetLocation

Summary

Fixed Value: 3 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron