臺灣核心實作指引(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 Provenance

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

此臺灣核心-出處(TW Core Provenance) Profile說明本IG如何進一步定義FHIR的Provenance Resource以呈現出處資料。

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..* Provenance Who, What, When for a set of resources
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
... target SΣ 1..* Reference(Resource) Target Reference(s) (usually version specific)
ele-1: All FHIR elements must have a @value or children
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children
... location 0..1 Reference(TW Core Location) Where the activity occurred, if relevant
ele-1: All FHIR elements must have a @value or children
... Slices for agent SC 1..* BackboneElement Actor involved
Slice: Unordered, Open by pattern:type
ele-1: All FHIR elements must have a @value or children
provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
.... agent:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type SΣ 0..1 CodeableConcept How the agent participated
Binding: HL7 Provenance participant type + 臺灣衛福部資訊處Provenance參與類型 (extensible)
ele-1: All FHIR elements must have a @value or children
..... who SΣ 1..1 Reference(TW Core Organization) Who participated
ele-1: All FHIR elements must have a @value or children
..... onBehalfOf S 0..1 Reference(TW Core Organization) Who the agent is representing
ele-1: All FHIR elements must have a @value or children
.... agent:ProvenanceAuthor S 0..* BackboneElement Actor involved
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type Σ 1..1 CodeableConceptTW How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 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/provenance-participant-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: author
..... who SΣ 1..1 Reference(TW Core Organization | TW Core Practitioner | TW Core Patient | TW Core PractitionerRole | TW Core RelatedPerson | Device) Who participated
ele-1: All FHIR elements must have a @value or children
..... onBehalfOf S 0..1 Reference(TW Core Organization) Who the agent is representing
ele-1: All FHIR elements must have a @value or children
.... agent:ProvenanceTransmitter S 0..* BackboneElement Actor involved
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type Σ 1..1 CodeableConceptTW How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/provenance-participant-type-tw
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: transmitter
..... who SΣ 1..1 Reference(TW Core Organization | TW Core Practitioner | TW Core Patient | TW Core PractitionerRole | TW Core RelatedPerson | Device) Who participated
ele-1: All FHIR elements must have a @value or children
..... onBehalfOf S 0..1 Reference(TW Core Organization) Who the agent is representing
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Provenance.agent.typeextensibleTWProvenancePaticipantTypeHL7
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/provenance-participant-type-hl7-tw
from this IG
Provenance.agent:ProvenanceAuthor.typeextensiblePattern: author
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent:ProvenanceTransmitter.typeextensiblePattern: transmitter
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProvenanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProvenanceIf 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-4errorProvenanceIf 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-5errorProvenanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProvenanceA 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()
provenance-1errorProvenance.agentonBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
: who.exists((resolve() is Practitioner) or (resolve() is Device)) implies onBehalfOf.exists()

 

Other representations of profile: CSV, Excel, Schematron

Notes:

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

TW Core Provenance應支援以下TW Core Profile resource types:

  • AllergyIntolerance
  • CarePlan
  • CareTeam
  • Condition
  • Coverage
  • Device
  • DiagnosticReport
  • DocumentReference
  • Encounter
  • Goal
  • Immunization
  • MedicationDispense
  • MedicationRequest
  • Observation
  • Patient
  • Procedure
  • QuestionnaireResponse
  • RelatedPerson
  • ServiceRequest

必須支援以下查詢參數:

  1. 必須(SHALL) 支援透過查詢參數 patient_revinclude 查詢所有上面列出的TW Core Profile resource types及這些Resource的Provenance紀錄:
    (如何透過reference查詢)
    GET [base]/[Resource]?patient=[id]&_revinclude=Provenance:target

    例子:
    (1) GET [base]/AllergyIntolerance?patient=Patient/pat-example&_revinclude=Provenance:target

  2. 必須(SHALL) 支援透過查詢參數 _id_revinclude 查詢所有上面列出的TW Core Profile resource types及這些Resource的Provenance紀錄:
    (如何透過token查詢)
    GET [base]/[Resource]?_id=[id]&_revinclude=Provenance:target

    例子:
    (1) GET [base]/AllergyIntolerance?_id=all-cat-example&_revinclude=Provenance:target