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

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

Resource Profile: Profile_R5_ImagingStudy_R4 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-ImagingStudy resource profile.

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

0. ImagingStudy
Definition

Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.

ShortA set of images produced in single study (one or more series of references images)
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. ImagingStudy.implicitRules
Definition

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

ShortA set of rules under which this content was created
Comments

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

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. ImagingStudy.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
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 ImagingStudy.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. ImagingStudy.extension:partOf
    Slice NamepartOf
    Definition

    R5: ImagingStudy.partOf (new:Reference(Procedure))

    ShortR5: Part of referenced event (new)
    Comments

    Element ImagingStudy.partOf has a context of ImagingStudy based on following the parent source element upwards and mapping to ImagingStudy. Element ImagingStudy.partOf has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). To link an ImagingStudy to an Encounter use encounter.

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: Part of referenced event (new)) (Extension Type: Reference(Cross-version Profile for R5.Procedure for use in FHIR R4, Procedure))
    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())
    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. ImagingStudy.extension:reason
    Slice Namereason
    Definition

    R5: ImagingStudy.reason additional types (CodeableReference(http://hl7.org/fhir/StructureDefinition/Condition), CodeableReference(http://hl7.org/fhir/StructureDefinition/Observation), CodeableReference(http://hl7.org/fhir/StructureDefinition/DiagnosticReport), CodeableReference(http://hl7.org/fhir/StructureDefinition/DocumentReference))

    ShortR5: Why the study was requested / performed additional types
    Comments

    Element ImagingStudy.reason is mapped to FHIR R4 element ImagingStudy.reasonCode as SourceIsBroaderThanTarget. Element ImagingStudy.reason is mapped to FHIR R4 element ImagingStudy.reasonReference as SourceIsBroaderThanTarget. The mappings for ImagingStudy.reason do not cover the following types: CodeableReference.

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: Why the study was requested / performed additional types) (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())
    10. ImagingStudy.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    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. ImagingStudy.status
    Definition

    The current state of the ImagingStudy.

    Shortregistered | available | cancelled | entered-in-error | unknown
    Comments

    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 ImagingStudyStatushttp://hl7.org/fhir/ValueSet/imagingstudy-status|4.0.1
    (required to http://hl7.org/fhir/ValueSet/imagingstudy-status|4.0.1)

    The status of the ImagingStudy.

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

    The subject, typically a patient, of the imaging study.

    ShortWho or what is the subject of the study
    Comments

    QA phantoms can be recorded with a Device; multiple subjects (such as mice) can be recorded with a Group.

    Control1..1
    TypeReference(Patient, Device, Group)
    Is Modifierfalse
    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()))

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

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

      R5: ImagingStudy.partOf (new:Reference(Procedure))

      ShortR5: Part of referenced event (new)
      Comments

      Element ImagingStudy.partOf has a context of ImagingStudy based on following the parent source element upwards and mapping to ImagingStudy. Element ImagingStudy.partOf has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). To link an ImagingStudy to an Encounter use encounter.

      Control0..*
      TypeExtension(R5: Part of referenced event (new)) (Extension Type: Reference(Cross-version Profile for R5.Procedure for use in FHIR R4, Procedure))
      6. ImagingStudy.extension:reason
      Slice Namereason
      Definition

      R5: ImagingStudy.reason additional types (CodeableReference(http://hl7.org/fhir/StructureDefinition/Condition), CodeableReference(http://hl7.org/fhir/StructureDefinition/Observation), CodeableReference(http://hl7.org/fhir/StructureDefinition/DiagnosticReport), CodeableReference(http://hl7.org/fhir/StructureDefinition/DocumentReference))

      ShortR5: Why the study was requested / performed additional types
      Comments

      Element ImagingStudy.reason is mapped to FHIR R4 element ImagingStudy.reasonCode as SourceIsBroaderThanTarget. Element ImagingStudy.reason is mapped to FHIR R4 element ImagingStudy.reasonReference as SourceIsBroaderThanTarget. The mappings for ImagingStudy.reason do not cover the following types: CodeableReference.

      Control0..*
      TypeExtension(R5: Why the study was requested / performed additional types) (Complex Extension)
      8. ImagingStudy.modality
      10. ImagingStudy.modality.extension
      Control0..*
      SlicingThis element introduces a set of slices on ImagingStudy.modality.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 12. ImagingStudy.modality.extension:modality
        Slice Namemodality
        Definition

        R5: ImagingStudy.modality additional types (CodeableConcept) additional types from child elements (text)

        ShortR5: All of the distinct values for series' modalities additional types
        Comments

        Element ImagingStudy.modality is mapped to FHIR R4 element ImagingStudy.modality as SourceIsBroaderThanTarget. The mappings for ImagingStudy.modality do not cover the following types: CodeableConcept. The mappings for ImagingStudy.modality do not cover the following types based on type expansion: text.

        Control0..*
        TypeExtension(R5: All of the distinct values for series' modalities additional types) (Extension Type: CodeableConcept)
        14. ImagingStudy.series
        16. ImagingStudy.series.modality
        18. ImagingStudy.series.modality.extension
        Control0..*
        SlicingThis element introduces a set of slices on ImagingStudy.series.modality.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 20. ImagingStudy.series.modality.extension:modality
          Slice Namemodality
          Definition

          R5: ImagingStudy.series.modality additional types (CodeableConcept) additional types from child elements (text)

          ShortR5: The modality used for this series additional types
          Comments

          Element ImagingStudy.series.modality is mapped to FHIR R4 element ImagingStudy.series.modality as SourceIsBroaderThanTarget. The mappings for ImagingStudy.series.modality do not cover the following types: CodeableConcept. The mappings for ImagingStudy.series.modality do not cover the following types based on type expansion: text.

          Control0..1
          TypeExtension(R5: The modality used for this series additional types) (Extension Type: CodeableConcept)
          22. ImagingStudy.series.bodySite
          24. ImagingStudy.series.bodySite.extension
          Control0..*
          SlicingThis element introduces a set of slices on ImagingStudy.series.bodySite.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 26. ImagingStudy.series.bodySite.extension:bodySite
            Slice NamebodySite
            Definition

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

            ShortR5: bodySite additional types
            Comments

            Element ImagingStudy.series.bodySite is mapped to FHIR R4 element ImagingStudy.series.bodySite as SourceIsBroaderThanTarget. The mappings for ImagingStudy.series.bodySite do not cover the following types: CodeableReference. The mappings for ImagingStudy.series.bodySite do not cover the following types based on type expansion: concept, reference.

            Control0..1
            TypeExtension(R5: bodySite additional types) (Complex Extension)
            28. ImagingStudy.series.laterality
            30. ImagingStudy.series.laterality.extension
            Control0..*
            SlicingThis element introduces a set of slices on ImagingStudy.series.laterality.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 32. ImagingStudy.series.laterality.extension:laterality
              Slice Namelaterality
              Definition

              R5: ImagingStudy.series.laterality additional types (CodeableConcept) additional types from child elements (text)

              ShortR5: laterality additional types
              Comments

              Element ImagingStudy.series.laterality is mapped to FHIR R4 element ImagingStudy.series.laterality as SourceIsBroaderThanTarget. The mappings for ImagingStudy.series.laterality do not cover the following types: CodeableConcept. The mappings for ImagingStudy.series.laterality do not cover the following types based on type expansion: text.

              Control0..1
              TypeExtension(R5: laterality additional types) (Extension Type: CodeableConcept)
              34. ImagingStudy.series.performer
              36. ImagingStudy.series.performer.actor
              38. ImagingStudy.series.performer.actor.extension
              Control0..*
              SlicingThis element introduces a set of slices on ImagingStudy.series.performer.actor.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 40. ImagingStudy.series.performer.actor.extension:actor
                Slice Nameactor
                Definition

                R5: ImagingStudy.series.performer.actor

                ShortR5: actor
                Comments

                Element ImagingStudy.series.performer.actor is mapped to FHIR R4 element ImagingStudy.series.performer.actor as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element ImagingStudy.series.performer.actor with unmapped reference targets: HealthcareService.

                Control0..1
                TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))

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

                0. ImagingStudy
                Definition

                Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.

                ShortA set of images produced in single study (one or more series of references images)
                Control0..*
                Is Modifierfalse
                Summaryfalse
                Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
                dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
                dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                dom-6: A resource should have narrative for robust management (text.`div`.exists())
                2. ImagingStudy.id
                Definition

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

                ShortLogical id of this artifact
                Comments

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

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

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

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

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

                ShortA set of rules under which this content was created
                Comments

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

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

                The base language in which the resource is written.

                ShortLanguage of the resource content
                Comments

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

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

                A human language.

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

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

                ShortText summary of the resource, for human interpretation
                Comments

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

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

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

                ShortContained, inline Resources
                Comments

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

                Control0..*
                TypeResource
                Is Modifierfalse
                Summaryfalse
                Alternate Namesinline resources, anonymous resources, contained resources
                14. ImagingStudy.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 ImagingStudy.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 16. ImagingStudy.extension:partOf
                  Slice NamepartOf
                  Definition

                  R5: ImagingStudy.partOf (new:Reference(Procedure))

                  ShortR5: Part of referenced event (new)
                  Comments

                  Element ImagingStudy.partOf has a context of ImagingStudy based on following the parent source element upwards and mapping to ImagingStudy. Element ImagingStudy.partOf has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). To link an ImagingStudy to an Encounter use encounter.

                  Control0..*
                  This element is affected by the following invariants: ele-1
                  TypeExtension(R5: Part of referenced event (new)) (Extension Type: Reference(Cross-version Profile for R5.Procedure for use in FHIR R4, Procedure))
                  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())
                  18. ImagingStudy.extension:reason
                  Slice Namereason
                  Definition

                  R5: ImagingStudy.reason additional types (CodeableReference(http://hl7.org/fhir/StructureDefinition/Condition), CodeableReference(http://hl7.org/fhir/StructureDefinition/Observation), CodeableReference(http://hl7.org/fhir/StructureDefinition/DiagnosticReport), CodeableReference(http://hl7.org/fhir/StructureDefinition/DocumentReference))

                  ShortR5: Why the study was requested / performed additional types
                  Comments

                  Element ImagingStudy.reason is mapped to FHIR R4 element ImagingStudy.reasonCode as SourceIsBroaderThanTarget. Element ImagingStudy.reason is mapped to FHIR R4 element ImagingStudy.reasonReference as SourceIsBroaderThanTarget. The mappings for ImagingStudy.reason do not cover the following types: CodeableReference.

                  Control0..*
                  This element is affected by the following invariants: ele-1
                  TypeExtension(R5: Why the study was requested / performed additional types) (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())
                  20. ImagingStudy.modifierExtension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                  ShortExtensions that cannot be ignored
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                  Summaryfalse
                  Requirements

                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  22. ImagingStudy.identifier
                  Definition

                  Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.

                  ShortIdentifiers for the whole study
                  Comments

                  See discussion under Imaging Study Implementation Notes for encoding of DICOM Study Instance UID. Accession Number should use ACSN Identifier type.

                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control0..*
                  TypeIdentifier
                  Is Modifierfalse
                  Summarytrue
                  Requirements

                  If one or more series elements are present in the ImagingStudy, then there shall be one DICOM Study UID identifier (see DICOM PS 3.3 C.7.2.

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

                  The current state of the ImagingStudy.

                  Shortregistered | available | cancelled | entered-in-error | unknown
                  Comments

                  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 ImagingStudyStatus
                  (required to http://hl7.org/fhir/ValueSet/imagingstudy-status|4.0.1)

                  The status of the ImagingStudy.

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

                  A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).

                  ShortAll series modality if actual acquisition modalities
                  Control0..*
                  BindingUnless not suitable, these codes SHALL be taken from AcquisitionModality .
                  (extensible to http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html)

                  Type of acquired data in the instance.

                  TypeCoding
                  Is Modifierfalse
                  Summarytrue
                  Alternate NamesModalitiesInStudy
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  28. ImagingStudy.modality.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  30. ImagingStudy.modality.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 ImagingStudy.modality.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 32. ImagingStudy.modality.extension:modality
                    Slice Namemodality
                    Definition

                    R5: ImagingStudy.modality additional types (CodeableConcept) additional types from child elements (text)

                    ShortR5: All of the distinct values for series' modalities additional types
                    Comments

                    Element ImagingStudy.modality is mapped to FHIR R4 element ImagingStudy.modality as SourceIsBroaderThanTarget. The mappings for ImagingStudy.modality do not cover the following types: CodeableConcept. The mappings for ImagingStudy.modality do not cover the following types based on type expansion: text.

                    Control0..*
                    TypeExtension(R5: All of the distinct values for series' modalities additional types) (Extension Type: CodeableConcept)
                    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())
                    34. ImagingStudy.modality.system
                    Definition

                    The identification of the code system that defines the meaning of the symbol in the code.

                    ShortIdentity of the terminology system
                    Comments

                    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

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

                    Need to be unambiguous about the source of the definition of the symbol.

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

                    The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                    ShortVersion of the system - if relevant
                    Comments

                    Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                    NoteThis is a business version Id, not a resource version Id (see discussion)
                    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()))
                    38. ImagingStudy.modality.code
                    Definition

                    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                    ShortSymbol in syntax defined by the system
                    Control0..1
                    Typecode
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    Need to refer to a particular code in the system.

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

                    A representation of the meaning of the code in the system, following the rules of the system.

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

                    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

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

                    Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                    ShortIf this coding was chosen directly by the user
                    Comments

                    Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                    This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

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

                    The subject, typically a patient, of the imaging study.

                    ShortWho or what is the subject of the study
                    Comments

                    QA phantoms can be recorded with a Device; multiple subjects (such as mice) can be recorded with a Group.

                    Control1..1
                    TypeReference(Patient, Device, Group)
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    46. ImagingStudy.encounter
                    Definition

                    The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made.

                    ShortEncounter with which this imaging study is associated
                    Comments

                    This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission test).

                    Control0..1
                    TypeReference(Encounter)
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    48. ImagingStudy.started
                    Definition

                    Date and time the study started.

                    ShortWhen the study was started
                    Control0..1
                    TypedateTime
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Alternate NamesStudyDate, StudyTime
                    ExampleGeneral: 2011-01-01T11:01:20+03:00
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    50. ImagingStudy.basedOn
                    Definition

                    A list of the diagnostic requests that resulted in this imaging study being performed.

                    ShortRequest fulfilled
                    Control0..*
                    TypeReference(CarePlan, ServiceRequest, Appointment, AppointmentResponse, Task)
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    To support grouped procedures (one imaging study supporting multiple ordered procedures, e.g. chest/abdomen/pelvis CT).

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

                    The requesting/referring physician.

                    ShortReferring physician
                    Control0..1
                    TypeReference(Practitioner, PractitionerRole)
                    Is Modifierfalse
                    Summarytrue
                    Alternate NamesReferringPhysiciansName
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    54. ImagingStudy.interpreter
                    Definition

                    Who read the study and interpreted the images or other content.

                    ShortWho interpreted images
                    Control0..*
                    TypeReference(Practitioner, PractitionerRole)
                    Is Modifierfalse
                    Summarytrue
                    Alternate NamesName of Physician(s) Reading Study
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    56. ImagingStudy.endpoint
                    Definition

                    The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.

                    ShortStudy access endpoint
                    Comments

                    Typical endpoint types include DICOM WADO-RS, which is used to retrieve DICOM instances in native or rendered (e.g., JPG, PNG), formats using a RESTful API; DICOM WADO-URI, which can similarly retrieve native or rendered instances, except using an HTTP query-based approach; DICOM QIDO-RS, which allows RESTful query for DICOM information without retrieving the actual instances; or IHE Invoke Image Display (IID), which provides standard invocation of an imaging web viewer.

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

                    Access methods for viewing (e.g., IHE’s IID profile) or retrieving (e.g., DICOM’s WADO-URI and WADO-RS) the study or the study’s series or instances. The study-level baseLocation applies to each series in the study, unless overridden in series by a series-level baseLocation of the same type.

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

                    Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.

                    ShortNumber of Study Related Series
                    Control0..1
                    TypeunsignedInt
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Alternate NamesNumberOfStudyRelatedSeries
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    60. ImagingStudy.numberOfInstances
                    Definition

                    Number of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.

                    ShortNumber of Study Related Instances
                    Control0..1
                    TypeunsignedInt
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Alternate NamesNumberOfStudyRelatedInstances
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    62. ImagingStudy.procedureReference
                    Definition

                    The procedure which this ImagingStudy was part of.

                    ShortThe performed Procedure reference
                    Control0..1
                    TypeReference(Procedure)
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    64. ImagingStudy.procedureCode
                    Definition

                    The code for the performed procedure type.

                    ShortThe performed procedure code
                    Control0..*
                    BindingUnless not suitable, these codes SHALL be taken from http://www.rsna.org/RadLex_Playbook.aspx
                    (extensible to http://www.rsna.org/RadLex_Playbook.aspx)

                    The performed procedure type.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summarytrue
                    Alternate NamesProcedureCodeSequence
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    66. ImagingStudy.location
                    Definition

                    The principal physical location where the ImagingStudy was performed.

                    ShortWhere ImagingStudy occurred
                    Control0..1
                    TypeReference(Location)
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting).

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

                    Description of clinical condition indicating why the ImagingStudy was requested.

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

                    The reason for the study.

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

                    Indicates another resource whose existence justifies this Study.

                    ShortWhy was study performed
                    Control0..*
                    TypeReference(Condition, Observation, Media, DiagnosticReport, DocumentReference)
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    72. ImagingStudy.note
                    Definition

                    Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.

                    ShortUser-defined comments
                    Control0..*
                    TypeAnnotation
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    74. ImagingStudy.description
                    Definition

                    The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.

                    ShortInstitution-generated description
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Alternate NamesStudyDescription
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    76. ImagingStudy.series
                    Definition

                    Each study has one or more series of images or other content.

                    ShortEach study has one or more series of instances
                    Control0..*
                    TypeBackboneElement
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    78. ImagingStudy.series.id
                    Definition

                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    80. ImagingStudy.series.extension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    82. ImagingStudy.series.modifierExtension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                    Summarytrue
                    Requirements

                    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                    Alternate Namesextensions, user content, modifiers
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    84. ImagingStudy.series.uid
                    Definition

                    The DICOM Series Instance UID for the series.

                    ShortDICOM Series Instance UID for the series
                    Comments

                    See DICOM PS3.3 C.7.3.

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

                    DICOM Series Instance UID.

                    Alternate NamesSeriesInstanceUID
                    ExampleGeneral: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    86. ImagingStudy.series.number
                    Definition

                    The numeric identifier of this series in the study.

                    ShortNumeric identifier of this series
                    Control0..1
                    TypeunsignedInt
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Alternate NamesSeriesNumber
                    ExampleGeneral: 3
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    88. ImagingStudy.series.modality
                    Definition

                    The modality of this series sequence.

                    ShortThe modality of the instances in the series
                    Control1..1
                    BindingUnless not suitable, these codes SHALL be taken from AcquisitionModality .
                    (extensible to http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html)

                    Type of acquired data in the instance.

                    TypeCoding
                    Is Modifierfalse
                    Summarytrue
                    Alternate NamesModality
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    90. ImagingStudy.series.modality.id
                    Definition

                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    92. ImagingStudy.series.modality.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 ImagingStudy.series.modality.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 94. ImagingStudy.series.modality.extension:modality
                      Slice Namemodality
                      Definition

                      R5: ImagingStudy.series.modality additional types (CodeableConcept) additional types from child elements (text)

                      ShortR5: The modality used for this series additional types
                      Comments

                      Element ImagingStudy.series.modality is mapped to FHIR R4 element ImagingStudy.series.modality as SourceIsBroaderThanTarget. The mappings for ImagingStudy.series.modality do not cover the following types: CodeableConcept. The mappings for ImagingStudy.series.modality do not cover the following types based on type expansion: text.

                      Control1..1
                      TypeExtension(R5: The modality used for this series additional types) (Extension Type: CodeableConcept)
                      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())
                      96. ImagingStudy.series.modality.system
                      Definition

                      The identification of the code system that defines the meaning of the symbol in the code.

                      ShortIdentity of the terminology system
                      Comments

                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

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

                      Need to be unambiguous about the source of the definition of the symbol.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      98. ImagingStudy.series.modality.version
                      Definition

                      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                      ShortVersion of the system - if relevant
                      Comments

                      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                      NoteThis is a business version Id, not a resource version Id (see discussion)
                      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()))
                      100. ImagingStudy.series.modality.code
                      Definition

                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                      ShortSymbol in syntax defined by the system
                      Control0..1
                      Typecode
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Need to refer to a particular code in the system.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      102. ImagingStudy.series.modality.display
                      Definition

                      A representation of the meaning of the code in the system, following the rules of the system.

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

                      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      104. ImagingStudy.series.modality.userSelected
                      Definition

                      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                      ShortIf this coding was chosen directly by the user
                      Comments

                      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

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

                      A description of the series.

                      ShortA short human readable summary of the series
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Alternate NamesSeriesDescription
                      ExampleGeneral: CT Surview 180
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      108. ImagingStudy.series.numberOfInstances
                      Definition

                      Number of SOP Instances in the Study. The value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.

                      ShortNumber of Series Related Instances
                      Control0..1
                      TypeunsignedInt
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Alternate NamesNumberOfSeriesRelatedInstances
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      110. ImagingStudy.series.endpoint
                      Definition

                      The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.connectionType.

                      ShortSeries access endpoint
                      Comments

                      Typical endpoint types include DICOM WADO-RS, which is used to retrieve DICOM instances in native or rendered (e.g., JPG, PNG) formats using a RESTful API; DICOM WADO-URI, which can similarly retrieve native or rendered instances, except using an HTTP query-based approach; and DICOM QIDO-RS, which allows RESTful query for DICOM information without retrieving the actual instances.

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

                      Access methods for retrieving (e.g., DICOM’s WADO-URI and WADO-RS) the series or the series’ instances. A baseLocation specified at the series level has precedence over a baseLocation of the same type specified at the study level.

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

                      The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality.

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

                      Codes describing anatomical locations. May include laterality.

                      TypeCoding
                      Is Modifierfalse
                      Summarytrue
                      Alternate NamesBodyPartExamined
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      114. ImagingStudy.series.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
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      116. ImagingStudy.series.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 ImagingStudy.series.bodySite.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 118. ImagingStudy.series.bodySite.extension:bodySite
                        Slice NamebodySite
                        Definition

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

                        ShortR5: bodySite additional types
                        Comments

                        Element ImagingStudy.series.bodySite is mapped to FHIR R4 element ImagingStudy.series.bodySite as SourceIsBroaderThanTarget. The mappings for ImagingStudy.series.bodySite do not cover the following types: CodeableReference. The mappings for ImagingStudy.series.bodySite do not cover the following types based on type expansion: concept, reference.

                        Control0..1
                        TypeExtension(R5: bodySite additional types) (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())
                        120. ImagingStudy.series.bodySite.system
                        Definition

                        The identification of the code system that defines the meaning of the symbol in the code.

                        ShortIdentity of the terminology system
                        Comments

                        The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

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

                        Need to be unambiguous about the source of the definition of the symbol.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        122. ImagingStudy.series.bodySite.version
                        Definition

                        The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                        ShortVersion of the system - if relevant
                        Comments

                        Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                        NoteThis is a business version Id, not a resource version Id (see discussion)
                        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()))
                        124. ImagingStudy.series.bodySite.code
                        Definition

                        A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                        ShortSymbol in syntax defined by the system
                        Control0..1
                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        Need to refer to a particular code in the system.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        126. ImagingStudy.series.bodySite.display
                        Definition

                        A representation of the meaning of the code in the system, following the rules of the system.

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

                        Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        128. ImagingStudy.series.bodySite.userSelected
                        Definition

                        Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                        ShortIf this coding was chosen directly by the user
                        Comments

                        Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                        This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

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

                        The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite.

                        ShortBody part laterality
                        Control0..1
                        BindingFor example codes, see Laterality
                        (example to http://hl7.org/fhir/ValueSet/bodysite-laterality|4.0.1)

                        Codes describing body site laterality (left, right, etc.).

                        TypeCoding
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        132. ImagingStudy.series.laterality.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        134. ImagingStudy.series.laterality.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 ImagingStudy.series.laterality.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 136. ImagingStudy.series.laterality.extension:laterality
                          Slice Namelaterality
                          Definition

                          R5: ImagingStudy.series.laterality additional types (CodeableConcept) additional types from child elements (text)

                          ShortR5: laterality additional types
                          Comments

                          Element ImagingStudy.series.laterality is mapped to FHIR R4 element ImagingStudy.series.laterality as SourceIsBroaderThanTarget. The mappings for ImagingStudy.series.laterality do not cover the following types: CodeableConcept. The mappings for ImagingStudy.series.laterality do not cover the following types based on type expansion: text.

                          Control0..1
                          TypeExtension(R5: laterality additional types) (Extension Type: CodeableConcept)
                          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())
                          138. ImagingStudy.series.laterality.system
                          Definition

                          The identification of the code system that defines the meaning of the symbol in the code.

                          ShortIdentity of the terminology system
                          Comments

                          The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

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

                          Need to be unambiguous about the source of the definition of the symbol.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          140. ImagingStudy.series.laterality.version
                          Definition

                          The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                          ShortVersion of the system - if relevant
                          Comments

                          Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                          NoteThis is a business version Id, not a resource version Id (see discussion)
                          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()))
                          142. ImagingStudy.series.laterality.code
                          Definition

                          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                          ShortSymbol in syntax defined by the system
                          Control0..1
                          Typecode
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          Need to refer to a particular code in the system.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          144. ImagingStudy.series.laterality.display
                          Definition

                          A representation of the meaning of the code in the system, following the rules of the system.

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

                          Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          146. ImagingStudy.series.laterality.userSelected
                          Definition

                          Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                          ShortIf this coding was chosen directly by the user
                          Comments

                          Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                          This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

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

                          The specimen imaged, e.g., for whole slide imaging of a biopsy.

                          ShortSpecimen imaged
                          Control0..*
                          TypeReference(Specimen)
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          150. ImagingStudy.series.started
                          Definition

                          The date and time the series was started.

                          ShortWhen the series started
                          Control0..1
                          TypedateTime
                          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()))
                          152. ImagingStudy.series.performer
                          Definition

                          Indicates who or what performed the series and how they were involved.

                          ShortWho performed the series
                          Comments

                          If the person who performed the series is not known, their Organization may be recorded. A patient, or related person, may be the performer, e.g. for patient-captured images.

                          Control0..*
                          TypeBackboneElement
                          Is Modifierfalse
                          Summarytrue
                          Requirements

                          The performer is recorded at the series level, since each series in a study may be performed by a different performer, at different times, and using different devices. A series may be performed by multiple performers.

                          Alternate NamesPerformingPhysicianName, OperatorName
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          154. ImagingStudy.series.performer.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          156. ImagingStudy.series.performer.extension
                          Definition

                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                          ShortAdditional content defined by implementations
                          Comments

                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                          Control0..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesextensions, user content
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          158. ImagingStudy.series.performer.modifierExtension
                          Definition

                          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                          ShortExtensions that cannot be ignored even if unrecognized
                          Comments

                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                          Control0..*
                          TypeExtension
                          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                          Summarytrue
                          Requirements

                          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                          Alternate Namesextensions, user content, modifiers
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          160. ImagingStudy.series.performer.function
                          Definition

                          Distinguishes the type of involvement of the performer in the series.

                          ShortType of performance
                          Control0..1
                          BindingUnless not suitable, these codes SHALL be taken from ImagingStudySeriesPerformerFunction
                          (extensible to http://hl7.org/fhir/ValueSet/series-performer-function|4.0.1)

                          The type of involvement of the performer.

                          TypeCodeableConcept
                          Is Modifierfalse
                          Summarytrue
                          Requirements

                          Allows disambiguation of the types of involvement of different performers.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          162. ImagingStudy.series.performer.actor
                          Definition

                          Indicates who or what performed the series.

                          ShortWho performed the series
                          Control1..1
                          TypeReference(Practitioner, PractitionerRole, Organization, CareTeam, Patient, Device, RelatedPerson)
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          164. ImagingStudy.series.performer.actor.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          166. ImagingStudy.series.performer.actor.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 ImagingStudy.series.performer.actor.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 168. ImagingStudy.series.performer.actor.extension:actor
                            Slice Nameactor
                            Definition

                            R5: ImagingStudy.series.performer.actor

                            ShortR5: actor
                            Comments

                            Element ImagingStudy.series.performer.actor is mapped to FHIR R4 element ImagingStudy.series.performer.actor as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element ImagingStudy.series.performer.actor with unmapped reference targets: HealthcareService.

                            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())
                            170. ImagingStudy.series.performer.actor.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()))
                            172. ImagingStudy.series.performer.actor.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.0.1)

                            Aa resource (or, for logical models, the URI of the logical model).

                            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()))
                            174. ImagingStudy.series.performer.actor.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()))
                            176. ImagingStudy.series.performer.actor.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()))
                            178. ImagingStudy.series.instance
                            Definition

                            A single SOP instance within the series, e.g. an image, or presentation state.

                            ShortA single SOP instance from the series
                            Control0..*
                            TypeBackboneElement
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            180. ImagingStudy.series.instance.id
                            Definition

                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                            ShortUnique id for inter-element referencing
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            182. ImagingStudy.series.instance.extension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                            ShortAdditional content defined by implementations
                            Comments

                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                            Control0..*
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Alternate Namesextensions, user content
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            184. ImagingStudy.series.instance.modifierExtension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                            ShortExtensions that cannot be ignored even if unrecognized
                            Comments

                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                            Control0..*
                            TypeExtension
                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                            Summarytrue
                            Requirements

                            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                            Alternate Namesextensions, user content, modifiers
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            186. ImagingStudy.series.instance.uid
                            Definition

                            The DICOM SOP Instance UID for this image or other DICOM content.

                            ShortDICOM SOP Instance UID
                            Comments

                            See DICOM PS3.3 C.12.1.

                            Control1..1
                            Typeid
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Requirements

                            DICOM SOP Instance UID.

                            Alternate NamesSOPInstanceUID
                            ExampleGeneral: 2.16.124.113543.6003.189642796.63084.16748.2599092903
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            188. ImagingStudy.series.instance.sopClass
                            Definition

                            DICOM instance type.

                            ShortDICOM class type
                            Control1..1
                            BindingUnless not suitable, these codes SHALL be taken from http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1
                            (extensible to http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1)

                            The sopClass for the instance.

                            TypeCoding
                            Is Modifierfalse
                            Summaryfalse
                            Alternate NamesSOPClassUID
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            190. ImagingStudy.series.instance.number
                            Definition

                            The number of instance in the series.

                            ShortThe number of this instance in the series
                            Control0..1
                            TypeunsignedInt
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Alternate NamesInstanceNumber
                            ExampleGeneral: 1
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            192. ImagingStudy.series.instance.title
                            Definition

                            The description of the instance.

                            ShortDescription of instance
                            Comments

                            Particularly for post-acquisition analytic objects, such as SR, presentation states, value mapping, etc.

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