Package org.hl7.fhir.dstu3.model

Class DiagnosticReport

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.DiagnosticReport

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

The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DiagnosticReport.DiagnosticReportImageComponent
static class	DiagnosticReport.DiagnosticReportPerformerComponent
static enum	DiagnosticReport.DiagnosticReportStatus
static class	DiagnosticReport.DiagnosticReportStatusEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	BASED_ON	Fluent Client search parameter constant for based-on
protected List<Reference>	basedOn	Details concerning a test or procedure requested.
protected List<Resource>	basedOnTarget	The actual objects that are the target of the reference (Details concerning a test or procedure requested.)
protected CodeableConcept	category	A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI).
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CATEGORY	Fluent Client search parameter constant for category
protected CodeableConcept	code	A code or name that describes this diagnostic report.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CODE	Fluent Client search parameter constant for code
protected List<CodeableConcept>	codedDiagnosis	Codes for the conclusion.
protected StringType	conclusion	Concise and clinically contextualized impression / summary of the diagnostic report.
protected Reference	context	The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport per is about.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	CONTEXT	Fluent Client search parameter constant for context
protected Resource	contextTarget	The actual object that is the target of the reference (The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport per is about.)
static final ca.uhn.fhir.rest.gclient.DateClientParam	DATE	Fluent Client search parameter constant for date
static final ca.uhn.fhir.rest.gclient.TokenClientParam	DIAGNOSIS	Fluent Client search parameter constant for diagnosis
protected Type	effective	The time or time-period the observed values are related to.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ENCOUNTER	Fluent Client search parameter constant for encounter
protected List<Identifier>	identifier	Identifiers assigned to this report by the performer or other systems.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
protected List<DiagnosticReport.DiagnosticReportImageComponent>	image	A list of key images associated with this report.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	IMAGE	Fluent Client search parameter constant for image
protected List<Reference>	imagingStudy	One or more links to full details of any imaging performed during the diagnostic investigation.
protected List<Resource>	imagingStudyTarget	The actual objects that are the target of the reference (One or more links to full details of any imaging performed during the diagnostic investigation.
static final ca.uhn.fhir.model.api.Include	INCLUDE_BASED_ON	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_CONTEXT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_ENCOUNTER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_IMAGE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PERFORMER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_RESULT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SPECIMEN	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SUBJECT	Constant for fluent queries to be used to add include statements.
protected InstantType	issued	The date and time that this version of the report was released from the source diagnostic service.
static final ca.uhn.fhir.rest.gclient.DateClientParam	ISSUED	Fluent Client search parameter constant for issued
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
protected List<DiagnosticReport.DiagnosticReportPerformerComponent>	performer	Indicates who or what participated in producing the report.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PERFORMER	Fluent Client search parameter constant for performer
protected List<Attachment>	presentedForm	Rich text representation of the entire result as issued by the diagnostic service.
protected List<Reference>	result	Observations that are part of this diagnostic report.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	RESULT	Fluent Client search parameter constant for result
protected List<Observation>	resultTarget	The actual objects that are the target of the reference (Observations that are part of this diagnostic report.
static final String	SP_BASED_ON	Search parameter: based-on
static final String	SP_CATEGORY	Search parameter: category
static final String	SP_CODE	Search parameter: code
static final String	SP_CONTEXT	Search parameter: context
static final String	SP_DATE	Search parameter: date
static final String	SP_DIAGNOSIS	Search parameter: diagnosis
static final String	SP_ENCOUNTER	Search parameter: encounter
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_IMAGE	Search parameter: image
static final String	SP_ISSUED	Search parameter: issued
static final String	SP_PATIENT	Search parameter: patient
static final String	SP_PERFORMER	Search parameter: performer
static final String	SP_RESULT	Search parameter: result
static final String	SP_SPECIMEN	Search parameter: specimen
static final String	SP_STATUS	Search parameter: status
static final String	SP_SUBJECT	Search parameter: subject
protected List<Reference>	specimen	Details about the specimens on which this diagnostic report is based.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SPECIMEN	Fluent Client search parameter constant for specimen
protected List<Specimen>	specimenTarget	The actual objects that are the target of the reference (Details about the specimens on which this diagnostic report is based.)
protected Enumeration<DiagnosticReport.DiagnosticReportStatus>	status	The status of the diagnostic report as a whole.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected Reference	subject	The subject of the report.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUBJECT	Fluent Client search parameter constant for subject
protected Resource	subjectTarget	The actual object that is the target of the reference (The subject of the report.

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

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

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
DiagnosticReport()	Constructor
DiagnosticReport(Enumeration<DiagnosticReport.DiagnosticReportStatus> status, CodeableConcept code)	Constructor

Method Summary

Modifier and Type	Method	Description
Reference	addBasedOn()
DiagnosticReport	addBasedOn(Reference t)
Base	addChild(String name)
CodeableConcept	addCodedDiagnosis()
DiagnosticReport	addCodedDiagnosis(CodeableConcept t)
Identifier	addIdentifier()
DiagnosticReport	addIdentifier(Identifier t)
DiagnosticReport.DiagnosticReportImageComponent	addImage()
DiagnosticReport	addImage(DiagnosticReport.DiagnosticReportImageComponent t)
Reference	addImagingStudy()
DiagnosticReport	addImagingStudy(Reference t)
DiagnosticReport.DiagnosticReportPerformerComponent	addPerformer()
DiagnosticReport	addPerformer(DiagnosticReport.DiagnosticReportPerformerComponent t)
Attachment	addPresentedForm()
DiagnosticReport	addPresentedForm(Attachment t)
Reference	addResult()
DiagnosticReport	addResult(Reference t)
Observation	addResultTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Reference	addSpecimen()
DiagnosticReport	addSpecimen(Reference t)
Specimen	addSpecimenTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
DiagnosticReport	copy()
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<Reference>	getBasedOn()
Reference	getBasedOnFirstRep()
List<Resource>	getBasedOnTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
CodeableConcept	getCategory()
CodeableConcept	getCode()
List<CodeableConcept>	getCodedDiagnosis()
CodeableConcept	getCodedDiagnosisFirstRep()
String	getConclusion()
StringType	getConclusionElement()
Reference	getContext()
Resource	getContextTarget()
Type	getEffective()
DateTimeType	getEffectiveDateTimeType()
Period	getEffectivePeriod()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<DiagnosticReport.DiagnosticReportImageComponent>	getImage()
DiagnosticReport.DiagnosticReportImageComponent	getImageFirstRep()
List<Reference>	getImagingStudy()
Reference	getImagingStudyFirstRep()
List<Resource>	getImagingStudyTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Date	getIssued()
InstantType	getIssuedElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<DiagnosticReport.DiagnosticReportPerformerComponent>	getPerformer()
DiagnosticReport.DiagnosticReportPerformerComponent	getPerformerFirstRep()
List<Attachment>	getPresentedForm()
Attachment	getPresentedFormFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
List<Reference>	getResult()
Reference	getResultFirstRep()
List<Observation>	getResultTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
List<Reference>	getSpecimen()
Reference	getSpecimenFirstRep()
List<Specimen>	getSpecimenTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
DiagnosticReport.DiagnosticReportStatus	getStatus()
Enumeration<DiagnosticReport.DiagnosticReportStatus>	getStatusElement()
Reference	getSubject()
Resource	getSubjectTarget()
String[]	getTypesForProperty(int hash, String name)
boolean	hasBasedOn()
boolean	hasCategory()
boolean	hasCode()
boolean	hasCodedDiagnosis()
boolean	hasConclusion()
boolean	hasConclusionElement()
boolean	hasContext()
boolean	hasEffective()
boolean	hasEffectiveDateTimeType()
boolean	hasEffectivePeriod()
boolean	hasIdentifier()
boolean	hasImage()
boolean	hasImagingStudy()
boolean	hasIssued()
boolean	hasIssuedElement()
boolean	hasPerformer()
boolean	hasPresentedForm()
boolean	hasResult()
boolean	hasSpecimen()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubject()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
DiagnosticReport	setBasedOn(List<Reference> theBasedOn)
DiagnosticReport	setCategory(CodeableConcept value)
DiagnosticReport	setCode(CodeableConcept value)
DiagnosticReport	setCodedDiagnosis(List<CodeableConcept> theCodedDiagnosis)
DiagnosticReport	setConclusion(String value)
DiagnosticReport	setConclusionElement(StringType value)
DiagnosticReport	setContext(Reference value)
DiagnosticReport	setContextTarget(Resource value)
DiagnosticReport	setEffective(Type value)
DiagnosticReport	setIdentifier(List<Identifier> theIdentifier)
DiagnosticReport	setImage(List<DiagnosticReport.DiagnosticReportImageComponent> theImage)
DiagnosticReport	setImagingStudy(List<Reference> theImagingStudy)
DiagnosticReport	setIssued(Date value)
DiagnosticReport	setIssuedElement(InstantType value)
DiagnosticReport	setPerformer(List<DiagnosticReport.DiagnosticReportPerformerComponent> thePerformer)
DiagnosticReport	setPresentedForm(List<Attachment> thePresentedForm)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
DiagnosticReport	setResult(List<Reference> theResult)
DiagnosticReport	setSpecimen(List<Reference> theSpecimen)
DiagnosticReport	setStatus(DiagnosticReport.DiagnosticReportStatus value)
DiagnosticReport	setStatusElement(Enumeration<DiagnosticReport.DiagnosticReportStatus> value)
DiagnosticReport	setSubject(Reference value)
DiagnosticReport	setSubjectTarget(Resource value)
protected DiagnosticReport	typedCopy()

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

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

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

Identifiers assigned to this report by the performer or other systems.

basedOn

protected List<Reference> basedOn

Details concerning a test or procedure requested.

basedOnTarget

protected List<Resource> basedOnTarget

The actual objects that are the target of the reference (Details concerning a test or procedure requested.)

status

protected Enumeration<DiagnosticReport.DiagnosticReportStatus> status

The status of the diagnostic report as a whole.

category

protected CodeableConcept category

A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.

code

protected CodeableConcept code

A code or name that describes this diagnostic report.

subject

protected Reference subject

The subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources.

subjectTarget

protected Resource subjectTarget

The actual object that is the target of the reference (The subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources.)

context

protected Reference context

The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport per is about.

contextTarget

protected Resource contextTarget

The actual object that is the target of the reference (The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport per is about.)

effective

protected Type effective

The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.

issued

protected InstantType issued

The date and time that this version of the report was released from the source diagnostic service.

performer

protected List<DiagnosticReport.DiagnosticReportPerformerComponent> performer

Indicates who or what participated in producing the report.

specimen

protected List<Reference> specimen

Details about the specimens on which this diagnostic report is based.

specimenTarget

protected List<Specimen> specimenTarget

The actual objects that are the target of the reference (Details about the specimens on which this diagnostic report is based.)

result

protected List<Reference> result

Observations that are part of this diagnostic report. Observations can be simple name/value pairs (e.g. "atomic" results), or they can be grouping observations that include references to other members of the group (e.g. "panels").

resultTarget

protected List<Observation> resultTarget

The actual objects that are the target of the reference (Observations that are part of this diagnostic report. Observations can be simple name/value pairs (e.g. "atomic" results), or they can be grouping observations that include references to other members of the group (e.g. "panels").)

imagingStudy

protected List<Reference> imagingStudy

One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.

imagingStudyTarget

protected List<Resource> imagingStudyTarget

The actual objects that are the target of the reference (One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.)

image

protected List<DiagnosticReport.DiagnosticReportImageComponent> image

A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).

conclusion

protected StringType conclusion

Concise and clinically contextualized impression / summary of the diagnostic report.

codedDiagnosis

protected List<CodeableConcept> codedDiagnosis

Codes for the conclusion.

presentedForm

protected List<Attachment> presentedForm

Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.

SP_DATE

public static final String SP_DATE

Search parameter: date

Description: The clinically relevant time of the report
Type: date
Path: DiagnosticReport.effective[x]

See Also:

• Constant Field Values

DATE

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

Fluent Client search parameter constant for date

Description: The clinically relevant time of the report
Type: date
Path: DiagnosticReport.effective[x]

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: An identifier for the report
Type: token
Path: DiagnosticReport.identifier

See Also:

• Constant Field Values

IDENTIFIER

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

Fluent Client search parameter constant for identifier

Description: An identifier for the report
Type: token
Path: DiagnosticReport.identifier

SP_IMAGE

public static final String SP_IMAGE

Search parameter: image

Description: A reference to the image source.
Type: reference
Path: DiagnosticReport.image.link

See Also:

• Constant Field Values

IMAGE

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

Fluent Client search parameter constant for image

Description: A reference to the image source.
Type: reference
Path: DiagnosticReport.image.link

INCLUDE_IMAGE

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

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

SP_PERFORMER

public static final String SP_PERFORMER

Search parameter: performer

Description: Who was the source of the report (organization)
Type: reference
Path: DiagnosticReport.performer.actor

See Also:

• Constant Field Values

PERFORMER

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

Fluent Client search parameter constant for performer

Description: Who was the source of the report (organization)
Type: reference
Path: DiagnosticReport.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 "DiagnosticReport:performer".

SP_CODE

public static final String SP_CODE

Search parameter: code

Description: The code for the report as a whole, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result
Type: token
Path: DiagnosticReport.code

See Also:

• Constant Field Values

CODE

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

Fluent Client search parameter constant for code

Description: The code for the report as a whole, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result
Type: token
Path: DiagnosticReport.code

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter: subject

Description: The subject of the report
Type: reference
Path: DiagnosticReport.subject

See Also:

• Constant Field Values

SUBJECT

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

Fluent Client search parameter constant for subject

Description: The subject of the report
Type: reference
Path: DiagnosticReport.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 "DiagnosticReport:subject".

SP_DIAGNOSIS

public static final String SP_DIAGNOSIS

Search parameter: diagnosis

Description: A coded diagnosis on the report
Type: token
Path: DiagnosticReport.codedDiagnosis

See Also:

• Constant Field Values

DIAGNOSIS

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

Fluent Client search parameter constant for diagnosis

Description: A coded diagnosis on the report
Type: token
Path: DiagnosticReport.codedDiagnosis

SP_ENCOUNTER

public static final String SP_ENCOUNTER

Search parameter: encounter

Description: The Encounter when the order was made
Type: reference
Path: DiagnosticReport.context

See Also:

• Constant Field Values

ENCOUNTER

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

Fluent Client search parameter constant for encounter

Description: The Encounter when the order was made
Type: reference
Path: DiagnosticReport.context

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 "DiagnosticReport:encounter".

SP_RESULT

public static final String SP_RESULT

Search parameter: result

Description: Link to an atomic result (observation resource)
Type: reference
Path: DiagnosticReport.result

See Also:

• Constant Field Values

RESULT

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

Fluent Client search parameter constant for result

Description: Link to an atomic result (observation resource)
Type: reference
Path: DiagnosticReport.result

INCLUDE_RESULT

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

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

SP_BASED_ON

public static final String SP_BASED_ON

Search parameter: based-on

Description: Reference to the procedure request.
Type: reference
Path: DiagnosticReport.basedOn

See Also:

• Constant Field Values

BASED_ON

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

Fluent Client search parameter constant for based-on

Description: Reference to the procedure request.
Type: reference
Path: DiagnosticReport.basedOn

INCLUDE_BASED_ON

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

Constant for fluent queries to be used to add include statements. Specifies the path value of "DiagnosticReport:based-on".

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: The subject of the report if a patient
Type: reference
Path: DiagnosticReport.subject

See Also:

• Constant Field Values

PATIENT

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

Fluent Client search parameter constant for patient

Description: The subject of the report if a patient
Type: reference
Path: DiagnosticReport.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 "DiagnosticReport:patient".

SP_SPECIMEN

public static final String SP_SPECIMEN

Search parameter: specimen

Description: The specimen details
Type: reference
Path: DiagnosticReport.specimen

See Also:

• Constant Field Values

SPECIMEN

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

Fluent Client search parameter constant for specimen

Description: The specimen details
Type: reference
Path: DiagnosticReport.specimen

INCLUDE_SPECIMEN

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

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

SP_CONTEXT

public static final String SP_CONTEXT

Search parameter: context

Description: Healthcare event (Episode of Care or Encounter) related to the report
Type: reference
Path: DiagnosticReport.context

See Also:

• Constant Field Values

CONTEXT

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

Fluent Client search parameter constant for context

Description: Healthcare event (Episode of Care or Encounter) related to the report
Type: reference
Path: DiagnosticReport.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 "DiagnosticReport:context".

SP_ISSUED

public static final String SP_ISSUED

Search parameter: issued

Description: When the report was issued
Type: date
Path: DiagnosticReport.issued

See Also:

• Constant Field Values

ISSUED

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

Fluent Client search parameter constant for issued

Description: When the report was issued
Type: date
Path: DiagnosticReport.issued

SP_CATEGORY

public static final String SP_CATEGORY

Search parameter: category

Description: Which diagnostic discipline/department created the report
Type: token
Path: DiagnosticReport.category

See Also:

• Constant Field Values

CATEGORY

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

Fluent Client search parameter constant for category

Description: Which diagnostic discipline/department created the report
Type: token
Path: DiagnosticReport.category

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: The status of the report
Type: token
Path: DiagnosticReport.status

See Also:

• Constant Field Values

STATUS

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

Fluent Client search parameter constant for status

Description: The status of the report
Type: token
Path: DiagnosticReport.status

Constructor Details

DiagnosticReport

public DiagnosticReport()

Constructor

DiagnosticReport

public DiagnosticReport(Enumeration<DiagnosticReport.DiagnosticReportStatus> status,
 CodeableConcept code)

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Identifiers assigned to this report by the performer or other systems.)

setIdentifier

public DiagnosticReport setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public DiagnosticReport addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist

getBasedOn

public List<Reference> getBasedOn()

Returns:

basedOn (Details concerning a test or procedure requested.)

setBasedOn

public DiagnosticReport setBasedOn(List<Reference> theBasedOn)

Returns:

Returns a reference to this for easy method chaining

hasBasedOn

public boolean hasBasedOn()

addBasedOn

public Reference addBasedOn()

addBasedOn

public DiagnosticReport 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

getStatusElement

public Enumeration<DiagnosticReport.DiagnosticReportStatus> getStatusElement()

Returns:

status (The status of the diagnostic report as a whole.). 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 DiagnosticReport setStatusElement(Enumeration<DiagnosticReport.DiagnosticReportStatus> value)

Parameters:

value - status (The status of the diagnostic report as a whole.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public DiagnosticReport.DiagnosticReportStatus getStatus()

Returns:

The status of the diagnostic report as a whole.

setStatus

public DiagnosticReport setStatus(DiagnosticReport.DiagnosticReportStatus value)

Parameters:

value - The status of the diagnostic report as a whole.

getCategory

public CodeableConcept getCategory()

Returns:

category (A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.)

hasCategory

public boolean hasCategory()

setCategory

public DiagnosticReport setCategory(CodeableConcept value)

Parameters:

value - category (A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.)

getCode

public CodeableConcept getCode()

Returns:

code (A code or name that describes this diagnostic report.)

hasCode

public boolean hasCode()

setCode

public DiagnosticReport setCode(CodeableConcept value)

Parameters:

value - code (A code or name that describes this diagnostic report.)

getSubject

public Reference getSubject()

Returns:

subject (The subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources.)

hasSubject

public boolean hasSubject()

setSubject

public DiagnosticReport setSubject(Reference value)

Parameters:

value - subject (The subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources.)

getSubjectTarget

public Resource getSubjectTarget()

Returns:

subject 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. (The subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources.)

setSubjectTarget

public DiagnosticReport setSubjectTarget(Resource value)

Parameters:

value - subject 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. (The subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources.)

getContext

public Reference getContext()

Returns:

context (The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport per is about.)

hasContext

public boolean hasContext()

setContext

public DiagnosticReport setContext(Reference value)

Parameters:

value - context (The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport per is about.)

getContextTarget

public Resource getContextTarget()

Returns:

context 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. (The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport per is about.)

setContextTarget

public DiagnosticReport setContextTarget(Resource value)

Parameters:

value - context 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. (The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport per is about.)

getEffective

public Type getEffective()

Returns:

effective (The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.)

getEffectiveDateTimeType

public DateTimeType getEffectiveDateTimeType()
                                      throws org.hl7.fhir.exceptions.FHIRException

Returns:

effective (The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasEffectiveDateTimeType

public boolean hasEffectiveDateTimeType()

getEffectivePeriod

public Period getEffectivePeriod()
                          throws org.hl7.fhir.exceptions.FHIRException

Returns:

effective (The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasEffectivePeriod

public boolean hasEffectivePeriod()

hasEffective

public boolean hasEffective()

setEffective

public DiagnosticReport setEffective(Type value)
                              throws org.hl7.fhir.exceptions.FHIRFormatError

Parameters:

value - effective (The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.)

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

getIssuedElement

public InstantType getIssuedElement()

Returns:

issued (The date and time that this version of the report was released from the source diagnostic service.). This is the underlying object with id, value and extensions. The accessor "getIssued" gives direct access to the value

hasIssuedElement

public boolean hasIssuedElement()

hasIssued

public boolean hasIssued()

setIssuedElement

public DiagnosticReport setIssuedElement(InstantType value)

Parameters:

value - issued (The date and time that this version of the report was released from the source diagnostic service.). This is the underlying object with id, value and extensions. The accessor "getIssued" gives direct access to the value

getIssued

public Date getIssued()

Returns:

The date and time that this version of the report was released from the source diagnostic service.

setIssued

public DiagnosticReport setIssued(Date value)

Parameters:

value - The date and time that this version of the report was released from the source diagnostic service.

getPerformer

public List<DiagnosticReport.DiagnosticReportPerformerComponent> getPerformer()

Returns:

performer (Indicates who or what participated in producing the report.)

setPerformer

public DiagnosticReport setPerformer(List<DiagnosticReport.DiagnosticReportPerformerComponent> thePerformer)

Returns:

Returns a reference to this for easy method chaining

hasPerformer

public boolean hasPerformer()

addPerformer

public DiagnosticReport.DiagnosticReportPerformerComponent addPerformer()

addPerformer

public DiagnosticReport addPerformer(DiagnosticReport.DiagnosticReportPerformerComponent t)

getPerformerFirstRep

public DiagnosticReport.DiagnosticReportPerformerComponent getPerformerFirstRep()

Returns:

The first repetition of repeating field performer, creating it if it does not already exist

getSpecimen

public List<Reference> getSpecimen()

Returns:

specimen (Details about the specimens on which this diagnostic report is based.)

setSpecimen

public DiagnosticReport setSpecimen(List<Reference> theSpecimen)

Returns:

Returns a reference to this for easy method chaining

hasSpecimen

public boolean hasSpecimen()

addSpecimen

public Reference addSpecimen()

addSpecimen

public DiagnosticReport addSpecimen(Reference t)

getSpecimenFirstRep

public Reference getSpecimenFirstRep()

Returns:

The first repetition of repeating field specimen, creating it if it does not already exist

getSpecimenTarget

@Deprecated
public List<Specimen> getSpecimenTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addSpecimenTarget

@Deprecated
public Specimen addSpecimenTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getResult

public List<Reference> getResult()

Returns:

result (Observations that are part of this diagnostic report. Observations can be simple name/value pairs (e.g. "atomic" results), or they can be grouping observations that include references to other members of the group (e.g. "panels").)

setResult

public DiagnosticReport setResult(List<Reference> theResult)

Returns:

Returns a reference to this for easy method chaining

hasResult

public boolean hasResult()

addResult

public Reference addResult()

addResult

public DiagnosticReport addResult(Reference t)

getResultFirstRep

public Reference getResultFirstRep()

Returns:

The first repetition of repeating field result, creating it if it does not already exist

getResultTarget

@Deprecated
public List<Observation> getResultTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addResultTarget

@Deprecated
public Observation addResultTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getImagingStudy

public List<Reference> getImagingStudy()

Returns:

imagingStudy (One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.)

setImagingStudy

public DiagnosticReport setImagingStudy(List<Reference> theImagingStudy)

Returns:

Returns a reference to this for easy method chaining

hasImagingStudy

public boolean hasImagingStudy()

addImagingStudy

public Reference addImagingStudy()

addImagingStudy

public DiagnosticReport addImagingStudy(Reference t)

getImagingStudyFirstRep

public Reference getImagingStudyFirstRep()

Returns:

The first repetition of repeating field imagingStudy, creating it if it does not already exist

getImagingStudyTarget

@Deprecated
public List<Resource> getImagingStudyTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getImage

public List<DiagnosticReport.DiagnosticReportImageComponent> getImage()

Returns:

image (A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).)

setImage

public DiagnosticReport setImage(List<DiagnosticReport.DiagnosticReportImageComponent> theImage)

Returns:

Returns a reference to this for easy method chaining

hasImage

public boolean hasImage()

addImage

public DiagnosticReport.DiagnosticReportImageComponent addImage()

addImage

public DiagnosticReport addImage(DiagnosticReport.DiagnosticReportImageComponent t)

getImageFirstRep

public DiagnosticReport.DiagnosticReportImageComponent getImageFirstRep()

Returns:

The first repetition of repeating field image, creating it if it does not already exist

getConclusionElement

public StringType getConclusionElement()

Returns:

conclusion (Concise and clinically contextualized impression / summary of the diagnostic report.). This is the underlying object with id, value and extensions. The accessor "getConclusion" gives direct access to the value

hasConclusionElement

public boolean hasConclusionElement()

hasConclusion

public boolean hasConclusion()

setConclusionElement

public DiagnosticReport setConclusionElement(StringType value)

Parameters:

value - conclusion (Concise and clinically contextualized impression / summary of the diagnostic report.). This is the underlying object with id, value and extensions. The accessor "getConclusion" gives direct access to the value

getConclusion

public String getConclusion()

Returns:

Concise and clinically contextualized impression / summary of the diagnostic report.

setConclusion

public DiagnosticReport setConclusion(String value)

Parameters:

value - Concise and clinically contextualized impression / summary of the diagnostic report.

getCodedDiagnosis

public List<CodeableConcept> getCodedDiagnosis()

Returns:

codedDiagnosis (Codes for the conclusion.)

setCodedDiagnosis

public DiagnosticReport setCodedDiagnosis(List<CodeableConcept> theCodedDiagnosis)

Returns:

Returns a reference to this for easy method chaining

hasCodedDiagnosis

public boolean hasCodedDiagnosis()

addCodedDiagnosis

public CodeableConcept addCodedDiagnosis()

addCodedDiagnosis

public DiagnosticReport addCodedDiagnosis(CodeableConcept t)

getCodedDiagnosisFirstRep

public CodeableConcept getCodedDiagnosisFirstRep()

Returns:

The first repetition of repeating field codedDiagnosis, creating it if it does not already exist

getPresentedForm

public List<Attachment> getPresentedForm()

Returns:

presentedForm (Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.)

setPresentedForm

public DiagnosticReport setPresentedForm(List<Attachment> thePresentedForm)

Returns:

Returns a reference to this for easy method chaining

hasPresentedForm

public boolean hasPresentedForm()

addPresentedForm

public Attachment addPresentedForm()

addPresentedForm

public DiagnosticReport addPresentedForm(Attachment t)

getPresentedFormFirstRep

public Attachment getPresentedFormFirstRep()

Returns:

The first repetition of repeating field presentedForm, creating it if it does not already exist

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

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 class DomainResource

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 class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base 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

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty 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()

Specified by:

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

Overrides:

fhirType in class DomainResource

copy

public DiagnosticReport copy()

Specified by:

copy in class DomainResource

typedCopy

protected DiagnosticReport 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