DocumentManifest class

DocumentManifest A collection of documents compiled for a purpose

Mixed in types
Annotations
  • @freezed

Constructors

DocumentManifest({@Default(R4ResourceType.DocumentManifest) @JsonKey(unknownEnumValue: R4ResourceType.DocumentManifest) 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, CodeableConcept? type, Reference? subject, FhirDateTime? created, @JsonKey(name: '_created') Element? createdElement, List<Reference>? author, List<Reference>? recipient, FhirUri? source, @JsonKey(name: '_source') Element? sourceElement, String? description, @JsonKey(name: '_description') Element? descriptionElement, required List<Reference> content, List<DocumentManifestRelated>? related})
DocumentManifest A collection of documents compiled for a purpose together with metadata that applies to the collection.
const
factory
DocumentManifest.fromJson(Map<String, dynamic> json)
Factory constructor, accepts Map<String, dynamic> as an argument
factory
DocumentManifest.fromJsonString(String source)
Acts like a constructor, returns a DocumentManifest, accepts a String as an argument, mostly because I got tired of typing it out
factory
DocumentManifest.fromYaml(dynamic yaml)
Factory constructor that accepts a String in YAML format as an argument
factory

Properties

author List<Reference>?
author Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.
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<Reference>
content The list of Resources that consist of the parts of this manifest.
no setterinherited
copyWith → $DocumentManifestCopyWith<DocumentManifest>
no setterinherited
created FhirDateTime?
created When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).
no setterinherited
createdElement Element?
createdElement Extensions for created
no setterinherited
dbId int?
no setterinherited
description String?
description Human-readable description of the source document. This is sometimes known as the "title".
no setterinherited
descriptionElement Element?
descriptionElement Extensions for description
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 manifest, 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 A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.
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
recipient List<Reference>?
recipient A patient, practitioner, or organization for which this set of documents is intended.
no setterinherited
related Related identifiers or resources associated with the DocumentManifest.
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
source FhirUri?
source Identifies the source system, application, or software that produced the document manifest.
no setterinherited
sourceElement Element?
sourceElement Extensions for source
no setterinherited
status FhirCode?
status The status of this document manifest.
no setterinherited
statusElement Element?
statusElement Extensions for status
no setterinherited
subject Reference?
subject Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. 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). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).
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 The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.
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