org.hl7.fhir.dstu2016may.model

Class ImagingExcerpt

java.lang.Object

org.hl7.fhir.dstu2016may.model.Base

org.hl7.fhir.dstu2016may.model.BaseResource

org.hl7.fhir.dstu2016may.model.Resource

org.hl7.fhir.dstu2016may.model.DomainResource

org.hl7.fhir.dstu2016may.model.ImagingExcerpt

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 ImagingExcerpt
extends DomainResource

A manifest of a set of DICOM Service-Object Pair Instances (SOP Instances). The referenced SOP Instances (images or other content) are for a single patient, and may be from one or more studies. The referenced SOP Instances have been selected for a purpose, such as quality assurance, conference, or consult. Reflecting that range of purposes, typical ImagingExcerpt resources may include all SOP Instances in a study (perhaps for sharing through a Health Information Exchange); key images from multiple studies (for reference by a referring or treating physician); a multi-frame ultrasound instance ("cine" video clip) and a set of measurements taken from that instance (for inclusion in a teaching file); and so on.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImagingExcerpt.DWebType
static class	ImagingExcerpt.DWebTypeEnumFactory
static class	ImagingExcerpt.InstanceComponent
static class	ImagingExcerpt.InstanceDicomComponent
static class	ImagingExcerpt.SeriesComponent
static class	ImagingExcerpt.SeriesDicomComponent
static class	ImagingExcerpt.StudyComponent
static class	ImagingExcerpt.StudyDicomComponent
static class	ImagingExcerpt.StudyViewableComponent

Field Summary

Fields

Modifier and Type	Field and Description
protected Reference	author Author of ImagingExcerpt.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	AUTHOR Fluent Client search parameter constant for author
static ca.uhn.fhir.rest.gclient.DateClientParam	AUTHORING_TIME Fluent Client search parameter constant for authoring-time
protected DateTimeType	authoringTime Date and time when the selection of the referenced instances were made.
protected Resource	authorTarget The actual object that is the target of the reference (Author of ImagingExcerpt.
protected StringType	description Text description of the DICOM SOP instances selected in the ImagingExcerpt.
static ca.uhn.fhir.rest.gclient.UriClientParam	IDENTIFIER Fluent Client search parameter constant for identifier
static ca.uhn.fhir.model.api.Include	INCLUDE_AUTHOR Constant for fluent queries to be used to add include statements.
static ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT Constant for fluent queries to be used to add include statements.
protected Reference	patient A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingExcerpt.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT Fluent Client search parameter constant for patient
protected Patient	patientTarget The actual object that is the target of the reference (A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingExcerpt.)
static ca.uhn.fhir.rest.gclient.UriClientParam	SELECTED_STUDY Fluent Client search parameter constant for selected-study
static String	SP_AUTHOR Search parameter: author
static String	SP_AUTHORING_TIME Search parameter: authoring-time
static String	SP_IDENTIFIER Search parameter: identifier
static String	SP_PATIENT Search parameter: patient
static String	SP_SELECTED_STUDY Search parameter: selected-study
static String	SP_TITLE Search parameter: title
protected List<ImagingExcerpt.StudyComponent>	study Study identity and locating information of the DICOM SOP instances in the selection.
protected CodeableConcept	title The reason for, or significance of, the selection of objects referenced in the resource.
static ca.uhn.fhir.rest.gclient.TokenClientParam	TITLE Fluent Client search parameter constant for title
protected OidType	uid Unique identifier of the DICOM Key Object Selection (KOS) representation.

Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor and Description
ImagingExcerpt() Constructor
ImagingExcerpt(OidType uid, Reference patient, CodeableConcept title) Constructor

Method Summary

Modifier and Type	Method and Description
Base	addChild(String name)
ImagingExcerpt.StudyComponent	addStudy()
ImagingExcerpt	addStudy(ImagingExcerpt.StudyComponent t)
ImagingExcerpt	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
Reference	getAuthor()
Date	getAuthoringTime()
DateTimeType	getAuthoringTimeElement()
Resource	getAuthorTarget()
String	getDescription()
StringType	getDescriptionElement()
Reference	getPatient()
Patient	getPatientTarget()
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
List<ImagingExcerpt.StudyComponent>	getStudy()
CodeableConcept	getTitle()
String	getUid()
OidType	getUidElement()
boolean	hasAuthor()
boolean	hasAuthoringTime()
boolean	hasAuthoringTimeElement()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasPatient()
boolean	hasStudy()
boolean	hasTitle()
boolean	hasUid()
boolean	hasUidElement()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
Base	makeProperty(int hash, String name)
ImagingExcerpt	setAuthor(Reference value)
ImagingExcerpt	setAuthoringTime(Date value)
ImagingExcerpt	setAuthoringTimeElement(DateTimeType value)
ImagingExcerpt	setAuthorTarget(Resource value)
ImagingExcerpt	setDescription(String value)
ImagingExcerpt	setDescriptionElement(StringType value)
ImagingExcerpt	setPatient(Reference value)
ImagingExcerpt	setPatientTarget(Patient value)
void	setProperty(int hash, String name, Base value)
void	setProperty(String name, Base value)
ImagingExcerpt	setTitle(CodeableConcept value)
ImagingExcerpt	setUid(String value)
ImagingExcerpt	setUidElement(OidType value)
protected ImagingExcerpt	typedCopy()

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource

copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource

getStructureFhirVersionEnum, setId

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base

castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, 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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Field Detail

uid

protected OidType uid

Unique identifier of the DICOM Key Object Selection (KOS) representation.

patient

protected Reference patient

A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingExcerpt.

patientTarget

protected Patient patientTarget

The actual object that is the target of the reference (A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingExcerpt.)

authoringTime

protected DateTimeType authoringTime

Date and time when the selection of the referenced instances were made. It is (typically) different from the creation date of the selection resource, and from dates associated with the referenced instances (e.g. capture time of the referenced image).

author

protected Reference author

Author of ImagingExcerpt. It can be a human author or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attach in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion.

authorTarget

protected Resource authorTarget

The actual object that is the target of the reference (Author of ImagingExcerpt. It can be a human author or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attach in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion.)

title

protected CodeableConcept title

The reason for, or significance of, the selection of objects referenced in the resource.

description

protected StringType description

Text description of the DICOM SOP instances selected in the ImagingExcerpt. This should be aligned with the content of the title element, and can provide further explanation of the SOP instances in the selection.

study

protected List<ImagingExcerpt.StudyComponent> study

Study identity and locating information of the DICOM SOP instances in the selection.

SP_SELECTED_STUDY

public static final String SP_SELECTED_STUDY

Search parameter: selected-study

Description: Study selected in key DICOM object selection
Type: uri
Path: ImagingExcerpt.study.uid

See Also:

Constant Field Values

SELECTED_STUDY

public static final ca.uhn.fhir.rest.gclient.UriClientParam SELECTED_STUDY

Fluent Client search parameter constant for selected-study

Description: Study selected in key DICOM object selection
Type: uri
Path: ImagingExcerpt.study.uid

SP_AUTHOR

public static final String SP_AUTHOR

Search parameter: author

Description: Author of key DICOM object selection
Type: reference
Path: ImagingExcerpt.author

See Also:

Constant Field Values

AUTHOR

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AUTHOR

Fluent Client search parameter constant for author

Description: Author of key DICOM object selection
Type: reference
Path: ImagingExcerpt.author

INCLUDE_AUTHOR

public static final ca.uhn.fhir.model.api.Include INCLUDE_AUTHOR

Constant for fluent queries to be used to add include statements. Specifies the path value of "ImagingExcerpt:author".

SP_TITLE

public static final String SP_TITLE

Search parameter: title

Description: Title of key DICOM object selection
Type: token
Path: ImagingExcerpt.title

See Also:

Constant Field Values

TITLE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam TITLE

Fluent Client search parameter constant for title

Description: Title of key DICOM object selection
Type: token
Path: ImagingExcerpt.title

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: Subject of key DICOM object selection
Type: reference
Path: ImagingExcerpt.patient

See Also:

Constant Field Values

PATIENT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT

Fluent Client search parameter constant for patient

Description: Subject of key DICOM object selection
Type: reference
Path: ImagingExcerpt.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 "ImagingExcerpt:patient".

SP_AUTHORING_TIME

public static final String SP_AUTHORING_TIME

Search parameter: authoring-time

Description: Time of key DICOM object selection authoring
Type: date
Path: ImagingExcerpt.authoringTime

See Also:

Constant Field Values

AUTHORING_TIME

public static final ca.uhn.fhir.rest.gclient.DateClientParam AUTHORING_TIME

Fluent Client search parameter constant for authoring-time

Description: Time of key DICOM object selection authoring
Type: date
Path: ImagingExcerpt.authoringTime

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: UID of key DICOM object selection
Type: uri
Path: ImagingExcerpt.uid

See Also:

Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.UriClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: UID of key DICOM object selection
Type: uri
Path: ImagingExcerpt.uid

Constructor Detail

ImagingExcerpt

public ImagingExcerpt()

Constructor

ImagingExcerpt

public ImagingExcerpt(OidType uid,
                      Reference patient,
                      CodeableConcept title)

Constructor

Method Detail

getUidElement

public OidType getUidElement()

Returns:

uid (Unique identifier of the DICOM Key Object Selection (KOS) representation.). 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 ImagingExcerpt setUidElement(OidType value)

Parameters:

value - uid (Unique identifier of the DICOM Key Object Selection (KOS) representation.). This is the underlying object with id, value and extensions. The accessor "getUid" gives direct access to the value

getUid

public String getUid()

Returns:

Unique identifier of the DICOM Key Object Selection (KOS) representation.

setUid

public ImagingExcerpt setUid(String value)

Parameters:

value - Unique identifier of the DICOM Key Object Selection (KOS) representation.

getPatient

public Reference getPatient()

Returns:

patient (A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingExcerpt.)

hasPatient

public boolean hasPatient()

setPatient

public ImagingExcerpt setPatient(Reference value)

Parameters:

value - patient (A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingExcerpt.)

getPatientTarget

public Patient getPatientTarget()

Returns:

patient The 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. (A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingExcerpt.)

setPatientTarget

public ImagingExcerpt setPatientTarget(Patient value)

Parameters:

value - patient The 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. (A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingExcerpt.)

getAuthoringTimeElement

public DateTimeType getAuthoringTimeElement()

Returns:

authoringTime (Date and time when the selection of the referenced instances were made. It is (typically) different from the creation date of the selection resource, and from dates associated with the referenced instances (e.g. capture time of the referenced image).). This is the underlying object with id, value and extensions. The accessor "getAuthoringTime" gives direct access to the value

hasAuthoringTimeElement

public boolean hasAuthoringTimeElement()

hasAuthoringTime

public boolean hasAuthoringTime()

setAuthoringTimeElement

public ImagingExcerpt setAuthoringTimeElement(DateTimeType value)

Parameters:

value - authoringTime (Date and time when the selection of the referenced instances were made. It is (typically) different from the creation date of the selection resource, and from dates associated with the referenced instances (e.g. capture time of the referenced image).). This is the underlying object with id, value and extensions. The accessor "getAuthoringTime" gives direct access to the value

getAuthoringTime

public Date getAuthoringTime()

Returns:

Date and time when the selection of the referenced instances were made. It is (typically) different from the creation date of the selection resource, and from dates associated with the referenced instances (e.g. capture time of the referenced image).

setAuthoringTime

public ImagingExcerpt setAuthoringTime(Date value)

Parameters:

value - Date and time when the selection of the referenced instances were made. It is (typically) different from the creation date of the selection resource, and from dates associated with the referenced instances (e.g. capture time of the referenced image).

getAuthor

public Reference getAuthor()

Returns:

author (Author of ImagingExcerpt. It can be a human author or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attach in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion.)

hasAuthor

public boolean hasAuthor()

setAuthor

public ImagingExcerpt setAuthor(Reference value)

Parameters:

value - author (Author of ImagingExcerpt. It can be a human author or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attach in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion.)

getAuthorTarget

public Resource getAuthorTarget()

Returns:

author The 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. (Author of ImagingExcerpt. It can be a human author or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attach in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion.)

setAuthorTarget

public ImagingExcerpt setAuthorTarget(Resource value)

Parameters:

value - author The 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. (Author of ImagingExcerpt. It can be a human author or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attach in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion.)

getTitle

public CodeableConcept getTitle()

Returns:

title (The reason for, or significance of, the selection of objects referenced in the resource.)

hasTitle

public boolean hasTitle()

setTitle

public ImagingExcerpt setTitle(CodeableConcept value)

Parameters:

value - title (The reason for, or significance of, the selection of objects referenced in the resource.)

getDescriptionElement

public StringType getDescriptionElement()

Returns:

description (Text description of the DICOM SOP instances selected in the ImagingExcerpt. This should be aligned with the content of the title element, and can provide further explanation of the SOP instances in the selection.). 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 ImagingExcerpt setDescriptionElement(StringType value)

Parameters:

value - description (Text description of the DICOM SOP instances selected in the ImagingExcerpt. This should be aligned with the content of the title element, and can provide further explanation of the SOP instances in the selection.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

getDescription

public String getDescription()

Returns:

Text description of the DICOM SOP instances selected in the ImagingExcerpt. This should be aligned with the content of the title element, and can provide further explanation of the SOP instances in the selection.

setDescription

public ImagingExcerpt setDescription(String value)

Parameters:

value - Text description of the DICOM SOP instances selected in the ImagingExcerpt. This should be aligned with the content of the title element, and can provide further explanation of the SOP instances in the selection.

getStudy

public List<ImagingExcerpt.StudyComponent> getStudy()

Returns:

study (Study identity and locating information of the DICOM SOP instances in the selection.)

hasStudy

public boolean hasStudy()

addStudy

public ImagingExcerpt.StudyComponent addStudy()

Returns:

study (Study identity and locating information of the DICOM SOP instances in the selection.)

addStudy

public ImagingExcerpt addStudy(ImagingExcerpt.StudyComponent t)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class DomainResource

getProperty

public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public void setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Overrides:

fhirType in class DomainResource

copy

public ImagingExcerpt copy()

Specified by:

copy in class DomainResource

typedCopy

protected ImagingExcerpt typedCopy()

equalsDeep

public boolean equalsDeep(Base other)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource