All Classes and Interfaces
Class
Description
A financial tool for tracking value accrued for a particular purpose.
This resource allows for the definition of some activity to be performed,
independent of a particular patient, practitioner, or other performance
context.
An address expressed using postal conventions (as opposed to GPS or other
location definition formats).
Actual or potential/avoided event causing unintended physical injury
resulting from or contributed to by medical care, a research study or other
healthcare setting factors that requires additional monitoring, treatment, or
hospitalization, or that results in death.
A duration of time during which an organism (or a process) has existed.
Risk of harmful or undesirable, physiological response which is unique to an
individual and associated with exposure to a substance.
A text note which also contains information about who made the statement and
when.
A booking of a healthcare event among patient(s), practitioner(s), related
person(s) and/or device(s) for a specific date/time.
A reply to an appointment request for a patient and/or practitioner(s), such
as a confirmation or rejection.
For referring to data content defined in other formats.
A record of an event made for purposes of maintaining a security log.
Base definition for all elements that are defined inside a resource - but not
those in a data type.
Base definition for all elements that are defined inside a resource - but not
those in a data type.
Primitive type "base64Binary" in FHIR: a sequence of bytes represented in
base64
Basic is used for handling concepts not yet defined in FHIR, narrative-only
resources that don't map to an existing resource, and custom resources not
appropriate for inclusion in the FHIR specification.
A resource that represents the data of a single raw artifact as digital
content accessible in its native format.
A material substance originating from a biological entity intended to be
transplanted or infused into another (possibly the same) biological entity.
Record details about an anatomical structure.
Primitive type "boolean" in FHIR "true" or "false"
A container for a collection of resources.
This manages a cached list of resources, and provides high speed access by
URL / URL+version, and assumes that patch version doesn't matter for access
note, though, that not all resources have semver versions
Primitive type "canonical" in FHIR: an OID represented as
urn:oid:0.1.2.3.4...
A Capability Statement documents a set of capabilities (behaviors) of a FHIR
Server for a particular version of FHIR that may be used as a statement of
actual server functionality or a statement of required or desired server
implementation.
Describes the intention of how one or more practitioners intend to deliver
care for a particular patient, group or community for a period of time,
possibly limited to care for a specific condition or set of conditions.
The Care Team includes all the people and organizations who plan to
participate in the coordination and delivery of care for a patient.
Catalog entries are wrappers that contextualize items included in a catalog.
The resource ChargeItem describes the provision of healthcare provider
products for a certain patient, therefore referring not only to the product,
but containing in addition details of the provision, like date, time, amounts
and participating organizations and persons.
The ChargeItemDefinition resource provides the properties that apply to the
(billing) codes necessary to calculate costs and prices.
A provider issued list of professional services and products which have been
provided, or are to be provided, to a patient which is sent to an insurer for
reimbursement.
This resource provides the adjudication details from the processing of a
Claim resource.
Generic Implementation of Client Headers.
A record of a clinical assessment performed to determine what problem(s) may
affect the patient and before planning the treatments or management
strategies that are best to manage a patient's condition.
A concept that may be defined by a formal reference to a terminology or
ontology or may be provided by text.
The CodeSystem resource is used to declare the existence of and describe a
code system or code system supplement and its key properties, and optionally
define a part or all of its content.
Primitive type "code" in FHIR, when not bound to an enumerated list of codes
A reference to a code defined by a terminology system.
An occurrence of information being transmitted; e.g.
A request to convey information; e.g.
See http://www.healthintersections.com.au/?p=1941
A compartment definition that defines how resources are accessed on a server.
A set of healthcare-related information that is assembled together into a
single logical package that provides a single coherent statement of meaning,
establishes its own context and that has clinical attestation with regard to
who is making the statement.
A statement of relationships from one set of concepts to one or more other
concepts - either concepts in code systems, or data element/data element
concepts, or classes in class models.
A clinical condition, problem, diagnosis, or other event, situation, issue,
or clinical concept that has risen to a level of concern.
This class is created to help implementers deal with a change to the API that
was made between versions 0.81 and 0.9
The change is the behaviour of the .getX() where the cardinality of x is 0..1
or 1..1.
A record of a healthcare consumer?s choices, which permits or denies
identified recipient(s) or recipient role(s) to perform one or more actions
within a given policy context, for specific purposes and periods of time.
Specifies contact information for a person or organization.
Details for all kinds of technology mediated contact points for a person or
organization, including telephone, email, etc.
Legally enforceable, formally recorded unilateral or bilateral directive
i.e., a policy or agreement.
A contributor to the content of a knowledge asset, including authors,
editors, reviewers, and endorsers.
A measured amount (or an amount that can potentially be measured).
Financial instrument which may be used to reimburse or pay for health care
products and services.
The CoverageEligibilityRequest provides patient and insurance coverage
information to an insurer for them to respond, in the form of an
CoverageEligibilityResponse, with information regarding whether the stated
coverage is valid and in-force and optionally to provide the insurance
details of the policy.
This resource provides eligibility and plan details from the processing of an
CoverageEligibilityRequest resource.
Describes a required data item for evaluation in terms of the type of data,
and optional code or date-based filters of the data.
Represents a FHIR dateTime datatype.
Represents a FHIR date datatype.
Primitive type "decimal" in FHIR: A rational number
Indicates an actual or potential clinical issue with or between one or more
active or proposed clinical actions for a patient; e.g.
A type of a manufactured item that is used in the provision of healthcare
without being substantially changed through that activity.
The characteristics, operational status and capabilities of a medical-related
component of a medical device.
Describes a measurement, calculation or setting capability of a medical
device.
Represents a request for a patient to employ a medical device.
A record of a device being used by a patient where the record is the result
of a report from the patient or another clinician.
The findings and interpretation of diagnostic tests performed on patients,
groups of patients, devices, and locations, and/or specimens derived from
these.
A length - a value with a unit that is a physical distance.
A collection of documents compiled for a purpose together with metadata that
applies to the collection.
A reference to a document of any kind for any purpose.
A resource that includes narrative, extensions, and contained resources.
Indicates how the medication is/was taken or should be taken by the patient.
A length of time.
The EffectEvidenceSynthesis resource describes the difference in an outcome
between exposures states in a population where the effect estimate is derived
from a combination of research studies.
FHIR client exception.
This class represents the underlying reference model of FHIR
A resource is nothing but a set of elements, where every element has a name,
maybe a stated type, maybe an id, and either a value or child elements (one
or the other, but not both or neither)
Base definition for all elements in a resource.
Captures constraints on each element within the resource, profile, or
extension.
An interaction between a patient and healthcare provider(s) for the purpose
of providing healthcare service(s) or assessing the health status of a
patient.
The technical details of an endpoint that can be used for electronic
services, such as for web services providing XDS.b or a REST endpoint for
another FHIR server.
This resource provides the insurance enrollment details to the insurer
regarding a specified coverage.
This resource provides enrollment and plan details from the processing of an
EnrollmentRequest resource.
Primitive type "code" in FHIR, where the code is tied to an enumerated list
of possible values
Helper class to help manage generic enumerated types
An association between a patient and an organization / healthcare provider(s)
during which time encounters may occur.
The EventDefinition resource provides a reusable description of when a
particular event can occur.
The Evidence resource describes the conditional state (population and any
exposures being compared within the population) and outcome (if specified)
that the knowledge (evidence, assertion, recommendation) is about.
The EvidenceVariable resource describes a "PICO" element that knowledge
(evidence, assertion, recommendation) is about.
Example of workflow instance.
This resource provides: the claim details; adjudication details from the
processing of a Claim; and optionally account balance information, for
informing the subscriber of the benefits provided.
A expression that is evaluated in a specified context and returns a value.
Optional Extension Element - found in all resources.
in a language with helper classes, this would be a helper class (at least,
the base exgtension helpers would be)
Significant health conditions for a person related to the patient relevant in
the context of care for the patient.
This enumreation is special, and hand crafted.
Very Simple RESTful client.
Prospective warnings of potential issues when providing care to the patient.
Describes the intended objective(s) for a patient, group or organization
care, for example, weight loss, restoring an activity of daily living,
obtaining herd immunity via immunization, meeting a process improvement
objective, etc.
A formal computable definition of a graph of resources - that is, a coherent
set of resources that form a graph by following references.
Represents a defined collection of entities that may be discussed or acted
upon collectively but which are not expected to act collectively, and are not
formally or legally recognized; i.e.
A guidance response is the formal response to a guidance request, including
any output parameters returned by the evaluation, as well as the description
of any proposed actions to be taken.
The details of a healthcare service available at a location.
A human's name with the ability to identify parts and usage.
An identifier - identifies some entity uniquely and unambiguously.
This class represents the logical identity for a resource, or as much of that
identity is known.
Representation of the content produced in a DICOM imaging study.
Describes the event of a patient being administered a vaccine or a record of
an immunization as reported by a patient, a clinician or another party.
Describes a comparison of an immunization event against published
recommendations to determine if the administration is "valid" in relation to
those recommendations.
A patient's point-in-time set of recommendations (i.e.
A set of rules of how a particular interoperability or standards problem is
solved - typically through the use of FHIR resources.
Represents a FHIR instant datatype.
Details of a Health Insurance product/plan provided by an organization.
Primitive type "integer" in FHIR: A signed 32-bit integer
Invoice containing collected ChargeItems from an Account with calculated
individual and total price for Billing purpose.
General interface - either an XML or JSON parser: read or write instances
Defined to allow a factory to create a parser of the right type
Interface to the instance validator.
The value set system has a collection of value sets that define code systems,
and construct value sets from them
Large external terminologies - LOINC, Snomed, etc - are too big, and trying
to represent their definition as a native value set is too large.
This is the standard interface used for access to underlying FHIR services
through the tools and utilities provided by the reference implementation.
Facade to GSON writer, or something that imposes property ordering first
A little implementation of a json write to replace Gson ....
General parser for JSON content.
The Library resource is a general-purpose container for knowledge asset
definitions.
Identifies two or more records (resource instances) that refer to the same
real-world "occurrence".
A list is a curated collection of resources.
Details and position information for a physical place where services are
provided and resources and participants may be stored, found, contained, or
accommodated.
This class converts the LOINC XML representation that the FHIR build tool
uses internally to a set of DataElements in an atom feed
Primitive type "code" in FHIR, when not bound to an enumerated list of codes
The marketing status describes the date when a medicinal product is actually
put on the market or the date as of which it is no longer available.
The Measure resource provides the definition of a quality measure.
The MeasureReport resource contains the results of the calculation of a
measure; and optionally a reference to the resources involved in that
calculation.
A photo, video, or audio recording acquired or used in healthcare.
This resource is primarily used for the identification and definition of a
medication for the purposes of prescribing, dispensing, and administering a
medication as well as for making statements about medication use.
Describes the event of a patient consuming or otherwise being administered a
medication.
Indicates that a medication product is to be or has been dispensed for a
named person/patient.
Information about a medication that is used to support knowledge.
An order or request for both supply of the medication and the instructions
for administration of the medication to a patient.
A record of a medication that is being consumed by a patient.
Detailed definition of a medicinal product, typically for uses other than
direct patient care (e.g.
The regulatory authorization of a medicinal product.
The clinical particulars - indications, contraindications etc.
Indication for the Medicinal Product.
An ingredient of a manufactured item or pharmaceutical product.
The interactions of the medicinal product with other medicinal products, or
other forms of interactions.
The manufactured item as contained in the packaged medicinal product.
A medicinal product in a container or package.
A pharmaceutical product described in terms of its composition and dose form.
Describe the undesirable effects of the medicinal product.
Defines the characteristics of a message that can be shared between systems,
including the type of event that initiates the message, the content to be
transmitted and what response(s), if any, are permitted.
The header for a message exchange that is either requesting or responding to
an action.
The metadata about a resource.
Common Ancestor declaration for conformance and knowledge artifact resources.
Raw data describing a biological sequence.
An amount of economic utility in some recognized currency.
A measured amount (or an amount that can potentially be measured).
A curated namespace that issues unique symbols within that namespace for the
identification of concepts, people, devices, etc.
A human-readable summary of the resource conveying the essential clinical and
business information for the resource.
A request to supply a diet, formula feeding (enteral) or oral nutritional
supplement to a patient/resident.
Measurements and simple assertions made about a patient, device or other
subject.
Set of definitional characteristics for a kind of observation or measurement
produced or consumed by an orderable health care service.
Primitive type "oid" in FHIR: an OID represented as urn:oid:0.1.2.3.4...
A formal computable definition of an operation (on the RESTful interface) or
a named query (using the search interaction).
A collection of error, warning, or information messages that result from a
system action.
A formally or informally recognized grouping of people or organizations
formed for the purpose of achieving some form of collective action.
Defines an affiliation/assotiation/relationship between 2 distinct
oganizations, that is not a part-of relationship/sub-division relationship.
The parameters to the module.
This resource is a non-persisted resource used to pass information into and
back from an [operation](operations.html).
Used to take an overload dump from tx.fhir.org and turn it into a parameters resource
Used in factory methods for parsers, for requesting a parser of a particular
type (see IWorkerContext)
Demographics and other administrative information about an individual or
animal receiving care or other health-related services.
This resource provides the status of the payment for goods and services
rendered, and the request and response resource references.
This resource provides the details including amount of a payment and
allocates the payment items being paid.
Factory class for the ProfiledElement sub-system
*** NOTE: This sub-system is still under development ***
This subsystem takes a profile and creates a view of the profile that stitches
all the parts together, and presents it as a seamless tree.
This class provides a profile centric view of a resource, as driven by a profile
This class is also suitable to be used as the base of a POJO
A time period defined by a start and end date and optionally time.
Demographics and administrative information about a person independent of a
specific health-related context.
This resource allows for the definition of various types of plans as a
sharable, consumable, and executable artifact.
A populatioof people with some set of grouping criteria.
Primitive type "integer" in FHIR: A signed 32-bit integer
A person who is directly or indirectly involved in the provisioning of
healthcare.
A specific set of Roles/Locations/specialties/services that a practitioner
may perform at an organization for a period of time.
An action that is or was performed on or for a patient.
The marketing status describes the date when a medicinal product is actually
put on the market or the date as of which it is no longer available.
The shelf-life and storage information for a medicinal product item or
container can be described using this class.
A engine that generates difference analysis between two sets of structure
definitions, typically from 2 different implementation guides.
This class provides a set of utility operations for working with Profiles.
This class is the base class for Profile classes - whether generated or
manual
A child element or property defined by the FHIR specification This class is
defined as a helper class when iterating the children of an element in a
generic fashion
At present, iteration is only based on the specification, but this may be
changed to allow profile based expression at a later date
note: there's no point in creating one of these classes outside this package
Provenance of a resource is a record that describes entities and processes
involved in producing and delivering or otherwise influencing that resource.
A measured amount (or an amount that can potentially be measured).
A structured set of questions intended to guide the collection of answers
from end-users.
This class takes a profile, and builds a questionnaire from it
If you then convert this questionnaire to a form using the XMLTools form
builder, and then take the QuestionnaireResponse this creates, you can use
QuestionnaireInstanceConvert to build an instance the conforms to the profile
FHIR context: conceptLocator, codeSystems, valueSets, maps, client, profiles
You don"t have to provide any of these, but the more you provide, the better
the conversion will be
A structured set of questions and their answers.
A set of ordered Quantities defined by a low and high limit.
A relationship of two Quantity values - expressed as a numerator and a
denominator.
A reference from one resource to another.
Related artifacts such as additional documentation, justification, or
bibliographic references.
Information about a person that is involved in the care for a patient, but
who is not the target of healthcare, nor has a formal responsibility in the
care process.
A group of related requests that can be used to capture intended activities
that have inter-dependencies such as "give this medication after that one".
The ResearchDefinition resource describes the conditional state (population
and any exposures being compared within the population) and outcome (if
specified) that the knowledge (evidence, assertion, recommendation) is about.
The ResearchElementDefinition resource describes a "PICO" element that
knowledge (evidence, assertion, recommendation) is about.
A process where a researcher or organization plans and then executes a series
of steps intended to increase the field of healthcare-related knowledge.
A physical entity which is the primary unit of operational and/or
administrative interest in a study.
This is the base resource type for everything.
Helper class to manage FHIR Resource URIs
Enumeration for preferred FHIR resource formats.
Decoration utilities for various resource types
An
Interceptor for OkHttpClient that controls the
number of times we retry a to execute a given request, before reporting a
failure.An assessment of the likely outcome(s) for a patient or other subject as well
as the likelihood of each outcome.
The RiskEvidenceSynthesis resource describes the likelihood of an outcome in
a population plus exposure state where the risk estimate is derived from a
combination of research studies.
A series of measurements taken by a device, with upper and lower limits.
A container for slots of time that may be available for booking appointments.
A search parameter that defines a named search item that can be used to
search/filter on a resource.
A record of a request for service such as diagnostic investigations,
treatments, or operations to be performed.
A signature along with supporting context.
A measured amount (or an amount that can potentially be measured).
A slot of time on a schedule that may be available for booking appointments.
A sample to be used for analysis.
A kind of specimen with associated set of requirements.
Primitive type "string" in FHIR - any sequence of unicode characters less
than 1MB in length
A definition of a FHIR structure.
A Map of relationships between 2 structures that can be used to transform
data.
Services in this class:
string render(map) - take a structure and convert it to text map parse(text)
- take a text representation and parse it getTargetType(map) - return the
definition for the type to create to hand in transform(appInfo, source, map,
target) - transform from source to target following the map analyse(appInfo,
map) - generate profiles and other analysis artifacts for the targets of the
transform map generateMapFromMappings(StructureDefinition) - build a mapping
from a structure definition with logical mappings
The subscription resource is used to define a push-based subscription from a
server to another system.
A homogeneous material with a definite composition.
Chemical substances are a single substance type whose primary defining
element is the molecular structure.
Nucleic acids are defined by three distinct elements: the base, sugar and
linkage.
Todo.
A SubstanceProtein is defined as a single unit of a linear amino acid
sequence, or a combination of subunits that are either covalently linked or
have a defined invariant stoichiometric relationship.
Todo.
Source material shall capture information on the taxonomic and anatomical
origins as well as the fraction of a material that can result in or can be
modified to form a substance.
The detailed description of a substance, typically at a level beyond what is
used for prescribing.
Record of delivery of what is supplied.
A record of a request for a medication, substance or device used in the
healthcare setting.
A task to be performed.
This implements a two level cache.
A TerminologyCapabilities resource documents a set of capabilities
(behaviors) of a FHIR Terminology Server that may be used as a statement of
actual server functionality or a statement of required or desired server
implementation.
A summary of information based on the results of executing a TestScript.
A structured set of tests against a FHIR server or client implementation to
determine compliance against the FHIR specification.
Represents a Time datatype, per the FHIR specification.
Specifies an event that may occur multiple times.
A description of a triggering event.
An element that is a type.
Primitive type "integer" in FHIR: A signed 32-bit integer
Primitive type "uri" in FHIR: any valid URI.
Primitive type "url" in FHIR: an OID represented as urn:oid:0.1.2.3.4...
Specifies clinical/business/etc.
A ValueSet resource instance specifies a set of codes drawn from one or more
code systems, intended for use in a particular context.
Some value sets are just too big to expand.
Describes validation requirements, source(s), status and dates for one or
more elements.
this is the version of the library, as opposed to the version of FHIR
This class provides special support for parsing v2 by the v2 logical model
For the logical model, see the FHIRPath spec
An authorization for the provision of glasses and/or contact lenses to a
patient.
General parser for XML content.