臺灣核心實作指引(TW Core IG)
0.3.2 - Ci-Build Trial Use

臺灣核心實作指引(TW Core IG), published by 衛生福利部. This guide is not an authorized publication; it is the continuous build for version 0.3.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/cctwFHIRterm/MOHW_TWCoreIG_Build/ and changes regularly. See the Directory of published versions

Resource Profile: TW Core RelatedPerson

Official URL: https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/RelatedPerson-twcore Version: 0.3.2
Active as of 2025-02-04 Computable Name: TWCoreRelatedPerson

此臺灣核心-相關人士(TW Core RelatedPerson) Profile說明本IG如何進一步定義FHIR的RelatedPerson Resource以呈現相關人士資料。

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... active ?!SΣ 1..1 boolean Whether this related person's record is in active use
ele-1: All FHIR elements must have a @value or children
... relationship SΣC 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): 病人與相關人士之間關係的類型。


ele-1: All FHIR elements must have a @value or children
... name SΣC 0..* HumanName A name associated with the person
ele-1: All FHIR elements must have a @value or children
... telecom SΣ 0..* ContactPoint A contact detail for the person
ele-1: All FHIR elements must have a @value or children
... address SΣ 0..* Address Address where the related person can be contacted or visited
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.relationshippreferredPatientRelationshipType
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron

Notes:

以下概述了此Profile所需的RESTful FHIR互動功能。有關TW Core IG支援的RESTful互動功能的完整清單,請參閱TW Core Server能力聲明

必須支援以下查詢參數:

  1. 必須(SHALL) 支援透過查詢參數 _idid 查詢所有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

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

  1. 建議應該(SHOULD) 支援透過查詢參數 patient 查詢所有RelatedPerson:
    (如何透過reference查詢)
    GET [base]/RelatedPerson?patient={Type/}[id]

    例子:
    (1) GET [base]/RelatedPerson?patient=Patient/pat-example

  2. 建議應該(SHOULD) 支援透過查詢參數 patientname 查詢所有RelatedPerson:
    (如何透過reference查詢)
    (如何透過string查詢)
    GET [base]/RelatedPerson?patient={Type/}[id]&name=[string]

    例子:
    (1) GET [base]/RelatedPerson?patient=Patient/pat-example&name=李立偉