EU Imaging Report R4
1.0.0-ballot - ci-build
150
EU Imaging Report R4
1.0.0-ballot - ci-build
150
EU Imaging Report R4, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/imaging-r4/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.eu/fhir/imaging/StructureDefinition/MediaKeyImageEuImaging | Version: 1.0.0-ballot | ||||
| Standards status: Draft | Maturity Level: 1 | Computable Name: MediaKeyImageEuImaging | |||
Copyright/Legal: Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0). |
|||||
Represents a key image for a patient as image content in an R4 Media resource. Use this profile to include or directly link the image (DICOM or non-DICOM); use ImagingSelectionKeyImageEuImaging when the key image is identified using DICOM selection data.
When the resource represents a DICOM artifact it SHALL contain the applicable DICOM identifier in the identifier element: the SOP Instance UID for a DICOM instance, the Series Instance UID for a DICOM series, and/or the Study Instance UID for a DICOM study. Such a resource MAY also reference an ImagingSelectionKeyImageEuImaging to indicate the DICOM source.
A key image is an image, or a specific frame within an image, that the imaging clinician has selected as particularly relevant to the report — for example an image that best demonstrates a finding, supports the impression, or is useful for comparison and follow-up. In radiology a study can contain hundreds or thousands of instances, so flagging key images helps the referring physician and other readers quickly locate the most significant images. In DICOM, key images are typically captured using a Key Object Selection (KOS) document, described by Key Object Selection, TID 2010 in DICOM PS3.16.
Key images can be represented either as image content or as a reference to DICOM selection data:
Media (MediaKeyImageEuImaging) — the key image as image content.ImagingSelection (ImagingSelectionKeyImageEuImaging) — the key image identified using DICOM selection data. In this R4 IG the ImagingSelection is implemented on a Basic resource with a cross-version extension backporting the R5 ImagingSelection structure.ImagingSelection is more DICOM oriented and relates to DICOM identifiers. Media represents the image content and contains information such as its size, format and duration. The eHN Imaging Studies and Reports guidelines requires information on the size, format and duration; these data elements are provided by the Attachment in Media.content.
This IG uses Media in R4 for image content, and ImagingSelection when the key image is identified using DICOM selection data (for example, to state that an image can come from a Procedure Phase).
The ImagingSelection resource points to DICOM data. The DICOM instance data also holds the data required by the eHN Imaging Studies and Reports, so the client can retrieve the information from the DICOM source data. Access to the imaging data can be direct or through a web based image viewer; a scenario supported by ImagingSelection requires access to the DICOM identifiers and a WADO endpoint.
Media resources refer to the image data directly, either by including it in the Attachment or by linking to it. The report may also refer to key images such as charts or PDFs that are not stored in a DICOM PACS; Media supports this case.
Key images can be represented by ImagingSelection or Media resources. When using Media to represent a DICOM artifact, it carries an identifier corresponding to the SOP instance, series or study it represents. In the case of ImagingSelection these values are represented as fields in the resource.
|
One or more DICOM identifier codes used by this profile come from the temporary MissingDicomTerminology CodeSystem and must be replaced with the equivalents defined by the DICOM terminology IG once it is published. |
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Media |
0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
  Slices for identifier |
0..* | Identifier | Identifier(s) for the image Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   identifier:seriesInstanceUid |
0..1 | Identifier | Identifier(s) for the image | |
  use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
  type |
1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 112002 | |
| display |
0..1 | string | Representation defined by the system | |
 userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
 value |
1..1 | string | The value that is unique Example General: 123456 | |
| identifier:sopClassInstanceUid |
0..1 | Identifier | Identifier(s) for the image | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| type |
1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.eu/fhir/imaging/CodeSystem/codesystem-missing-dicom-terminology | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 00080018 | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
 identifier:studyInstanceUid |
0..1 | Identifier | Identifier(s) for the image | |
 use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| type |
1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 110180 | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| Slices for basedOn |
0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| basedOn:ServiceRequestOrderEuImagingaccession |
0..1 | Reference(ServiceRequest: Imaging Order) | Procedure that caused this media to be created | |
| identifier |
0..1 | AccessionNumberIdentifierEuImaging | Logical reference, when literal reference is not known | |
| status |
1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): Codes identifying the lifecycle stage of an event. Required Pattern: completed | |
| type |
0..1 | CodeableConcept | Classification of media as image, video, or audio Binding: MediaType (extensible) | |
| modality |
1..1 | CodeableConcept | The type of acquisition equipment/process Binding: MediaModality (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it. | |
 subject |
1..1 | Reference(Patient (EU core)) | Who/What this Media is a record of | |
 content |
1..1 | Attachment | Actual Media - reference or data | |
| contentType |
1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Media.identifier:seriesInstanceUid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Media.identifier:seriesInstanceUid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Media.identifier:sopClassInstanceUid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Media.identifier:sopClassInstanceUid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Media.identifier:studyInstanceUid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Media.identifier:studyInstanceUid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Media.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Media.type | Base | extensible | Media Type | 📦4.0.1 | FHIR Std. |
| Media.modality | Base | example | Media Modality | 📍4.0.1 | FHIR Std. |
| Media.content.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 Filter: |
|---|---|---|---|---|
| Media |
0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
| Slices for identifier |
0..* | Identifier | Identifier(s) for the image Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:seriesInstanceUid |
0..1 | Identifier | Identifier(s) for the image | |
 type |
1..1 | CodeableConcept | Description of identifier 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://dicom.nema.org/resources/ontology/DCM | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 112002 | |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| identifier:sopClassInstanceUid |
0..1 | Identifier | Identifier(s) for the image | |
| type |
1..1 | CodeableConcept | Description of identifier 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://hl7.eu/fhir/imaging/CodeSystem/codesystem-missing-dicom-terminology | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 00080018 | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | |
| value |
1..1 | string | The value that is unique | |
| identifier:studyInstanceUid |
0..1 | Identifier | Identifier(s) for the image | |
| type |
1..1 | CodeableConcept | Description of identifier 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://dicom.nema.org/resources/ontology/DCM | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 110180 | |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| Slices for basedOn |
0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| basedOn:ServiceRequestOrderEuImagingaccession |
0..1 | Reference(ServiceRequest: Imaging Order) | Procedure that caused this media to be created | |
| identifier |
0..1 | AccessionNumberIdentifierEuImaging | Logical reference, when literal reference is not known | |
| status |
1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Required Pattern: completed | |
| type |
0..1 | CodeableConcept | Classification of media as image, video, or audio Binding: MediaType (extensible) | |
| modality |
1..1 | CodeableConcept | The type of acquisition equipment/process | |
| subject |
1..1 | Reference(Patient (EU core)) | Who/What this Media is a record of | |
| content |
||||
| contentType |
1..1 | code | Mime type of the content, with charset etc. | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Media.type | Base | extensible | Media Type | 📦4.0.1 | FHIR Std. |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Media |
0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| Slices for identifier |
0..* | Identifier | Identifier(s) for the image Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| identifier:seriesInstanceUid |
0..1 | Identifier | Identifier(s) for the image | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 112002 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| identifier:sopClassInstanceUid |
0..1 | Identifier | Identifier(s) for the image | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.eu/fhir/imaging/CodeSystem/codesystem-missing-dicom-terminology | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 00080018 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| identifier:studyInstanceUid |
0..1 | Identifier | Identifier(s) for the image | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 110180 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| Slices for basedOn |
0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| basedOn:ServiceRequestOrderEuImagingaccession |
0..1 | Reference(ServiceRequest: Imaging Order) | Procedure that caused this media to be created | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
0..1 | AccessionNumberIdentifierEuImaging | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| partOf |
0..* | Reference(Resource) | Part of referenced event | |||||
| status |
1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): Codes identifying the lifecycle stage of an event. Required Pattern: completed | |||||
| type |
0..1 | CodeableConcept | Classification of media as image, video, or audio Binding: MediaType (extensible) | |||||
| modality |
1..1 | CodeableConcept | The type of acquisition equipment/process Binding: MediaModality (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it. | |||||
| view |
0..1 | CodeableConcept | Imaging view, e.g. Lateral or Antero-posterior Binding: MediaCollectionView/Projection (example): Imaging view (projection) used when collecting an image. | |||||
| subject |
1..1 | Reference(Patient (EU core)) | Who/What this Media is a record of | |||||
| encounter |
0..1 | Reference(Encounter) | Encounter associated with media | |||||
 created[x] |
0..1 | When Media was collected | ||||||
| createdDateTime |
dateTime | |||||||
| createdPeriod |
Period | |||||||
| issued |
0..1 | instant | Date/Time this version was made available | |||||
| operator |
0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The person who generated the image | |||||
| reasonCode |
0..* | CodeableConcept | Why was event performed? Binding: ProcedureReasonCodes (example): The reason for the media. | |||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| deviceName |
0..1 | string | Name of the device/manufacturer | |||||
| device |
0..1 | Reference(Device | DeviceMetric | Device) | Observing Device | |||||
| height |
0..1 | positiveInt | Height of the image in pixels (photo/video) | |||||
| width |
0..1 | positiveInt | Width of the image in pixels (photo/video) | |||||
| frames |
0..1 | positiveInt | Number of frames if > 1 (photo) | |||||
| duration |
0..1 | decimal | Length in seconds (audio / video) | |||||
| content |
1..1 | Attachment | Actual Media - reference or data | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType |
1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | |||||
| language |
0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | |||||
| data |
0..1 | base64Binary | Data inline, base64ed | |||||
| url |
0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | |||||
| size |
0..1 | unsignedInt | Number of bytes of content (if url provided) | |||||
| hash |
0..1 | base64Binary | Hash of the data (sha-1, base64ed) | |||||
| title |
0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | |||||
| creation |
0..1 | dateTime | Date attachment was first created | |||||
| note |
0..* | Annotation | Comments made about the media | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Media.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Media.identifier:seriesInstanceUid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Media.identifier:seriesInstanceUid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Media.identifier:sopClassInstanceUid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Media.identifier:sopClassInstanceUid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Media.identifier:studyInstanceUid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Media.identifier:studyInstanceUid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Media.basedOn:ServiceRequestOrderEuImagingaccession.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Media.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Media.type | Base | extensible | Media Type | 📦4.0.1 | FHIR Std. |
| Media.modality | Base | example | Media Modality | 📍4.0.1 | FHIR Std. |
| Media.view | Base | example | Media Collection View/Projection | 📍4.0.1 | FHIR Std. |
| Media.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| Media.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Media.content.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Media.content.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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
Mandatory: 3 elements(9 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Media |
0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| Slices for identifier |
0..* | Identifier | Identifier(s) for the image Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:seriesInstanceUid |
0..1 | Identifier | Identifier(s) for the image | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| type |
1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 112002 | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| identifier:sopClassInstanceUid |
0..1 | Identifier | Identifier(s) for the image | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| type |
1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.eu/fhir/imaging/CodeSystem/codesystem-missing-dicom-terminology | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 00080018 | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| identifier:studyInstanceUid |
0..1 | Identifier | Identifier(s) for the image | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| type |
1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 110180 | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| Slices for basedOn |
0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| basedOn:ServiceRequestOrderEuImagingaccession |
0..1 | Reference(ServiceRequest: Imaging Order) | Procedure that caused this media to be created | |
| identifier |
0..1 | AccessionNumberIdentifierEuImaging | Logical reference, when literal reference is not known | |
| status |
1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): Codes identifying the lifecycle stage of an event. Required Pattern: completed | |
| type |
0..1 | CodeableConcept | Classification of media as image, video, or audio Binding: MediaType (extensible) | |
| modality |
1..1 | CodeableConcept | The type of acquisition equipment/process Binding: MediaModality (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it. | |
| subject |
1..1 | Reference(Patient (EU core)) | Who/What this Media is a record of | |
| content |
1..1 | Attachment | Actual Media - reference or data | |
| contentType |
1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Media.identifier:seriesInstanceUid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Media.identifier:seriesInstanceUid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Media.identifier:sopClassInstanceUid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Media.identifier:sopClassInstanceUid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Media.identifier:studyInstanceUid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Media.identifier:studyInstanceUid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Media.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Media.type | Base | extensible | Media Type | 📦4.0.1 | FHIR Std. |
| Media.modality | Base | example | Media Modality | 📍4.0.1 | FHIR Std. |
| Media.content.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 Filter: |
|---|---|---|---|---|
| Media |
0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
| Slices for identifier |
0..* | Identifier | Identifier(s) for the image Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:seriesInstanceUid |
0..1 | Identifier | Identifier(s) for the image | |
| type |
1..1 | CodeableConcept | Description of identifier 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://dicom.nema.org/resources/ontology/DCM | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 112002 | |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| identifier:sopClassInstanceUid |
0..1 | Identifier | Identifier(s) for the image | |
| type |
1..1 | CodeableConcept | Description of identifier 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://hl7.eu/fhir/imaging/CodeSystem/codesystem-missing-dicom-terminology | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 00080018 | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | |
| value |
1..1 | string | The value that is unique | |
| identifier:studyInstanceUid |
0..1 | Identifier | Identifier(s) for the image | |
| type |
1..1 | CodeableConcept | Description of identifier 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://dicom.nema.org/resources/ontology/DCM | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 110180 | |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| Slices for basedOn |
0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| basedOn:ServiceRequestOrderEuImagingaccession |
0..1 | Reference(ServiceRequest: Imaging Order) | Procedure that caused this media to be created | |
| identifier |
0..1 | AccessionNumberIdentifierEuImaging | Logical reference, when literal reference is not known | |
| status |
1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Required Pattern: completed | |
| type |
0..1 | CodeableConcept | Classification of media as image, video, or audio Binding: MediaType (extensible) | |
| modality |
1..1 | CodeableConcept | The type of acquisition equipment/process | |
| subject |
1..1 | Reference(Patient (EU core)) | Who/What this Media is a record of | |
| content |
||||
| contentType |
1..1 | code | Mime type of the content, with charset etc. | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Media.type | Base | extensible | Media Type | 📦4.0.1 | FHIR Std. |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Media |
0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| Slices for identifier |
0..* | Identifier | Identifier(s) for the image Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| identifier:seriesInstanceUid |
0..1 | Identifier | Identifier(s) for the image | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 112002 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| identifier:sopClassInstanceUid |
0..1 | Identifier | Identifier(s) for the image | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.eu/fhir/imaging/CodeSystem/codesystem-missing-dicom-terminology | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 00080018 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| identifier:studyInstanceUid |
0..1 | Identifier | Identifier(s) for the image | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 110180 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| Slices for basedOn |
0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| basedOn:ServiceRequestOrderEuImagingaccession |
0..1 | Reference(ServiceRequest: Imaging Order) | Procedure that caused this media to be created | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
0..1 | AccessionNumberIdentifierEuImaging | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| partOf |
0..* | Reference(Resource) | Part of referenced event | |||||
| status |
1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): Codes identifying the lifecycle stage of an event. Required Pattern: completed | |||||
| type |
0..1 | CodeableConcept | Classification of media as image, video, or audio Binding: MediaType (extensible) | |||||
| modality |
1..1 | CodeableConcept | The type of acquisition equipment/process Binding: MediaModality (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it. | |||||
| view |
0..1 | CodeableConcept | Imaging view, e.g. Lateral or Antero-posterior Binding: MediaCollectionView/Projection (example): Imaging view (projection) used when collecting an image. | |||||
| subject |
1..1 | Reference(Patient (EU core)) | Who/What this Media is a record of | |||||
| encounter |
0..1 | Reference(Encounter) | Encounter associated with media | |||||
| created[x] |
0..1 | When Media was collected | ||||||
| createdDateTime |
dateTime | |||||||
| createdPeriod |
Period | |||||||
| issued |
0..1 | instant | Date/Time this version was made available | |||||
| operator |
0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The person who generated the image | |||||
| reasonCode |
0..* | CodeableConcept | Why was event performed? Binding: ProcedureReasonCodes (example): The reason for the media. | |||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| deviceName |
0..1 | string | Name of the device/manufacturer | |||||
| device |
0..1 | Reference(Device | DeviceMetric | Device) | Observing Device | |||||
| height |
0..1 | positiveInt | Height of the image in pixels (photo/video) | |||||
| width |
0..1 | positiveInt | Width of the image in pixels (photo/video) | |||||
| frames |
0..1 | positiveInt | Number of frames if > 1 (photo) | |||||
| duration |
0..1 | decimal | Length in seconds (audio / video) | |||||
| content |
1..1 | Attachment | Actual Media - reference or data | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType |
1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | |||||
| language |
0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | |||||
| data |
0..1 | base64Binary | Data inline, base64ed | |||||
| url |
0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | |||||
| size |
0..1 | unsignedInt | Number of bytes of content (if url provided) | |||||
| hash |
0..1 | base64Binary | Hash of the data (sha-1, base64ed) | |||||
| title |
0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | |||||
| creation |
0..1 | dateTime | Date attachment was first created | |||||
| note |
0..* | Annotation | Comments made about the media | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Media.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Media.identifier:seriesInstanceUid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Media.identifier:seriesInstanceUid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Media.identifier:sopClassInstanceUid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Media.identifier:sopClassInstanceUid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Media.identifier:studyInstanceUid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Media.identifier:studyInstanceUid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Media.basedOn:ServiceRequestOrderEuImagingaccession.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Media.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Media.type | Base | extensible | Media Type | 📦4.0.1 | FHIR Std. |
| Media.modality | Base | example | Media Modality | 📍4.0.1 | FHIR Std. |
| Media.view | Base | example | Media Collection View/Projection | 📍4.0.1 | FHIR Std. |
| Media.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| Media.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Media.content.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Media.content.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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
Mandatory: 3 elements(9 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ HL7 Europe.
Package hl7.fhir.eu.imaging#1.0.0-ballot based on FHIR 4.0.1.
Generated
2026-10-13
