臺灣社政領域基礎實作指引, 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
| Official URL: https://sfaa.gov.tw/base/StructureDefinition/RelatedPerson-twss-base | Version: 0.0.1 | |||
| Draft as of 2026-08-10 | 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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 關係人國籍。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-nationality Binding: Iso3166-1-2 (extensible) |
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 關係人族群身分。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-ethnic-group Binding: TWSS-族群身分值集 (required) |
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 關係人婚姻狀態。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-marital-status Binding: Marital Status Codes (extensible) |
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為主要照顧者。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-primary-caregiver |
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為監護人。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-guardian |
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為主要聯絡者。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-primary-contact |
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為代理人。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-legal-representative |
![]() ![]() ![]() |
S | 0..1 | Age | 關係人年齡。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-age |
![]() ![]() ![]() |
S | 0..1 | boolean | 關係人身分識別碼不明註記。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-identifier-unknown |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 0..* | Identifier | A human identifier for this person Slice: Unordered, Open by value:type.coding.system, value:type.coding.code |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
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. |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | 關係人身分證字號。 |
![]() ![]() ![]() ![]() |
?!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 |
![]() ![]() ![]() ![]() |
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. |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | 關係人編號;識別碼型別使用 HL7 v2-0203 的 RI(Resource identifier)。 |
![]() ![]() ![]() ![]() |
?!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 |
![]() ![]() ![]() ![]() |
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. |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept Required Pattern: 關係人編號 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() |
?!SΣ | 0..1 | boolean | Whether this related person's record is in active use |
![]() ![]() |
SΣ | 1..1 | Reference(個案資料-Patient TWSS Base) | The patient this person is related to |
![]() ![]() |
SΣ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): 病人與相關人士之間關係的類型。 |
![]() ![]() |
SΣ | 0..* | HumanName | A name associated with the person |
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
![]() ![]() ![]() |
SΣ | 0..1 | string | Text representation of the full name |
![]() ![]() |
SΣ | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
![]() ![]() |
SΣ | 0..1 | date | The date on which the related person was born |
![]() ![]() |
SΣ | 0..* | AddressTWSSBase | Address where the related person can be contacted or visited |
![]() ![]() |
S | 0..1 | Period | Period of time that this relationship is considered valid |
Documentation for this format | ||||
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from RelatedPerson
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 關係人國籍。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-nationality Binding: Iso3166-1-2 (extensible) |
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 關係人族群身分。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-ethnic-group Binding: TWSS-族群身分值集 (required) |
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 關係人婚姻狀態。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-marital-status Binding: Marital Status Codes (extensible) |
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為主要照顧者。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-primary-caregiver |
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為監護人。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-guardian |
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為主要聯絡者。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-primary-contact |
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為代理人。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-legal-representative |
![]() ![]() ![]() |
S | 0..1 | Age | 關係人年齡。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-age |
![]() ![]() ![]() |
S | 0..1 | boolean | 關係人身分識別碼不明註記。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-identifier-unknown |
![]() ![]() |
S | 0..* | Identifier | A human identifier for this person Slice: Unordered, Open by value:type.coding.system, value:type.coding.code |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The value that is unique |
![]() ![]() ![]() |
S | 0..1 | Identifier | 關係人身分證字號。 |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: NNxxx | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() |
S | 0..1 | Identifier | 關係人編號;識別碼型別使用 HL7 v2-0203 的 RI(Resource identifier)。 |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: usual | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: RI | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept Required Pattern: 關係人編號 | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() |
S | 0..1 | boolean | Whether this related person's record is in active use |
![]() ![]() |
S | 1..1 | Reference(個案資料-Patient TWSS Base) | The patient this person is related to |
![]() ![]() |
S | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): 病人與相關人士之間關係的類型。 |
![]() ![]() |
S | 0..* | HumanName | A name associated with the person |
![]() ![]() ![]() |
S | 0..1 | string | Text representation of the full name |
![]() ![]() |
S | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() |
S | 0..1 | code | phone | fax | email | pager | url | sms | other |
![]() ![]() ![]() |
S | 0..1 | string | The actual contact point details |
![]() ![]() |
S | 0..1 | code | male | female | other | unknown |
![]() ![]() |
S | 0..1 | date | The date on which the related person was born |
![]() ![]() |
S | 0..* | AddressTWSSBase | Address where the related person can be contacted or visited |
![]() ![]() |
S | 0..1 | Period | Period of time that this relationship is considered valid |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.relationship | Base | preferred | Patient relationship type | 📦4.0.1 | FHIR Std. |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 關係人國籍。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-nationality Binding: Iso3166-1-2 (extensible) | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 關係人族群身分。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-ethnic-group Binding: TWSS-族群身分值集 (required) | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 關係人婚姻狀態。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-marital-status Binding: Marital Status Codes (extensible) | ||||
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為主要照顧者。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-primary-caregiver | ||||
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為監護人。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-guardian | ||||
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為主要聯絡者。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-primary-contact | ||||
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為代理人。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-legal-representative | ||||
![]() ![]() ![]() |
S | 0..1 | Age | 關係人年齡。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-age | ||||
![]() ![]() ![]() |
S | 0..1 | boolean | 關係人身分識別碼不明註記。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-identifier-unknown | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 0..* | Identifier | A human identifier for this person Slice: Unordered, Open by value:type.coding.system, value:type.coding.code | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | 關係人身分證字號。 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!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 | ||||
![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: NNxxx | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | 關係人編號;識別碼型別使用 HL7 v2-0203 的 RI(Resource identifier)。 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!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 | ||||
![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: RI | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept Required Pattern: 關係人編號 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!SΣ | 0..1 | boolean | Whether this related person's record is in active use | ||||
![]() ![]() |
SΣ | 1..1 | Reference(個案資料-Patient TWSS Base) | The patient this person is related to | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): 病人與相關人士之間關係的類型。 | ||||
![]() ![]() |
SΣ | 0..* | HumanName | A name associated with the person | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() |
SΣ | 0..* | ContactPoint | A contact detail for the person | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() |
SΣ | 0..1 | date | The date on which the related person was born | ||||
![]() ![]() |
SΣ | 0..* | AddressTWSSBase | Address where the related person can be contacted or visited | ||||
![]() ![]() |
0..* | Attachment | Image of the person | |||||
![]() ![]() |
S | 0..1 | Period | Period of time that this relationship is considered valid | ||||
![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
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.
| |||||
![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
Documentation for this format | ||||||||
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from RelatedPerson
Summary
Mandatory: 0 element(6 nested mandatory elements)
Must-Support: 28 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 關係人國籍。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-nationality Binding: Iso3166-1-2 (extensible) |
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 關係人族群身分。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-ethnic-group Binding: TWSS-族群身分值集 (required) |
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 關係人婚姻狀態。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-marital-status Binding: Marital Status Codes (extensible) |
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為主要照顧者。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-primary-caregiver |
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為監護人。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-guardian |
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為主要聯絡者。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-primary-contact |
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為代理人。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-legal-representative |
![]() ![]() ![]() |
S | 0..1 | Age | 關係人年齡。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-age |
![]() ![]() ![]() |
S | 0..1 | boolean | 關係人身分識別碼不明註記。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-identifier-unknown |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 0..* | Identifier | A human identifier for this person Slice: Unordered, Open by value:type.coding.system, value:type.coding.code |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
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. |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | 關係人身分證字號。 |
![]() ![]() ![]() ![]() |
?!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 |
![]() ![]() ![]() ![]() |
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. |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | 關係人編號;識別碼型別使用 HL7 v2-0203 的 RI(Resource identifier)。 |
![]() ![]() ![]() ![]() |
?!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 |
![]() ![]() ![]() ![]() |
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. |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept Required Pattern: 關係人編號 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() |
?!SΣ | 0..1 | boolean | Whether this related person's record is in active use |
![]() ![]() |
SΣ | 1..1 | Reference(個案資料-Patient TWSS Base) | The patient this person is related to |
![]() ![]() |
SΣ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): 病人與相關人士之間關係的類型。 |
![]() ![]() |
SΣ | 0..* | HumanName | A name associated with the person |
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
![]() ![]() ![]() |
SΣ | 0..1 | string | Text representation of the full name |
![]() ![]() |
SΣ | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
![]() ![]() |
SΣ | 0..1 | date | The date on which the related person was born |
![]() ![]() |
SΣ | 0..* | AddressTWSSBase | Address where the related person can be contacted or visited |
![]() ![]() |
S | 0..1 | Period | Period of time that this relationship is considered valid |
Documentation for this format | ||||
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from RelatedPerson
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 關係人國籍。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-nationality Binding: Iso3166-1-2 (extensible) |
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 關係人族群身分。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-ethnic-group Binding: TWSS-族群身分值集 (required) |
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 關係人婚姻狀態。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-marital-status Binding: Marital Status Codes (extensible) |
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為主要照顧者。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-primary-caregiver |
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為監護人。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-guardian |
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為主要聯絡者。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-primary-contact |
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為代理人。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-legal-representative |
![]() ![]() ![]() |
S | 0..1 | Age | 關係人年齡。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-age |
![]() ![]() ![]() |
S | 0..1 | boolean | 關係人身分識別碼不明註記。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-identifier-unknown |
![]() ![]() |
S | 0..* | Identifier | A human identifier for this person Slice: Unordered, Open by value:type.coding.system, value:type.coding.code |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The value that is unique |
![]() ![]() ![]() |
S | 0..1 | Identifier | 關係人身分證字號。 |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: NNxxx | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() |
S | 0..1 | Identifier | 關係人編號;識別碼型別使用 HL7 v2-0203 的 RI(Resource identifier)。 |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: usual | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: RI | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept Required Pattern: 關係人編號 | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() |
S | 0..1 | boolean | Whether this related person's record is in active use |
![]() ![]() |
S | 1..1 | Reference(個案資料-Patient TWSS Base) | The patient this person is related to |
![]() ![]() |
S | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): 病人與相關人士之間關係的類型。 |
![]() ![]() |
S | 0..* | HumanName | A name associated with the person |
![]() ![]() ![]() |
S | 0..1 | string | Text representation of the full name |
![]() ![]() |
S | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() |
S | 0..1 | code | phone | fax | email | pager | url | sms | other |
![]() ![]() ![]() |
S | 0..1 | string | The actual contact point details |
![]() ![]() |
S | 0..1 | code | male | female | other | unknown |
![]() ![]() |
S | 0..1 | date | The date on which the related person was born |
![]() ![]() |
S | 0..* | AddressTWSSBase | Address where the related person can be contacted or visited |
![]() ![]() |
S | 0..1 | Period | Period of time that this relationship is considered valid |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.relationship | Base | preferred | Patient relationship type | 📦4.0.1 | FHIR Std. |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 關係人國籍。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-nationality Binding: Iso3166-1-2 (extensible) | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 關係人族群身分。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-ethnic-group Binding: TWSS-族群身分值集 (required) | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConceptTW | 關係人婚姻狀態。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-marital-status Binding: Marital Status Codes (extensible) | ||||
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為主要照顧者。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-primary-caregiver | ||||
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為監護人。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-guardian | ||||
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為主要聯絡者。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-primary-contact | ||||
![]() ![]() ![]() |
S | 0..1 | boolean | 是否為代理人。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-is-legal-representative | ||||
![]() ![]() ![]() |
S | 0..1 | Age | 關係人年齡。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-age | ||||
![]() ![]() ![]() |
S | 0..1 | boolean | 關係人身分識別碼不明註記。 URL: https://sfaa.gov.tw/base/StructureDefinition/twss-related-person-identifier-unknown | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 0..* | Identifier | A human identifier for this person Slice: Unordered, Open by value:type.coding.system, value:type.coding.code | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | 關係人身分證字號。 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!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 | ||||
![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: NNxxx | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | 關係人編號;識別碼型別使用 HL7 v2-0203 的 RI(Resource identifier)。 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!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 | ||||
![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: RI | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept Required Pattern: 關係人編號 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!SΣ | 0..1 | boolean | Whether this related person's record is in active use | ||||
![]() ![]() |
SΣ | 1..1 | Reference(個案資料-Patient TWSS Base) | The patient this person is related to | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): 病人與相關人士之間關係的類型。 | ||||
![]() ![]() |
SΣ | 0..* | HumanName | A name associated with the person | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() |
SΣ | 0..* | ContactPoint | A contact detail for the person | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() |
SΣ | 0..1 | date | The date on which the related person was born | ||||
![]() ![]() |
SΣ | 0..* | AddressTWSSBase | Address where the related person can be contacted or visited | ||||
![]() ![]() |
0..* | Attachment | Image of the person | |||||
![]() ![]() |
S | 0..1 | Period | Period of time that this relationship is considered valid | ||||
![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
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.
| |||||
![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
Documentation for this format | ||||||||
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from RelatedPerson
Summary
Mandatory: 0 element(6 nested mandatory elements)
Must-Support: 28 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
建議(SHOULD) 支援透過查詢參數 _id 查詢所有 RelatedPerson:
(如何透過 token 查詢)
GET [base]/RelatedPerson?_id=[id]
GET [base]/RelatedPerson/[id]
例子:
(1) GET [base]/RelatedPerson?_id=related-min
(2) GET [base]/RelatedPerson/related-min
建議(SHOULD) 支援透過查詢參數 patient 查詢所有 RelatedPerson:
(如何透過 reference 查詢)
GET [base]/RelatedPerson?patient={Type/}[id]
例子:
(1) GET [base]/RelatedPerson?patient=Patient/pat-min
(2) GET [base]/RelatedPerson?patient=pat-min
建議(SHOULD) 支援透過查詢參數 identifier 查詢所有 RelatedPerson:
(如何透過 token 查詢)
GET [base]/RelatedPerson?identifier=[system]|[code]
建議(SHOULD) 支援透過查詢參數 name 查詢所有 RelatedPerson:
(如何透過 string 查詢)
GET [base]/RelatedPerson?name=[string]