CapabilityStatement class
CapabilityStatement A Capability Statement documents a set of
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
CapabilityStatement({@Default(R4ResourceType.CapabilityStatement) @JsonKey(unknownEnumValue: R4ResourceType.CapabilityStatement) 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, 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, FhirCode? kind, @JsonKey(name: '_kind') Element? kindElement, List<FhirCanonical> ? instantiates, List<FhirCanonical> ? imports, CapabilityStatementSoftware? software, CapabilityStatementImplementation? implementation, FhirCode? fhirVersion, @JsonKey(name: '_fhirVersion') Element? fhirVersionElement, List<FhirCode> ? format, @JsonKey(name: '_format') List<Element?> ? formatElement, List<FhirCode> ? patchFormat, @JsonKey(name: '_patchFormat') List<Element?> ? patchFormatElement, List<FhirCanonical> ? implementationGuide, List<CapabilityStatementRest> ? rest, List<CapabilityStatementMessaging> ? messaging, List<CapabilityStatementDocument> ? document}) -
CapabilityStatement A Capability Statement documents a set of
capabilities (behaviors) of a FHIR Server for a particular version of FHIR
that may be used as a statement of actual server functionality or a
statement of required or desired server implementation.
constfactory
-
CapabilityStatement.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- CapabilityStatement.fromJsonString(String source)
-
Acts like a constructor, returns a CapabilityStatement, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- CapabilityStatement.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
-
contact
→ List<
ContactDetail> ? -
contact Contact details to assist a user in finding and communicating
with the publisher.
no setterinherited
-
contained
→ List<
Resource> ? -
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.
no setterinherited
- copyright → FhirMarkdown?
-
copyright A copyright statement relating to the capability statement
and/or its contents. Copyright statements are generally legal restrictions
on the use and publishing of the capability statement.
no setterinherited
- copyrightElement → Element?
-
copyrightElement Extensions for copyright
no setterinherited
-
copyWith
→ $CapabilityStatementCopyWith<
CapabilityStatement> -
no setterinherited
- date → FhirDateTime?
-
date The date (and optionally time) when the capability statement 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 capability statement changes.
no setterinherited
- dateElement → Element?
-
dateElement Extensions for date
no setterinherited
- dbId → int?
-
no setterinherited
- description → FhirMarkdown?
-
description A free text natural language description of the capability
statement from a consumer's perspective. Typically, this is used when the
capability statement describes a desired rather than an actual solution,
for example as a formal expression of requirements as part of an RFP.
no setterinherited
- descriptionElement → Element?
-
descriptionElement Extensions for description
no setterinherited
-
document
→ List<
CapabilityStatementDocument> ? -
document A document definition.
no setterinherited
- experimental → FhirBoolean?
-
experimental A Boolean value to indicate that this capability statement
is authored for testing purposes (or education/evaluation/marketing) and
is not intended to be used for genuine usage.
no setterinherited
- experimentalElement → Element?
-
experimentalElement Extensions for experimental
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
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.
no setterinherited
- fhirId → String?
-
id The logical id of the resource, as used in the URL for the resource.
Once assigned, this value never changes.
no setterinherited
- fhirVersion → FhirCode?
-
fhirVersion The version of the FHIR specification that this
CapabilityStatement describes (which SHALL be the same as the FHIR version
of the CapabilityStatement itself). There is no default value.
no setterinherited
- fhirVersionElement → Element?
-
fhirVersionElement Extensions for fhirVersion
no setterinherited
-
format
→ List<
FhirCode> ? -
format A list of the formats supported by this implementation using
their content types.
no setterinherited
-
formatElement
→ List<
Element?> ? -
formatElement Extensions for format
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- implementation → CapabilityStatementImplementation?
-
implementation Identifies a specific implementation instance that is
described by the capability statement - i.e. a particular installation,
rather than the capabilities of a software program.
no setterinherited
-
implementationGuide
→ List<
FhirCanonical> ? -
implementationGuide A list of implementation guides that the server
does (or should) support in their entirety.
no setterinherited
- implicitRules → FhirUri?
-
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.
no setterinherited
- implicitRulesElement → Element?
-
implicitRulesElement Extensions for implicitRules
no setterinherited
-
imports
→ List<
FhirCanonical> ? -
imports Reference to a canonical URL of another CapabilityStatement
that this software adds to. The capability statement automatically
includes everything in the other statement, and it is not duplicated,
though the server may repeat the same resources, interactions and
operations to add additional details to them.
no setterinherited
-
instantiates
→ List<
FhirCanonical> ? -
instantiates Reference to a canonical URL of another
CapabilityStatement that this software implements. This capability
statement is a published API description that corresponds to a business
service. The server may actually implement a subset of the capability
statement it claims to implement, so the capability statement must specify
the full capability details.
no setterinherited
-
jurisdiction
→ List<
CodeableConcept> ? -
jurisdiction A legal or geographic region in which the capability
statement is intended to be used.
no setterinherited
- kind → FhirCode?
-
kind The way that this statement is intended to be used, to describe an
actual running instance of software, a particular product (kind, not
instance of software) or a class of implementation (e.g. a desired
purchase).
no setterinherited
- kindElement → Element?
-
kindElement Extensions for kind
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement Extensions for language
no setterinherited
-
messaging
→ List<
CapabilityStatementMessaging> ? -
messaging A description of the messaging capabilities of the solution.
no setterinherited
- meta → FhirMeta?
-
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.
no setterinherited
-
modifierExtension
→ List<
FhirExtension> ? -
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).
no setterinherited
- name → String?
-
name A natural language name identifying the capability statement. This
name should be usable as an identifier for the module by machine
processing applications such as code generation.
no setterinherited
- nameElement → Element?
-
nameElement Extensions for name
no setterinherited
-
patchFormat
→ List<
FhirCode> ? -
patchFormat A list of the patch formats supported by this
implementation using their content types.
no setterinherited
-
patchFormatElement
→ List<
Element?> ? -
patchFormatElement Extensions for patchFormat
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
- publisher → String?
-
publisher The name of the organization or individual that published the
capability statement.
no setterinherited
- publisherElement → Element?
-
publisherElement Extensions for publisher
no setterinherited
- purpose → FhirMarkdown?
-
purpose Explanation of why this capability statement is needed and why
it has been designed as it has.
no setterinherited
- purposeElement → Element?
-
purposeElement Extensions for purpose
no setterinherited
- resourceType → R4ResourceType
-
no setterinherited
- resourceTypeString → String?
-
produce a string of the resourceType
no setterinherited
-
rest
→ List<
CapabilityStatementRest> ? -
rest A definition of the restful capabilities of the solution, if any.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- software → CapabilityStatementSoftware?
-
software Software that is covered by this capability statement. It is
used when the capability statement describes the capabilities of a
particular software version, independent of an installation.
no setterinherited
- status → FhirCode?
-
status The status of this capability statement. Enables tracking the
life-cycle of the content.
no setterinherited
- statusElement → Element?
-
statusElement Extensions for status
no setterinherited
- text → Narrative?
-
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.
no setterinherited
- thisReference → Reference
-
Convenience method to return a Reference referring to that Resource
no setterinherited
- title → String?
-
title A short, descriptive, user-friendly title for the capability
statement.
no setterinherited
- titleElement → Element?
-
titleElement Extensions for title
no setterinherited
- url → FhirUri?
-
url An absolute URI that is used to identify this capability statement
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 capability statement is (or will be) published. This URL can be the
target of a canonical reference. It SHALL remain the same when the
capability statement is stored on different servers.
no setterinherited
- urlElement → Element?
-
urlElement Extensions for url
no setterinherited
-
useContext
→ List<
UsageContext> ? -
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 capability statement instances.
no setterinherited
- version → String?
-
version The identifier that is used to identify this version of the
capability statement when it is referenced in a specification, model,
design or instance. This is an arbitrary value managed by the capability
statement 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.
no setterinherited
- versionElement → Element?
-
versionElement Extensions for version
no setterinherited
Methods
-
newId(
) → Resource -
returns the same resource with a new ID (even if there is already an ID
present)
inherited
-
newIdIfNoId(
) → Resource -
returns the same resource with a new ID if there is no current ID
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDbJson(
) → Map< String, dynamic> -
The normal toJson ignores the dbId, and produces the fhirId as the id
However, if you're going to use this as a database entry, you have to
switch those two ids
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toJsonString(
) → String -
Another convenience method because more and more I'm transmitting FHIR
data as a String and not a Map
override
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String -
Produces a Yaml formatted String version of the object
inherited
-
updateVersion(
{FhirMeta? oldMeta}) → Resource -
Updates the meta field of this Resource, updates the meta.lastUpdated
field, adds 1 to the version number
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited