HealthcareService constructor

const HealthcareService({ @Default(R4ResourceType.HealthcareService) @JsonKey(unknownEnumValue: R4ResourceType.HealthcareService) 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, List<Identifier>? identifier, FhirBoolean? active, @JsonKey(name: '_active') Element? activeElement, Reference? providedBy, List<CodeableConcept>? category, List<CodeableConcept>? type, List<CodeableConcept>? specialty, List<Reference>? location, String? name, @JsonKey(name: '_name') Element? nameElement, String? comment, @JsonKey(name: '_comment') Element? commentElement, FhirMarkdown? extraDetails, @JsonKey(name: '_extraDetails') Element? extraDetailsElement, Attachment? photo, List<ContactPoint>? telecom, 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<HealthcareServiceAvailableTime>? availableTime, List<HealthcareServiceNotAvailable>? notAvailable, String? availabilityExceptions, @JsonKey(name: '_availabilityExceptions') Element? availabilityExceptionsElement, List<Reference>? endpoint, })

HealthcareService The details of a healthcare service available at a location.

resourceType This is a HealthcareService 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).

identifier External identifiers for this item.

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.

activeElement Extensions for active

providedBy The organization that provides this healthcare service.

category Identifies the broad category of service being performed or delivered.

type The specific type of service that may be delivered or performed.

specialty Collection of specialties handled by the service site. This is more of a medical term.

location The location(s) where this healthcare service may be provided.

name Further description of the service as it would be presented to a consumer while searching.

nameElement Extensions for name

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.

commentElement Extensions for comment

extraDetails Extra details about the service that can't be placed in the other fields.

extraDetailsElement Extensions for extraDetails

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.

contact List of contacts related to this specific healthcare service.

coverageArea The location(s) that this service is available to (not where the service is provided).

serviceProvisionCode The code(s) that detail the conditions under which the healthcare service is available/offered.

eligibility Does this service have specific eligibility requirements that need to be met in order to use the service?

program Programs that this service is applicable to.

characteristic Collection of characteristics (attributes).

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.

referralMethod Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.

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.

appointmentRequiredElement Extensions for appointmentRequired

availableTime A collection of times that the Service Site is available.

notAvailable The HealthcareService is not available during this period of time due to the provided reason.

availabilityExceptions A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.

availabilityExceptionsElement Extensions for availabilityExceptions

endpoint Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.

Implementation

const factory HealthcareService({
  @Default(R4ResourceType.HealthcareService)
  @JsonKey(unknownEnumValue: R4ResourceType.HealthcareService)

  /// [resourceType] This is a HealthcareService 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,

  /// [identifier] External identifiers for this item.
  List<Identifier>? identifier,

  /// [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.
  FhirBoolean? active,

  /// [activeElement] Extensions for active
  @JsonKey(name: '_active') Element? activeElement,

  /// [providedBy] The organization that provides this healthcare service.
  Reference? providedBy,

  /// [category] Identifies the broad category of service being performed or
  ///  delivered.
  List<CodeableConcept>? category,

  /// [type] The specific type of service that may be delivered or performed.
  List<CodeableConcept>? type,

  /// [specialty] Collection of specialties handled by the service site. This
  ///  is more of a medical term.
  List<CodeableConcept>? specialty,

  /// [location] The location(s) where this healthcare service may be provided.
  List<Reference>? location,

  /// [name] Further description of the service as it would be presented to a
  ///  consumer while searching.
  String? name,

  /// [nameElement] Extensions for name
  @JsonKey(name: '_name') Element? nameElement,

  /// [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.
  String? comment,

  /// [commentElement] Extensions for comment
  @JsonKey(name: '_comment') Element? commentElement,

  /// [extraDetails] Extra details about the service that can't be placed in
  ///  the other fields.
  FhirMarkdown? extraDetails,

  /// [extraDetailsElement] Extensions for extraDetails
  @JsonKey(name: '_extraDetails') Element? extraDetailsElement,

  /// [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.
  Attachment? photo,

  /// [telecom] List of contacts related to this specific healthcare service.
  List<ContactPoint>? telecom,

  /// [coverageArea] The location(s) that this service is available to (not
  ///  where the service is provided).
  List<Reference>? coverageArea,

  /// [serviceProvisionCode] The code(s) that detail the conditions under which
  ///  the healthcare service is available/offered.
  List<CodeableConcept>? serviceProvisionCode,

  /// [eligibility] Does this service have specific eligibility requirements
  ///  that need to be met in order to use the service?
  List<HealthcareServiceEligibility>? eligibility,

  /// [program] Programs that this service is applicable to.
  List<CodeableConcept>? program,

  /// [characteristic] Collection of characteristics (attributes).
  List<CodeableConcept>? characteristic,

  /// [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.
  List<CodeableConcept>? communication,

  /// [referralMethod] Ways that the service accepts referrals, if this is not
  ///  provided then it is implied that no referral is required.
  List<CodeableConcept>? referralMethod,

  /// [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.
  FhirBoolean? appointmentRequired,

  /// [appointmentRequiredElement] Extensions for appointmentRequired
  @JsonKey(name: '_appointmentRequired') Element? appointmentRequiredElement,

  /// [availableTime] A collection of times that the Service Site is available.
  List<HealthcareServiceAvailableTime>? availableTime,

  /// [notAvailable] The HealthcareService is not available during this period
  ///  of time due to the provided reason.
  List<HealthcareServiceNotAvailable>? notAvailable,

  /// [availabilityExceptions] A description of site availability exceptions,
  /// e.g. public holiday availability. Succinctly describing all possible
  /// exceptions to normal site availability as details in the available Times
  ///  and not available Times.
  String? availabilityExceptions,
  @JsonKey(name: '_availabilityExceptions')

  /// [availabilityExceptionsElement] Extensions for availabilityExceptions
  Element? availabilityExceptionsElement,

  /// [endpoint] Technical endpoints providing access to services operated for
  ///  the specific healthcare services defined at this resource.
  List<Reference>? endpoint,
}) = _HealthcareService;