HL7 Czech Imaging Report IG
0.1.0-ballot - ci-build
HL7 Czech Imaging Report IG, published by HL7 Czech Republic. This guide is not an authorized publication; it is the continuous build for version 0.1.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-cz/img/ and changes regularly. See the Directory of published versions
Page standards status: Draft | Maturity Level: 1 |
Definitions for the KeyImagesAttachment logical model.
Guidance on how to interpret the contents of this table can be foundhere
0. KeyImagesAttachment | |
Definition | Imaging Report - Imaging Report media (attachments) - A.2.6 Key images related to this report. |
Short | A.2.6 - Media (attachments) |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. KeyImagesAttachment.created | |
Definition | Date and time of creation or the period during which the media was created. |
Short | A.2.6.1 - Date and time of creation |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
4. KeyImagesAttachment.issued | |
Definition | Date and time when this resource was made available. |
Short | A.2.6.2 - Date and time of issuance |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
6. KeyImagesAttachment.author | |
Definition | Person who created the image. |
Short | A.2.6.3 - Created by |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
8. KeyImagesAttachment.author.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
10. KeyImagesAttachment.author.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on KeyImagesAttachment.author.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
12. KeyImagesAttachment.author.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
14. KeyImagesAttachment.author.identifier | |
Definition | The health professional identifier that will allow addressing recipients within a national or international data exchange infrastructure, such as the licence or registration number. In case when the recipient is not a health professional, e.g. patient, appropriate personal identifier should be used. |
Short | A.2.6.3.1 - Author identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
16. KeyImagesAttachment.author.name | |
Definition | Person name [the structure of the name will be the same as for the patient (given name, family name / surname)]. |
Short | A.2.6.3.2 - Author name |
Control | 1..1 |
Type | HumanName |
18. KeyImagesAttachment.author.organizationID | |
Definition | The healthcare provider organisation identifier. Identifier that is unique within a defined scope. Example: National healthcare provider ID. Multiple identifiers could be provided. |
Short | A.2.6.3.3 - Author organisation ID |
Control | 0..* |
Type | Identifier |
20. KeyImagesAttachment.author.organization | |
Definition | The healthcare provider organisation information. |
Short | A.2.6.3.4 - Author organisation |
Control | 1..1 |
Type | BackboneElement |
22. KeyImagesAttachment.author.dateTime | |
Definition | Date and time of the last modification of the document by its Author. |
Short | A.2.6.3.5 - Date Time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
24. KeyImagesAttachment.bodyPart | |
Definition | Observed body part. |
Short | A.2.6.4 - Body part |
Control | 0..1 |
Type | CodeableConcept |
26. KeyImagesAttachment.mediaHeight | |
Definition | Image height in pixels (photo/video). |
Short | A.2.6.5 - Media height |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
28. KeyImagesAttachment.mediaWidth | |
Definition | Image width in pixels (photo/video). |
Short | A.2.6.6 - Media width |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
30. KeyImagesAttachment.mediaFrames | |
Definition | Number of frames in a photo, video, or PDF. |
Short | A.2.6.7 - Media frames |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
32. KeyImagesAttachment.recordingDuration | |
Definition | Duration of the recording in seconds - for audio and video. |
Short | A.2.6.8 - Recording duration |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
34. KeyImagesAttachment.attachment | |
Definition | Directly embedded data or a link to the attachment's data source. |
Short | A.2.6.9 - Attachment |
Control | 1..1 |
Type | Attachment |
36. KeyImagesAttachment.note | |
Definition | Contains free text, its author, and the date and time of its creation. |
Short | A.2.6.10 - Note |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
38. KeyImagesAttachment.view | |
Definition | Projection name, e.g., lateral or anteroposterior (AP). - Preferred system(s): SNOMED CT [ViewProjectionCodelist] |
Short | A.2.6.11 - View |
Control | 0..1 |
Type | CodeableConcept |
40. KeyImagesAttachment.modality | |
Definition | Type of acquisition device/process. - Preferred system(s): DICOM [AcquisitionModalityCodelist] |
Short | A.2.6.12 - Modality |
Control | 0..1 |
Type | CodeableConcept |
42. KeyImagesAttachment.device | |
Definition | Device used to collect the media. |
Short | A.2.6.13 - Device |
Control | 0..1 |
Type | CodeableConcept |
44. KeyImagesAttachment.mediaType | |
Definition | Classification of the media, e.g., image, video, or audio. - Preferred system(s): http://terminology.hl7.org/CodeSystem/media-category ValueList: image | video | audio |
Short | A.2.6.14 - Media type |
Control | 0..1 |
Type | CodeableConcept |
Guidance on how to interpret the contents of this table can be foundhere
0. KeyImagesAttachment | |
Definition | Imaging Report - Imaging Report media (attachments) - A.2.6 Key images related to this report. |
Short | A.2.6 - Media (attachments) |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. KeyImagesAttachment.created | |
Definition | Date and time of creation or the period during which the media was created. |
Short | A.2.6.1 - Date and time of creation |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
4. KeyImagesAttachment.issued | |
Definition | Date and time when this resource was made available. |
Short | A.2.6.2 - Date and time of issuance |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
6. KeyImagesAttachment.author | |
Definition | Person who created the image. |
Short | A.2.6.3 - Created by |
Control | 0..1 |
Type | BackboneElement |
8. KeyImagesAttachment.author.identifier | |
Definition | The health professional identifier that will allow addressing recipients within a national or international data exchange infrastructure, such as the licence or registration number. In case when the recipient is not a health professional, e.g. patient, appropriate personal identifier should be used. |
Short | A.2.6.3.1 - Author identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
10. KeyImagesAttachment.author.name | |
Definition | Person name [the structure of the name will be the same as for the patient (given name, family name / surname)]. |
Short | A.2.6.3.2 - Author name |
Control | 1..1 |
Type | HumanName |
12. KeyImagesAttachment.author.organizationID | |
Definition | The healthcare provider organisation identifier. Identifier that is unique within a defined scope. Example: National healthcare provider ID. Multiple identifiers could be provided. |
Short | A.2.6.3.3 - Author organisation ID |
Control | 0..* |
Type | Identifier |
14. KeyImagesAttachment.author.organization | |
Definition | The healthcare provider organisation information. |
Short | A.2.6.3.4 - Author organisation |
Control | 1..1 |
Type | BackboneElement |
16. KeyImagesAttachment.author.dateTime | |
Definition | Date and time of the last modification of the document by its Author. |
Short | A.2.6.3.5 - Date Time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
18. KeyImagesAttachment.bodyPart | |
Definition | Observed body part. |
Short | A.2.6.4 - Body part |
Control | 0..1 |
Type | CodeableConcept |
20. KeyImagesAttachment.mediaHeight | |
Definition | Image height in pixels (photo/video). |
Short | A.2.6.5 - Media height |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
22. KeyImagesAttachment.mediaWidth | |
Definition | Image width in pixels (photo/video). |
Short | A.2.6.6 - Media width |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
24. KeyImagesAttachment.mediaFrames | |
Definition | Number of frames in a photo, video, or PDF. |
Short | A.2.6.7 - Media frames |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
26. KeyImagesAttachment.recordingDuration | |
Definition | Duration of the recording in seconds - for audio and video. |
Short | A.2.6.8 - Recording duration |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
28. KeyImagesAttachment.attachment | |
Definition | Directly embedded data or a link to the attachment's data source. |
Short | A.2.6.9 - Attachment |
Control | 1..1 |
Type | Attachment |
30. KeyImagesAttachment.note | |
Definition | Contains free text, its author, and the date and time of its creation. |
Short | A.2.6.10 - Note |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
32. KeyImagesAttachment.view | |
Definition | Projection name, e.g., lateral or anteroposterior (AP). - Preferred system(s): SNOMED CT [ViewProjectionCodelist] |
Short | A.2.6.11 - View |
Control | 0..1 |
Type | CodeableConcept |
34. KeyImagesAttachment.modality | |
Definition | Type of acquisition device/process. - Preferred system(s): DICOM [AcquisitionModalityCodelist] |
Short | A.2.6.12 - Modality |
Control | 0..1 |
Type | CodeableConcept |
36. KeyImagesAttachment.device | |
Definition | Device used to collect the media. |
Short | A.2.6.13 - Device |
Control | 0..1 |
Type | CodeableConcept |
38. KeyImagesAttachment.mediaType | |
Definition | Classification of the media, e.g., image, video, or audio. - Preferred system(s): http://terminology.hl7.org/CodeSystem/media-category ValueList: image | video | audio |
Short | A.2.6.14 - Media type |
Control | 0..1 |
Type | CodeableConcept |
Guidance on how to interpret the contents of this table can be foundhere
0. KeyImagesAttachment | |
Definition | Imaging Report - Imaging Report media (attachments) - A.2.6 Key images related to this report. |
Short | A.2.6 - Media (attachments) |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. KeyImagesAttachment.created | |
Definition | Date and time of creation or the period during which the media was created. |
Short | A.2.6.1 - Date and time of creation |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
4. KeyImagesAttachment.issued | |
Definition | Date and time when this resource was made available. |
Short | A.2.6.2 - Date and time of issuance |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
6. KeyImagesAttachment.author | |
Definition | Person who created the image. |
Short | A.2.6.3 - Created by |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
8. KeyImagesAttachment.author.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
10. KeyImagesAttachment.author.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on KeyImagesAttachment.author.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
12. KeyImagesAttachment.author.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
14. KeyImagesAttachment.author.identifier | |
Definition | The health professional identifier that will allow addressing recipients within a national or international data exchange infrastructure, such as the licence or registration number. In case when the recipient is not a health professional, e.g. patient, appropriate personal identifier should be used. |
Short | A.2.6.3.1 - Author identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
16. KeyImagesAttachment.author.name | |
Definition | Person name [the structure of the name will be the same as for the patient (given name, family name / surname)]. |
Short | A.2.6.3.2 - Author name |
Control | 1..1 |
Type | HumanName |
18. KeyImagesAttachment.author.organizationID | |
Definition | The healthcare provider organisation identifier. Identifier that is unique within a defined scope. Example: National healthcare provider ID. Multiple identifiers could be provided. |
Short | A.2.6.3.3 - Author organisation ID |
Control | 0..* |
Type | Identifier |
20. KeyImagesAttachment.author.organization | |
Definition | The healthcare provider organisation information. |
Short | A.2.6.3.4 - Author organisation |
Control | 1..1 |
Type | BackboneElement |
22. KeyImagesAttachment.author.dateTime | |
Definition | Date and time of the last modification of the document by its Author. |
Short | A.2.6.3.5 - Date Time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
24. KeyImagesAttachment.bodyPart | |
Definition | Observed body part. |
Short | A.2.6.4 - Body part |
Control | 0..1 |
Type | CodeableConcept |
26. KeyImagesAttachment.mediaHeight | |
Definition | Image height in pixels (photo/video). |
Short | A.2.6.5 - Media height |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
28. KeyImagesAttachment.mediaWidth | |
Definition | Image width in pixels (photo/video). |
Short | A.2.6.6 - Media width |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
30. KeyImagesAttachment.mediaFrames | |
Definition | Number of frames in a photo, video, or PDF. |
Short | A.2.6.7 - Media frames |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
32. KeyImagesAttachment.recordingDuration | |
Definition | Duration of the recording in seconds - for audio and video. |
Short | A.2.6.8 - Recording duration |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
34. KeyImagesAttachment.attachment | |
Definition | Directly embedded data or a link to the attachment's data source. |
Short | A.2.6.9 - Attachment |
Control | 1..1 |
Type | Attachment |
36. KeyImagesAttachment.note | |
Definition | Contains free text, its author, and the date and time of its creation. |
Short | A.2.6.10 - Note |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
38. KeyImagesAttachment.view | |
Definition | Projection name, e.g., lateral or anteroposterior (AP). - Preferred system(s): SNOMED CT [ViewProjectionCodelist] |
Short | A.2.6.11 - View |
Control | 0..1 |
Type | CodeableConcept |
40. KeyImagesAttachment.modality | |
Definition | Type of acquisition device/process. - Preferred system(s): DICOM [AcquisitionModalityCodelist] |
Short | A.2.6.12 - Modality |
Control | 0..1 |
Type | CodeableConcept |
42. KeyImagesAttachment.device | |
Definition | Device used to collect the media. |
Short | A.2.6.13 - Device |
Control | 0..1 |
Type | CodeableConcept |
44. KeyImagesAttachment.mediaType | |
Definition | Classification of the media, e.g., image, video, or audio. - Preferred system(s): http://terminology.hl7.org/CodeSystem/media-category ValueList: image | video | audio |
Short | A.2.6.14 - Media type |
Control | 0..1 |
Type | CodeableConcept |