Citation constructor
- @Default(R5ResourceType.Citation) @JsonKey(unknownEnumValue: R5ResourceType.Citation) 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,
- List<
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<
CitationSummary> ? summary, - List<
CitationClassification> ? classification, - List<
Annotation> ? note, - List<
CodeableConcept> ? currentState, - List<
CitationStatusDate> ? statusDate, - CitationCitedArtifact? citedArtifact,
Citation The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.
resourceType
This is a Citation 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 URI that is used to identify this citation record when
it is referenced in a specification, model, design or an instance; also
called its canonical identifier. This SHOULD be globally unique and
SHOULD be a literal address at which an authoritative instance of this
summary is (or will be) published. This URL can be the target of a
canonical reference. It SHALL remain the same when the summary is stored
on different servers.
urlElement
("_url") Extensions for url
identifier
A formal identifier that is used to identify this citation
record when it is represented in other formats, or referenced in a
specification, model, design or an instance.
version
The identifier that is used to identify this version of the
citation record when it is referenced in a specification, model, design
or instance. This is an arbitrary value managed by the citation record
author and is not expected to be globally unique. For example, it might
be a timestamp (e.g. yyyymmdd) if a managed version is not available.
There is also no expectation that versions can be placed in a
lexicographical sequence.
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 citation record. 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 citation record.
titleElement
("_title") Extensions for title
status
The status of this summary. Enables tracking the life-cycle of
the content.
statusElement
("_status") Extensions for status
experimental
A Boolean value to indicate that this citation record is
authored for testing purposes (or education/evaluation/marketing) and is
not intended to be used for genuine usage.
experimentalElement
("_experimental") Extensions for experimental
date
The date (and optionally time) when the citation record was last
significantly changed. The date must change when the business version
changes and it must change if the status code changes. In addition, it
should change when the substantive content of the citation record
changes.
dateElement
("_date") Extensions for date
publisher
The name of the organization or individual that published the
citation record.
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 citation
from a 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 contexts may be general
categories (gender, age, ...) or may be references to specific programs
(insurance plans, studies, ...) and may be used to assist with indexing
and searching for appropriate citation record instances.
jurisdiction
A legal or geographic region in which the citation record
is intended to be used.
purpose
Explanation of why this citation is needed and why it has been
designed as it has.
purposeElement
("_purpose") Extensions for purpose
copyright
Use and/or publishing restrictions for the citation record,
not for the cited artifact.
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 resource 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 resource content was last
reviewed. Review happens periodically after approval but does not change
the original approval date.
lastReviewDateElement
("_lastReviewDate") Extensions for lastReviewDate
effectivePeriod
The period during which the citation record content was
or is planned to be in active use.
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
Who authored or created the citation record.
editor
Who edited or revised the citation record.
reviewer
Who reviewed the citation record.
endorser
Who endorsed the citation record.
relatedArtifact
Artifact related to the citation record.
summary
A human-readable display of key concepts to represent the
citation.
classification
The assignment to an organizing scheme.
note
Used for general notes and annotations not coded elsewhere.
currentState
The status of the citation record.
statusDate
The state or status of the citation record paired with an
effective date or period for that state.
citedArtifact
The article or artifact being described.
Implementation
const factory Citation({
/// [resourceType] This is a Citation resource
@Default(R5ResourceType.Citation)
@JsonKey(unknownEnumValue: R5ResourceType.Citation)
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 URI that is used to identify this citation record
/// when it is referenced in a specification, model, design or an
/// instance; also called its canonical identifier. This SHOULD be
/// globally unique and SHOULD be a literal address at which an
/// authoritative instance of this summary is (or will be) published. This
/// URL can be the target of a canonical reference. It SHALL remain the
/// same when the summary is stored on different servers.
FhirUri? url,
/// [urlElement] ("_url") Extensions for url
@JsonKey(name: '_url') Element? urlElement,
/// [identifier] A formal identifier that is used to identify this citation
/// record when it is represented in other formats, or referenced in a
/// specification, model, design or an instance.
List<Identifier>? identifier,
/// [version] The identifier that is used to identify this version of the
/// citation record when it is referenced in a specification, model,
/// design or instance. This is an arbitrary value managed by the citation
/// record author and is not expected to be globally unique. For example,
/// it might be a timestamp (e.g. yyyymmdd) if a managed version is not
/// available. There is also no expectation that versions can be placed in
/// a lexicographical sequence.
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 citation record. 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 citation
/// record.
String? title,
/// [titleElement] ("_title") Extensions for title
@JsonKey(name: '_title') Element? titleElement,
/// [status] The status of this summary. Enables tracking the life-cycle of
/// the content.
FhirCode? status,
/// [statusElement] ("_status") Extensions for status
@JsonKey(name: '_status') Element? statusElement,
/// [experimental] A Boolean value to indicate that this citation record is
/// authored for testing purposes (or education/evaluation/marketing) and
/// is not intended to be used for genuine usage.
FhirBoolean? experimental,
/// [experimentalElement] ("_experimental") Extensions for experimental
@JsonKey(name: '_experimental') Element? experimentalElement,
/// [date] The date (and optionally time) when the citation record was last
/// significantly changed. The date must change when the business version
/// changes and it must change if the status code changes. In addition, it
/// should change when the substantive content of the citation record
/// changes.
FhirDateTime? date,
/// [dateElement] ("_date") Extensions for date
@JsonKey(name: '_date') Element? dateElement,
/// [publisher] The name of the organization or individual that published
/// the citation record.
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 citation
/// from a 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 contexts may be general
/// categories (gender, age, ...) or may be references to specific
/// programs (insurance plans, studies, ...) and may be used to assist
/// with indexing and searching for appropriate citation record instances.
List<UsageContext>? useContext,
/// [jurisdiction] A legal or geographic region in which the citation
/// record is intended to be used.
List<CodeableConcept>? jurisdiction,
/// [purpose] Explanation of why this citation is needed and why it has
/// been designed as it has.
FhirMarkdown? purpose,
/// [purposeElement] ("_purpose") Extensions for purpose
@JsonKey(name: '_purpose') Element? purposeElement,
/// [copyright] Use and/or publishing restrictions for the citation record,
/// not for the cited artifact.
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 resource 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 resource content was last
/// reviewed. Review happens periodically after approval but does not
/// change the original approval date.
FhirDate? lastReviewDate,
/// [lastReviewDateElement] ("_lastReviewDate") Extensions for
/// lastReviewDate
@JsonKey(name: '_lastReviewDate') Element? lastReviewDateElement,
/// [effectivePeriod] The period during which the citation record content
/// was or is planned to be in active use.
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] Who authored or created the citation record.
List<ContactDetail>? author,
/// [editor] Who edited or revised the citation record.
List<ContactDetail>? editor,
/// [reviewer] Who reviewed the citation record.
List<ContactDetail>? reviewer,
/// [endorser] Who endorsed the citation record.
List<ContactDetail>? endorser,
/// [relatedArtifact] Artifact related to the citation record.
List<RelatedArtifact>? relatedArtifact,
/// [summary] A human-readable display of key concepts to represent the
/// citation.
List<CitationSummary>? summary,
/// [classification] The assignment to an organizing scheme.
List<CitationClassification>? classification,
/// [note] Used for general notes and annotations not coded elsewhere.
List<Annotation>? note,
/// [currentState] The status of the citation record.
List<CodeableConcept>? currentState,
/// [statusDate] The state or status of the citation record paired with an
/// effective date or period for that state.
List<CitationStatusDate>? statusDate,
/// [citedArtifact] The article or artifact being described.
CitationCitedArtifact? citedArtifact,
}) = _Citation;