Class ImagingStudy
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.BaseResource
-
- org.hl7.fhir.dstu3.model.Resource
-
- org.hl7.fhir.dstu3.model.DomainResource
-
- org.hl7.fhir.dstu3.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.InstanceAvailabilitystatic classImagingStudy.InstanceAvailabilityEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected IdentifieraccessionAccession Number is an identifier related to some aspect of imaging workflow and data management.static ca.uhn.fhir.rest.gclient.TokenClientParamACCESSIONFluent Client search parameter constant for accessionprotected Enumeration<ImagingStudy.InstanceAvailability>availabilityAvailability of study (online, offline, or nearline).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 ReferencecontextThe encounter or episode at which the request is initiated.static ca.uhn.fhir.rest.gclient.ReferenceClientParamCONTEXTFluent Client search parameter constant for contextprotected ResourcecontextTargetThe actual object that is the target of the reference (The encounter or episode at which the request is initiated.)protected StringTypedescriptionInstitution-generated description or classification of the Study performed.static ca.uhn.fhir.rest.gclient.UriClientParamDICOM_CLASSFluent Client search parameter constant for dicom-classprotected 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>identifierOther identifiers for the study.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_CONTEXTConstant 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_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.protected List<Reference>interpreterWho read the study and interpreted the images or other content.protected List<Practitioner>interpreterTargetThe actual objects that are the target of the reference (Who read the study and interpreted the images or other content.)static ca.uhn.fhir.rest.gclient.TokenClientParamMODALITYFluent Client search parameter constant for modalityprotected List<Coding>modalityListA list of all the Series.ImageModality values that are actual acquisition modalities, i.e.protected UnsignedIntTypenumberOfInstancesNumber of SOP Instances in Study.protected UnsignedIntTypenumberOfSeriesNumber of Series in the Study.protected ReferencepatientThe patient imaged in the study.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientprotected PatientpatientTargetThe actual object that is the target of the reference (The patient imaged in the study.)static ca.uhn.fhir.rest.gclient.ReferenceClientParamPERFORMERFluent Client search parameter constant for performerprotected List<CodeableConcept>procedureCodeThe code for the performed procedure type.protected List<Reference>procedureReferenceA reference to the performed Procedure.protected List<Procedure>procedureReferenceTargetThe actual objects that are the target of the reference (A reference to the performed Procedure.)protected CodeableConceptreasonDescription of clinical condition indicating why the ImagingStudy was requested.static ca.uhn.fhir.rest.gclient.TokenClientParamREASONFluent Client search parameter constant for reasonprotected ReferencereferrerThe requesting/referring physician.protected PractitionerreferrerTargetThe 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.UriClientParamSERIESFluent Client search parameter constant for seriesstatic StringSP_ACCESSIONSearch parameter: accessionstatic StringSP_BASEDONSearch parameter: basedonstatic StringSP_BODYSITESearch parameter: bodysitestatic StringSP_CONTEXTSearch parameter: contextstatic StringSP_DICOM_CLASSSearch parameter: dicom-classstatic StringSP_ENDPOINTSearch parameter: endpointstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_MODALITYSearch parameter: modalitystatic StringSP_PATIENTSearch parameter: patientstatic StringSP_PERFORMERSearch parameter: performerstatic StringSP_REASONSearch parameter: reasonstatic StringSP_SERIESSearch parameter: seriesstatic StringSP_STARTEDSearch parameter: startedstatic StringSP_STUDYSearch parameter: studystatic StringSP_UIDSearch parameter: uidprotected DateTimeTypestartedDate and time the study started.static ca.uhn.fhir.rest.gclient.DateClientParamSTARTEDFluent Client search parameter constant for startedstatic ca.uhn.fhir.rest.gclient.UriClientParamSTUDYFluent Client search parameter constant for studyprotected OidTypeuidFormal identifier for the study.static ca.uhn.fhir.rest.gclient.UriClientParamUIDFluent Client search parameter constant for uid-
Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description ImagingStudy()ConstructorImagingStudy(OidType uid, Reference patient)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, 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.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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
-
accession
protected Identifier accession
Accession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance [IHE Radiology Technical Framework Volume 1 Appendix A](http://www.ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Rev13.0_Vol1_FT_2014-07-30.pdf).
-
identifier
protected List<Identifier> identifier
Other identifiers for the study.
-
availability
protected Enumeration<ImagingStudy.InstanceAvailability> availability
Availability of study (online, offline, or nearline).
-
modalityList
protected List<Coding> modalityList
A list of all the Series.ImageModality 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).
-
patientTarget
protected Patient patientTarget
The actual object that is the target of the reference (The patient imaged in the study.)
-
contextTarget
protected Resource contextTarget
The actual object that is the target of the reference (The encounter or episode at which the request is initiated.)
-
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 Practitioner 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<Practitioner> 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.type.
-
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.type.)
-
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 List<Reference> procedureReference
A reference to the performed Procedure.
-
procedureReferenceTarget
protected List<Procedure> procedureReferenceTarget
The actual objects that are the target of the reference (A reference to the performed Procedure.)
-
procedureCode
protected List<CodeableConcept> procedureCode
The code for the performed procedure type.
-
reason
protected CodeableConcept reason
Description of clinical condition indicating why the ImagingStudy was requested.
-
description
protected StringType description
Institution-generated description or classification of the Study 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: Other identifiers for the Study
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: Other identifiers for the Study
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.reason
- 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.reason
-
SP_STUDY
public static final String SP_STUDY
Search parameter: studyDescription: The study identifier for the image
Type: uri
Path: ImagingStudy.uid
- See Also:
- Constant Field Values
-
STUDY
public static final ca.uhn.fhir.rest.gclient.UriClientParam STUDY
Fluent Client search parameter constant for studyDescription: The study identifier for the image
Type: uri
Path: ImagingStudy.uid
-
SP_DICOM_CLASS
public static final String SP_DICOM_CLASS
Search parameter: dicom-classDescription: The type of the instance
Type: uri
Path: ImagingStudy.series.instance.sopClass
- See Also:
- Constant Field Values
-
DICOM_CLASS
public static final ca.uhn.fhir.rest.gclient.UriClientParam DICOM_CLASS
Fluent Client search parameter constant for dicom-classDescription: The type of the instance
Type: uri
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_PERFORMER
public static final String SP_PERFORMER
Search parameter: performerDescription: The person who performed the study
Type: reference
Path: ImagingStudy.series.performer
- 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
-
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_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_ACCESSION
public static final String SP_ACCESSION
Search parameter: accessionDescription: The accession identifier for the study
Type: token
Path: ImagingStudy.accession
- See Also:
- Constant Field Values
-
ACCESSION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam ACCESSION
Fluent Client search parameter constant for accessionDescription: The accession identifier for the study
Type: token
Path: ImagingStudy.accession
-
SP_UID
public static final String SP_UID
Search parameter: uidDescription: The instance unique identifier
Type: uri
Path: ImagingStudy.series.instance.uid
- See Also:
- Constant Field Values
-
UID
public static final ca.uhn.fhir.rest.gclient.UriClientParam UID
Fluent Client search parameter constant for uidDescription: The instance unique identifier
Type: uri
Path: ImagingStudy.series.instance.uid
-
SP_ENDPOINT
public static final String SP_ENDPOINT
Search parameter: endpointDescription: The endpoint for te 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 te 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.patient
- 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.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".
-
SP_SERIES
public static final String SP_SERIES
Search parameter: seriesDescription: The identifier of the series of images
Type: uri
Path: ImagingStudy.series.uid
- See Also:
- Constant Field Values
-
SERIES
public static final ca.uhn.fhir.rest.gclient.UriClientParam SERIES
Fluent Client search parameter constant for seriesDescription: The identifier of the series of images
Type: uri
Path: ImagingStudy.series.uid
-
SP_CONTEXT
public static final String SP_CONTEXT
Search parameter: contextDescription: The context of the study
Type: reference
Path: ImagingStudy.context
- See Also:
- Constant Field Values
-
CONTEXT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONTEXT
Fluent Client search parameter constant for contextDescription: The context of the study
Type: reference
Path: ImagingStudy.context
-
INCLUDE_CONTEXT
public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTEXT
Constant for fluent queries to be used to add include statements. Specifies the path value of "ImagingStudy:context".
-
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".
-
-
Constructor Detail
-
ImagingStudy
public ImagingStudy()
Constructor
-
ImagingStudy
public ImagingStudy(OidType uid, Reference patient)
Constructor
-
-
Method Detail
-
getUidElement
public OidType getUidElement()
- Returns:
uid(Formal identifier for the study.). This is the underlying object with id, value and extensions. The accessor "getUid" gives direct access to the value
-
hasUidElement
public boolean hasUidElement()
-
hasUid
public boolean hasUid()
-
setUidElement
public ImagingStudy setUidElement(OidType value)
- Parameters:
value-uid(Formal identifier for the study.). This is the underlying object with id, value and extensions. The accessor "getUid" gives direct access to the value
-
setUid
public ImagingStudy setUid(String value)
- Parameters:
value- Formal identifier for the study.
-
getAccession
public Identifier getAccession()
- Returns:
accession(Accession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance [IHE Radiology Technical Framework Volume 1 Appendix A](http://www.ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Rev13.0_Vol1_FT_2014-07-30.pdf).)
-
hasAccession
public boolean hasAccession()
-
setAccession
public ImagingStudy setAccession(Identifier value)
- Parameters:
value-accession(Accession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance [IHE Radiology Technical Framework Volume 1 Appendix A](http://www.ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Rev13.0_Vol1_FT_2014-07-30.pdf).)
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(Other identifiers for the study.)
-
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
-
getAvailabilityElement
public Enumeration<ImagingStudy.InstanceAvailability> getAvailabilityElement()
- Returns:
availability(Availability of study (online, offline, or nearline).). This is the underlying object with id, value and extensions. The accessor "getAvailability" gives direct access to the value
-
hasAvailabilityElement
public boolean hasAvailabilityElement()
-
hasAvailability
public boolean hasAvailability()
-
setAvailabilityElement
public ImagingStudy setAvailabilityElement(Enumeration<ImagingStudy.InstanceAvailability> value)
- Parameters:
value-availability(Availability of study (online, offline, or nearline).). This is the underlying object with id, value and extensions. The accessor "getAvailability" gives direct access to the value
-
getAvailability
public ImagingStudy.InstanceAvailability getAvailability()
- Returns:
- Availability of study (online, offline, or nearline).
-
setAvailability
public ImagingStudy setAvailability(ImagingStudy.InstanceAvailability value)
- Parameters:
value- Availability of study (online, offline, or nearline).
-
getModalityList
public List<Coding> getModalityList()
- Returns:
modalityList(A list of all the Series.ImageModality 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).)
-
setModalityList
public ImagingStudy setModalityList(List<Coding> theModalityList)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasModalityList
public boolean hasModalityList()
-
addModalityList
public Coding addModalityList()
-
addModalityList
public ImagingStudy addModalityList(Coding t)
-
getModalityListFirstRep
public Coding getModalityListFirstRep()
- Returns:
- The first repetition of repeating field
modalityList, creating it if it does not already exist
-
getPatient
public Reference getPatient()
- Returns:
patient(The patient imaged in the study.)
-
hasPatient
public boolean hasPatient()
-
setPatient
public ImagingStudy setPatient(Reference value)
- Parameters:
value-patient(The patient imaged in the study.)
-
getPatientTarget
public Patient getPatientTarget()
- Returns:
patientThe 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 patient imaged in the study.)
-
setPatientTarget
public ImagingStudy setPatientTarget(Patient value)
- Parameters:
value-patientThe 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 patient imaged in the study.)
-
getContext
public Reference getContext()
- Returns:
context(The encounter or episode at which the request is initiated.)
-
hasContext
public boolean hasContext()
-
setContext
public ImagingStudy setContext(Reference value)
- Parameters:
value-context(The encounter or episode at which the request is initiated.)
-
getContextTarget
public Resource getContextTarget()
- Returns:
contextThe 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 encounter or episode at which the request is initiated.)
-
setContextTarget
public ImagingStudy setContextTarget(Resource value)
- Parameters:
value-contextThe 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 encounter or episode at which the request is initiated.)
-
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 Practitioner 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(Practitioner 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<Practitioner> getInterpreterTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addInterpreterTarget
@Deprecated public Practitioner addInterpreterTarget()
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.type.)
-
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 List<Reference> getProcedureReference()
- Returns:
procedureReference(A reference to the performed Procedure.)
-
setProcedureReference
public ImagingStudy setProcedureReference(List<Reference> theProcedureReference)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasProcedureReference
public boolean hasProcedureReference()
-
addProcedureReference
public Reference addProcedureReference()
-
addProcedureReference
public ImagingStudy addProcedureReference(Reference t)
-
getProcedureReferenceFirstRep
public Reference getProcedureReferenceFirstRep()
- Returns:
- The first repetition of repeating field
procedureReference, creating it if it does not already exist
-
getProcedureReferenceTarget
@Deprecated public List<Procedure> getProcedureReferenceTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addProcedureReferenceTarget
@Deprecated public Procedure addProcedureReferenceTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
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
-
getReason
public CodeableConcept getReason()
- Returns:
reason(Description of clinical condition indicating why the ImagingStudy was requested.)
-
hasReason
public boolean hasReason()
-
setReason
public ImagingStudy setReason(CodeableConcept value)
- Parameters:
value-reason(Description of clinical condition indicating why the ImagingStudy was requested.)
-
getDescriptionElement
public StringType getDescriptionElement()
- Returns:
description(Institution-generated description or classification of the Study 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(Institution-generated description or classification of the Study 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:
- Institution-generated description or classification of the Study performed.
-
setDescription
public ImagingStudy setDescription(String value)
- Parameters:
value- Institution-generated description or classification of the Study 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
-
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
-
-