Besa Fhir Help File

Getting Started

Units

Class Hierarchy

Classes, Interfaces, Objects and Records

Types

Variables

Constants

Functions and Procedures

Identifiers

Class TDocumentReference

Description
Hierarchy
Fields
Methods
Properties

Unit

bsFhir_r5

Declaration

type TDocumentReference = class(TDomainResource)

Description

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. If the element is present, it must have either a @value, an @id, or extensions

Hierarchy

Overview

Methods

Public constructor Create; override;

Properties

Public property identifier : TIdentifierArray read GetidentifierArray;
Public property version : string read Getversion write Setversion;
Public property versionElement : Tstring read GetversionElement write SetversionElement;
Public property basedOn : TReferenceArray read GetbasedOnArray;
Public property status : string read Getstatus write Setstatus;
Public property statusElement : TDocumentReferenceStatus read GetstatusElement write SetstatusElement;
Public property docStatus : string read GetdocStatus write SetdocStatus;
Public property docStatusElement : TCompositionStatus read GetdocStatusElement write SetdocStatusElement;
Public property modality : TCodeableConceptArray read GetmodalityArray;
Public property type_ : TCodeableConcept read Gettype_ write Settype_;
Public property category : TCodeableConceptArray read GetcategoryArray;
Public property subject : TReference read Getsubject write Setsubject;
Public property context : TReferenceArray read GetcontextArray;
Public property event : TCodeableReferenceArray read GeteventArray;
Public property bodySite : TCodeableReferenceArray read GetbodySiteArray;
Public property facilityType : TCodeableConcept read GetfacilityType write SetfacilityType;
Public property practiceSetting : TCodeableConcept read GetpracticeSetting write SetpracticeSetting;
Public property period : TPeriod read Getperiod write Setperiod;
Public property date_ : string read Getdate_ write Setdate_;
Public property date_Element : Tinstant read Getdate_Element write Setdate_Element;
Public property author : TReferenceArray read GetauthorArray;
Public property attester : TDocumentReferenceAttesterArray read GetattesterArray;
Public property custodian : TReference read Getcustodian write Setcustodian;
Public property relatesTo : TDocumentReferenceRelatesToArray read GetrelatesToArray;
Public property description : string read Getdescription write Setdescription;
Public property descriptionElement : Tmarkdown read GetdescriptionElement write SetdescriptionElement;
Public property securityLabel : TCodeableConceptArray read GetsecurityLabelArray;
Public property content : TDocumentReferenceContentArray read GetcontentArray;

Description

Methods

Public constructor Create; override;
 

Properties

Public property identifier : TIdentifierArray read GetidentifierArray;

Other business identifiers associated with the document, including version independent identifiers.

Public property version : string read Getversion write Setversion;

An explicitly assigned identifer of a variation of the content in the DocumentReference.

Public property versionElement : Tstring read GetversionElement write SetversionElement;
 
Public property basedOn : TReferenceArray read GetbasedOnArray;

A procedure that is fulfilled in whole or in part by the creation of this media.

Public property status : string read Getstatus write Setstatus;

The status of this document reference.

Public property statusElement : TDocumentReferenceStatus read GetstatusElement write SetstatusElement;
 
Public property docStatus : string read GetdocStatus write SetdocStatus;

The status of the underlying document.

Public property docStatusElement : TCompositionStatus read GetdocStatusElement write SetdocStatusElement;
 
Public property modality : TCodeableConceptArray read GetmodalityArray;

Imaging modality used. This may include both acquisition and non-acquisition modalities.

Public property type_ : TCodeableConcept read Gettype_ write Settype_;

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.

Public property category : TCodeableConceptArray read GetcategoryArray;

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.

Public property subject : TReference read Getsubject write Setsubject;

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).

Public property context : TReferenceArray read GetcontextArray;

Describes the clinical encounter or type of care that the document content is associated with.

Public property event : TCodeableReferenceArray read GeteventArray;

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.

Public property bodySite : TCodeableReferenceArray read GetbodySiteArray;

The anatomic structures included in the document.

Public property facilityType : TCodeableConcept read GetfacilityType write SetfacilityType;

The kind of facility where the patient was seen.

Public property practiceSetting : TCodeableConcept read GetpracticeSetting write SetpracticeSetting;

This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.

Public property period : TPeriod read Getperiod write Setperiod;

The time period over which the service that is described by the document was provided.

Public property date_ : string read Getdate_ write Setdate_;

When the document reference was created.

Public property date_Element : Tinstant read Getdate_Element write Setdate_Element;
 
Public property author : TReferenceArray read GetauthorArray;

Identifies who is responsible for adding the information to the document.

Public property attester : TDocumentReferenceAttesterArray read GetattesterArray;

A participant who has authenticated the accuracy of the document.

Public property custodian : TReference read Getcustodian write Setcustodian;

Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.

Public property relatesTo : TDocumentReferenceRelatesToArray read GetrelatesToArray;

Relationships that this document has with other document references that already exist.

Public property description : string read Getdescription write Setdescription;

Human-readable description of the source document.

Public property descriptionElement : Tmarkdown read GetdescriptionElement write SetdescriptionElement;
 
Public property securityLabel : TCodeableConceptArray read GetsecurityLabelArray;

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.

Public property content : TDocumentReferenceContentArray read GetcontentArray;

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.

Generated by PasDoc 0.15.0.