
Class ImagingManifest
- 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.ImagingManifest
-
- 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 ImagingManifest extends DomainResource
A text description of the DICOM SOP instances selected in the ImagingManifest; or the reason for, or significance of, the selection.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ImagingManifest.InstanceComponent
static class
ImagingManifest.SeriesComponent
static class
ImagingManifest.StudyComponent
-
Field Summary
Fields Modifier and Type Field Description protected Reference
author
Author of ImagingManifest.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
AUTHOR
Fluent Client search parameter constant for authorstatic ca.uhn.fhir.rest.gclient.DateClientParam
AUTHORING_TIME
Fluent Client search parameter constant for authoring-timeprotected 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 ImagingManifest.protected StringType
description
Free text narrative description of the ImagingManifest.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
ENDPOINT
Fluent Client search parameter constant for endpointprotected Identifier
identifier
Unique identifier of the DICOM Key Object Selection (KOS) that this resource represents.static ca.uhn.fhir.rest.gclient.TokenClientParam
IDENTIFIER
Fluent Client search parameter constant for identifierstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
IMAGING_STUDY
Fluent Client search parameter constant for imaging-studystatic 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_ENDPOINT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_IMAGING_STUDY
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 ImagingManifest.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
PATIENT
Fluent Client search parameter constant for patientprotected 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 ImagingManifest.)static ca.uhn.fhir.rest.gclient.UriClientParam
SELECTED_STUDY
Fluent Client search parameter constant for selected-studystatic String
SP_AUTHOR
Search parameter: authorstatic String
SP_AUTHORING_TIME
Search parameter: authoring-timestatic String
SP_ENDPOINT
Search parameter: endpointstatic String
SP_IDENTIFIER
Search parameter: identifierstatic String
SP_IMAGING_STUDY
Search parameter: imaging-studystatic String
SP_PATIENT
Search parameter: patientstatic String
SP_SELECTED_STUDY
Search parameter: selected-studyprotected List<ImagingManifest.StudyComponent>
study
Study identity and locating information of the DICOM SOP instances in the selection.-
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 ImagingManifest()
ConstructorImagingManifest(Reference patient)
Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, 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
-
identifier
protected Identifier identifier
Unique identifier of the DICOM Key Object Selection (KOS) that this resource represents.
-
patient
protected Reference patient
A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingManifest.
-
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 ImagingManifest.)
-
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 ImagingManifest. 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 ImagingManifest. 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.)
-
description
protected StringType description
Free text narrative description of the ImagingManifest. The value may be derived from the DICOM Standard Part 16, CID-7010 descriptions (e.g. Best in Set, Complete Study Content). Note that those values cover the wide range of uses of the DICOM Key Object Selection object, several of which are not supported by ImagingManifest. Specifically, there is no expected behavior associated with descriptions that suggest referenced images be removed or not used.
-
study
protected List<ImagingManifest.StudyComponent> study
Study identity and locating information of the DICOM SOP instances in the selection.
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: UID of the ImagingManifest (or a DICOM Key Object Selection which it represents)
Type: token
Path: ImagingManifest.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: UID of the ImagingManifest (or a DICOM Key Object Selection which it represents)
Type: token
Path: ImagingManifest.identifier
-
SP_ENDPOINT
public static final String SP_ENDPOINT
Search parameter: endpointDescription: The endpoint for the study or series
Type: reference
Path: ImagingManifest.study.endpoint, ImagingManifest.study.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: ImagingManifest.study.endpoint, ImagingManifest.study.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 "ImagingManifest:endpoint".
-
SP_AUTHORING_TIME
public static final String SP_AUTHORING_TIME
Search parameter: authoring-timeDescription: Time of the ImagingManifest (or a DICOM Key Object Selection which it represents) authoring
Type: date
Path: ImagingManifest.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-timeDescription: Time of the ImagingManifest (or a DICOM Key Object Selection which it represents) authoring
Type: date
Path: ImagingManifest.authoringTime
-
SP_SELECTED_STUDY
public static final String SP_SELECTED_STUDY
Search parameter: selected-studyDescription: Study selected in the ImagingManifest (or a DICOM Key Object Selection which it represents)
Type: uri
Path: ImagingManifest.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-studyDescription: Study selected in the ImagingManifest (or a DICOM Key Object Selection which it represents)
Type: uri
Path: ImagingManifest.study.uid
-
SP_AUTHOR
public static final String SP_AUTHOR
Search parameter: authorDescription: Author of the ImagingManifest (or a DICOM Key Object Selection which it represents)
Type: reference
Path: ImagingManifest.author
- See Also:
- Constant Field Values
-
AUTHOR
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AUTHOR
Fluent Client search parameter constant for authorDescription: Author of the ImagingManifest (or a DICOM Key Object Selection which it represents)
Type: reference
Path: ImagingManifest.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 "ImagingManifest:author".
-
SP_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: Subject of the ImagingManifest (or a DICOM Key Object Selection which it represents)
Type: reference
Path: ImagingManifest.patient
- See Also:
- Constant Field Values
-
PATIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Fluent Client search parameter constant for patientDescription: Subject of the ImagingManifest (or a DICOM Key Object Selection which it represents)
Type: reference
Path: ImagingManifest.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 "ImagingManifest:patient".
-
SP_IMAGING_STUDY
public static final String SP_IMAGING_STUDY
Search parameter: imaging-studyDescription: ImagingStudy resource selected in the ImagingManifest (or a DICOM Key Object Selection which it represents)
Type: reference
Path: ImagingManifest.study.imagingStudy
- See Also:
- Constant Field Values
-
IMAGING_STUDY
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam IMAGING_STUDY
Fluent Client search parameter constant for imaging-studyDescription: ImagingStudy resource selected in the ImagingManifest (or a DICOM Key Object Selection which it represents)
Type: reference
Path: ImagingManifest.study.imagingStudy
-
INCLUDE_IMAGING_STUDY
public static final ca.uhn.fhir.model.api.Include INCLUDE_IMAGING_STUDY
Constant for fluent queries to be used to add include statements. Specifies the path value of "ImagingManifest:imaging-study".
-
-
Constructor Detail
-
ImagingManifest
public ImagingManifest()
Constructor
-
ImagingManifest
public ImagingManifest(Reference patient)
Constructor
-
-
Method Detail
-
getIdentifier
public Identifier getIdentifier()
- Returns:
identifier
(Unique identifier of the DICOM Key Object Selection (KOS) that this resource represents.)
-
hasIdentifier
public boolean hasIdentifier()
-
setIdentifier
public ImagingManifest setIdentifier(Identifier value)
- Parameters:
value
-identifier
(Unique identifier of the DICOM Key Object Selection (KOS) that this resource represents.)
-
getPatient
public Reference getPatient()
- Returns:
patient
(A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingManifest.)
-
hasPatient
public boolean hasPatient()
-
setPatient
public ImagingManifest setPatient(Reference value)
- Parameters:
value
-patient
(A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingManifest.)
-
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 ImagingManifest.)
-
setPatientTarget
public ImagingManifest 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 ImagingManifest.)
-
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 ImagingManifest 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 ImagingManifest 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 ImagingManifest. 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 ImagingManifest setAuthor(Reference value)
- Parameters:
value
-author
(Author of ImagingManifest. 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 ImagingManifest. 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 ImagingManifest 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 ImagingManifest. 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.)
-
getDescriptionElement
public StringType getDescriptionElement()
- Returns:
description
(Free text narrative description of the ImagingManifest. The value may be derived from the DICOM Standard Part 16, CID-7010 descriptions (e.g. Best in Set, Complete Study Content). Note that those values cover the wide range of uses of the DICOM Key Object Selection object, several of which are not supported by ImagingManifest. Specifically, there is no expected behavior associated with descriptions that suggest referenced images be removed or not used.). 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 ImagingManifest setDescriptionElement(StringType value)
- Parameters:
value
-description
(Free text narrative description of the ImagingManifest. The value may be derived from the DICOM Standard Part 16, CID-7010 descriptions (e.g. Best in Set, Complete Study Content). Note that those values cover the wide range of uses of the DICOM Key Object Selection object, several of which are not supported by ImagingManifest. Specifically, there is no expected behavior associated with descriptions that suggest referenced images be removed or not used.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
public String getDescription()
- Returns:
- Free text narrative description of the ImagingManifest. The value may be derived from the DICOM Standard Part 16, CID-7010 descriptions (e.g. Best in Set, Complete Study Content). Note that those values cover the wide range of uses of the DICOM Key Object Selection object, several of which are not supported by ImagingManifest. Specifically, there is no expected behavior associated with descriptions that suggest referenced images be removed or not used.
-
setDescription
public ImagingManifest setDescription(String value)
- Parameters:
value
- Free text narrative description of the ImagingManifest. The value may be derived from the DICOM Standard Part 16, CID-7010 descriptions (e.g. Best in Set, Complete Study Content). Note that those values cover the wide range of uses of the DICOM Key Object Selection object, several of which are not supported by ImagingManifest. Specifically, there is no expected behavior associated with descriptions that suggest referenced images be removed or not used.
-
getStudy
public List<ImagingManifest.StudyComponent> getStudy()
- Returns:
study
(Study identity and locating information of the DICOM SOP instances in the selection.)
-
setStudy
public ImagingManifest setStudy(List<ImagingManifest.StudyComponent> theStudy)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasStudy
public boolean hasStudy()
-
addStudy
public ImagingManifest.StudyComponent addStudy()
-
addStudy
public ImagingManifest addStudy(ImagingManifest.StudyComponent t)
-
getStudyFirstRep
public ImagingManifest.StudyComponent getStudyFirstRep()
- Returns:
- The first repetition of repeating field
study
, creating it if it does not already exist
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
public ImagingManifest copy()
- Specified by:
copy
in classDomainResource
-
typedCopy
protected ImagingManifest typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceType
in classResource
-
-