Class ImagingStudy

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class ImagingStudy extends DomainResource
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.
See Also:
  • Field Details

    • identifier

      Identifiers for the ImagingStudy such as DICOM Study Instance UID.
    • status

      The current state of the ImagingStudy resource. This is not the status of any ServiceRequest or Task resources associated with the ImagingStudy.
    • modality

      protected List<Coding> modality
      A list of all the distinct values of series.modality. This may include both acquisition and non-acquisition modalities.
    • subject

      protected Reference subject
      The subject, typically a patient, of the imaging study.
    • encounter

      protected Reference encounter
      The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made.
    • started

      protected DateTimeType started
      Date and time the study started.
    • basedOn

      protected List<Reference> basedOn
      A list of the diagnostic requests that resulted in this imaging study being performed.
    • referrer

      protected Reference referrer
      The requesting/referring physician.
    • interpreter

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

      protected List<Reference> endpoint
      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.
    • numberOfSeries

      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.
    • numberOfInstances

      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.
    • procedure

      The procedure or code from which this ImagingStudy was part of.
    • location

      protected Reference location
      The principal physical location where the ImagingStudy was performed.
    • reason

      Description of clinical condition indicating why the ImagingStudy was requested, and/or Indicates another resource whose existence justifies this Study.
    • note

      protected List<Annotation> note
      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.
    • description

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

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

      public static final String SP_BASEDON
      Search parameter: basedon

      Description: The order for the image, such as Accession Number associated with a ServiceRequest
      Type: reference
      Path: ImagingStudy.basedOn

      See Also:
    • BASEDON

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASEDON
      Fluent Client search parameter constant for basedon

      Description: The order for the image, such as Accession Number associated with a ServiceRequest
      Type: reference
      Path: ImagingStudy.basedOn

    • INCLUDE_BASEDON

      public static final ca.uhn.fhir.model.api.Include INCLUDE_BASEDON
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ImagingStudy:basedon".
    • SP_BODYSITE

      public static final String SP_BODYSITE
      Search parameter: bodysite

      Description: The body site studied
      Type: token
      Path: ImagingStudy.series.bodySite

      See Also:
    • BODYSITE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam BODYSITE
      Fluent Client search parameter constant for bodysite

      Description: The body site studied
      Type: token
      Path: ImagingStudy.series.bodySite

    • SP_DICOM_CLASS

      public static final String SP_DICOM_CLASS
      Search parameter: dicom-class

      Description: The type of the instance
      Type: token
      Path: ImagingStudy.series.instance.sopClass

      See Also:
    • DICOM_CLASS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam DICOM_CLASS
      Fluent Client search parameter constant for dicom-class

      Description: The type of the instance
      Type: token
      Path: ImagingStudy.series.instance.sopClass

    • SP_ENCOUNTER

      public static final String SP_ENCOUNTER
      Search parameter: encounter

      Description: The context of the study
      Type: reference
      Path: ImagingStudy.encounter

      See Also:
    • ENCOUNTER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER
      Fluent Client search parameter constant for encounter

      Description: The context of the study
      Type: reference
      Path: ImagingStudy.encounter

    • INCLUDE_ENCOUNTER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ImagingStudy:encounter".
    • SP_ENDPOINT

      public static final String SP_ENDPOINT
      Search parameter: endpoint

      Description: The endpoint for the study or series
      Type: reference
      Path: ImagingStudy.endpoint | ImagingStudy.series.endpoint

      See Also:
    • ENDPOINT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENDPOINT
      Fluent Client search parameter constant for endpoint

      Description: The endpoint for the study or series
      Type: reference
      Path: ImagingStudy.endpoint | ImagingStudy.series.endpoint

    • INCLUDE_ENDPOINT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ENDPOINT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ImagingStudy:endpoint".
    • SP_INSTANCE

      public static final String SP_INSTANCE
      Search parameter: instance

      Description: SOP Instance UID for an instance
      Type: token
      Path: ImagingStudy.series.instance.uid

      See Also:
    • INSTANCE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam INSTANCE
      Fluent Client search parameter constant for instance

      Description: SOP Instance UID for an instance
      Type: token
      Path: ImagingStudy.series.instance.uid

    • SP_INTERPRETER

      public static final String SP_INTERPRETER
      Search parameter: interpreter

      Description: Who interpreted the images
      Type: reference
      Path: ImagingStudy.interpreter

      See Also:
    • INTERPRETER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INTERPRETER
      Fluent Client search parameter constant for interpreter

      Description: Who interpreted the images
      Type: reference
      Path: ImagingStudy.interpreter

    • INCLUDE_INTERPRETER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_INTERPRETER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ImagingStudy:interpreter".
    • SP_MODALITY

      public static final String SP_MODALITY
      Search parameter: modality

      Description: The modality of the series
      Type: token
      Path: ImagingStudy.series.modality

      See Also:
    • MODALITY

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam MODALITY
      Fluent Client search parameter constant for modality

      Description: The modality of the series
      Type: token
      Path: ImagingStudy.series.modality

    • SP_PERFORMER

      public static final String SP_PERFORMER
      Search parameter: performer

      Description: The person who performed the study
      Type: reference
      Path: ImagingStudy.series.performer.actor

      See Also:
    • PERFORMER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PERFORMER
      Fluent Client search parameter constant for performer

      Description: The person who performed the study
      Type: reference
      Path: ImagingStudy.series.performer.actor

    • INCLUDE_PERFORMER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PERFORMER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ImagingStudy:performer".
    • SP_REASON

      public static final String SP_REASON
      Search parameter: reason

      Description: The reason for the study
      Type: token
      Path: null

      See Also:
    • REASON

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam REASON
      Fluent Client search parameter constant for reason

      Description: The reason for the study
      Type: token
      Path: null

    • SP_REFERRER

      public static final String SP_REFERRER
      Search parameter: referrer

      Description: The referring physician
      Type: reference
      Path: ImagingStudy.referrer

      See Also:
    • REFERRER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REFERRER
      Fluent Client search parameter constant for referrer

      Description: The referring physician
      Type: reference
      Path: ImagingStudy.referrer

    • INCLUDE_REFERRER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_REFERRER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ImagingStudy:referrer".
    • SP_SERIES

      public static final String SP_SERIES
      Search parameter: series

      Description: DICOM Series Instance UID for a series
      Type: token
      Path: ImagingStudy.series.uid

      See Also:
    • SERIES

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam SERIES
      Fluent Client search parameter constant for series

      Description: DICOM Series Instance UID for a series
      Type: token
      Path: ImagingStudy.series.uid

    • SP_STARTED

      public static final String SP_STARTED
      Search parameter: started

      Description: When the study was started
      Type: date
      Path: ImagingStudy.started

      See Also:
    • STARTED

      public static final ca.uhn.fhir.rest.gclient.DateClientParam STARTED
      Fluent Client search parameter constant for started

      Description: When the study was started
      Type: date
      Path: ImagingStudy.started

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: The status of the study
      Type: token
      Path: ImagingStudy.status

      See Also:
    • STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

      Description: The status of the study
      Type: token
      Path: ImagingStudy.status

    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter: subject

      Description: Who the study is about
      Type: reference
      Path: ImagingStudy.subject

      See Also:
    • SUBJECT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
      Fluent Client search parameter constant for subject

      Description: Who the study is about
      Type: reference
      Path: ImagingStudy.subject

    • INCLUDE_SUBJECT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ImagingStudy:subject".
    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): External ids for this item [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Goal](goal.html): External Ids for this goal [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [List](list.html): Business identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationUsage](medicationusage.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Procedure](procedure.html): A unique identifier for a procedure [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
      Type: token
      Path: AllergyIntolerance.identifier | CarePlan.identifier | CareTeam.identifier | Composition.identifier | Condition.identifier | Consent.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DiagnosticReport.identifier | DocumentManifest.masterIdentifier | DocumentManifest.identifier | DocumentReference.content.identifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationUsage.identifier | NutritionOrder.identifier | Observation.identifier | Procedure.identifier | RiskAssessment.identifier | ServiceRequest.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | VisionPrescription.identifier

      See Also:
    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): External ids for this item [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Goal](goal.html): External Ids for this goal [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [List](list.html): Business identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationUsage](medicationusage.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Procedure](procedure.html): A unique identifier for a procedure [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
      Type: token
      Path: AllergyIntolerance.identifier | CarePlan.identifier | CareTeam.identifier | Composition.identifier | Condition.identifier | Consent.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DiagnosticReport.identifier | DocumentManifest.masterIdentifier | DocumentManifest.identifier | DocumentReference.content.identifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationUsage.identifier | NutritionOrder.identifier | Observation.identifier | Procedure.identifier | RiskAssessment.identifier | ServiceRequest.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | VisionPrescription.identifier

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter: patient

      Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient assessed [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationUsage](medicationusage.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
      Type: reference
      Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | DetectedIssue.patient | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationUsage.subject.where(resolve() is Patient) | NutritionOrder.patient | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.patient | VisionPrescription.patient

      See Also:
    • PATIENT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
      Fluent Client search parameter constant for patient

      Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient assessed [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationUsage](medicationusage.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
      Type: reference
      Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | DetectedIssue.patient | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationUsage.subject.where(resolve() is Patient) | NutritionOrder.patient | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.patient | VisionPrescription.patient

    • INCLUDE_PATIENT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ImagingStudy:patient".
  • Constructor Details

  • Method Details