傳染病通報系統實作指引
0.1.0 - ci-build
傳染病通報系統實作指引
0.1.0 - ci-build
傳染病通報系統實作指引, published by 衛福部疾病管制署. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/fhir-nidrs/nidrs/ and changes regularly. See the Directory of published versions
| Official URL: https://cdc.gov.tw/nidrs/StructureDefinition/RelatedPerson-NIDRS | Version: 0.1.0 | |||
| Active as of 2026-10-08 | Computable Name: RelatedPersonNIDRS | |||
此個案生母資料-RelatedPerson NIDRS Profile說明本IG如何進一步定義臺灣核心-相關人士(TW Core RelatedPerson) Profile以呈現個案生母資料
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:  |
|---|---|---|---|---|
  RelatedPerson |
0..* | TWCoreRelatedPerson | 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 | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
  Slices for identifier |
0..1 | Identifier | 生母身份證統一編號/外來人口之居留證統一證號 Slice: Unordered, Closed by value:type.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   identifier:idCardNumber |
0..1 | Identifier | 身份證統一編號 | |
  use |
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 |
1..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. | |
  coding |
1..1 | Coding | Code defined by a terminology system | |
 system |
0..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 | |
| system |
0..1 | uri | The namespace for the identifier value Required Pattern: http://www.moi.gov.tw | |
 value |
1..1 | string | 生母身份證統一編號 Example General: 123456 | |
 identifier:residentNumber |
0..1 | Identifier | 居留證統一證號 | |
| use |
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 |
1..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. | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
0..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: PRC | |
| system |
0..1 | uri | The namespace for the identifier value Required Pattern: http://www.immigration.gov.tw | |
| value |
1..1 | string | 生母居留證統一證號 Example General: 123456 | |
| active |
1..1 | boolean | Whether this related person's record is in active use | |
 patient |
1..1 | Reference(個案資料-Patient NIDRS) | The patient this person is related to | |
| relationship |
C | 0..1 | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): 病人與相關人士之間關係的類型。 Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| text |
0..1 | string | Plain text representation of the concept | |
| coding |
0..1 | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
 system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: MTH | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| name |
C | 0..1 | HumanName | 生母姓名 |
| use |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | |
| text |
1..1 | string | 生母姓名 | |
| telecom |
0..* | ContactPoint | A contact detail for the person | |
| address |
0..* | Address | Address where the related person can be contacted or visited | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| 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:residentNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:residentNumber.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. |
| 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 TWCoreRelatedPerson
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| RelatedPerson |
TWCoreRelatedPerson | |||
| Slices for identifier |
0..1 | Identifier | 生母身份證統一編號/外來人口之居留證統一證號 Slice: Unordered, Closed by value:type.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:idCardNumber |
0..1 | Identifier | 身份證統一編號 | |
 use |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
| type |
1..1 | CodeableConcept | Description of identifier | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
0..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 | |
| system |
0..1 | uri | The namespace for the identifier value Required Pattern: http://www.moi.gov.tw | |
| value |
1..1 | string | 生母身份證統一編號 | |
| identifier:residentNumber |
0..1 | Identifier | 居留證統一證號 | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
| type |
1..1 | CodeableConcept | Description of identifier | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
0..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: PRC | |
| system |
0..1 | uri | The namespace for the identifier value Required Pattern: http://www.immigration.gov.tw | |
| value |
1..1 | string | 生母居留證統一證號 | |
| patient |
1..1 | Reference(個案資料-Patient NIDRS) | The patient this person is related to | |
| relationship |
0..1 | CodeableConcept | The nature of the relationship Required Pattern: At least the following | |
| coding |
0..1 | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: MTH | |
| name |
0..1 | HumanName | 生母姓名 | |
| text |
1..1 | string | 生母姓名 | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson |
0..* | TWCoreRelatedPerson | 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 | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| Slices for identifier |
0..1 | Identifier | 生母身份證統一編號/外來人口之居留證統一證號 Slice: Unordered, Closed by value:type.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| identifier:idCardNumber |
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 |
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 |
1..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 |
1..1 | 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 |
0..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 |
0..1 | uri | The namespace for the identifier value Required Pattern: http://www.moi.gov.tw | |||||
| value |
1..1 | string | 生母身份證統一編號 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:residentNumber |
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 |
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 |
1..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 |
1..1 | 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 |
0..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: PRC | |||||
| 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 |
0..1 | uri | The namespace for the identifier value Required Pattern: http://www.immigration.gov.tw | |||||
| value |
1..1 | string | 生母居留證統一證號 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 |
1..1 | boolean | Whether this related person's record is in active use | |||||
| patient |
1..1 | Reference(個案資料-Patient NIDRS) | The patient this person is related to | |||||
| relationship |
C | 0..1 | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): 病人與相關人士之間關係的類型。 Required Pattern: At least the following | ||||
| 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..1 | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: MTH | |||||
| 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 | |||||
| name |
C | 0..1 | HumanName | 生母姓名 | ||||
| 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 |
1..1 | string | 生母姓名 | |||||
| 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 |
0..* | ContactPoint | A contact detail for the person | |||||
| gender |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| birthDate |
0..1 | date | The date on which the related person was born | |||||
| address |
0..* | Address | Address where the related person can be contacted or visited | |||||
| photo |
0..* | Attachment | Image of the person | |||||
| period |
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.
| |||||
| preferred |
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:idCardNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:idCardNumber.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:residentNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:residentNumber.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.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 TWCoreRelatedPerson
Summary
Mandatory: 0 element(9 nested mandatory elements)
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| RelatedPerson |
0..* | TWCoreRelatedPerson | 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 | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| Slices for identifier |
0..1 | Identifier | 生母身份證統一編號/外來人口之居留證統一證號 Slice: Unordered, Closed by value:type.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:idCardNumber |
0..1 | Identifier | 身份證統一編號 | |
| use |
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 |
1..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. | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
0..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 | |
| system |
0..1 | uri | The namespace for the identifier value Required Pattern: http://www.moi.gov.tw | |
| value |
1..1 | string | 生母身份證統一編號 Example General: 123456 | |
| identifier:residentNumber |
0..1 | Identifier | 居留證統一證號 | |
| use |
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 |
1..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. | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
0..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: PRC | |
| system |
0..1 | uri | The namespace for the identifier value Required Pattern: http://www.immigration.gov.tw | |
| value |
1..1 | string | 生母居留證統一證號 Example General: 123456 | |
| active |
1..1 | boolean | Whether this related person's record is in active use | |
| patient |
1..1 | Reference(個案資料-Patient NIDRS) | The patient this person is related to | |
| relationship |
C | 0..1 | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): 病人與相關人士之間關係的類型。 Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| text |
0..1 | string | Plain text representation of the concept | |
| coding |
0..1 | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: MTH | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| name |
C | 0..1 | HumanName | 生母姓名 |
| use |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | |
| text |
1..1 | string | 生母姓名 | |
| telecom |
0..* | ContactPoint | A contact detail for the person | |
| address |
0..* | Address | Address where the related person can be contacted or visited | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| 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:residentNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:residentNumber.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. |
| 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 TWCoreRelatedPerson
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| RelatedPerson |
TWCoreRelatedPerson | |||
| Slices for identifier |
0..1 | Identifier | 生母身份證統一編號/外來人口之居留證統一證號 Slice: Unordered, Closed by value:type.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:idCardNumber |
0..1 | Identifier | 身份證統一編號 | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
| type |
1..1 | CodeableConcept | Description of identifier | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
0..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 | |
| system |
0..1 | uri | The namespace for the identifier value Required Pattern: http://www.moi.gov.tw | |
| value |
1..1 | string | 生母身份證統一編號 | |
| identifier:residentNumber |
0..1 | Identifier | 居留證統一證號 | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
| type |
1..1 | CodeableConcept | Description of identifier | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
0..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: PRC | |
| system |
0..1 | uri | The namespace for the identifier value Required Pattern: http://www.immigration.gov.tw | |
| value |
1..1 | string | 生母居留證統一證號 | |
| patient |
1..1 | Reference(個案資料-Patient NIDRS) | The patient this person is related to | |
| relationship |
0..1 | CodeableConcept | The nature of the relationship Required Pattern: At least the following | |
| coding |
0..1 | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: MTH | |
| name |
0..1 | HumanName | 生母姓名 | |
| text |
1..1 | string | 生母姓名 | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson |
0..* | TWCoreRelatedPerson | 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 | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| Slices for identifier |
0..1 | Identifier | 生母身份證統一編號/外來人口之居留證統一證號 Slice: Unordered, Closed by value:type.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| identifier:idCardNumber |
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 |
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 |
1..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 |
1..1 | 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 |
0..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 |
0..1 | uri | The namespace for the identifier value Required Pattern: http://www.moi.gov.tw | |||||
| value |
1..1 | string | 生母身份證統一編號 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:residentNumber |
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 |
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 |
1..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 |
1..1 | 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 |
0..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: PRC | |||||
| 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 |
0..1 | uri | The namespace for the identifier value Required Pattern: http://www.immigration.gov.tw | |||||
| value |
1..1 | string | 生母居留證統一證號 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 |
1..1 | boolean | Whether this related person's record is in active use | |||||
| patient |
1..1 | Reference(個案資料-Patient NIDRS) | The patient this person is related to | |||||
| relationship |
C | 0..1 | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): 病人與相關人士之間關係的類型。 Required Pattern: At least the following | ||||
| 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..1 | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: MTH | |||||
| 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 | |||||
| name |
C | 0..1 | HumanName | 生母姓名 | ||||
| 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 |
1..1 | string | 生母姓名 | |||||
| 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 |
0..* | ContactPoint | A contact detail for the person | |||||
| gender |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| birthDate |
0..1 | date | The date on which the related person was born | |||||
| address |
0..* | Address | Address where the related person can be contacted or visited | |||||
| photo |
0..* | Attachment | Image of the person | |||||
| period |
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.
| |||||
| preferred |
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:idCardNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:idCardNumber.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:residentNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:residentNumber.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.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 TWCoreRelatedPerson
Summary
Mandatory: 0 element(9 nested mandatory elements)
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron