DocumentReference class
DocumentReference A reference to a document of any kind for any
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
DocumentReference({@Default(R4ResourceType.DocumentReference) @JsonKey(unknownEnumValue: R4ResourceType.DocumentReference) R4ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') String? 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, Identifier? masterIdentifier, List<Identifier> ? identifier, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, FhirCode? docStatus, @JsonKey(name: '_docStatus') Element? docStatusElement, CodeableConcept? type, List<CodeableConcept> ? category, Reference? subject, FhirInstant? date, @JsonKey(name: '_date') Element? dateElement, List<Reference> ? author, Reference? authenticator, Reference? custodian, List<DocumentReferenceRelatesTo> ? relatesTo, String? description, @JsonKey(name: '_description') Element? descriptionElement, List<CodeableConcept> ? securityLabel, required List<DocumentReferenceContent> content, DocumentReferenceContext? context}) -
DocumentReference 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.
constfactory
-
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
- authenticator → Reference?
-
authenticator Which person or organization authenticates that this
document is valid.
no setterinherited
-
author Identifies who is responsible for adding the information to 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, and nor can they have their own independent transaction
scope.
no setterinherited
-
content
→ List<
DocumentReferenceContent> -
content The document and format referenced. There may be multiple
content element repetitions, each with a different format.
no setterinherited
- context → DocumentReferenceContext?
-
context The clinical context in which the document was prepared.
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 Extensions for date
no setterinherited
- dbId → int?
-
no setterinherited
- description → String?
-
description Human-readable description of the source document.
no setterinherited
- descriptionElement → Element?
-
descriptionElement Extensions for description
no setterinherited
- docStatus → FhirCode?
-
docStatus The status of the underlying document.
no setterinherited
- docStatusElement → Element?
-
docStatusElement Extensions for docStatus
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
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 manageable, 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
- fhirId → String?
-
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 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 Extensions for implicitRules
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement Extensions for language
no setterinherited
- masterIdentifier → Identifier?
-
masterIdentifier 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.
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
-
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
manageable, 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
-
relatesTo
→ List<
DocumentReferenceRelatesTo> ? -
relatesTo Relationships that this document has with other document
references that already exist.
no setterinherited
- resourceType → R4ResourceType
-
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. 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.
no setterinherited
- status → FhirCode?
-
status The status of this document reference.
no setterinherited
- statusElement → Element?
-
statusElement 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
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
inherited
-
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