Service d'Accès aux Soins
1.0.0 - trial-use France flag

This page is part of the Service d'Accès aux Soins (v1.0.0: trial-use) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: FrLocationAgregateurSOS

Official URL: https://interop.esante.gouv.fr/ig/fhir/sas/StructureDefinition/sas-sos-location-aggregator Version: 1.0.0
Active as of 2024-09-05 Computable Name: FrLocationAgregateurSOS

Profil de Location, dérivé de FrLocation, pour le service d’agrégation de créneaux de la plateforme SAS (Service d’accès aux soins), dans le cadre du cas d’usage SOS Médecins

Usage:

Formal Views of Profile Content

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

This structure is derived from FrLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location FrLocation
... identifier
.... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://interopsante.org/fhir/CodeSystem/fr-location-identifier-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: INTRN
... name 1..1 string Name of the location as used by humans
... address 1..1 FrAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... line 1..1 string Street name, number, direction & P.O. Box etc.
.... city 1..1 string Name of city, town etc.
.... postalCode 1..1 string Postal code for area
Max Length: 5
.... reference 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* FrLocation 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 Content/Rules for all slices
.... usePeriod N 0..1 Period Optional Extensions Element
URL: http://interopsante.org/fhir/StructureDefinition/FrLocationUsePeriod
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
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-location-identifier-type (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://interopsante.org/fhir/CodeSystem/fr-location-identifier-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: INTRN
.... 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
... status ?!Σ 0..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... name Σ 1..1 string Name of the location as used by humans
... type Σ 0..1 CodeableConcept Type of function performed
Binding: fr-location-type (extensible): Indicates the type of function performed at the location.


... address 1..1 FrAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... Slices for extension Content/Rules for all slices
..... inseeCode N 0..1 Coding Optional Extensions Element
URL: http://interopsante.org/fhir/StructureDefinition/FrAddressInseeCode
Binding: fr-insee-code (required)
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line Σ 1..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 1..1 string Name of city, town etc.
Example General: Erewhon
.... postalCode Σ 1..1 string Postal code for area
Example General: 9132
Max Length: 5
... managingOrganization ΣC 1..1 Reference(FrOrganizationAgregateurSOS) Organization responsible for provisioning and upkeep
ref-1: SHALL have a contained resource if a local reference is provided
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
from the FHIR Standard
Location.identifier.typeextensiblePattern: INTRN
http://interopsante.org/fhir/ValueSet/fr-location-identifier-type
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status
from the FHIR Standard
Location.typeextensiblefr-location-type
http://interopsante.org/fhir/ValueSet/fr-location-type
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLocationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorLocationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLocationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.extension:usePeriod, Location.modifierExtension, Location.address.extension:inseeCodeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ref-1errorLocation.managingOrganizationSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* FrLocation 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... usePeriod N 0..1 Period Optional Extensions Element
URL: http://interopsante.org/fhir/StructureDefinition/FrLocationUsePeriod
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ 1..* Identifier Unique code or number identifying the location to its users
.... id 0..1 string Unique id for inter-element referencing
.... extension N 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-location-identifier-type (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://interopsante.org/fhir/CodeSystem/fr-location-identifier-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: INTRN
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... 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 ΣC 0..1 Period Time period when id is/was valid for use
per-1: If present, start SHALL have a lower value than end
.... assigner ΣC 0..1 Reference(FrOrganization) Organization that issued id (may be just text)
ref-1: SHALL have a contained resource if a local reference is provided
... 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 Σ 1..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-location-type (extensible): Indicates the type of function performed at the location.


... telecom C 0..* FrContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
... address 1..1 FrAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... inseeCode N 0..1 Coding Optional Extensions Element
URL: http://interopsante.org/fhir/StructureDefinition/FrAddressInseeCode
Binding: fr-insee-code (required)
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 1..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 1..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 1..1 string Postal code for area
Example General: 9132
Max Length: 5
.... country Σ 0..1 string Country (will be ISO 3166 3 letter code; code=FRA for France)
.... period ΣC 0..1 Period Time period when address was/is in use
per-1: If present, start SHALL have a lower value than end
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... physicalType Σ 0..1 CodeableConcept Physical form of the location
Binding: fr-location-physical-type (example): Physical form of the location.

... position 0..1 BackboneElement The absolute geographic location
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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 ΣC 1..1 Reference(FrOrganizationAgregateurSOS) Organization responsible for provisioning and upkeep
ref-1: SHALL have a contained resource if a local reference is provided
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..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
... partOf C 0..1 Reference(FrLocation) Another Location this one is physically a part of
ref-1: SHALL have a contained resource if a local reference is provided
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... positionRoom N 0..1 Coding Optional Extensions Element
URL: http://interopsante.org/fhir/StructureDefinition/FrLocationPartOfPositionRoom
Binding: fr-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 N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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 C 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location
ref-1: SHALL have a contained resource if a local reference is provided

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Location.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
from the FHIR Standard
Location.identifier.typeextensiblePattern: INTRN
http://interopsante.org/fhir/ValueSet/fr-location-identifier-type
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status
from the FHIR Standard
Location.operationalStatuspreferredHl7VSBedStatus
http://terminology.hl7.org/ValueSet/v2-0116
Location.moderequiredLocationMode
http://hl7.org/fhir/ValueSet/location-mode
from the FHIR Standard
Location.typeextensiblefr-location-type
http://interopsante.org/fhir/ValueSet/fr-location-type
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use
from the FHIR Standard
Location.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type
from the FHIR Standard
Location.physicalTypeexamplefr-location-physical-type
http://interopsante.org/fhir/ValueSet/fr-location-physical-type
Location.managingOrganization.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Location.partOf.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorLocation.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLocationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorLocationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLocationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.extension, Location.extension:usePeriod, Location.modifierExtension, Location.identifier.extension, Location.address.extension, Location.address.extension:inseeCode, Location.position.extension, Location.position.modifierExtension, Location.managingOrganization.extension, Location.partOf.extension, Location.partOf.extension:positionRoom, Location.hoursOfOperation.extension, Location.hoursOfOperation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
per-1errorLocation.identifier.period, Location.address.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1errorLocation.identifier.assigner, Location.managingOrganization, Location.partOf, Location.endpointSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from FrLocation

Summary

Mandatory: 7 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from FrLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location FrLocation
... identifier
.... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://interopsante.org/fhir/CodeSystem/fr-location-identifier-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: INTRN
... name 1..1 string Name of the location as used by humans
... address 1..1 FrAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... line 1..1 string Street name, number, direction & P.O. Box etc.
.... city 1..1 string Name of city, town etc.
.... postalCode 1..1 string Postal code for area
Max Length: 5
.... reference 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* FrLocation 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 Content/Rules for all slices
.... usePeriod N 0..1 Period Optional Extensions Element
URL: http://interopsante.org/fhir/StructureDefinition/FrLocationUsePeriod
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
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-location-identifier-type (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://interopsante.org/fhir/CodeSystem/fr-location-identifier-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: INTRN
.... 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
... status ?!Σ 0..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... name Σ 1..1 string Name of the location as used by humans
... type Σ 0..1 CodeableConcept Type of function performed
Binding: fr-location-type (extensible): Indicates the type of function performed at the location.


... address 1..1 FrAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... Slices for extension Content/Rules for all slices
..... inseeCode N 0..1 Coding Optional Extensions Element
URL: http://interopsante.org/fhir/StructureDefinition/FrAddressInseeCode
Binding: fr-insee-code (required)
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line Σ 1..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 1..1 string Name of city, town etc.
Example General: Erewhon
.... postalCode Σ 1..1 string Postal code for area
Example General: 9132
Max Length: 5
... managingOrganization ΣC 1..1 Reference(FrOrganizationAgregateurSOS) Organization responsible for provisioning and upkeep
ref-1: SHALL have a contained resource if a local reference is provided
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
from the FHIR Standard
Location.identifier.typeextensiblePattern: INTRN
http://interopsante.org/fhir/ValueSet/fr-location-identifier-type
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status
from the FHIR Standard
Location.typeextensiblefr-location-type
http://interopsante.org/fhir/ValueSet/fr-location-type
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLocationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorLocationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLocationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.extension:usePeriod, Location.modifierExtension, Location.address.extension:inseeCodeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ref-1errorLocation.managingOrganizationSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* FrLocation 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... usePeriod N 0..1 Period Optional Extensions Element
URL: http://interopsante.org/fhir/StructureDefinition/FrLocationUsePeriod
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ 1..* Identifier Unique code or number identifying the location to its users
.... id 0..1 string Unique id for inter-element referencing
.... extension N 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-location-identifier-type (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://interopsante.org/fhir/CodeSystem/fr-location-identifier-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: INTRN
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... 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 ΣC 0..1 Period Time period when id is/was valid for use
per-1: If present, start SHALL have a lower value than end
.... assigner ΣC 0..1 Reference(FrOrganization) Organization that issued id (may be just text)
ref-1: SHALL have a contained resource if a local reference is provided
... 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 Σ 1..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-location-type (extensible): Indicates the type of function performed at the location.


... telecom C 0..* FrContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
... address 1..1 FrAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... inseeCode N 0..1 Coding Optional Extensions Element
URL: http://interopsante.org/fhir/StructureDefinition/FrAddressInseeCode
Binding: fr-insee-code (required)
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 1..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 1..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 1..1 string Postal code for area
Example General: 9132
Max Length: 5
.... country Σ 0..1 string Country (will be ISO 3166 3 letter code; code=FRA for France)
.... period ΣC 0..1 Period Time period when address was/is in use
per-1: If present, start SHALL have a lower value than end
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... physicalType Σ 0..1 CodeableConcept Physical form of the location
Binding: fr-location-physical-type (example): Physical form of the location.

... position 0..1 BackboneElement The absolute geographic location
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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 ΣC 1..1 Reference(FrOrganizationAgregateurSOS) Organization responsible for provisioning and upkeep
ref-1: SHALL have a contained resource if a local reference is provided
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..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
... partOf C 0..1 Reference(FrLocation) Another Location this one is physically a part of
ref-1: SHALL have a contained resource if a local reference is provided
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... positionRoom N 0..1 Coding Optional Extensions Element
URL: http://interopsante.org/fhir/StructureDefinition/FrLocationPartOfPositionRoom
Binding: fr-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 N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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 C 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location
ref-1: SHALL have a contained resource if a local reference is provided

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Location.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
from the FHIR Standard
Location.identifier.typeextensiblePattern: INTRN
http://interopsante.org/fhir/ValueSet/fr-location-identifier-type
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status
from the FHIR Standard
Location.operationalStatuspreferredHl7VSBedStatus
http://terminology.hl7.org/ValueSet/v2-0116
Location.moderequiredLocationMode
http://hl7.org/fhir/ValueSet/location-mode
from the FHIR Standard
Location.typeextensiblefr-location-type
http://interopsante.org/fhir/ValueSet/fr-location-type
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use
from the FHIR Standard
Location.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type
from the FHIR Standard
Location.physicalTypeexamplefr-location-physical-type
http://interopsante.org/fhir/ValueSet/fr-location-physical-type
Location.managingOrganization.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Location.partOf.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorLocation.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLocationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorLocationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceLocationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.extension, Location.extension:usePeriod, Location.modifierExtension, Location.identifier.extension, Location.address.extension, Location.address.extension:inseeCode, Location.position.extension, Location.position.modifierExtension, Location.managingOrganization.extension, Location.partOf.extension, Location.partOf.extension:positionRoom, Location.hoursOfOperation.extension, Location.hoursOfOperation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
per-1errorLocation.identifier.period, Location.address.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1errorLocation.identifier.assigner, Location.managingOrganization, Location.partOf, Location.endpointSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from FrLocation

Summary

Mandatory: 7 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron