臺灣社政領域基礎實作指引
0.0.1 - ci-build

臺灣社政領域基礎實作指引, published by 衛生福利部社會及家庭署. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/sfaassn2025-source/base/ and changes regularly. See the Directory of published versions

Resource Profile: 關係人資料-RelatedPerson TWSS Base

Official URL: https://sfaa.gov.tw/base/StructureDefinition/RelatedPerson-twss-base Version: 0.0.1
Draft as of 2026-10-20 Computable Name: RelatedPersonTWSSBase

關係人資料-RelatedPerson TWSS Base Profile 表達衛生福利部社會及家庭署業務中的關係人資料。本 Profile 因 TWSS Base 的基數需求與 reference target 與 TW Core RelatedPerson 0.3.2 限制不同，故繼承原生 RelatedPerson，並沿用相容的 TW Core 0.3.2 規則。

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.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
RelatedPerson.Slices for extension.extension:nationality This element must be supported. 0..1 CodeableConceptTW 關係人國籍。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-nationality
RelatedPerson.Slices for extension.extension:ethnicGroup This element must be supported. 0..* CodeableConceptTW 關係人族群身分。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-ethnic-group
Binding: TWSS-族群身分值集 (required)
RelatedPerson.Slices for extension.extension:maritalStatus This element must be supported. 0..1 CodeableConceptTW 關係人婚姻狀態。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-marital-status
Binding: TWSS-婚姻狀態值集 (extensible)
RelatedPerson.Slices for extension.extension:religion This element must be supported. 0..1 CodeableConceptTW 關係人宗教信仰。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-religion
Binding: TWSS-宗教信仰值集 (required)
RelatedPerson.Slices for extension.extension:age This element must be supported. C 0..1 (Complex) 關係人年齡及年齡記錄日期；填寫年齡時必須同時填寫記錄日期。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-age
Constraints: twss-age-requires-recorded-date
RelatedPerson.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
RelatedPerson.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier A human identifier for this person
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
RelatedPerson.Slices for identifier.identifier:All Slices Content/Rules for all slices
RelatedPerson.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
RelatedPerson.Slices for identifier.identifier:All Slices.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
RelatedPerson.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
RelatedPerson.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
RelatedPerson.Slices for identifier.identifier:idCardNumber This element must be supported. This element is included in summaries. 0..1 Identifier 關係人身分證字號。
RelatedPerson.Slices for identifier.identifier:idCardNumber.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official (extensions allowed)
RelatedPerson.Slices for identifier.identifier:idCardNumber.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
RelatedPerson.Slices for identifier.identifier:idCardNumber.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
RelatedPerson.Slices for identifier.identifier:idCardNumber.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
RelatedPerson.Slices for identifier.identifier:relationNumber This element must be supported. This element is included in summaries. 1..1 Identifier 關係人編號；識別碼型別使用 HL7 v2-0203 的 RI（Resource identifier）。
RelatedPerson.Slices for identifier.identifier:relationNumber.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: usual (extensions allowed)
RelatedPerson.Slices for identifier.identifier:relationNumber.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
RelatedPerson.Slices for identifier.identifier:relationNumber.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
RelatedPerson.Slices for identifier.identifier:relationNumber.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
RelatedPerson.active This element is a modifier element. This element must be supported. This element is included in summaries. 0..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(個案資料-Patient TWSS Base) The patient this person is related to
RelatedPerson.relationship This element must be supported. This element is included in summaries. 0..* CodeableConcept The nature of the relationship
Binding: TWSS-關係人類型值集 (extensible): 個案與相關人士之間關係的類型。
RelatedPerson.name This element must be supported. This element is included in summaries. 0..* HumanName A name associated with the person
RelatedPerson.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
RelatedPerson.name.text This element must be supported. This element is included in summaries. 0..1 string Text representation of the full name
RelatedPerson.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the person
RelatedPerson.telecom.system This element must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
RelatedPerson.telecom.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
RelatedPerson.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
RelatedPerson.gender This element must be supported. 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 must be supported. 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..* AddressTWSSBase Address where the related person can be contacted or visited
RelatedPerson.period This element must be supported. 0..1 Period Period of time that this relationship is considered valid

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:idCardNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:idCardNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:relationNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:relationNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base extensible TWSS-關係人類型值集 📦0.0.1 This IG
RelatedPerson.name.use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
RelatedPerson.gender Base required AdministrativeGender 📍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()
twss-age-requires-recorded-date error RelatedPerson.extension:age 填寫年齡時，必須同時填寫年齡記錄日期。 extension.where(url = 'age').exists() implies extension.where(url = 'recordedDate').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.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
RelatedPerson.Slices for extension.extension:nationality This element must be supported. 0..1 CodeableConceptTW 關係人國籍。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-nationality
RelatedPerson.Slices for extension.extension:ethnicGroup This element must be supported. 0..* CodeableConceptTW 關係人族群身分。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-ethnic-group
Binding: TWSS-族群身分值集 (required)
RelatedPerson.Slices for extension.extension:maritalStatus This element must be supported. 0..1 CodeableConceptTW 關係人婚姻狀態。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-marital-status
Binding: TWSS-婚姻狀態值集 (extensible)
RelatedPerson.Slices for extension.extension:religion This element must be supported. 0..1 CodeableConceptTW 關係人宗教信仰。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-religion
Binding: TWSS-宗教信仰值集 (required)
RelatedPerson.Slices for extension.extension:age This element must be supported. 0..1 (Complex) 關係人年齡及年齡記錄日期；填寫年齡時必須同時填寫記錄日期。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-age
RelatedPerson.Slices for identifier This element must be supported. 1..* Identifier A human identifier for this person
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
RelatedPerson.Slices for identifier.identifier:All Slices Content/Rules for all slices
RelatedPerson.Slices for identifier.identifier:All Slices.use This element must be supported. 0..1 code usual | official | temp | secondary | old (If known)
RelatedPerson.Slices for identifier.identifier:All Slices.type This element must be supported. 0..1 CodeableConcept Description of identifier
RelatedPerson.Slices for identifier.identifier:All Slices.system This element must be supported. 0..1 uri The namespace for the identifier value
RelatedPerson.Slices for identifier.identifier:All Slices.value This element must be supported. 0..1 string The value that is unique
RelatedPerson.Slices for identifier.identifier:idCardNumber This element must be supported. 0..1 Identifier 關係人身分證字號。
RelatedPerson.Slices for identifier.identifier:idCardNumber.use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official (extensions allowed)
RelatedPerson.Slices for identifier.identifier:idCardNumber.type
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.coding
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.coding.system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 (extensions allowed)
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.coding.code 1..1 code Symbol in syntax defined by the system
Required Pattern: NNxxx (extensions allowed)
RelatedPerson.Slices for identifier.identifier:idCardNumber.value 1..1 string The value that is unique
RelatedPerson.Slices for identifier.identifier:relationNumber This element must be supported. 1..1 Identifier 關係人編號；識別碼型別使用 HL7 v2-0203 的 RI（Resource identifier）。
RelatedPerson.Slices for identifier.identifier:relationNumber.use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: usual (extensions allowed)
RelatedPerson.Slices for identifier.identifier:relationNumber.type
RelatedPerson.Slices for identifier.identifier:relationNumber.type.coding
RelatedPerson.Slices for identifier.identifier:relationNumber.type.coding.system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 (extensions allowed)
RelatedPerson.Slices for identifier.identifier:relationNumber.type.coding.code 1..1 code Symbol in syntax defined by the system
Required Pattern: RI (extensions allowed)
RelatedPerson.Slices for identifier.identifier:relationNumber.value 1..1 string The value that is unique
RelatedPerson.active This element must be supported. 0..1 boolean Whether this related person's record is in active use
RelatedPerson.relationship This element must be supported. 0..* CodeableConcept The nature of the relationship
Binding: TWSS-關係人類型值集 (extensible): 個案與相關人士之間關係的類型。
RelatedPerson.name This element must be supported. 0..* HumanName A name associated with the person
RelatedPerson.name.text This element must be supported. 0..1 string Text representation of the full name
RelatedPerson.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
RelatedPerson.telecom.system This element must be supported. 0..1 code phone | fax | email | pager | url | sms | other
RelatedPerson.telecom.value This element must be supported. 0..1 string The actual contact point details
RelatedPerson.gender This element must be supported. 0..1 code male | female | other | unknown
RelatedPerson.birthDate This element must be supported. 0..1 date The date on which the related person was born
RelatedPerson.address This element must be supported. 0..* AddressTWSSBase Address where the related person can be contacted or visited
RelatedPerson.period This element must be supported. 0..1 Period Period of time that this relationship is considered valid

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base extensible TWSS-關係人類型值集 📦0.0.1 This IG
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.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
RelatedPerson.Slices for extension.extension:nationality This element must be supported. 0..1 CodeableConceptTW 關係人國籍。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-nationality
RelatedPerson.Slices for extension.extension:ethnicGroup This element must be supported. 0..* CodeableConceptTW 關係人族群身分。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-ethnic-group
Binding: TWSS-族群身分值集 (required)
RelatedPerson.Slices for extension.extension:maritalStatus This element must be supported. 0..1 CodeableConceptTW 關係人婚姻狀態。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-marital-status
Binding: TWSS-婚姻狀態值集 (extensible)
RelatedPerson.Slices for extension.extension:religion This element must be supported. 0..1 CodeableConceptTW 關係人宗教信仰。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-religion
Binding: TWSS-宗教信仰值集 (required)
RelatedPerson.Slices for extension.extension:age This element must be supported. C 0..1 (Complex) 關係人年齡及年齡記錄日期；填寫年齡時必須同時填寫記錄日期。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-age
Constraints: twss-age-requires-recorded-date
RelatedPerson.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
RelatedPerson.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier A human identifier for this person
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
RelatedPerson.Slices for identifier.identifier:All Slices Content/Rules for all slices
RelatedPerson.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
RelatedPerson.Slices for identifier.identifier:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
RelatedPerson.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
RelatedPerson.Slices for identifier.identifier:All Slices.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
RelatedPerson.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
RelatedPerson.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
RelatedPerson.Slices for identifier.identifier:All Slices.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
RelatedPerson.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
RelatedPerson.Slices for identifier.identifier:idCardNumber This element must be supported. This element is included in summaries. 0..1 Identifier 關係人身分證字號。
RelatedPerson.Slices for identifier.identifier:idCardNumber.id 0..1 string Unique id for inter-element referencing
RelatedPerson.Slices for identifier.identifier:idCardNumber.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
RelatedPerson.Slices for identifier.identifier:idCardNumber.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official (extensions allowed)
RelatedPerson.Slices for identifier.identifier:idCardNumber.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.id 0..1 string Unique id for inter-element referencing
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.coding.id 0..1 string Unique id for inter-element referencing
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 (extensions allowed)
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Required Pattern: NNxxx (extensions allowed)
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
RelatedPerson.Slices for identifier.identifier:idCardNumber.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
RelatedPerson.Slices for identifier.identifier:idCardNumber.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
RelatedPerson.Slices for identifier.identifier:idCardNumber.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
RelatedPerson.Slices for identifier.identifier:idCardNumber.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
RelatedPerson.Slices for identifier.identifier:relationNumber This element must be supported. This element is included in summaries. 1..1 Identifier 關係人編號；識別碼型別使用 HL7 v2-0203 的 RI（Resource identifier）。
RelatedPerson.Slices for identifier.identifier:relationNumber.id 0..1 string Unique id for inter-element referencing
RelatedPerson.Slices for identifier.identifier:relationNumber.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
RelatedPerson.Slices for identifier.identifier:relationNumber.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: usual (extensions allowed)
RelatedPerson.Slices for identifier.identifier:relationNumber.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
RelatedPerson.Slices for identifier.identifier:relationNumber.type.id 0..1 string Unique id for inter-element referencing
RelatedPerson.Slices for identifier.identifier:relationNumber.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
RelatedPerson.Slices for identifier.identifier:relationNumber.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
RelatedPerson.Slices for identifier.identifier:relationNumber.type.coding.id 0..1 string Unique id for inter-element referencing
RelatedPerson.Slices for identifier.identifier:relationNumber.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
RelatedPerson.Slices for identifier.identifier:relationNumber.type.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 (extensions allowed)
RelatedPerson.Slices for identifier.identifier:relationNumber.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
RelatedPerson.Slices for identifier.identifier:relationNumber.type.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Required Pattern: RI (extensions allowed)
RelatedPerson.Slices for identifier.identifier:relationNumber.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
RelatedPerson.Slices for identifier.identifier:relationNumber.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
RelatedPerson.Slices for identifier.identifier:relationNumber.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
RelatedPerson.Slices for identifier.identifier:relationNumber.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
RelatedPerson.Slices for identifier.identifier:relationNumber.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
RelatedPerson.Slices for identifier.identifier:relationNumber.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
RelatedPerson.Slices for identifier.identifier:relationNumber.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
RelatedPerson.active This element is a modifier element. This element must be supported. This element is included in summaries. 0..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(個案資料-Patient TWSS Base) The patient this person is related to
RelatedPerson.relationship This element must be supported. This element is included in summaries. 0..* CodeableConcept The nature of the relationship
Binding: TWSS-關係人類型值集 (extensible): 個案與相關人士之間關係的類型。
RelatedPerson.name This element must be supported. This element is included in summaries. 0..* HumanName A name associated with the person
RelatedPerson.name.id 0..1 string Unique id for inter-element referencing
RelatedPerson.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
RelatedPerson.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
RelatedPerson.name.text This element must be supported. This element is included in summaries. 0..1 string Text representation of the full name
RelatedPerson.name.family This element is included in summaries. 0..1 string Family name (often called 'Surname')
RelatedPerson.name.given This element is included in summaries. 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
RelatedPerson.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
RelatedPerson.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
RelatedPerson.name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
RelatedPerson.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the person
RelatedPerson.telecom.id 0..1 string Unique id for inter-element referencing
RelatedPerson.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
RelatedPerson.telecom.system This element must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
RelatedPerson.telecom.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
RelatedPerson.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
RelatedPerson.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
RelatedPerson.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
RelatedPerson.gender This element must be supported. 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 must be supported. 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..* AddressTWSSBase Address where the related person can be contacted or visited
RelatedPerson.photo 0..* Attachment Image of the person
RelatedPerson.period This element must be supported. 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.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:idCardNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:idCardNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:relationNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:relationNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base extensible TWSS-關係人類型值集 📦0.0.1 This IG
RelatedPerson.name.use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​use Base required ContactPointUse 📍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()
twss-age-requires-recorded-date error RelatedPerson.extension:age 填寫年齡時，必須同時填寫年齡記錄日期。 extension.where(url = 'age').exists() implies extension.where(url = 'recordedDate').exists()

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.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
RelatedPerson.Slices for extension.extension:nationality This element must be supported. 0..1 CodeableConceptTW 關係人國籍。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-nationality
RelatedPerson.Slices for extension.extension:ethnicGroup This element must be supported. 0..* CodeableConceptTW 關係人族群身分。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-ethnic-group
Binding: TWSS-族群身分值集 (required)
RelatedPerson.Slices for extension.extension:maritalStatus This element must be supported. 0..1 CodeableConceptTW 關係人婚姻狀態。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-marital-status
Binding: TWSS-婚姻狀態值集 (extensible)
RelatedPerson.Slices for extension.extension:religion This element must be supported. 0..1 CodeableConceptTW 關係人宗教信仰。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-religion
Binding: TWSS-宗教信仰值集 (required)
RelatedPerson.Slices for extension.extension:age This element must be supported. C 0..1 (Complex) 關係人年齡及年齡記錄日期；填寫年齡時必須同時填寫記錄日期。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-age
Constraints: twss-age-requires-recorded-date
RelatedPerson.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
RelatedPerson.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier A human identifier for this person
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
RelatedPerson.Slices for identifier.identifier:All Slices Content/Rules for all slices
RelatedPerson.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
RelatedPerson.Slices for identifier.identifier:All Slices.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
RelatedPerson.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
RelatedPerson.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
RelatedPerson.Slices for identifier.identifier:idCardNumber This element must be supported. This element is included in summaries. 0..1 Identifier 關係人身分證字號。
RelatedPerson.Slices for identifier.identifier:idCardNumber.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official (extensions allowed)
RelatedPerson.Slices for identifier.identifier:idCardNumber.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
RelatedPerson.Slices for identifier.identifier:idCardNumber.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
RelatedPerson.Slices for identifier.identifier:idCardNumber.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
RelatedPerson.Slices for identifier.identifier:relationNumber This element must be supported. This element is included in summaries. 1..1 Identifier 關係人編號；識別碼型別使用 HL7 v2-0203 的 RI（Resource identifier）。
RelatedPerson.Slices for identifier.identifier:relationNumber.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: usual (extensions allowed)
RelatedPerson.Slices for identifier.identifier:relationNumber.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
RelatedPerson.Slices for identifier.identifier:relationNumber.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
RelatedPerson.Slices for identifier.identifier:relationNumber.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
RelatedPerson.active This element is a modifier element. This element must be supported. This element is included in summaries. 0..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(個案資料-Patient TWSS Base) The patient this person is related to
RelatedPerson.relationship This element must be supported. This element is included in summaries. 0..* CodeableConcept The nature of the relationship
Binding: TWSS-關係人類型值集 (extensible): 個案與相關人士之間關係的類型。
RelatedPerson.name This element must be supported. This element is included in summaries. 0..* HumanName A name associated with the person
RelatedPerson.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
RelatedPerson.name.text This element must be supported. This element is included in summaries. 0..1 string Text representation of the full name
RelatedPerson.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the person
RelatedPerson.telecom.system This element must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
RelatedPerson.telecom.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
RelatedPerson.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
RelatedPerson.gender This element must be supported. 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 must be supported. 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..* AddressTWSSBase Address where the related person can be contacted or visited
RelatedPerson.period This element must be supported. 0..1 Period Period of time that this relationship is considered valid

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:idCardNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:idCardNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:relationNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:relationNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base extensible TWSS-關係人類型值集 📦0.0.1 This IG
RelatedPerson.name.use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
RelatedPerson.gender Base required AdministrativeGender 📍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()
twss-age-requires-recorded-date error RelatedPerson.extension:age 填寫年齡時，必須同時填寫年齡記錄日期。 extension.where(url = 'age').exists() implies extension.where(url = 'recordedDate').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.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
RelatedPerson.Slices for extension.extension:nationality This element must be supported. 0..1 CodeableConceptTW 關係人國籍。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-nationality
RelatedPerson.Slices for extension.extension:ethnicGroup This element must be supported. 0..* CodeableConceptTW 關係人族群身分。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-ethnic-group
Binding: TWSS-族群身分值集 (required)
RelatedPerson.Slices for extension.extension:maritalStatus This element must be supported. 0..1 CodeableConceptTW 關係人婚姻狀態。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-marital-status
Binding: TWSS-婚姻狀態值集 (extensible)
RelatedPerson.Slices for extension.extension:religion This element must be supported. 0..1 CodeableConceptTW 關係人宗教信仰。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-religion
Binding: TWSS-宗教信仰值集 (required)
RelatedPerson.Slices for extension.extension:age This element must be supported. 0..1 (Complex) 關係人年齡及年齡記錄日期；填寫年齡時必須同時填寫記錄日期。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-age
RelatedPerson.Slices for identifier This element must be supported. 1..* Identifier A human identifier for this person
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
RelatedPerson.Slices for identifier.identifier:All Slices Content/Rules for all slices
RelatedPerson.Slices for identifier.identifier:All Slices.use This element must be supported. 0..1 code usual | official | temp | secondary | old (If known)
RelatedPerson.Slices for identifier.identifier:All Slices.type This element must be supported. 0..1 CodeableConcept Description of identifier
RelatedPerson.Slices for identifier.identifier:All Slices.system This element must be supported. 0..1 uri The namespace for the identifier value
RelatedPerson.Slices for identifier.identifier:All Slices.value This element must be supported. 0..1 string The value that is unique
RelatedPerson.Slices for identifier.identifier:idCardNumber This element must be supported. 0..1 Identifier 關係人身分證字號。
RelatedPerson.Slices for identifier.identifier:idCardNumber.use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official (extensions allowed)
RelatedPerson.Slices for identifier.identifier:idCardNumber.type
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.coding
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.coding.system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 (extensions allowed)
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.coding.code 1..1 code Symbol in syntax defined by the system
Required Pattern: NNxxx (extensions allowed)
RelatedPerson.Slices for identifier.identifier:idCardNumber.value 1..1 string The value that is unique
RelatedPerson.Slices for identifier.identifier:relationNumber This element must be supported. 1..1 Identifier 關係人編號；識別碼型別使用 HL7 v2-0203 的 RI（Resource identifier）。
RelatedPerson.Slices for identifier.identifier:relationNumber.use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: usual (extensions allowed)
RelatedPerson.Slices for identifier.identifier:relationNumber.type
RelatedPerson.Slices for identifier.identifier:relationNumber.type.coding
RelatedPerson.Slices for identifier.identifier:relationNumber.type.coding.system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 (extensions allowed)
RelatedPerson.Slices for identifier.identifier:relationNumber.type.coding.code 1..1 code Symbol in syntax defined by the system
Required Pattern: RI (extensions allowed)
RelatedPerson.Slices for identifier.identifier:relationNumber.value 1..1 string The value that is unique
RelatedPerson.active This element must be supported. 0..1 boolean Whether this related person's record is in active use
RelatedPerson.patient This element must be supported. 1..1 Reference(個案資料-Patient TWSS Base) The patient this person is related to
RelatedPerson.relationship This element must be supported. 0..* CodeableConcept The nature of the relationship
Binding: TWSS-關係人類型值集 (extensible): 個案與相關人士之間關係的類型。
RelatedPerson.name This element must be supported. 0..* HumanName A name associated with the person
RelatedPerson.name.text This element must be supported. 0..1 string Text representation of the full name
RelatedPerson.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
RelatedPerson.telecom.system This element must be supported. 0..1 code phone | fax | email | pager | url | sms | other
RelatedPerson.telecom.value This element must be supported. 0..1 string The actual contact point details
RelatedPerson.gender This element must be supported. 0..1 code male | female | other | unknown
RelatedPerson.birthDate This element must be supported. 0..1 date The date on which the related person was born
RelatedPerson.address This element must be supported. 0..* AddressTWSSBase Address where the related person can be contacted or visited
RelatedPerson.period This element must be supported. 0..1 Period Period of time that this relationship is considered valid

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base extensible TWSS-關係人類型值集 📦0.0.1 This IG

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.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
RelatedPerson.Slices for extension.extension:nationality This element must be supported. 0..1 CodeableConceptTW 關係人國籍。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-nationality
RelatedPerson.Slices for extension.extension:ethnicGroup This element must be supported. 0..* CodeableConceptTW 關係人族群身分。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-ethnic-group
Binding: TWSS-族群身分值集 (required)
RelatedPerson.Slices for extension.extension:maritalStatus This element must be supported. 0..1 CodeableConceptTW 關係人婚姻狀態。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-marital-status
Binding: TWSS-婚姻狀態值集 (extensible)
RelatedPerson.Slices for extension.extension:religion This element must be supported. 0..1 CodeableConceptTW 關係人宗教信仰。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-religion
Binding: TWSS-宗教信仰值集 (required)
RelatedPerson.Slices for extension.extension:age This element must be supported. C 0..1 (Complex) 關係人年齡及年齡記錄日期；填寫年齡時必須同時填寫記錄日期。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-age
Constraints: twss-age-requires-recorded-date
RelatedPerson.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
RelatedPerson.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier A human identifier for this person
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
RelatedPerson.Slices for identifier.identifier:All Slices Content/Rules for all slices
RelatedPerson.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
RelatedPerson.Slices for identifier.identifier:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
RelatedPerson.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
RelatedPerson.Slices for identifier.identifier:All Slices.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
RelatedPerson.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
RelatedPerson.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
RelatedPerson.Slices for identifier.identifier:All Slices.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
RelatedPerson.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
RelatedPerson.Slices for identifier.identifier:idCardNumber This element must be supported. This element is included in summaries. 0..1 Identifier 關係人身分證字號。
RelatedPerson.Slices for identifier.identifier:idCardNumber.id 0..1 string Unique id for inter-element referencing
RelatedPerson.Slices for identifier.identifier:idCardNumber.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
RelatedPerson.Slices for identifier.identifier:idCardNumber.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official (extensions allowed)
RelatedPerson.Slices for identifier.identifier:idCardNumber.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.id 0..1 string Unique id for inter-element referencing
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.coding.id 0..1 string Unique id for inter-element referencing
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 (extensions allowed)
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Required Pattern: NNxxx (extensions allowed)
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
RelatedPerson.Slices for identifier.identifier:idCardNumber.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
RelatedPerson.Slices for identifier.identifier:idCardNumber.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
RelatedPerson.Slices for identifier.identifier:idCardNumber.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
RelatedPerson.Slices for identifier.identifier:idCardNumber.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
RelatedPerson.Slices for identifier.identifier:idCardNumber.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
RelatedPerson.Slices for identifier.identifier:relationNumber This element must be supported. This element is included in summaries. 1..1 Identifier 關係人編號；識別碼型別使用 HL7 v2-0203 的 RI（Resource identifier）。
RelatedPerson.Slices for identifier.identifier:relationNumber.id 0..1 string Unique id for inter-element referencing
RelatedPerson.Slices for identifier.identifier:relationNumber.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
RelatedPerson.Slices for identifier.identifier:relationNumber.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: usual (extensions allowed)
RelatedPerson.Slices for identifier.identifier:relationNumber.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
RelatedPerson.Slices for identifier.identifier:relationNumber.type.id 0..1 string Unique id for inter-element referencing
RelatedPerson.Slices for identifier.identifier:relationNumber.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
RelatedPerson.Slices for identifier.identifier:relationNumber.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
RelatedPerson.Slices for identifier.identifier:relationNumber.type.coding.id 0..1 string Unique id for inter-element referencing
RelatedPerson.Slices for identifier.identifier:relationNumber.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
RelatedPerson.Slices for identifier.identifier:relationNumber.type.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 (extensions allowed)
RelatedPerson.Slices for identifier.identifier:relationNumber.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
RelatedPerson.Slices for identifier.identifier:relationNumber.type.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Required Pattern: RI (extensions allowed)
RelatedPerson.Slices for identifier.identifier:relationNumber.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
RelatedPerson.Slices for identifier.identifier:relationNumber.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
RelatedPerson.Slices for identifier.identifier:relationNumber.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
RelatedPerson.Slices for identifier.identifier:relationNumber.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
RelatedPerson.Slices for identifier.identifier:relationNumber.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
RelatedPerson.Slices for identifier.identifier:relationNumber.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
RelatedPerson.Slices for identifier.identifier:relationNumber.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
RelatedPerson.active This element is a modifier element. This element must be supported. This element is included in summaries. 0..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(個案資料-Patient TWSS Base) The patient this person is related to
RelatedPerson.relationship This element must be supported. This element is included in summaries. 0..* CodeableConcept The nature of the relationship
Binding: TWSS-關係人類型值集 (extensible): 個案與相關人士之間關係的類型。
RelatedPerson.name This element must be supported. This element is included in summaries. 0..* HumanName A name associated with the person
RelatedPerson.name.id 0..1 string Unique id for inter-element referencing
RelatedPerson.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
RelatedPerson.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
RelatedPerson.name.text This element must be supported. This element is included in summaries. 0..1 string Text representation of the full name
RelatedPerson.name.family This element is included in summaries. 0..1 string Family name (often called 'Surname')
RelatedPerson.name.given This element is included in summaries. 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
RelatedPerson.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
RelatedPerson.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
RelatedPerson.name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
RelatedPerson.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the person
RelatedPerson.telecom.id 0..1 string Unique id for inter-element referencing
RelatedPerson.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
RelatedPerson.telecom.system This element must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
RelatedPerson.telecom.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
RelatedPerson.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
RelatedPerson.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
RelatedPerson.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
RelatedPerson.gender This element must be supported. 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 must be supported. 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..* AddressTWSSBase Address where the related person can be contacted or visited
RelatedPerson.photo 0..* Attachment Image of the person
RelatedPerson.period This element must be supported. 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.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:idCardNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:idCardNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:relationNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:relationNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base extensible TWSS-關係人類型值集 📦0.0.1 This IG
RelatedPerson.name.use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​use Base required ContactPointUse 📍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()
twss-age-requires-recorded-date error RelatedPerson.extension:age 填寫年齡時，必須同時填寫年齡記錄日期。 extension.where(url = 'age').exists() implies extension.where(url = 'recordedDate').exists()

 

Other representations of profile: CSV, Excel, Schematron

Notes:

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

此 Profile 使用 FHIR R4 RelatedPerson Resource；伺服端建議（SHOULD）支援以下 FHIR 原生查詢參數： 完整定義請參考 FHIR R4 RelatedPerson 原生查詢參數。

查詢參數 類型 查詢範例
_content string GET [base]/_content=[value]
_filter special GET [base]/_filter=[value]
_id token GET [base]/RelatedPerson/[id]
_lastUpdated date GET [base]/_lastUpdated=[value]
_profile uri GET [base]/_profile=[value]
_query token GET [base]/_query=[value]
_security token GET [base]/_security=[value]
_source uri GET [base]/_source=[value]
_tag token GET [base]/_tag=[value]
_text string GET [base]/_text=[value]
active token GET [base]/active=[value]
address string GET [base]/address=[value]
address-city string GET [base]/address-city=[value]
address-country string GET [base]/address-country=[value]
address-postalcode string GET [base]/address-postalcode=[value]
address-state string GET [base]/address-state=[value]
address-use token GET [base]/address-use=[value]
birthdate date GET [base]/birthdate=[value]
email token GET [base]/email=[value]
gender token GET [base]/gender=[value]
identifier token GET [base]/identifier=[value]
name string GET [base]/name=[value]
patient reference GET [base]/patient=[value]
phone token GET [base]/phone=[value]
phonetic string GET [base]/phonetic=[value]
relationship token GET [base]/relationship=[value]
telecom token GET [base]/telecom=[value]