Service d'Accès aux Soins
1.0.0 - trial-use
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
Official URL: http://sas.fr/fhir/StructureDefinition/FrLocationAgregateur | Version: 1.0.0 | |||
Active as of 2024-09-05 | Computable Name: FrLocationAgregateur |
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)
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from FrLocation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | FrLocation | |||
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. Binding Description (No ValueSet): (extensible): Adresse de consultation – Voie | |
city | 1..1 | string | Name of city, town etc. Binding Description (No ValueSet): (extensible): Adresse de consultation – Ville | |
postalCode | 1..1 | string | Postal code for area Binding Description (No ValueSet): (extensible): Adresse de consultation – Code postal | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Location.address.line | extensible |
| |
Location.address.city | extensible |
| |
Location.address.postalCode | extensible |
|
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
identifier | Σ | 1..* | Identifier | Unique code or number identifying the location to its users |
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. |
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. |
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. Binding Description (No ValueSet): (extensible): Adresse de consultation – Voie 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. Binding Description (No ValueSet): (extensible): Adresse de consultation – Ville Example General: Erewhon |
postalCode | Σ | 1..1 | string | Postal code for area Binding Description (No ValueSet): (extensible): Adresse de consultation – Code postal Example General: 9132 |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Location.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use from the FHIR Standard | |
Location.identifier.type | extensible | fr-location-identifier-typehttp://interopsante.org/fhir/ValueSet/fr-location-identifier-type | |
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status from the FHIR Standard | |
Location.type | extensible | fr-location-typehttp://interopsante.org/fhir/ValueSet/fr-location-type | |
Location.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use from the FHIR Standard | |
Location.address.line | extensible | ||
Location.address.city | extensible | ||
Location.address.postalCode | extensible |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Location.extension:usePeriod, Location.modifierExtension, Location.address.extension:inseeCode | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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 | ||||
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 | 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. | ||||
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 | Σ | 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-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. Binding Description (No ValueSet): (extensible): Adresse de consultation – Voie 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. Binding Description (No ValueSet): (extensible): Adresse de consultation – Ville 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 Binding Description (No ValueSet): (extensible): Adresse de consultation – Code postal Example General: 9132 | ||||
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 | 0..1 | Reference(FrOrganization) | Organization responsible for provisioning and upkeep ref-1: SHALL have a contained resource if a local reference is provided | ||||
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 | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
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 from the FHIR Standard | ||||
Location.identifier.type | extensible | fr-location-identifier-typehttp://interopsante.org/fhir/ValueSet/fr-location-identifier-type | ||||
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status from the FHIR Standard | ||||
Location.operationalStatus | preferred | Hl7VSBedStatushttp://terminology.hl7.org/ValueSet/v2-0116 | ||||
Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode from the FHIR Standard | ||||
Location.type | extensible | fr-location-typehttp://interopsante.org/fhir/ValueSet/fr-location-type | ||||
Location.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use from the FHIR Standard | ||||
Location.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type from the FHIR Standard | ||||
Location.address.line | extensible | |||||
Location.address.city | extensible | |||||
Location.address.postalCode | extensible | |||||
Location.physicalType | example | fr-location-physical-typehttp://interopsante.org/fhir/ValueSet/fr-location-physical-type | ||||
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 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 | Location.extension, Location.extension:usePeriod, Location.modifierExtension, Location.identifier.extension, Location.address.extension, Location.address.extension:inseeCode, Location.position.extension, Location.position.modifierExtension, Location.partOf.extension, Location.partOf.extension:positionRoom, Location.hoursOfOperation.extension, Location.hoursOfOperation.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
per-1 | error | Location.identifier.period, Location.address.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
ref-1 | error | Location.identifier.assigner, Location.managingOrganization, Location.partOf, Location.endpoint | SHALL 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
Differential View
This structure is derived from FrLocation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | FrLocation | |||
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. Binding Description (No ValueSet): (extensible): Adresse de consultation – Voie | |
city | 1..1 | string | Name of city, town etc. Binding Description (No ValueSet): (extensible): Adresse de consultation – Ville | |
postalCode | 1..1 | string | Postal code for area Binding Description (No ValueSet): (extensible): Adresse de consultation – Code postal | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Location.address.line | extensible |
| |
Location.address.city | extensible |
| |
Location.address.postalCode | extensible |
|
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
identifier | Σ | 1..* | Identifier | Unique code or number identifying the location to its users |
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. |
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. |
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. Binding Description (No ValueSet): (extensible): Adresse de consultation – Voie 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. Binding Description (No ValueSet): (extensible): Adresse de consultation – Ville Example General: Erewhon |
postalCode | Σ | 1..1 | string | Postal code for area Binding Description (No ValueSet): (extensible): Adresse de consultation – Code postal Example General: 9132 |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Location.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use from the FHIR Standard | |
Location.identifier.type | extensible | fr-location-identifier-typehttp://interopsante.org/fhir/ValueSet/fr-location-identifier-type | |
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status from the FHIR Standard | |
Location.type | extensible | fr-location-typehttp://interopsante.org/fhir/ValueSet/fr-location-type | |
Location.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use from the FHIR Standard | |
Location.address.line | extensible | ||
Location.address.city | extensible | ||
Location.address.postalCode | extensible |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Location.extension:usePeriod, Location.modifierExtension, Location.address.extension:inseeCode | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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 | ||||
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 | 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. | ||||
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 | Σ | 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-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. Binding Description (No ValueSet): (extensible): Adresse de consultation – Voie 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. Binding Description (No ValueSet): (extensible): Adresse de consultation – Ville 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 Binding Description (No ValueSet): (extensible): Adresse de consultation – Code postal Example General: 9132 | ||||
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 | 0..1 | Reference(FrOrganization) | Organization responsible for provisioning and upkeep ref-1: SHALL have a contained resource if a local reference is provided | ||||
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 | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
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 from the FHIR Standard | ||||
Location.identifier.type | extensible | fr-location-identifier-typehttp://interopsante.org/fhir/ValueSet/fr-location-identifier-type | ||||
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status from the FHIR Standard | ||||
Location.operationalStatus | preferred | Hl7VSBedStatushttp://terminology.hl7.org/ValueSet/v2-0116 | ||||
Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode from the FHIR Standard | ||||
Location.type | extensible | fr-location-typehttp://interopsante.org/fhir/ValueSet/fr-location-type | ||||
Location.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use from the FHIR Standard | ||||
Location.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type from the FHIR Standard | ||||
Location.address.line | extensible | |||||
Location.address.city | extensible | |||||
Location.address.postalCode | extensible | |||||
Location.physicalType | example | fr-location-physical-typehttp://interopsante.org/fhir/ValueSet/fr-location-physical-type | ||||
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 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 | Location.extension, Location.extension:usePeriod, Location.modifierExtension, Location.identifier.extension, Location.address.extension, Location.address.extension:inseeCode, Location.position.extension, Location.position.modifierExtension, Location.partOf.extension, Location.partOf.extension:positionRoom, Location.hoursOfOperation.extension, Location.hoursOfOperation.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
per-1 | error | Location.identifier.period, Location.address.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
ref-1 | error | Location.identifier.assigner, Location.managingOrganization, Location.partOf, Location.endpoint | SHALL 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
Other representations of profile: CSV, Excel, Schematron