Extensions for Using Data Elements from FHIR R5 in FHIR R4B
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR R4B - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_DocumentReference_R4B_Media - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-DocumentReference-for-Media resource profile.

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

0. Media
Definition

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

ShortA photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
Control0..*
Is Modifierfalse
Must Supportfalse
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.exists() and ('#'+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(uri) = '#').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())
dom-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.exists() and ('#'+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(uri) = '#').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
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Media.extension
Definition

An Extension


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.

ShortExtensionAdditional 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
Must Supportfalse
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())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Media.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Media.extension:version
    Slice Nameversion
    Definition

    R5: DocumentReference.version (new:string)

    ShortR5: An explicitly assigned identifer of a variation of the content in the DocumentReference (new)
    Comments

    Element DocumentReference.version has a context of Media based on following the parent source element upwards and mapping to Media. Element DocumentReference.version has a context of DocumentReference based on following the parent source element upwards and mapping to DocumentReference. Element DocumentReference.version has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). While each resource, including the DocumentReference itself, has its own version identifier, this is a formal identifier for the logical version of the DocumentReference as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: An explicitly assigned identifer of a variation of the content in the DocumentReference (new)) (Extension Type: string)
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. Media.extension:attester
    Slice Nameattester
    Definition

    R5: DocumentReference.attester (new:BackboneElement)

    ShortR5: Attests to accuracy of the document (new)
    Comments

    Element DocumentReference.attester has a context of Media based on following the parent source element upwards and mapping to Media. Element DocumentReference.attester has a context of DocumentReference based on following the parent source element upwards and mapping to DocumentReference. Element DocumentReference.attester has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Only list each attester once.

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: Attests to accuracy of the document (new)) (Complex Extension)
    Is Modifierfalse
    Must Supportfalse
    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. 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
    Must Supportfalse
    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())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. 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.3.0
    (required to http://hl7.org/fhir/ValueSet/event-status|4.3.0)

    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
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. 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
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Media.content.extension
    Definition

    An Extension


    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.

    ShortExtensionAdditional 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())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    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
    • 18. Media.content.extension:profile
      Slice Nameprofile
      Definition

      R5: DocumentReference.content.profile (new:BackboneElement)

      ShortR5: Content profile rules for the document (new)
      Comments

      Element DocumentReference.content.profile has a context of Media.content based on following the parent source element upwards and mapping to Media. Element DocumentReference.content.profile has a context of DocumentReference.content based on following the parent source element upwards and mapping to DocumentReference. Element DocumentReference.content.profile has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Note that IHE often issues URNs for formatCode codes, not all documents can be identified by a URI.

      For FHIR content, .profile should indicate the structureDefinition profile canonical URI(s) that the content complies with.

      Control0..*
      TypeExtension(R5: Content profile rules for the document (new)) (Complex Extension)
      Is Modifierfalse
      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())

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

      0. Media
      2. Media.extension
      Control0..*
      SlicingThis element introduces a set of slices on Media.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 4. Media.extension:version
        Slice Nameversion
        Definition

        R5: DocumentReference.version (new:string)

        ShortR5: An explicitly assigned identifer of a variation of the content in the DocumentReference (new)
        Comments

        Element DocumentReference.version has a context of Media based on following the parent source element upwards and mapping to Media. Element DocumentReference.version has a context of DocumentReference based on following the parent source element upwards and mapping to DocumentReference. Element DocumentReference.version has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). While each resource, including the DocumentReference itself, has its own version identifier, this is a formal identifier for the logical version of the DocumentReference as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example.

        Control0..1
        TypeExtension(R5: An explicitly assigned identifer of a variation of the content in the DocumentReference (new)) (Extension Type: string)
        6. Media.extension:attester
        Slice Nameattester
        Definition

        R5: DocumentReference.attester (new:BackboneElement)

        ShortR5: Attests to accuracy of the document (new)
        Comments

        Element DocumentReference.attester has a context of Media based on following the parent source element upwards and mapping to Media. Element DocumentReference.attester has a context of DocumentReference based on following the parent source element upwards and mapping to DocumentReference. Element DocumentReference.attester has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Only list each attester once.

        Control0..*
        TypeExtension(R5: Attests to accuracy of the document (new)) (Complex Extension)
        8. Media.basedOn
        10. Media.basedOn.extension
        Control0..*
        SlicingThis element introduces a set of slices on Media.basedOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 12. Media.basedOn.extension:basedOn
          Slice NamebasedOn
          Definition

          R5: DocumentReference.basedOn

          ShortR5: basedOn
          Comments

          Element DocumentReference.basedOn is mapped to FHIR R4B element Media.basedOn as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element DocumentReference.basedOn with unmapped reference targets: Appointment, AppointmentResponse, Claim, CommunicationRequest, Contract, CoverageEligibilityRequest, DeviceRequest, EnrollmentRequest, ImmunizationRecommendation, MedicationRequest, NutritionOrder, RequestOrchestration, SupplyRequest, VisionPrescription.

          Control0..*
          TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
          14. Media.subject
          16. Media.subject.extension
          Control0..*
          SlicingThis element introduces a set of slices on Media.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 18. Media.subject.extension:subject
            Slice Namesubject
            Definition

            R5: DocumentReference.subject additional types from child elements (display, identifier, reference, type)

            ShortR5: Who/what is the subject of the document additional types
            Comments

            Element DocumentReference.subject is mapped to FHIR R4B element Media.subject as SourceIsBroaderThanTarget. Element DocumentReference.subject is mapped to FHIR R4B element DocumentReference.subject as SourceIsBroaderThanTarget. The mappings for DocumentReference.subject do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element DocumentReference.subject with unmapped reference targets: Resource.

            Control0..1
            TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
            20. Media.bodySite
            22. Media.bodySite.extension
            Control0..*
            SlicingThis element introduces a set of slices on Media.bodySite.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 24. Media.bodySite.extension:bodySite
              Slice NamebodySite
              Definition

              R5: DocumentReference.bodySite additional types (CodeableReference(http://hl7.org/fhir/StructureDefinition/BodyStructure)) additional types from child elements (reference)

              ShortR5: Body part included additional types
              Comments

              Element DocumentReference.bodySite is mapped to FHIR R4B element Media.bodySite as SourceIsBroaderThanTarget. The mappings for DocumentReference.bodySite do not cover the following types: CodeableReference. The mappings for DocumentReference.bodySite do not cover the following types based on type expansion: reference.

              Control0..*
              TypeExtension(R5: Body part included additional types) (Extension Type: Reference(Cross-version Profile for R5.BodyStructure for use in FHIR R4B, BodyStructure))
              26. Media.content
              28. Media.content.extension
              Control0..*
              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
              • 30. Media.content.extension:profile
                Slice Nameprofile
                Definition

                R5: DocumentReference.content.profile (new:BackboneElement)

                ShortR5: Content profile rules for the document (new)
                Comments

                Element DocumentReference.content.profile has a context of Media.content based on following the parent source element upwards and mapping to Media. Element DocumentReference.content.profile has a context of DocumentReference.content based on following the parent source element upwards and mapping to DocumentReference. Element DocumentReference.content.profile has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Note that IHE often issues URNs for formatCode codes, not all documents can be identified by a URI.

                For FHIR content, .profile should indicate the structureDefinition profile canonical URI(s) that the content complies with.

                Control0..*
                TypeExtension(R5: Content profile rules for the document (new)) (Complex Extension)

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

                0. Media
                Definition

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

                ShortA photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
                Control0..*
                Is Modifierfalse
                Must Supportfalse
                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.exists() and ('#'+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(uri) = '#').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
                Must Supportfalse
                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
                Must Supportfalse
                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
                Must Supportfalse
                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.3.0)

                IETF language tag

                Additional BindingsPurpose
                AllLanguagesMax Binding
                Typecode
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supportfalse
                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
                Must Supportfalse
                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
                Must Supportfalse
                Summaryfalse
                Alternate Namesinline resources, anonymous resources, contained resources
                Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
                14. Media.extension
                Definition

                An Extension

                ShortExtension
                Control0..*
                TypeExtension
                Is Modifierfalse
                Must Supportfalse
                Summaryfalse
                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.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 16. Media.extension:version
                  Slice Nameversion
                  Definition

                  R5: DocumentReference.version (new:string)

                  ShortR5: An explicitly assigned identifer of a variation of the content in the DocumentReference (new)
                  Comments

                  Element DocumentReference.version has a context of Media based on following the parent source element upwards and mapping to Media. Element DocumentReference.version has a context of DocumentReference based on following the parent source element upwards and mapping to DocumentReference. Element DocumentReference.version has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). While each resource, including the DocumentReference itself, has its own version identifier, this is a formal identifier for the logical version of the DocumentReference as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example.

                  Control0..1
                  This element is affected by the following invariants: ele-1
                  TypeExtension(R5: An explicitly assigned identifer of a variation of the content in the DocumentReference (new)) (Extension Type: string)
                  Is Modifierfalse
                  Must Supportfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  18. Media.extension:attester
                  Slice Nameattester
                  Definition

                  R5: DocumentReference.attester (new:BackboneElement)

                  ShortR5: Attests to accuracy of the document (new)
                  Comments

                  Element DocumentReference.attester has a context of Media based on following the parent source element upwards and mapping to Media. Element DocumentReference.attester has a context of DocumentReference based on following the parent source element upwards and mapping to DocumentReference. Element DocumentReference.attester has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Only list each attester once.

                  Control0..*
                  This element is affected by the following invariants: ele-1
                  TypeExtension(R5: Attests to accuracy of the document (new)) (Complex Extension)
                  Is Modifierfalse
                  Must Supportfalse
                  Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  20. 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
                  Must Supportfalse
                  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())
                  22. 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
                  Must Supportfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  24. 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, CarePlan)
                  Is Modifierfalse
                  Must Supportfalse
                  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()))
                  26. Media.basedOn.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
                  Typeid
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  28. Media.basedOn.extension
                  Definition

                  An Extension

                  ShortExtension
                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  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.basedOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 30. Media.basedOn.extension:basedOn
                    Slice NamebasedOn
                    Definition

                    R5: DocumentReference.basedOn

                    ShortR5: basedOn
                    Comments

                    Element DocumentReference.basedOn is mapped to FHIR R4B element Media.basedOn as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element DocumentReference.basedOn with unmapped reference targets: Appointment, AppointmentResponse, Claim, CommunicationRequest, Contract, CoverageEligibilityRequest, DeviceRequest, EnrollmentRequest, ImmunizationRecommendation, MedicationRequest, NutritionOrder, RequestOrchestration, SupplyRequest, VisionPrescription.

                    Control0..1
                    TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                    Is Modifierfalse
                    Summaryfalse
                    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())
                    32. Media.basedOn.reference
                    Definition

                    A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                    ShortLiteral reference, Relative, internal or absolute URL
                    Comments

                    Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                    Control0..1
                    This element is affected by the following invariants: ref-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()))
                    34. Media.basedOn.type
                    Definition

                    The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                    The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                    ShortType the reference refers to (e.g. "Patient")
                    Comments

                    This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                    Control0..1
                    BindingUnless not suitable, these codes SHALL be taken from ResourceType
                    (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.3.0)
                    Typeuri
                    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()))
                    36. Media.basedOn.identifier
                    Definition

                    An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                    ShortLogical reference, when literal reference is not known
                    Comments

                    When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                    When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                    Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                    Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

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

                    Plain text narrative that identifies the resource in addition to the resource reference.

                    ShortText alternative for the resource
                    Comments

                    This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                    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()))
                    40. 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
                    Must Supportfalse
                    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()))
                    42. 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.3.0)

                    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
                    Must Supportfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    44. 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.3.0)

                    Codes for high level media categories.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Must Supportfalse
                    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()))
                    46. 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.3.0)

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

                    TypeCodeableConcept
                    Is Modifierfalse
                    Must Supportfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    48. 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.3.0)

                    Imaging view (projection) used when collecting an image.

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

                    Who/What this Media is a record of.

                    ShortWho/What this Media is a record of
                    Control0..1
                    TypeReference(Patient, Practitioner, PractitionerRole, Group, Device, Specimen, Location)
                    Is Modifierfalse
                    Must Supportfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    52. Media.subject.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
                    Typeid
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    54. Media.subject.extension
                    Definition

                    An Extension

                    ShortExtension
                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    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.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 56. Media.subject.extension:subject
                      Slice Namesubject
                      Definition

                      R5: DocumentReference.subject additional types from child elements (display, identifier, reference, type)

                      ShortR5: Who/what is the subject of the document additional types
                      Comments

                      Element DocumentReference.subject is mapped to FHIR R4B element Media.subject as SourceIsBroaderThanTarget. Element DocumentReference.subject is mapped to FHIR R4B element DocumentReference.subject as SourceIsBroaderThanTarget. The mappings for DocumentReference.subject do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element DocumentReference.subject with unmapped reference targets: Resource.

                      Control0..1
                      TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                      Is Modifierfalse
                      Summaryfalse
                      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())
                      58. Media.subject.reference
                      Definition

                      A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                      ShortLiteral reference, Relative, internal or absolute URL
                      Comments

                      Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                      Control0..1
                      This element is affected by the following invariants: ref-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()))
                      60. Media.subject.type
                      Definition

                      The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                      The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                      ShortType the reference refers to (e.g. "Patient")
                      Comments

                      This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                      Control0..1
                      BindingUnless not suitable, these codes SHALL be taken from ResourceType
                      (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.3.0)
                      Typeuri
                      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()))
                      62. Media.subject.identifier
                      Definition

                      An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                      ShortLogical reference, when literal reference is not known
                      Comments

                      When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                      When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                      Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                      Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

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

                      Plain text narrative that identifies the resource in addition to the resource reference.

                      ShortText alternative for the resource
                      Comments

                      This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                      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()))
                      66. 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
                      Must Supportfalse
                      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()))
                      68. 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
                      Must Supportfalse
                      Summarytrue
                      Alternate Namestiming
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      70. 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
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      72. Media.operator
                      Definition

                      The person who administered the collection of the image.

                      ShortThe person who generated the image
                      Control0..1
                      TypeReference(Practitioner, PractitionerRole, Organization, CareTeam, Patient, Device, RelatedPerson)
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      74. 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.3.0)

                      The reason for the media.

                      TypeCodeableConcept
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      76. 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.3.0)

                      SNOMED CT Body site concepts

                      TypeCodeableConcept
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      78. Media.bodySite.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
                      Typeid
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      80. Media.bodySite.extension
                      Definition

                      An Extension

                      ShortExtension
                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      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.bodySite.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 82. Media.bodySite.extension:bodySite
                        Slice NamebodySite
                        Definition

                        R5: DocumentReference.bodySite additional types (CodeableReference(http://hl7.org/fhir/StructureDefinition/BodyStructure)) additional types from child elements (reference)

                        ShortR5: Body part included additional types
                        Comments

                        Element DocumentReference.bodySite is mapped to FHIR R4B element Media.bodySite as SourceIsBroaderThanTarget. The mappings for DocumentReference.bodySite do not cover the following types: CodeableReference. The mappings for DocumentReference.bodySite do not cover the following types based on type expansion: reference.

                        Control0..*
                        TypeExtension(R5: Body part included additional types) (Extension Type: Reference(Cross-version Profile for R5.BodyStructure for use in FHIR R4B, BodyStructure))
                        Is Modifierfalse
                        Summaryfalse
                        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())
                        84. Media.bodySite.coding
                        Definition

                        A reference to a code defined by a terminology system.

                        ShortCode defined by a terminology system
                        Comments

                        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                        Control0..*
                        TypeCoding
                        Is Modifierfalse
                        Summarytrue
                        Requirements

                        Allows for alternative encodings within a code system, and translations to other code systems.

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

                        A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                        ShortPlain text representation of the concept
                        Comments

                        Very often the text is the same as a displayName of one of the codings.

                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        88. 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
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        90. 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
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        92. 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
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        94. 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
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        96. 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
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        98. 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
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        100. 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
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        102. 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
                        Typeid
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        104. Media.content.extension
                        Definition

                        An Extension

                        ShortExtension
                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        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
                        • 106. Media.content.extension:profile
                          Slice Nameprofile
                          Definition

                          R5: DocumentReference.content.profile (new:BackboneElement)

                          ShortR5: Content profile rules for the document (new)
                          Comments

                          Element DocumentReference.content.profile has a context of Media.content based on following the parent source element upwards and mapping to Media. Element DocumentReference.content.profile has a context of DocumentReference.content based on following the parent source element upwards and mapping to DocumentReference. Element DocumentReference.content.profile has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Note that IHE often issues URNs for formatCode codes, not all documents can be identified by a URI.

                          For FHIR content, .profile should indicate the structureDefinition profile canonical URI(s) that the content complies with.

                          Control0..*
                          TypeExtension(R5: Content profile rules for the document (new)) (Complex Extension)
                          Is Modifierfalse
                          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())
                          108. 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.3.0)

                          BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)

                          Typecode
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          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()))
                          110. 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.3.0)

                          IETF language tag

                          Additional BindingsPurpose
                          AllLanguagesMax Binding
                          Typecode
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          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()))
                          112. 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
                          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()))
                          114. 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
                          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()))
                          116. 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
                          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()))
                          118. 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
                          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()))
                          120. 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
                          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()))
                          122. 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
                          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()))
                          124. 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
                          Must Supportfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))