臺灣核心實作指引(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/Organization-govt-twcore | Version: 0.3.1 | |||
Active as of 2024-10-22 | Computable Name: TWCoreOrganizationGovt |
此臺灣核心-政府機構(TW Core Organization Government) Profile說明本IG如何進一步定義臺灣核心-機構(TW Core Organization) Profile以呈現機構基本資料。
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from TWCoreOrganization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | 0..* | TWCoreOrganization | 具有共同目的的一群人或機構 | |
identifier | ||||
type | 1..1 | CodeableConceptTW | 機構識別碼(identifier)的型別說明 Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: GOI | |
system | 0..1 | uri | 機構識別碼(identifier)的命名空間(namespace),可至[twTerminology](https://fhir.mohw.gov.tw/ts/namingsystem.jsp?status=active&type=0)申請或查詢命名系統。 Required Pattern: https://oid.nat.gov.tw/ | |
value | 0..1 | string | 唯一值。例如:機關代號為A21000000I | |
type | 1..1 | CodeableConceptTW | 機構的型別 Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: govt | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | TWCoreOrganization | 具有共同目的的一群人或機構 org-1: The organization SHALL at least have a name or an identifier, and possibly more than one |
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣC | 0..* | Identifier | 跨多個系統中識別此機構 |
use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (如果知道) Binding: IdentifierUse (required): 如果已知,請說明此識別碼的目的;應填入所綁定值集中的其中一個代碼。 |
type | S | 1..1 | CodeableConceptTW | 機構識別碼(identifier)的型別說明 Binding: IdentifierType + 臺灣衛福部資訊處識別碼類型值集 (extensible): 識別碼的型別,用於決定特定目的所適用的識別碼;應填入所綁定值集中的其中一個代碼。 Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: GOI | |
system | SΣ | 0..1 | uri | 機構識別碼(identifier)的命名空間(namespace),可至[twTerminology](https://fhir.mohw.gov.tw/ts/namingsystem.jsp?status=active&type=0)申請或查詢命名系統。 Required Pattern: https://oid.nat.gov.tw/ |
value | SΣ | 0..1 | string | 唯一值。例如:機關代號為A21000000I Example General: 123456 |
active | ?!SΣ | 0..1 | boolean | 此機構的紀錄是否仍在使用中 |
type | S | 1..1 | CodeableConceptTW | 機構的型別 Binding: OrganizationType (example): 用於分類機構;可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。 Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: govt | |
name | SΣC | 0..1 | string | 機構的名稱 |
telecom | SC | 0..* | ContactPoint | 此機構的詳細聯絡方式。
org-3:一個機構的通訊永遠不可能是「家用」,意即不可能使用「home」。 org-3: The telecom of an organization can never be of use 'home' |
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): 應填入所綁定值集中的其中一個代碼。 |
value | SΣ | 0..1 | string | 實際的聯絡方式之細節 |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile-此聯絡方式的用途 Binding: ContactPointUse (required): 應填入所綁定值集中的其中一個代碼。 |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Organization.identifier.type | extensible | Pattern: GOIhttps://twcore.mohw.gov.tw/ig/twcore/ValueSet/identifier-type-tw from this IG | |
Organization.type | example | Pattern: govthttp://hl7.org/fhir/ValueSet/organization-type from the FHIR Standard | |
Organization.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Organization.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Organization | 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 | Organization | 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 | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Organization | 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() | |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Organization | C | 0..* | TWCoreOrganization | 具有共同目的的一群人或機構 org-1: The organization SHALL at least have a name or an identifier, and possibly more than one | ||||
id | Σ | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Organization紀錄,通常又稱為邏輯性ID。 | ||||
meta | Σ | 0..1 | Meta | 此Organization Resource的metadata | ||||
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 | ||||
language | 0..1 | code | 用以表述Organization Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
Example Value: zh-TW | |||||
text | 0..1 | Narrative | Organization Resource之內容摘要以供人閱讀 | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣC | 0..* | Identifier | 跨多個系統中識別此機構 | ||||
id | 0..1 | string | 唯一可識別ID,以供資料項目間相互參照。 | |||||
extension | 0..* | Extension | 擴充的資料項目 Slice: Unordered, Open by value:url | |||||
use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (如果知道) Binding: IdentifierUse (required): 如果已知,請說明此識別碼的目的;應填入所綁定值集中的其中一個代碼。 | ||||
type | S | 1..1 | CodeableConceptTW | 機構識別碼(identifier)的型別說明 Binding: IdentifierType + 臺灣衛福部資訊處識別碼類型值集 (extensible): 識別碼的型別,用於決定特定目的所適用的識別碼;應填入所綁定值集中的其中一個代碼。 Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/v2-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: GOI | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | SΣ | 0..1 | uri | 機構識別碼(identifier)的命名空間(namespace),可至[twTerminology](https://fhir.mohw.gov.tw/ts/namingsystem.jsp?status=active&type=0)申請或查詢命名系統。 Required Pattern: https://oid.nat.gov.tw/ | ||||
value | SΣ | 0..1 | string | 唯一值。例如:機關代號為A21000000I Example General: 123456 | ||||
period | Σ | 0..1 | Period | 此機構識別碼(identifier)的使用效期 | ||||
assigner | Σ | 0..1 | Reference(TW Core Organization) | 簽發identifier的機構(可以只是文字表述) | ||||
active | ?!SΣ | 0..1 | boolean | 此機構的紀錄是否仍在使用中 | ||||
type | S | 1..1 | CodeableConceptTW | 機構的型別 Binding: OrganizationType (example): 用於分類機構;可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。 Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: govt | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
name | SΣC | 0..1 | string | 機構的名稱 | ||||
alias | 0..* | string | 此機構目前或過去已知的其他(多個)名稱 | |||||
telecom | SC | 0..* | ContactPoint | 此機構的詳細聯絡方式。
org-3:一個機構的通訊永遠不可能是「家用」,意即不可能使用「home」。 org-3: The telecom of an organization can never be of use 'home' | ||||
id | 0..1 | string | 唯一可識別ID,以供資料項目間相互參照。 | |||||
extension | 0..* | Extension | 擴充的資料項目 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 | ?!Σ | 0..1 | code | home | work | temp | old | mobile-此聯絡方式的用途 Binding: ContactPointUse (required): 應填入所綁定值集中的其中一個代碼。 | ||||
rank | Σ | 0..1 | positiveInt | 具體說明偏好的使用順序(1=最高優先順序) | ||||
period | Σ | 0..1 | Period | 此聯絡方式的使用效期 | ||||
address | C | 0..* | AddressTW | 此機構的地址。
org-2:一個機構的地址永遠不可能是「家用」,意即不可能使用「home」。 org-2: An address of an organization can never be of use 'home' | ||||
partOf | Σ | 0..1 | Reference(TW Core Organization) | 此機構屬於哪個更高層次機構的一部分 | ||||
contact | 0..* | BackboneElement | 某一用途的機構聯絡方式 | |||||
id | 0..1 | string | 唯一可識別ID,以供資料項目間相互參照。 | |||||
extension | 0..* | Extension | 擴充的資料項目 | |||||
modifierExtension | ?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
purpose | 0..1 | CodeableConceptTW | 聯絡的型別 Binding: ContactEntityType (extensible): 你所聯絡之聯絡人的聯絡方式用途;應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
name | 0..1 | HumanName | 聯絡人名字 | |||||
telecom | 0..* | ContactPoint | 聯絡人的詳細聯絡方式(例如:電話、電子郵件等)。 | |||||
address | 0..1 | AddressTW | 聯絡人的到訪或郵政地址 | |||||
endpoint | 0..* | Reference(Endpoint) | 存取此Organization的技術服務的終端(endpoints) | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Organization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Organization.identifier.type | extensible | Pattern: GOIhttps://twcore.mohw.gov.tw/ig/twcore/ValueSet/identifier-type-tw from this IG | ||||
Organization.type | example | Pattern: govthttp://hl7.org/fhir/ValueSet/organization-type from the FHIR Standard | ||||
Organization.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Organization.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Organization.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Organization | 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 | Organization | 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 | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Organization | 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() | |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |
This structure is derived from TWCoreOrganization
Differential View
This structure is derived from TWCoreOrganization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | 0..* | TWCoreOrganization | 具有共同目的的一群人或機構 | |
identifier | ||||
type | 1..1 | CodeableConceptTW | 機構識別碼(identifier)的型別說明 Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: GOI | |
system | 0..1 | uri | 機構識別碼(identifier)的命名空間(namespace),可至[twTerminology](https://fhir.mohw.gov.tw/ts/namingsystem.jsp?status=active&type=0)申請或查詢命名系統。 Required Pattern: https://oid.nat.gov.tw/ | |
value | 0..1 | string | 唯一值。例如:機關代號為A21000000I | |
type | 1..1 | CodeableConceptTW | 機構的型別 Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: govt | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | TWCoreOrganization | 具有共同目的的一群人或機構 org-1: The organization SHALL at least have a name or an identifier, and possibly more than one |
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣC | 0..* | Identifier | 跨多個系統中識別此機構 |
use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (如果知道) Binding: IdentifierUse (required): 如果已知,請說明此識別碼的目的;應填入所綁定值集中的其中一個代碼。 |
type | S | 1..1 | CodeableConceptTW | 機構識別碼(identifier)的型別說明 Binding: IdentifierType + 臺灣衛福部資訊處識別碼類型值集 (extensible): 識別碼的型別,用於決定特定目的所適用的識別碼;應填入所綁定值集中的其中一個代碼。 Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: GOI | |
system | SΣ | 0..1 | uri | 機構識別碼(identifier)的命名空間(namespace),可至[twTerminology](https://fhir.mohw.gov.tw/ts/namingsystem.jsp?status=active&type=0)申請或查詢命名系統。 Required Pattern: https://oid.nat.gov.tw/ |
value | SΣ | 0..1 | string | 唯一值。例如:機關代號為A21000000I Example General: 123456 |
active | ?!SΣ | 0..1 | boolean | 此機構的紀錄是否仍在使用中 |
type | S | 1..1 | CodeableConceptTW | 機構的型別 Binding: OrganizationType (example): 用於分類機構;可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。 Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: govt | |
name | SΣC | 0..1 | string | 機構的名稱 |
telecom | SC | 0..* | ContactPoint | 此機構的詳細聯絡方式。
org-3:一個機構的通訊永遠不可能是「家用」,意即不可能使用「home」。 org-3: The telecom of an organization can never be of use 'home' |
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): 應填入所綁定值集中的其中一個代碼。 |
value | SΣ | 0..1 | string | 實際的聯絡方式之細節 |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile-此聯絡方式的用途 Binding: ContactPointUse (required): 應填入所綁定值集中的其中一個代碼。 |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Organization.identifier.type | extensible | Pattern: GOIhttps://twcore.mohw.gov.tw/ig/twcore/ValueSet/identifier-type-tw from this IG | |
Organization.type | example | Pattern: govthttp://hl7.org/fhir/ValueSet/organization-type from the FHIR Standard | |
Organization.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Organization.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Organization | 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 | Organization | 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 | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Organization | 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() | |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Organization | C | 0..* | TWCoreOrganization | 具有共同目的的一群人或機構 org-1: The organization SHALL at least have a name or an identifier, and possibly more than one | ||||
id | Σ | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Organization紀錄,通常又稱為邏輯性ID。 | ||||
meta | Σ | 0..1 | Meta | 此Organization Resource的metadata | ||||
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 | ||||
language | 0..1 | code | 用以表述Organization Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
Example Value: zh-TW | |||||
text | 0..1 | Narrative | Organization Resource之內容摘要以供人閱讀 | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣC | 0..* | Identifier | 跨多個系統中識別此機構 | ||||
id | 0..1 | string | 唯一可識別ID,以供資料項目間相互參照。 | |||||
extension | 0..* | Extension | 擴充的資料項目 Slice: Unordered, Open by value:url | |||||
use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (如果知道) Binding: IdentifierUse (required): 如果已知,請說明此識別碼的目的;應填入所綁定值集中的其中一個代碼。 | ||||
type | S | 1..1 | CodeableConceptTW | 機構識別碼(identifier)的型別說明 Binding: IdentifierType + 臺灣衛福部資訊處識別碼類型值集 (extensible): 識別碼的型別,用於決定特定目的所適用的識別碼;應填入所綁定值集中的其中一個代碼。 Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/v2-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: GOI | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | SΣ | 0..1 | uri | 機構識別碼(identifier)的命名空間(namespace),可至[twTerminology](https://fhir.mohw.gov.tw/ts/namingsystem.jsp?status=active&type=0)申請或查詢命名系統。 Required Pattern: https://oid.nat.gov.tw/ | ||||
value | SΣ | 0..1 | string | 唯一值。例如:機關代號為A21000000I Example General: 123456 | ||||
period | Σ | 0..1 | Period | 此機構識別碼(identifier)的使用效期 | ||||
assigner | Σ | 0..1 | Reference(TW Core Organization) | 簽發identifier的機構(可以只是文字表述) | ||||
active | ?!SΣ | 0..1 | boolean | 此機構的紀錄是否仍在使用中 | ||||
type | S | 1..1 | CodeableConceptTW | 機構的型別 Binding: OrganizationType (example): 用於分類機構;可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。 Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: govt | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
name | SΣC | 0..1 | string | 機構的名稱 | ||||
alias | 0..* | string | 此機構目前或過去已知的其他(多個)名稱 | |||||
telecom | SC | 0..* | ContactPoint | 此機構的詳細聯絡方式。
org-3:一個機構的通訊永遠不可能是「家用」,意即不可能使用「home」。 org-3: The telecom of an organization can never be of use 'home' | ||||
id | 0..1 | string | 唯一可識別ID,以供資料項目間相互參照。 | |||||
extension | 0..* | Extension | 擴充的資料項目 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 | ?!Σ | 0..1 | code | home | work | temp | old | mobile-此聯絡方式的用途 Binding: ContactPointUse (required): 應填入所綁定值集中的其中一個代碼。 | ||||
rank | Σ | 0..1 | positiveInt | 具體說明偏好的使用順序(1=最高優先順序) | ||||
period | Σ | 0..1 | Period | 此聯絡方式的使用效期 | ||||
address | C | 0..* | AddressTW | 此機構的地址。
org-2:一個機構的地址永遠不可能是「家用」,意即不可能使用「home」。 org-2: An address of an organization can never be of use 'home' | ||||
partOf | Σ | 0..1 | Reference(TW Core Organization) | 此機構屬於哪個更高層次機構的一部分 | ||||
contact | 0..* | BackboneElement | 某一用途的機構聯絡方式 | |||||
id | 0..1 | string | 唯一可識別ID,以供資料項目間相互參照。 | |||||
extension | 0..* | Extension | 擴充的資料項目 | |||||
modifierExtension | ?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。 | ||||
purpose | 0..1 | CodeableConceptTW | 聯絡的型別 Binding: ContactEntityType (extensible): 你所聯絡之聯絡人的聯絡方式用途;應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
name | 0..1 | HumanName | 聯絡人名字 | |||||
telecom | 0..* | ContactPoint | 聯絡人的詳細聯絡方式(例如:電話、電子郵件等)。 | |||||
address | 0..1 | AddressTW | 聯絡人的到訪或郵政地址 | |||||
endpoint | 0..* | Reference(Endpoint) | 存取此Organization的技術服務的終端(endpoints) | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Organization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Organization.identifier.type | extensible | Pattern: GOIhttps://twcore.mohw.gov.tw/ig/twcore/ValueSet/identifier-type-tw from this IG | ||||
Organization.type | example | Pattern: govthttp://hl7.org/fhir/ValueSet/organization-type from the FHIR Standard | ||||
Organization.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Organization.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Organization.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Organization | 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 | Organization | 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 | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Organization | 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() | |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |
This structure is derived from TWCoreOrganization
Other representations of profile: CSV, Excel, Schematron
以下概述了此Profile所需的RESTful FHIR互動功能。有關TW Core IG支援的RESTful互動功能的完整清單,請參閱TW Core Server能力聲明。
建議應該(SHOULD) 支援透過查詢參數 _id
查詢所有Organization:
(如何透過token查詢)
GET [base]/Organization?_id=[id]
GET [base]/Organization/[id]
例子:
(1) GET [base]/Organization?_id=org-govt-example
(2) GET [base]/Organization/org-govt-example
建議應該(SHOULD) 支援透過查詢參數 identifier
查詢所有Organization:
(如何透過token查詢)
GET [base]/Organization?identifier={system|}[code]
例子:
(1) GET [base]/Organization?identifier=https://oid.nat.gov.tw/|A21000000I
建議應該(SHOULD) 支援透過查詢參數 name
查詢所有Organization:
(如何透過string查詢)
GET [base]/Organization?name=[name]
例子:
(1) GET [base]/Organization?name=衛生福利部
建議應該(SHOULD) 支援透過查詢參數 type
查詢所有Organization:
(如何透過token查詢)
GET [base]/Organization?type={system|}[code]
例子:
(1) GET [base]/Organization?type=http://terminology.hl7.org/CodeSystem/organization-type|govt