臺灣核心實作指引(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
Official URL: https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Media-twcore | Version: 0.3.2 | |||
Active as of 2024-12-23 | Computable Name: TWCoreMedia |
此臺灣核心-多媒體(TW Core Media) Profile說明本IG如何進一步定義FHIR的Media Resource以呈現多媒體的詳細資料。
Media resource 涵蓋了在健康照護中獲取或使用的影像、影片和音檔。這些內容可能直接嵌入或透過直接參照提供。
試用階段注意事項: 國際HL7「醫令和檢驗檢查工作小組」想讓大家知道,需要附加資料類型的檢驗檢查現在應該用 Media resource 來記錄,而不是用Observation。為了讓 Media resource 能更好地和檢驗檢查(Observation)以及工作流事件(event)模式結合,他們對 Media resource 做了幾個重要的調整:
partOf
和issued
資料項目。type
改成了 選填的類別(category
),並將 subtype
資料項目更名為儀器(modality
)。subject
、operator
和basedOn
元素增加了更多參照對象。event extensions
)。Media resource 包括影像、影片和音檔,是醫療過程中不可或缺的一部分。常見的使用情境包括:
這個 Media resource 專門記錄那些以音檔、影片或影像作為結果的檢驗檢查(Observation)。這種格式的資料優先使用此 resource 記錄,是因為它能提供讓我們理解這些資料的重要背景資訊(例如: metadata)。但要注意,有時候在一些舊的系統中,這類的多媒體資料可能會被記錄在 Observation 裡。
Media resource 可以包括用DICOM格式儲存的醫學影像。這些影像也可以透過 ImagingStudy resource 來存取,這個 resource 能直接連結到 WADO-RS 伺服器上的影像。
使用 WADO-RS 框架來呈現這些影像是首選的方法,因為它可能包括了根據 DICOM 標準加上的註釋和顯示參數。
另一方面,當 WADO-RS 服務無法使用時,Media resource 也提供了一個穩定的方式來傳送影像。所以,醫學影像同樣可以在 Media resource 表示,但Media.content.url
應該指向一個可以存取影像的WADO-RS服務。
這個 resource 被醫療不良事件(AdverseEvent)、臨床臆斷(ClinicalImpression)、設備使用聲明(DeviceUseStatement)、診斷報告(DiagnosticReport)、影像檢查(ImagingStudy)、藥品知識(MedicationKnowledge)和檢驗檢查(Observation)等多個其他FHIR resources 參照。
Media resource 包含幾個日期/時間的資料項目:
Media.created[x]
- 是指拍攝或錄製的具體日期(或時間),或者是進行拍攝或錄製的時間段。Media.duration
- 表示多媒體內容的持續時間。如果在錄製過程中有暫停,這個持續時間可能會與實際錄製的時間段Media.createdPeriod
有所不同。Media.content.creation
- 這個時間應該與Media.created[x]
保持一致,但如果音檔有被部分剪輯或編輯,時間上可能會有差異。這個resource允許透過attachment.data
直接嵌入影像或影片。不過,一般推薦的做法是使用attachment.url
指向一個 Binary resource。這樣做的原因是伺服器通常能夠把 Binary resources 儲存在專門設計來存放可能很大的文件的儲庫中,這樣更加合適。
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Media | 0..* | Media | 健康照護中獲取或使用的影像、影片或音檔,實際內容可能置於行內或透過直接參照提供。 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 | |||||
id | Σ | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Media紀錄,通常又稱為邏輯性ID。 | ||||
meta | Σ | 0..1 | Meta | 此Media Resource的metadata ele-1: All FHIR elements must have a @value or children | ||||
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 ele-1: All FHIR elements must have a @value or children | ||||
language | 0..1 | code | 用以表述Media Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
ele-1: All FHIR elements must have a @value or children Example Value: zh-TW | |||||
text | 0..1 | Narrative | Media Resource之內容摘要以供人閱讀 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 | ||||
identifier | Σ | 0..* | Identifier | 影像的識別碼 ele-1: All FHIR elements must have a @value or children | ||||
basedOn | Σ | 0..* | Reference(ServiceRequest | CarePlan) | 導致產生此多媒體的程序 ele-1: All FHIR elements must have a @value or children | ||||
partOf | Σ | 0..* | Reference(Resource) | 參照事件的一部分 ele-1: All FHIR elements must have a @value or children | ||||
status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): 代表事件生命週期階段的代碼;應填入所綁定值集中的其中一個代碼 ele-1: All FHIR elements must have a @value or children | ||||
type | 0..1 | CodeableConceptTW | 將多媒體分類為影像、影片或音檔 Binding: MediaType (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 ele-1: All FHIR elements must have a @value or children | |||||
modality | 0..1 | CodeableConceptTW | 取得影像的設備/過程 Binding: MediaModality (example): 可參考MediaModality代碼表,但此代碼表只是針對這個欄位的一個可能值的示例,不預期也不鼓勵使用者一定要使用此代碼表的代碼。 ele-1: All FHIR elements must have a @value or children | |||||
view | 0..1 | CodeableConceptTW | 影像視圖,從不同的角度拍攝醫學影像,例如:側位(Lateral,從旁邊看)或前後部位(Antero-posterior,從前面或後面看) Binding: MediaCollectionView/Projection (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 ele-1: All FHIR elements must have a @value or children | |||||
subject | SΣ | 0..1 | Reference(TW Core Patient | TW Core Practitioner | TW Core PractitionerRole | Group | Device | TW Core Specimen | TW Core Location) | 多媒體紀錄的對象是誰或什麼? ele-1: All FHIR elements must have a @value or children | ||||
encounter | Σ | 0..1 | Reference(TW Core Encounter) | 與此Media相關的就醫事件(Encounter) ele-1: All FHIR elements must have a @value or children | ||||
created[x] | Σ | 0..1 | Media被收集的時間 ele-1: All FHIR elements must have a @value or children | |||||
createdDateTime | dateTime | |||||||
createdPeriod | Period | |||||||
issued | Σ | 0..1 | instant | 此版本提供的日期/時間 ele-1: All FHIR elements must have a @value or children | ||||
operator | Σ | 0..1 | Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core CareTeam | TW Core Patient | Device | TW Core RelatedPerson) | 產生影像的人 ele-1: All FHIR elements must have a @value or children | ||||
reasonCode | 0..* | CodeableConceptTW | 為什麼會進行這個事件? Binding: ProcedureReasonCodes (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 ele-1: All FHIR elements must have a @value or children | |||||
bodySite | 0..1 | CodeableConceptTW | 接受檢驗檢查的身體部位 Binding: SNOMEDCTBodyStructures (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 ele-1: All FHIR elements must have a @value or children | |||||
deviceName | Σ | 0..1 | string | 設備/製造商的名稱 ele-1: All FHIR elements must have a @value or children | ||||
device | Σ | 0..1 | Reference(Device | DeviceMetric | Device) | 影像、影片、音檔的補捉設備。 ele-1: All FHIR elements must have a @value or children | ||||
height | Σ | 0..1 | positiveInt | 以像素為單位的影像高度(影像/影像) ele-1: All FHIR elements must have a @value or children | ||||
width | Σ | 0..1 | positiveInt | 以像素為單位的影像寬度(影像/影像) ele-1: All FHIR elements must have a @value or children | ||||
frames | Σ | 0..1 | positiveInt | > 1 的影格(影像)。 ele-1: All FHIR elements must have a @value or children | ||||
duration | Σ | 0..1 | decimal | 以秒為單位的長度(音檔/影片)。 ele-1: All FHIR elements must have a @value or children | ||||
content | Σ | 1..1 | Attachment | 實際的多媒體 - 參照或資料。 ele-1: All FHIR elements must have a @value or children | ||||
note | 0..* | Annotation | 對此Media的意見 ele-1: All FHIR elements must have a @value or children | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Media.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Media.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | ||||
Media.type | extensible | MediaTypehttp://hl7.org/fhir/ValueSet/media-type from the FHIR Standard | ||||
Media.modality | example | MediaModalityhttp://hl7.org/fhir/ValueSet/media-modality from the FHIR Standard | ||||
Media.view | extensible | MediaCollectionView/Projectionhttp://hl7.org/fhir/ValueSet/media-view from the FHIR Standard | ||||
Media.reasonCode | extensible | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason from the FHIR Standard | ||||
Media.bodySite | extensible | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Media | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Media | 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 | Media | 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 | Media | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Media | 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 Media
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Media | 0..* | Media | 健康照護中獲取或使用的影像、影片或音檔,實際內容可能置於行內或透過直接參照提供。 | |||||
id | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Media紀錄,通常又稱為邏輯性ID。 | |||||
meta | 0..1 | Meta | 此Media Resource的metadata | |||||
implicitRules | 0..1 | uri | 創建此內容所依據的一組規則 | |||||
language | 0..1 | code | 用以表述Media Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
Example Value: zh-TW | |||||
text | 0..1 | Narrative | Media Resource之內容摘要以供人閱讀 | |||||
identifier | 0..* | Identifier | 影像的識別碼 | |||||
basedOn | 0..* | Reference(ServiceRequest | CarePlan) | 導致產生此多媒體的程序 | |||||
partOf | 0..* | Reference(Resource) | 參照事件的一部分 | |||||
status | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): 代表事件生命週期階段的代碼;應填入所綁定值集中的其中一個代碼 | |||||
type | 0..1 | CodeableConceptTW | 將多媒體分類為影像、影片或音檔 Binding: MediaType (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
modality | 0..1 | CodeableConceptTW | 取得影像的設備/過程 Binding: MediaModality (example): 可參考MediaModality代碼表,但此代碼表只是針對這個欄位的一個可能值的示例,不預期也不鼓勵使用者一定要使用此代碼表的代碼。 | |||||
view | 0..1 | CodeableConceptTW | 影像視圖,從不同的角度拍攝醫學影像,例如:側位(Lateral,從旁邊看)或前後部位(Antero-posterior,從前面或後面看) Binding: MediaCollectionView/Projection (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
subject | S | 0..1 | Reference(TW Core Patient | TW Core Practitioner | TW Core PractitionerRole | Group | Device | TW Core Specimen | TW Core Location) | 多媒體紀錄的對象是誰或什麼? | ||||
encounter | 0..1 | Reference(TW Core Encounter) | 與此Media相關的就醫事件(Encounter) | |||||
created[x] | 0..1 | dateTime, Period | Media被收集的時間 | |||||
issued | 0..1 | instant | 此版本提供的日期/時間 | |||||
operator | 0..1 | Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core CareTeam | TW Core Patient | Device | TW Core RelatedPerson) | 產生影像的人 | |||||
reasonCode | 0..* | CodeableConceptTW | 為什麼會進行這個事件? Binding: ProcedureReasonCodes (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
bodySite | 0..1 | CodeableConceptTW | 接受檢驗檢查的身體部位 Binding: SNOMEDCTBodyStructures (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
deviceName | 0..1 | string | 設備/製造商的名稱 | |||||
device | 0..1 | Reference(Device | DeviceMetric | Device) | 影像、影片、音檔的補捉設備。 | |||||
height | 0..1 | positiveInt | 以像素為單位的影像高度(影像/影像) | |||||
width | 0..1 | positiveInt | 以像素為單位的影像寬度(影像/影像) | |||||
frames | 0..1 | positiveInt | > 1 的影格(影像)。 | |||||
duration | 0..1 | decimal | 以秒為單位的長度(音檔/影片)。 | |||||
content | 1..1 | Attachment | 實際的多媒體 - 參照或資料。 | |||||
note | 0..* | Annotation | 對此Media的意見 | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Media.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Media.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | ||||
Media.type | extensible | MediaTypehttp://hl7.org/fhir/ValueSet/media-type from the FHIR Standard | ||||
Media.modality | example | MediaModalityhttp://hl7.org/fhir/ValueSet/media-modality from the FHIR Standard | ||||
Media.view | extensible | MediaCollectionView/Projectionhttp://hl7.org/fhir/ValueSet/media-view from the FHIR Standard | ||||
Media.reasonCode | extensible | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason from the FHIR Standard | ||||
Media.bodySite | extensible | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Media | 0..* | Media | 健康照護中獲取或使用的影像、影片或音檔,實際內容可能置於行內或透過直接參照提供。 | |||||
id | Σ | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Media紀錄,通常又稱為邏輯性ID。 | ||||
meta | Σ | 0..1 | Meta | 此Media Resource的metadata | ||||
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 | ||||
language | 0..1 | code | 用以表述Media Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
Example Value: zh-TW | |||||
text | 0..1 | Narrative | Media Resource之內容摘要以供人閱讀 | |||||
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 | 影像的識別碼 | ||||
basedOn | Σ | 0..* | Reference(ServiceRequest | CarePlan) | 導致產生此多媒體的程序 | ||||
partOf | Σ | 0..* | Reference(Resource) | 參照事件的一部分 | ||||
status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): 代表事件生命週期階段的代碼;應填入所綁定值集中的其中一個代碼 | ||||
type | 0..1 | CodeableConceptTW | 將多媒體分類為影像、影片或音檔 Binding: MediaType (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
modality | 0..1 | CodeableConceptTW | 取得影像的設備/過程 Binding: MediaModality (example): 可參考MediaModality代碼表,但此代碼表只是針對這個欄位的一個可能值的示例,不預期也不鼓勵使用者一定要使用此代碼表的代碼。 | |||||
view | 0..1 | CodeableConceptTW | 影像視圖,從不同的角度拍攝醫學影像,例如:側位(Lateral,從旁邊看)或前後部位(Antero-posterior,從前面或後面看) Binding: MediaCollectionView/Projection (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
subject | SΣ | 0..1 | Reference(TW Core Patient | TW Core Practitioner | TW Core PractitionerRole | Group | Device | TW Core Specimen | TW Core Location) | 多媒體紀錄的對象是誰或什麼? | ||||
encounter | Σ | 0..1 | Reference(TW Core Encounter) | 與此Media相關的就醫事件(Encounter) | ||||
created[x] | Σ | 0..1 | Media被收集的時間 | |||||
createdDateTime | dateTime | |||||||
createdPeriod | Period | |||||||
issued | Σ | 0..1 | instant | 此版本提供的日期/時間 | ||||
operator | Σ | 0..1 | Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core CareTeam | TW Core Patient | Device | TW Core RelatedPerson) | 產生影像的人 | ||||
reasonCode | 0..* | CodeableConceptTW | 為什麼會進行這個事件? Binding: ProcedureReasonCodes (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
bodySite | 0..1 | CodeableConceptTW | 接受檢驗檢查的身體部位 Binding: SNOMEDCTBodyStructures (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
deviceName | Σ | 0..1 | string | 設備/製造商的名稱 | ||||
device | Σ | 0..1 | Reference(Device | DeviceMetric | Device) | 影像、影片、音檔的補捉設備。 | ||||
height | Σ | 0..1 | positiveInt | 以像素為單位的影像高度(影像/影像) | ||||
width | Σ | 0..1 | positiveInt | 以像素為單位的影像寬度(影像/影像) | ||||
frames | Σ | 0..1 | positiveInt | > 1 的影格(影像)。 | ||||
duration | Σ | 0..1 | decimal | 以秒為單位的長度(音檔/影片)。 | ||||
content | Σ | 1..1 | Attachment | 實際的多媒體 - 參照或資料。 | ||||
note | 0..* | Annotation | 對此Media的意見 | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Media.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Media.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | ||||
Media.type | extensible | MediaTypehttp://hl7.org/fhir/ValueSet/media-type from the FHIR Standard | ||||
Media.modality | example | MediaModalityhttp://hl7.org/fhir/ValueSet/media-modality from the FHIR Standard | ||||
Media.view | extensible | MediaCollectionView/Projectionhttp://hl7.org/fhir/ValueSet/media-view from the FHIR Standard | ||||
Media.reasonCode | extensible | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason from the FHIR Standard | ||||
Media.bodySite | extensible | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Media | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Media | 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 | Media | 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 | Media | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Media | 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 Media
Summary
Must-Support: 1 element
Structures
This structure refers to these other structures:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Media | 0..* | Media | 健康照護中獲取或使用的影像、影片或音檔,實際內容可能置於行內或透過直接參照提供。 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 | |||||
id | Σ | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Media紀錄,通常又稱為邏輯性ID。 | ||||
meta | Σ | 0..1 | Meta | 此Media Resource的metadata ele-1: All FHIR elements must have a @value or children | ||||
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 ele-1: All FHIR elements must have a @value or children | ||||
language | 0..1 | code | 用以表述Media Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
ele-1: All FHIR elements must have a @value or children Example Value: zh-TW | |||||
text | 0..1 | Narrative | Media Resource之內容摘要以供人閱讀 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 | ||||
identifier | Σ | 0..* | Identifier | 影像的識別碼 ele-1: All FHIR elements must have a @value or children | ||||
basedOn | Σ | 0..* | Reference(ServiceRequest | CarePlan) | 導致產生此多媒體的程序 ele-1: All FHIR elements must have a @value or children | ||||
partOf | Σ | 0..* | Reference(Resource) | 參照事件的一部分 ele-1: All FHIR elements must have a @value or children | ||||
status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): 代表事件生命週期階段的代碼;應填入所綁定值集中的其中一個代碼 ele-1: All FHIR elements must have a @value or children | ||||
type | 0..1 | CodeableConceptTW | 將多媒體分類為影像、影片或音檔 Binding: MediaType (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 ele-1: All FHIR elements must have a @value or children | |||||
modality | 0..1 | CodeableConceptTW | 取得影像的設備/過程 Binding: MediaModality (example): 可參考MediaModality代碼表,但此代碼表只是針對這個欄位的一個可能值的示例,不預期也不鼓勵使用者一定要使用此代碼表的代碼。 ele-1: All FHIR elements must have a @value or children | |||||
view | 0..1 | CodeableConceptTW | 影像視圖,從不同的角度拍攝醫學影像,例如:側位(Lateral,從旁邊看)或前後部位(Antero-posterior,從前面或後面看) Binding: MediaCollectionView/Projection (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 ele-1: All FHIR elements must have a @value or children | |||||
subject | SΣ | 0..1 | Reference(TW Core Patient | TW Core Practitioner | TW Core PractitionerRole | Group | Device | TW Core Specimen | TW Core Location) | 多媒體紀錄的對象是誰或什麼? ele-1: All FHIR elements must have a @value or children | ||||
encounter | Σ | 0..1 | Reference(TW Core Encounter) | 與此Media相關的就醫事件(Encounter) ele-1: All FHIR elements must have a @value or children | ||||
created[x] | Σ | 0..1 | Media被收集的時間 ele-1: All FHIR elements must have a @value or children | |||||
createdDateTime | dateTime | |||||||
createdPeriod | Period | |||||||
issued | Σ | 0..1 | instant | 此版本提供的日期/時間 ele-1: All FHIR elements must have a @value or children | ||||
operator | Σ | 0..1 | Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core CareTeam | TW Core Patient | Device | TW Core RelatedPerson) | 產生影像的人 ele-1: All FHIR elements must have a @value or children | ||||
reasonCode | 0..* | CodeableConceptTW | 為什麼會進行這個事件? Binding: ProcedureReasonCodes (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 ele-1: All FHIR elements must have a @value or children | |||||
bodySite | 0..1 | CodeableConceptTW | 接受檢驗檢查的身體部位 Binding: SNOMEDCTBodyStructures (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 ele-1: All FHIR elements must have a @value or children | |||||
deviceName | Σ | 0..1 | string | 設備/製造商的名稱 ele-1: All FHIR elements must have a @value or children | ||||
device | Σ | 0..1 | Reference(Device | DeviceMetric | Device) | 影像、影片、音檔的補捉設備。 ele-1: All FHIR elements must have a @value or children | ||||
height | Σ | 0..1 | positiveInt | 以像素為單位的影像高度(影像/影像) ele-1: All FHIR elements must have a @value or children | ||||
width | Σ | 0..1 | positiveInt | 以像素為單位的影像寬度(影像/影像) ele-1: All FHIR elements must have a @value or children | ||||
frames | Σ | 0..1 | positiveInt | > 1 的影格(影像)。 ele-1: All FHIR elements must have a @value or children | ||||
duration | Σ | 0..1 | decimal | 以秒為單位的長度(音檔/影片)。 ele-1: All FHIR elements must have a @value or children | ||||
content | Σ | 1..1 | Attachment | 實際的多媒體 - 參照或資料。 ele-1: All FHIR elements must have a @value or children | ||||
note | 0..* | Annotation | 對此Media的意見 ele-1: All FHIR elements must have a @value or children | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Media.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Media.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | ||||
Media.type | extensible | MediaTypehttp://hl7.org/fhir/ValueSet/media-type from the FHIR Standard | ||||
Media.modality | example | MediaModalityhttp://hl7.org/fhir/ValueSet/media-modality from the FHIR Standard | ||||
Media.view | extensible | MediaCollectionView/Projectionhttp://hl7.org/fhir/ValueSet/media-view from the FHIR Standard | ||||
Media.reasonCode | extensible | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason from the FHIR Standard | ||||
Media.bodySite | extensible | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Media | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Media | 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 | Media | 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 | Media | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Media | 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 Media
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Media | 0..* | Media | 健康照護中獲取或使用的影像、影片或音檔,實際內容可能置於行內或透過直接參照提供。 | |||||
id | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Media紀錄,通常又稱為邏輯性ID。 | |||||
meta | 0..1 | Meta | 此Media Resource的metadata | |||||
implicitRules | 0..1 | uri | 創建此內容所依據的一組規則 | |||||
language | 0..1 | code | 用以表述Media Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
Example Value: zh-TW | |||||
text | 0..1 | Narrative | Media Resource之內容摘要以供人閱讀 | |||||
identifier | 0..* | Identifier | 影像的識別碼 | |||||
basedOn | 0..* | Reference(ServiceRequest | CarePlan) | 導致產生此多媒體的程序 | |||||
partOf | 0..* | Reference(Resource) | 參照事件的一部分 | |||||
status | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): 代表事件生命週期階段的代碼;應填入所綁定值集中的其中一個代碼 | |||||
type | 0..1 | CodeableConceptTW | 將多媒體分類為影像、影片或音檔 Binding: MediaType (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
modality | 0..1 | CodeableConceptTW | 取得影像的設備/過程 Binding: MediaModality (example): 可參考MediaModality代碼表,但此代碼表只是針對這個欄位的一個可能值的示例,不預期也不鼓勵使用者一定要使用此代碼表的代碼。 | |||||
view | 0..1 | CodeableConceptTW | 影像視圖,從不同的角度拍攝醫學影像,例如:側位(Lateral,從旁邊看)或前後部位(Antero-posterior,從前面或後面看) Binding: MediaCollectionView/Projection (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
subject | S | 0..1 | Reference(TW Core Patient | TW Core Practitioner | TW Core PractitionerRole | Group | Device | TW Core Specimen | TW Core Location) | 多媒體紀錄的對象是誰或什麼? | ||||
encounter | 0..1 | Reference(TW Core Encounter) | 與此Media相關的就醫事件(Encounter) | |||||
created[x] | 0..1 | dateTime, Period | Media被收集的時間 | |||||
issued | 0..1 | instant | 此版本提供的日期/時間 | |||||
operator | 0..1 | Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core CareTeam | TW Core Patient | Device | TW Core RelatedPerson) | 產生影像的人 | |||||
reasonCode | 0..* | CodeableConceptTW | 為什麼會進行這個事件? Binding: ProcedureReasonCodes (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
bodySite | 0..1 | CodeableConceptTW | 接受檢驗檢查的身體部位 Binding: SNOMEDCTBodyStructures (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
deviceName | 0..1 | string | 設備/製造商的名稱 | |||||
device | 0..1 | Reference(Device | DeviceMetric | Device) | 影像、影片、音檔的補捉設備。 | |||||
height | 0..1 | positiveInt | 以像素為單位的影像高度(影像/影像) | |||||
width | 0..1 | positiveInt | 以像素為單位的影像寬度(影像/影像) | |||||
frames | 0..1 | positiveInt | > 1 的影格(影像)。 | |||||
duration | 0..1 | decimal | 以秒為單位的長度(音檔/影片)。 | |||||
content | 1..1 | Attachment | 實際的多媒體 - 參照或資料。 | |||||
note | 0..* | Annotation | 對此Media的意見 | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Media.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Media.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | ||||
Media.type | extensible | MediaTypehttp://hl7.org/fhir/ValueSet/media-type from the FHIR Standard | ||||
Media.modality | example | MediaModalityhttp://hl7.org/fhir/ValueSet/media-modality from the FHIR Standard | ||||
Media.view | extensible | MediaCollectionView/Projectionhttp://hl7.org/fhir/ValueSet/media-view from the FHIR Standard | ||||
Media.reasonCode | extensible | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason from the FHIR Standard | ||||
Media.bodySite | extensible | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Media | 0..* | Media | 健康照護中獲取或使用的影像、影片或音檔,實際內容可能置於行內或透過直接參照提供。 | |||||
id | Σ | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Media紀錄,通常又稱為邏輯性ID。 | ||||
meta | Σ | 0..1 | Meta | 此Media Resource的metadata | ||||
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則 | ||||
language | 0..1 | code | 用以表述Media Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言;鼓勵使用CommonLanguages代碼表中的代碼,但不強制一定要使用此代碼表,你也可使用其他代碼表的代碼或單純以文字表示。
Example Value: zh-TW | |||||
text | 0..1 | Narrative | Media Resource之內容摘要以供人閱讀 | |||||
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 | 影像的識別碼 | ||||
basedOn | Σ | 0..* | Reference(ServiceRequest | CarePlan) | 導致產生此多媒體的程序 | ||||
partOf | Σ | 0..* | Reference(Resource) | 參照事件的一部分 | ||||
status | ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): 代表事件生命週期階段的代碼;應填入所綁定值集中的其中一個代碼 | ||||
type | 0..1 | CodeableConceptTW | 將多媒體分類為影像、影片或音檔 Binding: MediaType (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
modality | 0..1 | CodeableConceptTW | 取得影像的設備/過程 Binding: MediaModality (example): 可參考MediaModality代碼表,但此代碼表只是針對這個欄位的一個可能值的示例,不預期也不鼓勵使用者一定要使用此代碼表的代碼。 | |||||
view | 0..1 | CodeableConceptTW | 影像視圖,從不同的角度拍攝醫學影像,例如:側位(Lateral,從旁邊看)或前後部位(Antero-posterior,從前面或後面看) Binding: MediaCollectionView/Projection (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
subject | SΣ | 0..1 | Reference(TW Core Patient | TW Core Practitioner | TW Core PractitionerRole | Group | Device | TW Core Specimen | TW Core Location) | 多媒體紀錄的對象是誰或什麼? | ||||
encounter | Σ | 0..1 | Reference(TW Core Encounter) | 與此Media相關的就醫事件(Encounter) | ||||
created[x] | Σ | 0..1 | Media被收集的時間 | |||||
createdDateTime | dateTime | |||||||
createdPeriod | Period | |||||||
issued | Σ | 0..1 | instant | 此版本提供的日期/時間 | ||||
operator | Σ | 0..1 | Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core CareTeam | TW Core Patient | Device | TW Core RelatedPerson) | 產生影像的人 | ||||
reasonCode | 0..* | CodeableConceptTW | 為什麼會進行這個事件? Binding: ProcedureReasonCodes (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
bodySite | 0..1 | CodeableConceptTW | 接受檢驗檢查的身體部位 Binding: SNOMEDCTBodyStructures (extensible): 應填入所綁定值集中適合的代碼,確定無適合的代碼才可以使用其他值集的代碼來表示。 | |||||
deviceName | Σ | 0..1 | string | 設備/製造商的名稱 | ||||
device | Σ | 0..1 | Reference(Device | DeviceMetric | Device) | 影像、影片、音檔的補捉設備。 | ||||
height | Σ | 0..1 | positiveInt | 以像素為單位的影像高度(影像/影像) | ||||
width | Σ | 0..1 | positiveInt | 以像素為單位的影像寬度(影像/影像) | ||||
frames | Σ | 0..1 | positiveInt | > 1 的影格(影像)。 | ||||
duration | Σ | 0..1 | decimal | 以秒為單位的長度(音檔/影片)。 | ||||
content | Σ | 1..1 | Attachment | 實際的多媒體 - 參照或資料。 | ||||
note | 0..* | Annotation | 對此Media的意見 | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Media.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Media.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | ||||
Media.type | extensible | MediaTypehttp://hl7.org/fhir/ValueSet/media-type from the FHIR Standard | ||||
Media.modality | example | MediaModalityhttp://hl7.org/fhir/ValueSet/media-modality from the FHIR Standard | ||||
Media.view | extensible | MediaCollectionView/Projectionhttp://hl7.org/fhir/ValueSet/media-view from the FHIR Standard | ||||
Media.reasonCode | extensible | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason from the FHIR Standard | ||||
Media.bodySite | extensible | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Media | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Media | 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 | Media | 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 | Media | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Media | 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 Media
Summary
Must-Support: 1 element
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron
以下概述了此Profile所需的RESTful FHIR互動功能。有關TW Core IG支援的RESTful互動功能的完整清單,請參閱TW Core Server能力聲明。
建議應該(SHOULD) 支援透過查詢參數 _id
查詢所有Media:
(如何透過token查詢)
GET [base]/Media?_id=[id]
GET [base]/Media/[id]
例子:
(1) GET [base]/Media?_id=media-example
(2) GET [base]/Media/media-example
建議應該(SHOULD) 支援透過查詢參數 status
查詢所有Media:
(如何透過token查詢)
GET [base]/Media?status=[code]
例子:
(1) GET [base]/Media?status=completed
建議應該(SHOULD) 支援透過查詢參數 subject
查詢所有Media:
(如何透過reference查詢)
GET [base]/Media?subject={Type/}[id]
例子:
(1) GET [base]/Media?subject=Patient/pat-example