臺灣核心實作指引(TW Core IG)
0.2.0 - Trial Use

This page is part of the 臺灣核心實作指引(TW Core IG) (v0.2.0: Releases) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: TW Core Organization

Official URL: https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Organization-twcore Version: 0.2.0
Active as of 2024-03-21 Computable Name: TWCoreOrganization

  • 2024/3/21異動說明:identifier.type欄位之值集綁定強度由example改為extensible,以利實務專案使用

此臺灣核心-機構(TW Core Organization) Profile說明本IG如何進一步定義FHIR的Organization Resource以呈現機構基本資料。

Resource Organization - 內容

這是指一群人或組織,他們不論是正式或非正式地被認可,都是為了達成某種共同行動的目的而聚集在一起。這樣的群體包括了各種形式,如公司、學校、企業、部門、社群(區)團體、健康照護服務團隊以及醫療費用支付者(payer)如健保署(全民健保)、僱主(提供員工健康保險福利)或收取保費提供健康保險的機構或公司(insurer)等。

範圍與使用

這個 resource 既可以用來在一個共享註冊處登記各種機構的聯絡方式和其他資訊,也可以單純作為支援其他需要參照機構資訊的resource,比如作為一份文件(docuement)、一則訊息(message)或者作為一個內嵌(contained) resource 。如果採用註冊處的方式,那麼完全有可能存在多個註冊處,其中每一個都專門處理不同類型或不同層級的機構資訊。

界限與關聯

Organization resource 用於描述一群人為了共同的目標而聚集的情形。與之相對,Group 則用來標識一群出於分析目的或需要被採取行動對的人(或動物、設備等),但這群體本身不預期會採取任何行動。

Organization resource 通常會形成一個層級結構,透過使用 part-of 屬性來顯示子Organization與其父Organization之間的聯繫。這種組織的層級結構幫助闡明概念上的結構,而 Location resource 則提供了這種層級結構的實體上表示。

Organization 與 Location 之間的關聯是從 Location 層級結構中的每一點到 Organization 層級結構中適當層級的連接。這些連結不一定都指向最頂層的 Organization。

在構建 Organization 和 Location 的層級結構時,雖然這兩者間可能不容易區分,但為了幫助進行判斷,Location 總被用來記錄服務發生的地點,從而與 Encounter 和 Observation 有所聯繫。這意味著,resource 上的 Organization 屬性可能不反應服務發生的真實位置。

Organization resource 被以下 resources 所參照: 註釋(Annotation)、識別碼(Identifier)、簽章(Signature)、使用情境(UsageContext)、帳戶(Account)、稽核事件(AuditEvent)基本(Basic)、生物衍生產品(BiologicallyDerivedProduct)、能力聲明(CapabilityStatement)、照護計畫(CarePlan)、照護團隊(CareTeam)、目錄內的條目(CatalogEntry)、費用項目(ChargeItem)、理賠申請(Claim)、理賠申請回應(ClaimResponse)、通訊(Communication)、通訊請求(CommunicationRequest)、臨床文件架構(Composition)、同意書(Consent)、同意書(Consent)、合約(Contract)、給付範圍(Coverage)、給付資格請求(CoverageEligibilityRequest)、給付資格回應(CoverageEligibilityResponse)、設備(Device)、設備定義(DeviceDefinition)、設備請求(DeviceRequest)、診斷報告(DiagnosticReport)、文件清單(DocumentManifest)、文件參照(DocumentReference)、就醫(Encounter)、端點(Endpoint)、加入或退出保險計畫請求(EnrollmentRequest)、 加入或退出保險計畫回應(EnrollmentResponse)、照護事件(EpisodeOfCare)、利益說明(ExplanationOfBenefit)、標記(Flag)、目標(Goal)、群體(Group)、健康照護服務(HealthcareService)、影像檢查(ImagingStudy)、疫苗接種(Immunization)、疫苗接種評估(ImmunizationEvaluation)、疫苗接種建議(ImmunizationRecommendation)、保險計畫(InsurancePlan)、發票或費用清單(Invoice)、連結(Linkage)、地點(Location)、測量報告(MeasureReport)、多媒體(Media)、藥品(Medication)、配藥或藥品調劑(MedicationDispense)、藥品知識(MedicationKnowledge)藥品請求(MedicationRequest)、用藥聲明(MedicationStatement)、醫藥產品(MedicinalProduct)、醫藥產品授權(MedicinalProductAuthorization)、醫藥產品成份(MedicinalProductIngredient)、醫藥產品製造(MedicinalProductManufactured)、醫藥產品包裝(MedicinalProductPackaged)、訊息表頭(MessageHeader)、分子序列(MolecularSequence)、檢驗檢查(Observation)、機構(Organization)、機構隸屬關係(OrganizationAffiliation)、病人(Patient)、付款通知(PaymentNotice)、付款對帳(PaymentReconciliation)、人(Person)、健康照護服務提供者(Practitioner)、健康照護服務提供者角色(PractitionerRole)、處置(Procedure)、出處(Provenance)、問卷題目回覆(QuestionnaireResponse)、研究(ResearchStudy)、服務請求(ServiceRequest)、供應品供應品遞交(SupplyDelivery)、供應品請求(SupplyRequest)、任務(Task)及驗證結果(VerificationResult)。

Usage:

Formal Views of Profile Content

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

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*Organization具有共同目的的一群人或機構
... id 0..1id不重複的ID用以識別儲存在特定FHIR Server中的Organization紀錄,通常又稱為邏輯性ID。
... meta 0..1Meta此Organization Resource的metadata
... implicitRules 0..1uri創建此內容所依據的一組規則
... text 0..1NarrativeOrganization Resource之內容摘要以供人閱讀
... contained 0..*Resource內嵌的(contained)、行內的Resources
... extension 0..*Extension擴充的資料項目
... modifierExtension 0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... identifier S1..*Identifier跨多個系統中識別此機構
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... use S0..1codeusual | official | temp | secondary | old (如果知道)
Binding: IdentifierUse (required): 如果已知,請說明此識別碼的目的;應填入所綁定值集中的其中一個代碼。

.... type S0..1CodeableConceptTW機構識別碼(identifier)的型別說明
Binding: IdentifierType + 臺灣衛福部資訊處識別碼類型值集 (extensible): 識別碼的型別,用於決定特定目的所適用的識別碼;應填入所綁定值集中的其中一個代碼。

.... system S0..1uri機構識別碼(identifier)的命名空間(namespace),可至[twTerminology](https://twcore.mohw.gov.tw/ts/namingsystem.jsp?status=active&type=0)申請或查詢命名系統。
.... value S1..1string唯一值
.... period 0..1Period此機構識別碼(identifier)的使用效期
.... assigner 0..1Reference(TW Core Organization)簽發identifier的機構(可以只是文字表述)
... active S0..1boolean此機構的紀錄是否仍在使用中
... type S0..1CodeableConceptTW機構的型別
Binding: OrganizationType (example): 用於分類機構;可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。

... name S1..1string機構的名稱
... alias 0..*string此機構目前或過去已知的其他(多個)名稱
... telecom S0..*ContactPoint此機構的詳細聯絡方式。 org-3:一個機構的通訊永遠不可能是「家用」,意即不可能使用「home」。
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... system S0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): 應填入所綁定值集中的其中一個代碼。

.... value S0..1string實際的聯絡方式之細節
.... use 0..1codehome | work | temp | old | mobile-此聯絡方式的用途
Binding: ContactPointUse (required): 應填入所綁定值集中的其中一個代碼。

.... rank 0..1positiveInt具體說明偏好的使用順序(1=最高優先順序)
.... period 0..1Period此聯絡方式的使用效期
... address 0..*TWCoreAddress此機構的地址。 org-2:一個機構的地址永遠不可能是「家用」,意即不可能使用「home」。
... partOf 0..1Reference(TW Core Organization)此機構屬於哪個更高層次機構的一部分
... contact 0..*BackboneElement某一用途的機構聯絡方式
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension 0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... purpose 0..1CodeableConceptTW聯絡的型別
Binding: ContactEntityType (extensible): 你所聯絡之聯絡人的聯絡方式用途;應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。

.... name 0..1HumanName聯絡人名字
.... telecom 0..*ContactPoint聯絡人的詳細聯絡方式(例如:電話、電子郵件等)。
.... address 0..1TWCoreAddress聯絡人的到訪或郵政地址
... endpoint 0..*Reference(Endpoint)存取此Organization的技術服務的終端(endpoints)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier.typeextensibleTWIdentifierType
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/identifier-type-tw
from this IG
Organization.typeexampleOrganizationType
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*Organization具有共同目的的一群人或機構
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id Σ0..1id不重複的ID用以識別儲存在特定FHIR Server中的Organization紀錄,通常又稱為邏輯性ID。
... meta Σ0..1Meta此Organization Resource的metadata
... implicitRules ?!Σ0..1uri創建此內容所依據的一組規則
... text 0..1NarrativeOrganization Resource之內容摘要以供人閱讀
... contained 0..*Resource內嵌的(contained)、行內的Resources
... extension 0..*Extension擴充的資料項目
... modifierExtension ?!0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... identifier SΣC1..*Identifier跨多個系統中識別此機構
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
Slice: Unordered, Open by value:url
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (如果知道)
Binding: IdentifierUse (required): 如果已知,請說明此識別碼的目的;應填入所綁定值集中的其中一個代碼。

.... type S0..1CodeableConceptTW機構識別碼(identifier)的型別說明
Binding: IdentifierType + 臺灣衛福部資訊處識別碼類型值集 (extensible): 識別碼的型別,用於決定特定目的所適用的識別碼;應填入所綁定值集中的其中一個代碼。

.... system SΣ0..1uri機構識別碼(identifier)的命名空間(namespace),可至[twTerminology](https://twcore.mohw.gov.tw/ts/namingsystem.jsp?status=active&type=0)申請或查詢命名系統。
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1string唯一值
Example General: 123456
.... period Σ0..1Period此機構識別碼(identifier)的使用效期
.... assigner Σ0..1Reference(TW Core Organization)簽發identifier的機構(可以只是文字表述)
... active ?!SΣ0..1boolean此機構的紀錄是否仍在使用中
... type S0..1CodeableConceptTW機構的型別
Binding: OrganizationType (example): 用於分類機構;可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。


... name SΣC1..1string機構的名稱
... alias 0..*string此機構目前或過去已知的其他(多個)名稱
... telecom SC0..*ContactPoint此機構的詳細聯絡方式。 org-3:一個機構的通訊永遠不可能是「家用」,意即不可能使用「home」。
org-3: The telecom of an organization can never be of use 'home'
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
Slice: Unordered, Open by value:url
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): 應填入所綁定值集中的其中一個代碼。

.... value SΣ0..1string實際的聯絡方式之細節
.... use ?!Σ0..1codehome | work | temp | old | mobile-此聯絡方式的用途
Binding: ContactPointUse (required): 應填入所綁定值集中的其中一個代碼。

.... rank Σ0..1positiveInt具體說明偏好的使用順序(1=最高優先順序)
.... period Σ0..1Period此聯絡方式的使用效期
... address C0..*TWCoreAddress此機構的地址。 org-2:一個機構的地址永遠不可能是「家用」,意即不可能使用「home」。
org-2: An address of an organization can never be of use 'home'
... partOf Σ0..1Reference(TW Core Organization)此機構屬於哪個更高層次機構的一部分
... contact 0..*BackboneElement某一用途的機構聯絡方式
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension ?!Σ0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... purpose 0..1CodeableConceptTW聯絡的型別
Binding: ContactEntityType (extensible): 你所聯絡之聯絡人的聯絡方式用途;應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。

.... name 0..1HumanName聯絡人名字
.... telecom 0..*ContactPoint聯絡人的詳細聯絡方式(例如:電話、電子郵件等)。
.... address 0..1TWCoreAddress聯絡人的到訪或郵政地址
... endpoint 0..*Reference(Endpoint)存取此Organization的技術服務的終端(endpoints)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier.typeextensibleTWIdentifierType
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/identifier-type-tw
from this IG
Organization.typeexampleOrganizationType
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*Organization具有共同目的的一群人或機構
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id Σ0..1id不重複的ID用以識別儲存在特定FHIR Server中的Organization紀錄,通常又稱為邏輯性ID。
... meta Σ0..1Meta此Organization Resource的metadata
... implicitRules ?!Σ0..1uri創建此內容所依據的一組規則
... text 0..1NarrativeOrganization Resource之內容摘要以供人閱讀
... contained 0..*Resource內嵌的(contained)、行內的Resources
... extension 0..*Extension擴充的資料項目
... modifierExtension ?!0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... identifier SΣC1..*Identifier跨多個系統中識別此機構
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
Slice: Unordered, Open by value:url
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (如果知道)
Binding: IdentifierUse (required): 如果已知,請說明此識別碼的目的;應填入所綁定值集中的其中一個代碼。

.... type S0..1CodeableConceptTW機構識別碼(identifier)的型別說明
Binding: IdentifierType + 臺灣衛福部資訊處識別碼類型值集 (extensible): 識別碼的型別,用於決定特定目的所適用的識別碼;應填入所綁定值集中的其中一個代碼。

.... system SΣ0..1uri機構識別碼(identifier)的命名空間(namespace),可至[twTerminology](https://twcore.mohw.gov.tw/ts/namingsystem.jsp?status=active&type=0)申請或查詢命名系統。
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1string唯一值
Example General: 123456
.... period Σ0..1Period此機構識別碼(identifier)的使用效期
.... assigner Σ0..1Reference(TW Core Organization)簽發identifier的機構(可以只是文字表述)
... active ?!SΣ0..1boolean此機構的紀錄是否仍在使用中
... type S0..1CodeableConceptTW機構的型別
Binding: OrganizationType (example): 用於分類機構;可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。


... name SΣC1..1string機構的名稱
... alias 0..*string此機構目前或過去已知的其他(多個)名稱
... telecom SC0..*ContactPoint此機構的詳細聯絡方式。 org-3:一個機構的通訊永遠不可能是「家用」,意即不可能使用「home」。
org-3: The telecom of an organization can never be of use 'home'
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
Slice: Unordered, Open by value:url
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): 應填入所綁定值集中的其中一個代碼。

.... value SΣ0..1string實際的聯絡方式之細節
.... use ?!Σ0..1codehome | work | temp | old | mobile-此聯絡方式的用途
Binding: ContactPointUse (required): 應填入所綁定值集中的其中一個代碼。

.... rank Σ0..1positiveInt具體說明偏好的使用順序(1=最高優先順序)
.... period Σ0..1Period此聯絡方式的使用效期
... address C0..*TWCoreAddress此機構的地址。 org-2:一個機構的地址永遠不可能是「家用」,意即不可能使用「home」。
org-2: An address of an organization can never be of use 'home'
... partOf Σ0..1Reference(TW Core Organization)此機構屬於哪個更高層次機構的一部分
... contact 0..*BackboneElement某一用途的機構聯絡方式
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension ?!Σ0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... purpose 0..1CodeableConceptTW聯絡的型別
Binding: ContactEntityType (extensible): 你所聯絡之聯絡人的聯絡方式用途;應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。

.... name 0..1HumanName聯絡人名字
.... telecom 0..*ContactPoint聯絡人的詳細聯絡方式(例如:電話、電子郵件等)。
.... address 0..1TWCoreAddress聯絡人的到訪或郵政地址
... endpoint 0..*Reference(Endpoint)存取此Organization的技術服務的終端(endpoints)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier.typeextensibleTWIdentifierType
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/identifier-type-tw
from this IG
Organization.typeexampleOrganizationType
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

Differential View

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*Organization具有共同目的的一群人或機構
... id 0..1id不重複的ID用以識別儲存在特定FHIR Server中的Organization紀錄,通常又稱為邏輯性ID。
... meta 0..1Meta此Organization Resource的metadata
... implicitRules 0..1uri創建此內容所依據的一組規則
... text 0..1NarrativeOrganization Resource之內容摘要以供人閱讀
... contained 0..*Resource內嵌的(contained)、行內的Resources
... extension 0..*Extension擴充的資料項目
... modifierExtension 0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... identifier S1..*Identifier跨多個系統中識別此機構
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... use S0..1codeusual | official | temp | secondary | old (如果知道)
Binding: IdentifierUse (required): 如果已知,請說明此識別碼的目的;應填入所綁定值集中的其中一個代碼。

.... type S0..1CodeableConceptTW機構識別碼(identifier)的型別說明
Binding: IdentifierType + 臺灣衛福部資訊處識別碼類型值集 (extensible): 識別碼的型別,用於決定特定目的所適用的識別碼;應填入所綁定值集中的其中一個代碼。

.... system S0..1uri機構識別碼(identifier)的命名空間(namespace),可至[twTerminology](https://twcore.mohw.gov.tw/ts/namingsystem.jsp?status=active&type=0)申請或查詢命名系統。
.... value S1..1string唯一值
.... period 0..1Period此機構識別碼(identifier)的使用效期
.... assigner 0..1Reference(TW Core Organization)簽發identifier的機構(可以只是文字表述)
... active S0..1boolean此機構的紀錄是否仍在使用中
... type S0..1CodeableConceptTW機構的型別
Binding: OrganizationType (example): 用於分類機構;可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。

... name S1..1string機構的名稱
... alias 0..*string此機構目前或過去已知的其他(多個)名稱
... telecom S0..*ContactPoint此機構的詳細聯絡方式。 org-3:一個機構的通訊永遠不可能是「家用」,意即不可能使用「home」。
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... system S0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): 應填入所綁定值集中的其中一個代碼。

.... value S0..1string實際的聯絡方式之細節
.... use 0..1codehome | work | temp | old | mobile-此聯絡方式的用途
Binding: ContactPointUse (required): 應填入所綁定值集中的其中一個代碼。

.... rank 0..1positiveInt具體說明偏好的使用順序(1=最高優先順序)
.... period 0..1Period此聯絡方式的使用效期
... address 0..*TWCoreAddress此機構的地址。 org-2:一個機構的地址永遠不可能是「家用」,意即不可能使用「home」。
... partOf 0..1Reference(TW Core Organization)此機構屬於哪個更高層次機構的一部分
... contact 0..*BackboneElement某一用途的機構聯絡方式
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension 0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... purpose 0..1CodeableConceptTW聯絡的型別
Binding: ContactEntityType (extensible): 你所聯絡之聯絡人的聯絡方式用途;應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。

.... name 0..1HumanName聯絡人名字
.... telecom 0..*ContactPoint聯絡人的詳細聯絡方式(例如:電話、電子郵件等)。
.... address 0..1TWCoreAddress聯絡人的到訪或郵政地址
... endpoint 0..*Reference(Endpoint)存取此Organization的技術服務的終端(endpoints)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier.typeextensibleTWIdentifierType
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/identifier-type-tw
from this IG
Organization.typeexampleOrganizationType
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*Organization具有共同目的的一群人或機構
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id Σ0..1id不重複的ID用以識別儲存在特定FHIR Server中的Organization紀錄,通常又稱為邏輯性ID。
... meta Σ0..1Meta此Organization Resource的metadata
... implicitRules ?!Σ0..1uri創建此內容所依據的一組規則
... text 0..1NarrativeOrganization Resource之內容摘要以供人閱讀
... contained 0..*Resource內嵌的(contained)、行內的Resources
... extension 0..*Extension擴充的資料項目
... modifierExtension ?!0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... identifier SΣC1..*Identifier跨多個系統中識別此機構
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
Slice: Unordered, Open by value:url
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (如果知道)
Binding: IdentifierUse (required): 如果已知,請說明此識別碼的目的;應填入所綁定值集中的其中一個代碼。

.... type S0..1CodeableConceptTW機構識別碼(identifier)的型別說明
Binding: IdentifierType + 臺灣衛福部資訊處識別碼類型值集 (extensible): 識別碼的型別,用於決定特定目的所適用的識別碼;應填入所綁定值集中的其中一個代碼。

.... system SΣ0..1uri機構識別碼(identifier)的命名空間(namespace),可至[twTerminology](https://twcore.mohw.gov.tw/ts/namingsystem.jsp?status=active&type=0)申請或查詢命名系統。
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1string唯一值
Example General: 123456
.... period Σ0..1Period此機構識別碼(identifier)的使用效期
.... assigner Σ0..1Reference(TW Core Organization)簽發identifier的機構(可以只是文字表述)
... active ?!SΣ0..1boolean此機構的紀錄是否仍在使用中
... type S0..1CodeableConceptTW機構的型別
Binding: OrganizationType (example): 用於分類機構;可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。


... name SΣC1..1string機構的名稱
... alias 0..*string此機構目前或過去已知的其他(多個)名稱
... telecom SC0..*ContactPoint此機構的詳細聯絡方式。 org-3:一個機構的通訊永遠不可能是「家用」,意即不可能使用「home」。
org-3: The telecom of an organization can never be of use 'home'
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
Slice: Unordered, Open by value:url
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): 應填入所綁定值集中的其中一個代碼。

.... value SΣ0..1string實際的聯絡方式之細節
.... use ?!Σ0..1codehome | work | temp | old | mobile-此聯絡方式的用途
Binding: ContactPointUse (required): 應填入所綁定值集中的其中一個代碼。

.... rank Σ0..1positiveInt具體說明偏好的使用順序(1=最高優先順序)
.... period Σ0..1Period此聯絡方式的使用效期
... address C0..*TWCoreAddress此機構的地址。 org-2:一個機構的地址永遠不可能是「家用」,意即不可能使用「home」。
org-2: An address of an organization can never be of use 'home'
... partOf Σ0..1Reference(TW Core Organization)此機構屬於哪個更高層次機構的一部分
... contact 0..*BackboneElement某一用途的機構聯絡方式
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension ?!Σ0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... purpose 0..1CodeableConceptTW聯絡的型別
Binding: ContactEntityType (extensible): 你所聯絡之聯絡人的聯絡方式用途;應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。

.... name 0..1HumanName聯絡人名字
.... telecom 0..*ContactPoint聯絡人的詳細聯絡方式(例如:電話、電子郵件等)。
.... address 0..1TWCoreAddress聯絡人的到訪或郵政地址
... endpoint 0..*Reference(Endpoint)存取此Organization的技術服務的終端(endpoints)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier.typeextensibleTWIdentifierType
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/identifier-type-tw
from this IG
Organization.typeexampleOrganizationType
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*Organization具有共同目的的一群人或機構
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id Σ0..1id不重複的ID用以識別儲存在特定FHIR Server中的Organization紀錄,通常又稱為邏輯性ID。
... meta Σ0..1Meta此Organization Resource的metadata
... implicitRules ?!Σ0..1uri創建此內容所依據的一組規則
... text 0..1NarrativeOrganization Resource之內容摘要以供人閱讀
... contained 0..*Resource內嵌的(contained)、行內的Resources
... extension 0..*Extension擴充的資料項目
... modifierExtension ?!0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
... identifier SΣC1..*Identifier跨多個系統中識別此機構
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
Slice: Unordered, Open by value:url
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (如果知道)
Binding: IdentifierUse (required): 如果已知,請說明此識別碼的目的;應填入所綁定值集中的其中一個代碼。

.... type S0..1CodeableConceptTW機構識別碼(identifier)的型別說明
Binding: IdentifierType + 臺灣衛福部資訊處識別碼類型值集 (extensible): 識別碼的型別,用於決定特定目的所適用的識別碼;應填入所綁定值集中的其中一個代碼。

.... system SΣ0..1uri機構識別碼(identifier)的命名空間(namespace),可至[twTerminology](https://twcore.mohw.gov.tw/ts/namingsystem.jsp?status=active&type=0)申請或查詢命名系統。
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1string唯一值
Example General: 123456
.... period Σ0..1Period此機構識別碼(identifier)的使用效期
.... assigner Σ0..1Reference(TW Core Organization)簽發identifier的機構(可以只是文字表述)
... active ?!SΣ0..1boolean此機構的紀錄是否仍在使用中
... type S0..1CodeableConceptTW機構的型別
Binding: OrganizationType (example): 用於分類機構;可參考所綁定值集,但此值集只是針對這個欄位的一個可能值的範例,不預期也不鼓勵使用者一定要使用此值集的代碼。


... name SΣC1..1string機構的名稱
... alias 0..*string此機構目前或過去已知的其他(多個)名稱
... telecom SC0..*ContactPoint此機構的詳細聯絡方式。 org-3:一個機構的通訊永遠不可能是「家用」,意即不可能使用「home」。
org-3: The telecom of an organization can never be of use 'home'
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
Slice: Unordered, Open by value:url
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): 應填入所綁定值集中的其中一個代碼。

.... value SΣ0..1string實際的聯絡方式之細節
.... use ?!Σ0..1codehome | work | temp | old | mobile-此聯絡方式的用途
Binding: ContactPointUse (required): 應填入所綁定值集中的其中一個代碼。

.... rank Σ0..1positiveInt具體說明偏好的使用順序(1=最高優先順序)
.... period Σ0..1Period此聯絡方式的使用效期
... address C0..*TWCoreAddress此機構的地址。 org-2:一個機構的地址永遠不可能是「家用」,意即不可能使用「home」。
org-2: An address of an organization can never be of use 'home'
... partOf Σ0..1Reference(TW Core Organization)此機構屬於哪個更高層次機構的一部分
... contact 0..*BackboneElement某一用途的機構聯絡方式
.... id 0..1string唯一可識別ID,以供資料項目間相互參照。
.... extension 0..*Extension擴充的資料項目
.... modifierExtension ?!Σ0..*Extension此擴充的資料項目可能會完全修正或改變其他資料項目的意涵,需特別留意。
.... purpose 0..1CodeableConceptTW聯絡的型別
Binding: ContactEntityType (extensible): 你所聯絡之聯絡人的聯絡方式用途;應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。

.... name 0..1HumanName聯絡人名字
.... telecom 0..*ContactPoint聯絡人的詳細聯絡方式(例如:電話、電子郵件等)。
.... address 0..1TWCoreAddress聯絡人的到訪或郵政地址
... endpoint 0..*Reference(Endpoint)存取此Organization的技術服務的終端(endpoints)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier.typeextensibleTWIdentifierType
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/identifier-type-tw
from this IG
Organization.typeexampleOrganizationType
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

 

Other representations of profile: CSV, Excel, Schematron

Notes:

以下概述了此Profile所需的RESTful FHIR互動功能。有關TW Core IG支援的RESTful互動功能的完整清單,請參閱TW Core Server能力聲明

建議應該支援以下查詢參數:

  1. 建議應該(SHOULD) 支援透過查詢參數 _id 查詢所有Organization:
    (如何透過token查詢)
    GET [base]/Organization?_id=[id]
    GET [base]/Organization/[id]

    例子:
    (1) GET [base]/Organization?_id=org-example
    (2) GET [base]/Organization/org-example

  2. 建議應該(SHOULD) 支援透過查詢參數 identifier 查詢所有Organization:
    (如何透過token查詢)
    GET [base]/Organization?identifier={system|}[code]

    例子:
    (1) GET [base]/Organization?identifier=http://ns.electronichealth.net.au/id/hi/hpio/1.0|8003621566684455

  3. 建議應該(SHOULD) 支援透過查詢參數 name 查詢所有Organization:
    (如何透過string查詢)
    GET [base]/Organization?name=[name]

    例子:
    (1) GET [base]/Organization?name=Downunder Hospital

  4. 建議應該(SHOULD) 支援透過查詢參數 type 查詢所有Organization:
    (如何透過token查詢)
    GET [base]/Organization?type={system|}[code]

    例子:
    (1) GET [base]/Organization?type=http://terminology.hl7.org/CodeSystem/organization-type|prov