HL7 Czech Imaging Report IG
0.1.0-ballot - ci-build Czechia flag

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

Logical Model: KeyImagesAttachmentCz - Detailed Descriptions

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.

ShortA.2.6 - Media (attachments)
Control0..*
Is Modifierfalse
Logical ModelInstances 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.

ShortA.2.6.1 - Date and time of creation
Control0..1
TypedateTime
Primitive ValueThis 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.

ShortA.2.6.2 - Date and time of issuance
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. KeyImagesAttachment.author
Definition

Person who created the image.

ShortA.2.6.3 - Created by
Control0..1
TypeBackboneElement
Invariantsele-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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on KeyImagesAttachment.author.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 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).

    ShortExtensions 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.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    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 Namesextensions, user content, modifiers
    Invariantsele-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.

    ShortA.2.6.3.1 - Author identifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..*
    TypeIdentifier
    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)].

    ShortA.2.6.3.2 - Author name
    Control1..1
    TypeHumanName
    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.

    ShortA.2.6.3.3 - Author organisation ID
    Control0..*
    TypeIdentifier
    20. KeyImagesAttachment.author.organization
    Definition

    The healthcare provider organisation information.

    ShortA.2.6.3.4 - Author organisation
    Control1..1
    TypeBackboneElement
    22. KeyImagesAttachment.author.dateTime
    Definition

    Date and time of the last modification of the document by its Author.

    ShortA.2.6.3.5 - Date Time
    Control1..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    24. KeyImagesAttachment.bodyPart
    Definition

    Observed body part.

    ShortA.2.6.4 - Body part
    Control0..1
    TypeCodeableConcept
    26. KeyImagesAttachment.mediaHeight
    Definition

    Image height in pixels (photo/video).

    ShortA.2.6.5 - Media height
    Control0..1
    Typeinteger
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    28. KeyImagesAttachment.mediaWidth
    Definition

    Image width in pixels (photo/video).

    ShortA.2.6.6 - Media width
    Control0..1
    Typeinteger
    Primitive ValueThis 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.

    ShortA.2.6.7 - Media frames
    Control0..1
    Typeinteger
    Primitive ValueThis 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.

    ShortA.2.6.8 - Recording duration
    Control0..1
    TypedateTime
    Primitive ValueThis 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.

    ShortA.2.6.9 - Attachment
    Control1..1
    TypeAttachment
    36. KeyImagesAttachment.note
    Definition

    Contains free text, its author, and the date and time of its creation.

    ShortA.2.6.10 - Note
    Control0..1
    Typestring
    Primitive ValueThis 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]

    ShortA.2.6.11 - View
    Control0..1
    TypeCodeableConcept
    40. KeyImagesAttachment.modality
    Definition

    Type of acquisition device/process. - Preferred system(s): DICOM [AcquisitionModalityCodelist]

    ShortA.2.6.12 - Modality
    Control0..1
    TypeCodeableConcept
    42. KeyImagesAttachment.device
    Definition

    Device used to collect the media.

    ShortA.2.6.13 - Device
    Control0..1
    TypeCodeableConcept
    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

    ShortA.2.6.14 - Media type
    Control0..1
    TypeCodeableConcept

    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.

    ShortA.2.6 - Media (attachments)
    Logical ModelInstances 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.

    ShortA.2.6.1 - Date and time of creation
    Control0..1
    TypedateTime
    Primitive ValueThis 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.

    ShortA.2.6.2 - Date and time of issuance
    Control0..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    6. KeyImagesAttachment.author
    Definition

    Person who created the image.

    ShortA.2.6.3 - Created by
    Control0..1
    TypeBackboneElement
    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.

    ShortA.2.6.3.1 - Author identifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..*
    TypeIdentifier
    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)].

    ShortA.2.6.3.2 - Author name
    Control1..1
    TypeHumanName
    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.

    ShortA.2.6.3.3 - Author organisation ID
    Control0..*
    TypeIdentifier
    14. KeyImagesAttachment.author.organization
    Definition

    The healthcare provider organisation information.

    ShortA.2.6.3.4 - Author organisation
    Control1..1
    TypeBackboneElement
    16. KeyImagesAttachment.author.dateTime
    Definition

    Date and time of the last modification of the document by its Author.

    ShortA.2.6.3.5 - Date Time
    Control1..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    18. KeyImagesAttachment.bodyPart
    Definition

    Observed body part.

    ShortA.2.6.4 - Body part
    Control0..1
    TypeCodeableConcept
    20. KeyImagesAttachment.mediaHeight
    Definition

    Image height in pixels (photo/video).

    ShortA.2.6.5 - Media height
    Control0..1
    Typeinteger
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    22. KeyImagesAttachment.mediaWidth
    Definition

    Image width in pixels (photo/video).

    ShortA.2.6.6 - Media width
    Control0..1
    Typeinteger
    Primitive ValueThis 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.

    ShortA.2.6.7 - Media frames
    Control0..1
    Typeinteger
    Primitive ValueThis 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.

    ShortA.2.6.8 - Recording duration
    Control0..1
    TypedateTime
    Primitive ValueThis 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.

    ShortA.2.6.9 - Attachment
    Control1..1
    TypeAttachment
    30. KeyImagesAttachment.note
    Definition

    Contains free text, its author, and the date and time of its creation.

    ShortA.2.6.10 - Note
    Control0..1
    Typestring
    Primitive ValueThis 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]

    ShortA.2.6.11 - View
    Control0..1
    TypeCodeableConcept
    34. KeyImagesAttachment.modality
    Definition

    Type of acquisition device/process. - Preferred system(s): DICOM [AcquisitionModalityCodelist]

    ShortA.2.6.12 - Modality
    Control0..1
    TypeCodeableConcept
    36. KeyImagesAttachment.device
    Definition

    Device used to collect the media.

    ShortA.2.6.13 - Device
    Control0..1
    TypeCodeableConcept
    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

    ShortA.2.6.14 - Media type
    Control0..1
    TypeCodeableConcept

    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.

    ShortA.2.6 - Media (attachments)
    Control0..*
    Is Modifierfalse
    Logical ModelInstances 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.

    ShortA.2.6.1 - Date and time of creation
    Control0..1
    TypedateTime
    Primitive ValueThis 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.

    ShortA.2.6.2 - Date and time of issuance
    Control0..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    6. KeyImagesAttachment.author
    Definition

    Person who created the image.

    ShortA.2.6.3 - Created by
    Control0..1
    TypeBackboneElement
    Invariantsele-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.

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    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.

    ShortAdditional 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.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-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())
    SlicingThis element introduces a set of slices on KeyImagesAttachment.author.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 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).

      ShortExtensions 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.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      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 Namesextensions, user content, modifiers
      Invariantsele-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.

      ShortA.2.6.3.1 - Author identifier
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control1..*
      TypeIdentifier
      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)].

      ShortA.2.6.3.2 - Author name
      Control1..1
      TypeHumanName
      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.

      ShortA.2.6.3.3 - Author organisation ID
      Control0..*
      TypeIdentifier
      20. KeyImagesAttachment.author.organization
      Definition

      The healthcare provider organisation information.

      ShortA.2.6.3.4 - Author organisation
      Control1..1
      TypeBackboneElement
      22. KeyImagesAttachment.author.dateTime
      Definition

      Date and time of the last modification of the document by its Author.

      ShortA.2.6.3.5 - Date Time
      Control1..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      24. KeyImagesAttachment.bodyPart
      Definition

      Observed body part.

      ShortA.2.6.4 - Body part
      Control0..1
      TypeCodeableConcept
      26. KeyImagesAttachment.mediaHeight
      Definition

      Image height in pixels (photo/video).

      ShortA.2.6.5 - Media height
      Control0..1
      Typeinteger
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      28. KeyImagesAttachment.mediaWidth
      Definition

      Image width in pixels (photo/video).

      ShortA.2.6.6 - Media width
      Control0..1
      Typeinteger
      Primitive ValueThis 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.

      ShortA.2.6.7 - Media frames
      Control0..1
      Typeinteger
      Primitive ValueThis 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.

      ShortA.2.6.8 - Recording duration
      Control0..1
      TypedateTime
      Primitive ValueThis 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.

      ShortA.2.6.9 - Attachment
      Control1..1
      TypeAttachment
      36. KeyImagesAttachment.note
      Definition

      Contains free text, its author, and the date and time of its creation.

      ShortA.2.6.10 - Note
      Control0..1
      Typestring
      Primitive ValueThis 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]

      ShortA.2.6.11 - View
      Control0..1
      TypeCodeableConcept
      40. KeyImagesAttachment.modality
      Definition

      Type of acquisition device/process. - Preferred system(s): DICOM [AcquisitionModalityCodelist]

      ShortA.2.6.12 - Modality
      Control0..1
      TypeCodeableConcept
      42. KeyImagesAttachment.device
      Definition

      Device used to collect the media.

      ShortA.2.6.13 - Device
      Control0..1
      TypeCodeableConcept
      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

      ShortA.2.6.14 - Media type
      Control0..1
      TypeCodeableConcept