DaVinci PDEX Plan Net STU Ballot

This page is part of the DaVinci PDEX Plan Net (v0.1.0: STU 1 Ballot 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

Location

 

The official URL for this profile is: 

http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location

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.

This profile builds on USCoreLocation.

This profile was published on Wed Oct 23 00:00:00 EDT 2019 as a active by HL7 Financial Management WG.

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 24 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

plannet.Location maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-location:
  Accessibility maps to http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility
  NewPatients maps to extension
  NewPatientProfile maps to http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile
  TViaIntermediary maps to telecom.extension
  TAvailableTime maps to telecom.extension
  PN_Identifier.IdentifierUse maps to identifier.use
  PN_Identifier.IdentifierSystem maps to identifier.system
  PN_Identifier.IdentifierValue maps to identifier.value
  PN_Identifier.IdentifierType maps to identifier.type
  PN_Identifier.IdentifierPeriod maps to identifier.period
  PN_Identifier.IdentifierAssigner maps to identifier.assigner
  LocationStatus maps to status
  LocationType maps to type
  LocationName maps to name
  LocationAlias maps to alias
  LocationDescription maps to description
  LocationTelecom maps to telecom
  LocationTelecom.ContactPoint.Purpose maps to telecom.use
  LocationTelecom.ContactPoint.Type maps to telecom.system
  LocationTelecom.ContactPoint.PriorityRank maps to telecom.rank
  LocationTelecom.ContactPoint.EffectiveTimePeriod maps to telecom.period
  LocationTelecom.ContactPoint.TelecomNumberOrAddress maps to telecom.value
  LocationAddress maps to address
  LocationPhysicalType maps to physicalType
  LocationPosition maps to position
  LocationHoursOfOperation.AvailableTime maps to hoursOfOperation
  LocationHoursOfOperation.AvailableTime.DaysOfWeek maps to hoursOfOperation.daysOfWeek
  LocationHoursOfOperation.AvailableTime.AllDay maps to hoursOfOperation.allDay
  LocationHoursOfOperation.AvailableTime.AvailableStartTime maps to hoursOfOperation.openingTime
  LocationHoursOfOperation.AvailableTime.AvailableEndTime maps to hoursOfOperation.closingTime
  AvailabilityExceptions maps to availabilityExceptions
  LocationEndpoint maps to endpoint
  ManagingOrganization maps to managingOrganization
  PartOfLocation maps to partOf
  constrain operationalStatus to 0..0
  constrain mode to 0..0
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location plannet-Location
... extension Slice: Unordered, Open by value:url
... plannet-NewPatients-extension S0..*(Complex)NewPatients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-NewPatients-extension
... accessibility S0..*CodeableConcept​Accessibility
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility
Binding: VhDir Accessibility Value Set (example)
... newpatientprofile S0..*string​New patient profile
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile
... identifier
.... use S
.... type S
.... system S
.... value S
.... period S
.... assigner SReference(plannet-Organization)
... status 1..1
... operationalStatus 0..0
... alias S
... description S
... mode 0..0
... type S
... telecom
.... plannet-CViaIntermediary-extension S0..*Reference(plannet-PractitionerRole | plannet-Organization | plannet-OrganizationAffiliation | plannet-Location)CViaIntermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-CViaIntermediary-extension
.... contactpoint-availabletime S0..*(Complex)​Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
... physicalType S
... position S
... managingOrganization Reference(plannet-Organization)
... partOf SReference(plannet-Location)
... hoursOfOperation S
.... daysOfWeek S
.... allDay S
.... openingTime S
.... closingTime S
... availabilityExceptions S
... endpoint SReference(plannet-Endpoint)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location I0..*plannet-Location
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... plannet-NewPatients-extension S0..*(Complex)NewPatients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-NewPatients-extension
... accessibility S0..*CodeableConcept​Accessibility
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility
Binding: VhDir Accessibility Value Set (example)
... newpatientprofile S0..*string​New patient profile
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... period SΣ0..1PeriodTime period when id is/was valid for use
.... assigner SΣ0..1Reference(plannet-Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | suspended | inactive
Binding: LocationStatus (required)
... name SΣ1..1stringName of the location as used by humans
... alias S0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description SΣ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... type SΣ0..*CodeableConceptType of function performed
Binding: V3 Value SetServiceDeliveryLocationRoleType (extensible)
... telecom S0..*ContactPointContact details of the location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... plannet-CViaIntermediary-extension S0..*Reference(plannet-PractitionerRole | plannet-Organization | plannet-OrganizationAffiliation | plannet-Location)CViaIntermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-CViaIntermediary-extension
.... contactpoint-availabletime S0..*(Complex)​Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address S0..1AddressPhysical location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
.... text Σ0..1stringText representation of the address
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
.... city SΣ0..1stringName of city, town etc.
.... district Σ0..1stringDistrict name (aka county)
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible)
.... postalCode SΣ0..1stringUS Zip Codes
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
... physicalType SΣ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example)
... position SI0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ0..1Reference(plannet-Organization)Organization responsible for provisioning and upkeep
... partOf S0..1Reference(plannet-Location)Another Location this one is physically a part of
... hoursOfOperation SI0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek S0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay S0..1booleanThe Location is open all day
.... openingTime S0..1timeTime that the Location opens
.... closingTime S0..1timeTime that the Location closes
... availabilityExceptions S0..1stringDescription of availability exceptions
... endpoint S0..*Reference(plannet-Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 24 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

plannet.Location maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-location:
  Accessibility maps to http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility
  NewPatients maps to extension
  NewPatientProfile maps to http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile
  TViaIntermediary maps to telecom.extension
  TAvailableTime maps to telecom.extension
  PN_Identifier.IdentifierUse maps to identifier.use
  PN_Identifier.IdentifierSystem maps to identifier.system
  PN_Identifier.IdentifierValue maps to identifier.value
  PN_Identifier.IdentifierType maps to identifier.type
  PN_Identifier.IdentifierPeriod maps to identifier.period
  PN_Identifier.IdentifierAssigner maps to identifier.assigner
  LocationStatus maps to status
  LocationType maps to type
  LocationName maps to name
  LocationAlias maps to alias
  LocationDescription maps to description
  LocationTelecom maps to telecom
  LocationTelecom.ContactPoint.Purpose maps to telecom.use
  LocationTelecom.ContactPoint.Type maps to telecom.system
  LocationTelecom.ContactPoint.PriorityRank maps to telecom.rank
  LocationTelecom.ContactPoint.EffectiveTimePeriod maps to telecom.period
  LocationTelecom.ContactPoint.TelecomNumberOrAddress maps to telecom.value
  LocationAddress maps to address
  LocationPhysicalType maps to physicalType
  LocationPosition maps to position
  LocationHoursOfOperation.AvailableTime maps to hoursOfOperation
  LocationHoursOfOperation.AvailableTime.DaysOfWeek maps to hoursOfOperation.daysOfWeek
  LocationHoursOfOperation.AvailableTime.AllDay maps to hoursOfOperation.allDay
  LocationHoursOfOperation.AvailableTime.AvailableStartTime maps to hoursOfOperation.openingTime
  LocationHoursOfOperation.AvailableTime.AvailableEndTime maps to hoursOfOperation.closingTime
  AvailabilityExceptions maps to availabilityExceptions
  LocationEndpoint maps to endpoint
  ManagingOrganization maps to managingOrganization
  PartOfLocation maps to partOf
  constrain operationalStatus to 0..0
  constrain mode to 0..0

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location plannet-Location
... extension Slice: Unordered, Open by value:url
... plannet-NewPatients-extension S0..*(Complex)NewPatients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-NewPatients-extension
... accessibility S0..*CodeableConcept​Accessibility
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility
Binding: VhDir Accessibility Value Set (example)
... newpatientprofile S0..*string​New patient profile
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile
... identifier
.... use S
.... type S
.... system S
.... value S
.... period S
.... assigner SReference(plannet-Organization)
... status 1..1
... operationalStatus 0..0
... alias S
... description S
... mode 0..0
... type S
... telecom
.... plannet-CViaIntermediary-extension S0..*Reference(plannet-PractitionerRole | plannet-Organization | plannet-OrganizationAffiliation | plannet-Location)CViaIntermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-CViaIntermediary-extension
.... contactpoint-availabletime S0..*(Complex)​Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
... physicalType S
... position S
... managingOrganization Reference(plannet-Organization)
... partOf SReference(plannet-Location)
... hoursOfOperation S
.... daysOfWeek S
.... allDay S
.... openingTime S
.... closingTime S
... availabilityExceptions S
... endpoint SReference(plannet-Endpoint)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location I0..*plannet-Location
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... plannet-NewPatients-extension S0..*(Complex)NewPatients
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-NewPatients-extension
... accessibility S0..*CodeableConcept​Accessibility
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility
Binding: VhDir Accessibility Value Set (example)
... newpatientprofile S0..*string​New patient profile
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... period SΣ0..1PeriodTime period when id is/was valid for use
.... assigner SΣ0..1Reference(plannet-Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | suspended | inactive
Binding: LocationStatus (required)
... name SΣ1..1stringName of the location as used by humans
... alias S0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description SΣ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... type SΣ0..*CodeableConceptType of function performed
Binding: V3 Value SetServiceDeliveryLocationRoleType (extensible)
... telecom S0..*ContactPointContact details of the location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... plannet-CViaIntermediary-extension S0..*Reference(plannet-PractitionerRole | plannet-Organization | plannet-OrganizationAffiliation | plannet-Location)CViaIntermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-CViaIntermediary-extension
.... contactpoint-availabletime S0..*(Complex)​Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address S0..1AddressPhysical location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
.... text Σ0..1stringText representation of the address
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
.... city SΣ0..1stringName of city, town etc.
.... district Σ0..1stringDistrict name (aka county)
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible)
.... postalCode SΣ0..1stringUS Zip Codes
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
... physicalType SΣ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example)
... position SI0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ0..1Reference(plannet-Organization)Organization responsible for provisioning and upkeep
... partOf S0..1Reference(plannet-Location)Another Location this one is physically a part of
... hoursOfOperation SI0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek S0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay S0..1booleanThe Location is open all day
.... openingTime S0..1timeTime that the Location opens
.... closingTime S0..1timeTime that the Location closes
... availabilityExceptions S0..1stringDescription of availability exceptions
... endpoint S0..*Reference(plannet-Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathConformanceValueSet
Location.languagepreferredCommonLanguages
Max Binding: AllLanguages
Location.identifier.userequiredIdentifierUse
Location.identifier.typeextensibleIdentifier Type Codes
Location.statusrequiredLocationStatus
Location.typeextensiblev3.ServiceDeliveryLocationRoleType
Location.telecom.systemrequiredContactPointSystem
Location.telecom.userequiredContactPointUse
Location.address.userequiredAddressUse
Location.address.typerequiredAddressType
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes
Location.physicalTypeexampleLocationType
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek

 

Constraints

IdPathDetailsRequirements
dom-2LocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4LocationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3LocationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6LocationA resource should have narrative for robust management
: text.div.exists()
dom-5LocationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
ele-1Location.positionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.hoursOfOperationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())