Cumuluz Translate Implementation Guide
0.1.0 - ci-build
Cumuluz Translate Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.cumuluz.org/xib/StructureDefinition/xib-Media | Version: 0.1.0 | |||
| Draft as of 2026-07-11 | Computable Name: XibMedia | |||
Generic XIB media target for nl-core Media profiles.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Naam | Markeringen | Kard. | Type | Omschrijving & constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!SΣ | 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. |
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Classification of media as image, video, or audio Binding: MediaType (extensible): Codes for high level media categories. |
![]() ![]() |
SΣ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Group | Device | Specimen | Location) | Who/What this Media is a record of |
![]() ![]() |
SΣ | 0..1 | When Media was collected | |
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() |
SΣ | 1..1 | Attachment | Actual Media - reference or data |
Documentatie voor dit formaat | ||||
| Pad | Status | Gebruik | ValueSet | Versie | Source |
| Media.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Media.type | Base | extensible | Media Type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Pad(en) | Omschrijving | Expressie |
| 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
| Naam | Markeringen | Kard. | Type | Omschrijving & constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
![]() ![]() |
S | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
![]() ![]() |
S | 0..1 | CodeableConcept | Classification of media as image, video, or audio |
![]() ![]() |
S | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Group | Device | Specimen | Location) | Who/What this Media is a record of |
![]() ![]() |
S | 0..1 | dateTime, Period | When Media was collected |
![]() ![]() |
S | 1..1 | Attachment | Actual Media - reference or data |
Documentatie voor dit formaat | ||||
| Naam | Markeringen | Kard. | Type | Omschrijving & constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Identifier(s) for the image | ||||
![]() ![]() |
Σ | 0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created | ||||
![]() ![]() |
Σ | 0..* | Reference(Resource) | Part of referenced event | ||||
![]() ![]() |
?!SΣ | 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. | ||||
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Classification of media as image, video, or audio Binding: MediaType (extensible): Codes for high level media categories. | ||||
![]() ![]() |
Σ | 0..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. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Imaging view, e.g. Lateral or Antero-posterior Binding: MediaCollectionView/Projection (example): Imaging view (projection) used when collecting an image. | ||||
![]() ![]() |
SΣ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Group | Device | Specimen | Location) | Who/What this Media is a record of | ||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter associated with media | ||||
![]() ![]() |
SΣ | 0..1 | When Media was collected | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() |
Σ | 0..1 | instant | Date/Time this version was made available | ||||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The person who generated the image | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Why was event performed? Binding: ProcedureReasonCodes (example): The reason for the media. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
![]() ![]() |
Σ | 0..1 | string | Name of the device/manufacturer | ||||
![]() ![]() |
Σ | 0..1 | Reference(Device | DeviceMetric | Device) | Observing Device | ||||
![]() ![]() |
Σ | 0..1 | positiveInt | Height of the image in pixels (photo/video) | ||||
![]() ![]() |
Σ | 0..1 | positiveInt | Width of the image in pixels (photo/video) | ||||
![]() ![]() |
Σ | 0..1 | positiveInt | Number of frames if > 1 (photo) | ||||
![]() ![]() |
Σ | 0..1 | decimal | Length in seconds (audio / video) | ||||
![]() ![]() |
SΣ | 1..1 | Attachment | Actual Media - reference or data | ||||
![]() ![]() |
0..* | Annotation | Comments made about the media | |||||
Documentatie voor dit formaat | ||||||||
| Pad | Status | Gebruik | ValueSet | Versie | Source |
| Media.language | Base | preferred | Common Languages | 📍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. |
| Id | Grade | Pad(en) | Omschrijving | Expressie |
| 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
Key Elements View
| Naam | Markeringen | Kard. | Type | Omschrijving & constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!SΣ | 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. |
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Classification of media as image, video, or audio Binding: MediaType (extensible): Codes for high level media categories. |
![]() ![]() |
SΣ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Group | Device | Specimen | Location) | Who/What this Media is a record of |
![]() ![]() |
SΣ | 0..1 | When Media was collected | |
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() |
SΣ | 1..1 | Attachment | Actual Media - reference or data |
Documentatie voor dit formaat | ||||
| Pad | Status | Gebruik | ValueSet | Versie | Source |
| Media.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Media.type | Base | extensible | Media Type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Pad(en) | Omschrijving | Expressie |
| 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
| Naam | Markeringen | Kard. | Type | Omschrijving & constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |
![]() ![]() |
S | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
![]() ![]() |
S | 0..1 | CodeableConcept | Classification of media as image, video, or audio |
![]() ![]() |
S | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Group | Device | Specimen | Location) | Who/What this Media is a record of |
![]() ![]() |
S | 0..1 | dateTime, Period | When Media was collected |
![]() ![]() |
S | 1..1 | Attachment | Actual Media - reference or data |
Documentatie voor dit formaat | ||||
Snapshot View
| Naam | Markeringen | Kard. | Type | Omschrijving & constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Media | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Identifier(s) for the image | ||||
![]() ![]() |
Σ | 0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created | ||||
![]() ![]() |
Σ | 0..* | Reference(Resource) | Part of referenced event | ||||
![]() ![]() |
?!SΣ | 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. | ||||
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Classification of media as image, video, or audio Binding: MediaType (extensible): Codes for high level media categories. | ||||
![]() ![]() |
Σ | 0..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. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Imaging view, e.g. Lateral or Antero-posterior Binding: MediaCollectionView/Projection (example): Imaging view (projection) used when collecting an image. | ||||
![]() ![]() |
SΣ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Group | Device | Specimen | Location) | Who/What this Media is a record of | ||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter associated with media | ||||
![]() ![]() |
SΣ | 0..1 | When Media was collected | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() |
Σ | 0..1 | instant | Date/Time this version was made available | ||||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The person who generated the image | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Why was event performed? Binding: ProcedureReasonCodes (example): The reason for the media. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
![]() ![]() |
Σ | 0..1 | string | Name of the device/manufacturer | ||||
![]() ![]() |
Σ | 0..1 | Reference(Device | DeviceMetric | Device) | Observing Device | ||||
![]() ![]() |
Σ | 0..1 | positiveInt | Height of the image in pixels (photo/video) | ||||
![]() ![]() |
Σ | 0..1 | positiveInt | Width of the image in pixels (photo/video) | ||||
![]() ![]() |
Σ | 0..1 | positiveInt | Number of frames if > 1 (photo) | ||||
![]() ![]() |
Σ | 0..1 | decimal | Length in seconds (audio / video) | ||||
![]() ![]() |
SΣ | 1..1 | Attachment | Actual Media - reference or data | ||||
![]() ![]() |
0..* | Annotation | Comments made about the media | |||||
Documentatie voor dit formaat | ||||||||
| Pad | Status | Gebruik | ValueSet | Versie | Source |
| Media.language | Base | preferred | Common Languages | 📍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. |
| Id | Grade | Pad(en) | Omschrijving | Expressie |
| 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
Other representations of profile: CSV, Excel, Schematron