臺灣核心實作指引(TW Core IG)
1.0.0 - STU 1.0.0 Taiwan flag

臺灣核心實作指引(TW Core IG), published by 衛生福利部. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/TU9IVy1UV0NvcmVJRw/VFcgQ29yZSBJRyBJVFJJ/ and changes regularly. See the Directory of published versions

Resource Profile: TW Core RelatedPerson

Official URL: https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/RelatedPerson-twcore Version: 1.0.0
Active as of 2026-11-10 Computable Name: TWCoreRelatedPerson

此臺灣核心-相關人士(TW Core RelatedPerson) Profile說明本IG如何進一步定義FHIR的RelatedPerson Resource以呈現相關人士資料。

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
RelatedPerson.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
RelatedPerson.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
RelatedPerson.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether this related person's record is in active use
RelatedPerson.patient This element must be supported. This element is included in summaries. 1..1 Reference(TW Core Patient) The patient this person is related to
RelatedPerson.relationship This element must be supported. This element is included in summaries. C 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): 病人與相關人士之間關係的類型。
RelatedPerson.name This element must be supported. This element is included in summaries. C 0..* HumanName A name associated with the person
RelatedPerson.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the person
RelatedPerson.address This element must be supported. This element is included in summaries. 0..* Address Address where the related person can be contacted or visited

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base preferred Patient relationship type 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson 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 RelatedPerson 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 RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson 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 RelatedPerson

NameFlagsCard.TypeDescription & Constraints    Filter: doco
RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
RelatedPerson.active This element must be supported. 1..1 boolean Whether this related person's record is in active use
RelatedPerson.patient This element must be supported. 1..1 Reference(TW Core Patient) The patient this person is related to
RelatedPerson.relationship This element must be supported. C 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): 病人與相關人士之間關係的類型。
RelatedPerson.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
RelatedPerson.address This element must be supported. 0..* Address Address where the related person can be contacted or visited

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base preferred Patient relationship type 📦4.0.1 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: doco
RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
RelatedPerson.id This element is included in summaries. 0..1 id Logical id of this artifact
RelatedPerson.meta This element is included in summaries. 0..1 Meta Metadata about the resource
RelatedPerson.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
RelatedPerson.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
RelatedPerson.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
RelatedPerson.contained 0..* Resource Contained, inline Resources
RelatedPerson.extension 0..* Extension Additional content defined by implementations
RelatedPerson.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
RelatedPerson.identifier This element is included in summaries. 0..* Identifier A human identifier for this person
RelatedPerson.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether this related person's record is in active use
RelatedPerson.patient This element must be supported. This element is included in summaries. 1..1 Reference(TW Core Patient) The patient this person is related to
RelatedPerson.relationship This element must be supported. This element is included in summaries. C 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): 病人與相關人士之間關係的類型。
RelatedPerson.name This element must be supported. This element is included in summaries. C 0..* HumanName A name associated with the person
RelatedPerson.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the person
RelatedPerson.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
RelatedPerson.birthDate This element is included in summaries. 0..1 date The date on which the related person was born
RelatedPerson.address This element must be supported. This element is included in summaries. 0..* Address Address where the related person can be contacted or visited
RelatedPerson.photo 0..* Attachment Image of the person
RelatedPerson.period 0..1 Period Period of time that this relationship is considered valid
RelatedPerson.communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
RelatedPerson.communication.id 0..1 string Unique id for inter-element referencing
RelatedPerson.communication.extension 0..* Extension Additional content defined by implementations
RelatedPerson.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
RelatedPerson.communication.language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
RelatedPerson.communication.preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.language Base preferred Common Languages 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base preferred Patient relationship type 📦4.0.1 FHIR Std.
RelatedPerson.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson 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 RelatedPerson 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 RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson 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 RelatedPerson

Summary

Mandatory: 1 element
Must-Support: 6 elements

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
RelatedPerson.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
RelatedPerson.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
RelatedPerson.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether this related person's record is in active use
RelatedPerson.patient This element must be supported. This element is included in summaries. 1..1 Reference(TW Core Patient) The patient this person is related to
RelatedPerson.relationship This element must be supported. This element is included in summaries. C 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): 病人與相關人士之間關係的類型。
RelatedPerson.name This element must be supported. This element is included in summaries. C 0..* HumanName A name associated with the person
RelatedPerson.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the person
RelatedPerson.address This element must be supported. This element is included in summaries. 0..* Address Address where the related person can be contacted or visited

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base preferred Patient relationship type 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson 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 RelatedPerson 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 RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson 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()

Differential View

This structure is derived from RelatedPerson

NameFlagsCard.TypeDescription & Constraints    Filter: doco
RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
RelatedPerson.active This element must be supported. 1..1 boolean Whether this related person's record is in active use
RelatedPerson.patient This element must be supported. 1..1 Reference(TW Core Patient) The patient this person is related to
RelatedPerson.relationship This element must be supported. C 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): 病人與相關人士之間關係的類型。
RelatedPerson.name This element must be supported. C 0..* HumanName A name associated with the person
RelatedPerson.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
RelatedPerson.address This element must be supported. 0..* Address Address where the related person can be contacted or visited

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base preferred Patient relationship type 📦4.0.1 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
RelatedPerson.id This element is included in summaries. 0..1 id Logical id of this artifact
RelatedPerson.meta This element is included in summaries. 0..1 Meta Metadata about the resource
RelatedPerson.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
RelatedPerson.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
RelatedPerson.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
RelatedPerson.contained 0..* Resource Contained, inline Resources
RelatedPerson.extension 0..* Extension Additional content defined by implementations
RelatedPerson.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
RelatedPerson.identifier This element is included in summaries. 0..* Identifier A human identifier for this person
RelatedPerson.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether this related person's record is in active use
RelatedPerson.patient This element must be supported. This element is included in summaries. 1..1 Reference(TW Core Patient) The patient this person is related to
RelatedPerson.relationship This element must be supported. This element is included in summaries. C 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): 病人與相關人士之間關係的類型。
RelatedPerson.name This element must be supported. This element is included in summaries. C 0..* HumanName A name associated with the person
RelatedPerson.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the person
RelatedPerson.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
RelatedPerson.birthDate This element is included in summaries. 0..1 date The date on which the related person was born
RelatedPerson.address This element must be supported. This element is included in summaries. 0..* Address Address where the related person can be contacted or visited
RelatedPerson.photo 0..* Attachment Image of the person
RelatedPerson.period 0..1 Period Period of time that this relationship is considered valid
RelatedPerson.communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
RelatedPerson.communication.id 0..1 string Unique id for inter-element referencing
RelatedPerson.communication.extension 0..* Extension Additional content defined by implementations
RelatedPerson.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
RelatedPerson.communication.language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
RelatedPerson.communication.preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.language Base preferred Common Languages 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base preferred Patient relationship type 📦4.0.1 FHIR Std.
RelatedPerson.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson 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 RelatedPerson 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 RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson 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 RelatedPerson

Summary

Mandatory: 1 element
Must-Support: 6 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron

Notes:

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

必須支援以下查詢參數:

  1. 必須(SHALL) 支援透過查詢參數 _id 或 id 查詢所有RelatedPerson:
    (如何透過token查詢)
    GET [base]/RelatedPerson?_id=[id]
    GET [base]/RelatedPerson/[id]

    例子:
    (1) GET [base]/RelatedPerson?_id=rel-per-example
    (2) GET [base]/RelatedPerson/rel-example

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

  1. 建議應該(SHOULD) 支援透過查詢參數 patient 查詢所有RelatedPerson:
    (如何透過reference查詢)
    GET [base]/RelatedPerson?patient={Type/}[id]

    例子:
    (1) GET [base]/RelatedPerson?patient=Patient/pat-example

  2. 建議應該(SHOULD) 支援透過查詢參數 patient 及 name 查詢所有RelatedPerson:
    (如何透過reference查詢)
    (如何透過string查詢)
    GET [base]/RelatedPerson?patient={Type/}[id]&name=[string]

    例子:
    (1) GET [base]/RelatedPerson?patient=Patient/pat-example&name=李立偉