HealthcareService

class HealthcareService(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: LitSeq[CodeableConcept], val name: Option[String], val photo: Option[Attachment], val active: Option[Boolean], val comment: Option[String], val telecom: LitSeq[ContactPoint], val program: LitSeq[CodeableConcept], val language: Option[LANGUAGES], val category: LitSeq[CodeableConcept], val location: LitSeq[Reference], val endpoint: LitSeq[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val specialty: LitSeq[CodeableConcept], val identifier: LitSeq[Identifier], val providedBy: Option[Reference], val extraDetails: Option[Markdown], val coverageArea: LitSeq[Reference], val implicitRules: Option[UriStr], val communication: LitSeq[CodeableConcept], val characteristic: LitSeq[CodeableConcept], val referralMethod: LitSeq[CodeableConcept], val modifierExtension: LitSeq[Extension], val appointmentRequired: Option[Boolean], val serviceProvisionCode: LitSeq[CodeableConcept], val availabilityExceptions: Option[String], val eligibility: LitSeq[Eligibility], val notAvailable: LitSeq[NotAvailable], val availableTime: LitSeq[AvailableTime], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The details of a healthcare service available at a location.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • The specific type of service that may be delivered or performed.
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.
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.
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.
availableTime
  • A collection of times that the Service Site is available.
category
  • Identifies the broad category of service being performed or delivered.
characteristic
  • Collection of characteristics (attributes).
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.
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.
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.
coverageArea
  • The location(s) that this service is available to (not where the service is provided).
eligibility
  • Does this service have specific eligibility requirements that need to be met in order to use the service?
endpoint
  • Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.
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.
extraDetails
  • Extra details about the service that can't be placed in the other fields.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • External identifiers for this item.
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.
language
  • The base language in which the resource is written.
location
  • The location(s) where this healthcare service may be provided.
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.
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).
name
  • Further description of the service as it would be presented to a consumer while searching.
notAvailable
  • The HealthcareService is not available during this period of time due to the provided reason.
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.
program
  • Programs that this service is applicable to.
providedBy
  • The organization that provides this healthcare service.
referralMethod
  • Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.
serviceProvisionCode
  • The code(s) that detail the conditions under which the healthcare service is available/offered.
specialty
  • Collection of specialties handled by the service site. This is more of a medical term.
telecom
  • List of contacts related to this specific healthcare service.
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.
Constructor:

Introduces the fields type, name, photo, active, comment, telecom, program, category, location, endpoint, specialty, identifier, providedBy, extraDetails, coverageArea, communication, characteristic, referralMethod, appointmentRequired, serviceProvisionCode, availabilityExceptions, eligibility, notAvailable, availableTime.

Companion:
object
class Resource
class FHIRObject
trait FHIRComponent
trait Utils
class Object
trait Matchable
class Any

Type members

Inherited classlikes

object extensions
Inherited from:
FHIRObject
object ids
Inherited from:
FHIRObject

Inherited types

type FieldToElementLookup = TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
Inherited from:
FHIRObject

Value members

Inherited methods

final def >>[T](fn: T => T)(implicit tt: LTag[T]): FHIRObject.this.type

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_] or an Option[_]
  • It may require a type parameter sometimes (e.g. sampleResource >>[BUNDLE_TYPE] { (_: BUNDLE_TYPE) => BUNDLE_TYPE.SEARCHSET } )
Inherited from:
FHIRObject
final def >>=[T, F[_] : Monad](fn: T => F[T])(implicit evidence$7: Monad[F], tt: LTag[T]): F[FHIRObject]
Inherited from:
FHIRObject
final def ^^[From, To](fn: From => To)(implicit tt: LTag[From]): LitSeq[To]

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Inherited from:
FHIRObject
final def ^^^[T](implicit tt: LTag[T]): LitSeq[T]
Inherited from:
FHIRObject
def companionClassName[T](tag: LTag[T]): String
Inherited from:
Utils
def companionOf[T <: FHIRObject : ClassTag](implicit evidence$1: ClassTag[T], tag: LTag[T]): CompanionFor[T]
Inherited from:
Utils
def constructor: Constructor[_]
Inherited from:
FHIRComponent
def decodeMethodFor[T <: FHIRObject : ClassTag](implicit evidence$2: ClassTag[T], tag: LTag[T], params: DecoderParams): HCursor => Try[T]
Inherited from:
Utils
override def equals(obj: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters:
that

the object to compare against this object for equality.

Returns:

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def fields: Seq[FHIRComponentField[_]]
Inherited from:
FHIRObject
def getFieldByClass[T](name: String, clazz: Class[T]): LitSeq[T]
Inherited from:
FHIRComponent
def getFieldByType[T : LTag](name: String): LitSeq[T]
Inherited from:
FHIRComponent
def getIdentifier: Option[String]
Inherited from:
Resource
def getMostSpecificIdentifier: Option[String]
Inherited from:
Resource
def getVersionedIdentifier: Option[String]
Inherited from:
Resource
override def hashCode(): Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Returns:

the hash code value for this object.

Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def modifyField[T : LTag, Up >: HealthcareService <: FHIRObject](fieldName: String, modify: T => T)(implicit evidence$5: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def modifyFieldUnsafe[T, Up >: HealthcareService <: FHIRObject](fieldName: String, modify: T => T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
final def nodalExtract[From, To](klass: Class[From], fn: From => To): LitSeq[To]

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Inherited from:
FHIRObject
final def nodalGetByClass[Target](klass: Class[Target]): LitSeq[Target]

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Inherited from:
FHIRObject
final def nodalMap[T](klass: Class[T], fn: T => T): FHIRObject.this.type

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_], an Option[_], or any 'subtyped' type (eg PositiveInt). You should ensure, if T is a supertype of multiple valid choice values (e.g. T =:= Object), that the return value of fn retains the same type as the input value.
Inherited from:
FHIRObject
def setFromField[T, UpType >: HealthcareService <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(newVal: T): UpType
Inherited from:
FHIRObject
def thisClassName: String
Inherited from:
FHIRObject
def toClass[T](klass: Class[T]): Option[T]
Inherited from:
FHIRObject
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Returns:

a string representation of the object.

Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def toType[T](implicit ct: ClassTag[T]): Option[T]
Inherited from:
FHIRObject
def updateFromField[T, UpType >: HealthcareService <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(fn: T => T): UpType
Inherited from:
FHIRObject
def updatePrimitiveAttributes(fn: FieldToElementLookup => FieldToElementLookup): FHIRObject.this.type
Inherited from:
FHIRObject
def withField[T : LTag, Up >: HealthcareService <: FHIRObject](fieldName: String, value: T)(implicit evidence$6: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFieldUnsafe[T, Up >: HealthcareService <: FHIRObject](fieldName: String, value: T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFields[Up >: HealthcareService <: FHIRObject](replacementFields: (String, Any)*)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withPrimitiveAttributes(a: FieldToElementLookup): FHIRObject.this.type
Inherited from:
FHIRObject

Concrete fields

val `type`: LitSeq[CodeableConcept]
val active: Option[Boolean]
val appointmentRequired: Option[Boolean]
val availabilityExceptions: Option[String]
val category: LitSeq[CodeableConcept]
val characteristic: LitSeq[CodeableConcept]
val comment: Option[String]
val communication: LitSeq[CodeableConcept]
override val contained: LitSeq[Resource]
val coverageArea: LitSeq[Reference]
val endpoint: LitSeq[Reference]
override val extension: LitSeq[Extension]
val extraDetails: Option[Markdown]
override val id: Option[String]
val identifier: LitSeq[Identifier]
override val implicitRules: Option[UriStr]
override val language: Option[LANGUAGES]
val location: LitSeq[Reference]
override val meta: Option[Meta]
override val modifierExtension: LitSeq[Extension]
val name: Option[String]
val photo: Option[Attachment]
override val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
val program: LitSeq[CodeableConcept]
val providedBy: Option[Reference]
val referralMethod: LitSeq[CodeableConcept]
val serviceProvisionCode: LitSeq[CodeableConcept]
val specialty: LitSeq[CodeableConcept]
val telecom: LitSeq[ContactPoint]
override val text: Option[Narrative]
override val thisTypeName: String

Inherited fields

val companion: CompanionFor[HealthcareService]
Inherited from:
FHIRObject