public class DocumentReference extends DomainResource
| Modifier and Type | Class and 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 |
| Modifier and Type | Field and 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
|
contained, extension, modifierExtension, textid, implicitRules, language, meta| Constructor and Description |
|---|
DocumentReference()
Constructor
|
DocumentReference(Enumeration<Enumerations.DocumentReferenceStatus> status)
Constructor
|
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setTextcopyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetagetStructureFhirVersionEnum, isResource, setIdcastToAddress, 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, setUserDataINNclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetId, getIdElement, getLanguageElement, getUserData, setId, setUserDataprotected Identifier masterIdentifier
protected List<Identifier> identifier
protected Enumeration<Enumerations.DocumentReferenceStatus> status
protected Enumeration<DocumentReference.ReferredDocumentStatus> docStatus
protected CodeableConcept type
protected List<CodeableConcept> category
protected Reference subject
protected Resource subjectTarget
protected InstantType date
protected List<Reference> author
protected List<Resource> authorTarget
protected Reference authenticator
protected Resource authenticatorTarget
protected Reference custodian
protected Organization custodianTarget
protected List<DocumentReference.DocumentReferenceRelatesToComponent> relatesTo
protected StringType description
protected List<CodeableConcept> securityLabel
protected List<DocumentReference.DocumentReferenceContentComponent> content
protected DocumentReference.DocumentReferenceContextComponent context
public static final String SP_DATE
Description: When this document reference was created
Type: date
Path: DocumentReference.date
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Description: When this document reference was created
Type: date
Path: DocumentReference.date
public static final String SP_SUBJECT
Description: Who/what is the subject of the document
Type: reference
Path: DocumentReference.subject
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
Description: Who/what is the subject of the document
Type: reference
Path: DocumentReference.subject
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
public static final String SP_DESCRIPTION
Description: Human-readable description
Type: string
Path: DocumentReference.description
public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
Description: Human-readable description
Type: string
Path: DocumentReference.description
public static final String SP_LANGUAGE
Description: Human language of the content (BCP-47)
Type: token
Path: DocumentReference.content.attachment.language
public static final ca.uhn.fhir.rest.gclient.TokenClientParam LANGUAGE
Description: Human language of the content (BCP-47)
Type: token
Path: DocumentReference.content.attachment.language
public static final String SP_TYPE
Description: Kind of document (LOINC if possible)
Type: token
Path: DocumentReference.type
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
Description: Kind of document (LOINC if possible)
Type: token
Path: DocumentReference.type
public static final String SP_RELATION
Description: replaces | transforms | signs | appends
Type: token
Path: DocumentReference.relatesTo.code
public static final ca.uhn.fhir.rest.gclient.TokenClientParam RELATION
Description: replaces | transforms | signs | appends
Type: token
Path: DocumentReference.relatesTo.code
public static final String SP_SETTING
Description: Additional details about where the content was created (e.g. clinical specialty)
Type: token
Path: DocumentReference.context.practiceSetting
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SETTING
Description: Additional details about where the content was created (e.g. clinical specialty)
Type: token
Path: DocumentReference.context.practiceSetting
public static final String SP_RELATED
Description: Related identifiers or resources
Type: reference
Path: DocumentReference.context.related
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RELATED
Description: Related identifiers or resources
Type: reference
Path: DocumentReference.context.related
public static final ca.uhn.fhir.model.api.Include INCLUDE_RELATED
public static final String SP_PATIENT
Description: Who/what is the subject of the document
Type: reference
Path: DocumentReference.subject
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Description: Who/what is the subject of the document
Type: reference
Path: DocumentReference.subject
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
public static final String SP_RELATIONSHIP
Description: Combination of relation and relatesTo
Type: composite
Path:
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.ReferenceClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> RELATIONSHIP
Description: Combination of relation and relatesTo
Type: composite
Path:
public static final String SP_EVENT
Description: Main clinical acts documented
Type: token
Path: DocumentReference.context.event
public static final ca.uhn.fhir.rest.gclient.TokenClientParam EVENT
Description: Main clinical acts documented
Type: token
Path: DocumentReference.context.event
public static final String SP_AUTHENTICATOR
Description: Who/what authenticated the document
Type: reference
Path: DocumentReference.authenticator
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AUTHENTICATOR
Description: Who/what authenticated the document
Type: reference
Path: DocumentReference.authenticator
public static final ca.uhn.fhir.model.api.Include INCLUDE_AUTHENTICATOR
public static final String SP_IDENTIFIER
Description: Master Version Specific Identifier
Type: token
Path: DocumentReference.masterIdentifier, DocumentReference.identifier
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Description: Master Version Specific Identifier
Type: token
Path: DocumentReference.masterIdentifier, DocumentReference.identifier
public static final String SP_PERIOD
Description: Time of service that is being documented
Type: date
Path: DocumentReference.context.period
public static final ca.uhn.fhir.rest.gclient.DateClientParam PERIOD
Description: Time of service that is being documented
Type: date
Path: DocumentReference.context.period
public static final String SP_CUSTODIAN
Description: Organization which maintains the document
Type: reference
Path: DocumentReference.custodian
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CUSTODIAN
Description: Organization which maintains the document
Type: reference
Path: DocumentReference.custodian
public static final ca.uhn.fhir.model.api.Include INCLUDE_CUSTODIAN
public static final String SP_AUTHOR
Description: Who and/or what authored the document
Type: reference
Path: DocumentReference.author
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AUTHOR
Description: Who and/or what authored the document
Type: reference
Path: DocumentReference.author
public static final ca.uhn.fhir.model.api.Include INCLUDE_AUTHOR
public static final String SP_FORMAT
Description: Format/content rules for the document
Type: token
Path: DocumentReference.content.format
public static final ca.uhn.fhir.rest.gclient.TokenClientParam FORMAT
Description: Format/content rules for the document
Type: token
Path: DocumentReference.content.format
public static final String SP_ENCOUNTER
Description: Context of the document content
Type: reference
Path: DocumentReference.context.encounter
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER
Description: Context of the document content
Type: reference
Path: DocumentReference.context.encounter
public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER
public static final String SP_CONTENTTYPE
Description: Mime type of the content, with charset etc.
Type: token
Path: DocumentReference.content.attachment.contentType
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTENTTYPE
Description: Mime type of the content, with charset etc.
Type: token
Path: DocumentReference.content.attachment.contentType
public static final String SP_SECURITY_LABEL
Description: Document security-tags
Type: token
Path: DocumentReference.securityLabel
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SECURITY_LABEL
Description: Document security-tags
Type: token
Path: DocumentReference.securityLabel
public static final String SP_LOCATION
Description: Uri where the data can be found
Type: uri
Path: DocumentReference.content.attachment.url
public static final ca.uhn.fhir.rest.gclient.UriClientParam LOCATION
Description: Uri where the data can be found
Type: uri
Path: DocumentReference.content.attachment.url
public static final String SP_CATEGORY
Description: Categorization of document
Type: token
Path: DocumentReference.category
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY
Description: Categorization of document
Type: token
Path: DocumentReference.category
public static final String SP_RELATESTO
Description: Target of the relationship
Type: reference
Path: DocumentReference.relatesTo.target
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RELATESTO
Description: Target of the relationship
Type: reference
Path: DocumentReference.relatesTo.target
public static final ca.uhn.fhir.model.api.Include INCLUDE_RELATESTO
public static final String SP_FACILITY
Description: Kind of facility where patient was seen
Type: token
Path: DocumentReference.context.facilityType
public static final ca.uhn.fhir.rest.gclient.TokenClientParam FACILITY
Description: Kind of facility where patient was seen
Type: token
Path: DocumentReference.context.facilityType
public static final String SP_STATUS
Description: current | superseded | entered-in-error
Type: token
Path: DocumentReference.status
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Description: current | superseded | entered-in-error
Type: token
Path: DocumentReference.status
public DocumentReference()
public DocumentReference(Enumeration<Enumerations.DocumentReferenceStatus> status)
public Identifier getMasterIdentifier()
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.)public boolean hasMasterIdentifier()
public DocumentReference setMasterIdentifier(Identifier value)
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.)public List<Identifier> getIdentifier()
identifier (Other identifiers associated with the document, including version independent identifiers.)public DocumentReference setIdentifier(List<Identifier> theIdentifier)
this for easy method chainingpublic boolean hasIdentifier()
public Identifier addIdentifier()
public DocumentReference addIdentifier(Identifier t)
public Identifier getIdentifierFirstRep()
identifier, creating it if it does not already existpublic Enumeration<Enumerations.DocumentReferenceStatus> getStatusElement()
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 valuepublic boolean hasStatusElement()
public boolean hasStatus()
public DocumentReference setStatusElement(Enumeration<Enumerations.DocumentReferenceStatus> value)
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 valuepublic Enumerations.DocumentReferenceStatus getStatus()
public DocumentReference setStatus(Enumerations.DocumentReferenceStatus value)
value - The status of this document reference.public Enumeration<DocumentReference.ReferredDocumentStatus> getDocStatusElement()
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 valuepublic boolean hasDocStatusElement()
public boolean hasDocStatus()
public DocumentReference setDocStatusElement(Enumeration<DocumentReference.ReferredDocumentStatus> value)
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 valuepublic DocumentReference.ReferredDocumentStatus getDocStatus()
public DocumentReference setDocStatus(DocumentReference.ReferredDocumentStatus value)
value - The status of the underlying document.public CodeableConcept getType()
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.)public boolean hasType()
public DocumentReference setType(CodeableConcept value)
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.)public List<CodeableConcept> getCategory()
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.)public DocumentReference setCategory(List<CodeableConcept> theCategory)
this for easy method chainingpublic boolean hasCategory()
public CodeableConcept addCategory()
public DocumentReference addCategory(CodeableConcept t)
public CodeableConcept getCategoryFirstRep()
category, creating it if it does not already existpublic Reference getSubject()
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).)public boolean hasSubject()
public DocumentReference setSubject(Reference value)
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).)public Resource getSubjectTarget()
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).)public DocumentReference setSubjectTarget(Resource value)
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).)public InstantType getDateElement()
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 valuepublic boolean hasDateElement()
public boolean hasDate()
public DocumentReference setDateElement(InstantType value)
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 valuepublic DocumentReference setDate(Date value)
value - When the document reference was created.public List<Reference> getAuthor()
author (Identifies who is responsible for adding the information to the document.)public DocumentReference setAuthor(List<Reference> theAuthor)
this for easy method chainingpublic boolean hasAuthor()
public DocumentReference addAuthor(Reference t)
public Reference getAuthorFirstRep()
author, creating it if it does not already exist@Deprecated public List<Resource> getAuthorTarget()
public Reference getAuthenticator()
authenticator (Which person or organization authenticates that this document is valid.)public boolean hasAuthenticator()
public DocumentReference setAuthenticator(Reference value)
value - authenticator (Which person or organization authenticates that this document is valid.)public Resource getAuthenticatorTarget()
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.)public DocumentReference setAuthenticatorTarget(Resource value)
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.)public Reference getCustodian()
custodian (Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.)public boolean hasCustodian()
public DocumentReference setCustodian(Reference value)
value - custodian (Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.)public Organization getCustodianTarget()
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.)public DocumentReference setCustodianTarget(Organization value)
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.)public List<DocumentReference.DocumentReferenceRelatesToComponent> getRelatesTo()
relatesTo (Relationships that this document has with other document references that already exist.)public DocumentReference setRelatesTo(List<DocumentReference.DocumentReferenceRelatesToComponent> theRelatesTo)
this for easy method chainingpublic boolean hasRelatesTo()
public DocumentReference.DocumentReferenceRelatesToComponent addRelatesTo()
public DocumentReference addRelatesTo(DocumentReference.DocumentReferenceRelatesToComponent t)
public DocumentReference.DocumentReferenceRelatesToComponent getRelatesToFirstRep()
relatesTo, creating it if it does not already existpublic StringType getDescriptionElement()
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 valuepublic boolean hasDescriptionElement()
public boolean hasDescription()
public DocumentReference setDescriptionElement(StringType value)
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 valuepublic String getDescription()
public DocumentReference setDescription(String value)
value - Human-readable description of the source document.public List<CodeableConcept> getSecurityLabel()
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.)public DocumentReference setSecurityLabel(List<CodeableConcept> theSecurityLabel)
this for easy method chainingpublic boolean hasSecurityLabel()
public CodeableConcept addSecurityLabel()
public DocumentReference addSecurityLabel(CodeableConcept t)
public CodeableConcept getSecurityLabelFirstRep()
securityLabel, creating it if it does not already existpublic List<DocumentReference.DocumentReferenceContentComponent> getContent()
content (The document and format referenced. There may be multiple content element repetitions, each with a different format.)public DocumentReference setContent(List<DocumentReference.DocumentReferenceContentComponent> theContent)
this for easy method chainingpublic boolean hasContent()
public DocumentReference.DocumentReferenceContentComponent addContent()
public DocumentReference addContent(DocumentReference.DocumentReferenceContentComponent t)
public DocumentReference.DocumentReferenceContentComponent getContentFirstRep()
content, creating it if it does not already existpublic DocumentReference.DocumentReferenceContextComponent getContext()
context (The clinical context in which the document was prepared.)public boolean hasContext()
public DocumentReference setContext(DocumentReference.DocumentReferenceContextComponent value)
value - context (The clinical context in which the document was prepared.)protected void listChildren(List<Property> children)
listChildren in class DomainResourcepublic Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
getNamedProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
getProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
makeProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
getTypesForProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
addChild in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic String fhirType()
fhirType in interface org.hl7.fhir.instance.model.api.IBasefhirType in class DomainResourcepublic DocumentReference copy()
copy in class DomainResourcepublic void copyValues(DocumentReference dst)
protected DocumentReference typedCopy()
public boolean equalsDeep(Base other_)
equalsDeep in class DomainResourcepublic boolean equalsShallow(Base other_)
equalsShallow in class DomainResourcepublic boolean isEmpty()
isEmpty in interface org.hl7.fhir.instance.model.api.IBaseisEmpty in class DomainResourcepublic ResourceType getResourceType()
getResourceType in class ResourceCopyright © 2014–2021 Health Level 7. All rights reserved.