Class ImagingStudy
- java.lang.Object
-
- org.hl7.fhir.r4.model.Base
-
- org.hl7.fhir.r4.model.BaseResource
-
- org.hl7.fhir.r4.model.Resource
-
- org.hl7.fhir.r4.model.DomainResource
-
- org.hl7.fhir.r4.model.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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classImagingStudy.ImagingStudySeriesComponentstatic classImagingStudy.ImagingStudySeriesInstanceComponentstatic classImagingStudy.ImagingStudySeriesPerformerComponentstatic classImagingStudy.ImagingStudyStatusstatic classImagingStudy.ImagingStudyStatusEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected List<Reference>basedOnA list of the diagnostic requests that resulted in this imaging study being performed.static ca.uhn.fhir.rest.gclient.ReferenceClientParamBASEDONFluent Client search parameter constant for basedonprotected List<Resource>basedOnTargetThe actual objects that are the target of the reference (A list of the diagnostic requests that resulted in this imaging study being performed.)static ca.uhn.fhir.rest.gclient.TokenClientParamBODYSITEFluent Client search parameter constant for bodysiteprotected StringTypedescriptionThe Imaging Manager description of the study.static ca.uhn.fhir.rest.gclient.TokenClientParamDICOM_CLASSFluent Client search parameter constant for dicom-classprotected ReferenceencounterThe healthcare event (e.g.static ca.uhn.fhir.rest.gclient.ReferenceClientParamENCOUNTERFluent Client search parameter constant for encounterprotected EncounterencounterTargetThe actual object that is the target of the reference (The healthcare event (e.g.protected List<Reference>endpointThe network service providing access (e.g., query, view, or retrieval) for the study.static ca.uhn.fhir.rest.gclient.ReferenceClientParamENDPOINTFluent Client search parameter constant for endpointprotected List<Endpoint>endpointTargetThe actual objects that are the target of the reference (The network service providing access (e.g., query, view, or retrieval) for the study.protected List<Identifier>identifierIdentifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_BASEDONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_ENCOUNTERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_ENDPOINTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_INTERPRETERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PATIENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PERFORMERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_REFERRERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SUBJECTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.rest.gclient.TokenClientParamINSTANCEFluent Client search parameter constant for instanceprotected List<Reference>interpreterWho read the study and interpreted the images or other content.static ca.uhn.fhir.rest.gclient.ReferenceClientParamINTERPRETERFluent Client search parameter constant for interpreterprotected List<Resource>interpreterTargetThe actual objects that are the target of the reference (Who read the study and interpreted the images or other content.)protected ReferencelocationThe principal physical location where the ImagingStudy was performed.protected LocationlocationTargetThe actual object that is the target of the reference (The principal physical location where the ImagingStudy was performed.)protected List<Coding>modalityA list of all the series.modality values that are actual acquisition modalities, i.e.static ca.uhn.fhir.rest.gclient.TokenClientParamMODALITYFluent Client search parameter constant for modalityprotected List<Annotation>notePer the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030).protected UnsignedIntTypenumberOfInstancesNumber of SOP Instances in Study.protected UnsignedIntTypenumberOfSeriesNumber of Series in the Study.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientstatic ca.uhn.fhir.rest.gclient.ReferenceClientParamPERFORMERFluent Client search parameter constant for performerprotected List<CodeableConcept>procedureCodeThe code for the performed procedure type.protected ReferenceprocedureReferenceThe procedure which this ImagingStudy was part of.protected ProcedureprocedureReferenceTargetThe actual object that is the target of the reference (The procedure which this ImagingStudy was part of.)static ca.uhn.fhir.rest.gclient.TokenClientParamREASONFluent Client search parameter constant for reasonprotected List<CodeableConcept>reasonCodeDescription of clinical condition indicating why the ImagingStudy was requested.protected List<Reference>reasonReferenceIndicates another resource whose existence justifies this Study.protected List<Resource>reasonReferenceTargetThe actual objects that are the target of the reference (Indicates another resource whose existence justifies this Study.)protected ReferencereferrerThe requesting/referring physician.static ca.uhn.fhir.rest.gclient.ReferenceClientParamREFERRERFluent Client search parameter constant for referrerprotected ResourcereferrerTargetThe actual object that is the target of the reference (The requesting/referring physician.)protected List<ImagingStudy.ImagingStudySeriesComponent>seriesEach study has one or more series of images or other content.static ca.uhn.fhir.rest.gclient.TokenClientParamSERIESFluent Client search parameter constant for seriesstatic StringSP_BASEDONSearch parameter: basedonstatic StringSP_BODYSITESearch parameter: bodysitestatic StringSP_DICOM_CLASSSearch parameter: dicom-classstatic StringSP_ENCOUNTERSearch parameter: encounterstatic StringSP_ENDPOINTSearch parameter: endpointstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_INSTANCESearch parameter: instancestatic StringSP_INTERPRETERSearch parameter: interpreterstatic StringSP_MODALITYSearch parameter: modalitystatic StringSP_PATIENTSearch parameter: patientstatic StringSP_PERFORMERSearch parameter: performerstatic StringSP_REASONSearch parameter: reasonstatic StringSP_REFERRERSearch parameter: referrerstatic StringSP_SERIESSearch parameter: seriesstatic StringSP_STARTEDSearch parameter: startedstatic StringSP_STATUSSearch parameter: statusstatic StringSP_SUBJECTSearch parameter: subjectprotected DateTimeTypestartedDate and time the study started.static ca.uhn.fhir.rest.gclient.DateClientParamSTARTEDFluent Client search parameter constant for startedprotected Enumeration<ImagingStudy.ImagingStudyStatus>statusThe current state of the ImagingStudy.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected ReferencesubjectThe subject, typically a patient, of the imaging study.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUBJECTFluent Client search parameter constant for subjectprotected ResourcesubjectTargetThe actual object that is the target of the reference (The subject, typically a patient, of the imaging study.)-
Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description ImagingStudy()ConstructorImagingStudy(Enumeration<ImagingStudy.ImagingStudyStatus> status, Reference subject)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.
-
status
protected Enumeration<ImagingStudy.ImagingStudyStatus> status
The current state of the ImagingStudy.
-
modality
protected List<Coding> modality
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).
-
subjectTarget
protected Resource subjectTarget
The actual object that is the target of the reference (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.
-
encounterTarget
protected Encounter encounterTarget
The actual object that is the target of the reference (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.
-
basedOnTarget
protected List<Resource> basedOnTarget
The actual objects that are the target of the reference (A list of the diagnostic requests that resulted in this imaging study being performed.)
-
referrerTarget
protected Resource referrerTarget
The actual object that is the target of the reference (The requesting/referring physician.)
-
interpreter
protected List<Reference> interpreter
Who read the study and interpreted the images or other content.
-
interpreterTarget
protected List<Resource> interpreterTarget
The actual objects that are the target of the reference (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.
-
endpointTarget
protected List<Endpoint> endpointTarget
The actual objects that are the target of the reference (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
protected UnsignedIntType 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
protected UnsignedIntType 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.
-
procedureReference
protected Reference procedureReference
The procedure which this ImagingStudy was part of.
-
procedureReferenceTarget
protected Procedure procedureReferenceTarget
The actual object that is the target of the reference (The procedure which this ImagingStudy was part of.)
-
procedureCode
protected List<CodeableConcept> procedureCode
The code for the performed procedure type.
-
location
protected Reference location
The principal physical location where the ImagingStudy was performed.
-
locationTarget
protected Location locationTarget
The actual object that is the target of the reference (The principal physical location where the ImagingStudy was performed.)
-
reasonCode
protected List<CodeableConcept> reasonCode
Description of clinical condition indicating why the ImagingStudy was requested.
-
reasonReference
protected List<Reference> reasonReference
Indicates another resource whose existence justifies this Study.
-
reasonReferenceTarget
protected List<Resource> reasonReferenceTarget
The actual objects that are the target of the reference (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
protected StringType description
The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.
-
series
protected List<ImagingStudy.ImagingStudySeriesComponent> series
Each study has one or more series of images or other content.
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Identifiers for the Study, such as DICOM Study Instance UID and Accession number
Type: token
Path: ImagingStudy.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Identifiers for the Study, such as DICOM Study Instance UID and Accession number
Type: token
Path: ImagingStudy.identifier
-
SP_REASON
public static final String SP_REASON
Search parameter: reasonDescription: The reason for the study
Type: token
Path: ImagingStudy.reasonCode
- See Also:
- Constant Field Values
-
REASON
public static final ca.uhn.fhir.rest.gclient.TokenClientParam REASON
Fluent Client search parameter constant for reasonDescription: The reason for the study
Type: token
Path: ImagingStudy.reasonCode
-
SP_DICOM_CLASS
public static final String SP_DICOM_CLASS
Search parameter: dicom-classDescription: The type of the instance
Type: token
Path: ImagingStudy.series.instance.sopClass
- See Also:
- Constant Field Values
-
DICOM_CLASS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam DICOM_CLASS
Fluent Client search parameter constant for dicom-classDescription: The type of the instance
Type: token
Path: ImagingStudy.series.instance.sopClass
-
SP_MODALITY
public static final String SP_MODALITY
Search parameter: modalityDescription: The modality of the series
Type: token
Path: ImagingStudy.series.modality
- See Also:
- Constant Field Values
-
MODALITY
public static final ca.uhn.fhir.rest.gclient.TokenClientParam MODALITY
Fluent Client search parameter constant for modalityDescription: The modality of the series
Type: token
Path: ImagingStudy.series.modality
-
SP_BODYSITE
public static final String SP_BODYSITE
Search parameter: bodysiteDescription: The body site studied
Type: token
Path: ImagingStudy.series.bodySite
- See Also:
- Constant Field Values
-
BODYSITE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam BODYSITE
Fluent Client search parameter constant for bodysiteDescription: The body site studied
Type: token
Path: ImagingStudy.series.bodySite
-
SP_INSTANCE
public static final String SP_INSTANCE
Search parameter: instanceDescription: SOP Instance UID for an instance
Type: token
Path: ImagingStudy.series.instance.uid
- See Also:
- Constant Field Values
-
INSTANCE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam INSTANCE
Fluent Client search parameter constant for instanceDescription: SOP Instance UID for an instance
Type: token
Path: ImagingStudy.series.instance.uid
-
SP_PERFORMER
public static final String SP_PERFORMER
Search parameter: performerDescription: The person who performed the study
Type: reference
Path: ImagingStudy.series.performer.actor
- See Also:
- Constant Field Values
-
PERFORMER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PERFORMER
Fluent Client search parameter constant for performerDescription: 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_SUBJECT
public static final String SP_SUBJECT
Search parameter: subjectDescription: Who the study is about
Type: reference
Path: ImagingStudy.subject
- See Also:
- Constant Field Values
-
SUBJECT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
Fluent Client search parameter constant for subjectDescription: 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_STARTED
public static final String SP_STARTED
Search parameter: startedDescription: When the study was started
Type: date
Path: ImagingStudy.started
- See Also:
- Constant Field Values
-
STARTED
public static final ca.uhn.fhir.rest.gclient.DateClientParam STARTED
Fluent Client search parameter constant for startedDescription: When the study was started
Type: date
Path: ImagingStudy.started
-
SP_INTERPRETER
public static final String SP_INTERPRETER
Search parameter: interpreterDescription: Who interpreted the images
Type: reference
Path: ImagingStudy.interpreter
- See Also:
- Constant Field Values
-
INTERPRETER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INTERPRETER
Fluent Client search parameter constant for interpreterDescription: 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_ENCOUNTER
public static final String SP_ENCOUNTER
Search parameter: encounterDescription: The context of the study
Type: reference
Path: ImagingStudy.encounter
- See Also:
- Constant Field Values
-
ENCOUNTER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER
Fluent Client search parameter constant for encounterDescription: 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_REFERRER
public static final String SP_REFERRER
Search parameter: referrerDescription: The referring physician
Type: reference
Path: ImagingStudy.referrer
- See Also:
- Constant Field Values
-
REFERRER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REFERRER
Fluent Client search parameter constant for referrerDescription: 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_ENDPOINT
public static final String SP_ENDPOINT
Search parameter: endpointDescription: The endpoint for the study or series
Type: reference
Path: ImagingStudy.endpoint, ImagingStudy.series.endpoint
- See Also:
- Constant Field Values
-
ENDPOINT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENDPOINT
Fluent Client search parameter constant for endpointDescription: 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_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: Who the study is about
Type: reference
Path: ImagingStudy.subject
- See Also:
- Constant Field Values
-
PATIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Fluent Client search parameter constant for patientDescription: Who the study is about
Type: reference
Path: ImagingStudy.subject
-
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".
-
SP_SERIES
public static final String SP_SERIES
Search parameter: seriesDescription: DICOM Series Instance UID for a series
Type: token
Path: ImagingStudy.series.uid
- See Also:
- Constant Field Values
-
SERIES
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SERIES
Fluent Client search parameter constant for seriesDescription: DICOM Series Instance UID for a series
Type: token
Path: ImagingStudy.series.uid
-
SP_BASEDON
public static final String SP_BASEDON
Search parameter: basedonDescription: The order for the image
Type: reference
Path: ImagingStudy.basedOn
- See Also:
- Constant Field Values
-
BASEDON
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASEDON
Fluent Client search parameter constant for basedonDescription: The order for the image
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_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: The status of the study
Type: token
Path: ImagingStudy.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: The status of the study
Type: token
Path: ImagingStudy.status
-
-
Constructor Detail
-
ImagingStudy
public ImagingStudy()
Constructor
-
ImagingStudy
public ImagingStudy(Enumeration<ImagingStudy.ImagingStudyStatus> status, Reference subject)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.)
-
setIdentifier
public ImagingStudy setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public ImagingStudy addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist
-
getStatusElement
public Enumeration<ImagingStudy.ImagingStudyStatus> getStatusElement()
- Returns:
status(The current state of the ImagingStudy.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
public boolean hasStatusElement()
-
hasStatus
public boolean hasStatus()
-
setStatusElement
public ImagingStudy setStatusElement(Enumeration<ImagingStudy.ImagingStudyStatus> value)
- Parameters:
value-status(The current state of the ImagingStudy.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public ImagingStudy.ImagingStudyStatus getStatus()
- Returns:
- The current state of the ImagingStudy.
-
setStatus
public ImagingStudy setStatus(ImagingStudy.ImagingStudyStatus value)
- Parameters:
value- The current state of the ImagingStudy.
-
getModality
public List<Coding> getModality()
- Returns:
modality(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).)
-
setModality
public ImagingStudy setModality(List<Coding> theModality)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasModality
public boolean hasModality()
-
addModality
public Coding addModality()
-
addModality
public ImagingStudy addModality(Coding t)
-
getModalityFirstRep
public Coding getModalityFirstRep()
- Returns:
- The first repetition of repeating field
modality, creating it if it does not already exist
-
getSubject
public Reference getSubject()
- Returns:
subject(The subject, typically a patient, of the imaging study.)
-
hasSubject
public boolean hasSubject()
-
setSubject
public ImagingStudy setSubject(Reference value)
- Parameters:
value-subject(The subject, typically a patient, of the imaging study.)
-
getSubjectTarget
public Resource getSubjectTarget()
- Returns:
subjectThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The subject, typically a patient, of the imaging study.)
-
setSubjectTarget
public ImagingStudy setSubjectTarget(Resource value)
- Parameters:
value-subjectThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The subject, typically a patient, of the imaging study.)
-
getEncounter
public Reference getEncounter()
- Returns:
encounter(The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made.)
-
hasEncounter
public boolean hasEncounter()
-
setEncounter
public ImagingStudy setEncounter(Reference value)
- Parameters:
value-encounter(The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made.)
-
getEncounterTarget
public Encounter getEncounterTarget()
- Returns:
encounterThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made.)
-
setEncounterTarget
public ImagingStudy setEncounterTarget(Encounter value)
- Parameters:
value-encounterThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made.)
-
getStartedElement
public DateTimeType getStartedElement()
- Returns:
started(Date and time the study started.). This is the underlying object with id, value and extensions. The accessor "getStarted" gives direct access to the value
-
hasStartedElement
public boolean hasStartedElement()
-
hasStarted
public boolean hasStarted()
-
setStartedElement
public ImagingStudy setStartedElement(DateTimeType value)
- Parameters:
value-started(Date and time the study started.). This is the underlying object with id, value and extensions. The accessor "getStarted" gives direct access to the value
-
getStarted
public Date getStarted()
- Returns:
- Date and time the study started.
-
setStarted
public ImagingStudy setStarted(Date value)
- Parameters:
value- Date and time the study started.
-
getBasedOn
public List<Reference> getBasedOn()
- Returns:
basedOn(A list of the diagnostic requests that resulted in this imaging study being performed.)
-
setBasedOn
public ImagingStudy setBasedOn(List<Reference> theBasedOn)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasBasedOn
public boolean hasBasedOn()
-
addBasedOn
public Reference addBasedOn()
-
addBasedOn
public ImagingStudy addBasedOn(Reference t)
-
getBasedOnFirstRep
public Reference getBasedOnFirstRep()
- Returns:
- The first repetition of repeating field
basedOn, creating it if it does not already exist
-
getBasedOnTarget
@Deprecated public List<Resource> getBasedOnTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getReferrer
public Reference getReferrer()
- Returns:
referrer(The requesting/referring physician.)
-
hasReferrer
public boolean hasReferrer()
-
setReferrer
public ImagingStudy setReferrer(Reference value)
- Parameters:
value-referrer(The requesting/referring physician.)
-
getReferrerTarget
public Resource getReferrerTarget()
- Returns:
referrerThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The requesting/referring physician.)
-
setReferrerTarget
public ImagingStudy setReferrerTarget(Resource value)
- Parameters:
value-referrerThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The requesting/referring physician.)
-
getInterpreter
public List<Reference> getInterpreter()
- Returns:
interpreter(Who read the study and interpreted the images or other content.)
-
setInterpreter
public ImagingStudy setInterpreter(List<Reference> theInterpreter)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasInterpreter
public boolean hasInterpreter()
-
addInterpreter
public Reference addInterpreter()
-
addInterpreter
public ImagingStudy addInterpreter(Reference t)
-
getInterpreterFirstRep
public Reference getInterpreterFirstRep()
- Returns:
- The first repetition of repeating field
interpreter, creating it if it does not already exist
-
getInterpreterTarget
@Deprecated public List<Resource> getInterpreterTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getEndpoint
public List<Reference> getEndpoint()
- Returns:
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.)
-
setEndpoint
public ImagingStudy setEndpoint(List<Reference> theEndpoint)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEndpoint
public boolean hasEndpoint()
-
addEndpoint
public Reference addEndpoint()
-
addEndpoint
public ImagingStudy addEndpoint(Reference t)
-
getEndpointFirstRep
public Reference getEndpointFirstRep()
- Returns:
- The first repetition of repeating field
endpoint, creating it if it does not already exist
-
getEndpointTarget
@Deprecated public List<Endpoint> getEndpointTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addEndpointTarget
@Deprecated public Endpoint addEndpointTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getNumberOfSeriesElement
public UnsignedIntType getNumberOfSeriesElement()
- Returns:
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.). This is the underlying object with id, value and extensions. The accessor "getNumberOfSeries" gives direct access to the value
-
hasNumberOfSeriesElement
public boolean hasNumberOfSeriesElement()
-
hasNumberOfSeries
public boolean hasNumberOfSeries()
-
setNumberOfSeriesElement
public ImagingStudy setNumberOfSeriesElement(UnsignedIntType value)
- Parameters:
value-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.). This is the underlying object with id, value and extensions. The accessor "getNumberOfSeries" gives direct access to the value
-
getNumberOfSeries
public int getNumberOfSeries()
- Returns:
- 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.
-
setNumberOfSeries
public ImagingStudy setNumberOfSeries(int value)
- Parameters:
value- 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.
-
getNumberOfInstancesElement
public UnsignedIntType getNumberOfInstancesElement()
- Returns:
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.). This is the underlying object with id, value and extensions. The accessor "getNumberOfInstances" gives direct access to the value
-
hasNumberOfInstancesElement
public boolean hasNumberOfInstancesElement()
-
hasNumberOfInstances
public boolean hasNumberOfInstances()
-
setNumberOfInstancesElement
public ImagingStudy setNumberOfInstancesElement(UnsignedIntType value)
- Parameters:
value-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.). This is the underlying object with id, value and extensions. The accessor "getNumberOfInstances" gives direct access to the value
-
getNumberOfInstances
public int getNumberOfInstances()
- Returns:
- 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.
-
setNumberOfInstances
public ImagingStudy setNumberOfInstances(int value)
- Parameters:
value- 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.
-
getProcedureReference
public Reference getProcedureReference()
- Returns:
procedureReference(The procedure which this ImagingStudy was part of.)
-
hasProcedureReference
public boolean hasProcedureReference()
-
setProcedureReference
public ImagingStudy setProcedureReference(Reference value)
- Parameters:
value-procedureReference(The procedure which this ImagingStudy was part of.)
-
getProcedureReferenceTarget
public Procedure getProcedureReferenceTarget()
- Returns:
procedureReferenceThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The procedure which this ImagingStudy was part of.)
-
setProcedureReferenceTarget
public ImagingStudy setProcedureReferenceTarget(Procedure value)
- Parameters:
value-procedureReferenceThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The procedure which this ImagingStudy was part of.)
-
getProcedureCode
public List<CodeableConcept> getProcedureCode()
- Returns:
procedureCode(The code for the performed procedure type.)
-
setProcedureCode
public ImagingStudy setProcedureCode(List<CodeableConcept> theProcedureCode)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasProcedureCode
public boolean hasProcedureCode()
-
addProcedureCode
public CodeableConcept addProcedureCode()
-
addProcedureCode
public ImagingStudy addProcedureCode(CodeableConcept t)
-
getProcedureCodeFirstRep
public CodeableConcept getProcedureCodeFirstRep()
- Returns:
- The first repetition of repeating field
procedureCode, creating it if it does not already exist
-
getLocation
public Reference getLocation()
- Returns:
location(The principal physical location where the ImagingStudy was performed.)
-
hasLocation
public boolean hasLocation()
-
setLocation
public ImagingStudy setLocation(Reference value)
- Parameters:
value-location(The principal physical location where the ImagingStudy was performed.)
-
getLocationTarget
public Location getLocationTarget()
- Returns:
locationThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The principal physical location where the ImagingStudy was performed.)
-
setLocationTarget
public ImagingStudy setLocationTarget(Location value)
- Parameters:
value-locationThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The principal physical location where the ImagingStudy was performed.)
-
getReasonCode
public List<CodeableConcept> getReasonCode()
- Returns:
reasonCode(Description of clinical condition indicating why the ImagingStudy was requested.)
-
setReasonCode
public ImagingStudy setReasonCode(List<CodeableConcept> theReasonCode)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReasonCode
public boolean hasReasonCode()
-
addReasonCode
public CodeableConcept addReasonCode()
-
addReasonCode
public ImagingStudy addReasonCode(CodeableConcept t)
-
getReasonCodeFirstRep
public CodeableConcept getReasonCodeFirstRep()
- Returns:
- The first repetition of repeating field
reasonCode, creating it if it does not already exist
-
getReasonReference
public List<Reference> getReasonReference()
- Returns:
reasonReference(Indicates another resource whose existence justifies this Study.)
-
setReasonReference
public ImagingStudy setReasonReference(List<Reference> theReasonReference)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReasonReference
public boolean hasReasonReference()
-
addReasonReference
public Reference addReasonReference()
-
addReasonReference
public ImagingStudy addReasonReference(Reference t)
-
getReasonReferenceFirstRep
public Reference getReasonReferenceFirstRep()
- Returns:
- The first repetition of repeating field
reasonReference, creating it if it does not already exist
-
getReasonReferenceTarget
@Deprecated public List<Resource> getReasonReferenceTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getNote
public List<Annotation> getNote()
- Returns:
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.)
-
setNote
public ImagingStudy setNote(List<Annotation> theNote)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasNote
public boolean hasNote()
-
addNote
public Annotation addNote()
-
addNote
public ImagingStudy addNote(Annotation t)
-
getNoteFirstRep
public Annotation getNoteFirstRep()
- Returns:
- The first repetition of repeating field
note, creating it if it does not already exist
-
getDescriptionElement
public StringType getDescriptionElement()
- Returns:
description(The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
public boolean hasDescriptionElement()
-
hasDescription
public boolean hasDescription()
-
setDescriptionElement
public ImagingStudy setDescriptionElement(StringType value)
- Parameters:
value-description(The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
public String getDescription()
- Returns:
- The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.
-
setDescription
public ImagingStudy setDescription(String value)
- Parameters:
value- The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.
-
getSeries
public List<ImagingStudy.ImagingStudySeriesComponent> getSeries()
- Returns:
series(Each study has one or more series of images or other content.)
-
setSeries
public ImagingStudy setSeries(List<ImagingStudy.ImagingStudySeriesComponent> theSeries)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSeries
public boolean hasSeries()
-
addSeries
public ImagingStudy.ImagingStudySeriesComponent addSeries()
-
addSeries
public ImagingStudy addSeries(ImagingStudy.ImagingStudySeriesComponent t)
-
getSeriesFirstRep
public ImagingStudy.ImagingStudySeriesComponent getSeriesFirstRep()
- Returns:
- The first repetition of repeating field
series, creating it if it does not already exist
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public ImagingStudy copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(ImagingStudy dst)
-
typedCopy
protected ImagingStudy typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-