Da Vinci PDex Plan Net
1.2.0 - STU 2 (ci-build) United States of America flag

Da Vinci PDex Plan Net, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 1.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pdex-plan-net/ and changes regularly. See the Directory of published versions

Resource Profile: Plan-Net Location

Official URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location Version: 1.2.0
Standards status: Trial-use Computable Name: PlannetLocation

A Location is the physical place where healthcare 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 USCoreLocationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location USCoreLocationProfile(7.0.0)
... meta
.... lastUpdated 1..1 instant When the resource version last changed
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... newpatients S 0..* (Complex) New Patients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
.... accessibility S 0..* CodeableConcept Accessibility
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/accessibility
Binding: Accessibility VS (extensible)
.... region S 0..1 Attachment Associated Region (GeoJSON)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
... identifier
.... type S 0..1 CodeableConcept Description of identifier
.... value S 0..1 string The value that is unique
... alias S 0..* string A list of alternate names that the location is known as, or was known as, in the past
... description S 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
... mode 0..0
... telecom
.... Slices for extension Content/Rules for all slices
..... contactpoint-availabletime S 0..* (Complex) Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
..... via-intermediary S 0..* 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 0..1 code phone | fax | email | pager | url | sms | other
.... value S 0..1 string The actual contact point details
... position S 0..1 BackboneElement The absolute geographic location
... managingOrganization 0..1 Reference(Plan-Net Organization) Organization responsible for provisioning and upkeep
... partOf S 0..1 Reference(Plan-Net Location) Another Location this one is physically a part of
... hoursOfOperation S 0..* BackboneElement What days/times during a week is this location usually open
.... daysOfWeek S 0..* code mon | tue | wed | thu | fri | sat | sun
.... allDay S 0..1 boolean The Location is open all day
.... openingTime S 0..1 time Time that the Location opens
.... closingTime S 0..1 time Time that the Location closes
... availabilityExceptions S 0..1 string Description of availability exceptions
... endpoint S 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..* USCoreLocationProfile(7.0.0) Details and position information for a physical place
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... newpatients SC 0..* (Complex) New Patients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
new-patients-characteristics: If no new patients are accepted, no characteristics are allowed
.... accessibility S 0..* CodeableConcept Accessibility
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/accessibility
Binding: Accessibility VS (extensible)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... region S 0..1 Attachment Associated Region (GeoJSON)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... type SΣ 0..1 CodeableConcept Description 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.


ele-1: All FHIR elements must have a @value or children
.... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... status ?!SΣ 1..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.


ele-1: All FHIR elements must have a @value or children
Fixed Value: active
... name SΣ 1..1 string Name by which a facility or location is known.
ele-1: All FHIR elements must have a @value or children
... alias S 0..* string A list of alternate names that the location is known as, or was known as, in the past
ele-1: All FHIR elements must have a @value or children
... description SΣ 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
ele-1: All FHIR elements must have a @value or children
... type SΣ 0..* CodeableConcept Category of service or resource available in a location.
Binding: ServiceDeliveryLocationRoleType (extensible)
ele-1: All FHIR elements must have a @value or children
... telecom S 0..* ContactPoint Contact details of the location
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... contactpoint-availabletime S 0..* (Complex) Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... via-intermediary S 0..* 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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
.... value SΣ 0..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
... address S 0..1 Address Physical location
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example General: 49 MEADOW ST
.... city SΣ 0..1 string Name of city, town etc.
ele-1: All FHIR elements must have a @value or children
Example General: Erewhon
Example General: EVERYTOWN
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.


ele-1: All FHIR elements must have a @value or children
Example General: OK
.... postalCode SΣ 0..1 string US Zip Codes
ele-1: All FHIR elements must have a @value or children
Example General: 9132
Example General: 74047
... position S 0..1 BackboneElement The absolute geographic location
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... longitude 1..1 decimal Longitude with WGS84 datum
ele-1: All FHIR elements must have a @value or children
.... latitude 1..1 decimal Latitude with WGS84 datum
ele-1: All FHIR elements must have a @value or children
... managingOrganization SΣ 0..1 Reference(Plan-Net Organization) Organization responsible for provisioning and upkeep
ele-1: All FHIR elements must have a @value or children
... partOf S 0..1 Reference(Plan-Net Location) Another Location this one is physically a part of
ele-1: All FHIR elements must have a @value or children
... hoursOfOperation S 0..* BackboneElement What days/times during a week is this location usually open
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... daysOfWeek S 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


ele-1: All FHIR elements must have a @value or children
.... allDay S 0..1 boolean The Location is open all day
ele-1: All FHIR elements must have a @value or children
.... openingTime S 0..1 time Time that the Location opens
ele-1: All FHIR elements must have a @value or children
.... closingTime S 0..1 time Time that the Location closes
ele-1: All FHIR elements must have a @value or children
... availabilityExceptions S 0..1 string Description of availability exceptions
ele-1: All FHIR elements must have a @value or children
... endpoint S 0..* Reference(Plan-Net Endpoint) Technical endpoints providing access to services operated for the location
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* USCoreLocationProfile(7.0.0) Details and position information for a physical place
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 1..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags 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..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... newpatients SC 0..* (Complex) New Patients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
new-patients-characteristics: If no new patients are accepted, no characteristics are allowed
.... accessibility S 0..* CodeableConcept Accessibility
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/accessibility
Binding: Accessibility VS (extensible)
.... region S 0..1 Attachment Associated Region (GeoJSON)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Unique business identifier for facility or location.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ 0..1 CodeableConcept Description 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..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.


Fixed Value: active
... 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 by which a facility or location is known.
... alias S 0..* string A list of alternate names that the location is known as, or was known as, in the past
... description SΣ 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
... type SΣ 0..* CodeableConcept Category of service or resource available in a location.
Binding: ServiceDeliveryLocationRoleType (extensible)
... telecom S 0..* ContactPoint Contact details of the 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
..... contactpoint-availabletime S 0..* (Complex) Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
..... via-intermediary S 0..* 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ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... address S 0..1 Address Physical location
.... id 0..1 string Unique id for inter-element referencing
.... 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
Example General: 49 MEADOW ST
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
Example General: EVERYTOWN
.... 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.


Example General: OK
.... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
Example General: 74047
.... 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 S 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(Plan-Net Organization) Organization responsible for provisioning and upkeep
... partOf S 0..1 Reference(Plan-Net Location) Another Location this one is physically a part of
... hoursOfOperation S 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 S 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay S 0..1 boolean The Location is open all day
.... openingTime S 0..1 time Time that the Location opens
.... closingTime S 0..1 time Time that the Location closes
... availabilityExceptions S 0..1 string Description of availability exceptions
... endpoint S 0..* Reference(Plan-Net Endpoint) Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Location.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Location.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Location.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.operationalStatuspreferredHl7VSBedStatus
http://terminology.hl7.org/ValueSet/v2-0116
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Differential View

This structure is derived from USCoreLocationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location USCoreLocationProfile(7.0.0)
... meta
.... lastUpdated 1..1 instant When the resource version last changed
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... newpatients S 0..* (Complex) New Patients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
.... accessibility S 0..* CodeableConcept Accessibility
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/accessibility
Binding: Accessibility VS (extensible)
.... region S 0..1 Attachment Associated Region (GeoJSON)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
... identifier
.... type S 0..1 CodeableConcept Description of identifier
.... value S 0..1 string The value that is unique
... alias S 0..* string A list of alternate names that the location is known as, or was known as, in the past
... description S 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
... mode 0..0
... telecom
.... Slices for extension Content/Rules for all slices
..... contactpoint-availabletime S 0..* (Complex) Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
..... via-intermediary S 0..* 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 0..1 code phone | fax | email | pager | url | sms | other
.... value S 0..1 string The actual contact point details
... position S 0..1 BackboneElement The absolute geographic location
... managingOrganization 0..1 Reference(Plan-Net Organization) Organization responsible for provisioning and upkeep
... partOf S 0..1 Reference(Plan-Net Location) Another Location this one is physically a part of
... hoursOfOperation S 0..* BackboneElement What days/times during a week is this location usually open
.... daysOfWeek S 0..* code mon | tue | wed | thu | fri | sat | sun
.... allDay S 0..1 boolean The Location is open all day
.... openingTime S 0..1 time Time that the Location opens
.... closingTime S 0..1 time Time that the Location closes
... availabilityExceptions S 0..1 string Description of availability exceptions
... endpoint S 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..* USCoreLocationProfile(7.0.0) Details and position information for a physical place
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... newpatients SC 0..* (Complex) New Patients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
new-patients-characteristics: If no new patients are accepted, no characteristics are allowed
.... accessibility S 0..* CodeableConcept Accessibility
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/accessibility
Binding: Accessibility VS (extensible)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... region S 0..1 Attachment Associated Region (GeoJSON)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... type SΣ 0..1 CodeableConcept Description 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.


ele-1: All FHIR elements must have a @value or children
.... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... status ?!SΣ 1..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.


ele-1: All FHIR elements must have a @value or children
Fixed Value: active
... name SΣ 1..1 string Name by which a facility or location is known.
ele-1: All FHIR elements must have a @value or children
... alias S 0..* string A list of alternate names that the location is known as, or was known as, in the past
ele-1: All FHIR elements must have a @value or children
... description SΣ 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
ele-1: All FHIR elements must have a @value or children
... type SΣ 0..* CodeableConcept Category of service or resource available in a location.
Binding: ServiceDeliveryLocationRoleType (extensible)
ele-1: All FHIR elements must have a @value or children
... telecom S 0..* ContactPoint Contact details of the location
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... contactpoint-availabletime S 0..* (Complex) Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... via-intermediary S 0..* 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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
.... value SΣ 0..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
... address S 0..1 Address Physical location
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example General: 49 MEADOW ST
.... city SΣ 0..1 string Name of city, town etc.
ele-1: All FHIR elements must have a @value or children
Example General: Erewhon
Example General: EVERYTOWN
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.


ele-1: All FHIR elements must have a @value or children
Example General: OK
.... postalCode SΣ 0..1 string US Zip Codes
ele-1: All FHIR elements must have a @value or children
Example General: 9132
Example General: 74047
... position S 0..1 BackboneElement The absolute geographic location
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... longitude 1..1 decimal Longitude with WGS84 datum
ele-1: All FHIR elements must have a @value or children
.... latitude 1..1 decimal Latitude with WGS84 datum
ele-1: All FHIR elements must have a @value or children
... managingOrganization SΣ 0..1 Reference(Plan-Net Organization) Organization responsible for provisioning and upkeep
ele-1: All FHIR elements must have a @value or children
... partOf S 0..1 Reference(Plan-Net Location) Another Location this one is physically a part of
ele-1: All FHIR elements must have a @value or children
... hoursOfOperation S 0..* BackboneElement What days/times during a week is this location usually open
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... daysOfWeek S 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


ele-1: All FHIR elements must have a @value or children
.... allDay S 0..1 boolean The Location is open all day
ele-1: All FHIR elements must have a @value or children
.... openingTime S 0..1 time Time that the Location opens
ele-1: All FHIR elements must have a @value or children
.... closingTime S 0..1 time Time that the Location closes
ele-1: All FHIR elements must have a @value or children
... availabilityExceptions S 0..1 string Description of availability exceptions
ele-1: All FHIR elements must have a @value or children
... endpoint S 0..* Reference(Plan-Net Endpoint) Technical endpoints providing access to services operated for the location
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* USCoreLocationProfile(7.0.0) Details and position information for a physical place
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 1..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags 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..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... newpatients SC 0..* (Complex) New Patients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
new-patients-characteristics: If no new patients are accepted, no characteristics are allowed
.... accessibility S 0..* CodeableConcept Accessibility
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/accessibility
Binding: Accessibility VS (extensible)
.... region S 0..1 Attachment Associated Region (GeoJSON)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Unique business identifier for facility or location.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ 0..1 CodeableConcept Description 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..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.


Fixed Value: active
... 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 by which a facility or location is known.
... alias S 0..* string A list of alternate names that the location is known as, or was known as, in the past
... description SΣ 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
... type SΣ 0..* CodeableConcept Category of service or resource available in a location.
Binding: ServiceDeliveryLocationRoleType (extensible)
... telecom S 0..* ContactPoint Contact details of the 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
..... contactpoint-availabletime S 0..* (Complex) Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
..... via-intermediary S 0..* 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ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... address S 0..1 Address Physical location
.... id 0..1 string Unique id for inter-element referencing
.... 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
Example General: 49 MEADOW ST
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
Example General: EVERYTOWN
.... 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.


Example General: OK
.... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
Example General: 74047
.... 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 S 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(Plan-Net Organization) Organization responsible for provisioning and upkeep
... partOf S 0..1 Reference(Plan-Net Location) Another Location this one is physically a part of
... hoursOfOperation S 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 S 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay S 0..1 boolean The Location is open all day
.... openingTime S 0..1 time Time that the Location opens
.... closingTime S 0..1 time Time that the Location closes
... availabilityExceptions S 0..1 string Description of availability exceptions
... endpoint S 0..* Reference(Plan-Net Endpoint) Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Location.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Location.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Location.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.operationalStatuspreferredHl7VSBedStatus
http://terminology.hl7.org/ValueSet/v2-0116
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron