This page is part of the 臺灣核心實作指引(TW Core IG) (v0.3.1: Releases) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/RelatedPerson-twcore | Version: 0.3.1 | |||
Active as of 2024-10-22 | Computable Name: TWCoreRelatedPerson |
此臺灣核心-相關人士(TW Core RelatedPerson) Profile說明本IG如何進一步定義FHIR的RelatedPerson Resource以呈現相關人士資料。
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from RelatedPerson
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RelatedPerson | RelatedPerson | |||
active | S | 1..1 | boolean | Whether this related person's record is in active use |
patient | S | 1..1 | Reference(TW Core Patient) | The patient this person is related to |
relationship | SC | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): 病人與相關人士之間關係的類型。 |
name | SC | 0..* | HumanName | A name associated with the person |
telecom | S | 0..* | ContactPoint | A contact detail for the person |
address | S | 0..* | Address | Address where the related person can be contacted or visited |
Documentation for this format |
Path | Conformance | ValueSet | URI |
RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
active | ?!SΣ | 1..1 | boolean | Whether this related person's record is in active use |
patient | SΣ | 1..1 | Reference(TW Core Patient) | The patient this person is related to |
relationship | SΣC | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): 病人與相關人士之間關係的類型。 |
name | SΣC | 0..* | HumanName | A name associated with the person |
telecom | SΣ | 0..* | ContactPoint | A contact detail for the person |
address | SΣ | 0..* | Address | Address where the related person can be contacted or visited |
Documentation for this format |
Path | Conformance | ValueSet | URI |
RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
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 | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | A human identifier for this person | ||||
active | ?!SΣ | 1..1 | boolean | Whether this related person's record is in active use | ||||
patient | SΣ | 1..1 | Reference(TW Core Patient) | The patient this person is related to | ||||
relationship | SΣC | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): 病人與相關人士之間關係的類型。 | ||||
name | SΣC | 0..* | HumanName | A name associated with the person | ||||
telecom | SΣ | 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 | SΣ | 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 | Conformance | ValueSet | URI | |||
RelatedPerson.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard | ||||
RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
RelatedPerson.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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
Differential View
This structure is derived from RelatedPerson
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RelatedPerson | RelatedPerson | |||
active | S | 1..1 | boolean | Whether this related person's record is in active use |
patient | S | 1..1 | Reference(TW Core Patient) | The patient this person is related to |
relationship | SC | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): 病人與相關人士之間關係的類型。 |
name | SC | 0..* | HumanName | A name associated with the person |
telecom | S | 0..* | ContactPoint | A contact detail for the person |
address | S | 0..* | Address | Address where the related person can be contacted or visited |
Documentation for this format |
Path | Conformance | ValueSet | URI |
RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
active | ?!SΣ | 1..1 | boolean | Whether this related person's record is in active use |
patient | SΣ | 1..1 | Reference(TW Core Patient) | The patient this person is related to |
relationship | SΣC | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): 病人與相關人士之間關係的類型。 |
name | SΣC | 0..* | HumanName | A name associated with the person |
telecom | SΣ | 0..* | ContactPoint | A contact detail for the person |
address | SΣ | 0..* | Address | Address where the related person can be contacted or visited |
Documentation for this format |
Path | Conformance | ValueSet | URI |
RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
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 | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | A human identifier for this person | ||||
active | ?!SΣ | 1..1 | boolean | Whether this related person's record is in active use | ||||
patient | SΣ | 1..1 | Reference(TW Core Patient) | The patient this person is related to | ||||
relationship | SΣC | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): 病人與相關人士之間關係的類型。 | ||||
name | SΣC | 0..* | HumanName | A name associated with the person | ||||
telecom | SΣ | 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 | SΣ | 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 | Conformance | ValueSet | URI | |||
RelatedPerson.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard | ||||
RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
RelatedPerson.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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
Other representations of profile: CSV, Excel, Schematron
以下概述了此Profile所需的RESTful FHIR互動功能。有關TW Core IG支援的RESTful互動功能的完整清單,請參閱TW Core Server能力聲明。
必須(SHALL) 支援透過查詢參數 _id
或 id
查詢所有RelatedPerson:
(如何透過token查詢)
GET [base]/RelatedPerson?_id=[id]
GET [base]/RelatedPerson/[id]
例子:
(1) GET [base]/RelatedPerson?_id=rel-per-example
(2) GET [base]/RelatedPerson/rel-example
建議應該(SHOULD) 支援透過查詢參數 patient
查詢所有RelatedPerson:
(如何透過reference查詢)
GET [base]/RelatedPerson?patient={Type/}[id]
例子:
(1) GET [base]/RelatedPerson?patient=Patient/pat-example
建議應該(SHOULD) 支援透過查詢參數 patient
及 name
查詢所有RelatedPerson:
(如何透過reference查詢)
(如何透過string查詢)
GET [base]/RelatedPerson?patient={Type/}[id]&name=[string]
例子:
(1) GET [base]/RelatedPerson?patient=Patient/pat-example&name=李立偉