Data Model Libraries
    Preparing search index...

    Class DocumentReference

    DocumentReference Class

    A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.

    FHIR Specification

    • Short: A reference to a document
    • Definition: A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.
    • Comment: Usually, this is used for documents other than those defined by FHIR.
    • FHIR Version: 4.3.0

    FHIR DocumentReference

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    masterIdentifier? identifier? documentReferenceStatusEnum status compositionStatusEnum docStatus? type_? category? subject? date? author? authenticator? custodian? relatesTo? description? securityLabel? content context?

    Methods

    parse getMasterIdentifier setMasterIdentifier hasMasterIdentifier getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getDocStatusEnumType setDocStatusEnumType hasDocStatusEnumType getDocStatusElement setDocStatusElement hasDocStatusElement getDocStatus setDocStatus hasDocStatus getType setType hasType getCategory setCategory addCategory hasCategory getSubject setSubject hasSubject getDateElement setDateElement hasDateElement getDate setDate hasDate getAuthor setAuthor addAuthor hasAuthor getAuthenticator setAuthenticator hasAuthenticator getCustodian setCustodian hasCustodian getRelatesTo setRelatesTo addRelatesTo hasRelatesTo getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getSecurityLabel setSecurityLabel addSecurityLabel hasSecurityLabel getContent setContent addContent hasContent getContext setContext hasContext 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 initCategory initAuthor initRelatesTo initSecurityLabel initContent

    Constructors

    Properties

    masterIdentifier?: Identifier

    DocumentReference.masterIdentifier Element

    FHIR Specification

    • Short: Master Version Specific Identifier
    • Definition: Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.
    • Comment: CDA Document Id extension and root.
    • Requirements: The structure and format of this Id shall be consistent with the specification corresponding to the formatCode attribute. (e.g. for a DICOM standard document a 64-character numeric UID, for an HL7 CDA format a serialization of the CDA Document Id extension and root in the form "oid^extension", where OID is a 64 digits max, and the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.).
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    identifier?: Identifier[]

    DocumentReference.identifier Element

    FHIR Specification

    • Short: Other identifiers for the document
    • Definition: Other identifiers associated with the document, including version independent identifiers.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    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: preliminary | final | amended | entered-in-error
    • 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

    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

    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

    authenticator?: Reference

    DocumentReference.authenticator Element

    FHIR Specification

    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?: StringType

    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: string
    • 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. 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.
    • 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. There may be multiple content element repetitions, each with a different format.
    • FHIR Type: BackboneElement
    • Cardinality: 1..*
    • isModifier: false
    • isSummary: true
    context?: DocumentReferenceContextComponent

    DocumentReference.context Element

    FHIR Specification

    • Short: Clinical context of document
    • Definition: The clinical context in which the document was prepared.
    • Comment: These values are primarily added to help with searching for interesting/relevant documents.
    • FHIR Type: BackboneElement
    • Cardinality: 0..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 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
    parsegetMasterIdentifiersetMasterIdentifierhasMasterIdentifiergetIdentifiersetIdentifieraddIdentifierhasIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetDocStatusEnumTypesetDocStatusEnumTypehasDocStatusEnumTypegetDocStatusElementsetDocStatusElementhasDocStatusElementgetDocStatussetDocStatushasDocStatusgetTypesetTypehasTypegetCategorysetCategoryaddCategoryhasCategorygetSubjectsetSubjecthasSubjectgetDateElementsetDateElementhasDateElementgetDatesetDatehasDategetAuthorsetAuthoraddAuthorhasAuthorgetAuthenticatorsetAuthenticatorhasAuthenticatorgetCustodiansetCustodianhasCustodiangetRelatesTosetRelatesToaddRelatesTohasRelatesTogetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetSecurityLabelsetSecurityLabeladdSecurityLabelhasSecurityLabelgetContentsetContentaddContenthasContentgetContextsetContexthasContextfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitCategoryinitAuthorinitRelatesToinitSecurityLabelinitContent