RelatedArtifact constructor
- @JsonKey(name: 'id') String? fhirId,
- @JsonKey(name: 'extension') List<
FhirExtension> ? extension_, - @JsonKey(unknownEnumValue: RelatedArtifactType.unknown) RelatedArtifactType? type,
- @JsonKey(name: '_type') Element? typeElement,
- String? label,
- @JsonKey(name: '_label') Element? labelElement,
- String? display,
- @JsonKey(name: '_display') Element? displayElement,
- FhirMarkdown? citation,
- @JsonKey(name: '_citation') Element? citationElement,
- FhirUrl? url,
- @JsonKey(name: '_url') Element? urlElement,
- Attachment? document,
- FhirCanonical? resource,
RelatedArtifact Related artifacts such as additional documentation, justification, or bibliographic references.
id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
extension_
May be used to represent additional information that is not
part of the basic definition of the element. 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.
type
The type of relationship to the related artifact.
typeElement
Extensions for type
label
A short label that can be used to reference the citation from
elsewhere in the containing artifact, such as a footnote index.
labelElement
Extensions for label
display
A brief description of the document or knowledge resource being
referenced, suitable for display to a consumer.
displayElement
Extensions for display
citation
A bibliographic citation for the related artifact. This text
SHOULD be formatted according to an accepted citation format.
citationElement
Extensions for citation
url
A url for the artifact that can be followed to access the actual
content.
urlElement
Extensions for url
document
The document being referenced, represented as an attachment.
This is exclusive with the resource element.
resource
The related resource, such as a library, value set, profile,
or other knowledge resource.
Implementation
const factory RelatedArtifact({
/// [id] Unique id for the element within a resource (for internal
/// references). This may be any string value that does not contain spaces.
@JsonKey(name: 'id') String? fhirId,
/// [extension_] May be used to represent additional information that is not
/// part of the basic definition of the element. 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_,
@JsonKey(unknownEnumValue: RelatedArtifactType.unknown)
/// [type] The type of relationship to the related artifact.
RelatedArtifactType? type,
/// [typeElement] Extensions for type
@JsonKey(name: '_type') Element? typeElement,
/// [label] A short label that can be used to reference the citation from
/// elsewhere in the containing artifact, such as a footnote index.
String? label,
/// [labelElement] Extensions for label
@JsonKey(name: '_label') Element? labelElement,
/// [display] A brief description of the document or knowledge resource being
/// referenced, suitable for display to a consumer.
String? display,
/// [displayElement] Extensions for display
@JsonKey(name: '_display') Element? displayElement,
/// [citation] A bibliographic citation for the related artifact. This text
/// SHOULD be formatted according to an accepted citation format.
FhirMarkdown? citation,
/// [citationElement] Extensions for citation
@JsonKey(name: '_citation') Element? citationElement,
/// [url] A url for the artifact that can be followed to access the actual
/// content.
FhirUrl? url,
/// [urlElement] Extensions for url
@JsonKey(name: '_url') Element? urlElement,
/// [document] The document being referenced, represented as an attachment.
/// This is exclusive with the resource element.
Attachment? document,
/// [resource] The related resource, such as a library, value set, profile,
/// or other knowledge resource.
FhirCanonical? resource,
}) = _RelatedArtifact;