Class ComprehensiveDocumentReference

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.BaseResource

org.hl7.fhir.r4.model.Resource

org.hl7.fhir.r4.model.DomainResource

org.hl7.fhir.r4.model.DocumentReference

org.openehealth.ipf.commons.ihe.fhir.mhd.model.ComprehensiveDocumentReference

All Implemented Interfaces:

IElement, Serializable, IAnyResource, IBase, IBaseHasExtensions, IBaseHasModifierExtensions, IBaseResource, IDomainResource

public class ComprehensiveDocumentReference
extends DocumentReference

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class DocumentReference

DocumentReference.DocumentReferenceContentComponent, DocumentReference.DocumentReferenceContextComponent, DocumentReference.DocumentReferenceRelatesToComponent, DocumentReference.DocumentRelationshipType, DocumentReference.DocumentRelationshipTypeEnumFactory, DocumentReference.ReferredDocumentStatus, DocumentReference.ReferredDocumentStatusEnumFactory

Field Summary

Fields inherited from class DocumentReference

authenticator, AUTHENTICATOR, authenticatorTarget, author, AUTHOR, authorTarget, category, CATEGORY, content, CONTENTTYPE, context, custodian, CUSTODIAN, custodianTarget, date, DATE, description, DESCRIPTION, docStatus, ENCOUNTER, EVENT, FACILITY, FORMAT, identifier, IDENTIFIER, INCLUDE_AUTHENTICATOR, INCLUDE_AUTHOR, INCLUDE_CUSTODIAN, INCLUDE_ENCOUNTER, INCLUDE_PATIENT, INCLUDE_RELATED, INCLUDE_RELATESTO, INCLUDE_SUBJECT, LANGUAGE, LOCATION, masterIdentifier, PATIENT, PERIOD, RELATED, relatesTo, RELATESTO, RELATION, RELATIONSHIP, SECURITY_LABEL, securityLabel, SETTING, SP_AUTHENTICATOR, SP_AUTHOR, SP_CATEGORY, SP_CONTENTTYPE, SP_CUSTODIAN, SP_DATE, SP_DESCRIPTION, SP_ENCOUNTER, SP_EVENT, SP_FACILITY, SP_FORMAT, SP_IDENTIFIER, SP_LANGUAGE, SP_LOCATION, SP_PATIENT, SP_PERIOD, SP_RELATED, SP_RELATESTO, SP_RELATION, SP_RELATIONSHIP, SP_SECURITY_LABEL, SP_SETTING, SP_STATUS, SP_SUBJECT, SP_TYPE, status, STATUS, subject, SUBJECT, subjectTarget, type, TYPE

Fields inherited from class DomainResource

contained, extension, modifierExtension, text

Fields inherited from class Resource

id, implicitRules, language, meta

Fields inherited from interface IAnyResource

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

Fields inherited from interface IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
ComprehensiveDocumentReference()

Method Summary

Modifier and Type	Method	Description
ComprehensiveDocumentReference	addAuthor(Device device)
ComprehensiveDocumentReference	addAuthor(Organization organization)
ComprehensiveDocumentReference	addAuthor(Patient patient)
ComprehensiveDocumentReference	addAuthor(Practitioner practioner)
ComprehensiveDocumentReference	addAuthor(PractitionerRole practitionerRole)
ComprehensiveDocumentReference	addAuthor(RelatedPerson relatedPerson)
ComprehensiveDocumentReference	copy()
void	copyValues(DocumentReference dst)
boolean	equalsDeep(Base other_)
Optional<Identifier>	getEntryUuidIdentifier()	Returns the EntryUuid identifier, recognized either by its type coding (MHD 4.2.4) or by its use (MHD 4.2.3 and earlier).
OidType	getHomeCommunityId()	Returns the community this DocumentReference resides in, as introduced by MHD 4.2.4 with the Target Communities Option (CP-ITI-1326-02).
Optional<Identifier>	getUniqueIdIdentifier()	Returns the Unique Id identifier, recognized either by its type coding (MHD 4.2.4) or by its use (MHD 4.2.3 and earlier).
boolean	hasHomeCommunityId()
boolean	isEmpty()
ComprehensiveDocumentReference	setAuthenticator(Organization organization)
ComprehensiveDocumentReference	setAuthenticator(Practitioner practitioner)
ComprehensiveDocumentReference	setAuthenticator(PractitionerRole practitionerRole)
ComprehensiveDocumentReference	setEntryUuidIdentifier(UUID uuid)	Adds an identifier to be a EntryUuid as required by the profile.
ComprehensiveDocumentReference	setHomeCommunityId(OidType homeCommunityId)
ComprehensiveDocumentReference	setHomeCommunityId(Oid oid)	Sets the community this DocumentReference resides in.
ComprehensiveDocumentReference	setSourcePatientInfo(Patient patient)
ComprehensiveDocumentReference	setUniqueIdIdentifier(String system, String value)	Sets the Unique Id of the referenced document.

Methods inherited from class DocumentReference

addAuthor, addAuthor, addCategory, addCategory, addChild, addContent, addContent, addIdentifier, addIdentifier, addRelatesTo, addRelatesTo, addSecurityLabel, addSecurityLabel, equalsShallow, fhirType, getAuthenticator, getAuthenticatorTarget, getAuthor, getAuthorFirstRep, getCategory, getCategoryFirstRep, getContent, getContentFirstRep, getContext, getCustodian, getCustodianTarget, getDate, getDateElement, getDescription, getDescriptionElement, getDocStatus, getDocStatusElement, getIdentifier, getIdentifierFirstRep, getMasterIdentifier, getNamedProperty, getProperty, getRelatesTo, getRelatesToFirstRep, getResourceType, getSecurityLabel, getSecurityLabelFirstRep, getStatus, getStatusElement, getSubject, getSubjectTarget, getType, getTypesForProperty, hasAuthenticator, hasAuthor, hasCategory, hasContent, hasContext, hasCustodian, hasDate, hasDateElement, hasDescription, hasDescriptionElement, hasDocStatus, hasDocStatusElement, hasIdentifier, hasMasterIdentifier, hasRelatesTo, hasSecurityLabel, hasStatus, hasStatusElement, hasSubject, hasType, listChildren, makeProperty, removeChild, setAuthenticator, setAuthenticatorTarget, setAuthor, setCategory, setContent, setContext, setCustodian, setCustodianTarget, setDate, setDateElement, setDescription, setDescriptionElement, setDocStatus, setDocStatusElement, setIdentifier, setMasterIdentifier, setProperty, setProperty, setRelatesTo, setSecurityLabel, setStatus, setStatusElement, setSubject, setSubjectTarget, setType, typedCopy

Methods inherited from class DomainResource

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

Methods inherited from class Resource

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

Methods inherited from class BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class Base

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

Methods inherited from class Object

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

Methods inherited from interface IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface IBaseResource

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Constructor Details

ComprehensiveDocumentReference

public ComprehensiveDocumentReference()

Method Details

addAuthor

public ComprehensiveDocumentReference addAuthor(Practitioner practioner)

addAuthor

public ComprehensiveDocumentReference addAuthor(Patient patient)

addAuthor

public ComprehensiveDocumentReference addAuthor(PractitionerRole practitionerRole)

addAuthor

public ComprehensiveDocumentReference addAuthor(Organization organization)

addAuthor

public ComprehensiveDocumentReference addAuthor(Device device)

addAuthor

public ComprehensiveDocumentReference addAuthor(RelatedPerson relatedPerson)

setAuthenticator

public ComprehensiveDocumentReference setAuthenticator(Practitioner practitioner)

setAuthenticator

public ComprehensiveDocumentReference setAuthenticator(PractitionerRole practitionerRole)

setAuthenticator

public ComprehensiveDocumentReference setAuthenticator(Organization organization)

setSourcePatientInfo

public ComprehensiveDocumentReference setSourcePatientInfo(Patient patient)

copy

public ComprehensiveDocumentReference copy()

Overrides:

copy in class DocumentReference

getHomeCommunityId

public OidType getHomeCommunityId()

Returns the community this DocumentReference resides in, as introduced by MHD 4.2.4 with the Target Communities Option (CP-ITI-1326-02).

Returns:

the homeCommunityId, never null

hasHomeCommunityId

public boolean hasHomeCommunityId()

setHomeCommunityId

public ComprehensiveDocumentReference setHomeCommunityId(OidType homeCommunityId)

setHomeCommunityId

public ComprehensiveDocumentReference setHomeCommunityId(Oid oid)

Sets the community this DocumentReference resides in. The OID is rendered as a URN, as the oid data type requires.

Parameters:

oid - homeCommunityId

Returns:

this object

setUniqueIdIdentifier

public ComprehensiveDocumentReference setUniqueIdIdentifier(String system,
 String value)

Sets the Unique Id of the referenced document. It is written to the MasterIdentifier and, since MHD 4.2.4 also allows for it, to the Unique Id slice of DocumentReference.identifier, where the profile requires it to carry the very same value. Both are restricted to one occurrence, so an already present Unique Id is replaced.

Parameters:

system - system value

value - identifier value

Returns:

this object

setEntryUuidIdentifier

public ComprehensiveDocumentReference setEntryUuidIdentifier(UUID uuid)

Adds an identifier to be a EntryUuid as required by the profile. Since MHD 4.2.4 this slice is restricted to one occurrence, so an already present EntryUuid identifier is replaced.

Parameters:

uuid - UUID

Returns:

this object

getEntryUuidIdentifier

public Optional<Identifier> getEntryUuidIdentifier()

Returns the EntryUuid identifier, recognized either by its type coding (MHD 4.2.4) or by its use (MHD 4.2.3 and earlier).

Returns:

the EntryUuid identifier, if present

getUniqueIdIdentifier

public Optional<Identifier> getUniqueIdIdentifier()

Returns the Unique Id identifier, recognized either by its type coding (MHD 4.2.4) or by its use (MHD 4.2.3 and earlier). Looks at DocumentReference.identifier first and falls back to the MasterIdentifier, which is where MHD primarily carries it.

Returns:

the Unique Id identifier, if present

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IBase

Overrides:

isEmpty in class DocumentReference

copyValues

public void copyValues(DocumentReference dst)

Overrides:

copyValues in class DocumentReference

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class DocumentReference