DocumentReference class

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

Mixed in types
Annotations
  • @freezed

Constructors

DocumentReference({@Default(R5ResourceType.DocumentReference) @JsonKey(unknownEnumValue: R5ResourceType.DocumentReference) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<Resource>? contained, @JsonKey(name: 'extension') List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, List<Identifier>? identifier, String? version, @JsonKey(name: '_version') Element? versionElement, List<Reference>? basedOn, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, FhirCode? docStatus, @JsonKey(name: '_docStatus') Element? docStatusElement, List<CodeableConcept>? modality, CodeableConcept? type, List<CodeableConcept>? category, Reference? subject, List<Reference>? context, List<CodeableReference>? event, List<CodeableReference>? bodySite, CodeableConcept? facilityType, CodeableConcept? practiceSetting, Period? period, FhirInstant? date, @JsonKey(name: '_date') Element? dateElement, List<Reference>? author, List<DocumentReferenceAttester>? attester, Reference? custodian, List<DocumentReferenceRelatesTo>? relatesTo, FhirMarkdown? description, @JsonKey(name: '_description') Element? descriptionElement, List<CodeableConcept>? securityLabel, required List<DocumentReferenceContent> content})
DocumentReference 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.
const
factory
DocumentReference.fromJson(Map<String, dynamic> json)
Factory constructor, accepts Map<String, dynamic> as an argument
factory
DocumentReference.fromJsonString(String source)
Acts like a constructor, returns a DocumentReference, accepts a String as an argument, mostly because I got tired of typing it out
factory
DocumentReference.fromYaml(dynamic yaml)
Factory constructor that accepts a String in YAML format as an argument
factory

Properties

attester → List<DocumentReferenceAttester>?
attester A participant who has authenticated the accuracy of the document.
no setterinherited
author → List<Reference>?
author Identifies who is responsible for adding the information to the document.
no setterinherited
basedOn → List<Reference>?
basedOn A procedure that is fulfilled in whole or in part by the creation of this media.
no setterinherited
bodySite → List<CodeableReference>?
bodySite The anatomic structures included in the document.
no setterinherited
category → List<CodeableConcept>?
category 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.
no setterinherited
contained → List<Resource>?
contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
no setterinherited
content → List<DocumentReferenceContent>
content 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.
no setterinherited
context → List<Reference>?
context Describes the clinical encounter or type of care that the document content is associated with.
no setterinherited
copyWith → $DocumentReferenceCopyWith<DocumentReference>
no setterinherited
custodian → Reference?
custodian Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.
no setterinherited
date → FhirInstant?
date When the document reference was created.
no setterinherited
dateElement → Element?
dateElement ("_date") Extensions for date
no setterinherited
dbId → int?
no setterinherited
description → FhirMarkdown?
description Human-readable description of the source document.
no setterinherited
descriptionElement → Element?
descriptionElement ("_description") Extensions for description
no setterinherited
docStatus → FhirCode?
docStatus The status of the underlying document.
no setterinherited
docStatusElement → Element?
docStatusElement ("_docStatus") Extensions for docStatus
no setterinherited
event → List<CodeableReference>?
event 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.
no setterinherited
extension_ → List<FhirExtension>?
extension_ ("extension") May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
no setterinherited
facilityType → CodeableConcept?
facilityType The kind of facility where the patient was seen.
no setterinherited
fhirId → FhirId?
id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
identifier → List<Identifier>?
identifier Other business identifiers associated with the document, including version independent identifiers.
no setterinherited
implicitRules → FhirUri?
implicitRules A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
no setterinherited
implicitRulesElement → Element?
implicitRulesElement ("_implicitRules") Extensions for implicitRules
no setterinherited
language → FhirCode?
language The base language in which the resource is written.
no setterinherited
languageElement → Element?
languageElement ("_language") Extensions for language
no setterinherited
meta → FhirMeta?
meta The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
no setterinherited
modality → List<CodeableConcept>?
modality Imaging modality used. This may include both acquisition and non-acquisition modalities.
no setterinherited
modifierExtension → List<FhirExtension>?
modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
no setterinherited
path → String
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
period → Period?
period The time period over which the service that is described by the document was provided.
no setterinherited
practiceSetting → CodeableConcept?
practiceSetting This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.
no setterinherited
relatesTo → List<DocumentReferenceRelatesTo>?
relatesTo Relationships that this document has with other document references that already exist.
no setterinherited
resourceType → R5ResourceType
resourceType This is a DocumentReference resource
no setterinherited
resourceTypeString → String?
produce a string of the resourceType
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityLabel → List<CodeableConcept>?
securityLabel 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.
no setterinherited
status → FhirCode?
status The status of this document reference.
no setterinherited
statusElement → Element?
statusElement ("_status") Extensions for status
no setterinherited
subject → Reference?
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).
no setterinherited
text → Narrative?
text A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
no setterinherited
thisReference → Reference
Convenience method to return a Reference referring to that Resource
no setterinherited
type → CodeableConcept?
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.
no setterinherited
version → String?
version An explicitly assigned identifer of a variation of the content in the DocumentReference.
no setterinherited
versionElement → Element?
versionElement ("_version") Extensions for version
no setterinherited

Methods

newId() → Resource
returns the same resource with a new ID (even if there is already an ID present)
inherited
newIdIfNoId() → Resource
returns the same resource with a new ID if there is no current ID
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDbJson() → Map<String, dynamic>
The normal toJson ignores the dbId, and produces the fhirId as the id However, if you're going to use this as a database entry, you have to switch those two ids
inherited
toJson() → Map<String, dynamic>
inherited
toJsonString() → String
Another convenience method because more and more I'm transmitting FHIR data as a String and not a Map
override
toString() → String
A string representation of this object.
inherited
toYaml() → String
Produces a Yaml formatted String version of the object
override
updateVersion({FhirMeta? oldMeta}) → Resource
Updates the meta field of this Resource, updates the meta.lastUpdated field, adds 1 to the version number
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited