CompartmentDefinition constructor
- @Default(R4ResourceType.CompartmentDefinition) @JsonKey(unknownEnumValue: R4ResourceType.CompartmentDefinition) 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, - FhirUri? url,
- @JsonKey(name: '_url') Element? urlElement,
- String? version,
- @JsonKey(name: '_version') Element? versionElement,
- String? name,
- @JsonKey(name: '_name') Element? nameElement,
- 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, - FhirMarkdown? purpose,
- @JsonKey(name: '_purpose') Element? purposeElement,
- FhirCode? code,
- @JsonKey(name: '_code') Element? codeElement,
- FhirBoolean? search,
- @JsonKey(name: '_search') Element? searchElement,
- List<
CompartmentDefinitionResource> ? resource,
CompartmentDefinition A compartment definition that defines how resources are accessed on a server.
resourceType
This is a CompartmentDefinition 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).
url
An absolute URI that is used to identify this compartment
definition 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 at which an authoritative
instance of this compartment definition is (or will be) published. This
URL can be the target of a canonical reference. It SHALL remain the same
when the compartment definition is stored on different servers.
urlElement
Extensions for url
version
The identifier that is used to identify this version of the
compartment definition when it is referenced in a specification, model,
design or instance. This is an arbitrary value managed by the compartment
definition 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
Extensions for version
name
A natural language name identifying the compartment definition.
This name should be usable as an identifier for the module by machine
processing applications such as code generation.
nameElement
Extensions for name
status
The status of this compartment definition. Enables tracking the
life-cycle of the content.
statusElement
Extensions for status
experimental
A Boolean value to indicate that this compartment
definition is authored for testing purposes (or
education/evaluation/marketing) and is not intended to be used for genuine
usage.
experimentalElement
Extensions for experimental
date
The date (and optionally time) when the compartment definition
was published. 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 compartment definition changes.
dateElement
Extensions for date
publisher
The name of the organization or individual that published the
compartment definition.
publisherElement
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 compartment
definition from a consumer's perspective.
descriptionElement
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 compartment definition instances.
purpose
Explanation of why this compartment definition is needed and
why it has been designed as it has.
purposeElement
Extensions for purpose
code
Which compartment this definition describes.
codeElement
Extensions for code
search
Whether the search syntax is supported,.
searchElement
Extensions for search
resource
Information about how a resource is related to the
compartment.
Implementation
const factory CompartmentDefinition({
@Default(R4ResourceType.CompartmentDefinition)
@JsonKey(unknownEnumValue: R4ResourceType.CompartmentDefinition)
/// [resourceType] This is a CompartmentDefinition 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,
/// [url] An absolute URI that is used to identify this compartment
/// definition 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 at which an authoritative
/// instance of this compartment definition is (or will be) published. This
/// URL can be the target of a canonical reference. It SHALL remain the same
/// when the compartment definition is stored on different servers.
FhirUri? url,
/// [urlElement] Extensions for url
@JsonKey(name: '_url') Element? urlElement,
/// [version] The identifier that is used to identify this version of the
/// compartment definition when it is referenced in a specification, model,
/// design or instance. This is an arbitrary value managed by the compartment
/// definition 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] Extensions for version
@JsonKey(name: '_version') Element? versionElement,
/// [name] A natural language name identifying the compartment definition.
/// This name should be usable as an identifier for the module by machine
/// processing applications such as code generation.
String? name,
/// [nameElement] Extensions for name
@JsonKey(name: '_name') Element? nameElement,
/// [status] The status of this compartment definition. Enables tracking the
/// life-cycle of the content.
FhirCode? status,
/// [statusElement] Extensions for status
@JsonKey(name: '_status') Element? statusElement,
/// [experimental] A Boolean value to indicate that this compartment
/// definition is authored for testing purposes (or
/// education/evaluation/marketing) and is not intended to be used for genuine
/// usage.
FhirBoolean? experimental,
/// [experimentalElement] Extensions for experimental
@JsonKey(name: '_experimental') Element? experimentalElement,
/// [date] The date (and optionally time) when the compartment definition
/// was published. 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 compartment definition changes.
FhirDateTime? date,
/// [dateElement] Extensions for date
@JsonKey(name: '_date') Element? dateElement,
/// [publisher] The name of the organization or individual that published the
/// compartment definition.
String? publisher,
/// [publisherElement] 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 compartment
/// definition from a consumer's perspective.
FhirMarkdown? description,
/// [descriptionElement] 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 compartment definition instances.
List<UsageContext>? useContext,
/// [purpose] Explanation of why this compartment definition is needed and
/// why it has been designed as it has.
FhirMarkdown? purpose,
/// [purposeElement] Extensions for purpose
@JsonKey(name: '_purpose') Element? purposeElement,
/// [code] Which compartment this definition describes.
FhirCode? code,
/// [codeElement] Extensions for code
@JsonKey(name: '_code') Element? codeElement,
/// [search] Whether the search syntax is supported,.
FhirBoolean? search,
/// [searchElement] Extensions for search
@JsonKey(name: '_search') Element? searchElement,
/// [resource] Information about how a resource is related to the
/// compartment.
List<CompartmentDefinitionResource>? resource,
}) = _CompartmentDefinition;