eHealthExchange Healthcare Directory Implementation Guide
1.6.0 - Release 1
eHealthExchange Healthcare Directory Implementation Guide
1.6.0 - Release 1
| Official URL: https://sequoiaproject.org/fhir/ehx/StructureDefinition/eHxSubparticipantLocation | Version: 1.6.0 | |||
| Active as of 2025-06-11 | Computable Name: EHxSubparticipantLocation | |||
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Location |
C | 0..* | SequoiaLocation | Details and position information for a physical place Constraints: ehx-sub-part-loc-1 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
Content/Rules for all slices | |||
   extension:orgrole |
S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgRole Binding: OrganizationAffiliationRole (required) |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
 type |
SΣ | 1..* | CodeableConcept | Type of function performed Binding: Sequoia Service Delivery Location Role Type Value Set (required) |
 position |
S | 1..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 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1From the FHIR Standard | |
| Location.type | required | SequoiaServiceDeliveryLocationRoleTypeValueSethttps://sequoiaproject.org/fhir/sphd/ValueSet/SequoiaServiceDeliveryLocationRoleTypeValueSetFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| ehx-sub-part-loc-1 | error | Location | If Location.type is “administrative”, then require an OrgRole extension for eHx Subparticipant Location. : type.where(coding.where(code='administrative').exists()).exists() implies extension.where(url='https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgRole').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() |
This structure is derived from SequoiaLocation
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Location |
C | 0..* | SequoiaLocation | Details and position information for a physical place Constraints: ehx-sub-part-loc-1 |
 type |
1..* | CodeableConcept | Type of function performed | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| ehx-sub-part-loc-1 | error | Location | If Location.type is “administrative”, then require an OrgRole extension for eHx Subparticipant Location. : type.where(coding.where(code='administrative').exists()).exists() implies extension.where(url='https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgRole').exists() |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Location |
C | 0..* | SequoiaLocation | Details and position information for a physical place Constraints: ehx-sub-part-loc-1 | ||||
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:orgrole |
S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgRole Binding: OrganizationAffiliationRole (required) | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Unique code or number identifying the location to its users | ||||
| status |
?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. | ||||
| 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 |
Σ | 0..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 | ||||
| mode |
Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. | ||||
| type |
SΣ | 1..* | CodeableConcept | Type of function performed Binding: Sequoia Service Delivery Location Role Type Value Set (required) | ||||
| telecom |
0..* | ContactPoint | Contact details of the location | |||||
| address |
0..1 | Address | Physical location | |||||
| physicalType |
Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example): Physical form of the location. | ||||
| position |
S | 1..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 |
Σ | 0..1 | Reference(Organization) | Organization responsible for provisioning and upkeep | ||||
| partOf |
0..1 | Reference(Location) | Another Location this one is physically a part of | |||||
| hoursOfOperation |
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 |
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(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Location.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1From the FHIR Standard | ||||
| Location.operationalStatus | preferred | Hl7VSBedStatushttp://terminology.hl7.org/ValueSet/v2-0116 | ||||
| Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1From the FHIR Standard | ||||
| Location.type | required | SequoiaServiceDeliveryLocationRoleTypeValueSethttps://sequoiaproject.org/fhir/sphd/ValueSet/SequoiaServiceDeliveryLocationRoleTypeValueSetFrom this IG | ||||
| Location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-typeFrom the FHIR Standard | ||||
| Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| ehx-sub-part-loc-1 | error | Location | If Location.type is “administrative”, then require an OrgRole extension for eHx Subparticipant Location. : type.where(coding.where(code='administrative').exists()).exists() implies extension.where(url='https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgRole').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() |
This structure is derived from SequoiaLocation
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Location |
C | 0..* | SequoiaLocation | Details and position information for a physical place Constraints: ehx-sub-part-loc-1 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| extension:orgrole |
S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgRole Binding: OrganizationAffiliationRole (required) |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
| type |
SΣ | 1..* | CodeableConcept | Type of function performed Binding: Sequoia Service Delivery Location Role Type Value Set (required) |
| position |
S | 1..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 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1From the FHIR Standard | |
| Location.type | required | SequoiaServiceDeliveryLocationRoleTypeValueSethttps://sequoiaproject.org/fhir/sphd/ValueSet/SequoiaServiceDeliveryLocationRoleTypeValueSetFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| ehx-sub-part-loc-1 | error | Location | If Location.type is “administrative”, then require an OrgRole extension for eHx Subparticipant Location. : type.where(coding.where(code='administrative').exists()).exists() implies extension.where(url='https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgRole').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() |
Differential View
This structure is derived from SequoiaLocation
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Location |
C | 0..* | SequoiaLocation | Details and position information for a physical place Constraints: ehx-sub-part-loc-1 |
| type |
1..* | CodeableConcept | Type of function performed | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| ehx-sub-part-loc-1 | error | Location | If Location.type is “administrative”, then require an OrgRole extension for eHx Subparticipant Location. : type.where(coding.where(code='administrative').exists()).exists() implies extension.where(url='https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgRole').exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Location |
C | 0..* | SequoiaLocation | Details and position information for a physical place Constraints: ehx-sub-part-loc-1 | ||||
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:orgrole |
S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgRole Binding: OrganizationAffiliationRole (required) | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Unique code or number identifying the location to its users | ||||
| status |
?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. | ||||
| 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 |
Σ | 0..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 | ||||
| mode |
Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. | ||||
| type |
SΣ | 1..* | CodeableConcept | Type of function performed Binding: Sequoia Service Delivery Location Role Type Value Set (required) | ||||
| telecom |
0..* | ContactPoint | Contact details of the location | |||||
| address |
0..1 | Address | Physical location | |||||
| physicalType |
Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example): Physical form of the location. | ||||
| position |
S | 1..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 |
Σ | 0..1 | Reference(Organization) | Organization responsible for provisioning and upkeep | ||||
| partOf |
0..1 | Reference(Location) | Another Location this one is physically a part of | |||||
| hoursOfOperation |
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 |
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(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Location.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1From the FHIR Standard | ||||
| Location.operationalStatus | preferred | Hl7VSBedStatushttp://terminology.hl7.org/ValueSet/v2-0116 | ||||
| Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1From the FHIR Standard | ||||
| Location.type | required | SequoiaServiceDeliveryLocationRoleTypeValueSethttps://sequoiaproject.org/fhir/sphd/ValueSet/SequoiaServiceDeliveryLocationRoleTypeValueSetFrom this IG | ||||
| Location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-typeFrom the FHIR Standard | ||||
| Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| ehx-sub-part-loc-1 | error | Location | If Location.type is “administrative”, then require an OrgRole extension for eHx Subparticipant Location. : type.where(coding.where(code='administrative').exists()).exists() implies extension.where(url='https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgRole').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() |
This structure is derived from SequoiaLocation
Other representations of profile: CSV, Excel, Schematron