Data Model Libraries
    Preparing search index...

    Class DocumentReference

    DocumentReference Class

    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.

    FHIR Specification

    • Short: A reference to a document
    • Definition: 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.
    • Comment: Usually, this is used for documents other than those defined by FHIR.
    • FHIR Version: 5.0.0

    FHIR DocumentReference

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? version? basedOn? documentReferenceStatusEnum status compositionStatusEnum docStatus? modality? type_? category? subject? context? event? bodySite? facilityType? practiceSetting? period? date? author? attester? custodian? relatesTo? description? securityLabel? content

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getVersionElement setVersionElement hasVersionElement getVersion setVersion hasVersion getBasedOn setBasedOn addBasedOn hasBasedOn getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getDocStatusEnumType setDocStatusEnumType hasDocStatusEnumType getDocStatusElement setDocStatusElement hasDocStatusElement getDocStatus setDocStatus hasDocStatus getModality setModality addModality hasModality getType setType hasType getCategory setCategory addCategory hasCategory getSubject setSubject hasSubject getContext setContext addContext hasContext getEvent setEvent addEvent hasEvent getBodySite setBodySite addBodySite hasBodySite getFacilityType setFacilityType hasFacilityType getPracticeSetting setPracticeSetting hasPracticeSetting getPeriod setPeriod hasPeriod getDateElement setDateElement hasDateElement getDate setDate hasDate getAuthor setAuthor addAuthor hasAuthor getAttester setAttester addAttester hasAttester getCustodian setCustodian hasCustodian getRelatesTo setRelatesTo addRelatesTo hasRelatesTo getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getSecurityLabel setSecurityLabel addSecurityLabel hasSecurityLabel getContent setContent addContent hasContent fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initBasedOn initModality initCategory initContext initEvent initBodySite initAuthor initAttester initRelatesTo initSecurityLabel initContent

    Constructors

    Properties

    identifier?: Identifier[]

    DocumentReference.identifier Element

    FHIR Specification

    • Short: Business identifiers for the document
    • Definition: Other business identifiers associated with the document, including version independent identifiers.
    • Comment: The structure and format of this identifier would be consistent with the specification corresponding to the format of the document. (e.g. for a DICOM standard document, a 64-character numeric UID; for an HL7 CDA format, the CDA Document Id root and extension).
    • Requirements: Document identifiers usually assigned by the source of the document, or other business identifiers such as XDS DocumentEntry.uniqueId and DocumentEntry.entryUUID. These identifiers are specific to this instance of the document.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    version?: StringType

    DocumentReference.version Element

    FHIR Specification

    • Short: An explicitly assigned identifer of a variation of the content in the DocumentReference
    • Definition: An explicitly assigned identifer of a variation of the content in the DocumentReference.
    • Comment: While each resource, including the DocumentReference itself, has its own version identifier, this is a formal identifier for the logical version of the DocumentReference as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    basedOn?: Reference[]

    DocumentReference.basedOn Element

    FHIR Specification

    documentReferenceStatusEnum: DocumentReferenceStatusEnum

    FHIR CodeSystem: DocumentReferenceStatus

    DocumentReferenceStatusEnum

    status: null | EnumCodeType

    DocumentReference.status Element

    FHIR Specification

    • Short: current | superseded | entered-in-error
    • Definition: The status of this document reference.
    • Comment: This is the status of the DocumentReference object, which might be independent from the docStatus element. This element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: DocumentReferenceStatusEnum

    compositionStatusEnum: CompositionStatusEnum

    FHIR CodeSystem: CompositionStatus

    CompositionStatusEnum

    docStatus?: EnumCodeType

    DocumentReference.docStatus Element

    FHIR Specification

    • Short: registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
    • Definition: The status of the underlying document.
    • Comment: The document that is pointed to might be in various lifecycle states.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: CompositionStatusEnum

    modality?: CodeableConcept[]

    DocumentReference.modality Element

    FHIR Specification

    • Short: Imaging modality used
    • Definition: Imaging modality used. This may include both acquisition and non-acquisition modalities.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Private Optionaltype_

    type_?: CodeableConcept

    DocumentReference.type Element

    FHIR Specification

    • Short: Kind of document (LOINC if possible)
    • Definition: 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.
    • Comment: Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    category?: CodeableConcept[]

    DocumentReference.category Element

    FHIR Specification

    • Short: Categorization of document
    • Definition: 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.
    • Comment: Key metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    subject?: Reference

    DocumentReference.subject Element

    FHIR Specification

    • Short: Who/what is the subject of the document
    • Definition: 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).
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    context?: Reference[]

    DocumentReference.context Element

    FHIR Specification

    event?: CodeableReference[]

    DocumentReference.event Element

    FHIR Specification

    • Short: Main clinical acts documented
    • Definition: 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.
    • Comment: An event can further specialize the act inherent in the type, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation.
    • FHIR Type: CodeableReference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    bodySite?: CodeableReference[]

    DocumentReference.bodySite Element

    FHIR Specification

    facilityType?: CodeableConcept

    DocumentReference.facilityType Element

    FHIR Specification

    • Short: Kind of facility where patient was seen
    • Definition: The kind of facility where the patient was seen.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    practiceSetting?: CodeableConcept

    DocumentReference.practiceSetting Element

    FHIR Specification

    • Short: Additional details about where the content was created (e.g. clinical specialty)
    • Definition: This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.
    • Comment: This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC.
    • Requirements: This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    period?: Period

    DocumentReference.period Element

    FHIR Specification

    • Short: Time of service that is being documented
    • Definition: The time period over which the service that is described by the document was provided.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    date?: InstantType

    DocumentReference.date Element

    FHIR Specification

    • Short: When this document reference was created
    • Definition: When the document reference was created.
    • Comment: Referencing/indexing time is used for tracking, organizing versions and searching.
    • FHIR Type: instant
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    author?: Reference[]

    DocumentReference.author Element

    FHIR Specification

    attester?: DocumentReferenceAttesterComponent[]

    DocumentReference.attester Element

    FHIR Specification

    • Short: Attests to accuracy of the document
    • Definition: A participant who has authenticated the accuracy of the document.
    • Comment: Only list each attester once.
    • Requirements: Identifies responsibility for the accuracy of the document content.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    custodian?: Reference

    DocumentReference.custodian Element

    FHIR Specification

    • Short: Organization which maintains the document
    • Definition: Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.
    • Comment: Identifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    relatesTo?: DocumentReferenceRelatesToComponent[]

    DocumentReference.relatesTo Element

    FHIR Specification

    • Short: Relationships to other documents
    • Definition: Relationships that this document has with other document references that already exist.
    • Comment: This element is labeled as a modifier because documents that append to other documents are incomplete on their own.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    description?: MarkdownType

    DocumentReference.description Element

    FHIR Specification

    • Short: Human-readable description
    • Definition: Human-readable description of the source document.
    • Comment: What the document is about, a terse summary of the document.
    • Requirements: Helps humans to assess whether the document is of interest.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    securityLabel?: CodeableConcept[]

    DocumentReference.securityLabel Element

    FHIR Specification

    • Short: Document security-tags
    • Definition: A set of Security-Tag codes specifying the level of privacy/security of the Document found at DocumentReference.content.attachment.url. Note that DocumentReference.meta.security contains the security labels of the data elements in DocumentReference, while DocumentReference.securityLabel contains the security labels for the document the reference refers to. The distinction recognizes that the document may contain sensitive information, while the DocumentReference is metadata about the document and thus might not be as sensitive as the document. For example: a psychotherapy episode may contain highly sensitive information, while the metadata may simply indicate that some episode happened.
    • Comment: The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce. In the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects.
    • Requirements: Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Privatecontent

    content: null | DocumentReferenceContentComponent[]

    DocumentReference.content Element

    FHIR Specification

    • Short: Document referenced
    • Definition: 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.
    • Comment: content element shall not contain different versions of the same content. For version handling use multiple DocumentReference with .relatesTo.
    • Requirements: Note that .relatesTo may also include references to other DocumentReference with a transforms relationship to represent the same document in multiple formats.
    • FHIR Type: BackboneElement
    • Cardinality: 1..*
    • isModifier: false
    • isSummary: true

    Methods

    • Parse the provided DocumentReference JSON to instantiate the DocumentReference data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR DocumentReference

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to DocumentReference

      Returns undefined | DocumentReference

      DocumentReference data model or undefined for DocumentReference

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the basedOn property.

      Parameters

      • value: undefined | Reference[]

        the basedOn array value

      Returns this

      this

      @ReferenceTargets('DocumentReference.basedOn', ['Appointment','AppointmentResponse','CarePlan','Claim','CommunicationRequest','Contract','CoverageEligibilityRequest','DeviceRequest','EnrollmentRequest','ImmunizationRecommendation','MedicationRequest','NutritionOrder','RequestOrchestration','ServiceRequest','SupplyRequest','VisionPrescription',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the basedOn array property.

      Parameters

      • value: undefined | Reference

        the basedOn value

      Returns this

      this

      @ReferenceTargets('DocumentReference.basedOn', ['Appointment','AppointmentResponse','CarePlan','Claim','CommunicationRequest','Contract','CoverageEligibilityRequest','DeviceRequest','EnrollmentRequest','ImmunizationRecommendation','MedicationRequest','NutritionOrder','RequestOrchestration','ServiceRequest','SupplyRequest','VisionPrescription',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided Reference array value to the author property.

      Parameters

      • value: undefined | Reference[]

        the author array value

      Returns this

      this

      @ReferenceTargets('DocumentReference.author', ['Practitioner','PractitionerRole','Organization','Device','Patient','RelatedPerson','CareTeam',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetVersionElementsetVersionElementhasVersionElementgetVersionsetVersionhasVersiongetBasedOnsetBasedOnaddBasedOnhasBasedOngetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetDocStatusEnumTypesetDocStatusEnumTypehasDocStatusEnumTypegetDocStatusElementsetDocStatusElementhasDocStatusElementgetDocStatussetDocStatushasDocStatusgetModalitysetModalityaddModalityhasModalitygetTypesetTypehasTypegetCategorysetCategoryaddCategoryhasCategorygetSubjectsetSubjecthasSubjectgetContextsetContextaddContexthasContextgetEventsetEventaddEventhasEventgetBodySitesetBodySiteaddBodySitehasBodySitegetFacilityTypesetFacilityTypehasFacilityTypegetPracticeSettingsetPracticeSettinghasPracticeSettinggetPeriodsetPeriodhasPeriodgetDateElementsetDateElementhasDateElementgetDatesetDatehasDategetAuthorsetAuthoraddAuthorhasAuthorgetAttestersetAttesteraddAttesterhasAttestergetCustodiansetCustodianhasCustodiangetRelatesTosetRelatesToaddRelatesTohasRelatesTogetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetSecurityLabelsetSecurityLabeladdSecurityLabelhasSecurityLabelgetContentsetContentaddContenthasContentfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitBasedOninitModalityinitCategoryinitContextinitEventinitBodySiteinitAuthorinitAttesterinitRelatesToinitSecurityLabelinitContent