Class 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
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
static class
static enum
static class
static enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected Reference
Which person or organization authenticates that this document is valid.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for authenticatorprotected Resource
The actual object that is the target of the reference (Which person or organization authenticates that this document is valid.)Identifies who is responsible for adding the information to the document.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for authorThe actual objects that are the target of the reference (Identifies who is responsible for adding the information to the document.)protected List
<CodeableConcept> A categorization for the type of document referenced - helps for indexing and searching.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for categoryThe document and format referenced.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for contenttypeThe clinical context in which the document was prepared.protected Reference
Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for custodianprotected Organization
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
When the document reference was created.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for dateprotected StringType
Human-readable description of the source document.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for descriptionThe status of the underlying document.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for encounterstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for eventstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for facilitystatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for formatprotected List
<Identifier> Other identifiers associated with the document, including version independent identifiers.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for languagestatic final ca.uhn.fhir.rest.gclient.UriClientParam
Fluent Client search parameter constant for locationprotected Identifier
Document identifier as assigned by the source of the document.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientstatic final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for periodstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for relatedRelationships that this document has with other document references that already exist.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for relatestostatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for relationstatic final ca.uhn.fhir.rest.gclient.CompositeClientParam
<ca.uhn.fhir.rest.gclient.ReferenceClientParam, ca.uhn.fhir.rest.gclient.TokenClientParam> Fluent Client search parameter constant for relationshipstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for security-labelprotected List
<CodeableConcept> A set of Security-Tag codes specifying the level of privacy/security of the Document.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for settingstatic final String
Search parameter: authenticatorstatic final String
Search parameter: authorstatic final String
Search parameter: categorystatic final String
Search parameter: contenttypestatic final String
Search parameter: custodianstatic final String
Search parameter: datestatic final String
Search parameter: descriptionstatic final String
Search parameter: encounterstatic final String
Search parameter: eventstatic final String
Search parameter: facilitystatic final String
Search parameter: formatstatic final String
Search parameter: identifierstatic final String
Search parameter: languagestatic final String
Search parameter: locationstatic final String
Search parameter: patientstatic final String
Search parameter: periodstatic final String
Search parameter: relatedstatic final String
Search parameter: relatestostatic final String
Search parameter: relationstatic final String
Search parameter: relationshipstatic final String
Search parameter: security-labelstatic final String
Search parameter: settingstatic final String
Search parameter: statusstatic final String
Search parameter: subjectstatic final String
Search parameter: typeprotected Enumeration
<Enumerations.DocumentReferenceStatus> The status of this document reference.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected Reference
Who or what the document is about.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subjectprotected Resource
The actual object that is the target of the reference (Who or what the document is about.protected CodeableConcept
Specifies the particular kind of document referenced (e.g.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for typeFields 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, 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
ConstructorDescriptionConstructorConstructor -
Method Summary
Modifier and TypeMethodDescriptioncopy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
Deprecated.Use Reference#setResource(IBaseResource) insteadgetDate()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) getType()
String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasDate()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasType()
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setAuthenticator
(Reference value) setAuthenticatorTarget
(Resource value) setCategory
(List<CodeableConcept> theCategory) setCustodian
(Reference value) setCustodianTarget
(Organization value) setDateElement
(InstantType value) setDescription
(String value) setDescriptionElement
(StringType value) setIdentifier
(List<Identifier> theIdentifier) setMasterIdentifier
(Identifier value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setSecurityLabel
(List<CodeableConcept> theSecurityLabel) setSubject
(Reference value) setSubjectTarget
(Resource value) setType
(CodeableConcept value) protected DocumentReference
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, 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, getIdPart, 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, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, 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, isDeleted, setId
-
Field Details
-
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
Other identifiers associated with the document, including version independent identifiers. -
status
The status of this document reference. -
docStatus
The status of the underlying document. -
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
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
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
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
When the document reference was created. -
author
Identifies who is responsible for adding the information to the document. -
authorTarget
The actual objects that are the target of the reference (Identifies who is responsible for adding the information to the document.) -
authenticator
Which person or organization authenticates that this document is valid. -
authenticatorTarget
The actual object that is the target of the reference (Which person or organization authenticates that this document is valid.) -
custodian
Identifies the organization or group who is responsible for ongoing maintenance of and access to the document. -
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
Relationships that this document has with other document references that already exist. -
description
Human-readable description of the source document. -
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. -
The document and format referenced. There may be multiple content element repetitions, each with a different format.
-
context
The clinical context in which the document was prepared. -
SP_DATE
Search parameter: dateDescription: When this document reference was created
Type: date
Path: DocumentReference.date
- See Also:
-
DATE
Fluent Client search parameter constant for dateDescription: When this document reference was created
Type: date
Path: DocumentReference.date
-
SP_SUBJECT
Search parameter: subjectDescription: Who/what is the subject of the document
Type: reference
Path: DocumentReference.subject
- See Also:
-
SUBJECT
Fluent Client search parameter constant for subjectDescription: Who/what is the subject of the document
Type: reference
Path: DocumentReference.subject
-
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:subject". -
SP_DESCRIPTION
Search parameter: descriptionDescription: Human-readable description
Type: string
Path: DocumentReference.description
- See Also:
-
DESCRIPTION
Fluent Client search parameter constant for descriptionDescription: Human-readable description
Type: string
Path: DocumentReference.description
-
SP_LANGUAGE
Search parameter: languageDescription: Human language of the content (BCP-47)
Type: token
Path: DocumentReference.content.attachment.language
- See Also:
-
LANGUAGE
Fluent Client search parameter constant for languageDescription: Human language of the content (BCP-47)
Type: token
Path: DocumentReference.content.attachment.language
-
SP_TYPE
Search parameter: typeDescription: Kind of document (LOINC if possible)
Type: token
Path: DocumentReference.type
- See Also:
-
TYPE
Fluent Client search parameter constant for typeDescription: Kind of document (LOINC if possible)
Type: token
Path: DocumentReference.type
-
SP_RELATION
Search parameter: relationDescription: replaces | transforms | signs | appends
Type: token
Path: DocumentReference.relatesTo.code
- See Also:
-
RELATION
Fluent Client search parameter constant for relationDescription: replaces | transforms | signs | appends
Type: token
Path: DocumentReference.relatesTo.code
-
SP_SETTING
Search parameter: settingDescription: Additional details about where the content was created (e.g. clinical specialty)
Type: token
Path: DocumentReference.context.practiceSetting
- See Also:
-
SETTING
Fluent Client search parameter constant for settingDescription: Additional details about where the content was created (e.g. clinical specialty)
Type: token
Path: DocumentReference.context.practiceSetting
-
SP_RELATED
Search parameter: relatedDescription: Related identifiers or resources
Type: reference
Path: DocumentReference.context.related
- See Also:
-
RELATED
Fluent Client search parameter constant for relatedDescription: Related identifiers or resources
Type: reference
Path: DocumentReference.context.related
-
INCLUDE_RELATED
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:related". -
SP_PATIENT
Search parameter: patientDescription: Who/what is the subject of the document
Type: reference
Path: DocumentReference.subject
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: Who/what is the subject of the document
Type: reference
Path: DocumentReference.subject
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:patient". -
SP_RELATIONSHIP
Search parameter: relationshipDescription: Combination of relation and relatesTo
Type: composite
Path:
- See Also:
-
RELATIONSHIP
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.ReferenceClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> RELATIONSHIPFluent Client search parameter constant for relationshipDescription: Combination of relation and relatesTo
Type: composite
Path:
-
SP_EVENT
Search parameter: eventDescription: Main clinical acts documented
Type: token
Path: DocumentReference.context.event
- See Also:
-
EVENT
Fluent Client search parameter constant for eventDescription: Main clinical acts documented
Type: token
Path: DocumentReference.context.event
-
SP_AUTHENTICATOR
Search parameter: authenticatorDescription: Who/what authenticated the document
Type: reference
Path: DocumentReference.authenticator
- See Also:
-
AUTHENTICATOR
Fluent Client search parameter constant for authenticatorDescription: Who/what authenticated the document
Type: reference
Path: DocumentReference.authenticator
-
INCLUDE_AUTHENTICATOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:authenticator". -
SP_IDENTIFIER
Search parameter: identifierDescription: Master Version Specific Identifier
Type: token
Path: DocumentReference.masterIdentifier, DocumentReference.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Master Version Specific Identifier
Type: token
Path: DocumentReference.masterIdentifier, DocumentReference.identifier
-
SP_PERIOD
Search parameter: periodDescription: Time of service that is being documented
Type: date
Path: DocumentReference.context.period
- See Also:
-
PERIOD
Fluent Client search parameter constant for periodDescription: Time of service that is being documented
Type: date
Path: DocumentReference.context.period
-
SP_CUSTODIAN
Search parameter: custodianDescription: Organization which maintains the document
Type: reference
Path: DocumentReference.custodian
- See Also:
-
CUSTODIAN
Fluent Client search parameter constant for custodianDescription: Organization which maintains the document
Type: reference
Path: DocumentReference.custodian
-
INCLUDE_CUSTODIAN
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:custodian". -
SP_AUTHOR
Search parameter: authorDescription: Who and/or what authored the document
Type: reference
Path: DocumentReference.author
- See Also:
-
AUTHOR
Fluent Client search parameter constant for authorDescription: Who and/or what authored the document
Type: reference
Path: DocumentReference.author
-
INCLUDE_AUTHOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:author". -
SP_FORMAT
Search parameter: formatDescription: Format/content rules for the document
Type: token
Path: DocumentReference.content.format
- See Also:
-
FORMAT
Fluent Client search parameter constant for formatDescription: Format/content rules for the document
Type: token
Path: DocumentReference.content.format
-
SP_ENCOUNTER
Search parameter: encounterDescription: Context of the document content
Type: reference
Path: DocumentReference.context.encounter
- See Also:
-
ENCOUNTER
Fluent Client search parameter constant for encounterDescription: Context of the document content
Type: reference
Path: DocumentReference.context.encounter
-
INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:encounter". -
SP_CONTENTTYPE
Search parameter: contenttypeDescription: Mime type of the content, with charset etc.
Type: token
Path: DocumentReference.content.attachment.contentType
- See Also:
-
CONTENTTYPE
Fluent Client search parameter constant for contenttypeDescription: Mime type of the content, with charset etc.
Type: token
Path: DocumentReference.content.attachment.contentType
-
SP_SECURITY_LABEL
Search parameter: security-labelDescription: Document security-tags
Type: token
Path: DocumentReference.securityLabel
- See Also:
-
SECURITY_LABEL
Fluent Client search parameter constant for security-labelDescription: Document security-tags
Type: token
Path: DocumentReference.securityLabel
-
SP_LOCATION
Search parameter: locationDescription: Uri where the data can be found
Type: uri
Path: DocumentReference.content.attachment.url
- See Also:
-
LOCATION
Fluent Client search parameter constant for locationDescription: Uri where the data can be found
Type: uri
Path: DocumentReference.content.attachment.url
-
SP_CATEGORY
Search parameter: categoryDescription: Categorization of document
Type: token
Path: DocumentReference.category
- See Also:
-
CATEGORY
Fluent Client search parameter constant for categoryDescription: Categorization of document
Type: token
Path: DocumentReference.category
-
SP_RELATESTO
Search parameter: relatestoDescription: Target of the relationship
Type: reference
Path: DocumentReference.relatesTo.target
- See Also:
-
RELATESTO
Fluent Client search parameter constant for relatestoDescription: Target of the relationship
Type: reference
Path: DocumentReference.relatesTo.target
-
INCLUDE_RELATESTO
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:relatesto". -
SP_FACILITY
Search parameter: facilityDescription: Kind of facility where patient was seen
Type: token
Path: DocumentReference.context.facilityType
- See Also:
-
FACILITY
Fluent Client search parameter constant for facilityDescription: Kind of facility where patient was seen
Type: token
Path: DocumentReference.context.facilityType
-
SP_STATUS
Search parameter: statusDescription: current | superseded | entered-in-error
Type: token
Path: DocumentReference.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: current | superseded | entered-in-error
Type: token
Path: DocumentReference.status
-
-
Constructor Details
-
DocumentReference
public DocumentReference()Constructor -
DocumentReference
Constructor
-
-
Method Details
-
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
-
setMasterIdentifier
- 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
- Returns:
identifier
(Other identifiers associated with the document, including version independent identifiers.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
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
-
hasStatus
-
setStatusElement
- 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
- Returns:
- The status of this document reference.
-
setStatus
- Parameters:
value
- The status of this document reference.
-
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
-
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
- Returns:
- The status of the underlying document.
-
setDocStatus
- Parameters:
value
- The status of the underlying document.
-
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
-
setType
- 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
- 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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCategory
-
addCategory
-
addCategory
-
getCategoryFirstRep
- Returns:
- The first repetition of repeating field
category
, creating it if it does not already exist
-
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
-
setSubject
- 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
- 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
- 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
- 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
-
hasDate
-
setDateElement
- 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
- Returns:
- When the document reference was created.
-
setDate
- Parameters:
value
- When the document reference was created.
-
getAuthor
- Returns:
author
(Identifies who is responsible for adding the information to the document.)
-
setAuthor
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAuthor
-
addAuthor
-
addAuthor
-
getAuthorFirstRep
- Returns:
- The first repetition of repeating field
author
, creating it if it does not already exist
-
getAuthorTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getAuthenticator
- Returns:
authenticator
(Which person or organization authenticates that this document is valid.)
-
hasAuthenticator
-
setAuthenticator
- Parameters:
value
-authenticator
(Which person or organization authenticates that this document is valid.)
-
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
- 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
- Returns:
custodian
(Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.)
-
hasCustodian
-
setCustodian
- Parameters:
value
-custodian
(Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.)
-
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
- 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
- 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
-
addRelatesTo
-
addRelatesTo
-
getRelatesToFirstRep
- Returns:
- The first repetition of repeating field
relatesTo
, creating it if it does not already exist
-
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
-
hasDescription
-
setDescriptionElement
- 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
- Returns:
- Human-readable description of the source document.
-
setDescription
- Parameters:
value
- Human-readable description of the source document.
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSecurityLabel
-
addSecurityLabel
-
addSecurityLabel
-
getSecurityLabelFirstRep
- Returns:
- The first repetition of repeating field
securityLabel
, creating it if it does not already exist
-
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
-
addContent
-
addContent
-
getContentFirstRep
- Returns:
- The first repetition of repeating field
content
, creating it if it does not already exist
-
getContext
- Returns:
context
(The clinical context in which the document was prepared.)
-
hasContext
-
setContext
- Parameters:
value
-context
(The clinical context in which the document was prepared.)
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-