Da Vinci PDex Plan Net
1.2.0 - STU1.2 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.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* USCoreLocationProfile(7.0.0) Details and position information for a physical place
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:newpatients SC 0..* (Complex) New Patients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
Constraints: new-patients-characteristics
.... extension:accessibility S 0..* CodeableConcept Accessibility
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/accessibility
Binding: Accessibility VS (extensible)
.... extension: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
.... 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.
.... value SΣ 0..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.
Fixed Value: active
... 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
.... Slices for extension Content/Rules for all slices
..... extension:contactpoint-availabletime S 0..* (Complex) Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
..... extension: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.
... address S 0..1 Address Physical location
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... 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
.... 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
... position S 0..1 BackboneElement The absolute geographic location
.... 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
... 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
.... 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

Path Status Usage ValueSet Version Source
Location.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.2
Location.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Location.telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.address.state Base extensible USPS Two Letter Alphabetic Codes 📦7.0.0 US Core v7.0
Location.hoursOfOperation.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Location If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Location If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Location A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
new-patients-characteristics error Location.extension:newpatients If no new patients are accepted, no characteristics are allowed extension.where(url='acceptingPatients').value.ofType(CodeableConcept).coding.where(code = 'no') implies extension.where(url='characteristics').empty()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* USCoreLocationProfile(7.0.0) Details and position information for a physical place
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:newpatients S 0..* (Complex) New Patients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
.... extension:accessibility S 0..* CodeableConcept Accessibility
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/accessibility
Binding: Accessibility VS (extensible)
.... extension: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
... status 1..1 code active | suspended | inactive
Fixed Value: active
... 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 instance | kind
... telecom
.... Slices for extension Content/Rules for all slices
..... extension:contactpoint-availabletime S 0..* (Complex) Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
..... extension: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 & Constraints    Filter: Filtersdoco
.. 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
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:newpatients SC 0..* (Complex) New Patients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
Constraints: new-patients-characteristics
.... extension:accessibility S 0..* CodeableConcept Accessibility
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/accessibility
Binding: Accessibility VS (extensible)
.... extension: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
..... extension:contactpoint-availabletime S 0..* (Complex) Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
..... extension: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

Path Status Usage ValueSet Version Source
Location.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Location.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.operationalStatus Base preferred hl7VS-bedStatus 📦3.0.0 THO v7.2
Location.type Base extensible ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.2
Location.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Location.telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.address.type Base required AddressType 📍4.0.1 FHIR Std.
Location.address.state Base extensible USPS Two Letter Alphabetic Codes 📦7.0.0 US Core v7.0
Location.physicalType Base example Location type 📦4.0.1 FHIR Std.
Location.hoursOfOperation.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Location If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Location If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Location A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
new-patients-characteristics error Location.extension:newpatients If no new patients are accepted, no characteristics are allowed extension.where(url='acceptingPatients').value.ofType(CodeableConcept).coding.where(code = 'no') implies extension.where(url='characteristics').empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* USCoreLocationProfile(7.0.0) Details and position information for a physical place
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:newpatients SC 0..* (Complex) New Patients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
Constraints: new-patients-characteristics
.... extension:accessibility S 0..* CodeableConcept Accessibility
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/accessibility
Binding: Accessibility VS (extensible)
.... extension: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
.... 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.
.... value SΣ 0..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.
Fixed Value: active
... 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
.... Slices for extension Content/Rules for all slices
..... extension:contactpoint-availabletime S 0..* (Complex) Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
..... extension: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.
... address S 0..1 Address Physical location
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... 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
.... 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
... position S 0..1 BackboneElement The absolute geographic location
.... 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
... 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
.... 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

Path Status Usage ValueSet Version Source
Location.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.2
Location.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Location.telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.address.state Base extensible USPS Two Letter Alphabetic Codes 📦7.0.0 US Core v7.0
Location.hoursOfOperation.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Location If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Location If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Location A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
new-patients-characteristics error Location.extension:newpatients If no new patients are accepted, no characteristics are allowed extension.where(url='acceptingPatients').value.ofType(CodeableConcept).coding.where(code = 'no') implies extension.where(url='characteristics').empty()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* USCoreLocationProfile(7.0.0) Details and position information for a physical place
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:newpatients S 0..* (Complex) New Patients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
.... extension:accessibility S 0..* CodeableConcept Accessibility
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/accessibility
Binding: Accessibility VS (extensible)
.... extension: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
... status 1..1 code active | suspended | inactive
Fixed Value: active
... 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 instance | kind
... telecom
.... Slices for extension Content/Rules for all slices
..... extension:contactpoint-availabletime S 0..* (Complex) Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
..... extension: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

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:newpatients SC 0..* (Complex) New Patients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
Constraints: new-patients-characteristics
.... extension:accessibility S 0..* CodeableConcept Accessibility
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/accessibility
Binding: Accessibility VS (extensible)
.... extension: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
..... extension:contactpoint-availabletime S 0..* (Complex) Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
..... extension: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

Path Status Usage ValueSet Version Source
Location.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Location.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.operationalStatus Base preferred hl7VS-bedStatus 📦3.0.0 THO v7.2
Location.type Base extensible ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.2
Location.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Location.telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.address.type Base required AddressType 📍4.0.1 FHIR Std.
Location.address.state Base extensible USPS Two Letter Alphabetic Codes 📦7.0.0 US Core v7.0
Location.physicalType Base example Location type 📦4.0.1 FHIR Std.
Location.hoursOfOperation.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Location If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Location If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Location A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
new-patients-characteristics error Location.extension:newpatients If no new patients are accepted, no characteristics are allowed extension.where(url='acceptingPatients').value.ofType(CodeableConcept).coding.where(code = 'no') implies extension.where(url='characteristics').empty()

 

Other representations of profile: CSV, Excel, Schematron