HL7 CZ Laboratory IG
0.5.0 - ci-build Czechia flag

HL7 CZ Laboratory IG, published by HL7 Czech Republic. This guide is not an authorized publication; it is the continuous build for version 0.5.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-cz/cz-lab/ and changes regularly. See the Directory of published versions

Resource Profile: CZ_AttachmentObligationsLab - Detailed Descriptions

Draft as of 2025-12-10

Definitions for the cz-attachment-obl-lab resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. Media
Definition

Lab Report attachment.


A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.

ShortLab Report attachmentA photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Media.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Media.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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
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 resource that contains them
Summaryfalse
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
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())
6. Media.status
Definition

The current state of the {{title}}.

Shortpreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Comments

A nominal state-transition diagram can be found in the [[event.html#statemachine | Event pattern]] documentation

Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

Control1..1
BindingThe codes SHALL be taken from EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1
(required to http://hl7.org/fhir/ValueSet/event-status|4.0.1)

Codes identifying the lifecycle stage of an event.

Typecode
Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Media.content
Definition

The actual content of the media - inline or by direct reference to the media source file.

ShortActual Media - reference or data
Comments

Recommended content types: image/jpeg, image/png, image/tiff, video/mpeg, audio/mp4, application/dicom. Application/dicom can contain the transfer syntax as a parameter. For media that covers a period of time (video/sound), the content.creationTime is the end time. Creation time is used for tracking, organizing versions and searching.

Control1..1
TypeAttachment
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Media.content.contentType
Definition

Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

ShortMime type of the content, with charset etc.
Control0..1
BindingThe codes SHALL be taken from Mime Typeshttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1
(required to http://hl7.org/fhir/ValueSet/mimetypes|4.0.1)

The mime type of an attachment. Any valid mime type is allowed.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Obligations
    ObligationsActor
    SHOULD:able-to-populateCreator_L2
    SHALL:able-to-populateCreator_L3
    SHOULD:displayConsumer_L2
    SHALL:displayConsumer_L3
    Summarytrue
    Requirements

    Processors of the data need to be able to know how to interpret the data.

    ExampleGeneral: text/plain; charset=UTF-8, image/png
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. Media.content.language
    Definition

    The human language of the content. The value can be any valid value according to BCP 47.

    ShortHuman language of the content (BCP-47)
    Control0..1
    BindingThe codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1
    (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

    A human language.

    Additional BindingsPurpose
    AllLanguagesMax Binding
    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Obligations
      ObligationsActor
      SHOULD:able-to-populateCreator_L2
      SHALL:able-to-populateCreator_L3
      SHOULD:displayConsumer_L2
      SHALL:displayConsumer_L3
      Summarytrue
      Requirements

      Users need to be able to choose between the languages in a set of attachments.

      ExampleGeneral: en-AU
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      14. Media.content.data
      Definition

      The actual data of the attachment - a sequence of bytes, base64 encoded.

      ShortData inline, base64ed
      Comments

      The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

      Control0..1
      Typebase64Binary
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Obligations
        ObligationsActor
        SHOULD:able-to-populateCreator_L2
        SHALL:able-to-populateCreator_L3
        SHOULD:displayConsumer_L2
        SHALL:displayConsumer_L3
        Summaryfalse
        Requirements

        The data needs to able to be transmitted inline.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        16. Media.content.url
        Definition

        A location where the data can be accessed.

        ShortUri where the data can be found
        Comments

        If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.

        Control0..1
        Typeurl
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Obligations
          ObligationsActor
          SHOULD:able-to-populateCreator_L2
          SHALL:able-to-populateCreator_L3
          SHOULD:displayConsumer_L2
          SHALL:displayConsumer_L3
          Summarytrue
          Requirements

          The data needs to be transmitted by reference.

          ExampleGeneral: http://www.acme.com/logo-small.png
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          18. Media.content.size
          Definition

          The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

          ShortNumber of bytes of content (if url provided)
          Comments

          The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.

          Control0..1
          TypeunsignedInt
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Obligations
            ObligationsActor
            SHOULD:populate-if-knownCreator_L2
            SHALL:populate-if-knownCreator_L3
            SHOULD:displayConsumer_L2
            SHALL:displayConsumer_L3
            Summarytrue
            Requirements

            Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            20. Media.content.hash
            Definition

            The calculated hash of the data using SHA-1. Represented using base64.

            ShortHash of the data (sha-1, base64ed)
            Comments

            The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.


            The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.

            Control0..1
            Typebase64Binary
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Obligations
              ObligationsActor
              SHOULD:populate-if-knownCreator_L2
              SHALL:populate-if-knownCreator_L3
              SHOULD:displayConsumer_L2
              SHALL:displayConsumer_L3
              Summarytrue
              Requirements

              Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              22. Media.content.title
              Definition

              A label or set of text to display in place of the data.

              ShortLabel to display in place of the data
              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Obligations
                ObligationsActor
                SHOULD:able-to-populateCreator_L2
                SHALL:able-to-populateCreator_L3
                SHOULD:displayConsumer_L2
                SHALL:displayConsumer_L3
                Summarytrue
                Requirements

                Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.

                ExampleGeneral: Official Corporate Logo
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                24. Media.content.creation
                Definition

                The date that the attachment was first created.

                ShortDate attachment was first created
                Control0..1
                TypedateTime
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Obligations
                  ObligationsActor
                  SHOULD:populate-if-knownCreator_L2
                  SHALL:populate-if-knownCreator_L3
                  SHOULD:displayConsumer_L2
                  SHALL:displayConsumer_L3
                  Summarytrue
                  Requirements

                  This is often tracked as an integrity issue for use of the attachment.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

                  Guidance on how to interpret the contents of this table can be foundhere

                  0. Media
                  2. Media.content
                  4. Media.content.contentType
                  Obligations
                    ObligationsActor
                    SHOULD:able-to-populateCreator_L2
                    SHALL:able-to-populateCreator_L3
                    SHOULD:displayConsumer_L2
                    SHALL:displayConsumer_L3
                    6. Media.content.language
                    Obligations
                      ObligationsActor
                      SHOULD:able-to-populateCreator_L2
                      SHALL:able-to-populateCreator_L3
                      SHOULD:displayConsumer_L2
                      SHALL:displayConsumer_L3
                      8. Media.content.data
                      Obligations
                        ObligationsActor
                        SHOULD:able-to-populateCreator_L2
                        SHALL:able-to-populateCreator_L3
                        SHOULD:displayConsumer_L2
                        SHALL:displayConsumer_L3
                        10. Media.content.url
                        Obligations
                          ObligationsActor
                          SHOULD:able-to-populateCreator_L2
                          SHALL:able-to-populateCreator_L3
                          SHOULD:displayConsumer_L2
                          SHALL:displayConsumer_L3
                          12. Media.content.size
                          Obligations
                            ObligationsActor
                            SHOULD:populate-if-knownCreator_L2
                            SHALL:populate-if-knownCreator_L3
                            SHOULD:displayConsumer_L2
                            SHALL:displayConsumer_L3
                            14. Media.content.hash
                            Obligations
                              ObligationsActor
                              SHOULD:populate-if-knownCreator_L2
                              SHALL:populate-if-knownCreator_L3
                              SHOULD:displayConsumer_L2
                              SHALL:displayConsumer_L3
                              16. Media.content.title
                              Obligations
                                ObligationsActor
                                SHOULD:able-to-populateCreator_L2
                                SHALL:able-to-populateCreator_L3
                                SHOULD:displayConsumer_L2
                                SHALL:displayConsumer_L3
                                18. Media.content.creation
                                Obligations
                                  ObligationsActor
                                  SHOULD:populate-if-knownCreator_L2
                                  SHALL:populate-if-knownCreator_L3
                                  SHOULD:displayConsumer_L2
                                  SHALL:displayConsumer_L3

                                  Guidance on how to interpret the contents of this table can be foundhere

                                  0. Media
                                  Definition

                                  Lab Report attachment.

                                  ShortLab Report attachment
                                  Control0..*
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                                  dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                                  dom-6: A resource should have narrative for robust management (text.`div`.exists())
                                  2. Media.id
                                  Definition

                                  The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

                                  ShortLogical id of this artifact
                                  Comments

                                  The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

                                  Control0..1
                                  Typeid
                                  Is Modifierfalse
                                  Summarytrue
                                  4. Media.meta
                                  Definition

                                  The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

                                  ShortMetadata about the resource
                                  Control0..1
                                  TypeMeta
                                  Is Modifierfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  6. Media.implicitRules
                                  Definition

                                  A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                                  ShortA set of rules under which this content was created
                                  Comments

                                  Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

                                  Control0..1
                                  Typeuri
                                  Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  8. Media.language
                                  Definition

                                  The base language in which the resource is written.

                                  ShortLanguage of the resource content
                                  Comments

                                  Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

                                  Control0..1
                                  BindingThe codes SHOULD be taken from CommonLanguages
                                  (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

                                  A human language.

                                  Additional BindingsPurpose
                                  AllLanguagesMax Binding
                                  Typecode
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  10. Media.text
                                  Definition

                                  A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

                                  ShortText summary of the resource, for human interpretation
                                  Comments

                                  Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

                                  Control0..1
                                  TypeNarrative
                                  Is Modifierfalse
                                  Summaryfalse
                                  Alternate Namesnarrative, html, xhtml, display
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  12. Media.contained
                                  Definition

                                  These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

                                  ShortContained, inline Resources
                                  Comments

                                  This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

                                  Control0..*
                                  TypeResource
                                  Is Modifierfalse
                                  Summaryfalse
                                  Alternate Namesinline resources, anonymous resources, contained resources
                                  14. Media.extension
                                  Definition

                                  May be used to represent additional information that is not part of the basic definition of the resource. 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())
                                  16. Media.modifierExtension
                                  Definition

                                  May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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
                                  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 resource that contains them
                                  Summaryfalse
                                  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
                                  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())
                                  18. Media.identifier
                                  Definition

                                  Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers.

                                  ShortIdentifier(s) for the image
                                  Comments

                                  The identifier label and use can be used to determine what kind of identifier it is.

                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                  Control0..*
                                  TypeIdentifier
                                  Is Modifierfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  20. Media.basedOn
                                  Definition

                                  A procedure that is fulfilled in whole or in part by the creation of this media.

                                  ShortProcedure that caused this media to be created
                                  Control0..*
                                  TypeReference(ServiceRequest: Laboratory Order, CarePlan)
                                  Is Modifierfalse
                                  Summarytrue
                                  Requirements

                                  Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.

                                  Alternate Namesfulfills
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  22. Media.partOf
                                  Definition

                                  A larger event of which this particular event is a component or step.

                                  ShortPart of referenced event
                                  Comments

                                  Not to be used to link an event to an Encounter - use Media.encounter for that.

                                  [The allowed reference resources may be adjusted as appropriate for the event resource].

                                  Control0..*
                                  TypeReference(Resource)
                                  Is Modifierfalse
                                  Summarytrue
                                  Requirements

                                  E.g. Drug administration as part of a procedure, procedure as part of observation, etc.

                                  Alternate Namescontainer
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  24. Media.status
                                  Definition

                                  The current state of the {{title}}.

                                  Shortpreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
                                  Comments

                                  A nominal state-transition diagram can be found in the [[event.html#statemachine | Event pattern]] documentation

                                  Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

                                  Control1..1
                                  BindingThe codes SHALL be taken from EventStatus
                                  (required to http://hl7.org/fhir/ValueSet/event-status|4.0.1)

                                  Codes identifying the lifecycle stage of an event.

                                  Typecode
                                  Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  26. Media.type
                                  Definition

                                  A code that classifies whether the media is an image, video or audio recording or some other media category.

                                  ShortClassification of media as image, video, or audio
                                  Control0..1
                                  BindingUnless not suitable, these codes SHALL be taken from MediaType
                                  (extensible to http://hl7.org/fhir/ValueSet/media-type|4.0.1)

                                  Codes for high level media categories.

                                  TypeCodeableConcept
                                  Is Modifierfalse
                                  Summarytrue
                                  Requirements

                                  Used for filtering what observations are retrieved and displayed.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  28. Media.modality
                                  Definition

                                  Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality.

                                  ShortThe type of acquisition equipment/process
                                  Control0..1
                                  BindingFor example codes, see MediaModality
                                  (example to http://hl7.org/fhir/ValueSet/media-modality|4.0.1)

                                  Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it.

                                  TypeCodeableConcept
                                  Is Modifierfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  30. Media.view
                                  Definition

                                  The name of the imaging view e.g. Lateral or Antero-posterior (AP).

                                  ShortImaging view, e.g. Lateral or Antero-posterior
                                  Control0..1
                                  BindingFor example codes, see MediaCollectionView/Projection
                                  (example to http://hl7.org/fhir/ValueSet/media-view|4.0.1)

                                  Imaging view (projection) used when collecting an image.

                                  TypeCodeableConcept
                                  Is Modifierfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  32. Media.subject
                                  Definition

                                  Who/What this Media is a record of.

                                  ShortWho/What this Media is a record of
                                  Control0..1
                                  TypeReference(Patient (CZ core), Practitioner (CZ core), Practitioner Role (CZ core), Group, Device, Specimen Laboratory (CZ), Location (CZ core))
                                  Is Modifierfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  34. Media.encounter
                                  Definition

                                  The encounter that establishes the context for this media.

                                  ShortEncounter associated with media
                                  Comments

                                  This will typically be the encounter the media occurred within.

                                  Control0..1
                                  TypeReference(Encounter)
                                  Is Modifierfalse
                                  Summarytrue
                                  Requirements

                                  Links the Media to the Encounter context.

                                  Alternate Namescontext
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  36. Media.created[x]
                                  Definition

                                  The date and time(s) at which the media was collected.

                                  ShortWhen Media was collected
                                  Control0..1
                                  TypeChoice of: dateTime, Period
                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Alternate Namestiming
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  38. Media.issued
                                  Definition

                                  The date and time this version of the media was made available to providers, typically after having been reviewed.

                                  ShortDate/Time this version was made available
                                  Comments

                                  It may be the same as the lastUpdated time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the lastUpdated time of the resource itself due to a non-clinically significant update that does not require the new version to be reviewed and verified again.

                                  Control0..1
                                  Typeinstant
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  40. Media.operator
                                  Definition

                                  The person who administered the collection of the image.

                                  ShortThe person who generated the image
                                  Control0..1
                                  TypeReference(Practitioner (CZ core), Practitioner Role (CZ core), Organization (CZ core), CareTeam, Patient (CZ core), Device, Related Person (CZ core))
                                  Is Modifierfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  42. Media.reasonCode
                                  Definition

                                  Describes why the event occurred in coded or textual form.

                                  ShortWhy was event performed?
                                  Comments

                                  Textual reasons can be captured using reasonCode.text.

                                  Control0..*
                                  BindingFor example codes, see ProcedureReasonCodes
                                  (example to http://hl7.org/fhir/ValueSet/procedure-reason|4.0.1)

                                  The reason for the media.

                                  TypeCodeableConcept
                                  Is Modifierfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  44. Media.bodySite
                                  Definition

                                  Indicates the site on the subject's body where the observation was made (i.e. the target site).

                                  ShortObserved body part
                                  Comments

                                  Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component.

                                  If the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension bodySite.

                                  Control0..1
                                  BindingFor example codes, see SNOMEDCTBodyStructures
                                  (example to http://hl7.org/fhir/ValueSet/body-site|4.0.1)

                                  Codes describing anatomical locations. May include laterality.

                                  TypeCodeableConcept
                                  Is Modifierfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  46. Media.deviceName
                                  Definition

                                  The name of the device / manufacturer of the device that was used to make the recording.

                                  ShortName of the device/manufacturer
                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  48. Media.device
                                  Definition

                                  The device used to collect the media.

                                  ShortObserving Device
                                  Comments

                                  An extension should be used if further typing of the device is needed. Secondary devices used to support collecting a media can be represented using either extension or through the Observation.related element.

                                  Control0..1
                                  TypeReference(Device, DeviceMetric, Device)
                                  Is Modifierfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  50. Media.height
                                  Definition

                                  Height of the image in pixels (photo/video).

                                  ShortHeight of the image in pixels (photo/video)
                                  Control0..1
                                  TypepositiveInt
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  52. Media.width
                                  Definition

                                  Width of the image in pixels (photo/video).

                                  ShortWidth of the image in pixels (photo/video)
                                  Control0..1
                                  TypepositiveInt
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  54. Media.frames
                                  Definition

                                  The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.

                                  ShortNumber of frames if > 1 (photo)
                                  Comments

                                  if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.

                                  Control0..1
                                  TypepositiveInt
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  56. Media.duration
                                  Definition

                                  The duration of the recording in seconds - for audio and video.

                                  ShortLength in seconds (audio / video)
                                  Comments

                                  The duration might differ from occurrencePeriod if recording was paused.

                                  Control0..1
                                  Typedecimal
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  58. Media.content
                                  Definition

                                  The actual content of the media - inline or by direct reference to the media source file.

                                  ShortActual Media - reference or data
                                  Comments

                                  Recommended content types: image/jpeg, image/png, image/tiff, video/mpeg, audio/mp4, application/dicom. Application/dicom can contain the transfer syntax as a parameter. For media that covers a period of time (video/sound), the content.creationTime is the end time. Creation time is used for tracking, organizing versions and searching.

                                  Control1..1
                                  TypeAttachment
                                  Is Modifierfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  60. Media.content.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
                                  62. Media.content.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 Media.content.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 64. Media.content.contentType
                                    Definition

                                    Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

                                    ShortMime type of the content, with charset etc.
                                    Control0..1
                                    BindingThe codes SHALL be taken from Mime Types
                                    (required to http://hl7.org/fhir/ValueSet/mimetypes|4.0.1)

                                    The mime type of an attachment. Any valid mime type is allowed.

                                    Typecode
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Obligations
                                      ObligationsActor
                                      SHOULD:able-to-populateCreator_L2
                                      SHALL:able-to-populateCreator_L3
                                      SHOULD:displayConsumer_L2
                                      SHALL:displayConsumer_L3
                                      Summarytrue
                                      Requirements

                                      Processors of the data need to be able to know how to interpret the data.

                                      ExampleGeneral: text/plain; charset=UTF-8, image/png
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      66. Media.content.language
                                      Definition

                                      The human language of the content. The value can be any valid value according to BCP 47.

                                      ShortHuman language of the content (BCP-47)
                                      Control0..1
                                      BindingThe codes SHOULD be taken from CommonLanguages
                                      (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

                                      A human language.

                                      Additional BindingsPurpose
                                      AllLanguagesMax Binding
                                      Typecode
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      Obligations
                                        ObligationsActor
                                        SHOULD:able-to-populateCreator_L2
                                        SHALL:able-to-populateCreator_L3
                                        SHOULD:displayConsumer_L2
                                        SHALL:displayConsumer_L3
                                        Summarytrue
                                        Requirements

                                        Users need to be able to choose between the languages in a set of attachments.

                                        ExampleGeneral: en-AU
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        68. Media.content.data
                                        Definition

                                        The actual data of the attachment - a sequence of bytes, base64 encoded.

                                        ShortData inline, base64ed
                                        Comments

                                        The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

                                        Control0..1
                                        Typebase64Binary
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Obligations
                                          ObligationsActor
                                          SHOULD:able-to-populateCreator_L2
                                          SHALL:able-to-populateCreator_L3
                                          SHOULD:displayConsumer_L2
                                          SHALL:displayConsumer_L3
                                          Summaryfalse
                                          Requirements

                                          The data needs to able to be transmitted inline.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          70. Media.content.url
                                          Definition

                                          A location where the data can be accessed.

                                          ShortUri where the data can be found
                                          Comments

                                          If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.

                                          Control0..1
                                          Typeurl
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Obligations
                                            ObligationsActor
                                            SHOULD:able-to-populateCreator_L2
                                            SHALL:able-to-populateCreator_L3
                                            SHOULD:displayConsumer_L2
                                            SHALL:displayConsumer_L3
                                            Summarytrue
                                            Requirements

                                            The data needs to be transmitted by reference.

                                            ExampleGeneral: http://www.acme.com/logo-small.png
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            72. Media.content.size
                                            Definition

                                            The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

                                            ShortNumber of bytes of content (if url provided)
                                            Comments

                                            The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.

                                            Control0..1
                                            TypeunsignedInt
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Obligations
                                              ObligationsActor
                                              SHOULD:populate-if-knownCreator_L2
                                              SHALL:populate-if-knownCreator_L3
                                              SHOULD:displayConsumer_L2
                                              SHALL:displayConsumer_L3
                                              Summarytrue
                                              Requirements

                                              Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.

                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              74. Media.content.hash
                                              Definition

                                              The calculated hash of the data using SHA-1. Represented using base64.

                                              ShortHash of the data (sha-1, base64ed)
                                              Comments

                                              The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.

                                              Control0..1
                                              Typebase64Binary
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Obligations
                                                ObligationsActor
                                                SHOULD:populate-if-knownCreator_L2
                                                SHALL:populate-if-knownCreator_L3
                                                SHOULD:displayConsumer_L2
                                                SHALL:displayConsumer_L3
                                                Summarytrue
                                                Requirements

                                                Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                76. Media.content.title
                                                Definition

                                                A label or set of text to display in place of the data.

                                                ShortLabel to display in place of the data
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Must Supporttrue
                                                Obligations
                                                  ObligationsActor
                                                  SHOULD:able-to-populateCreator_L2
                                                  SHALL:able-to-populateCreator_L3
                                                  SHOULD:displayConsumer_L2
                                                  SHALL:displayConsumer_L3
                                                  Summarytrue
                                                  Requirements

                                                  Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.

                                                  ExampleGeneral: Official Corporate Logo
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  78. Media.content.creation
                                                  Definition

                                                  The date that the attachment was first created.

                                                  ShortDate attachment was first created
                                                  Control0..1
                                                  TypedateTime
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Must Supporttrue
                                                  Obligations
                                                    ObligationsActor
                                                    SHOULD:populate-if-knownCreator_L2
                                                    SHALL:populate-if-knownCreator_L3
                                                    SHOULD:displayConsumer_L2
                                                    SHALL:displayConsumer_L3
                                                    Summarytrue
                                                    Requirements

                                                    This is often tracked as an integrity issue for use of the attachment.

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    80. Media.note
                                                    Definition

                                                    Comments made about the media by the performer, subject or other participants.

                                                    ShortComments made about the media
                                                    Comments

                                                    Not to be used for observations, conclusions, etc. Instead use an Observation based on the Media/ImagingStudy resource.

                                                    Control0..*
                                                    TypeAnnotation
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))