臺灣核心實作指引(TW Core IG), published by 衛生福利部. This guide is not an authorized publication; it is the continuous build for version 0.3.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/cctwFHIRterm/MOHW_TWCoreIG_Build/ and changes regularly. See the Directory of published versions
Official URL: https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Location-twcore | Version: 0.3.1 | |||
Active as of 2024-10-22 | Computable Name: TWCoreLocation |
此臺灣核心-地點(TW Core Location) Profile說明本IG如何進一步定義FHIR的Location Resource以呈現地點的詳細資料。
這是關於一個提供服務的具體位置的描述,包括那裡如何存放、查找、包含或安置資源和人員的資訊。
地點(Location)既包括臨時的地方(像是一個沒有提前被指定或批准就用來提供醫療服務的地方),也包括那些被正式確定用於特定目的的地方。這些地點既可以是私有的,也可以是公有的,有的可以移動,有的是固定不動的,大小也各不相同,從小型的冷凍箱到整座醫院大樓或停車場都是。
地點的例子有:
這裡提到的地點位置不是指病人身上發生了什麼(比如病人的腿斷了那裡),而是指病人腿斷發生時的地點(比如在遊樂場)。
地點(Location)和機構(Organization)是兩種密切相關的resources,但它們的用途有所不同。地點專注於描述具體的實體空間,這些空間由機構管理或運營。相比之下,機構更多地代表組織結構上的概念層次,例如:管理一間病房。
在某些情況下,地點可以不需要具體的地址就有效,例如:透過地理編碼描述偏遠地區,或由裝置記錄的位置。那些模式為「kind
」的地點通常也不會有地址,因為它們只是表示一種地點的類型,但如果這些地點有一個具體地址可以找到,那麼也可以記錄地址。
地點還可以用來描述一個管轄區域,這可能是基於實體邊界和其他特定因素組合而定的一個範圍,例如:
這個 resource 被多個其他 FHIR resources 參照,包括使用上下文/情境(UsageContext)、帳戶(Account)、活動定義(ActivityDefinition)、醫療不良事件(AdverseEvent)、預約(Appointment)、預約回應(AppointmentResponse)等。
Location.position
)使用與Google Earth的KML文件相同的語法、基準和參照系統表示,詳見Google/OGS的KML標準。Location.mode
資料項目可以用來指示一個 Location resource 是代表一個特定的(可能可識別的)地點(「instance
」),還是某類地點(「kind
」)。特別是在涉及醫令、排程、計劃和定義的時,可能會參照處於「kind
」mode的地點。在這些領域,往往不需要指向一個具體的地點,而是指向某類地點。這在計劃時尤其明顯,比如我們需要為一位病人分配「一間隔離室」,或者在特定時間派遣「一輛救護車」。在這些情況下,沒有必要確切識別哪一個隔離室或哪一輛救護車被分配,只需指出是一種地點的「kind
」就足夠了。
需要注意的是:當你有一個具體的地點參與,但缺少該地點的具體識別資訊時,應該使用「instance
」mode,即使無法提供該地點的完整識別資訊。這是因為「instance
」模式用於表示一個具體的、特定的地點實例,即使某些具體細節(如identifier
)未知。
而「kind」 mode則不應用於試圖填補關於具體地點實例缺失資訊的情況,而是用於表示某類地點,即一個通用類別或地點的類型,而不是指向一個具體的、可識別的單一地點。
所以,如果我們知道某個具體事件(如病人乘救護車到達)涉及一個具體的地點實例,但我們不知道是哪一輛救護車,我們仍然應該使用「instance」mode並嘗試提供盡可能多的資料,而不是使用「kind
」mode。「kind
」是用於當我們需要參用一個廣泛的地點類別,而不是特定的地點實例時。
當mode為「instance
」時,一些資料項目才適用;當mode為「kind
」時以下這些資料項目通常不使用:(不過,如果某些資訊對於描述某類地點來說仍然有意義,即使它是特定於某個範圍的通用而非全球通用的,例如:代表Burgers Medical Centre的某一輛救護車,這時這些資料項目還是可以被包含進來的。)
Location.identifier
)Location.telecom
)Location.address
)Location.position
)Location.status
)Location.managingOrganization
)Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Location
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Location | 0..* | Location | 用於描述一個實體地點的詳細資訊和位置資訊 | |||||
id | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Location紀錄,通常又稱為邏輯性ID。 | |||||
meta | 0..1 | Meta | 此Location Resource的metadata | |||||
implicitRules | 0..1 | uri | 創建此內容所依據的一組規則 | |||||
language | 0..1 | code | 用以表述Location Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
Example Value: zh-TW | |||||
text | 0..1 | Narrative | Location Resource之內容摘要以供人閱讀 | |||||
identifier | 0..* | Identifier | 地點的唯一識別號 | |||||
status | S | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): 地點的狀態,指明該地點是否目前正在使用中;應填入所綁定值集中的其中一個代碼。 | ||||
operationalStatus | 0..1 | Coding | 地點的運營狀態(通常僅適用於床位 / 房間) Binding: hl7VS-bedStatus (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | |||||
name | S | 1..1 | string | 人們使用的地點名稱 | ||||
alias | 0..* | string | 這是一份地點過去或現在所使用的其他名稱的清單 | |||||
description | 0..1 | string | 關於地點的額外資訊,除了名稱之外,還可以提供更多的細節來幫助識別這個地點。 | |||||
mode | 0..1 | code | instance | kind Binding: LocationMode (required): 表明為一個地點或是一個地點的類別;應填入所綁定值集中的其中一個代碼。 | |||||
type | 0..* | CodeableConceptTW | 執行的功能類型 Binding: ServiceDeliveryLocationRoleType (extensible): 應填入所綁定值集中的其中一個代碼。 | |||||
telecom | S | 0..* | ContactPoint | 地點的聯絡細節 | ||||
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): 應填入所綁定值集中的其中一個代碼。 | ||||
value | S | 0..1 | string | 實際的聯絡方式之細節 | ||||
use | S | 0..1 | code | home | work | temp | old | mobile Binding: ContactPointUse (required): 此聯絡方式的用途;應填入所綁定值集中的其中一個代碼。 | ||||
rank | 0..1 | positiveInt | 具體說明偏好的使用順序(1=最高優先順序) | |||||
period | S | 0..1 | Period | 此聯絡方式的使用效期 | ||||
address | S | 0..1 | AddressTW | 實體地點 | ||||
physicalType | 0..1 | CodeableConceptTW | 絕對的地理位置 Binding: LocationType (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。 | |||||
position | 0..1 | BackboneElement | 絕對地理位置 | |||||
longitude | 1..1 | decimal | 以 WGS84 為基準的經度 | |||||
latitude | 1..1 | decimal | 以 WGS84 為基準的緯度 | |||||
altitude | 0..1 | decimal | 以 WGS84 為基準的海拔高度 | |||||
managingOrganization | S | 0..1 | Reference(TW Core Organization) | 負責地點的提供與維護之機構 | ||||
partOf | 0..1 | Reference(TW Core Location) | 此地點是另一個地點的一部分 | |||||
hoursOfOperation | 0..* | BackboneElement | 這個地點通常在一個星期的哪些日子/時間開放? | |||||
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): 應填入所綁定值集中的其中一個代碼。 | |||||
allDay | 0..1 | boolean | 此地點全天開放 | |||||
openingTime | 0..1 | time | 此地點的開放時間 | |||||
closingTime | 0..1 | time | 此地點的關閉時間 | |||||
availabilityExceptions | 0..1 | string | 可用性例外情況說明 | |||||
endpoint | 0..* | Reference(Endpoint) | 提供用於此地點運營服務的技術端點 | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Location.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | ||||
Location.operationalStatus | preferred | Hl7VSBedStatushttp://terminology.hl7.org/ValueSet/v2-0116 | ||||
Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard | ||||
Location.type | extensible | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
Location.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Location.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard | ||||
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Location | 0..* | Location | 用於描述一個實體地點的詳細資訊和位置資訊 | |||||
id | Σ | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Location紀錄,通常又稱為邏輯性ID。 | ||||
meta | Σ | 0..1 | Meta | 此Location Resource的metadata | ||||
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 | ||||
language | 0..1 | code | 用以表述Location Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
Example Value: zh-TW | |||||
text | 0..1 | Narrative | Location Resource之內容摘要以供人閱讀 | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | 地點的唯一識別號 | ||||
status | ?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): 地點的狀態,指明該地點是否目前正在使用中;應填入所綁定值集中的其中一個代碼。 | ||||
operationalStatus | Σ | 0..1 | Coding | 地點的運營狀態(通常僅適用於床位 / 房間) Binding: hl7VS-bedStatus (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | ||||
name | SΣ | 1..1 | string | 人們使用的地點名稱 | ||||
alias | 0..* | string | 這是一份地點過去或現在所使用的其他名稱的清單 | |||||
description | Σ | 0..1 | string | 關於地點的額外資訊,除了名稱之外,還可以提供更多的細節來幫助識別這個地點。 | ||||
mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required): 表明為一個地點或是一個地點的類別;應填入所綁定值集中的其中一個代碼。 | ||||
type | 0..* | CodeableConceptTW | 執行的功能類型 Binding: ServiceDeliveryLocationRoleType (extensible): 應填入所綁定值集中的其中一個代碼。 | |||||
telecom | S | 0..* | ContactPoint | 地點的聯絡細節 | ||||
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): 應填入所綁定值集中的其中一個代碼。 | ||||
value | SΣ | 0..1 | string | 實際的聯絡方式之細節 | ||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile Binding: ContactPointUse (required): 此聯絡方式的用途;應填入所綁定值集中的其中一個代碼。 | ||||
rank | Σ | 0..1 | positiveInt | 具體說明偏好的使用順序(1=最高優先順序) | ||||
period | SΣ | 0..1 | Period | 此聯絡方式的使用效期 | ||||
address | S | 0..1 | AddressTW | 實體地點 | ||||
physicalType | 0..1 | CodeableConceptTW | 絕對的地理位置 Binding: LocationType (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。 | |||||
position | 0..1 | BackboneElement | 絕對地理位置 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
longitude | 1..1 | decimal | 以 WGS84 為基準的經度 | |||||
latitude | 1..1 | decimal | 以 WGS84 為基準的緯度 | |||||
altitude | 0..1 | decimal | 以 WGS84 為基準的海拔高度 | |||||
managingOrganization | SΣ | 0..1 | Reference(TW Core Organization) | 負責地點的提供與維護之機構 | ||||
partOf | 0..1 | Reference(TW Core Location) | 此地點是另一個地點的一部分 | |||||
hoursOfOperation | 0..* | BackboneElement | 這個地點通常在一個星期的哪些日子/時間開放? | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): 應填入所綁定值集中的其中一個代碼。 | |||||
allDay | 0..1 | boolean | 此地點全天開放 | |||||
openingTime | 0..1 | time | 此地點的開放時間 | |||||
closingTime | 0..1 | time | 此地點的關閉時間 | |||||
availabilityExceptions | 0..1 | string | 可用性例外情況說明 | |||||
endpoint | 0..* | Reference(Endpoint) | 提供用於此地點運營服務的技術端點 | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Location.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | ||||
Location.operationalStatus | preferred | Hl7VSBedStatushttp://terminology.hl7.org/ValueSet/v2-0116 | ||||
Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard | ||||
Location.type | extensible | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
Location.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Location.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard | ||||
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Location | 0..* | Location | 用於描述一個實體地點的詳細資訊和位置資訊 | |||||
id | Σ | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Location紀錄,通常又稱為邏輯性ID。 | ||||
meta | Σ | 0..1 | Meta | 此Location Resource的metadata | ||||
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 | ||||
language | 0..1 | code | 用以表述Location Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
Example Value: zh-TW | |||||
text | 0..1 | Narrative | Location Resource之內容摘要以供人閱讀 | |||||
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 | 地點的唯一識別號 | ||||
status | ?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): 地點的狀態,指明該地點是否目前正在使用中;應填入所綁定值集中的其中一個代碼。 | ||||
operationalStatus | Σ | 0..1 | Coding | 地點的運營狀態(通常僅適用於床位 / 房間) Binding: hl7VS-bedStatus (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | ||||
name | SΣ | 1..1 | string | 人們使用的地點名稱 | ||||
alias | 0..* | string | 這是一份地點過去或現在所使用的其他名稱的清單 | |||||
description | Σ | 0..1 | string | 關於地點的額外資訊,除了名稱之外,還可以提供更多的細節來幫助識別這個地點。 | ||||
mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required): 表明為一個地點或是一個地點的類別;應填入所綁定值集中的其中一個代碼。 | ||||
type | 0..* | CodeableConceptTW | 執行的功能類型 Binding: ServiceDeliveryLocationRoleType (extensible): 應填入所綁定值集中的其中一個代碼。 | |||||
telecom | S | 0..* | ContactPoint | 地點的聯絡細節 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): 應填入所綁定值集中的其中一個代碼。 | ||||
value | SΣ | 0..1 | string | 實際的聯絡方式之細節 | ||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile Binding: ContactPointUse (required): 此聯絡方式的用途;應填入所綁定值集中的其中一個代碼。 | ||||
rank | Σ | 0..1 | positiveInt | 具體說明偏好的使用順序(1=最高優先順序) | ||||
period | SΣ | 0..1 | Period | 此聯絡方式的使用效期 | ||||
address | S | 0..1 | AddressTW | 實體地點 | ||||
physicalType | 0..1 | CodeableConceptTW | 絕對的地理位置 Binding: LocationType (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。 | |||||
position | 0..1 | BackboneElement | 絕對地理位置 | |||||
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 | 以 WGS84 為基準的經度 | |||||
latitude | 1..1 | decimal | 以 WGS84 為基準的緯度 | |||||
altitude | 0..1 | decimal | 以 WGS84 為基準的海拔高度 | |||||
managingOrganization | SΣ | 0..1 | Reference(TW Core Organization) | 負責地點的提供與維護之機構 | ||||
partOf | 0..1 | Reference(TW Core Location) | 此地點是另一個地點的一部分 | |||||
hoursOfOperation | 0..* | BackboneElement | 這個地點通常在一個星期的哪些日子/時間開放? | |||||
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): 應填入所綁定值集中的其中一個代碼。 | |||||
allDay | 0..1 | boolean | 此地點全天開放 | |||||
openingTime | 0..1 | time | 此地點的開放時間 | |||||
closingTime | 0..1 | time | 此地點的關閉時間 | |||||
availabilityExceptions | 0..1 | string | 可用性例外情況說明 | |||||
endpoint | 0..* | Reference(Endpoint) | 提供用於此地點運營服務的技術端點 | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Location.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | ||||
Location.operationalStatus | preferred | Hl7VSBedStatushttp://terminology.hl7.org/ValueSet/v2-0116 | ||||
Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard | ||||
Location.type | extensible | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
Location.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Location.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard | ||||
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Location
Summary
Mandatory: 1 element
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from Location
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Location | 0..* | Location | 用於描述一個實體地點的詳細資訊和位置資訊 | |||||
id | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Location紀錄,通常又稱為邏輯性ID。 | |||||
meta | 0..1 | Meta | 此Location Resource的metadata | |||||
implicitRules | 0..1 | uri | 創建此內容所依據的一組規則 | |||||
language | 0..1 | code | 用以表述Location Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
Example Value: zh-TW | |||||
text | 0..1 | Narrative | Location Resource之內容摘要以供人閱讀 | |||||
identifier | 0..* | Identifier | 地點的唯一識別號 | |||||
status | S | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): 地點的狀態,指明該地點是否目前正在使用中;應填入所綁定值集中的其中一個代碼。 | ||||
operationalStatus | 0..1 | Coding | 地點的運營狀態(通常僅適用於床位 / 房間) Binding: hl7VS-bedStatus (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | |||||
name | S | 1..1 | string | 人們使用的地點名稱 | ||||
alias | 0..* | string | 這是一份地點過去或現在所使用的其他名稱的清單 | |||||
description | 0..1 | string | 關於地點的額外資訊,除了名稱之外,還可以提供更多的細節來幫助識別這個地點。 | |||||
mode | 0..1 | code | instance | kind Binding: LocationMode (required): 表明為一個地點或是一個地點的類別;應填入所綁定值集中的其中一個代碼。 | |||||
type | 0..* | CodeableConceptTW | 執行的功能類型 Binding: ServiceDeliveryLocationRoleType (extensible): 應填入所綁定值集中的其中一個代碼。 | |||||
telecom | S | 0..* | ContactPoint | 地點的聯絡細節 | ||||
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): 應填入所綁定值集中的其中一個代碼。 | ||||
value | S | 0..1 | string | 實際的聯絡方式之細節 | ||||
use | S | 0..1 | code | home | work | temp | old | mobile Binding: ContactPointUse (required): 此聯絡方式的用途;應填入所綁定值集中的其中一個代碼。 | ||||
rank | 0..1 | positiveInt | 具體說明偏好的使用順序(1=最高優先順序) | |||||
period | S | 0..1 | Period | 此聯絡方式的使用效期 | ||||
address | S | 0..1 | AddressTW | 實體地點 | ||||
physicalType | 0..1 | CodeableConceptTW | 絕對的地理位置 Binding: LocationType (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。 | |||||
position | 0..1 | BackboneElement | 絕對地理位置 | |||||
longitude | 1..1 | decimal | 以 WGS84 為基準的經度 | |||||
latitude | 1..1 | decimal | 以 WGS84 為基準的緯度 | |||||
altitude | 0..1 | decimal | 以 WGS84 為基準的海拔高度 | |||||
managingOrganization | S | 0..1 | Reference(TW Core Organization) | 負責地點的提供與維護之機構 | ||||
partOf | 0..1 | Reference(TW Core Location) | 此地點是另一個地點的一部分 | |||||
hoursOfOperation | 0..* | BackboneElement | 這個地點通常在一個星期的哪些日子/時間開放? | |||||
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): 應填入所綁定值集中的其中一個代碼。 | |||||
allDay | 0..1 | boolean | 此地點全天開放 | |||||
openingTime | 0..1 | time | 此地點的開放時間 | |||||
closingTime | 0..1 | time | 此地點的關閉時間 | |||||
availabilityExceptions | 0..1 | string | 可用性例外情況說明 | |||||
endpoint | 0..* | Reference(Endpoint) | 提供用於此地點運營服務的技術端點 | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Location.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | ||||
Location.operationalStatus | preferred | Hl7VSBedStatushttp://terminology.hl7.org/ValueSet/v2-0116 | ||||
Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard | ||||
Location.type | extensible | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
Location.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Location.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard | ||||
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Location | 0..* | Location | 用於描述一個實體地點的詳細資訊和位置資訊 | |||||
id | Σ | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Location紀錄,通常又稱為邏輯性ID。 | ||||
meta | Σ | 0..1 | Meta | 此Location Resource的metadata | ||||
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 | ||||
language | 0..1 | code | 用以表述Location Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
Example Value: zh-TW | |||||
text | 0..1 | Narrative | Location Resource之內容摘要以供人閱讀 | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | 地點的唯一識別號 | ||||
status | ?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): 地點的狀態,指明該地點是否目前正在使用中;應填入所綁定值集中的其中一個代碼。 | ||||
operationalStatus | Σ | 0..1 | Coding | 地點的運營狀態(通常僅適用於床位 / 房間) Binding: hl7VS-bedStatus (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | ||||
name | SΣ | 1..1 | string | 人們使用的地點名稱 | ||||
alias | 0..* | string | 這是一份地點過去或現在所使用的其他名稱的清單 | |||||
description | Σ | 0..1 | string | 關於地點的額外資訊,除了名稱之外,還可以提供更多的細節來幫助識別這個地點。 | ||||
mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required): 表明為一個地點或是一個地點的類別;應填入所綁定值集中的其中一個代碼。 | ||||
type | 0..* | CodeableConceptTW | 執行的功能類型 Binding: ServiceDeliveryLocationRoleType (extensible): 應填入所綁定值集中的其中一個代碼。 | |||||
telecom | S | 0..* | ContactPoint | 地點的聯絡細節 | ||||
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): 應填入所綁定值集中的其中一個代碼。 | ||||
value | SΣ | 0..1 | string | 實際的聯絡方式之細節 | ||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile Binding: ContactPointUse (required): 此聯絡方式的用途;應填入所綁定值集中的其中一個代碼。 | ||||
rank | Σ | 0..1 | positiveInt | 具體說明偏好的使用順序(1=最高優先順序) | ||||
period | SΣ | 0..1 | Period | 此聯絡方式的使用效期 | ||||
address | S | 0..1 | AddressTW | 實體地點 | ||||
physicalType | 0..1 | CodeableConceptTW | 絕對的地理位置 Binding: LocationType (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。 | |||||
position | 0..1 | BackboneElement | 絕對地理位置 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
longitude | 1..1 | decimal | 以 WGS84 為基準的經度 | |||||
latitude | 1..1 | decimal | 以 WGS84 為基準的緯度 | |||||
altitude | 0..1 | decimal | 以 WGS84 為基準的海拔高度 | |||||
managingOrganization | SΣ | 0..1 | Reference(TW Core Organization) | 負責地點的提供與維護之機構 | ||||
partOf | 0..1 | Reference(TW Core Location) | 此地點是另一個地點的一部分 | |||||
hoursOfOperation | 0..* | BackboneElement | 這個地點通常在一個星期的哪些日子/時間開放? | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): 應填入所綁定值集中的其中一個代碼。 | |||||
allDay | 0..1 | boolean | 此地點全天開放 | |||||
openingTime | 0..1 | time | 此地點的開放時間 | |||||
closingTime | 0..1 | time | 此地點的關閉時間 | |||||
availabilityExceptions | 0..1 | string | 可用性例外情況說明 | |||||
endpoint | 0..* | Reference(Endpoint) | 提供用於此地點運營服務的技術端點 | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Location.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | ||||
Location.operationalStatus | preferred | Hl7VSBedStatushttp://terminology.hl7.org/ValueSet/v2-0116 | ||||
Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard | ||||
Location.type | extensible | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
Location.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Location.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard | ||||
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Location | 0..* | Location | 用於描述一個實體地點的詳細資訊和位置資訊 | |||||
id | Σ | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Location紀錄,通常又稱為邏輯性ID。 | ||||
meta | Σ | 0..1 | Meta | 此Location Resource的metadata | ||||
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 | ||||
language | 0..1 | code | 用以表述Location Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
Example Value: zh-TW | |||||
text | 0..1 | Narrative | Location Resource之內容摘要以供人閱讀 | |||||
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 | 地點的唯一識別號 | ||||
status | ?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): 地點的狀態,指明該地點是否目前正在使用中;應填入所綁定值集中的其中一個代碼。 | ||||
operationalStatus | Σ | 0..1 | Coding | 地點的運營狀態(通常僅適用於床位 / 房間) Binding: hl7VS-bedStatus (preferred): 鼓勵使用所綁定值集中的代碼,但不強制一定要使用此值集,你也可使用其他值集的代碼或單純以文字表示。 | ||||
name | SΣ | 1..1 | string | 人們使用的地點名稱 | ||||
alias | 0..* | string | 這是一份地點過去或現在所使用的其他名稱的清單 | |||||
description | Σ | 0..1 | string | 關於地點的額外資訊,除了名稱之外,還可以提供更多的細節來幫助識別這個地點。 | ||||
mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required): 表明為一個地點或是一個地點的類別;應填入所綁定值集中的其中一個代碼。 | ||||
type | 0..* | CodeableConceptTW | 執行的功能類型 Binding: ServiceDeliveryLocationRoleType (extensible): 應填入所綁定值集中的其中一個代碼。 | |||||
telecom | S | 0..* | ContactPoint | 地點的聯絡細節 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): 應填入所綁定值集中的其中一個代碼。 | ||||
value | SΣ | 0..1 | string | 實際的聯絡方式之細節 | ||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile Binding: ContactPointUse (required): 此聯絡方式的用途;應填入所綁定值集中的其中一個代碼。 | ||||
rank | Σ | 0..1 | positiveInt | 具體說明偏好的使用順序(1=最高優先順序) | ||||
period | SΣ | 0..1 | Period | 此聯絡方式的使用效期 | ||||
address | S | 0..1 | AddressTW | 實體地點 | ||||
physicalType | 0..1 | CodeableConceptTW | 絕對的地理位置 Binding: LocationType (example): 可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。 | |||||
position | 0..1 | BackboneElement | 絕對地理位置 | |||||
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 | 以 WGS84 為基準的經度 | |||||
latitude | 1..1 | decimal | 以 WGS84 為基準的緯度 | |||||
altitude | 0..1 | decimal | 以 WGS84 為基準的海拔高度 | |||||
managingOrganization | SΣ | 0..1 | Reference(TW Core Organization) | 負責地點的提供與維護之機構 | ||||
partOf | 0..1 | Reference(TW Core Location) | 此地點是另一個地點的一部分 | |||||
hoursOfOperation | 0..* | BackboneElement | 這個地點通常在一個星期的哪些日子/時間開放? | |||||
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): 應填入所綁定值集中的其中一個代碼。 | |||||
allDay | 0..1 | boolean | 此地點全天開放 | |||||
openingTime | 0..1 | time | 此地點的開放時間 | |||||
closingTime | 0..1 | time | 此地點的關閉時間 | |||||
availabilityExceptions | 0..1 | string | 可用性例外情況說明 | |||||
endpoint | 0..* | Reference(Endpoint) | 提供用於此地點運營服務的技術端點 | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Location.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | ||||
Location.operationalStatus | preferred | Hl7VSBedStatushttp://terminology.hl7.org/ValueSet/v2-0116 | ||||
Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard | ||||
Location.type | extensible | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
Location.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Location.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard | ||||
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Location
Summary
Mandatory: 1 element
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron
以下概述了此Profile所需的RESTful FHIR互動功能。有關TW Core IG支援的RESTful互動功能的完整清單,請參閱TW Core Server能力聲明。
建議應該(SHOULD) 支援透過查詢參數 _id
查詢所有Location:
(如何透過token查詢)
GET [base]/Location?_id=[id]
GET [base]/Location/[id]
例子:
(1) GET [base]/Location?_id=loc-ent-example
(2) GET [base]/Location/loc-ent-example
建議應該(SHOULD) 支援透過查詢參數 address
查詢所有Location:
(如何透過string查詢)
GET [base]/Location?address=[string]
例子:
(1) GET [base]/Location?address=新北市
建議應該(SHOULD) 支援透過查詢參數 name
查詢所有Location:
(如何透過string查詢)
GET [base]/Location?name=[string]
例子:
(1) GET [base]/Location?name=衛生福利部臺北醫院