OpenEHR Base package
0.1.0 - First Draft
OpenEHR Base package
0.1.0 - First Draft
OpenEHR Base package, published by openEHR + HL7. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/openehr-fhir/base-spec/ and changes regularly. See the Directory of published versions
| Page standards status: Informative | Maturity Level: 3 |
Definitions for the DV-MULTIMEDIA logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. DV_MULTIMEDIA | |
| Definition | A specialisation of Base definition for all types defined in FHIR type system. |
| Short | A specialisation of `DV_ENCAPSULATED` for audiovisual and bio-signal types.Base for all types and resources |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Invariants | Size_valid: Size valid must satisfy range constraints (size() >= 0)Not_empty: Not empty ( is_inline() or is_external())Integrity_check_validity: Integrity check validity must be present ( integrity_check.exists() implies integrity_check_algorithm.exists()) |
| 2. DV_MULTIMEDIA.CR | |
| Definition | Carriage return character. |
| Short | Carriage return character. |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. DV_MULTIMEDIA.LF | |
| Definition | Line feed character. |
| Short | Line feed character. |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. DV_MULTIMEDIA.Local-terminology-id | |
| Definition | Predefined terminology identifier to indicate it is local to the knowledge resource in which it occurs, e.g. an archetype |
| Short | Predefined terminology identifier |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. DV_MULTIMEDIA.charset | |
| Definition | Name of character encoding scheme in which this value is encoded. Coded from openEHR Code Set character sets . Unicode is the default assumption in openEHR, with UTF-8 being the assumed encoding. This attribute allows for variations from these assumptions. |
| Short | Name of character encoding scheme in which this value is encoded. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
| 10. DV_MULTIMEDIA.language | |
| Definition | Optional indicator of the localised language in which the data is written, if relevant. Coded from openEHR Code Set |
| Short | Optional indicator of the localised language in which the data is written, if relevant. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
| 12. DV_MULTIMEDIA.alternate-text | |
| Definition | Text to display in lieu of multimedia display/replay. |
| Short | Text to display in lieu of multimedia display/replay. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. DV_MULTIMEDIA.uri | |
| Definition | URI reference to electronic information stored outside the record as a file, database entry etc, if supplied as a reference. |
| Short | URI reference to electronic information stored outside the record as a file, database entry etc, if supplied as a reference. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DV-URI |
| Is Modifier | false |
| 16. DV_MULTIMEDIA.data | |
| Definition | The actual data found at |
| Short | The actual data found at `_uri_`, if supplied inline. |
| Control | 0..* |
| Type | base64Binary |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. DV_MULTIMEDIA.media-type | |
| Definition | Data media type coded from openEHR code set media types (interface for the IANA MIME types code set). |
| Short | Data media type coded from openEHR code set media types (interface for the IANA MIME types code set). |
| Control | 1..1 |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
| 20. DV_MULTIMEDIA.compression-algorithm | |
| Definition | Compression type, a coded value from the openEHR Integrity check code set. Void means no compression. |
| Short | Compression type, a coded value from the openEHR Integrity check code set. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
| 22. DV_MULTIMEDIA.integrity-check | |
| Definition | Binary cryptographic integrity checksum. |
| Short | Binary cryptographic integrity checksum. |
| Control | 0..* |
| Type | base64Binary |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. DV_MULTIMEDIA.integrity-check-algorithm | |
| Definition | Type of integrity check, a coded value from the openEHR |
| Short | Type of integrity check, a coded value from the openEHR `Integrity check` code set. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
| 26. DV_MULTIMEDIA.thumbnail | |
| Definition | The thumbnail for this item, if one exists; mainly for graphics formats. |
| Short | The thumbnail for this item, if one exists; mainly for graphics formats. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DV-MULTIMEDIA |
| Is Modifier | false |
| 28. DV_MULTIMEDIA.size | |
| Definition | Original size in bytes of unencoded encapsulated data. I.e. encodings such as base64, hexadecimal etc do not change the value of this attribute. |
| Short | Original size in bytes of unencoded encapsulated data. |
| Control | 1..1 |
| Type | integer |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be foundhere
| 0. DV_MULTIMEDIA | |
| Definition | A specialisation of |
| Short | A specialisation of `DV_ENCAPSULATED` for audiovisual and bio-signal types. |
| Control | 0..* |
| Binding | The codes SHALL be taken from Integrity check algorithms (required to https://specifications.openehr.org/fhir/valueset-integrity_check_algorithms) |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Invariants | Not_empty: Not empty (is_inline() or is_external())Integrity_check_validity: Integrity check validity must be present ( integrity_check.exists() implies integrity_check_algorithm.exists())Size_valid: Size valid must satisfy range constraints ( null # TODO: manual translation needed) |
| 2. DV_MULTIMEDIA.alternate-text | |
| Definition | Text to display in lieu of multimedia display/replay. |
| Short | Text to display in lieu of multimedia display/replay. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. DV_MULTIMEDIA.uri | |
| Definition | URI reference to electronic information stored outside the record as a file, database entry etc, if supplied as a reference. |
| Short | URI reference to electronic information stored outside the record as a file, database entry etc, if supplied as a reference. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DV-URI |
| Is Modifier | false |
| 6. DV_MULTIMEDIA.data | |
| Definition | The actual data found at |
| Short | The actual data found at `_uri_`, if supplied inline. |
| Control | 0..* |
| Type | base64Binary |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. DV_MULTIMEDIA.media-type | |
| Definition | Data media type coded from openEHR code set media types (interface for the IANA MIME types code set). |
| Short | Data media type coded from openEHR code set media types (interface for the IANA MIME types code set). |
| Control | 1..1 |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
| 10. DV_MULTIMEDIA.compression-algorithm | |
| Definition | Compression type, a coded value from the openEHR Integrity check code set. Void means no compression. |
| Short | Compression type, a coded value from the openEHR Integrity check code set. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
| 12. DV_MULTIMEDIA.integrity-check | |
| Definition | Binary cryptographic integrity checksum. |
| Short | Binary cryptographic integrity checksum. |
| Control | 0..* |
| Type | base64Binary |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. DV_MULTIMEDIA.integrity-check-algorithm | |
| Definition | Type of integrity check, a coded value from the openEHR |
| Short | Type of integrity check, a coded value from the openEHR `Integrity check` code set. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
| 16. DV_MULTIMEDIA.thumbnail | |
| Definition | The thumbnail for this item, if one exists; mainly for graphics formats. |
| Short | The thumbnail for this item, if one exists; mainly for graphics formats. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DV-MULTIMEDIA |
| Is Modifier | false |
| 18. DV_MULTIMEDIA.size | |
| Definition | Original size in bytes of unencoded encapsulated data. I.e. encodings such as base64, hexadecimal etc do not change the value of this attribute. |
| Short | Original size in bytes of unencoded encapsulated data. |
| Control | 1..1 |
| Type | integer |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be foundhere
| 0. DV_MULTIMEDIA | |
| Definition | A specialisation of |
| Short | A specialisation of `DV_ENCAPSULATED` for audiovisual and bio-signal types. |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Invariants | Size_valid: Size valid must satisfy range constraints (size() >= 0)Not_empty: Not empty ( is_inline() or is_external())Integrity_check_validity: Integrity check validity must be present ( integrity_check.exists() implies integrity_check_algorithm.exists()) |
| 2. DV_MULTIMEDIA.CR | |
| Definition | Carriage return character. |
| Short | Carriage return character. |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. DV_MULTIMEDIA.LF | |
| Definition | Line feed character. |
| Short | Line feed character. |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. DV_MULTIMEDIA.Local-terminology-id | |
| Definition | Predefined terminology identifier to indicate it is local to the knowledge resource in which it occurs, e.g. an archetype |
| Short | Predefined terminology identifier |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. DV_MULTIMEDIA.charset | |
| Definition | Name of character encoding scheme in which this value is encoded. Coded from openEHR Code Set character sets . Unicode is the default assumption in openEHR, with UTF-8 being the assumed encoding. This attribute allows for variations from these assumptions. |
| Short | Name of character encoding scheme in which this value is encoded. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
| 10. DV_MULTIMEDIA.language | |
| Definition | Optional indicator of the localised language in which the data is written, if relevant. Coded from openEHR Code Set |
| Short | Optional indicator of the localised language in which the data is written, if relevant. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
| 12. DV_MULTIMEDIA.alternate-text | |
| Definition | Text to display in lieu of multimedia display/replay. |
| Short | Text to display in lieu of multimedia display/replay. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. DV_MULTIMEDIA.uri | |
| Definition | URI reference to electronic information stored outside the record as a file, database entry etc, if supplied as a reference. |
| Short | URI reference to electronic information stored outside the record as a file, database entry etc, if supplied as a reference. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DV-URI |
| Is Modifier | false |
| 16. DV_MULTIMEDIA.data | |
| Definition | The actual data found at |
| Short | The actual data found at `_uri_`, if supplied inline. |
| Control | 0..* |
| Type | base64Binary |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. DV_MULTIMEDIA.media-type | |
| Definition | Data media type coded from openEHR code set media types (interface for the IANA MIME types code set). |
| Short | Data media type coded from openEHR code set media types (interface for the IANA MIME types code set). |
| Control | 1..1 |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
| 20. DV_MULTIMEDIA.compression-algorithm | |
| Definition | Compression type, a coded value from the openEHR Integrity check code set. Void means no compression. |
| Short | Compression type, a coded value from the openEHR Integrity check code set. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
| 22. DV_MULTIMEDIA.integrity-check | |
| Definition | Binary cryptographic integrity checksum. |
| Short | Binary cryptographic integrity checksum. |
| Control | 0..* |
| Type | base64Binary |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. DV_MULTIMEDIA.integrity-check-algorithm | |
| Definition | Type of integrity check, a coded value from the openEHR |
| Short | Type of integrity check, a coded value from the openEHR `Integrity check` code set. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Is Modifier | false |
| 26. DV_MULTIMEDIA.thumbnail | |
| Definition | The thumbnail for this item, if one exists; mainly for graphics formats. |
| Short | The thumbnail for this item, if one exists; mainly for graphics formats. |
| Control | 0..1 |
| Type | http://openehr.org/fhir/StructureDefinition/DV-MULTIMEDIA |
| Is Modifier | false |
| 28. DV_MULTIMEDIA.size | |
| Definition | Original size in bytes of unencoded encapsulated data. I.e. encodings such as base64, hexadecimal etc do not change the value of this attribute. |
| Short | Original size in bytes of unencoded encapsulated data. |
| Control | 1..1 |
| Type | integer |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |