臺灣社政領域基礎實作指引
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-09-03 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: Filtersdoco
.. RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality S 0..1 CodeableConceptTW 關係人國籍。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-nationality
.... extension:ethnicGroup S 0..* CodeableConceptTW 關係人族群身分。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-ethnic-group
Binding: TWSS-族群身分值集 (required)
.... extension:maritalStatus S 0..1 CodeableConceptTW 關係人婚姻狀態。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-marital-status
Binding: TWSS-婚姻狀態值集 (extensible)
.... extension:religion S 0..1 CodeableConceptTW 關係人宗教信仰。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-religion
Binding: TWSS-宗教信仰值集 (required)
.... extension:age SC 0..1 (Complex) 關係人年齡及年齡記錄日期；填寫年齡時必須同時填寫記錄日期。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-age
Constraints: twss-age-requires-recorded-date
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:All Slices Content/Rules for all slices
..... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 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.
..... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 0..1 string The value that is unique
Example General: 123456
.... identifier:idCardNumber SΣ 0..1 Identifier 關係人身分證字號。
..... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... type SΣ 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.
..... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:relationNumber SΣ 1..1 Identifier 關係人編號；識別碼型別使用 HL7 v2-0203 的 RI（Resource identifier）。
..... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: usual
..... type SΣ 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.
..... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
... active ?!SΣ 0..1 boolean Whether this related person's record is in active use
... patient SΣ 1..1 Reference(個案資料-Patient TWSS Base) The patient this person is related to
... relationship SΣ 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): 個案與相關人士之間關係的類型。
... name SΣ 0..* HumanName A name associated with the person
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 0..1 string Text representation of the full name
... telecom SΣ 0..* ContactPoint A contact detail for the person
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 0..1 date The date on which the related person was born
... address SΣ 0..* AddressTWSSBase Address where the related person can be contacted or visited
... period S 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 preferred Patient relationship type 📦4.0.1 FHIR Std.
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: Filtersdoco
.. RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality S 0..1 CodeableConceptTW 關係人國籍。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-nationality
.... extension:ethnicGroup S 0..* CodeableConceptTW 關係人族群身分。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-ethnic-group
Binding: TWSS-族群身分值集 (required)
.... extension:maritalStatus S 0..1 CodeableConceptTW 關係人婚姻狀態。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-marital-status
Binding: TWSS-婚姻狀態值集 (extensible)
.... extension:religion S 0..1 CodeableConceptTW 關係人宗教信仰。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-religion
Binding: TWSS-宗教信仰值集 (required)
.... extension:age S 0..1 (Complex) 關係人年齡及年齡記錄日期；填寫年齡時必須同時填寫記錄日期。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-age
... Slices for identifier S 1..* Identifier A human identifier for this person
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code
.... identifier:All Slices Content/Rules for all slices
..... use S 0..1 code usual | official | temp | secondary | old (If known)
..... type S 0..1 CodeableConcept Description of identifier
..... system S 0..1 uri The namespace for the identifier value
..... value S 0..1 string The value that is unique
.... identifier:idCardNumber S 0..1 Identifier 關係人身分證字號。
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... type
...... coding
....... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: NNxxx
..... value 1..1 string The value that is unique
.... identifier:relationNumber S 1..1 Identifier 關係人編號；識別碼型別使用 HL7 v2-0203 的 RI（Resource identifier）。
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: usual
..... type
...... coding
....... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: RI
..... value 1..1 string The value that is unique
... active S 0..1 boolean Whether this related person's record is in active use
... relationship S 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): 個案與相關人士之間關係的類型。
... name S 0..* HumanName A name associated with the person
.... text S 0..1 string Text representation of the full name
... telecom S 0..* ContactPoint A contact detail for the person
.... system S 0..1 code phone | fax | email | pager | url | sms | other
.... value S 0..1 string The actual contact point details
... gender S 0..1 code male | female | other | unknown
... birthDate S 0..1 date The date on which the related person was born
... address S 0..* AddressTWSSBase Address where the related person can be contacted or visited
... period S 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 preferred Patient relationship type 📦4.0.1 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality S 0..1 CodeableConceptTW 關係人國籍。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-nationality
.... extension:ethnicGroup S 0..* CodeableConceptTW 關係人族群身分。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-ethnic-group
Binding: TWSS-族群身分值集 (required)
.... extension:maritalStatus S 0..1 CodeableConceptTW 關係人婚姻狀態。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-marital-status
Binding: TWSS-婚姻狀態值集 (extensible)
.... extension:religion S 0..1 CodeableConceptTW 關係人宗教信仰。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-religion
Binding: TWSS-宗教信仰值集 (required)
.... extension:age SC 0..1 (Complex) 關係人年齡及年齡記錄日期；填寫年齡時必須同時填寫記錄日期。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-age
Constraints: twss-age-requires-recorded-date
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier A human identifier for this person
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 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.
..... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:idCardNumber SΣ 0..1 Identifier 關係人身分證字號。
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... type SΣ 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: NNxxx
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:relationNumber SΣ 1..1 Identifier 關係人編號；識別碼型別使用 HL7 v2-0203 的 RI（Resource identifier）。
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: usual
..... type SΣ 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: RI
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!SΣ 0..1 boolean Whether this related person's record is in active use
... patient SΣ 1..1 Reference(個案資料-Patient TWSS Base) The patient this person is related to
... relationship SΣ 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): 個案與相關人士之間關係的類型。
... name SΣ 0..* HumanName A name associated with the person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 0..1 string Text representation of the full name
.... family Σ 0..1 string Family name (often called 'Surname')
.... given Σ 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
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... telecom SΣ 0..* ContactPoint A contact detail for the person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 0..1 date The date on which the related person was born
... address SΣ 0..* AddressTWSSBase Address where the related person can be contacted or visited
... photo 0..* Attachment Image of the person
... period S 0..1 Period Period of time that this relationship is considered valid
... communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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
.... 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 preferred Patient relationship type 📦4.0.1 FHIR Std.
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: Filtersdoco
.. RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality S 0..1 CodeableConceptTW 關係人國籍。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-nationality
.... extension:ethnicGroup S 0..* CodeableConceptTW 關係人族群身分。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-ethnic-group
Binding: TWSS-族群身分值集 (required)
.... extension:maritalStatus S 0..1 CodeableConceptTW 關係人婚姻狀態。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-marital-status
Binding: TWSS-婚姻狀態值集 (extensible)
.... extension:religion S 0..1 CodeableConceptTW 關係人宗教信仰。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-religion
Binding: TWSS-宗教信仰值集 (required)
.... extension:age SC 0..1 (Complex) 關係人年齡及年齡記錄日期；填寫年齡時必須同時填寫記錄日期。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-age
Constraints: twss-age-requires-recorded-date
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:All Slices Content/Rules for all slices
..... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 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.
..... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 0..1 string The value that is unique
Example General: 123456
.... identifier:idCardNumber SΣ 0..1 Identifier 關係人身分證字號。
..... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... type SΣ 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.
..... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:relationNumber SΣ 1..1 Identifier 關係人編號；識別碼型別使用 HL7 v2-0203 的 RI（Resource identifier）。
..... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: usual
..... type SΣ 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.
..... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
... active ?!SΣ 0..1 boolean Whether this related person's record is in active use
... patient SΣ 1..1 Reference(個案資料-Patient TWSS Base) The patient this person is related to
... relationship SΣ 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): 個案與相關人士之間關係的類型。
... name SΣ 0..* HumanName A name associated with the person
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 0..1 string Text representation of the full name
... telecom SΣ 0..* ContactPoint A contact detail for the person
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 0..1 date The date on which the related person was born
... address SΣ 0..* AddressTWSSBase Address where the related person can be contacted or visited
... period S 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 preferred Patient relationship type 📦4.0.1 FHIR Std.
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: Filtersdoco
.. RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality S 0..1 CodeableConceptTW 關係人國籍。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-nationality
.... extension:ethnicGroup S 0..* CodeableConceptTW 關係人族群身分。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-ethnic-group
Binding: TWSS-族群身分值集 (required)
.... extension:maritalStatus S 0..1 CodeableConceptTW 關係人婚姻狀態。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-marital-status
Binding: TWSS-婚姻狀態值集 (extensible)
.... extension:religion S 0..1 CodeableConceptTW 關係人宗教信仰。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-religion
Binding: TWSS-宗教信仰值集 (required)
.... extension:age S 0..1 (Complex) 關係人年齡及年齡記錄日期；填寫年齡時必須同時填寫記錄日期。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-age
... Slices for identifier S 1..* Identifier A human identifier for this person
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code
.... identifier:All Slices Content/Rules for all slices
..... use S 0..1 code usual | official | temp | secondary | old (If known)
..... type S 0..1 CodeableConcept Description of identifier
..... system S 0..1 uri The namespace for the identifier value
..... value S 0..1 string The value that is unique
.... identifier:idCardNumber S 0..1 Identifier 關係人身分證字號。
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... type
...... coding
....... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: NNxxx
..... value 1..1 string The value that is unique
.... identifier:relationNumber S 1..1 Identifier 關係人編號；識別碼型別使用 HL7 v2-0203 的 RI（Resource identifier）。
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: usual
..... type
...... coding
....... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: RI
..... value 1..1 string The value that is unique
... active S 0..1 boolean Whether this related person's record is in active use
... relationship S 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): 個案與相關人士之間關係的類型。
... name S 0..* HumanName A name associated with the person
.... text S 0..1 string Text representation of the full name
... telecom S 0..* ContactPoint A contact detail for the person
.... system S 0..1 code phone | fax | email | pager | url | sms | other
.... value S 0..1 string The actual contact point details
... gender S 0..1 code male | female | other | unknown
... birthDate S 0..1 date The date on which the related person was born
... address S 0..* AddressTWSSBase Address where the related person can be contacted or visited
... period S 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 preferred Patient relationship type 📦4.0.1 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality S 0..1 CodeableConceptTW 關係人國籍。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-nationality
.... extension:ethnicGroup S 0..* CodeableConceptTW 關係人族群身分。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-ethnic-group
Binding: TWSS-族群身分值集 (required)
.... extension:maritalStatus S 0..1 CodeableConceptTW 關係人婚姻狀態。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-marital-status
Binding: TWSS-婚姻狀態值集 (extensible)
.... extension:religion S 0..1 CodeableConceptTW 關係人宗教信仰。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-religion
Binding: TWSS-宗教信仰值集 (required)
.... extension:age SC 0..1 (Complex) 關係人年齡及年齡記錄日期；填寫年齡時必須同時填寫記錄日期。
URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-age
Constraints: twss-age-requires-recorded-date
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier A human identifier for this person
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 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.
..... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:idCardNumber SΣ 0..1 Identifier 關係人身分證字號。
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... type SΣ 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: NNxxx
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:relationNumber SΣ 1..1 Identifier 關係人編號；識別碼型別使用 HL7 v2-0203 的 RI（Resource identifier）。
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: usual
..... type SΣ 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: RI
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!SΣ 0..1 boolean Whether this related person's record is in active use
... patient SΣ 1..1 Reference(個案資料-Patient TWSS Base) The patient this person is related to
... relationship SΣ 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): 個案與相關人士之間關係的類型。
... name SΣ 0..* HumanName A name associated with the person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 0..1 string Text representation of the full name
.... family Σ 0..1 string Family name (often called 'Surname')
.... given Σ 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
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... telecom SΣ 0..* ContactPoint A contact detail for the person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 0..1 date The date on which the related person was born
... address SΣ 0..* AddressTWSSBase Address where the related person can be contacted or visited
... photo 0..* Attachment Image of the person
... period S 0..1 Period Period of time that this relationship is considered valid
... communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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
.... 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 preferred Patient relationship type 📦4.0.1 FHIR Std.
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]