CH ORF (R4)
2.0.0-ballot - ballot
This page is part of the CH ORF (R4) (v2.0.0-ballot: STU 2 Ballot 1) based on FHIR 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://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-location | Version: 2.0.0-ballot | |||
Active as of 2023-06-29 | Computable Name: ChOrfLocation | |||
Copyright/Legal: CC0-1.0 |
Profile to define the details of the location of the appointment.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CHCoreLocation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | 0..* | CHCoreLocation | CH ORF Location | |
name | S | 1..1 | string | Name of the location as used by humans |
telecom | S | 0..* | ContactPoint | Contact details of the location |
address | S | 0..1 | CHCoreAddressECH10 | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | 0..* | CHCoreLocation | CH ORF Location | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
name | SΣ | 1..1 | string | Name of the location as used by humans |
Slices for telecom | S | 0..* | ContactPoint | Contact details of the location Slice: Unordered, Open by value:system |
telecom:email | C | 0..* | CHCoreContactPointECH46Email | CH Core ContactPoint eCH-0046 Email |
telecom:phone | C | 0..* | CHCoreContactPointECH46Phone | CH Core ContactPoint eCH-0046 Phone |
telecom:internet | C | 0..* | CHCoreContactPointECH46Internet | CH Core ContactPoint eCH-0046 Internet |
address | S | 0..1 | CHCoreAddressECH10 | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
Documentation for this format |
Path | Conformance | ValueSet |
Location.status | required | LocationStatus |
Id | Grade | Path(s) | Details | Requirements |
cpt-2 | error | Location.telecom:email, Location.telecom:phone, Location.telecom:internet | 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..* | CHCoreLocation | CH ORF Location | |||||
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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Unique code or number identifying the location to its users | ||||
status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. | ||||
operationalStatus | Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room). | ||||
name | SΣ | 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..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. | ||||
Slices for telecom | S | 0..* | ContactPoint | Contact details of the location Slice: Unordered, Open by value:system | ||||
telecom:email | C | 0..* | CHCoreContactPointECH46Email | CH Core ContactPoint eCH-0046 Email | ||||
telecom:phone | C | 0..* | CHCoreContactPointECH46Phone | CH Core ContactPoint eCH-0046 Phone | ||||
telecom:internet | C | 0..* | CHCoreContactPointECH46Internet | CH Core ContactPoint eCH-0046 Internet | ||||
address | S | 0..1 | CHCoreAddressECH10 | 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: LocationType (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 | 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(CH Core Organization) | Organization responsible for provisioning and upkeep | ||||
partOf | 0..1 | Reference(Location) | Another Location this one is physically a part of | |||||
hoursOfOperation | 0..* | BackboneElement | What days/times during a week is this location usually open | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
allDay | 0..1 | boolean | The Location is open all day | |||||
openingTime | 0..1 | time | Time that the Location opens | |||||
closingTime | 0..1 | time | Time that the Location closes | |||||
availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Location.language | preferred | CommonLanguages
| ||||
Location.status | required | LocationStatus | ||||
Location.operationalStatus | preferred | Hl7VSBedStatus | ||||
Location.mode | required | LocationMode | ||||
Location.type | extensible | ServiceDeliveryLocationRoleType | ||||
Location.physicalType | example | LocationType | ||||
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeek |
Id | Grade | Path(s) | Details | Requirements |
cpt-2 | error | Location.telecom:email, Location.telecom:phone, Location.telecom:internet | A system is required if a value is provided. : value.empty() or system.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 CHCoreLocation
Differential View
This structure is derived from CHCoreLocation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | 0..* | CHCoreLocation | CH ORF Location | |
name | S | 1..1 | string | Name of the location as used by humans |
telecom | S | 0..* | ContactPoint | Contact details of the location |
address | S | 0..1 | CHCoreAddressECH10 | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | 0..* | CHCoreLocation | CH ORF Location | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
name | SΣ | 1..1 | string | Name of the location as used by humans |
Slices for telecom | S | 0..* | ContactPoint | Contact details of the location Slice: Unordered, Open by value:system |
telecom:email | C | 0..* | CHCoreContactPointECH46Email | CH Core ContactPoint eCH-0046 Email |
telecom:phone | C | 0..* | CHCoreContactPointECH46Phone | CH Core ContactPoint eCH-0046 Phone |
telecom:internet | C | 0..* | CHCoreContactPointECH46Internet | CH Core ContactPoint eCH-0046 Internet |
address | S | 0..1 | CHCoreAddressECH10 | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
Documentation for this format |
Path | Conformance | ValueSet |
Location.status | required | LocationStatus |
Id | Grade | Path(s) | Details | Requirements |
cpt-2 | error | Location.telecom:email, Location.telecom:phone, Location.telecom:internet | 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..* | CHCoreLocation | CH ORF Location | |||||
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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Unique code or number identifying the location to its users | ||||
status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. | ||||
operationalStatus | Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room). | ||||
name | SΣ | 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..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. | ||||
Slices for telecom | S | 0..* | ContactPoint | Contact details of the location Slice: Unordered, Open by value:system | ||||
telecom:email | C | 0..* | CHCoreContactPointECH46Email | CH Core ContactPoint eCH-0046 Email | ||||
telecom:phone | C | 0..* | CHCoreContactPointECH46Phone | CH Core ContactPoint eCH-0046 Phone | ||||
telecom:internet | C | 0..* | CHCoreContactPointECH46Internet | CH Core ContactPoint eCH-0046 Internet | ||||
address | S | 0..1 | CHCoreAddressECH10 | 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: LocationType (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 | 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(CH Core Organization) | Organization responsible for provisioning and upkeep | ||||
partOf | 0..1 | Reference(Location) | Another Location this one is physically a part of | |||||
hoursOfOperation | 0..* | BackboneElement | What days/times during a week is this location usually open | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
allDay | 0..1 | boolean | The Location is open all day | |||||
openingTime | 0..1 | time | Time that the Location opens | |||||
closingTime | 0..1 | time | Time that the Location closes | |||||
availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Location.language | preferred | CommonLanguages
| ||||
Location.status | required | LocationStatus | ||||
Location.operationalStatus | preferred | Hl7VSBedStatus | ||||
Location.mode | required | LocationMode | ||||
Location.type | extensible | ServiceDeliveryLocationRoleType | ||||
Location.physicalType | example | LocationType | ||||
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeek |
Id | Grade | Path(s) | Details | Requirements |
cpt-2 | error | Location.telecom:email, Location.telecom:phone, Location.telecom:internet | A system is required if a value is provided. : value.empty() or system.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 CHCoreLocation
Other representations of profile: CSV, Excel, Schematron