This page is part of the DaVinci PDEX Plan Net (v1.0.0: STU 1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions
Defining URL: | http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location |
Version: | 1.0.0 |
Name: | PlannetLocation |
Title: | Plan-Net Location |
Status: | Active as of 2020-12-20T06:12:23+00:00 |
Definition: | 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. |
Publisher: | HL7 Financial Management Working Group |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreLocation
Summary
Mandatory: 1 element (1 nested mandatory element)
Must-Support: 21 elements
Fixed Value: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from USCoreLocation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | 0..* | USCoreLocation | Details and position information for a physical place | |
meta | ||||
lastUpdated | 1..1 | instant | When the resource version last changed | |
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 (extensible) |
location-boundary-geojson | 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 | |
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 | |||
type | S | 0..* | CodeableConcept | Type of function performed |
telecom | ||||
contactpoint-availabletime | S | 0..* | (Complex) | Extension 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 |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | 0..* | USCoreLocation | Details and position information for a physical place | |
id | Σ | 0..1 | string | 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 |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
newpatients | SI | 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 (extensible) |
location-boundary-geojson | 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 | Σ | 0..* | Identifier | Unique code or number identifying the location to its users |
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 of the location as used by humans |
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 | Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. |
telecom | S | 0..* | ContactPoint | Contact details of the 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 | |
contactpoint-availabletime | S | 0..* | (Complex) | Optional Extensions Element 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ΣI | 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 |
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
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. |
postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 |
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-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"} |
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 |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | 0..* | USCoreLocation | Details and position information for a physical place | |
newpatients | I | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients |
accessibility | 0..* | CodeableConcept | Accessibility URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/accessibility Binding: Accessibility (extensible) | |
location-boundary-geojson | 0..1 | Attachment | Associated Region (GeoJSON) URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson | |
identifier | Σ | 0..* | Identifier | Unique code or number identifying the location to its users |
type | Σ | 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 | Σ | 0..1 | string | The value that is unique |
status | ?!Σ | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. Fixed Value: active |
name | Σ | 1..1 | string | Name of the location as used by humans |
alias | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |
description | Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name |
type | Σ | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. |
telecom | 0..* | ContactPoint | Contact details of the location | |
contactpoint-availabletime | 0..* | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime | |
via-intermediary | 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 | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
value | Σ | 0..1 | string | The actual contact point details |
address | 0..1 | Address | Physical location | |
line | Σ | 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 |
city | Σ | 0..1 | string | Name of city, town etc. |
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. |
postalCode | Σ | 0..1 | string | US Zip Codes |
position | 0..1 | BackboneElement | The absolute geographic location | |
managingOrganization | Σ | 0..1 | Reference(Plan-Net Organization) | Organization responsible for provisioning and upkeep |
partOf | 0..1 | Reference(Plan-Net Location) | Another Location this one is physically a part of | |
hoursOfOperation | 0..* | BackboneElement | What days/times during a week is this location usually open | |
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |
allDay | 0..1 | boolean | The Location is open all day | |
openingTime | 0..1 | time | Time that the Location opens | |
closingTime | 0..1 | time | Time that the Location closes | |
availabilityExceptions | 0..1 | string | Description of availability exceptions | |
endpoint | 0..* | Reference(Plan-Net Endpoint) | Technical endpoints providing access to services operated for the location | |
Documentation for this format |
This structure is derived from USCoreLocation
Summary
Mandatory: 1 element (1 nested mandatory element)
Must-Support: 21 elements
Fixed Value: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from USCoreLocation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | 0..* | USCoreLocation | Details and position information for a physical place | |
meta | ||||
lastUpdated | 1..1 | instant | When the resource version last changed | |
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 (extensible) |
location-boundary-geojson | 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 | |
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 | |||
type | S | 0..* | CodeableConcept | Type of function performed |
telecom | ||||
contactpoint-availabletime | S | 0..* | (Complex) | Extension 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 |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | 0..* | USCoreLocation | Details and position information for a physical place | |
id | Σ | 0..1 | string | 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 |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
newpatients | SI | 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 (extensible) |
location-boundary-geojson | 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 | Σ | 0..* | Identifier | Unique code or number identifying the location to its users |
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 of the location as used by humans |
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 | Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. |
telecom | S | 0..* | ContactPoint | Contact details of the 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 | |
contactpoint-availabletime | S | 0..* | (Complex) | Optional Extensions Element 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ΣI | 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 |
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
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. |
postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 |
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-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"} |
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 |
Documentation for this format |
Other representations of profile: Schematron
Path | Conformance | ValueSet / Code |
Location.meta.security | extensible | All Security Labels |
Location.meta.tag | example | CommonTags |
Location.language | preferred | CommonLanguages Max Binding: AllLanguages |
Location.identifier.use | required | IdentifierUse |
Location.identifier.type | extensible | Identifier Type Codes |
Location.status | required | Fixed Value: active |
Location.operationalStatus | preferred | Hl7VSBedStatus |
Location.type | extensible | ServiceDeliveryLocationRoleType |
Location.telecom.system | required | ContactPointSystem |
Location.telecom.use | required | ContactPointUse |
Location.address.use | required | AddressUse |
Location.address.type | required | AddressType |
Location.address.state | extensible | UspsTwoLetterAlphabeticCodes |
Location.physicalType | example | LocationType |
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeek |