Class DocumentReference
- java.lang.Object
-
- org.hl7.fhir.dstu2016may.model.Base
-
- org.hl7.fhir.dstu2016may.model.BaseResource
-
- org.hl7.fhir.dstu2016may.model.Resource
-
- org.hl7.fhir.dstu2016may.model.DomainResource
-
- org.hl7.fhir.dstu2016may.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 .- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDocumentReference.DocumentReferenceContentComponentstatic classDocumentReference.DocumentReferenceContextComponentstatic classDocumentReference.DocumentReferenceContextRelatedComponentstatic classDocumentReference.DocumentReferenceRelatesToComponentstatic classDocumentReference.DocumentRelationshipTypestatic classDocumentReference.DocumentRelationshipTypeEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected ReferenceauthenticatorWhich person or organization authenticates that this document is valid.static ca.uhn.fhir.rest.gclient.ReferenceClientParamAUTHENTICATORFluent Client search parameter constant for authenticatorprotected ResourceauthenticatorTargetThe actual object that is the target of the reference (Which person or organization authenticates that this document is valid.)protected List<Reference>authorIdentifies who is responsible for adding the information to the document.static ca.uhn.fhir.rest.gclient.ReferenceClientParamAUTHORFluent Client search parameter constant for authorprotected List<Resource>authorTargetThe actual objects that are the target of the reference (Identifies who is responsible for adding the information to the document.)static ca.uhn.fhir.rest.gclient.TokenClientParamCLASSFluent Client search parameter constant for classprotected CodeableConceptclass_A categorization for the type of document referenced - helps for indexing and searching.protected List<DocumentReference.DocumentReferenceContentComponent>contentThe document and format referenced.protected DocumentReference.DocumentReferenceContextComponentcontextThe clinical context in which the document was prepared.protected DateTimeTypecreatedWhen the document was created.static ca.uhn.fhir.rest.gclient.DateClientParamCREATEDFluent Client search parameter constant for createdprotected ReferencecustodianIdentifies the organization or group who is responsible for ongoing maintenance of and access to the document.static ca.uhn.fhir.rest.gclient.ReferenceClientParamCUSTODIANFluent Client search parameter constant for custodianprotected OrganizationcustodianTargetThe 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 StringTypedescriptionHuman-readable description of the source document.static ca.uhn.fhir.rest.gclient.StringClientParamDESCRIPTIONFluent Client search parameter constant for descriptionprotected CodeableConceptdocStatusThe status of the underlying document.static ca.uhn.fhir.rest.gclient.ReferenceClientParamENCOUNTERFluent Client search parameter constant for encounterstatic ca.uhn.fhir.rest.gclient.TokenClientParamEVENTFluent Client search parameter constant for eventstatic ca.uhn.fhir.rest.gclient.TokenClientParamFACILITYFluent Client search parameter constant for facilitystatic ca.uhn.fhir.rest.gclient.TokenClientParamFORMATFluent Client search parameter constant for formatprotected List<Identifier>identifierOther identifiers associated with the document, including version independent identifiers.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_AUTHENTICATORConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_AUTHORConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_CUSTODIANConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_ENCOUNTERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PATIENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_RELATED_REFConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_RELATESTOConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SUBJECTConstant for fluent queries to be used to add include statements.protected InstantTypeindexedWhen the document reference was created.static ca.uhn.fhir.rest.gclient.DateClientParamINDEXEDFluent Client search parameter constant for indexedstatic ca.uhn.fhir.rest.gclient.TokenClientParamLANGUAGEFluent Client search parameter constant for languagestatic ca.uhn.fhir.rest.gclient.UriClientParamLOCATIONFluent Client search parameter constant for locationprotected IdentifiermasterIdentifierDocument identifier as assigned by the source of the document.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientstatic ca.uhn.fhir.rest.gclient.DateClientParamPERIODFluent Client search parameter constant for periodstatic ca.uhn.fhir.rest.gclient.TokenClientParamRELATED_IDFluent Client search parameter constant for related-idstatic ca.uhn.fhir.rest.gclient.ReferenceClientParamRELATED_REFFluent Client search parameter constant for related-refprotected List<DocumentReference.DocumentReferenceRelatesToComponent>relatesToRelationships that this document has with other document references that already exist.static ca.uhn.fhir.rest.gclient.ReferenceClientParamRELATESTOFluent Client search parameter constant for relatestostatic ca.uhn.fhir.rest.gclient.TokenClientParamRELATIONFluent Client search parameter constant for relationstatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.ReferenceClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam>RELATIONSHIPFluent Client search parameter constant for relationshipprotected List<CodeableConcept>securityLabelA set of Security-Tag codes specifying the level of privacy/security of the Document.static ca.uhn.fhir.rest.gclient.TokenClientParamSECURITYLABELFluent Client search parameter constant for securitylabelstatic ca.uhn.fhir.rest.gclient.TokenClientParamSETTINGFluent Client search parameter constant for settingstatic StringSP_AUTHENTICATORSearch parameter: authenticatorstatic StringSP_AUTHORSearch parameter: authorstatic StringSP_CLASSSearch parameter: classstatic StringSP_CREATEDSearch parameter: createdstatic StringSP_CUSTODIANSearch parameter: custodianstatic StringSP_DESCRIPTIONSearch parameter: descriptionstatic StringSP_ENCOUNTERSearch parameter: encounterstatic StringSP_EVENTSearch parameter: eventstatic StringSP_FACILITYSearch parameter: facilitystatic StringSP_FORMATSearch parameter: formatstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_INDEXEDSearch parameter: indexedstatic StringSP_LANGUAGESearch parameter: languagestatic StringSP_LOCATIONSearch parameter: locationstatic StringSP_PATIENTSearch parameter: patientstatic StringSP_PERIODSearch parameter: periodstatic StringSP_RELATED_IDSearch parameter: related-idstatic StringSP_RELATED_REFSearch parameter: related-refstatic StringSP_RELATESTOSearch parameter: relatestostatic StringSP_RELATIONSearch parameter: relationstatic StringSP_RELATIONSHIPSearch parameter: relationshipstatic StringSP_SECURITYLABELSearch parameter: securitylabelstatic StringSP_SETTINGSearch parameter: settingstatic StringSP_STATUSSearch parameter: statusstatic StringSP_SUBJECTSearch parameter: subjectstatic StringSP_TYPESearch parameter: typeprotected Enumeration<Enumerations.DocumentReferenceStatus>statusThe status of this document reference.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected ReferencesubjectWho or what the document is about.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUBJECTFluent Client search parameter constant for subjectprotected ResourcesubjectTargetThe actual object that is the target of the reference (Who or what the document is about.protected CodeableConcepttypeSpecifies the particular kind of document referenced (e.g.static ca.uhn.fhir.rest.gclient.TokenClientParamTYPEFluent Client search parameter constant for type-
Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description DocumentReference()ConstructorDocumentReference(CodeableConcept type, InstantType indexed, Enumeration<Enumerations.DocumentReferenceStatus> status)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText
-
Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource
getStructureFhirVersionEnum, setId
-
Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
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.
-
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).)
-
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.
-
class_
protected CodeableConcept class_
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.
-
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.)
-
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.)
-
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.)
-
created
protected DateTimeType created
When the document was created.
-
indexed
protected InstantType indexed
When the document reference was created.
-
status
protected Enumeration<Enumerations.DocumentReferenceStatus> status
The status of this document reference.
-
docStatus
protected CodeableConcept docStatus
The status of the underlying 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. This is sometimes known as the "title".
-
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_RELATED_REF
public static final String SP_RELATED_REF
Search parameter: related-refDescription: Related Resource
Type: reference
Path: DocumentReference.context.related.ref
- See Also:
- Constant Field Values
-
RELATED_REF
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RELATED_REF
Fluent Client search parameter constant for related-refDescription: Related Resource
Type: reference
Path: DocumentReference.context.related.ref
-
INCLUDE_RELATED_REF
public static final ca.uhn.fhir.model.api.Include INCLUDE_RELATED_REF
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:related-ref".
-
SP_RELATED_ID
public static final String SP_RELATED_ID
Search parameter: related-idDescription: Identifier of related objects or events
Type: token
Path: DocumentReference.context.related.identifier
- See Also:
- Constant Field Values
-
RELATED_ID
public static final ca.uhn.fhir.rest.gclient.TokenClientParam RELATED_ID
Fluent Client search parameter constant for related-idDescription: Identifier of related objects or events
Type: token
Path: DocumentReference.context.related.identifier
-
SP_INDEXED
public static final String SP_INDEXED
Search parameter: indexedDescription: When this document reference created
Type: date
Path: DocumentReference.indexed
- See Also:
- Constant Field Values
-
INDEXED
public static final ca.uhn.fhir.rest.gclient.DateClientParam INDEXED
Fluent Client search parameter constant for indexedDescription: When this document reference created
Type: date
Path: DocumentReference.indexed
-
SP_LOCATION
public static final String SP_LOCATION
Search parameter: locationDescription: 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 locationDescription: Uri where the data can be found
Type: uri
Path: DocumentReference.content.attachment.url
-
SP_RELATESTO
public static final String SP_RELATESTO
Search parameter: relatestoDescription: 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 relatestoDescription: 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_SUBJECT
public static final String SP_SUBJECT
Search parameter: subjectDescription: 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 subjectDescription: 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_ENCOUNTER
public static final String SP_ENCOUNTER
Search parameter: encounterDescription: 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 encounterDescription: 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_TYPE
public static final String SP_TYPE
Search parameter: typeDescription: 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 typeDescription: Kind of document (LOINC if possible)
Type: token
Path: DocumentReference.type
-
SP_SECURITYLABEL
public static final String SP_SECURITYLABEL
Search parameter: securitylabelDescription: Document security-tags
Type: token
Path: DocumentReference.securityLabel
- See Also:
- Constant Field Values
-
SECURITYLABEL
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SECURITYLABEL
Fluent Client search parameter constant for securitylabelDescription: Document security-tags
Type: token
Path: DocumentReference.securityLabel
-
SP_SETTING
public static final String 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:
- Constant Field Values
-
SETTING
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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_AUTHOR
public static final String SP_AUTHOR
Search parameter: authorDescription: 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 authorDescription: 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_CUSTODIAN
public static final String SP_CUSTODIAN
Search parameter: custodianDescription: 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 custodianDescription: 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_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: 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 patientDescription: 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_FACILITY
public static final String SP_FACILITY
Search parameter: facilityDescription: 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 facilityDescription: Kind of facility where patient was seen
Type: token
Path: DocumentReference.context.facilityType
-
SP_CREATED
public static final String SP_CREATED
Search parameter: createdDescription: Document creation time
Type: date
Path: DocumentReference.created
- See Also:
- Constant Field Values
-
CREATED
public static final ca.uhn.fhir.rest.gclient.DateClientParam CREATED
Fluent Client search parameter constant for createdDescription: Document creation time
Type: date
Path: DocumentReference.created
-
SP_DESCRIPTION
public static final String SP_DESCRIPTION
Search parameter: descriptionDescription: Human-readable description (title)
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 descriptionDescription: Human-readable description (title)
Type: string
Path: DocumentReference.description
-
SP_EVENT
public static final String SP_EVENT
Search parameter: eventDescription: 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 eventDescription: Main Clinical Acts Documented
Type: token
Path: DocumentReference.context.event
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: 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 statusDescription: current | superseded | entered-in-error
Type: token
Path: DocumentReference.status
-
SP_RELATION
public static final String SP_RELATION
Search parameter: relationDescription: 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 relationDescription: replaces | transforms | signs | appends
Type: token
Path: DocumentReference.relatesTo.code
-
SP_CLASS
public static final String SP_CLASS
Search parameter: classDescription: Categorization of document
Type: token
Path: DocumentReference.class
- See Also:
- Constant Field Values
-
CLASS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CLASS
Fluent Client search parameter constant for classDescription: Categorization of document
Type: token
Path: DocumentReference.class
-
SP_FORMAT
public static final String SP_FORMAT
Search parameter: formatDescription: 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 formatDescription: Format/content rules for the document
Type: token
Path: DocumentReference.content.format
-
SP_PERIOD
public static final String SP_PERIOD
Search parameter: periodDescription: 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 periodDescription: Time of service that is being documented
Type: date
Path: DocumentReference.context.period
-
SP_AUTHENTICATOR
public static final String SP_AUTHENTICATOR
Search parameter: authenticatorDescription: 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 authenticatorDescription: 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_RELATIONSHIP
public static final String SP_RELATIONSHIP
Search parameter: relationshipDescription: 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 relationshipDescription: Combination of relation and relatesTo
Type: composite
Path:
-
SP_LANGUAGE
public static final String SP_LANGUAGE
Search parameter: languageDescription: 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 languageDescription: Human language of the content (BCP-47)
Type: token
Path: DocumentReference.content.attachment.language
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: 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 identifierDescription: Master Version Specific Identifier
Type: token
Path: DocumentReference.masterIdentifier, DocumentReference.identifier
-
-
Constructor Detail
-
DocumentReference
public DocumentReference()
Constructor
-
DocumentReference
public DocumentReference(CodeableConcept type, InstantType indexed, Enumeration<Enumerations.DocumentReferenceStatus> status)
Constructor
-
-
Method Detail
-
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.)
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
- Returns:
identifier(Other identifiers associated with the document, including version independent identifiers.)
-
addIdentifier
public DocumentReference addIdentifier(Identifier t)
-
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:
subjectThe 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-subjectThe 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).)
-
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.)
-
getClass_
public CodeableConcept getClass_()
- Returns:
class_(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.)
-
hasClass_
public boolean hasClass_()
-
setClass_
public DocumentReference setClass_(CodeableConcept value)
- Parameters:
value-class_(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.)
-
getAuthor
public List<Reference> getAuthor()
- Returns:
author(Identifies who is responsible for adding the information to the document.)
-
hasAuthor
public boolean hasAuthor()
-
addAuthor
public Reference addAuthor()
- Returns:
author(Identifies who is responsible for adding the information to the document.)
-
addAuthor
public DocumentReference addAuthor(Reference t)
-
getAuthorTarget
public List<Resource> getAuthorTarget()
- Returns:
author(The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Identifies who is responsible for adding the information to the document.)
-
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:
custodianThe 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-custodianThe 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.)
-
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:
authenticatorThe 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-authenticatorThe 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.)
-
getCreatedElement
public DateTimeType getCreatedElement()
- Returns:
created(When the document was created.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value
-
hasCreatedElement
public boolean hasCreatedElement()
-
hasCreated
public boolean hasCreated()
-
setCreatedElement
public DocumentReference setCreatedElement(DateTimeType value)
- Parameters:
value-created(When the document was created.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value
-
getCreated
public Date getCreated()
- Returns:
- When the document was created.
-
setCreated
public DocumentReference setCreated(Date value)
- Parameters:
value- When the document was created.
-
getIndexedElement
public InstantType getIndexedElement()
- Returns:
indexed(When the document reference was created.). This is the underlying object with id, value and extensions. The accessor "getIndexed" gives direct access to the value
-
hasIndexedElement
public boolean hasIndexedElement()
-
hasIndexed
public boolean hasIndexed()
-
setIndexedElement
public DocumentReference setIndexedElement(InstantType value)
- Parameters:
value-indexed(When the document reference was created.). This is the underlying object with id, value and extensions. The accessor "getIndexed" gives direct access to the value
-
getIndexed
public Date getIndexed()
- Returns:
- When the document reference was created.
-
setIndexed
public DocumentReference setIndexed(Date value)
- Parameters:
value- When the document reference was created.
-
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.
-
getDocStatus
public CodeableConcept getDocStatus()
- Returns:
docStatus(The status of the underlying document.)
-
hasDocStatus
public boolean hasDocStatus()
-
setDocStatus
public DocumentReference setDocStatus(CodeableConcept value)
- Parameters:
value-docStatus(The status of the underlying document.)
-
getRelatesTo
public List<DocumentReference.DocumentReferenceRelatesToComponent> getRelatesTo()
- Returns:
relatesTo(Relationships that this document has with other document references that already exist.)
-
hasRelatesTo
public boolean hasRelatesTo()
-
addRelatesTo
public DocumentReference.DocumentReferenceRelatesToComponent addRelatesTo()
- Returns:
relatesTo(Relationships that this document has with other document references that already exist.)
-
addRelatesTo
public DocumentReference addRelatesTo(DocumentReference.DocumentReferenceRelatesToComponent t)
-
getDescriptionElement
public StringType getDescriptionElement()
- Returns:
description(Human-readable description of the source document. This is sometimes known as the "title".). 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 sometimes known as the "title".). 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. This is sometimes known as the "title".
-
setDescription
public DocumentReference setDescription(String value)
- Parameters:
value- Human-readable description of the source document. This is sometimes known as the "title".
-
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.)
-
hasSecurityLabel
public boolean hasSecurityLabel()
-
addSecurityLabel
public CodeableConcept addSecurityLabel()
- 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.)
-
addSecurityLabel
public DocumentReference addSecurityLabel(CodeableConcept t)
-
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.)
-
hasContent
public boolean hasContent()
-
addContent
public DocumentReference.DocumentReferenceContentComponent addContent()
- Returns:
content(The document and format referenced. There may be multiple content element repetitions, each with a different format.)
-
addContent
public DocumentReference addContent(DocumentReference.DocumentReferenceContentComponent t)
-
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> childrenList)
- Overrides:
listChildrenin classDomainResource
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public void setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
Description copied from class:Basemake an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property- Overrides:
makePropertyin classDomainResource- Returns:
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public DocumentReference copy()
- Specified by:
copyin classDomainResource
-
typedCopy
protected DocumentReference typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-