DocumentReference constructor

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

resourceType This is a DocumentReference resource

id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

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.

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.

implicitRulesElement Extensions for implicitRules

language The base language in which the resource is written.

languageElement Extensions for language

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.

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.

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.

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

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.

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

status The status of this document reference.

statusElement Extensions for status

docStatus The status of the underlying document.

docStatusElement Extensions for docStatus

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.

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.

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

date When the document reference was created.

dateElement Extensions for date

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

authenticator Which person or organization authenticates that this document is valid.

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

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

description Human-readable description of the source document.

descriptionElement Extensions for description

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.

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

context The clinical context in which the document was prepared.

Implementation

const factory DocumentReference({
  @Default(R4ResourceType.DocumentReference)
  @JsonKey(unknownEnumValue: R4ResourceType.DocumentReference)

  /// [resourceType] This is a DocumentReference resource
  R4ResourceType resourceType,
  @JsonKey(includeFromJson: true, includeToJson: false) int? dbId,

  /// [id] The logical id of the resource, as used in the URL for the resource.
  ///  Once assigned, this value never changes.
  @JsonKey(name: 'id') String? fhirId,

  /// [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.
  FhirMeta? meta,

  /// [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.
  FhirUri? implicitRules,

  /// [implicitRulesElement] Extensions for implicitRules
  @JsonKey(name: '_implicitRules') Element? implicitRulesElement,

  /// [language] The base language in which the resource is written.
  FhirCode? language,

  /// [languageElement] Extensions for language
  @JsonKey(name: '_language') Element? languageElement,

  /// [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.
  Narrative? text,

  /// [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.
  List<Resource>? contained,

  /// [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.
  @JsonKey(name: 'extension') List<FhirExtension>? extension_,

  /// [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).
  List<FhirExtension>? modifierExtension,

  /// [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.
  Identifier? masterIdentifier,

  /// [identifier] Other identifiers associated with the document, including
  ///  version independent identifiers.
  List<Identifier>? identifier,

  /// [status] The status of this document reference.
  FhirCode? status,

  /// [statusElement] Extensions for status
  @JsonKey(name: '_status') Element? statusElement,

  /// [docStatus] The status of the underlying document.
  FhirCode? docStatus,

  /// [docStatusElement] Extensions for docStatus
  @JsonKey(name: '_docStatus') Element? docStatusElement,

  /// [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.
  CodeableConcept? type,

  /// [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.
  List<CodeableConcept>? category,

  /// [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).
  Reference? subject,

  /// [date] When the document reference was created.
  FhirInstant? date,

  /// [dateElement] Extensions for date
  @JsonKey(name: '_date') Element? dateElement,

  /// [author] Identifies who is responsible for adding the information to the
  ///  document.
  List<Reference>? author,

  /// [authenticator] Which person or organization authenticates that this
  ///  document is valid.
  Reference? authenticator,

  /// [custodian] Identifies the organization or group who is responsible for
  ///  ongoing maintenance of and access to the document.
  Reference? custodian,

  /// [relatesTo] Relationships that this document has with other document
  ///  references that already exist.
  List<DocumentReferenceRelatesTo>? relatesTo,

  /// [description] Human-readable description of the source document.
  String? description,

  /// [descriptionElement] Extensions for description
  @JsonKey(name: '_description') Element? descriptionElement,

  /// [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.
  List<CodeableConcept>? securityLabel,

  /// [content] The document and format referenced. There may be multiple
  ///  content element repetitions, each with a different format.
  required List<DocumentReferenceContent> content,

  /// [context] The clinical context in which the document was prepared.
  DocumentReferenceContext? context,
}) = _DocumentReference;