SpecimenDefinition constructor

const SpecimenDefinition({ @Default(R5ResourceType.SpecimenDefinition) @JsonKey(unknownEnumValue: R5ResourceType.SpecimenDefinition) 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, FhirUri? url, @JsonKey(name: '_url') Element? urlElement, Identifier? identifier, String? version, @JsonKey(name: '_version') Element? versionElement, String? versionAlgorithmString, @JsonKey(name: '_versionAlgorithmString') Element? versionAlgorithmStringElement, Coding? versionAlgorithmCoding, String? name, @JsonKey(name: '_name') Element? nameElement, String? title, @JsonKey(name: '_title') Element? titleElement, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, FhirBoolean? experimental, @JsonKey(name: '_experimental') Element? experimentalElement, FhirDateTime? date, @JsonKey(name: '_date') Element? dateElement, String? publisher, @JsonKey(name: '_publisher') Element? publisherElement, List<ContactDetail>? contact, FhirMarkdown? description, @JsonKey(name: '_description') Element? descriptionElement, List<UsageContext>? useContext, List<CodeableConcept>? jurisdiction, FhirMarkdown? purpose, @JsonKey(name: '_purpose') Element? purposeElement, FhirMarkdown? copyright, @JsonKey(name: '_copyright') Element? copyrightElement, String? copyrightLabel, @JsonKey(name: '_copyrightLabel') Element? copyrightLabelElement, FhirDate? approvalDate, @JsonKey(name: '_approvalDate') Element? approvalDateElement, FhirDate? lastReviewDate, @JsonKey(name: '_lastReviewDate') Element? lastReviewDateElement, Period? effectivePeriod, List<CodeableConcept>? topic, List<ContactDetail>? author, List<ContactDetail>? editor, List<ContactDetail>? reviewer, List<ContactDetail>? endorser, List<RelatedArtifact>? relatedArtifact, List<FhirCanonical>? derivedFromCanonical, List<FhirUri>? derivedFromUri, @JsonKey(name: '_derivedFromUri') List<Element>? derivedFromUriElement, CodeableConcept? subjectCodeableConcept, Reference? subjectReference, CodeableConcept? typeCollected, List<CodeableConcept>? patientPreparation, String? timeAspect, @JsonKey(name: '_timeAspect') Element? timeAspectElement, List<CodeableConcept>? collection, List<SpecimenDefinitionTypeTested>? typeTested, })

SpecimenDefinition A kind of specimen with associated set of requirements.

resourceType This is a SpecimenDefinition 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).

url An absolute URL that is used to identify this SpecimenDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this SpecimenDefinition is (or will be) published. The URL SHOULD include the major version of the SpecimenDefinition. For more information see Technical and Business Versions.

urlElement ("_url") Extensions for url

identifier A business identifier assigned to this SpecimenDefinition.

version The identifier that is used to identify this version of the SpecimenDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the SpecimenDefinition author and is not expected to be globally unique.

versionElement ("_version") Extensions for version

versionAlgorithmString Indicates the mechanism used to compare versions to determine which is more current.

versionAlgorithmStringElement ("_versionAlgorithmString") Extensions for versionAlgorithmString

versionAlgorithmCoding Indicates the mechanism used to compare versions to determine which is more current.

name A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation.

nameElement ("_name") Extensions for name

title A short, descriptive, user-friendly title for the SpecimenDefinition.

titleElement ("_title") Extensions for title

status The current state of theSpecimenDefinition.

statusElement ("_status") Extensions for status

experimental A flag to indicate that this SpecimenDefinition is not authored for genuine usage.

experimentalElement ("_experimental") Extensions for experimental

date For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.

dateElement ("_date") Extensions for date

publisher Helps establish the "authority/credibility" of the SpecimenDefinition. May also allow for contact.

publisherElement ("_publisher") Extensions for publisher

contact Contact details to assist a user in finding and communicating with the publisher.

description A free text natural language description of the SpecimenDefinition from the consumer's perspective.

descriptionElement ("_description") Extensions for description

useContext The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of specimen definitions.

jurisdiction A jurisdiction in which the SpecimenDefinition is intended to be used.

purpose Explains why this SpecimeDefinition is needed and why it has been designed as it has.

purposeElement ("_purpose") Extensions for purpose

copyright Copyright statement relating to the SpecimenDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SpecimenDefinition.

copyrightElement ("_copyright") Extensions for copyright

copyrightLabel A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

copyrightLabelElement ("_copyrightLabel") Extensions for copyrightLabel

approvalDate The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.

approvalDateElement ("_approvalDate") Extensions for approvalDate

lastReviewDate The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.

lastReviewDateElement ("_lastReviewDate") Extensions for lastReviewDate

effectivePeriod The period during which the SpecimenDefinition content was or is planned to be effective.

topic Descriptive topics related to the content of the {{title}}. Topics provide a high-level categorization as well as keywords for the {{title}} that can be useful for filtering and searching.

author An individiual or organization primarily involved in the creation and maintenance of the {{title}}.

editor An individual or organization primarily responsible for internal coherence of the {{title}}.

reviewer An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the {{title}}.

endorser An individual or organization asserted by the publisher to be responsible for officially endorsing the {{title}} for use in some setting.

relatedArtifact Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.

derivedFromCanonical The canonical URL pointing to another FHIR-defined SpecimenDefinition that is adhered to in whole or in part by this definition.

derivedFromUri The URL pointing to an externally-defined type of specimen, guideline or other definition that is adhered to in whole or in part by this definition.

derivedFromUriElement ("_derivedFromUri") Extensions for derivedFromUri

subjectCodeableConcept A code or group definition that describes the intended subject from which this kind of specimen is to be collected.

subjectReference A code or group definition that describes the intended subject from which this kind of specimen is to be collected.

typeCollected The kind of material to be collected.

patientPreparation Preparation of the patient for specimen collection.

timeAspect Time aspect of specimen collection (duration or offset).

timeAspectElement ("_timeAspect") Extensions for timeAspect

collection The action to be performed for collecting the specimen.

typeTested Specimen conditioned in a container as expected by the testing laboratory.

Implementation

const factory SpecimenDefinition({
  /// [resourceType] This is a SpecimenDefinition resource
  @Default(R5ResourceType.SpecimenDefinition)
  @JsonKey(unknownEnumValue: R5ResourceType.SpecimenDefinition)
  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,

  /// [url] An absolute URL that is used to identify this SpecimenDefinition
  ///  when it is referenced in a specification, model, design or an
  ///  instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD
  ///  be an address at which this SpecimenDefinition is (or will be)
  ///  published. The URL SHOULD include the major version of the
  ///  SpecimenDefinition. For more information see Technical and Business
  ///  Versions.
  FhirUri? url,

  /// [urlElement] ("_url") Extensions for url
  @JsonKey(name: '_url') Element? urlElement,

  /// [identifier] A business identifier assigned to this SpecimenDefinition.
  Identifier? identifier,

  /// [version] The identifier that is used to identify this version of the
  ///  SpecimenDefinition when it is referenced in a specification, model,
  ///  design or instance. This is an arbitrary value managed by the
  ///  SpecimenDefinition author and is not expected to be globally unique.
  String? version,

  /// [versionElement] ("_version") Extensions for version
  @JsonKey(name: '_version') Element? versionElement,

  /// [versionAlgorithmString] Indicates the mechanism used to compare
  ///  versions to determine which is more current.
  String? versionAlgorithmString,

  /// [versionAlgorithmStringElement] ("_versionAlgorithmString") Extensions
  ///  for versionAlgorithmString
  @JsonKey(name: '_versionAlgorithmString')
  Element? versionAlgorithmStringElement,

  /// [versionAlgorithmCoding] Indicates the mechanism used to compare
  ///  versions to determine which is more current.
  Coding? versionAlgorithmCoding,

  /// [name] A natural language name identifying the {{title}}. This name
  ///  should be usable as an identifier for the module by machine processing
  ///  applications such as code generation.
  String? name,

  /// [nameElement] ("_name") Extensions for name
  @JsonKey(name: '_name') Element? nameElement,

  /// [title] A short, descriptive, user-friendly title for the
  ///  SpecimenDefinition.
  String? title,

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

  /// [status] The current state of theSpecimenDefinition.
  FhirCode? status,

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

  /// [experimental] A flag to indicate that this SpecimenDefinition is not
  ///  authored for  genuine usage.
  FhirBoolean? experimental,

  /// [experimentalElement] ("_experimental") Extensions for experimental
  @JsonKey(name: '_experimental') Element? experimentalElement,

  /// [date] For draft definitions, indicates the date of initial creation.
  ///  For active definitions, represents the date of activation. For
  ///  withdrawn definitions, indicates the date of withdrawal.
  FhirDateTime? date,

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

  /// [publisher] Helps establish the "authority/credibility" of the
  ///  SpecimenDefinition. May also allow for contact.
  String? publisher,

  /// [publisherElement] ("_publisher") Extensions for publisher
  @JsonKey(name: '_publisher') Element? publisherElement,

  /// [contact] Contact details to assist a user in finding and communicating
  ///  with the publisher.
  List<ContactDetail>? contact,

  /// [description] A free text natural language description of the
  ///  SpecimenDefinition from the consumer's perspective.
  FhirMarkdown? description,

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

  /// [useContext] The content was developed with a focus and intent of
  ///  supporting the contexts that are listed. These terms may be used to
  ///  assist with indexing and searching of specimen definitions.
  List<UsageContext>? useContext,

  /// [jurisdiction] A jurisdiction in which the SpecimenDefinition is
  ///  intended to be used.
  List<CodeableConcept>? jurisdiction,

  /// [purpose] Explains why this SpecimeDefinition is needed and why it has
  ///  been designed as it has.
  FhirMarkdown? purpose,

  /// [purposeElement] ("_purpose") Extensions for purpose
  @JsonKey(name: '_purpose') Element? purposeElement,

  /// [copyright] Copyright statement relating to the SpecimenDefinition
  ///  and/or its contents. Copyright statements are generally legal
  ///  restrictions on the use and publishing of the SpecimenDefinition.
  FhirMarkdown? copyright,

  /// [copyrightElement] ("_copyright") Extensions for copyright
  @JsonKey(name: '_copyright') Element? copyrightElement,

  /// [copyrightLabel] A short string (<50 characters), suitable for
  ///  inclusion in a page footer that identifies the copyright holder,
  ///  effective period, and optionally whether rights are resctricted. (e.g.
  ///  'All rights reserved', 'Some rights reserved').
  String? copyrightLabel,

  /// [copyrightLabelElement] ("_copyrightLabel") Extensions for
  ///  copyrightLabel
  @JsonKey(name: '_copyrightLabel') Element? copyrightLabelElement,

  /// [approvalDate] The date on which the asset content was approved by the
  ///  publisher. Approval happens once when the content is officially
  ///  approved for usage.
  FhirDate? approvalDate,

  /// [approvalDateElement] ("_approvalDate") Extensions for approvalDate
  @JsonKey(name: '_approvalDate') Element? approvalDateElement,

  /// [lastReviewDate] The date on which the asset content was last reviewed.
  ///  Review happens periodically after that, but doesn't change the
  ///  original approval date.
  FhirDate? lastReviewDate,

  /// [lastReviewDateElement] ("_lastReviewDate") Extensions for
  ///  lastReviewDate
  @JsonKey(name: '_lastReviewDate') Element? lastReviewDateElement,

  /// [effectivePeriod] The period during which the SpecimenDefinition
  ///  content was or is planned to be effective.
  Period? effectivePeriod,

  /// [topic] Descriptive topics related to the content of the {{title}}.
  ///  Topics provide a high-level categorization as well as keywords for the
  ///  {{title}} that can be useful for filtering and searching.
  List<CodeableConcept>? topic,

  /// [author] An individiual or organization primarily involved in the
  ///  creation and maintenance of the {{title}}.
  List<ContactDetail>? author,

  /// [editor] An individual or organization primarily responsible for
  ///  internal coherence of the {{title}}.
  List<ContactDetail>? editor,

  /// [reviewer] An individual or organization asserted by the publisher to
  ///  be primarily responsible for review of some aspect of the {{title}}.
  List<ContactDetail>? reviewer,

  /// [endorser] An individual or organization asserted by the publisher to
  ///  be responsible for officially endorsing the {{title}} for use in some
  ///  setting.
  List<ContactDetail>? endorser,

  /// [relatedArtifact] Related artifacts such as additional documentation,
  ///  justification, dependencies, bibliographic references, and predecessor
  ///  and successor artifacts.
  List<RelatedArtifact>? relatedArtifact,

  /// [derivedFromCanonical] The canonical URL pointing to another
  ///  FHIR-defined SpecimenDefinition that is adhered to in whole or in part
  ///  by this definition.
  List<FhirCanonical>? derivedFromCanonical,

  /// [derivedFromUri] The URL pointing to an externally-defined type of
  ///  specimen, guideline or other definition that is adhered to in whole or
  ///  in part by this definition.
  List<FhirUri>? derivedFromUri,

  /// [derivedFromUriElement] ("_derivedFromUri") Extensions for
  ///  derivedFromUri
  @JsonKey(name: '_derivedFromUri') List<Element>? derivedFromUriElement,

  /// [subjectCodeableConcept] A code or group definition that describes the
  ///  intended subject  from which this kind of specimen is to be collected.
  CodeableConcept? subjectCodeableConcept,

  /// [subjectReference] A code or group definition that describes the
  ///  intended subject  from which this kind of specimen is to be collected.
  Reference? subjectReference,

  /// [typeCollected] The kind of material to be collected.
  CodeableConcept? typeCollected,

  /// [patientPreparation] Preparation of the patient for specimen collection.
  List<CodeableConcept>? patientPreparation,

  /// [timeAspect] Time aspect of specimen collection (duration or offset).
  String? timeAspect,

  /// [timeAspectElement] ("_timeAspect") Extensions for timeAspect
  @JsonKey(name: '_timeAspect') Element? timeAspectElement,

  /// [collection] The action to be performed for collecting the specimen.
  List<CodeableConcept>? collection,

  /// [typeTested] Specimen conditioned in a container as expected by the
  ///  testing laboratory.
  List<SpecimenDefinitionTypeTested>? typeTested,
}) = _SpecimenDefinition;