Package org.hl7.fhir.r4.model

Class DocumentReference

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.BaseResource

org.hl7.fhir.r4.model.Resource

org.hl7.fhir.r4.model.DomainResource

org.hl7.fhir.r4.model.DocumentReference

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

A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentReference.DocumentReferenceContentComponent
static class	DocumentReference.DocumentReferenceContextComponent
static class	DocumentReference.DocumentReferenceRelatesToComponent
static class	DocumentReference.DocumentRelationshipType
static class	DocumentReference.DocumentRelationshipTypeEnumFactory
static class	DocumentReference.ReferredDocumentStatus
static class	DocumentReference.ReferredDocumentStatusEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected Reference	authenticator	Which person or organization authenticates that this document is valid.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	AUTHENTICATOR	Fluent Client search parameter constant for authenticator
protected Resource	authenticatorTarget	The actual object that is the target of the reference (Which person or organization authenticates that this document is valid.)
protected List<Reference>	author	Identifies who is responsible for adding the information to the document.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	AUTHOR	Fluent Client search parameter constant for author
protected List<Resource>	authorTarget	The actual objects that are the target of the reference (Identifies who is responsible for adding the information to the document.)
protected List<CodeableConcept>	category	A categorization for the type of document referenced - helps for indexing and searching.
static ca.uhn.fhir.rest.gclient.TokenClientParam	CATEGORY	Fluent Client search parameter constant for category
protected List<DocumentReference.DocumentReferenceContentComponent>	content	The document and format referenced.
static ca.uhn.fhir.rest.gclient.TokenClientParam	CONTENTTYPE	Fluent Client search parameter constant for contenttype
protected DocumentReference.DocumentReferenceContextComponent	context	The clinical context in which the document was prepared.
protected Reference	custodian	Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	CUSTODIAN	Fluent Client search parameter constant for custodian
protected Organization	custodianTarget	The actual object that is the target of the reference (Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.)
protected InstantType	date	When the document reference was created.
static ca.uhn.fhir.rest.gclient.DateClientParam	DATE	Fluent Client search parameter constant for date
protected StringType	description	Human-readable description of the source document.
static ca.uhn.fhir.rest.gclient.StringClientParam	DESCRIPTION	Fluent Client search parameter constant for description
protected Enumeration<DocumentReference.ReferredDocumentStatus>	docStatus	The status of the underlying document.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	ENCOUNTER	Fluent Client search parameter constant for encounter
static ca.uhn.fhir.rest.gclient.TokenClientParam	EVENT	Fluent Client search parameter constant for event
static ca.uhn.fhir.rest.gclient.TokenClientParam	FACILITY	Fluent Client search parameter constant for facility
static ca.uhn.fhir.rest.gclient.TokenClientParam	FORMAT	Fluent Client search parameter constant for format
protected List<Identifier>	identifier	Other identifiers associated with the document, including version independent identifiers.
static ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static ca.uhn.fhir.model.api.Include	INCLUDE_AUTHENTICATOR	Constant for fluent queries to be used to add include statements.
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_CUSTODIAN	Constant for fluent queries to be used to add include statements.
static ca.uhn.fhir.model.api.Include	INCLUDE_ENCOUNTER	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.
static ca.uhn.fhir.model.api.Include	INCLUDE_RELATED	Constant for fluent queries to be used to add include statements.
static ca.uhn.fhir.model.api.Include	INCLUDE_RELATESTO	Constant for fluent queries to be used to add include statements.
static ca.uhn.fhir.model.api.Include	INCLUDE_SUBJECT	Constant for fluent queries to be used to add include statements.
static ca.uhn.fhir.rest.gclient.TokenClientParam	LANGUAGE	Fluent Client search parameter constant for language
static ca.uhn.fhir.rest.gclient.UriClientParam	LOCATION	Fluent Client search parameter constant for location
protected Identifier	masterIdentifier	Document identifier as assigned by the source of the document.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
static ca.uhn.fhir.rest.gclient.DateClientParam	PERIOD	Fluent Client search parameter constant for period
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	RELATED	Fluent Client search parameter constant for related
protected List<DocumentReference.DocumentReferenceRelatesToComponent>	relatesTo	Relationships that this document has with other document references that already exist.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	RELATESTO	Fluent Client search parameter constant for relatesto
static ca.uhn.fhir.rest.gclient.TokenClientParam	RELATION	Fluent Client search parameter constant for relation
static ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.ReferenceClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam>	RELATIONSHIP	Fluent Client search parameter constant for relationship
static ca.uhn.fhir.rest.gclient.TokenClientParam	SECURITY_LABEL	Fluent Client search parameter constant for security-label
protected List<CodeableConcept>	securityLabel	A set of Security-Tag codes specifying the level of privacy/security of the Document.
static ca.uhn.fhir.rest.gclient.TokenClientParam	SETTING	Fluent Client search parameter constant for setting
static String	SP_AUTHENTICATOR	Search parameter: authenticator
static String	SP_AUTHOR	Search parameter: author
static String	SP_CATEGORY	Search parameter: category
static String	SP_CONTENTTYPE	Search parameter: contenttype
static String	SP_CUSTODIAN	Search parameter: custodian
static String	SP_DATE	Search parameter: date
static String	SP_DESCRIPTION	Search parameter: description
static String	SP_ENCOUNTER	Search parameter: encounter
static String	SP_EVENT	Search parameter: event
static String	SP_FACILITY	Search parameter: facility
static String	SP_FORMAT	Search parameter: format
static String	SP_IDENTIFIER	Search parameter: identifier
static String	SP_LANGUAGE	Search parameter: language
static String	SP_LOCATION	Search parameter: location
static String	SP_PATIENT	Search parameter: patient
static String	SP_PERIOD	Search parameter: period
static String	SP_RELATED	Search parameter: related
static String	SP_RELATESTO	Search parameter: relatesto
static String	SP_RELATION	Search parameter: relation
static String	SP_RELATIONSHIP	Search parameter: relationship
static String	SP_SECURITY_LABEL	Search parameter: security-label
static String	SP_SETTING	Search parameter: setting
static String	SP_STATUS	Search parameter: status
static String	SP_SUBJECT	Search parameter: subject
static String	SP_TYPE	Search parameter: type
protected Enumeration<Enumerations.DocumentReferenceStatus>	status	The status of this document reference.
static ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected Reference	subject	Who or what the document is about.
static 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 (Who or what the document is about.
protected CodeableConcept	type	Specifies the particular kind of document referenced (e.g.
static ca.uhn.fhir.rest.gclient.TokenClientParam	TYPE	Fluent Client search parameter constant for type

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

contained, extension, modifierExtension, text

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

id, implicitRules, language, meta

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	Description
DocumentReference()	Constructor
DocumentReference(Enumeration<Enumerations.DocumentReferenceStatus> status)	Constructor

Method Summary

Modifier and Type	Method	Description
Reference	addAuthor()
DocumentReference	addAuthor(Reference t)
CodeableConcept	addCategory()
DocumentReference	addCategory(CodeableConcept t)
Base	addChild(String name)
DocumentReference.DocumentReferenceContentComponent	addContent()
DocumentReference	addContent(DocumentReference.DocumentReferenceContentComponent t)
Identifier	addIdentifier()
DocumentReference	addIdentifier(Identifier t)
DocumentReference.DocumentReferenceRelatesToComponent	addRelatesTo()
DocumentReference	addRelatesTo(DocumentReference.DocumentReferenceRelatesToComponent t)
CodeableConcept	addSecurityLabel()
DocumentReference	addSecurityLabel(CodeableConcept t)
DocumentReference	copy()
void	copyValues(DocumentReference dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Reference	getAuthenticator()
Resource	getAuthenticatorTarget()
List<Reference>	getAuthor()
Reference	getAuthorFirstRep()
List<Resource>	getAuthorTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
List<CodeableConcept>	getCategory()
CodeableConcept	getCategoryFirstRep()
List<DocumentReference.DocumentReferenceContentComponent>	getContent()
DocumentReference.DocumentReferenceContentComponent	getContentFirstRep()
DocumentReference.DocumentReferenceContextComponent	getContext()
Reference	getCustodian()
Organization	getCustodianTarget()
Date	getDate()
InstantType	getDateElement()
String	getDescription()
StringType	getDescriptionElement()
DocumentReference.ReferredDocumentStatus	getDocStatus()
Enumeration<DocumentReference.ReferredDocumentStatus>	getDocStatusElement()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
Identifier	getMasterIdentifier()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
List<DocumentReference.DocumentReferenceRelatesToComponent>	getRelatesTo()
DocumentReference.DocumentReferenceRelatesToComponent	getRelatesToFirstRep()
ResourceType	getResourceType()
List<CodeableConcept>	getSecurityLabel()
CodeableConcept	getSecurityLabelFirstRep()
Enumerations.DocumentReferenceStatus	getStatus()
Enumeration<Enumerations.DocumentReferenceStatus>	getStatusElement()
Reference	getSubject()
Resource	getSubjectTarget()
CodeableConcept	getType()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAuthenticator()
boolean	hasAuthor()
boolean	hasCategory()
boolean	hasContent()
boolean	hasContext()
boolean	hasCustodian()
boolean	hasDate()
boolean	hasDateElement()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasDocStatus()
boolean	hasDocStatusElement()
boolean	hasIdentifier()
boolean	hasMasterIdentifier()
boolean	hasRelatesTo()
boolean	hasSecurityLabel()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubject()
boolean	hasType()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
DocumentReference	setAuthenticator(Reference value)
DocumentReference	setAuthenticatorTarget(Resource value)
DocumentReference	setAuthor(List<Reference> theAuthor)
DocumentReference	setCategory(List<CodeableConcept> theCategory)
DocumentReference	setContent(List<DocumentReference.DocumentReferenceContentComponent> theContent)
DocumentReference	setContext(DocumentReference.DocumentReferenceContextComponent value)
DocumentReference	setCustodian(Reference value)
DocumentReference	setCustodianTarget(Organization value)
DocumentReference	setDate(Date value)
DocumentReference	setDateElement(InstantType value)
DocumentReference	setDescription(String value)
DocumentReference	setDescriptionElement(StringType value)
DocumentReference	setDocStatus(DocumentReference.ReferredDocumentStatus value)
DocumentReference	setDocStatusElement(Enumeration<DocumentReference.ReferredDocumentStatus> value)
DocumentReference	setIdentifier(List<Identifier> theIdentifier)
DocumentReference	setMasterIdentifier(Identifier value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
DocumentReference	setRelatesTo(List<DocumentReference.DocumentReferenceRelatesToComponent> theRelatesTo)
DocumentReference	setSecurityLabel(List<CodeableConcept> theSecurityLabel)
DocumentReference	setStatus(Enumerations.DocumentReferenceStatus value)
DocumentReference	setStatusElement(Enumeration<Enumerations.DocumentReferenceStatus> value)
DocumentReference	setSubject(Reference value)
DocumentReference	setSubjectTarget(Resource value)
DocumentReference	setType(CodeableConcept value)
protected DocumentReference	typedCopy()

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

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

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

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

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

getStructureFhirVersionEnum, isResource, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

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, setId

Field Details

masterIdentifier

protected Identifier masterIdentifier

Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.

identifier

protected List<Identifier> identifier

Other identifiers associated with the document, including version independent identifiers.

status

protected Enumeration<Enumerations.DocumentReferenceStatus> status

The status of this document reference.

docStatus

protected Enumeration<DocumentReference.ReferredDocumentStatus> docStatus

The status of the underlying document.

type

protected CodeableConcept type

Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.

category

protected List<CodeableConcept> category

A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.

subject

protected Reference subject

Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).

subjectTarget

protected Resource subjectTarget

The actual object that is the target of the reference (Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).)

date

protected InstantType date

When the document reference was created.

author

protected List<Reference> author

Identifies who is responsible for adding the information to the document.

authorTarget

protected List<Resource> authorTarget

The actual objects that are the target of the reference (Identifies who is responsible for adding the information to the document.)

authenticator

protected Reference authenticator

Which person or organization authenticates that this document is valid.

authenticatorTarget

protected Resource authenticatorTarget

The actual object that is the target of the reference (Which person or organization authenticates that this document is valid.)

custodian

protected Reference custodian

Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.

custodianTarget

protected Organization custodianTarget

The actual object that is the target of the reference (Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.)

relatesTo

protected List<DocumentReference.DocumentReferenceRelatesToComponent> relatesTo

Relationships that this document has with other document references that already exist.

description

protected StringType description

Human-readable description of the source document.

securityLabel

protected List<CodeableConcept> securityLabel

A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.

content

protected List<DocumentReference.DocumentReferenceContentComponent> content

The document and format referenced. There may be multiple content element repetitions, each with a different format.

context

protected DocumentReference.DocumentReferenceContextComponent context

The clinical context in which the document was prepared.

SP_DATE

public static final String SP_DATE

Search parameter: date

Description: When this document reference was created
Type: date
Path: DocumentReference.date

See Also:

Constant Field Values

DATE

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

Fluent Client search parameter constant for date

Description: When this document reference was created
Type: date
Path: DocumentReference.date

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter: subject

Description: Who/what is the subject of the document
Type: reference
Path: DocumentReference.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: Who/what is the subject of the document
Type: reference
Path: DocumentReference.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 "DocumentReference:subject".

SP_DESCRIPTION

public static final String SP_DESCRIPTION

Search parameter: description

Description: Human-readable description
Type: string
Path: DocumentReference.description

See Also:

Constant Field Values

DESCRIPTION

public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION

Fluent Client search parameter constant for description

Description: Human-readable description
Type: string
Path: DocumentReference.description

SP_LANGUAGE

public static final String SP_LANGUAGE

Search parameter: language

Description: Human language of the content (BCP-47)
Type: token
Path: DocumentReference.content.attachment.language

See Also:

Constant Field Values

LANGUAGE

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

Fluent Client search parameter constant for language

Description: Human language of the content (BCP-47)
Type: token
Path: DocumentReference.content.attachment.language

SP_TYPE

public static final String SP_TYPE

Search parameter: type

Description: Kind of document (LOINC if possible)
Type: token
Path: DocumentReference.type

See Also:

Constant Field Values

TYPE

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

Fluent Client search parameter constant for type

Description: Kind of document (LOINC if possible)
Type: token
Path: DocumentReference.type

SP_RELATION

public static final String SP_RELATION

Search parameter: relation

Description: replaces | transforms | signs | appends
Type: token
Path: DocumentReference.relatesTo.code

See Also:

Constant Field Values

RELATION

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

Fluent Client search parameter constant for relation

Description: replaces | transforms | signs | appends
Type: token
Path: DocumentReference.relatesTo.code

SP_SETTING

public static final String SP_SETTING

Search parameter: setting

Description: Additional details about where the content was created (e.g. clinical specialty)
Type: token
Path: DocumentReference.context.practiceSetting

See Also:

Constant Field Values

SETTING

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

Fluent Client search parameter constant for setting

Description: Additional details about where the content was created (e.g. clinical specialty)
Type: token
Path: DocumentReference.context.practiceSetting

SP_RELATED

public static final String SP_RELATED

Search parameter: related

Description: Related identifiers or resources
Type: reference
Path: DocumentReference.context.related

See Also:

Constant Field Values

RELATED

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

Fluent Client search parameter constant for related

Description: Related identifiers or resources
Type: reference
Path: DocumentReference.context.related

INCLUDE_RELATED

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

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

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: Who/what is the subject of the document
Type: reference
Path: DocumentReference.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: Who/what is the subject of the document
Type: reference
Path: DocumentReference.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 "DocumentReference:patient".

SP_RELATIONSHIP

public static final String SP_RELATIONSHIP

Search parameter: relationship

Description: Combination of relation and relatesTo
Type: composite
Path:

See Also:

Constant Field Values

RELATIONSHIP

public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.ReferenceClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> RELATIONSHIP

Fluent Client search parameter constant for relationship

Description: Combination of relation and relatesTo
Type: composite
Path:

SP_EVENT

public static final String SP_EVENT

Search parameter: event

Description: Main clinical acts documented
Type: token
Path: DocumentReference.context.event

See Also:

Constant Field Values

EVENT

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

Fluent Client search parameter constant for event

Description: Main clinical acts documented
Type: token
Path: DocumentReference.context.event

SP_AUTHENTICATOR

public static final String SP_AUTHENTICATOR

Search parameter: authenticator

Description: Who/what authenticated the document
Type: reference
Path: DocumentReference.authenticator

See Also:

Constant Field Values

AUTHENTICATOR

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

Fluent Client search parameter constant for authenticator

Description: Who/what authenticated the document
Type: reference
Path: DocumentReference.authenticator

INCLUDE_AUTHENTICATOR

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

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

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Master Version Specific Identifier
Type: token
Path: DocumentReference.masterIdentifier, DocumentReference.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: Master Version Specific Identifier
Type: token
Path: DocumentReference.masterIdentifier, DocumentReference.identifier

SP_PERIOD

public static final String SP_PERIOD

Search parameter: period

Description: Time of service that is being documented
Type: date
Path: DocumentReference.context.period

See Also:

Constant Field Values

PERIOD

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

Fluent Client search parameter constant for period

Description: Time of service that is being documented
Type: date
Path: DocumentReference.context.period

SP_CUSTODIAN

public static final String SP_CUSTODIAN

Search parameter: custodian

Description: Organization which maintains the document
Type: reference
Path: DocumentReference.custodian

See Also:

Constant Field Values

CUSTODIAN

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

Fluent Client search parameter constant for custodian

Description: Organization which maintains the document
Type: reference
Path: DocumentReference.custodian

INCLUDE_CUSTODIAN

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

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

SP_AUTHOR

public static final String SP_AUTHOR

Search parameter: author

Description: Who and/or what authored the document
Type: reference
Path: DocumentReference.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: Who and/or what authored the document
Type: reference
Path: DocumentReference.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 "DocumentReference:author".

SP_FORMAT

public static final String SP_FORMAT

Search parameter: format

Description: Format/content rules for the document
Type: token
Path: DocumentReference.content.format

See Also:

Constant Field Values

FORMAT

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

Fluent Client search parameter constant for format

Description: Format/content rules for the document
Type: token
Path: DocumentReference.content.format

SP_ENCOUNTER

public static final String SP_ENCOUNTER

Search parameter: encounter

Description: Context of the document content
Type: reference
Path: DocumentReference.context.encounter

See Also:

Constant Field Values

ENCOUNTER

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

Fluent Client search parameter constant for encounter

Description: Context of the document content
Type: reference
Path: DocumentReference.context.encounter

INCLUDE_ENCOUNTER

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

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

SP_CONTENTTYPE

public static final String SP_CONTENTTYPE

Search parameter: contenttype

Description: Mime type of the content, with charset etc.
Type: token
Path: DocumentReference.content.attachment.contentType

See Also:

Constant Field Values

CONTENTTYPE

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

Fluent Client search parameter constant for contenttype

Description: Mime type of the content, with charset etc.
Type: token
Path: DocumentReference.content.attachment.contentType

SP_SECURITY_LABEL

public static final String SP_SECURITY_LABEL

Search parameter: security-label

Description: Document security-tags
Type: token
Path: DocumentReference.securityLabel

See Also:

Constant Field Values

SECURITY_LABEL

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

Fluent Client search parameter constant for security-label

Description: Document security-tags
Type: token
Path: DocumentReference.securityLabel

SP_LOCATION

public static final String SP_LOCATION

Search parameter: location

Description: Uri where the data can be found
Type: uri
Path: DocumentReference.content.attachment.url

See Also:

Constant Field Values

LOCATION

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

Fluent Client search parameter constant for location

Description: Uri where the data can be found
Type: uri
Path: DocumentReference.content.attachment.url

SP_CATEGORY

public static final String SP_CATEGORY

Search parameter: category

Description: Categorization of document
Type: token
Path: DocumentReference.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: Categorization of document
Type: token
Path: DocumentReference.category

SP_RELATESTO

public static final String SP_RELATESTO

Search parameter: relatesto

Description: Target of the relationship
Type: reference
Path: DocumentReference.relatesTo.target

See Also:

Constant Field Values

RELATESTO

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

Fluent Client search parameter constant for relatesto

Description: Target of the relationship
Type: reference
Path: DocumentReference.relatesTo.target

INCLUDE_RELATESTO

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

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

SP_FACILITY

public static final String SP_FACILITY

Search parameter: facility

Description: Kind of facility where patient was seen
Type: token
Path: DocumentReference.context.facilityType

See Also:

Constant Field Values

FACILITY

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

Fluent Client search parameter constant for facility

Description: Kind of facility where patient was seen
Type: token
Path: DocumentReference.context.facilityType

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: current | superseded | entered-in-error
Type: token
Path: DocumentReference.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: current | superseded | entered-in-error
Type: token
Path: DocumentReference.status

Constructor Details

DocumentReference

public DocumentReference()

Constructor

DocumentReference

public DocumentReference(Enumeration<Enumerations.DocumentReferenceStatus> status)

Constructor

Method Details

getMasterIdentifier

public Identifier getMasterIdentifier()

Returns:

masterIdentifier (Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.)

hasMasterIdentifier

public boolean hasMasterIdentifier()

setMasterIdentifier

public DocumentReference setMasterIdentifier(Identifier value)

Parameters:

value - masterIdentifier (Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.)

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Other identifiers associated with the document, including version independent identifiers.)

setIdentifier

public DocumentReference setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public DocumentReference addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

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

getStatusElement

public Enumeration<Enumerations.DocumentReferenceStatus> getStatusElement()

Returns:

status (The status of this document reference.). 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 DocumentReference setStatusElement(Enumeration<Enumerations.DocumentReferenceStatus> value)

Parameters:

value - status (The status of this document reference.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public Enumerations.DocumentReferenceStatus getStatus()

Returns:

The status of this document reference.

setStatus

public DocumentReference setStatus(Enumerations.DocumentReferenceStatus value)

Parameters:

value - The status of this document reference.

getDocStatusElement

public Enumeration<DocumentReference.ReferredDocumentStatus> getDocStatusElement()

Returns:

docStatus (The status of the underlying document.). This is the underlying object with id, value and extensions. The accessor "getDocStatus" gives direct access to the value

hasDocStatusElement

public boolean hasDocStatusElement()

hasDocStatus

public boolean hasDocStatus()

setDocStatusElement

public DocumentReference setDocStatusElement(Enumeration<DocumentReference.ReferredDocumentStatus> value)

Parameters:

value - docStatus (The status of the underlying document.). This is the underlying object with id, value and extensions. The accessor "getDocStatus" gives direct access to the value

getDocStatus

public DocumentReference.ReferredDocumentStatus getDocStatus()

Returns:

The status of the underlying document.

setDocStatus

public DocumentReference setDocStatus(DocumentReference.ReferredDocumentStatus value)

Parameters:

value - The status of the underlying document.

getType

public CodeableConcept getType()

Returns:

type (Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.)

hasType

public boolean hasType()

setType

public DocumentReference setType(CodeableConcept value)

Parameters:

value - type (Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.)

getCategory

public List<CodeableConcept> getCategory()

Returns:

category (A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.)

setCategory

public DocumentReference setCategory(List<CodeableConcept> theCategory)

Returns:

Returns a reference to this for easy method chaining

hasCategory

public boolean hasCategory()

addCategory

public CodeableConcept addCategory()

addCategory

public DocumentReference addCategory(CodeableConcept t)

getCategoryFirstRep

public CodeableConcept getCategoryFirstRep()

Returns:

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

getSubject

public Reference getSubject()

Returns:

subject (Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).)

hasSubject

public boolean hasSubject()

setSubject

public DocumentReference setSubject(Reference value)

Parameters:

value - subject (Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).)

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. (Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).)

setSubjectTarget

public DocumentReference 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. (Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).)

getDateElement

public InstantType getDateElement()

Returns:

date (When the document reference was created.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

hasDateElement

public boolean hasDateElement()

hasDate

public boolean hasDate()

setDateElement

public DocumentReference setDateElement(InstantType value)

Parameters:

value - date (When the document reference was created.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

getDate

public Date getDate()

Returns:

When the document reference was created.

setDate

public DocumentReference setDate(Date value)

Parameters:

value - When the document reference was created.

getAuthor

public List<Reference> getAuthor()

Returns:

author (Identifies who is responsible for adding the information to the document.)

setAuthor

public DocumentReference setAuthor(List<Reference> theAuthor)

Returns:

Returns a reference to this for easy method chaining

hasAuthor

public boolean hasAuthor()

addAuthor

public Reference addAuthor()

addAuthor

public DocumentReference addAuthor(Reference t)

getAuthorFirstRep

public Reference getAuthorFirstRep()

Returns:

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

getAuthorTarget

@Deprecated
public List<Resource> getAuthorTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getAuthenticator

public Reference getAuthenticator()

Returns:

authenticator (Which person or organization authenticates that this document is valid.)

hasAuthenticator

public boolean hasAuthenticator()

setAuthenticator

public DocumentReference setAuthenticator(Reference value)

Parameters:

value - authenticator (Which person or organization authenticates that this document is valid.)

getAuthenticatorTarget

public Resource getAuthenticatorTarget()

Returns:

authenticator 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. (Which person or organization authenticates that this document is valid.)

setAuthenticatorTarget

public DocumentReference setAuthenticatorTarget(Resource value)

Parameters:

value - authenticator 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. (Which person or organization authenticates that this document is valid.)

getCustodian

public Reference getCustodian()

Returns:

custodian (Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.)

hasCustodian

public boolean hasCustodian()

setCustodian

public DocumentReference setCustodian(Reference value)

Parameters:

value - custodian (Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.)

getCustodianTarget

public Organization getCustodianTarget()

Returns:

custodian 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. (Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.)

setCustodianTarget

public DocumentReference setCustodianTarget(Organization value)

Parameters:

value - custodian 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. (Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.)

getRelatesTo

public List<DocumentReference.DocumentReferenceRelatesToComponent> getRelatesTo()

Returns:

relatesTo (Relationships that this document has with other document references that already exist.)

setRelatesTo

public DocumentReference setRelatesTo(List<DocumentReference.DocumentReferenceRelatesToComponent> theRelatesTo)

Returns:

Returns a reference to this for easy method chaining

hasRelatesTo

public boolean hasRelatesTo()

addRelatesTo

public DocumentReference.DocumentReferenceRelatesToComponent addRelatesTo()

addRelatesTo

public DocumentReference addRelatesTo(DocumentReference.DocumentReferenceRelatesToComponent t)

getRelatesToFirstRep

public DocumentReference.DocumentReferenceRelatesToComponent getRelatesToFirstRep()

Returns:

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

getDescriptionElement

public StringType getDescriptionElement()

Returns:

description (Human-readable description of the source document.). 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 DocumentReference setDescriptionElement(StringType value)

Parameters:

value - description (Human-readable description of the source document.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

getDescription

public String getDescription()

Returns:

Human-readable description of the source document.

setDescription

public DocumentReference setDescription(String value)

Parameters:

value - Human-readable description of the source document.

getSecurityLabel

public List<CodeableConcept> getSecurityLabel()

Returns:

securityLabel (A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.)

setSecurityLabel

public DocumentReference setSecurityLabel(List<CodeableConcept> theSecurityLabel)

Returns:

Returns a reference to this for easy method chaining

hasSecurityLabel

public boolean hasSecurityLabel()

addSecurityLabel

public CodeableConcept addSecurityLabel()

addSecurityLabel

public DocumentReference addSecurityLabel(CodeableConcept t)

getSecurityLabelFirstRep

public CodeableConcept getSecurityLabelFirstRep()

Returns:

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

getContent

public List<DocumentReference.DocumentReferenceContentComponent> getContent()

Returns:

content (The document and format referenced. There may be multiple content element repetitions, each with a different format.)

setContent

public DocumentReference setContent(List<DocumentReference.DocumentReferenceContentComponent> theContent)

Returns:

Returns a reference to this for easy method chaining

hasContent

public boolean hasContent()

addContent

public DocumentReference.DocumentReferenceContentComponent addContent()

addContent

public DocumentReference addContent(DocumentReference.DocumentReferenceContentComponent t)

getContentFirstRep

public DocumentReference.DocumentReferenceContentComponent getContentFirstRep()

Returns:

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

getContext

public DocumentReference.DocumentReferenceContextComponent getContext()

Returns:

context (The clinical context in which the document was prepared.)

hasContext

public boolean hasContext()

setContext

public DocumentReference setContext(DocumentReference.DocumentReferenceContextComponent value)

Parameters:

value - context (The clinical context in which the document was prepared.)

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 DocumentReference copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(DocumentReference dst)

typedCopy

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