Class DocumentReference
- java.lang.Object
-
- org.hl7.fhir.r5.model.Base
-
- org.hl7.fhir.r5.model.BaseResource
-
- org.hl7.fhir.r5.model.Resource
-
- org.hl7.fhir.r5.model.DomainResource
-
- org.hl7.fhir.r5.model.DocumentReference
-
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement,Serializable,org.hl7.fhir.instance.model.api.IAnyResource,org.hl7.fhir.instance.model.api.IBase,org.hl7.fhir.instance.model.api.IBaseHasExtensions,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions,org.hl7.fhir.instance.model.api.IBaseResource,org.hl7.fhir.instance.model.api.IDomainResource
public class DocumentReference extends DomainResource
A reference to a document of any kind for any purpose. While the term “document” implies a more narrow focus, for this resource this "document" encompasses *any* serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDocumentReference.DocumentAttestationModestatic classDocumentReference.DocumentAttestationModeEnumFactorystatic classDocumentReference.DocumentReferenceAttesterComponentstatic classDocumentReference.DocumentReferenceContentComponentstatic classDocumentReference.DocumentReferenceRelatesToComponent
-
Field Summary
Fields Modifier and Type Field Description protected List<DocumentReference.DocumentReferenceAttesterComponent>attesterA participant who has attested to the accuracy of the composition/document.static ca.uhn.fhir.rest.gclient.ReferenceClientParamATTESTERFluent Client search parameter constant for attesterprotected 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 authorstatic ca.uhn.fhir.rest.gclient.ReferenceClientParamBASED_ONFluent Client search parameter constant for based-onprotected List<Reference>basedOnA procedure that is fulfilled in whole or in part by the creation of this media.protected List<CodeableConcept>categoryA categorization for the type of document referenced - helps for indexing and searching.static ca.uhn.fhir.rest.gclient.TokenClientParamCATEGORYFluent Client search parameter constant for categoryprotected List<DocumentReference.DocumentReferenceContentComponent>contentThe document and format referenced.static ca.uhn.fhir.rest.gclient.TokenClientParamCONTENTTYPEFluent Client search parameter constant for contenttypestatic ca.uhn.fhir.rest.gclient.DateClientParamCREATIONFluent Client search parameter constant for creationprotected 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 InstantTypedateWhen the document reference was created.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for dateprotected MarkdownTypedescriptionHuman-readable description of the source document.static ca.uhn.fhir.rest.gclient.StringClientParamDESCRIPTIONFluent Client search parameter constant for descriptionstatic ca.uhn.fhir.rest.gclient.TokenClientParamDOC_STATUSFluent Client search parameter constant for doc-statusprotected Enumeration<Enumerations.CompositionStatus>docStatusThe status of the underlying document.protected List<Reference>encounterDescribes the clinical encounter or type of care that the document content is associated with.static ca.uhn.fhir.rest.gclient.ReferenceClientParamENCOUNTERFluent Client search parameter constant for encounterprotected List<CodeableConcept>eventThis list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented.static ca.uhn.fhir.rest.gclient.TokenClientParamEVENTFluent Client search parameter constant for eventstatic ca.uhn.fhir.rest.gclient.TokenClientParamFACILITYFluent Client search parameter constant for facilityprotected CodeableConceptfacilityTypeThe kind of facility where the patient was seen.static 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_ATTESTERConstant 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_BASED_ONConstant 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_RELATEDConstant 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.static ca.uhn.fhir.rest.gclient.TokenClientParamLANGUAGEFluent Client search parameter constant for languagestatic ca.uhn.fhir.rest.gclient.UriClientParamLOCATIONFluent Client search parameter constant for locationstatic ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientprotected PeriodperiodThe time period over which the service that is described by the document was provided.static ca.uhn.fhir.rest.gclient.DateClientParamPERIODFluent Client search parameter constant for periodprotected CodeableConceptpracticeSettingThis property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.protected List<Reference>relatedRelated identifiers or resources associated with the DocumentReference.static ca.uhn.fhir.rest.gclient.ReferenceClientParamRELATEDFluent Client search parameter constant for relatedprotected 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 relationshipstatic ca.uhn.fhir.rest.gclient.TokenClientParamSECURITY_LABELFluent Client search parameter constant for security-labelprotected List<CodeableConcept>securityLabelA set of Security-Tag codes specifying the level of privacy/security of the Document.static ca.uhn.fhir.rest.gclient.TokenClientParamSETTINGFluent Client search parameter constant for settingprotected ReferencesourcePatientInfoThe Patient Information as known when the document was published.static StringSP_ATTESTERSearch parameter: attesterstatic StringSP_AUTHORSearch parameter: authorstatic StringSP_BASED_ONSearch parameter: based-onstatic StringSP_CATEGORYSearch parameter: categorystatic StringSP_CONTENTTYPESearch parameter: contenttypestatic StringSP_CREATIONSearch parameter: creationstatic StringSP_CUSTODIANSearch parameter: custodianstatic StringSP_DATESearch parameter: datestatic StringSP_DESCRIPTIONSearch parameter: descriptionstatic StringSP_DOC_STATUSSearch parameter: doc-statusstatic StringSP_ENCOUNTERSearch parameter: encounterstatic StringSP_EVENTSearch parameter: eventstatic StringSP_FACILITYSearch parameter: facilitystatic StringSP_FORMATSearch parameter: formatstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_LANGUAGESearch parameter: languagestatic StringSP_LOCATIONSearch parameter: locationstatic StringSP_PATIENTSearch parameter: patientstatic StringSP_PERIODSearch parameter: periodstatic StringSP_RELATEDSearch parameter: relatedstatic StringSP_RELATESTOSearch parameter: relatestostatic StringSP_RELATIONSearch parameter: relationstatic StringSP_RELATIONSHIPSearch parameter: relationshipstatic StringSP_SECURITY_LABELSearch parameter: security-labelstatic 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 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.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
-
Fields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description DocumentReference()ConstructorDocumentReference(Enumerations.DocumentReferenceStatus status, DocumentReference.DocumentReferenceContentComponent content)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r5.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.r5.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, 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
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
Other identifiers associated with the document, including version independent identifiers.
-
basedOn
protected List<Reference> basedOn
A procedure that is fulfilled in whole or in part by the creation of this media.
-
status
protected Enumeration<Enumerations.DocumentReferenceStatus> status
The status of this document reference.
-
docStatus
protected Enumeration<Enumerations.CompositionStatus> docStatus
The status of the underlying document.
-
type
protected CodeableConcept type
Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.
-
category
protected List<CodeableConcept> category
A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.
-
subject
protected Reference subject
Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).
-
encounter
protected List<Reference> encounter
Describes the clinical encounter or type of care that the document content is associated with.
-
event
protected List<CodeableConcept> event
This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.
-
facilityType
protected CodeableConcept facilityType
The kind of facility where the patient was seen.
-
practiceSetting
protected CodeableConcept practiceSetting
This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.
-
period
protected Period period
The time period over which the service that is described by the document was provided.
-
date
protected InstantType date
When the document reference was created.
-
author
protected List<Reference> author
Identifies who is responsible for adding the information to the document.
-
attester
protected List<DocumentReference.DocumentReferenceAttesterComponent> attester
A participant who has attested to the accuracy of the composition/document.
-
custodian
protected Reference custodian
Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.
-
relatesTo
protected List<DocumentReference.DocumentReferenceRelatesToComponent> relatesTo
Relationships that this document has with other document references that already exist.
-
description
protected MarkdownType description
Human-readable description of the source document.
-
securityLabel
protected List<CodeableConcept> securityLabel
A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.
-
content
protected List<DocumentReference.DocumentReferenceContentComponent> content
The document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadata.
-
sourcePatientInfo
protected Reference sourcePatientInfo
The Patient Information as known when the document was published. May be a reference to a version specific, or contained.
-
related
protected List<Reference> related
Related identifiers or resources associated with the DocumentReference.
-
SP_ATTESTER
public static final String SP_ATTESTER
Search parameter: attesterDescription: Who attested the composition
Type: reference
Path: DocumentReference.attester.party
- See Also:
- Constant Field Values
-
ATTESTER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ATTESTER
Fluent Client search parameter constant for attesterDescription: Who attested the composition
Type: reference
Path: DocumentReference.attester.party
-
INCLUDE_ATTESTER
public static final ca.uhn.fhir.model.api.Include INCLUDE_ATTESTER
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:attester".
-
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_BASED_ON
public static final String SP_BASED_ON
Search parameter: based-onDescription: Procedure that caused this media to be created
Type: reference
Path: DocumentReference.basedOn
- See Also:
- Constant Field Values
-
BASED_ON
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASED_ON
Fluent Client search parameter constant for based-onDescription: Procedure that caused this media to be created
Type: reference
Path: DocumentReference.basedOn
-
INCLUDE_BASED_ON
public static final ca.uhn.fhir.model.api.Include INCLUDE_BASED_ON
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:based-on".
-
SP_CATEGORY
public static final String SP_CATEGORY
Search parameter: categoryDescription: Categorization of document
Type: token
Path: DocumentReference.category
- See Also:
- Constant Field Values
-
CATEGORY
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY
Fluent Client search parameter constant for categoryDescription: Categorization of document
Type: token
Path: DocumentReference.category
-
SP_CONTENTTYPE
public static final String SP_CONTENTTYPE
Search parameter: contenttypeDescription: Mime type of the content, with charset etc.
Type: token
Path: DocumentReference.content.attachment.contentType
- See Also:
- Constant Field Values
-
CONTENTTYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTENTTYPE
Fluent Client search parameter constant for contenttypeDescription: Mime type of the content, with charset etc.
Type: token
Path: DocumentReference.content.attachment.contentType
-
SP_CREATION
public static final String SP_CREATION
Search parameter: creationDescription: Date attachment was first created
Type: date
Path: DocumentReference.content.attachment.creation
- See Also:
- Constant Field Values
-
CREATION
public static final ca.uhn.fhir.rest.gclient.DateClientParam CREATION
Fluent Client search parameter constant for creationDescription: Date attachment was first created
Type: date
Path: DocumentReference.content.attachment.creation
-
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_DATE
public static final String SP_DATE
Search parameter: dateDescription: When this document reference was created
Type: date
Path: DocumentReference.date
- See Also:
- Constant Field Values
-
DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Fluent Client search parameter constant for dateDescription: When this document reference was created
Type: date
Path: DocumentReference.date
-
SP_DESCRIPTION
public static final String SP_DESCRIPTION
Search parameter: descriptionDescription: Human-readable description
Type: string
Path: DocumentReference.description
- See Also:
- Constant Field Values
-
DESCRIPTION
public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
Fluent Client search parameter constant for descriptionDescription: Human-readable description
Type: string
Path: DocumentReference.description
-
SP_DOC_STATUS
public static final String SP_DOC_STATUS
Search parameter: doc-statusDescription: preliminary | final | amended | entered-in-error
Type: token
Path: DocumentReference.docStatus
- See Also:
- Constant Field Values
-
DOC_STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam DOC_STATUS
Fluent Client search parameter constant for doc-statusDescription: preliminary | final | amended | entered-in-error
Type: token
Path: DocumentReference.docStatus
-
SP_EVENT
public static final String SP_EVENT
Search parameter: eventDescription: Main clinical acts documented
Type: token
Path: DocumentReference.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.event
-
SP_FACILITY
public static final String SP_FACILITY
Search parameter: facilityDescription: Kind of facility where patient was seen
Type: token
Path: DocumentReference.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.facilityType
-
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_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_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_PERIOD
public static final String SP_PERIOD
Search parameter: periodDescription: Time of service that is being documented
Type: date
Path: DocumentReference.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.period
-
SP_RELATED
public static final String SP_RELATED
Search parameter: relatedDescription: Related identifiers or resources
Type: reference
Path: DocumentReference.related
- See Also:
- Constant Field Values
-
RELATED
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RELATED
Fluent Client search parameter constant for relatedDescription: Related identifiers or resources
Type: reference
Path: DocumentReference.related
-
INCLUDE_RELATED
public static final ca.uhn.fhir.model.api.Include INCLUDE_RELATED
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:related".
-
SP_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_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_RELATIONSHIP
public static final String SP_RELATIONSHIP
Search parameter: relationshipDescription: Combination of relation and relatesTo
Type: composite
Path: DocumentReference.relatesTo
- 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: DocumentReference.relatesTo
-
SP_SECURITY_LABEL
public static final String SP_SECURITY_LABEL
Search parameter: security-labelDescription: Document security-tags
Type: token
Path: DocumentReference.securityLabel
- See Also:
- Constant Field Values
-
SECURITY_LABEL
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SECURITY_LABEL
Fluent Client search parameter constant for security-labelDescription: 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.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.practiceSetting
-
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_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: Multiple Resources: [Composition](composition.html): Context of the Composition [DeviceRequest](devicerequest.html): Encounter during which request was created [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made [DocumentReference](documentreference.html): Context of the document content [Flag](flag.html): Alert relevant during encounter [List](list.html): Context in which list created [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier [Observation](observation.html): Encounter related to the observation [Procedure](procedure.html): The Encounter during which this Procedure was created [RiskAssessment](riskassessment.html): Where was assessment performed? [ServiceRequest](servicerequest.html): An encounter in which this request is made [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier
Type: reference
Path: Composition.encounter | DeviceRequest.encounter | DiagnosticReport.encounter | DocumentReference.encounter | Flag.encounter | List.encounter | NutritionOrder.encounter | Observation.encounter | Procedure.encounter | RiskAssessment.encounter | ServiceRequest.encounter | VisionPrescription.encounter
- See Also:
- Constant Field Values
-
ENCOUNTER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER
Fluent Client search parameter constant for encounterDescription: Multiple Resources: [Composition](composition.html): Context of the Composition [DeviceRequest](devicerequest.html): Encounter during which request was created [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made [DocumentReference](documentreference.html): Context of the document content [Flag](flag.html): Alert relevant during encounter [List](list.html): Context in which list created [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier [Observation](observation.html): Encounter related to the observation [Procedure](procedure.html): The Encounter during which this Procedure was created [RiskAssessment](riskassessment.html): Where was assessment performed? [ServiceRequest](servicerequest.html): An encounter in which this request is made [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier
Type: reference
Path: Composition.encounter | DeviceRequest.encounter | DiagnosticReport.encounter | DocumentReference.encounter | Flag.encounter | List.encounter | NutritionOrder.encounter | Observation.encounter | Procedure.encounter | RiskAssessment.encounter | ServiceRequest.encounter | VisionPrescription.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_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): External ids for this item [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Goal](goal.html): External Ids for this goal [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [List](list.html): Business identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationUsage](medicationusage.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Procedure](procedure.html): A unique identifier for a procedure [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: AllergyIntolerance.identifier | CarePlan.identifier | CareTeam.identifier | Composition.identifier | Condition.identifier | Consent.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DiagnosticReport.identifier | DocumentManifest.masterIdentifier | DocumentManifest.identifier | DocumentReference.content.identifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationUsage.identifier | NutritionOrder.identifier | Observation.identifier | Procedure.identifier | RiskAssessment.identifier | ServiceRequest.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | VisionPrescription.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): External ids for this item [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Goal](goal.html): External Ids for this goal [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [List](list.html): Business identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationUsage](medicationusage.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Procedure](procedure.html): A unique identifier for a procedure [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: AllergyIntolerance.identifier | CarePlan.identifier | CareTeam.identifier | Composition.identifier | Condition.identifier | Consent.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DiagnosticReport.identifier | DocumentManifest.masterIdentifier | DocumentManifest.identifier | DocumentReference.content.identifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationUsage.identifier | NutritionOrder.identifier | Observation.identifier | Procedure.identifier | RiskAssessment.identifier | ServiceRequest.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | VisionPrescription.identifier
-
SP_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient assessed [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationUsage](medicationusage.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | DetectedIssue.patient | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationUsage.subject.where(resolve() is Patient) | NutritionOrder.patient | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.patient | VisionPrescription.patient
- See Also:
- Constant Field Values
-
PATIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Fluent Client search parameter constant for patientDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient assessed [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationUsage](medicationusage.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | DetectedIssue.patient | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationUsage.subject.where(resolve() is Patient) | NutritionOrder.patient | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.patient | VisionPrescription.patient
-
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_TYPE
public static final String SP_TYPE
Search parameter: typeDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known) [Composition](composition.html): Kind of composition (LOINC if possible) [DocumentManifest](documentmanifest.html): Kind of document set [DocumentReference](documentreference.html): Kind of document (LOINC if possible) [Encounter](encounter.html): Specific type of encounter [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management
Type: token
Path: AllergyIntolerance.type | Composition.type | DocumentManifest.type | DocumentReference.type | Encounter.type | EpisodeOfCare.type
- See Also:
- Constant Field Values
-
TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
Fluent Client search parameter constant for typeDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known) [Composition](composition.html): Kind of composition (LOINC if possible) [DocumentManifest](documentmanifest.html): Kind of document set [DocumentReference](documentreference.html): Kind of document (LOINC if possible) [Encounter](encounter.html): Specific type of encounter [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management
Type: token
Path: AllergyIntolerance.type | Composition.type | DocumentManifest.type | DocumentReference.type | Encounter.type | EpisodeOfCare.type
-
-
Constructor Detail
-
DocumentReference
public DocumentReference()
Constructor
-
DocumentReference
public DocumentReference(Enumerations.DocumentReferenceStatus status, DocumentReference.DocumentReferenceContentComponent content)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(Other identifiers associated with the document, including version independent identifiers.)
-
setIdentifier
public DocumentReference setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public DocumentReference addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist {3}
-
getBasedOn
public List<Reference> getBasedOn()
- Returns:
basedOn(A procedure that is fulfilled in whole or in part by the creation of this media.)
-
setBasedOn
public DocumentReference setBasedOn(List<Reference> theBasedOn)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasBasedOn
public boolean hasBasedOn()
-
addBasedOn
public Reference addBasedOn()
-
addBasedOn
public DocumentReference addBasedOn(Reference t)
-
getBasedOnFirstRep
public Reference getBasedOnFirstRep()
- Returns:
- The first repetition of repeating field
basedOn, creating it if it does not already exist {3}
-
getStatusElement
public Enumeration<Enumerations.DocumentReferenceStatus> getStatusElement()
- Returns:
status(The status of this document reference.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
public boolean hasStatusElement()
-
hasStatus
public boolean hasStatus()
-
setStatusElement
public DocumentReference setStatusElement(Enumeration<Enumerations.DocumentReferenceStatus> value)
- Parameters:
value-status(The status of this document reference.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public Enumerations.DocumentReferenceStatus getStatus()
- Returns:
- The status of this document reference.
-
setStatus
public DocumentReference setStatus(Enumerations.DocumentReferenceStatus value)
- Parameters:
value- The status of this document reference.
-
getDocStatusElement
public Enumeration<Enumerations.CompositionStatus> getDocStatusElement()
- Returns:
docStatus(The status of the underlying document.). This is the underlying object with id, value and extensions. The accessor "getDocStatus" gives direct access to the value
-
hasDocStatusElement
public boolean hasDocStatusElement()
-
hasDocStatus
public boolean hasDocStatus()
-
setDocStatusElement
public DocumentReference setDocStatusElement(Enumeration<Enumerations.CompositionStatus> value)
- Parameters:
value-docStatus(The status of the underlying document.). This is the underlying object with id, value and extensions. The accessor "getDocStatus" gives direct access to the value
-
getDocStatus
public Enumerations.CompositionStatus getDocStatus()
- Returns:
- The status of the underlying document.
-
setDocStatus
public DocumentReference setDocStatus(Enumerations.CompositionStatus value)
- Parameters:
value- The status of the underlying document.
-
getType
public CodeableConcept getType()
- Returns:
type(Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.)
-
hasType
public boolean hasType()
-
setType
public DocumentReference setType(CodeableConcept value)
- Parameters:
value-type(Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.)
-
getCategory
public List<CodeableConcept> getCategory()
- Returns:
category(A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.)
-
setCategory
public DocumentReference setCategory(List<CodeableConcept> theCategory)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCategory
public boolean hasCategory()
-
addCategory
public CodeableConcept addCategory()
-
addCategory
public DocumentReference addCategory(CodeableConcept t)
-
getCategoryFirstRep
public CodeableConcept getCategoryFirstRep()
- Returns:
- The first repetition of repeating field
category, creating it if it does not already exist {3}
-
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).)
-
getEncounter
public List<Reference> getEncounter()
- Returns:
encounter(Describes the clinical encounter or type of care that the document content is associated with.)
-
setEncounter
public DocumentReference setEncounter(List<Reference> theEncounter)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEncounter
public boolean hasEncounter()
-
addEncounter
public Reference addEncounter()
-
addEncounter
public DocumentReference addEncounter(Reference t)
-
getEncounterFirstRep
public Reference getEncounterFirstRep()
- Returns:
- The first repetition of repeating field
encounter, creating it if it does not already exist {3}
-
getEvent
public List<CodeableConcept> getEvent()
- Returns:
event(This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.)
-
setEvent
public DocumentReference setEvent(List<CodeableConcept> theEvent)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEvent
public boolean hasEvent()
-
addEvent
public CodeableConcept addEvent()
-
addEvent
public DocumentReference addEvent(CodeableConcept t)
-
getEventFirstRep
public CodeableConcept getEventFirstRep()
- Returns:
- The first repetition of repeating field
event, creating it if it does not already exist {3}
-
getFacilityType
public CodeableConcept getFacilityType()
- Returns:
facilityType(The kind of facility where the patient was seen.)
-
hasFacilityType
public boolean hasFacilityType()
-
setFacilityType
public DocumentReference setFacilityType(CodeableConcept value)
- Parameters:
value-facilityType(The kind of facility where the patient was seen.)
-
getPracticeSetting
public CodeableConcept getPracticeSetting()
- Returns:
practiceSetting(This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.)
-
hasPracticeSetting
public boolean hasPracticeSetting()
-
setPracticeSetting
public DocumentReference setPracticeSetting(CodeableConcept value)
- Parameters:
value-practiceSetting(This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.)
-
getPeriod
public Period getPeriod()
- Returns:
period(The time period over which the service that is described by the document was provided.)
-
hasPeriod
public boolean hasPeriod()
-
setPeriod
public DocumentReference setPeriod(Period value)
- Parameters:
value-period(The time period over which the service that is described by the document was provided.)
-
getDateElement
public InstantType getDateElement()
- Returns:
date(When the document reference was created.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
hasDateElement
public boolean hasDateElement()
-
hasDate
public boolean hasDate()
-
setDateElement
public DocumentReference setDateElement(InstantType value)
- Parameters:
value-date(When the document reference was created.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
setDate
public DocumentReference setDate(Date value)
- Parameters:
value- When the document reference was created.
-
getAuthor
public List<Reference> getAuthor()
- Returns:
author(Identifies who is responsible for adding the information to the document.)
-
setAuthor
public DocumentReference setAuthor(List<Reference> theAuthor)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAuthor
public boolean hasAuthor()
-
addAuthor
public DocumentReference addAuthor(Reference t)
-
getAuthorFirstRep
public Reference getAuthorFirstRep()
- Returns:
- The first repetition of repeating field
author, creating it if it does not already exist {3}
-
getAttester
public List<DocumentReference.DocumentReferenceAttesterComponent> getAttester()
- Returns:
attester(A participant who has attested to the accuracy of the composition/document.)
-
setAttester
public DocumentReference setAttester(List<DocumentReference.DocumentReferenceAttesterComponent> theAttester)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAttester
public boolean hasAttester()
-
addAttester
public DocumentReference.DocumentReferenceAttesterComponent addAttester()
-
addAttester
public DocumentReference addAttester(DocumentReference.DocumentReferenceAttesterComponent t)
-
getAttesterFirstRep
public DocumentReference.DocumentReferenceAttesterComponent getAttesterFirstRep()
- Returns:
- The first repetition of repeating field
attester, creating it if it does not already exist {3}
-
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.)
-
getRelatesTo
public List<DocumentReference.DocumentReferenceRelatesToComponent> getRelatesTo()
- Returns:
relatesTo(Relationships that this document has with other document references that already exist.)
-
setRelatesTo
public DocumentReference setRelatesTo(List<DocumentReference.DocumentReferenceRelatesToComponent> theRelatesTo)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasRelatesTo
public boolean hasRelatesTo()
-
addRelatesTo
public DocumentReference.DocumentReferenceRelatesToComponent addRelatesTo()
-
addRelatesTo
public DocumentReference addRelatesTo(DocumentReference.DocumentReferenceRelatesToComponent t)
-
getRelatesToFirstRep
public DocumentReference.DocumentReferenceRelatesToComponent getRelatesToFirstRep()
- Returns:
- The first repetition of repeating field
relatesTo, creating it if it does not already exist {3}
-
getDescriptionElement
public MarkdownType getDescriptionElement()
- Returns:
description(Human-readable description of the source document.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
public boolean hasDescriptionElement()
-
hasDescription
public boolean hasDescription()
-
setDescriptionElement
public DocumentReference setDescriptionElement(MarkdownType value)
- Parameters:
value-description(Human-readable description of the source document.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
public String getDescription()
- Returns:
- Human-readable description of the source document.
-
setDescription
public DocumentReference setDescription(String value)
- Parameters:
value- Human-readable description of the source document.
-
getSecurityLabel
public List<CodeableConcept> getSecurityLabel()
- Returns:
securityLabel(A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.)
-
setSecurityLabel
public DocumentReference setSecurityLabel(List<CodeableConcept> theSecurityLabel)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSecurityLabel
public boolean hasSecurityLabel()
-
addSecurityLabel
public CodeableConcept addSecurityLabel()
-
addSecurityLabel
public DocumentReference addSecurityLabel(CodeableConcept t)
-
getSecurityLabelFirstRep
public CodeableConcept getSecurityLabelFirstRep()
- Returns:
- The first repetition of repeating field
securityLabel, creating it if it does not already exist {3}
-
getContent
public List<DocumentReference.DocumentReferenceContentComponent> getContent()
- Returns:
content(The document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadata.)
-
setContent
public DocumentReference setContent(List<DocumentReference.DocumentReferenceContentComponent> theContent)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContent
public boolean hasContent()
-
addContent
public DocumentReference.DocumentReferenceContentComponent addContent()
-
addContent
public DocumentReference addContent(DocumentReference.DocumentReferenceContentComponent t)
-
getContentFirstRep
public DocumentReference.DocumentReferenceContentComponent getContentFirstRep()
- Returns:
- The first repetition of repeating field
content, creating it if it does not already exist {3}
-
getSourcePatientInfo
public Reference getSourcePatientInfo()
- Returns:
sourcePatientInfo(The Patient Information as known when the document was published. May be a reference to a version specific, or contained.)
-
hasSourcePatientInfo
public boolean hasSourcePatientInfo()
-
setSourcePatientInfo
public DocumentReference setSourcePatientInfo(Reference value)
- Parameters:
value-sourcePatientInfo(The Patient Information as known when the document was published. May be a reference to a version specific, or contained.)
-
getRelated
public List<Reference> getRelated()
- Returns:
related(Related identifiers or resources associated with the DocumentReference.)
-
setRelated
public DocumentReference setRelated(List<Reference> theRelated)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasRelated
public boolean hasRelated()
-
addRelated
public Reference addRelated()
-
addRelated
public DocumentReference addRelated(Reference t)
-
getRelatedFirstRep
public Reference getRelatedFirstRep()
- Returns:
- The first repetition of repeating field
related, creating it if it does not already exist {3}
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
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 Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base 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
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- 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
-
copyValues
public void copyValues(DocumentReference dst)
-
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
-
-