HealthcareService class
HealthcareService The details of a healthcare service available at a location.
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
HealthcareService({@Default(R5ResourceType.HealthcareService) @JsonKey(unknownEnumValue: R5ResourceType.HealthcareService) 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, List<Identifier> ? identifier, FhirBoolean? active, @JsonKey(name: '_active') Element? activeElement, Reference? providedBy, List<Reference> ? offeredIn, List<CodeableConcept> ? category, List<CodeableConcept> ? type, List<CodeableConcept> ? specialty, List<Reference> ? location, String? name, @JsonKey(name: '_name') Element? nameElement, FhirMarkdown? comment, @JsonKey(name: '_comment') Element? commentElement, FhirMarkdown? extraDetails, @JsonKey(name: '_extraDetails') Element? extraDetailsElement, Attachment? photo, List<ExtendedContactDetail> ? contact, List<Reference> ? coverageArea, List<CodeableConcept> ? serviceProvisionCode, List<HealthcareServiceEligibility> ? eligibility, List<CodeableConcept> ? program, List<CodeableConcept> ? characteristic, List<CodeableConcept> ? communication, List<CodeableConcept> ? referralMethod, FhirBoolean? appointmentRequired, @JsonKey(name: '_appointmentRequired') Element? appointmentRequiredElement, List<Availability> ? availability, List<Reference> ? endpoint}) -
HealthcareService The details of a healthcare service available at a
location.
constfactory
-
HealthcareService.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- HealthcareService.fromJsonString(String source)
-
Acts like a constructor, returns a HealthcareService, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- HealthcareService.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
- active → FhirBoolean?
-
active This flag is used to mark the record to not be used. This is
not used when a center is closed for maintenance, or for holidays, the
notAvailable period is to be used for this.
no setterinherited
- activeElement → Element?
-
activeElement ("_active") Extensions for active
no setterinherited
- appointmentRequired → FhirBoolean?
-
appointmentRequired Indicates whether or not a prospective consumer
will require an appointment for a particular service at a site to be
provided by the Organization. Indicates if an appointment is required
for access to this service.
no setterinherited
- appointmentRequiredElement → Element?
-
appointmentRequiredElement ("_appointmentRequired") Extensions for
appointmentRequired
no setterinherited
-
availability
→ List<
Availability> ? -
availability A collection of times that the healthcare service is
available.
no setterinherited
-
category
→ List<
CodeableConcept> ? -
category Identifies the broad category of service being performed or
delivered.
no setterinherited
-
characteristic
→ List<
CodeableConcept> ? -
characteristic Collection of characteristics (attributes).
no setterinherited
- comment → FhirMarkdown?
-
comment Any additional description of the service and/or any specific
issues not covered by the other attributes, which can be displayed as
further detail under the serviceName.
no setterinherited
- commentElement → Element?
-
commentElement ("_comment") Extensions for comment
no setterinherited
-
communication
→ List<
CodeableConcept> ? -
communication Some services are specifically made available in
multiple languages, this property permits a directory to declare the
languages this is offered in. Typically this is only provided where a
service operates in communities with mixed languages used.
no setterinherited
-
contact
→ List<
ExtendedContactDetail> ? -
contact The contact details of communication devices available
relevant to the specific HealthcareService. This can include
addresses, phone numbers, fax numbers, mobile numbers, email addresses
and web sites.
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, 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.
no setterinherited
-
copyWith
→ $HealthcareServiceCopyWith<
HealthcareService> -
no setterinherited
-
coverageArea
→ List<
Reference> ? -
coverageArea The location(s) that this service is available to (not
where the service is provided).
no setterinherited
- dbId → int?
-
no setterinherited
-
eligibility
→ List<
HealthcareServiceEligibility> ? -
eligibility Does this service have specific eligibility requirements
that need to be met in order to use the service?
no setterinherited
-
endpoint
→ List<
Reference> ? -
endpoint Technical endpoints providing access to services operated
for the specific healthcare services defined at this resource.
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
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.
no setterinherited
- extraDetails → FhirMarkdown?
-
extraDetails Extra details about the service that can't be placed in
the other fields.
no setterinherited
- extraDetailsElement → Element?
-
extraDetailsElement ("_extraDetails") Extensions for extraDetails
no setterinherited
- fhirId → FhirId?
-
id The logical id of the resource, as used in the URL for the
resource. Once assigned, this value never changes.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
identifier
→ List<
Identifier> ? -
identifier External identifiers for this item.
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 ("_implicitRules") Extensions for implicitRules
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement ("_language") Extensions for language
no setterinherited
-
location
→ List<
Reference> ? -
location The location(s) where this healthcare service may be
provided.
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 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).
no setterinherited
- name → String?
-
name Further description of the service as it would be presented to a
consumer while searching.
no setterinherited
- nameElement → Element?
-
nameElement ("_name") Extensions for name
no setterinherited
-
offeredIn
→ List<
Reference> ? -
offeredIn When the HealthcareService is representing a specific,
schedulable service, the availableIn property can refer to a generic
service.
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
- photo → Attachment?
-
photo If there is a photo/symbol associated with this
HealthcareService, it may be included here to facilitate quick
identification of the service in a list.
no setterinherited
-
program
→ List<
CodeableConcept> ? -
program Programs that this service is applicable to.
no setterinherited
- providedBy → Reference?
-
providedBy The organization that provides this healthcare service.
no setterinherited
-
referralMethod
→ List<
CodeableConcept> ? -
referralMethod Ways that the service accepts referrals, if this is
not provided then it is implied that no referral is required.
no setterinherited
- resourceType → R5ResourceType
-
resourceType This is a HealthcareService resource
no setterinherited
- resourceTypeString → String?
-
produce a string of the resourceType
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
serviceProvisionCode
→ List<
CodeableConcept> ? -
serviceProvisionCode The code(s) that detail the conditions under
which the healthcare service is available/offered.
no setterinherited
-
specialty
→ List<
CodeableConcept> ? -
specialty Collection of specialties handled by the Healthcare
service. This is more of a medical term.
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
-
type
→ List<
CodeableConcept> ? -
type The specific type of service that may be delivered or performed.
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
override
-
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