eHealthExchange Healthcare Directory Implementation Guide
1.0.5 - Release 1 United States of America flag

Resource Profile: eHx Subparticipant Location

Official URL: https://sequoiaproject.org/fhir/ehx/StructureDefinition/eHxSubparticipantLocation Version: 1.0.5
Active as of 2024-03-29 Computable Name: EHxSubparticipantLocation

Copyright/Legal: This document is copyright 2017-2021 by The Sequoia Project. All rights reserved world wide.

Usage:

Formal Views of Profile Content

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

This structure is derived from SequoiaLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*SequoiaLocationDetails and position information for a physical place
ehx-sub-part-loc-1: If Location.type is “administrative”, then require an OrgRole extension for eHx Subparticipant Location.
... type S1..*CodeableConceptType of function performed

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ehx-sub-part-loc-1errorLocationIf Location.type is “administrative”, then require an OrgRole extension for eHx Subparticipant Location.
: type.where(coding.code='administrative').exists() implies extension.where(url='https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgRole').exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*SequoiaLocationDetails and position information for a physical place
ehx-sub-part-loc-1: If Location.type is “administrative”, then require an OrgRole extension for eHx Subparticipant Location.
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... OrgRole S0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgRole
Binding: OrganizationAffiliationRole (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... type SΣ1..*CodeableConceptType of function performed
Binding: Sequoia Service Delivery Location Role Type Value Set (required)
... position S1..1BackboneElementThe absolute geographic location
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.typerequiredSequoiaServiceDeliveryLocationRoleTypeValueSet
https://sequoiaproject.org/fhir/sphd/ValueSet/SequoiaServiceDeliveryLocationRoleTypeValueSet
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLocationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorLocationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLocationA resource should have narrative for robust management
: text.`div`.exists()
ehx-sub-part-loc-1errorLocationIf Location.type is “administrative”, then require an OrgRole extension for eHx Subparticipant Location.
: type.where(coding.code='administrative').exists() implies extension.where(url='https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgRole').exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*SequoiaLocationDetails and position information for a physical place
ehx-sub-part-loc-1: If Location.type is “administrative”, then require an OrgRole extension for eHx Subparticipant 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
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... OrgRole S0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgRole
Binding: OrganizationAffiliationRole (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
... status ?!Σ0..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... operationalStatus Σ0..1CodingThe operational status of the location (typically only for a bed/room)
Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).

... name Σ0..1stringName of the location as used by humans
... alias 0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description Σ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode Σ0..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type SΣ1..*CodeableConceptType of function performed
Binding: Sequoia Service Delivery Location Role Type Value Set (required)
... telecom 0..*ContactPointContact details of the location
... address 0..1AddressPhysical location
... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example): Physical form of the location.

... position S1..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 Σ0..1Reference(Organization)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Location)Another Location this one is physically a part of
... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.operationalStatuspreferredHl7VSBedStatus
http://terminology.hl7.org/ValueSet/v2-0116
Location.moderequiredLocationMode
http://hl7.org/fhir/ValueSet/location-mode|4.0.1
from the FHIR Standard
Location.typerequiredSequoiaServiceDeliveryLocationRoleTypeValueSet
https://sequoiaproject.org/fhir/sphd/ValueSet/SequoiaServiceDeliveryLocationRoleTypeValueSet
from this IG
Location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLocationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorLocationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLocationA resource should have narrative for robust management
: text.`div`.exists()
ehx-sub-part-loc-1errorLocationIf Location.type is “administrative”, then require an OrgRole extension for eHx Subparticipant Location.
: type.where(coding.code='administrative').exists() implies extension.where(url='https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgRole').exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from SequoiaLocation

Summary

Mandatory: 1 element
Must-Support: 1 element

Differential View

This structure is derived from SequoiaLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*SequoiaLocationDetails and position information for a physical place
ehx-sub-part-loc-1: If Location.type is “administrative”, then require an OrgRole extension for eHx Subparticipant Location.
... type S1..*CodeableConceptType of function performed

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ehx-sub-part-loc-1errorLocationIf Location.type is “administrative”, then require an OrgRole extension for eHx Subparticipant Location.
: type.where(coding.code='administrative').exists() implies extension.where(url='https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgRole').exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*SequoiaLocationDetails and position information for a physical place
ehx-sub-part-loc-1: If Location.type is “administrative”, then require an OrgRole extension for eHx Subparticipant Location.
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... OrgRole S0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgRole
Binding: OrganizationAffiliationRole (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... type SΣ1..*CodeableConceptType of function performed
Binding: Sequoia Service Delivery Location Role Type Value Set (required)
... position S1..1BackboneElementThe absolute geographic location
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.typerequiredSequoiaServiceDeliveryLocationRoleTypeValueSet
https://sequoiaproject.org/fhir/sphd/ValueSet/SequoiaServiceDeliveryLocationRoleTypeValueSet
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLocationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorLocationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLocationA resource should have narrative for robust management
: text.`div`.exists()
ehx-sub-part-loc-1errorLocationIf Location.type is “administrative”, then require an OrgRole extension for eHx Subparticipant Location.
: type.where(coding.code='administrative').exists() implies extension.where(url='https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgRole').exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*SequoiaLocationDetails and position information for a physical place
ehx-sub-part-loc-1: If Location.type is “administrative”, then require an OrgRole extension for eHx Subparticipant 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
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... OrgRole S0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgRole
Binding: OrganizationAffiliationRole (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
... status ?!Σ0..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... operationalStatus Σ0..1CodingThe operational status of the location (typically only for a bed/room)
Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).

... name Σ0..1stringName of the location as used by humans
... alias 0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description Σ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode Σ0..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type SΣ1..*CodeableConceptType of function performed
Binding: Sequoia Service Delivery Location Role Type Value Set (required)
... telecom 0..*ContactPointContact details of the location
... address 0..1AddressPhysical location
... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example): Physical form of the location.

... position S1..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 Σ0..1Reference(Organization)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Location)Another Location this one is physically a part of
... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.operationalStatuspreferredHl7VSBedStatus
http://terminology.hl7.org/ValueSet/v2-0116
Location.moderequiredLocationMode
http://hl7.org/fhir/ValueSet/location-mode|4.0.1
from the FHIR Standard
Location.typerequiredSequoiaServiceDeliveryLocationRoleTypeValueSet
https://sequoiaproject.org/fhir/sphd/ValueSet/SequoiaServiceDeliveryLocationRoleTypeValueSet
from this IG
Location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLocationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorLocationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLocationA resource should have narrative for robust management
: text.`div`.exists()
ehx-sub-part-loc-1errorLocationIf Location.type is “administrative”, then require an OrgRole extension for eHx Subparticipant Location.
: type.where(coding.code='administrative').exists() implies extension.where(url='https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgRole').exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from SequoiaLocation

Summary

Mandatory: 1 element
Must-Support: 1 element

 

Other representations of profile: CSV, Excel, Schematron