HL7 FHIR JP Core ImplementationGuide
2.0.0-dev - ci-build Japan flag

HL7 FHIR JP Core ImplementationGuide - Local Development build (v2.0.0-dev) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: JP_Media_Endoscopy - Detailed Descriptions

Active as of 2023-10-31

Definitions for the jp-media-endoscopy resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Media
Definition

内視鏡検査で取得または使用される画像、映像、音声に関わる情報。


A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.

Short内視鏡検査で取得または使用される画像、映像、音声に関わる情報。A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
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 (contained.where(((id.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Media.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Media.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. Media.identifier
Definition

製品またはシステムが管理する、施設内で画像(JPEG等)、映像(MPEG等)、音声ファイルなどのメディアを一意に識別するためのID。


Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers.

Short製品またはシステムが管理する、施設内で画像(JPEG等)、映像(MPEG等)、音声ファイルなどのメディアを一意に識別するためのID。Identifier(s) for the image
Comments

The identifier label and use can be used to determine what kind of identifier it is.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Media.basedOn
Definition

他のシステムから依頼されたオーダ情報。


A procedure that is fulfilled in whole or in part by the creation of this media.

Short他のシステムから依頼されたオーダ情報。Procedure that caused this media to be created
Comments

通常、依頼元となるServiceRequestリソースを参照する。他のシステムと連携していない場合は参照不要。

Control0..*
TypeReference(ServiceRequest, CarePlan)
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.

Alternate Namesfulfills
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Media.partOf
Definition

参照されるイベントの一部。


A larger event of which this particular event is a component or step.

Short参照されるイベントの一部。Part of referenced event
Comments

使用する場合は、基底にある Definition、Requirement、Comments の内容を参考に使用する。


Not to be used to link an event to an Encounter - use Media.encounter for that.

[The allowed reference resources may be adjusted as appropriate for the event resource].

Control0..*
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

E.g. Drug administration as part of a procedure, procedure as part of observation, etc.

Alternate Namescontainer
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Media.status
Definition

メディアのステータス。


The current state of the {{title}}.

Shortメディアのステータス。preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Comments

”completed” を指定する。


A nominal state-transition diagram can be found in the [[event.html#statemachine | Event pattern]] documentation

Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

Control1..1
BindingThe codes SHALL be taken from EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.3.0
(required to http://hl7.org/fhir/ValueSet/event-status|4.3.0)

Codes identifying the lifecycle stage of an event.

Typecode
Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Media.type
Definition

メディアの種類。


A code that classifies whether the media is an image, video or audio recording or some other media category.

Shortメディアの種類。Classification of media as image, video, or audio
Comments

使用する場合は、メディアの種類を image, video, audio から選択する。

Control0..1
BindingUnless not suitable, these codes SHALL be taken from MediaTypehttp://hl7.org/fhir/ValueSet/media-type
(extensible to http://hl7.org/fhir/ValueSet/media-type)

Codes for high level media categories.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

Used for filtering what observations are retrieved and displayed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Media.modality
Definition

メディアを取得・撮影した装置(モダリティ)。


Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality.

Shortメディアを取得・撮影した装置(モダリティ)。The type of acquisition equipment/process
Comments

使用する場合、ImagingStudy同様”ES”を指定する。

Control0..1
BindingFor example codes, see MediaModalityhttp://hl7.org/fhir/ValueSet/media-modality
(example to http://hl7.org/fhir/ValueSet/media-modality)

Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Media.view
Definition

メディアのイメージングビュー(例:横方向、前後方向など)。


The name of the imaging view e.g. Lateral or Antero-posterior (AP).

Shortメディアのイメージングビュー(例:横方向、前後方向など)。Imaging view, e.g. Lateral or Antero-posterior
Comments

内視鏡では省略してよい。将来的にニーズが出てきた場合には検討する。

Control0..1
BindingFor example codes, see MediaCollectionView/Projectionhttp://hl7.org/fhir/ValueSet/media-view
(example to http://hl7.org/fhir/ValueSet/media-view)

Imaging view (projection) used when collecting an image.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Media.subject
Definition

メディアの対象患者に関する情報。


Who/What this Media is a record of.

Shortメディアの対象患者に関する情報。Who/What this Media is a record of
Comments

JP Core Patientリソースを参照する。

Control0..1
TypeReference(JP Core Patient Profile, Patient, Practitioner, PractitionerRole, Group, Device, Specimen, Location)
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Media.encounter
Definition

このメディアが生成されるきっかけとなった情報。


The encounter that establishes the context for this media.

Shortこのメディアが生成されるきっかけとなった情報。Encounter associated with media
Comments

JP Core Encounterリソースを参照する。


This will typically be the encounter the media occurred within.

Control0..1
TypeReference(JP Core Encounter Profile, Encounter)
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

Links the Media to the Encounter context.

Alternate Namescontext
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Media.created[x]
Definition

このメディアが生成された日時。


The date and time(s) at which the media was collected.

Shortこのメディアが生成された日時。When Media was collected
Comments

静止画の場合createdDateTime、ビデオ、音声の場合createdPeriodを指定する。

Control0..1
TypeChoice of: dateTime, Period
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Alternate Namestiming
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Media.issued
Definition

DiagnosticReportのStatusがFinalになった日時(レポート確定日時)。


The date and time this version of the media was made available to providers, typically after having been reviewed.

ShortDiagnosticReportのStatusがFinalになった日時(レポート確定日時)。Date/Time this version was made available
Comments

内視鏡では、mediaが示すデータが単独でリソース化されることはない前提。


It may be the same as the lastUpdated time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the lastUpdated time of the resource itself due to a non-clinically significant update that does not require the new version to be reviewed and verified again.

Control0..1
Typeinstant
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Media.operator
Definition

内視鏡検査の実施医。


The person who administered the collection of the image.

Short内視鏡検査の実施医。The person who generated the image
Comments

内視鏡検査実施医の情報が入っているリソースを参照する。

Control0..1
TypeReference(Practitioner, PractitionerRole, Organization, CareTeam, Patient, Device, RelatedPerson)
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Media.reasonCode
Definition

このメディアが生成された理由。


Describes why the event occurred in coded or textual form.

Shortこのメディアが生成された理由。Why was event performed?
Comments

内視鏡では省略してよい。


Textual reasons can be captured using reasonCode.text.

Control0..*
BindingFor example codes, see ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason
(example to http://hl7.org/fhir/ValueSet/procedure-reason)

The reason for the media.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Media.bodySite
Definition

このメディアの対象となる解剖学的部位。


Indicates the site on the subject's body where the observation was made (i.e. the target site).

Shortこのメディアの対象となる解剖学的部位。Observed body part
Comments

内視鏡では省略してよい。将来的にニーズが出てきた場合には検討する。


Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component.

If the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension bodySite.

Control0..1
BindingFor example codes, see SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site
(example to http://hl7.org/fhir/ValueSet/body-site)

SNOMED CT Body site concepts

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Media.deviceName
Definition

このメディアを生成した装置名。


The name of the device / manufacturer of the device that was used to make the recording.

Shortこのメディアを生成した装置名。Name of the device/manufacturer
Comments

原則機種名(スコープ)を記載する。デジカメの場合Exifヘッダの機種名とする。

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Media.device
Definition

メディアの収集に使用されるデバイス。


The device used to collect the media.

Shortメディアの収集に使用されるデバイス。Observing Device
Comments

内視鏡では省略してよい。使用する場合には、参照するリソースで定義して使用する。


An extension should be used if further typing of the device is needed. Secondary devices used to support collecting a media can be represented using either extension or through the Observation.related element.

Control0..1
TypeReference(Device, DeviceMetric, Device)
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Media.height
Definition

画像の高さ(ピクセル単位)(写真/ビデオ)。


Height of the image in pixels (photo/video).

Short画像の高さ(ピクセル単位)(写真/ビデオ)。Height of the image in pixels (photo/video)
Comments

使用する場合は、画像の高さ(ピクセル単位)(写真/ビデオ)を指定する。

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Media.width
Definition

画像の幅(ピクセル単位)(写真/ビデオ)。


Width of the image in pixels (photo/video).

Short画像の幅(ピクセル単位)(写真/ビデオ)。Width of the image in pixels (photo/video)
Comments

使用する場合は、画像の幅(ピクセル単位)(写真/ビデオ)を指定する。

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Media.frames
Definition

フレーム数。


The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.

Shortフレーム数。Number of frames if > 1 (photo)
Comments

EUSの場合など、フレーム数が1より大きいメディア(単一のメディアで複数のスライスを取得する画像取得コンテキスト)を扱う場合に使用する。


if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. Media.duration
Definition

ビデオ映像・音声向けの、秒単位の録画・記録時間。


The duration of the recording in seconds - for audio and video.

Shortビデオ映像・音声向けの、秒単位の録画・記録時間。Length in seconds (audio / video)
Comments

The duration might differ from occurrencePeriod if recording was paused.

Control0..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Media.content
Definition

埋め込まれたメディアの実際のコンテンツ、またはメディアソースファイルへの直接参照。


The actual content of the media - inline or by direct reference to the media source file.

Short埋め込まれたメディアの実際のコンテンツ、またはメディアソースファイルへの直接参照。Actual Media - reference or data
Comments

Recommended content types: image/jpeg, image/png, image/tiff, video/mpeg, audio/mp4, application/dicom. Application/dicom can contain the transfer syntax as a parameter. For media that covers a period of time (video/sound), the content.creationTime is the end time. Creation time is used for tracking, organizing versions and searching.

Control1..1
TypeAttachment
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. Media.note
Definition

メディアについてのコメント。


Comments made about the media by the performer, subject or other participants.

Shortメディアについてのコメント。Comments made about the media
Comments

Not to be used for observations, conclusions, etc. Instead use an Observation based on the Media/ImagingStudy resource.

Control0..*
TypeAnnotation
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. Media
Definition

内視鏡検査で取得または使用される画像、映像、音声に関わる情報。

Short内視鏡検査で取得または使用される画像、映像、音声に関わる情報。
2. Media.identifier
Definition

製品またはシステムが管理する、施設内で画像(JPEG等)、映像(MPEG等)、音声ファイルなどのメディアを一意に識別するためのID。

Short製品またはシステムが管理する、施設内で画像(JPEG等)、映像(MPEG等)、音声ファイルなどのメディアを一意に識別するためのID。
NoteThis is a business identifier, not a resource identifier (see discussion)
Must Supporttrue
4. Media.basedOn
Definition

他のシステムから依頼されたオーダ情報。

Short他のシステムから依頼されたオーダ情報。
Comments

通常、依頼元となるServiceRequestリソースを参照する。他のシステムと連携していない場合は参照不要。

6. Media.partOf
Definition

参照されるイベントの一部。

Short参照されるイベントの一部。
Comments

使用する場合は、基底にある Definition、Requirement、Comments の内容を参考に使用する。

8. Media.status
Definition

メディアのステータス。

Shortメディアのステータス。
Comments

”completed” を指定する。

10. Media.type
Definition

メディアの種類。

Shortメディアの種類。
Comments

使用する場合は、メディアの種類を image, video, audio から選択する。

12. Media.modality
Definition

メディアを取得・撮影した装置(モダリティ)。

Shortメディアを取得・撮影した装置(モダリティ)。
Comments

使用する場合、ImagingStudy同様”ES”を指定する。

14. Media.view
Definition

メディアのイメージングビュー(例:横方向、前後方向など)。

Shortメディアのイメージングビュー(例:横方向、前後方向など)。
Comments

内視鏡では省略してよい。将来的にニーズが出てきた場合には検討する。

16. Media.subject
Definition

メディアの対象患者に関する情報。

Shortメディアの対象患者に関する情報。
Comments

JP Core Patientリソースを参照する。

TypeReference(JP Core Patient Profile)
Must Supporttrue
18. Media.encounter
Definition

このメディアが生成されるきっかけとなった情報。

Shortこのメディアが生成されるきっかけとなった情報。
Comments

JP Core Encounterリソースを参照する。

TypeReference(JP Core Encounter Profile)
20. Media.created[x]
Definition

このメディアが生成された日時。

Shortこのメディアが生成された日時。
Comments

静止画の場合createdDateTime、ビデオ、音声の場合createdPeriodを指定する。

[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
22. Media.issued
Definition

DiagnosticReportのStatusがFinalになった日時(レポート確定日時)。

ShortDiagnosticReportのStatusがFinalになった日時(レポート確定日時)。
Comments

内視鏡では、mediaが示すデータが単独でリソース化されることはない前提。

24. Media.operator
Definition

内視鏡検査の実施医。

Short内視鏡検査の実施医。
Comments

内視鏡検査実施医の情報が入っているリソースを参照する。

26. Media.reasonCode
Definition

このメディアが生成された理由。

Shortこのメディアが生成された理由。
Comments

内視鏡では省略してよい。

28. Media.bodySite
Definition

このメディアの対象となる解剖学的部位。

Shortこのメディアの対象となる解剖学的部位。
Comments

内視鏡では省略してよい。将来的にニーズが出てきた場合には検討する。

30. Media.deviceName
Definition

このメディアを生成した装置名。

Shortこのメディアを生成した装置名。
Comments

原則機種名(スコープ)を記載する。デジカメの場合Exifヘッダの機種名とする。

32. Media.device
Definition

メディアの収集に使用されるデバイス。

Shortメディアの収集に使用されるデバイス。
Comments

内視鏡では省略してよい。使用する場合には、参照するリソースで定義して使用する。

34. Media.height
Definition

画像の高さ(ピクセル単位)(写真/ビデオ)。

Short画像の高さ(ピクセル単位)(写真/ビデオ)。
Comments

使用する場合は、画像の高さ(ピクセル単位)(写真/ビデオ)を指定する。

36. Media.width
Definition

画像の幅(ピクセル単位)(写真/ビデオ)。

Short画像の幅(ピクセル単位)(写真/ビデオ)。
Comments

使用する場合は、画像の幅(ピクセル単位)(写真/ビデオ)を指定する。

38. Media.frames
Definition

フレーム数。

Shortフレーム数。
Comments

EUSの場合など、フレーム数が1より大きいメディア(単一のメディアで複数のスライスを取得する画像取得コンテキスト)を扱う場合に使用する。

40. Media.duration
Definition

ビデオ映像・音声向けの、秒単位の録画・記録時間。

Shortビデオ映像・音声向けの、秒単位の録画・記録時間。
42. Media.content
Definition

埋め込まれたメディアの実際のコンテンツ、またはメディアソースファイルへの直接参照。

Short埋め込まれたメディアの実際のコンテンツ、またはメディアソースファイルへの直接参照。
44. Media.note
Definition

メディアについてのコメント。

Shortメディアについてのコメント。

Guidance on how to interpret the contents of this table can be found here

0. Media
Definition

内視鏡検査で取得または使用される画像、映像、音声に関わる情報。

Short内視鏡検査で取得または使用される画像、映像、音声に関わる情報。
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
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 (contained.where(((id.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Media.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control0..1
Typeid
Is Modifierfalse
Must Supportfalse
Summarytrue
4. Media.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Media.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Media.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages)

IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Media.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Media.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Control0..*
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
14. Media.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. Media.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. Media.identifier
Definition

製品またはシステムが管理する、施設内で画像(JPEG等)、映像(MPEG等)、音声ファイルなどのメディアを一意に識別するためのID。

Short製品またはシステムが管理する、施設内で画像(JPEG等)、映像(MPEG等)、音声ファイルなどのメディアを一意に識別するためのID。
Comments

The identifier label and use can be used to determine what kind of identifier it is.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Media.basedOn
Definition

他のシステムから依頼されたオーダ情報。

Short他のシステムから依頼されたオーダ情報。
Comments

通常、依頼元となるServiceRequestリソースを参照する。他のシステムと連携していない場合は参照不要。

Control0..*
TypeReference(ServiceRequest, CarePlan)
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.

Alternate Namesfulfills
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Media.partOf
Definition

参照されるイベントの一部。

Short参照されるイベントの一部。
Comments

使用する場合は、基底にある Definition、Requirement、Comments の内容を参考に使用する。

Control0..*
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

E.g. Drug administration as part of a procedure, procedure as part of observation, etc.

Alternate Namescontainer
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Media.status
Definition

メディアのステータス。

Shortメディアのステータス。
Comments

”completed” を指定する。

Control1..1
BindingThe codes SHALL be taken from EventStatus
(required to http://hl7.org/fhir/ValueSet/event-status|4.3.0)

Codes identifying the lifecycle stage of an event.

Typecode
Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Media.type
Definition

メディアの種類。

Shortメディアの種類。
Comments

使用する場合は、メディアの種類を image, video, audio から選択する。

Control0..1
BindingUnless not suitable, these codes SHALL be taken from MediaType
(extensible to http://hl7.org/fhir/ValueSet/media-type)

Codes for high level media categories.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

Used for filtering what observations are retrieved and displayed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Media.modality
Definition

メディアを取得・撮影した装置(モダリティ)。

Shortメディアを取得・撮影した装置(モダリティ)。
Comments

使用する場合、ImagingStudy同様”ES”を指定する。

Control0..1
BindingFor example codes, see MediaModality
(example to http://hl7.org/fhir/ValueSet/media-modality)

Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Media.view
Definition

メディアのイメージングビュー(例:横方向、前後方向など)。

Shortメディアのイメージングビュー(例:横方向、前後方向など)。
Comments

内視鏡では省略してよい。将来的にニーズが出てきた場合には検討する。

Control0..1
BindingFor example codes, see MediaCollectionView/Projection
(example to http://hl7.org/fhir/ValueSet/media-view)

Imaging view (projection) used when collecting an image.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Media.subject
Definition

メディアの対象患者に関する情報。

Shortメディアの対象患者に関する情報。
Comments

JP Core Patientリソースを参照する。

Control0..1
TypeReference(JP Core Patient Profile)
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Media.encounter
Definition

このメディアが生成されるきっかけとなった情報。

Shortこのメディアが生成されるきっかけとなった情報。
Comments

JP Core Encounterリソースを参照する。

Control0..1
TypeReference(JP Core Encounter Profile)
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

Links the Media to the Encounter context.

Alternate Namescontext
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Media.created[x]
Definition

このメディアが生成された日時。

Shortこのメディアが生成された日時。
Comments

静止画の場合createdDateTime、ビデオ、音声の場合createdPeriodを指定する。

Control0..1
TypeChoice of: dateTime, Period
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Alternate Namestiming
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Media.issued
Definition

DiagnosticReportのStatusがFinalになった日時(レポート確定日時)。

ShortDiagnosticReportのStatusがFinalになった日時(レポート確定日時)。
Comments

内視鏡では、mediaが示すデータが単独でリソース化されることはない前提。

Control0..1
Typeinstant
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Media.operator
Definition

内視鏡検査の実施医。

Short内視鏡検査の実施医。
Comments

内視鏡検査実施医の情報が入っているリソースを参照する。

Control0..1
TypeReference(Practitioner, PractitionerRole, Organization, CareTeam, Patient, Device, RelatedPerson)
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Media.reasonCode
Definition

このメディアが生成された理由。

Shortこのメディアが生成された理由。
Comments

内視鏡では省略してよい。

Control0..*
BindingFor example codes, see ProcedureReasonCodes
(example to http://hl7.org/fhir/ValueSet/procedure-reason)

The reason for the media.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. Media.bodySite
Definition

このメディアの対象となる解剖学的部位。

Shortこのメディアの対象となる解剖学的部位。
Comments

内視鏡では省略してよい。将来的にニーズが出てきた場合には検討する。

Control0..1
BindingFor example codes, see SNOMEDCTBodyStructures
(example to http://hl7.org/fhir/ValueSet/body-site)

SNOMED CT Body site concepts

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Media.deviceName
Definition

このメディアを生成した装置名。

Shortこのメディアを生成した装置名。
Comments

原則機種名(スコープ)を記載する。デジカメの場合Exifヘッダの機種名とする。

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. Media.device
Definition

メディアの収集に使用されるデバイス。

Shortメディアの収集に使用されるデバイス。
Comments

内視鏡では省略してよい。使用する場合には、参照するリソースで定義して使用する。

Control0..1
TypeReference(Device, DeviceMetric, Device)
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Media.height
Definition

画像の高さ(ピクセル単位)(写真/ビデオ)。

Short画像の高さ(ピクセル単位)(写真/ビデオ)。
Comments

使用する場合は、画像の高さ(ピクセル単位)(写真/ビデオ)を指定する。

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. Media.width
Definition

画像の幅(ピクセル単位)(写真/ビデオ)。

Short画像の幅(ピクセル単位)(写真/ビデオ)。
Comments

使用する場合は、画像の幅(ピクセル単位)(写真/ビデオ)を指定する。

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Media.frames
Definition

フレーム数。

Shortフレーム数。
Comments

EUSの場合など、フレーム数が1より大きいメディア(単一のメディアで複数のスライスを取得する画像取得コンテキスト)を扱う場合に使用する。

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. Media.duration
Definition

ビデオ映像・音声向けの、秒単位の録画・記録時間。

Shortビデオ映像・音声向けの、秒単位の録画・記録時間。
Comments

The duration might differ from occurrencePeriod if recording was paused.

Control0..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Media.content
Definition

埋め込まれたメディアの実際のコンテンツ、またはメディアソースファイルへの直接参照。

Short埋め込まれたメディアの実際のコンテンツ、またはメディアソースファイルへの直接参照。
Comments

Recommended content types: image/jpeg, image/png, image/tiff, video/mpeg, audio/mp4, application/dicom. Application/dicom can contain the transfer syntax as a parameter. For media that covers a period of time (video/sound), the content.creationTime is the end time. Creation time is used for tracking, organizing versions and searching.

Control1..1
TypeAttachment
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. Media.note
Definition

メディアについてのコメント。

Shortメディアについてのコメント。
Comments

Not to be used for observations, conclusions, etc. Instead use an Observation based on the Media/ImagingStudy resource.

Control0..*
TypeAnnotation
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
本実装ガイドへのご質問・ご指摘については、GitHub IssueおよびGitHub PullRequestにて受け付けております。