FhirList constructor

const FhirList({ @Default(R5ResourceType.List) @JsonKey(unknownEnumValue: R5ResourceType.List) 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, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, FhirCode? mode, @JsonKey(name: '_mode') Element? modeElement, String? title, @JsonKey(name: '_title') Element? titleElement, CodeableConcept? code, List<Reference>? subject, Reference? encounter, FhirDateTime? date, @JsonKey(name: '_date') Element? dateElement, Reference? source, CodeableConcept? orderedBy, List<Annotation>? note, List<FhirListEntry>? entry, CodeableConcept? emptyReason, })

FhirList A List is a curated collection of resources, for things such as problem lists, allergy lists, facility list, organization list, etc.

resourceType This is a List 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 ("_implicitRules") Extensions for implicitRules

language The base language in which the resource is written.

languageElement ("_language") 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, 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.

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.

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

identifier Identifier for the List assigned for business purposes outside the context of FHIR.

status Indicates the current state of this list.

statusElement ("_status") Extensions for status

mode How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

modeElement ("_mode") Extensions for mode

title A label for the list assigned by the author.

titleElement ("_title") Extensions for title

code This code defines the purpose of the list - why it was created.

subject The common subject(s) (or patient(s)) of the resources that are in the list if there is one (or a set of subjects).

encounter The encounter that is the context in which this list was created.

date Date list was last reviewed/revised and determined to be 'current'.

dateElement ("_date") Extensions for date

source The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.

orderedBy What order applies to the items in the list.

note Comments that apply to the overall list.

entry Entries in this list.

emptyReason If the list is empty, why the list is empty.

Implementation

const factory FhirList({
  /// [resourceType] This is a List resource
  @Default(R5ResourceType.List)
  @JsonKey(unknownEnumValue: R5ResourceType.List)
  R5ResourceType 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') FhirId? 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] ("_implicitRules") Extensions for implicitRules
  @JsonKey(name: '_implicitRules') Element? implicitRulesElement,

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

  /// [languageElement] ("_language") 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, 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.
  List<Resource>? contained,

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

  /// [identifier] Identifier for the List assigned for business purposes
  ///  outside the context of FHIR.
  List<Identifier>? identifier,

  /// [status] Indicates the current state of this list.
  FhirCode? status,

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

  /// [mode] How this list was prepared - whether it is a working list that
  ///  is suitable for being maintained on an ongoing basis, or if it
  ///  represents a snapshot of a list of items from another source, or
  ///  whether it is a prepared list where items may be marked as added,
  ///  modified or deleted.
  FhirCode? mode,

  /// [modeElement] ("_mode") Extensions for mode
  @JsonKey(name: '_mode') Element? modeElement,

  /// [title] A label for the list assigned by the author.
  String? title,

  /// [titleElement] ("_title") Extensions for title
  @JsonKey(name: '_title') Element? titleElement,

  /// [code] This code defines the purpose of the list - why it was created.
  CodeableConcept? code,

  /// [subject] The common subject(s) (or patient(s)) of the resources that
  ///  are in the list if there is one (or a set of subjects).
  List<Reference>? subject,

  /// [encounter] The encounter that is the context in which this list was
  ///  created.
  Reference? encounter,

  /// [date] Date list was last reviewed/revised and determined to be
  ///  'current'.
  FhirDateTime? date,

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

  /// [source] The entity responsible for deciding what the contents of the
  ///  list were. Where the list was created by a human, this is the same as
  ///  the author of the list.
  Reference? source,

  /// [orderedBy] What order applies to the items in the list.
  CodeableConcept? orderedBy,

  /// [note] Comments that apply to the overall list.
  List<Annotation>? note,

  /// [entry] Entries in this list.
  List<FhirListEntry>? entry,

  /// [emptyReason] If the list is empty, why the list is empty.
  CodeableConcept? emptyReason,
}) = _FhirList;