Healthcare Financial Services IG Edition 1 - Local Development build (v0.4.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/location | Version: 0.4.0 | |||
Draft as of 2025-10-12 | Computable Name: NphiesLocation | |||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License |
Location - Department Profile
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Location | Details and position information for a physical place | |
![]() ![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact Max Length:64 |
![]() ![]() ![]() |
Σ | 1..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
Σ | 1..* | DP_canonical(StructureDefinition) | Profiles this resource claims to conform to |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 0..1 | DP_Identifier_A | Unique code or number identifying the location to its users |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (required) |
![]() ![]() ![]() ![]() |
Σ | 1..1 | DP_uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 Max Length:50 |
![]() ![]() ![]() |
?!Σ | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. Required Pattern: active |
![]() ![]() ![]() |
Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: v2.0116 (2.9) ![]() |
![]() ![]() ![]() |
Σ | 1..1 | DP_CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (3.0.0) (required) |
![]() ![]() ![]() |
Σ | 1..1 | DP_Reference_1or2a(Nphies Provider Organization) | Organization responsible for provisioning and upkeep |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL Max Length:250 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | DP_CodeableConcept | Description of identifier Binding: Organization Identifier (required) |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | DP_uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 Max Length:50 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource Max Length:200 |
![]() |
Path | Status | Usage | ValueSet | Version | Source |
Location.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
Location.identifier.type | Base | required | IdentifierType | 📦4.0.1 | FHIR Std. |
Location.status | Base | required | LocationStatus | 📍4.0.1 | FHIR Std. |
Location.operationalStatus | Base | required |
v2 BED STATUS
![]() |
📍2.9 | tx.fhir.org |
Location.type | Base | required | ServiceDeliveryLocationRoleType | 📍3.0.0 | THO v6.5 |
Location.managingOrganization.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
Location.managingOrganization.identifier.type | Base | required | Organization Identifier | 📦0.4.0 | This IG |
Id | Grade | Path(s) | Description | Expression |
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
dom-6 | best practice | Location | A resource should have narrative for robust management |
text.`div`.exists()
|
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Location
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Location | Details and position information for a physical place | |
![]() ![]() ![]() |
1..1 | id | Logical id of this artifact Max Length:64 | |
![]() ![]() ![]() |
1..1 | Meta | Metadata about the resource | |
![]() ![]() ![]() ![]() |
1..* | DP_canonical(StructureDefinition) | Profiles this resource claims to conform to | |
![]() ![]() ![]() |
S | 0..1 | DP_Identifier_A | Unique code or number identifying the location to its users |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (required) | |
![]() ![]() ![]() |
1..1 | code | active | suspended | inactive Required Pattern: active | |
![]() ![]() ![]() |
0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: v2.0116 (2.9) ![]() | |
![]() ![]() ![]() |
1..1 | DP_CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (3.0.0) (required) | |
![]() ![]() ![]() |
1..1 | DP_Reference_1or2a(Nphies Provider Organization) | Organization responsible for provisioning and upkeep | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
1..1 | DP_CodeableConcept | Description of identifier Binding: Organization Identifier (required) | |
![]() |
Path | Status | Usage | ValueSet | Version | Source |
Location.identifier.type | Base | required | IdentifierType | 📦4.0.1 | FHIR Std. |
Location.operationalStatus | Base | required |
v2 BED STATUS
![]() |
📍2.9 | tx.fhir.org |
Location.type | Base | required | ServiceDeliveryLocationRoleType | 📍3.0.0 | THO v6.5 |
Location.managingOrganization.identifier.type | Base | required | Organization Identifier | 📦0.4.0 | This IG |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Location | Details and position information for a physical place | |||||
![]() ![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact Max Length:64 | ||||
![]() ![]() ![]() |
Σ | 1..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 1..* | DP_canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 0..1 | DP_Identifier_A | Unique code or number identifying the location to its users | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | DP_uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 Max Length:50 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. Required Pattern: active | ||||
![]() ![]() ![]() |
Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: v2.0116 (2.9) ![]() | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name of the location as used by humans | ||||
![]() ![]() ![]() |
0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |||||
![]() ![]() ![]() |
Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. | ||||
![]() ![]() ![]() |
Σ | 1..1 | DP_CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (3.0.0) (required) | ||||
![]() ![]() ![]() |
0..* | ContactPoint | Contact details of the location | |||||
![]() ![]() ![]() |
0..1 | Address | Physical location | |||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example): Physical form of the location. | ||||
![]() ![]() ![]() |
0..1 | BackboneElement | The absolute geographic location | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | decimal | Longitude with WGS84 datum | |||||
![]() ![]() ![]() ![]() |
1..1 | decimal | Latitude with WGS84 datum | |||||
![]() ![]() ![]() ![]() |
0..1 | decimal | Altitude with WGS84 datum | |||||
![]() ![]() ![]() |
Σ | 1..1 | DP_Reference_1or2a(Nphies Provider Organization) | Organization responsible for provisioning and upkeep | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL Max Length:250 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | DP_CodeableConcept | Description of identifier Binding: Organization Identifier (required) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | DP_uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 Max Length:50 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource Max Length:200 | ||||
![]() ![]() ![]() |
0..1 | Reference(Location) | Another Location this one is physically a part of | |||||
![]() ![]() ![]() |
0..* | BackboneElement | What days/times during a week is this location usually open | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | The Location is open all day | |||||
![]() ![]() ![]() ![]() |
0..1 | time | Time that the Location opens | |||||
![]() ![]() ![]() ![]() |
0..1 | time | Time that the Location closes | |||||
![]() ![]() ![]() |
0..1 | string | Description of availability exceptions | |||||
![]() ![]() ![]() |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
![]() |
Path | Status | Usage | ValueSet | Version | Source |
Location.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
Location.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
Location.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
Location.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
Location.identifier.type | Base | required | IdentifierType | 📦4.0.1 | FHIR Std. |
Location.status | Base | required | LocationStatus | 📍4.0.1 | FHIR Std. |
Location.operationalStatus | Base | required |
v2 BED STATUS
![]() |
📍2.9 | tx.fhir.org |
Location.mode | Base | required | LocationMode | 📍4.0.1 | FHIR Std. |
Location.type | Base | required | ServiceDeliveryLocationRoleType | 📍3.0.0 | THO v6.5 |
Location.physicalType | Base | example | Location type | 📍4.0.1 | FHIR Std. |
Location.managingOrganization.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
Location.managingOrganization.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
Location.managingOrganization.identifier.type | Base | required | Organization Identifier | 📦0.4.0 | This IG |
Location.hoursOfOperation.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
Id | Grade | Path(s) | Description | Expression |
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
dom-6 | best practice | Location | A resource should have narrative for robust management |
text.`div`.exists()
|
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Location
Summary
Mandatory: 6 elements
Must-Support: 1 element
Structures
This structure refers to these other structures:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Location | Details and position information for a physical place | |
![]() ![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact Max Length:64 |
![]() ![]() ![]() |
Σ | 1..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
Σ | 1..* | DP_canonical(StructureDefinition) | Profiles this resource claims to conform to |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 0..1 | DP_Identifier_A | Unique code or number identifying the location to its users |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (required) |
![]() ![]() ![]() ![]() |
Σ | 1..1 | DP_uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 Max Length:50 |
![]() ![]() ![]() |
?!Σ | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. Required Pattern: active |
![]() ![]() ![]() |
Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: v2.0116 (2.9) ![]() |
![]() ![]() ![]() |
Σ | 1..1 | DP_CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (3.0.0) (required) |
![]() ![]() ![]() |
Σ | 1..1 | DP_Reference_1or2a(Nphies Provider Organization) | Organization responsible for provisioning and upkeep |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL Max Length:250 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | DP_CodeableConcept | Description of identifier Binding: Organization Identifier (required) |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | DP_uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 Max Length:50 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource Max Length:200 |
![]() |
Path | Status | Usage | ValueSet | Version | Source |
Location.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
Location.identifier.type | Base | required | IdentifierType | 📦4.0.1 | FHIR Std. |
Location.status | Base | required | LocationStatus | 📍4.0.1 | FHIR Std. |
Location.operationalStatus | Base | required |
v2 BED STATUS
![]() |
📍2.9 | tx.fhir.org |
Location.type | Base | required | ServiceDeliveryLocationRoleType | 📍3.0.0 | THO v6.5 |
Location.managingOrganization.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
Location.managingOrganization.identifier.type | Base | required | Organization Identifier | 📦0.4.0 | This IG |
Id | Grade | Path(s) | Description | Expression |
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
dom-6 | best practice | Location | A resource should have narrative for robust management |
text.`div`.exists()
|
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Location
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Location | Details and position information for a physical place | |
![]() ![]() ![]() |
1..1 | id | Logical id of this artifact Max Length:64 | |
![]() ![]() ![]() |
1..1 | Meta | Metadata about the resource | |
![]() ![]() ![]() ![]() |
1..* | DP_canonical(StructureDefinition) | Profiles this resource claims to conform to | |
![]() ![]() ![]() |
S | 0..1 | DP_Identifier_A | Unique code or number identifying the location to its users |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (required) | |
![]() ![]() ![]() |
1..1 | code | active | suspended | inactive Required Pattern: active | |
![]() ![]() ![]() |
0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: v2.0116 (2.9) ![]() | |
![]() ![]() ![]() |
1..1 | DP_CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (3.0.0) (required) | |
![]() ![]() ![]() |
1..1 | DP_Reference_1or2a(Nphies Provider Organization) | Organization responsible for provisioning and upkeep | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
1..1 | DP_CodeableConcept | Description of identifier Binding: Organization Identifier (required) | |
![]() |
Path | Status | Usage | ValueSet | Version | Source |
Location.identifier.type | Base | required | IdentifierType | 📦4.0.1 | FHIR Std. |
Location.operationalStatus | Base | required |
v2 BED STATUS
![]() |
📍2.9 | tx.fhir.org |
Location.type | Base | required | ServiceDeliveryLocationRoleType | 📍3.0.0 | THO v6.5 |
Location.managingOrganization.identifier.type | Base | required | Organization Identifier | 📦0.4.0 | This IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Location | Details and position information for a physical place | |||||
![]() ![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact Max Length:64 | ||||
![]() ![]() ![]() |
Σ | 1..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 1..* | DP_canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 0..1 | DP_Identifier_A | Unique code or number identifying the location to its users | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | DP_uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 Max Length:50 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. Required Pattern: active | ||||
![]() ![]() ![]() |
Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: v2.0116 (2.9) ![]() | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name of the location as used by humans | ||||
![]() ![]() ![]() |
0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |||||
![]() ![]() ![]() |
Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. | ||||
![]() ![]() ![]() |
Σ | 1..1 | DP_CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (3.0.0) (required) | ||||
![]() ![]() ![]() |
0..* | ContactPoint | Contact details of the location | |||||
![]() ![]() ![]() |
0..1 | Address | Physical location | |||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example): Physical form of the location. | ||||
![]() ![]() ![]() |
0..1 | BackboneElement | The absolute geographic location | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | decimal | Longitude with WGS84 datum | |||||
![]() ![]() ![]() ![]() |
1..1 | decimal | Latitude with WGS84 datum | |||||
![]() ![]() ![]() ![]() |
0..1 | decimal | Altitude with WGS84 datum | |||||
![]() ![]() ![]() |
Σ | 1..1 | DP_Reference_1or2a(Nphies Provider Organization) | Organization responsible for provisioning and upkeep | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL Max Length:250 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | DP_CodeableConcept | Description of identifier Binding: Organization Identifier (required) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | DP_uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 Max Length:50 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource Max Length:200 | ||||
![]() ![]() ![]() |
0..1 | Reference(Location) | Another Location this one is physically a part of | |||||
![]() ![]() ![]() |
0..* | BackboneElement | What days/times during a week is this location usually open | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | The Location is open all day | |||||
![]() ![]() ![]() ![]() |
0..1 | time | Time that the Location opens | |||||
![]() ![]() ![]() ![]() |
0..1 | time | Time that the Location closes | |||||
![]() ![]() ![]() |
0..1 | string | Description of availability exceptions | |||||
![]() ![]() ![]() |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
![]() |
Path | Status | Usage | ValueSet | Version | Source |
Location.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
Location.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
Location.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
Location.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
Location.identifier.type | Base | required | IdentifierType | 📦4.0.1 | FHIR Std. |
Location.status | Base | required | LocationStatus | 📍4.0.1 | FHIR Std. |
Location.operationalStatus | Base | required |
v2 BED STATUS
![]() |
📍2.9 | tx.fhir.org |
Location.mode | Base | required | LocationMode | 📍4.0.1 | FHIR Std. |
Location.type | Base | required | ServiceDeliveryLocationRoleType | 📍3.0.0 | THO v6.5 |
Location.physicalType | Base | example | Location type | 📍4.0.1 | FHIR Std. |
Location.managingOrganization.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
Location.managingOrganization.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
Location.managingOrganization.identifier.type | Base | required | Organization Identifier | 📦0.4.0 | This IG |
Location.hoursOfOperation.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
Id | Grade | Path(s) | Description | Expression |
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
dom-6 | best practice | Location | A resource should have narrative for robust management |
text.`div`.exists()
|
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Location
Summary
Mandatory: 6 elements
Must-Support: 1 element
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron