Guide d'implémentation Fr Core
2.1.0 - trial-use
Guide d'implémentation Fr Core, published by Interop'Santé. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Interop-Sante/hl7.fhir.fr.core/ and changes regularly. See the Directory of published versions
Official URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-location | Version: 2.1.0 | |||
Active as of 2024-10-29 | Computable Name: FRCoreLocationProfile |
French profile of Location.
Profil français de la ressource Location
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Location
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | Location | |||
meta | ||||
Slices for profile | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | |
profile:fr-canonical | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-location | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
usePeriod | 0..1 | Period | FR Core Use Period Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-use-period | |
identifier | 0..* | Identifier | Identifiant fonctionnel du lieu. Il est recommandé de remplir ce champs pour faciliter l'identification des ressources. | |
type | 1..1 | CodeableConcept | Description of identifier Binding: FR Core ValueSet Location identifier type (extensible) | |
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
assigner | 0..1 | Reference(FR Core Organization Profile) | Organization that issued id (may be just text) | |
type | 0..1 | CodeableConcept | Type of function performed Binding: FR Core ValueSet Location type (extensible) | |
telecom | 0..* | FRCoreContactPointProfile | Details of a Technology mediated contact point (phone, fax, email, etc.) | |
address | 0..1 | FRCoreAddressProfile | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
physicalType | 0..1 | CodeableConcept | Physical form of the location Binding: FR Core ValueSet Location physical type (example) | |
managingOrganization | 0..1 | Reference(FR Core Organization Profile) | Organization responsible for provisioning and upkeep | |
partOf | 0..1 | Reference(FR Core Location Profile) | Another Location this one is physically a part of | |
Slices for extension | Content/Rules for all slices | |||
positionRoom | 0..1 | Coding | FR Core Location Part Of Position Room Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-location-position-room Binding: FR Core ValueSet Location position room (extensible) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Location.identifier.type | extensible | FRCoreValueSetLocationIdentifierTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-location-identifier-type from this IG | |
Location.type | extensible | FRCoreValueSetLocationType (a valid code from FR Core CodeSystem Location Type)https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-location-type from this IG | |
Location.physicalType | example | FRCoreValueSetLocationPhysicalTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-location-physical-type from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | 0..* | Location | Details and position information for a physical place | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
usePeriod | 0..1 | Period | FR Core Use Period Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-use-period | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Identifiant fonctionnel du lieu. Il est recommandé de remplir ce champs pour faciliter l'identification des ressources. |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: FR Core ValueSet Location identifier type (extensible) |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
assigner | Σ | 0..1 | Reference(FR Core Organization Profile) | Organization that issued id (may be just text) |
status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
type | Σ | 0..1 | CodeableConcept | Type of function performed Binding: FR Core ValueSet Location type (extensible) |
telecom | C | 0..* | FRCoreContactPointProfile | Details of a Technology mediated contact point (phone, fax, email, etc.) cpt-2: A system is required if a value is provided. |
address | 0..1 | FRCoreAddressProfile | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
physicalType | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: FR Core ValueSet Location physical type (example) |
managingOrganization | Σ | 0..1 | Reference(FR Core Organization Profile) | Organization responsible for provisioning and upkeep |
partOf | 0..1 | Reference(FR Core Location Profile) | Another Location this one is physically a part of | |
Slices for extension | Content/Rules for all slices | |||
positionRoom | 0..1 | Coding | FR Core Location Part Of Position Room Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-location-position-room Binding: FR Core ValueSet Location position room (extensible) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Location.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Location.identifier.type | extensible | FRCoreValueSetLocationIdentifierTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-location-identifier-type from this IG | |
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | |
Location.type | extensible | FRCoreValueSetLocationType (a valid code from FR Core CodeSystem Location Type)https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-location-type from this IG | |
Location.physicalType | example | FRCoreValueSetLocationPhysicalTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-location-physical-type from this IG |
Id | Grade | Path(s) | Details | Requirements |
cpt-2 | error | Location.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Location | 0..* | Location | Details and position information for a physical place | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
Slices for profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | ||||
profile:fr-canonical | Σ | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-location | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): 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 | |||||
usePeriod | 0..1 | Period | FR Core Use Period Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-use-period | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Identifiant fonctionnel du lieu. Il est recommandé de remplir ce champs pour faciliter l'identification des ressources. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: FR Core ValueSet Location identifier type (extensible) | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(FR Core Organization Profile) | Organization that issued id (may be just text) | ||||
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 | Σ | 0..1 | CodeableConcept | Type of function performed Binding: FR Core ValueSet Location type (extensible) | ||||
telecom | C | 0..* | FRCoreContactPointProfile | Details of a Technology mediated contact point (phone, fax, email, etc.) cpt-2: A system is required if a value is provided. | ||||
address | 0..1 | FRCoreAddressProfile | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
physicalType | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: FR Core ValueSet Location physical type (example) | ||||
position | 0..1 | BackboneElement | The absolute geographic location | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
longitude | 1..1 | decimal | Longitude with WGS84 datum | |||||
latitude | 1..1 | decimal | Latitude with WGS84 datum | |||||
altitude | 0..1 | decimal | Altitude with WGS84 datum | |||||
managingOrganization | Σ | 0..1 | Reference(FR Core Organization Profile) | Organization responsible for provisioning and upkeep | ||||
partOf | 0..1 | Reference(FR Core Location Profile) | Another Location this one is physically a part of | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
positionRoom | 0..1 | Coding | FR Core Location Part Of Position Room Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-location-position-room Binding: FR Core ValueSet Location position room (extensible) | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 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). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
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.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Location.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Location.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Location.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Location.identifier.type | extensible | FRCoreValueSetLocationIdentifierTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-location-identifier-type from this IG | ||||
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from 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.1 from the FHIR Standard | ||||
Location.type | extensible | FRCoreValueSetLocationType (a valid code from FR Core CodeSystem Location Type)https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-location-type from this IG | ||||
Location.physicalType | example | FRCoreValueSetLocationPhysicalTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-location-physical-type from this IG | ||||
Location.partOf.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cpt-2 | error | Location.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
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: 0 element(3 nested mandatory elements)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Location
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | Location | |||
meta | ||||
Slices for profile | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | |
profile:fr-canonical | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-location | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
usePeriod | 0..1 | Period | FR Core Use Period Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-use-period | |
identifier | 0..* | Identifier | Identifiant fonctionnel du lieu. Il est recommandé de remplir ce champs pour faciliter l'identification des ressources. | |
type | 1..1 | CodeableConcept | Description of identifier Binding: FR Core ValueSet Location identifier type (extensible) | |
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
assigner | 0..1 | Reference(FR Core Organization Profile) | Organization that issued id (may be just text) | |
type | 0..1 | CodeableConcept | Type of function performed Binding: FR Core ValueSet Location type (extensible) | |
telecom | 0..* | FRCoreContactPointProfile | Details of a Technology mediated contact point (phone, fax, email, etc.) | |
address | 0..1 | FRCoreAddressProfile | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
physicalType | 0..1 | CodeableConcept | Physical form of the location Binding: FR Core ValueSet Location physical type (example) | |
managingOrganization | 0..1 | Reference(FR Core Organization Profile) | Organization responsible for provisioning and upkeep | |
partOf | 0..1 | Reference(FR Core Location Profile) | Another Location this one is physically a part of | |
Slices for extension | Content/Rules for all slices | |||
positionRoom | 0..1 | Coding | FR Core Location Part Of Position Room Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-location-position-room Binding: FR Core ValueSet Location position room (extensible) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Location.identifier.type | extensible | FRCoreValueSetLocationIdentifierTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-location-identifier-type from this IG | |
Location.type | extensible | FRCoreValueSetLocationType (a valid code from FR Core CodeSystem Location Type)https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-location-type from this IG | |
Location.physicalType | example | FRCoreValueSetLocationPhysicalTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-location-physical-type from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | 0..* | Location | Details and position information for a physical place | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
usePeriod | 0..1 | Period | FR Core Use Period Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-use-period | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Identifiant fonctionnel du lieu. Il est recommandé de remplir ce champs pour faciliter l'identification des ressources. |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: FR Core ValueSet Location identifier type (extensible) |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
assigner | Σ | 0..1 | Reference(FR Core Organization Profile) | Organization that issued id (may be just text) |
status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
type | Σ | 0..1 | CodeableConcept | Type of function performed Binding: FR Core ValueSet Location type (extensible) |
telecom | C | 0..* | FRCoreContactPointProfile | Details of a Technology mediated contact point (phone, fax, email, etc.) cpt-2: A system is required if a value is provided. |
address | 0..1 | FRCoreAddressProfile | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
physicalType | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: FR Core ValueSet Location physical type (example) |
managingOrganization | Σ | 0..1 | Reference(FR Core Organization Profile) | Organization responsible for provisioning and upkeep |
partOf | 0..1 | Reference(FR Core Location Profile) | Another Location this one is physically a part of | |
Slices for extension | Content/Rules for all slices | |||
positionRoom | 0..1 | Coding | FR Core Location Part Of Position Room Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-location-position-room Binding: FR Core ValueSet Location position room (extensible) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Location.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Location.identifier.type | extensible | FRCoreValueSetLocationIdentifierTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-location-identifier-type from this IG | |
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | |
Location.type | extensible | FRCoreValueSetLocationType (a valid code from FR Core CodeSystem Location Type)https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-location-type from this IG | |
Location.physicalType | example | FRCoreValueSetLocationPhysicalTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-location-physical-type from this IG |
Id | Grade | Path(s) | Details | Requirements |
cpt-2 | error | Location.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Location | 0..* | Location | Details and position information for a physical place | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
Slices for profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | ||||
profile:fr-canonical | Σ | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-location | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): 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 | |||||
usePeriod | 0..1 | Period | FR Core Use Period Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-use-period | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Identifiant fonctionnel du lieu. Il est recommandé de remplir ce champs pour faciliter l'identification des ressources. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: FR Core ValueSet Location identifier type (extensible) | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(FR Core Organization Profile) | Organization that issued id (may be just text) | ||||
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 | Σ | 0..1 | CodeableConcept | Type of function performed Binding: FR Core ValueSet Location type (extensible) | ||||
telecom | C | 0..* | FRCoreContactPointProfile | Details of a Technology mediated contact point (phone, fax, email, etc.) cpt-2: A system is required if a value is provided. | ||||
address | 0..1 | FRCoreAddressProfile | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
physicalType | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: FR Core ValueSet Location physical type (example) | ||||
position | 0..1 | BackboneElement | The absolute geographic location | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
longitude | 1..1 | decimal | Longitude with WGS84 datum | |||||
latitude | 1..1 | decimal | Latitude with WGS84 datum | |||||
altitude | 0..1 | decimal | Altitude with WGS84 datum | |||||
managingOrganization | Σ | 0..1 | Reference(FR Core Organization Profile) | Organization responsible for provisioning and upkeep | ||||
partOf | 0..1 | Reference(FR Core Location Profile) | Another Location this one is physically a part of | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
positionRoom | 0..1 | Coding | FR Core Location Part Of Position Room Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-location-position-room Binding: FR Core ValueSet Location position room (extensible) | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 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). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
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.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Location.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Location.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Location.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Location.identifier.type | extensible | FRCoreValueSetLocationIdentifierTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-location-identifier-type from this IG | ||||
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from 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.1 from the FHIR Standard | ||||
Location.type | extensible | FRCoreValueSetLocationType (a valid code from FR Core CodeSystem Location Type)https://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-location-type from this IG | ||||
Location.physicalType | example | FRCoreValueSetLocationPhysicalTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-location-physical-type from this IG | ||||
Location.partOf.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cpt-2 | error | Location.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
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: 0 element(3 nested mandatory elements)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron