Cross Border Data Exchange IG
1.0.0 - CI Build
Cross Border Data Exchange IG
1.0.0 - CI Build
Cross Border Data Exchange IG, published by IEHR-Workgroup. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/InteropEHRate-project/cross-border-data-exchange/ and changes regularly. See the Directory of published versions
| Official URL: http://interopehrate.eu/fhir/StructureDefinition/Media-IEHR | Version: 1.0.0 | |||
| Draft as of 2024-04-08 | Computable Name: MediaIEHR | |||
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Media
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Media |
Media | |||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 Provenance |
S | 1..1 | Reference(Provenance-IEHR) | Extension URL: http://interopehrate.eu/fhir/StructureDefinition/ProvenanceExtension-IEHR |
  created[x] |
S | 0..1 | When Media was collected | |
  createdDateTime |
dateTime | |||
  createdPeriod |
Period(PeriodIEHR) | |||
| content |
1..1 | AttachmentIEHR | Content in a format defined elsewhere | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Provenance |
S | 1..1 | Reference(Provenance-IEHR) | Extension URL: http://interopehrate.eu/fhir/StructureDefinition/ProvenanceExtension-IEHR |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| 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. |
| created[x] |
SΣ | 0..1 | When Media was collected | |
| createdDateTime |
dateTime | |||
| createdPeriod |
Period(PeriodIEHR) | |||
| content |
C | 1..1 | AttachmentIEHR | Content in a format defined elsewhere att-1: If the Attachment has data, it SHALL have a contentType attIEHR-1: At least one of data and url SHALL be present |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Media.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| att-1 | error | Media.content | If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() | |
| attIEHR-1 | error | Media.content | At least one of data and url SHALL be present : data.exists() or url.exists() | |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| Provenance |
S | 1..1 | Reference(Provenance-IEHR) | Extension URL: http://interopehrate.eu/fhir/StructureDefinition/ProvenanceExtension-IEHR | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Identifier(s) for the image | ||||
 basedOn |
Σ | 0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created | ||||
| 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. | ||||
| type |
Σ | 0..1 | CodeableConcept | Classification of media as image, video, or audio Binding: MediaType (extensible): Codes for high level media categories. | ||||
| modality |
Σ | 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. | ||||
| 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 |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Group | Device | Specimen | Location) | Who/What this Media is a record of | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter associated with media | ||||
| created[x] |
SΣ | 0..1 | When Media was collected | |||||
| createdDateTime |
dateTime | |||||||
| createdPeriod |
Period(PeriodIEHR) | |||||||
| 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 |
C | 1..1 | AttachmentIEHR | Content in a format defined elsewhere att-1: If the Attachment has data, it SHALL have a contentType attIEHR-1: At least one of data and url SHALL be present | ||||
| note |
0..* | Annotation | Comments made about the media | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Media.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Media.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1from the FHIR Standard | ||||
| Media.type | extensible | MediaTypehttp://hl7.org/fhir/ValueSet/media-typefrom the FHIR Standard | ||||
| Media.modality | example | MediaModalityhttp://hl7.org/fhir/ValueSet/media-modalityfrom the FHIR Standard | ||||
| Media.view | example | MediaCollectionView/Projectionhttp://hl7.org/fhir/ValueSet/media-viewfrom the FHIR Standard | ||||
| Media.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard | ||||
| Media.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| att-1 | error | Media.content | If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() | |
| attIEHR-1 | error | Media.content | At least one of data and url SHALL be present : data.exists() or url.exists() | |
| 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: 1 element
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Media
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Media |
Media | |||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Provenance |
S | 1..1 | Reference(Provenance-IEHR) | Extension URL: http://interopehrate.eu/fhir/StructureDefinition/ProvenanceExtension-IEHR |
| created[x] |
S | 0..1 | When Media was collected | |
| createdDateTime |
dateTime | |||
| createdPeriod |
Period(PeriodIEHR) | |||
| content |
1..1 | AttachmentIEHR | Content in a format defined elsewhere | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Provenance |
S | 1..1 | Reference(Provenance-IEHR) | Extension URL: http://interopehrate.eu/fhir/StructureDefinition/ProvenanceExtension-IEHR |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| 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. |
| created[x] |
SΣ | 0..1 | When Media was collected | |
| createdDateTime |
dateTime | |||
| createdPeriod |
Period(PeriodIEHR) | |||
| content |
C | 1..1 | AttachmentIEHR | Content in a format defined elsewhere att-1: If the Attachment has data, it SHALL have a contentType attIEHR-1: At least one of data and url SHALL be present |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Media.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| att-1 | error | Media.content | If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() | |
| attIEHR-1 | error | Media.content | At least one of data and url SHALL be present : data.exists() or url.exists() | |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| Provenance |
S | 1..1 | Reference(Provenance-IEHR) | Extension URL: http://interopehrate.eu/fhir/StructureDefinition/ProvenanceExtension-IEHR | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Identifier(s) for the image | ||||
| basedOn |
Σ | 0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created | ||||
| 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. | ||||
| type |
Σ | 0..1 | CodeableConcept | Classification of media as image, video, or audio Binding: MediaType (extensible): Codes for high level media categories. | ||||
| modality |
Σ | 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. | ||||
| 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 |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Group | Device | Specimen | Location) | Who/What this Media is a record of | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter associated with media | ||||
| created[x] |
SΣ | 0..1 | When Media was collected | |||||
| createdDateTime |
dateTime | |||||||
| createdPeriod |
Period(PeriodIEHR) | |||||||
| 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 |
C | 1..1 | AttachmentIEHR | Content in a format defined elsewhere att-1: If the Attachment has data, it SHALL have a contentType attIEHR-1: At least one of data and url SHALL be present | ||||
| note |
0..* | Annotation | Comments made about the media | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Media.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Media.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1from the FHIR Standard | ||||
| Media.type | extensible | MediaTypehttp://hl7.org/fhir/ValueSet/media-typefrom the FHIR Standard | ||||
| Media.modality | example | MediaModalityhttp://hl7.org/fhir/ValueSet/media-modalityfrom the FHIR Standard | ||||
| Media.view | example | MediaCollectionView/Projectionhttp://hl7.org/fhir/ValueSet/media-viewfrom the FHIR Standard | ||||
| Media.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard | ||||
| Media.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| att-1 | error | Media.content | If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() | |
| attIEHR-1 | error | Media.content | At least one of data and url SHALL be present : data.exists() or url.exists() | |
| 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: 1 element
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron