Class DocumentReference

A reference to a document .

Inheritance
System.Object
Resource
DomainResource
DocumentReference
Implements
Inherited Members
Namespace: fhirCsR2.Models
Assembly: fhirCsR2.dll
Syntax
public class DocumentReference : DomainResource, IFhirJsonSerializable

Properties

| Improve this Doc View Source

_Created

Extension container element for Created

Declaration
public Element _Created { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Description

Extension container element for Description

Declaration
public Element _Description { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Indexed

Extension container element for Indexed

Declaration
public Element _Indexed { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Status

Extension container element for Status

Declaration
public Element _Status { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

Authenticator

Which person or organization authenticates that this document is valid.

Declaration
public Reference Authenticator { get; set; }
Property Value
Type Description
Reference
| Improve this Doc View Source

Author

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

Declaration
public List<Reference> Author { get; set; }
Property Value
Type Description
fhirCsR2.Models.List<Reference>
| Improve this Doc View Source

Class

Helps humans to assess whether the document is of interest when viewing a list of documents.

Declaration
public CodeableConcept Class { get; set; }
Property Value
Type Description
CodeableConcept
| Improve this Doc View Source

Content

The document and format referenced. There may be multiple content element repetitions, each with a different format.

Declaration
public List<DocumentReferenceContent> Content { get; set; }
Property Value
Type Description
fhirCsR2.Models.List<DocumentReferenceContent>
| Improve this Doc View Source

Context

The clinical context in which the document was prepared.

Declaration
public DocumentReferenceContext Context { get; set; }
Property Value
Type Description
DocumentReferenceContext
| Improve this Doc View Source

Created

When the document was created.

Declaration
public string Created { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Custodian

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

Declaration
public Reference Custodian { get; set; }
Property Value
Type Description
Reference
| Improve this Doc View Source

Description

Helps humans to assess whether the document is of interest.

Declaration
public string Description { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

DocStatus

The status of the underlying document.

Declaration
public CodeableConcept DocStatus { get; set; }
Property Value
Type Description
CodeableConcept
| Improve this Doc View Source

Identifier

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

Declaration
public List<Identifier> Identifier { get; set; }
Property Value
Type Description
fhirCsR2.Models.List<Identifier>
| Improve this Doc View Source

Indexed

When the document reference was created.

Declaration
public string Indexed { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

MasterIdentifier

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

Declaration
public Identifier MasterIdentifier { get; set; }
Property Value
Type Description
Identifier
| Improve this Doc View Source

RelatesTo

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

Declaration
public List<DocumentReferenceRelatesTo> RelatesTo { get; set; }
Property Value
Type Description
fhirCsR2.Models.List<DocumentReferenceRelatesTo>
| Improve this Doc View Source

ResourceType

Resource Type Name

Declaration
public override string ResourceType { get; }
Property Value
Type Description
System.String
Overrides
| Improve this Doc View Source

SecurityLabel

Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended.

Declaration
public List<CodeableConcept> SecurityLabel { get; set; }
Property Value
Type Description
fhirCsR2.Models.List<CodeableConcept>
| Improve this Doc View Source

Status

The status of this document reference.

Declaration
public string Status { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

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

Declaration
public Reference Subject { get; set; }
Property Value
Type Description
Reference
| Improve this Doc View Source

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.

Declaration
public CodeableConcept Type { get; set; }
Property Value
Type Description
CodeableConcept

Methods

| Improve this Doc View Source

DeserializeJson(ref Utf8JsonReader, JsonSerializerOptions)

Deserialize a JSON object

Declaration
public void DeserializeJson(ref Utf8JsonReader reader, JsonSerializerOptions options)
Parameters
Type Name Description
Utf8JsonReader reader
JsonSerializerOptions options
| Improve this Doc View Source

DeserializeJsonProperty(ref Utf8JsonReader, JsonSerializerOptions, String)

Deserialize a JSON property

Declaration
public void DeserializeJsonProperty(ref Utf8JsonReader reader, JsonSerializerOptions options, string propertyName)
Parameters
Type Name Description
Utf8JsonReader reader
JsonSerializerOptions options
System.String propertyName
| Improve this Doc View Source

SerializeJson(Utf8JsonWriter, JsonSerializerOptions, Boolean)

Serialize to a JSON object

Declaration
public void SerializeJson(Utf8JsonWriter writer, JsonSerializerOptions options, bool includeStartObject = true)
Parameters
Type Name Description
Utf8JsonWriter writer
JsonSerializerOptions options
System.Boolean includeStartObject

Implements