com.babylonhealth.lit.core.model

Type members

Classlikes

object Address extends CompanionFor[Address]
Companion:
class
@POJOBoilerplate
class Address(val id: Option[String], val use: Option[ADDRESS_USE], `type`: Option[ADDRESS_TYPE], val text: Option[String], val line: LitSeq[String], val city: Option[String], val state: Option[String], val period: Option[Period], val country: Option[String], val district: Option[String], val extension: LitSeq[Extension], val postalCode: Option[String], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for Address Type: An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

Base StructureDefinition for Address Type: An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
`type`
  • Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
city
  • The name of the city, town, suburb, village or other community or delivery center.
country
  • Country - a nation as commonly understood or generally accepted.
district
  • The name of the administrative area (county).
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
line
  • This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
period
  • Time period when address was/is in use.
postalCode
  • A postal code designating a region defined by the postal service.
state
  • Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).
text
  • Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.
use
  • The purpose of this address.
Constructor:

Introduces the fields use, type, text, line, city, state, period, country, district, postalCode.

Companion:
object
object Age extends CompanionFor[Age]
Companion:
class
@POJOBoilerplate
class Age(val id: Option[String], val unit: Option[String], val code: Option[Code], val value: Option[BigDecimal], val system: Option[UriStr], val extension: LitSeq[Extension], val comparator: Option[QUANTITY_COMPARATOR], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Quantity

Base StructureDefinition for Age Type: A duration of time during which an organism (or a process) has existed.

Base StructureDefinition for Age Type: A duration of time during which an organism (or a process) has existed.

Subclass of core.model.Quantity (Base StructureDefinition for Quantity Type: A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.)

Value parameters:
code
  • A computer processable form of the unit in some unit representation system.
comparator
  • How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
system
  • The identification of the system that provides the coded form of the unit.
unit
  • A human-readable form of the unit.
value
  • The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Constructor:

Inherits all params from parent.

Companion:
object
Companion:
class
@POJOBoilerplate
class Annotation(val id: Option[String], val time: Option[FHIRDateTime], val text: Markdown, val extension: LitSeq[Extension], val author: Option[AuthorChoice], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for Annotation Type: A text note which also contains information about who made the statement and when.

Base StructureDefinition for Annotation Type: A text note which also contains information about who made the statement and when.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
author
  • The individual responsible for making the annotation.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
text
  • The text of the annotation in markdown format.
time
  • Indicates when this particular annotation was made.
Constructor:

Introduces the fields time, text, author.

Companion:
object
Companion:
class
@POJOBoilerplate
class Attachment(val id: Option[String], val url: Option[UrlStr], val data: Option[Base64Binary], val size: Option[UnsignedInt], val hash: Option[Base64Binary], val title: Option[String], val language: Option[LANGUAGES], val creation: Option[FHIRDateTime], val extension: LitSeq[Extension], val contentType: Option[Code], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for Attachment Type: For referring to data content defined in other formats.

Base StructureDefinition for Attachment Type: For referring to data content defined in other formats.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
contentType
  • Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.
creation
  • The date that the attachment was first created.
data
  • The actual data of the attachment - a sequence of bytes, base64 encoded.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
hash
  • The calculated hash of the data using SHA-1. Represented using base64.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
language
  • The human language of the content. The value can be any valid value according to BCP 47.
size
  • The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
title
  • A label or set of text to display in place of the data.
url
  • A location where the data can be accessed.
Constructor:

Introduces the fields url, data, size, hash, title, language, creation, contentType.

Companion:
object
@POJOBoilerplate
class BackboneElement(val id: Option[String], val extension: LitSeq[Extension], val modifierExtension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for BackboneElement Type: Base definition for all elements that are defined inside a resource - but not those in a data type.

Base StructureDefinition for BackboneElement Type: Base definition for all elements that are defined inside a resource - but not those in a data type.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).
Constructor:

Introduces the fields modifierExtension.

Companion:
object
@POJOBoilerplate
class CodeableConcept(val id: Option[String], val text: Option[String], val coding: LitSeq[Coding], val extension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for CodeableConcept Type: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Base StructureDefinition for CodeableConcept Type: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
coding
  • A reference to a code defined by a terminology system.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
text
  • A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Constructor:

Introduces the fields text, coding.

Companion:
object
object Coding extends CompanionFor[Coding]
Companion:
class
@POJOBoilerplate
class Coding(val id: Option[String], val code: Option[Code], val system: Option[UriStr], val version: Option[String], val display: Option[String], val extension: LitSeq[Extension], val userSelected: Option[Boolean], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for Coding Type: A reference to a code defined by a terminology system.

Base StructureDefinition for Coding Type: A reference to a code defined by a terminology system.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
code
  • A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
display
  • A representation of the meaning of the code in the system, following the rules of the system.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
system
  • The identification of the code system that defines the meaning of the symbol in the code.
userSelected
  • Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
version
  • The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Constructor:

Introduces the fields code, system, version, display, userSelected.

Companion:
object
@POJOBoilerplate
class ContactDetail(val id: Option[String], val name: Option[String], val telecom: LitSeq[ContactPoint], val extension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for ContactDetail Type: Specifies contact information for a person or organization.

Base StructureDefinition for ContactDetail Type: Specifies contact information for a person or organization.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
name
  • The name of an individual to contact.
telecom
  • The contact details for the individual (if a name was provided) or the organization.
Constructor:

Introduces the fields name, telecom.

Companion:
object
Companion:
class
@POJOBoilerplate
class ContactPoint(val id: Option[String], val use: Option[CONTACT_POINT_USE], val rank: Option[PositiveInt], val value: Option[String], val system: Option[CONTACT_POINT_SYSTEM], val period: Option[Period], val extension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for ContactPoint Type: Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

Base StructureDefinition for ContactPoint Type: Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
period
  • Time period when the contact point was/is in use.
rank
  • Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
system
  • Telecommunications form for contact point - what communications system is required to make use of the contact.
use
  • Identifies the purpose for the contact point.
value
  • The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Constructor:

Introduces the fields use, rank, value, system, period.

Companion:
object
Companion:
class
@POJOBoilerplate
class Contributor(val id: Option[String], `type`: CONTRIBUTOR_TYPE, val name: String, val contact: LitSeq[ContactDetail], val extension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for Contributor Type: A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.

Base StructureDefinition for Contributor Type: A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
`type`
  • The type of contributor.
contact
  • Contact details to assist a user in finding and communicating with the contributor.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
name
  • The name of the individual or organization responsible for the contribution.
Constructor:

Introduces the fields type, name, contact.

Companion:
object
object Count extends CompanionFor[Count]
Companion:
class
@POJOBoilerplate
class Count(val id: Option[String], val unit: Option[String], val code: Option[Code], val value: Option[BigDecimal], val system: Option[UriStr], val extension: LitSeq[Extension], val comparator: Option[QUANTITY_COMPARATOR], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Quantity

Base StructureDefinition for Count Type: A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.

Base StructureDefinition for Count Type: A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.

Subclass of core.model.Quantity (Base StructureDefinition for Quantity Type: A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.)

Value parameters:
code
  • A computer processable form of the unit in some unit representation system.
comparator
  • How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
system
  • The identification of the system that provides the coded form of the unit.
unit
  • A human-readable form of the unit.
value
  • The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Constructor:

Inherits all params from parent.

Companion:
object
@POJOBoilerplate
class DataRequirement(val id: Option[String], `type`: ALL_TYPES, val limit: Option[PositiveInt], val profile: LitSeq[Canonical], val extension: LitSeq[Extension], val subject: Option[SubjectChoice], val mustSupport: LitSeq[String], val sort: LitSeq[Sort], val codeFilter: LitSeq[CodeFilter], val dateFilter: LitSeq[DateFilter], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for DataRequirement Type: Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.

Base StructureDefinition for DataRequirement Type: Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
`type`
  • The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
codeFilter
  • Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
dateFilter
  • Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
limit
  • Specifies a maximum number of results that are required (uses the _count search parameter).
mustSupport
  • Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).
profile
  • The profile of the required data, specified as the uri of the profile definition.
sort
  • Specifies the order of the results to be returned.
subject
  • The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
Constructor:

Introduces the fields type, limit, profile, subject, mustSupport, sort, codeFilter, dateFilter.

Companion:
object
Companion:
class
@POJOBoilerplate
class Distance(val id: Option[String], val unit: Option[String], val code: Option[Code], val value: Option[BigDecimal], val system: Option[UriStr], val extension: LitSeq[Extension], val comparator: Option[QUANTITY_COMPARATOR], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Quantity

Base StructureDefinition for Distance Type: A length - a value with a unit that is a physical distance.

Base StructureDefinition for Distance Type: A length - a value with a unit that is a physical distance.

Subclass of core.model.Quantity (Base StructureDefinition for Quantity Type: A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.)

Value parameters:
code
  • A computer processable form of the unit in some unit representation system.
comparator
  • How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
system
  • The identification of the system that provides the coded form of the unit.
unit
  • A human-readable form of the unit.
value
  • The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Constructor:

Inherits all params from parent.

Companion:
object
object Dosage extends CompanionFor[Dosage]
Companion:
class
@POJOBoilerplate
class Dosage(val id: Option[String], val text: Option[String], val site: Option[CodeableConcept], val route: Option[CodeableConcept], val timing: Option[Timing], val method: Option[CodeableConcept], val sequence: Option[Int], val extension: LitSeq[Extension], val asNeeded: Option[AsNeededChoice], val maxDosePerPeriod: Option[Ratio], val modifierExtension: LitSeq[Extension], val patientInstruction: Option[String], val maxDosePerLifetime: Option[Quantity], val additionalInstruction: LitSeq[CodeableConcept], val doseAndRate: LitSeq[DoseAndRate], val maxDosePerAdministration: Option[Quantity], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends BackboneElement

Base StructureDefinition for Dosage Type: Indicates how the medication is/was taken or should be taken by the patient.

Base StructureDefinition for Dosage Type: Indicates how the medication is/was taken or should be taken by the patient.

Subclass of core.model.BackboneElement (Base StructureDefinition for BackboneElement Type: Base definition for all elements that are defined inside a resource - but not those in a data type.)

Value parameters:
additionalInstruction
  • Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").
asNeeded
  • Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).
doseAndRate
  • The amount of medication administered.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
maxDosePerAdministration
  • Upper limit on medication per administration.
maxDosePerLifetime
  • Upper limit on medication per lifetime of the patient.
maxDosePerPeriod
  • Upper limit on medication per unit of time.
method
  • Technique for administering medication.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).
patientInstruction
  • Instructions in terms that are understood by the patient or consumer.
route
  • How drug should enter body.
sequence
  • Indicates the order in which the dosage instructions should be applied or interpreted.
site
  • Body site to administer to.
text
  • Free text dosage instructions e.g. SIG.
timing
  • When medication should be administered.
Constructor:

Introduces the fields text, site, route, timing, method, sequence, asNeeded, maxDosePerPeriod, patientInstruction, maxDosePerLifetime, additionalInstruction, doseAndRate, maxDosePerAdministration.

Companion:
object
Companion:
class
@POJOBoilerplate
class Duration(val id: Option[String], val unit: Option[String], val code: Option[Code], val value: Option[BigDecimal], val system: Option[UriStr], val extension: LitSeq[Extension], val comparator: Option[QUANTITY_COMPARATOR], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Quantity

Base StructureDefinition for Duration Type: A length of time.

Base StructureDefinition for Duration Type: A length of time.

Subclass of core.model.Quantity (Base StructureDefinition for Quantity Type: A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.)

Value parameters:
code
  • A computer processable form of the unit in some unit representation system.
comparator
  • How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
system
  • The identification of the system that provides the coded form of the unit.
unit
  • A human-readable form of the unit.
value
  • The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Constructor:

Inherits all params from parent.

Companion:
object
object Element extends CompanionFor[Element]
Companion:
class
@POJOBoilerplate
class Element(val id: Option[String], val extension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends FHIRObject

Base StructureDefinition for Element Type: Base definition for all elements in a resource.

Base StructureDefinition for Element Type: Base definition for all elements in a resource.

Value parameters:
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Constructor:

Introduces the fields id, extension.

Companion:
object
Companion:
class
@POJOBoilerplate
class Expression(val id: Option[String], val name: Option[Id], val language: EXPRESSION_LANGUAGE, val extension: LitSeq[Extension], val reference: Option[UriStr], val expression: Option[String], val description: Option[String], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for Expression Type: A expression that is evaluated in a specified context and returns a value. The context of use of the expression must specify the context in which the expression is evaluated, and how the result of the expression is used.

Base StructureDefinition for Expression Type: A expression that is evaluated in a specified context and returns a value. The context of use of the expression must specify the context in which the expression is evaluated, and how the result of the expression is used.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
description
  • A brief, natural language description of the condition that effectively communicates the intended semantics.
expression
  • An expression in the specified language that returns a value.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
language
  • The media type of the language for the expression.
name
  • A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.
reference
  • A URI that defines where the expression is found.
Constructor:

Introduces the fields name, language, reference, expression, description.

Companion:
object
Companion:
class
@POJOBoilerplate
class Extension(val id: Option[String], val url: String, val value: Option[ValueChoice], val extension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for Extension Type: Optional Extension Element - found in all resources.

Base StructureDefinition for Extension Type: Optional Extension Element - found in all resources.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
url
  • Source of the definition for the extension code - a logical name or a URL.
value
  • Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Constructor:

Introduces the fields url, value.

Companion:
object
Companion:
class
@POJOBoilerplate
class HumanName(val id: Option[String], val use: Option[NAME_USE], val text: Option[String], val given: LitSeq[String], val family: Option[String], val prefix: LitSeq[String], val suffix: LitSeq[String], val period: Option[Period], val extension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for HumanName Type: A human's name with the ability to identify parts and usage.

Base StructureDefinition for HumanName Type: A human's name with the ability to identify parts and usage.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
`given`
  • Given name.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
family
  • The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
period
  • Indicates the period of time when this name was valid for the named person.
prefix
  • Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
suffix
  • Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
text
  • Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.
use
  • Identifies the purpose for this name.
Constructor:

Introduces the fields use, text, given, family, prefix, suffix, period.

Companion:
object
Companion:
class
@POJOBoilerplate
class Identifier(val id: Option[String], val use: Option[IDENTIFIER_USE], `type`: Option[CodeableConcept], val value: Option[String], val system: Option[UriStr], val period: Option[Period], val assigner: Option[Reference], val extension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for Identifier Type: An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

Base StructureDefinition for Identifier Type: An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
`type`
  • A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
assigner
  • Organization that issued/manages the identifier.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
period
  • Time period during which identifier is/was valid for use.
system
  • Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
use
  • The purpose of this identifier.
value
  • The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Constructor:

Introduces the fields use, type, value, system, period, assigner.

Companion:
object
object Meta extends CompanionFor[Meta]
Companion:
class
@POJOBoilerplate
class Meta(val id: Option[String], val tag: LitSeq[Coding], val source: Option[UriStr], val profile: LitSeq[Canonical], val security: LitSeq[Coding], val extension: LitSeq[Extension], val versionId: Option[Id], val lastUpdated: Option[ZonedDateTime], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for Meta Type: The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Base StructureDefinition for Meta Type: The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
lastUpdated
  • When the resource last changed - e.g. when the version changed.
profile
security
  • Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
source
  • A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
tag
  • Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
versionId
  • The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
Constructor:

Introduces the fields tag, source, profile, security, versionId, lastUpdated.

Companion:
object
object Money extends CompanionFor[Money]
Companion:
class
@POJOBoilerplate
class Money(val id: Option[String], val value: Option[BigDecimal], val currency: Option[Code], val extension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for Money Type: An amount of economic utility in some recognized currency.

Base StructureDefinition for Money Type: An amount of economic utility in some recognized currency.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
currency
  • ISO 4217 Currency Code.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
value
  • Numerical value (with implicit precision).
Constructor:

Introduces the fields value, currency.

Companion:
object
@POJOBoilerplate
class ParameterDefinition(val id: Option[String], val use: OPERATION_PARAMETER_USE, val min: Option[Int], val max: Option[String], val name: Option[Code], `type`: ALL_TYPES, val profile: Option[Canonical], val extension: LitSeq[Extension], val documentation: Option[String], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for ParameterDefinition Type: The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.

Base StructureDefinition for ParameterDefinition Type: The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
`type`
  • The type of the parameter.
documentation
  • A brief discussion of what the parameter is for and how it is used by the module.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
max
  • The maximum number of times this element is permitted to appear in the request or response.
min
  • The minimum number of times this parameter SHALL appear in the request or response.
name
  • The name of the parameter used to allow access to the value of the parameter in evaluation contexts.
profile
  • If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.
use
  • Whether the parameter is input or output for the module.
Constructor:

Introduces the fields use, min, max, name, type, profile, documentation.

Companion:
object
object Period extends CompanionFor[Period]
Companion:
class
@POJOBoilerplate
class Period(val id: Option[String], val end: Option[FHIRDateTime], val start: Option[FHIRDateTime], val extension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for Period Type: A time period defined by a start and end date and optionally time.

Base StructureDefinition for Period Type: A time period defined by a start and end date and optionally time.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
end
  • The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
start
  • The start of the period. The boundary is inclusive.
Constructor:

Introduces the fields end, start.

Companion:
object
Companion:
class
@POJOBoilerplate
class Quantity(val id: Option[String], val unit: Option[String], val code: Option[Code], val value: Option[BigDecimal], val system: Option[UriStr], val extension: LitSeq[Extension], val comparator: Option[QUANTITY_COMPARATOR], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for Quantity Type: A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.

Base StructureDefinition for Quantity Type: A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
code
  • A computer processable form of the unit in some unit representation system.
comparator
  • How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
system
  • The identification of the system that provides the coded form of the unit.
unit
  • A human-readable form of the unit.
value
  • The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Constructor:

Introduces the fields unit, code, value, system, comparator.

Companion:
object
object Range extends CompanionFor[Range]
Companion:
class
@POJOBoilerplate
class Range(val id: Option[String], val low: Option[Quantity], val high: Option[Quantity], val extension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for Range Type: A set of ordered Quantities defined by a low and high limit.

Base StructureDefinition for Range Type: A set of ordered Quantities defined by a low and high limit.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
high
  • The high limit. The boundary is inclusive.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
low
  • The low limit. The boundary is inclusive.
Constructor:

Introduces the fields low, high.

Companion:
object
object Ratio extends CompanionFor[Ratio]
Companion:
class
@POJOBoilerplate
class Ratio(val id: Option[String], val extension: LitSeq[Extension], val numerator: Option[Quantity], val denominator: Option[Quantity], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for Ratio Type: A relationship of two Quantity values - expressed as a numerator and a denominator.

Base StructureDefinition for Ratio Type: A relationship of two Quantity values - expressed as a numerator and a denominator.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
denominator
  • The value of the denominator.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
numerator
  • The value of the numerator.
Constructor:

Introduces the fields numerator, denominator.

Companion:
object
Companion:
class
@POJOBoilerplate
class Reference(val id: Option[String], `type`: Option[UriStr], val display: Option[String], val extension: LitSeq[Extension], val reference: Option[String], val identifier: Option[Identifier], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for Reference Type: A reference from one resource to another.

Base StructureDefinition for Reference Type: A reference from one resource to another.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
`type`
  • The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
display
  • Plain text narrative that identifies the resource in addition to the resource reference.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
identifier
  • An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
reference
  • A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Constructor:

Introduces the fields type, display, reference, identifier.

Companion:
object
@POJOBoilerplate
class RelatedArtifact(val id: Option[String], val url: Option[UrlStr], `type`: RELATED_ARTIFACT_TYPE, val label: Option[String], val display: Option[String], val citation: Option[Markdown], val document: Option[Attachment], val resource: Option[Canonical], val extension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for RelatedArtifact Type: Related artifacts such as additional documentation, justification, or bibliographic references.

Base StructureDefinition for RelatedArtifact Type: Related artifacts such as additional documentation, justification, or bibliographic references.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
`type`
  • The type of relationship to the related artifact.
citation
  • A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
display
  • A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
document
  • The document being referenced, represented as an attachment. This is exclusive with the resource element.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
label
  • A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
resource
  • The related resource, such as a library, value set, profile, or other knowledge resource.
url
  • A url for the artifact that can be followed to access the actual content.
Constructor:

Introduces the fields url, type, label, display, citation, document, resource.

Companion:
object
Companion:
class
@POJOBoilerplate
class Resource(val id: Option[String], val meta: Option[Meta], val language: Option[LANGUAGES], val implicitRules: Option[UriStr], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends FHIRObject

This is the base resource type for everything.

This is the base resource type for everything.

Value parameters:
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
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.
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.
Constructor:

Introduces the fields id, meta, language, implicitRules.

Companion:
object
Companion:
class
@POJOBoilerplate
class SampledData(val id: Option[String], val data: Option[String], val origin: Quantity, val period: BigDecimal, val factor: Option[BigDecimal], val extension: LitSeq[Extension], val lowerLimit: Option[BigDecimal], val upperLimit: Option[BigDecimal], val dimensions: PositiveInt, val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for SampledData Type: A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.

Base StructureDefinition for SampledData Type: A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
data
  • A series of data points which are decimal values separated by a single space (character u20). The special values "E" (error), "L" (below detection limit) and "U" (above detection limit) can also be used in place of a decimal value.
dimensions
  • The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced
  • all the sample points for a point in time will be recorded at once.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
factor
  • A correction factor that is applied to the sampled data points before they are added to the origin.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
lowerLimit
  • The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).
origin
  • The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series.
period
  • The length of time between sampling times, measured in milliseconds.
upperLimit
  • The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).
Constructor:

Introduces the fields data, origin, period, factor, lowerLimit, upperLimit, dimensions.

Companion:
object
Companion:
class
@POJOBoilerplate
class Signature(val id: Option[String], val who: Reference, `type`: NonEmptyLitSeq[Coding], val when: ZonedDateTime, val data: Option[Base64Binary], val extension: LitSeq[Extension], val sigFormat: Option[Code], val onBehalfOf: Option[Reference], val targetFormat: Option[Code], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for Signature Type: A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.

Base StructureDefinition for Signature Type: A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
`type`
  • An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.
data
  • The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
onBehalfOf
  • A reference to an application-usable description of the identity that is represented by the signature.
sigFormat
  • A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.
targetFormat
  • A mime type that indicates the technical format of the target resources signed by the signature.
when
  • When the digital signature was signed.
who
  • A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).
Constructor:

Introduces the fields who, type, when, data, sigFormat, onBehalfOf, targetFormat.

Companion:
object
object Timing extends CompanionFor[Timing]
Companion:
class
@POJOBoilerplate
class Timing(val id: Option[String], val code: Option[CodeableConcept], val event: LitSeq[FHIRDateTime], val extension: LitSeq[Extension], val modifierExtension: LitSeq[Extension], val repeat: Option[Repeat], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends BackboneElement

Base StructureDefinition for Timing Type: Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.

Base StructureDefinition for Timing Type: Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.

Subclass of core.model.BackboneElement (Base StructureDefinition for BackboneElement Type: Base definition for all elements that are defined inside a resource - but not those in a data type.)

Value parameters:
code
  • A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).
event
  • Identifies specific times when the event occurs.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).
repeat
  • A set of rules that describe when the event is scheduled.
Constructor:

Introduces the fields code, event, repeat.

Companion:
object
@POJOBoilerplate
class TriggerDefinition(val id: Option[String], `type`: TRIGGER_TYPE, val name: Option[String], val data: LitSeq[DataRequirement], val extension: LitSeq[Extension], val timing: Option[TimingChoice], val condition: Option[Expression], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for TriggerDefinition Type: A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.

Base StructureDefinition for TriggerDefinition Type: A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
`type`
  • The type of triggering event.
condition
  • A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.
data
  • The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
name
  • A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.
timing
  • The timing of the event (if this is a periodic trigger).
Constructor:

Introduces the fields type, name, data, timing, condition.

Companion:
object
Companion:
class
@POJOBoilerplate
class UsageContext(val id: Option[String], val code: Coding, val value: ValueChoice, val extension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for UsageContext Type: Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).

Base StructureDefinition for UsageContext Type: Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
code
  • A code that identifies the type of context being specified by this usage context.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. 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.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
value
  • A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
Constructor:

Introduces the fields code, value.

Companion:
object

Value members

Concrete methods

def extractModuleFromNames(classNames: Seq[String]): Seq[ModuleDict]
def extractModuleFromPath(classPathResults: Seq[ClassInfo]): Seq[ModuleDict]

Concrete fields

val intSubSuffixes: Set[String]
lazy val resourceTypeLookup: Map[String, CompanionFor[_ <: FHIRObject]]
val stringSubSuffixes: Set[String]
val suffixTypeMap: Map[String, LightTypeTag]
lazy val urlLookup: Map[String, CompanionFor[_ <: FHIRObject]]

Deprecated fields

@deprecated("Use urlLookup or resourceTypeLookup")
lazy val companionLookup: Map[String, CompanionFor[_ <: FHIRObject]]
Deprecated
@deprecated("Use companionLookup or something...")
val localClasses: Seq[LightTypeTag]
Deprecated
@deprecated("REALLY SLOW")
val typeSuffixMap: LightTypeTag => Option[String]
Deprecated