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.
The ActorDefinition resource is used to describe an actor - a human or an application that plays a role in data exchange, and that may have obligations associated with the role the actor plays.
Address Type: An address expressed using postal conventions (as opposed to GPS or other location definition formats).
A medicinal product in the final form which is suitable for administering to a patient (after any mixing of multiple components, dissolution etc.
An event (i.e.
Age Type: 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.
Annotation Type: 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.
This Resource provides one or more comments, classifiers or ratings about a Resource and supports attribution and rights management metadata for the added content.
Attachment Type: For referring to data content defined in other formats.
A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.
Availability Type: Availability data for an {item}.
BackboneElement Type: Base definition for all elements that are defined inside a resource - but not those in a data type.
BackboneType Type: Base definition for the few data types that are allowed to carry modifier extensions.
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 biological material originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.
A record of dispensation of a biologically derived product.
Record details about an anatomical structure.
Primitive type "boolean" in FHIR "true" or "false"
A container for a collection of resources.
Common Interface declaration for conformance and knowledge artifact 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 or Client 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.
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.
The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution.
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 single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.
CodeableConcept Type: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
CodeableReference Type: A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).
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.
For special code systems where the code system resource isn't enough, but we can support them internall
Usually, small grammar based code systems
Primitive type "code" in FHIR, when not bound to an enumerated list of codes
Coding Type: A reference to a code defined by a terminology system.
A clinical or business level record of information being transmitted or shared; 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.
A definition of a condition and information relevant to managing it.
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 or choices made on their behalf by a third party, 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.
ContactDetail Type: Specifies contact information for a person or organization.
ContactPoint Type: 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.
Contributor Type: A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.
Count Type: 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.
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.
DataType Type: The base class for all re-useable types defined as part of the FHIR Specification.
Represents a FHIR dateTime datatype.
Represents a FHIR date datatype.
Primitive type "decimal" in FHIR: A rational number
A pattern to be followed by resources that represent a specific proposal, plan and/or order for some sort of action or service.
Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g.
This resource describes the properties (regulated, has real time clock, etc.), adminstrative (manufacturer name, model number, serial number, firmware, etc.), and type (knee replacement, blood pressure cuff, MRI, etc.) of a physical unit (these values do not change much within a given module, for example the serail number, manufacturer name, and model number).
A record of association of a device.
This is a specialized resource that defines the characteristics and capabilities of a device.
Indicates that a device is to be or has been dispensed for a named person/patient.
Describes a measurement, calculation or setting capability of a device.
Represents a request a device to be provided to a specific patient.
A record of a device being used by a patient where the record is the result of a report from the patient or a clinician.
The findings and interpretation of diagnostic tests performed on patients, groups of patients, products, substances, devices, and locations, and/or specimens derived from these.
Distance Type: A length - a value with a unit that is a physical distance.
A reference to a document of any kind for any purpose.
A resource that includes narrative, extensions, and contained resources.
Dosage Type: Indicates how the medication is/was taken or should be taken by the patient.
Duration Type: A length of time.
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)
Element Type: Base definition for all elements in a resource.
ElementDefinition Type: Captures constraints on each element within the resource, profile, or extension.
An interaction between healthcare provider(s), and/or patient(s) for the purpose of providing healthcare service(s) or assessing the health status of patient(s).
A record of significant events/milestones key data throughout the history of an Encounter
The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b, a REST endpoint for another FHIR server, or a s/Mime email address.
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.
A pattern to be followed by resources that represent the performance of some activity, possibly in accordance with a request or service definition.
The EventDefinition resource provides a reusable description of when a particular event can occur.
The Evidence Resource provides a machine-interpretable expression of an evidence concept including the evidence variables (e.g., population, exposures/interventions, comparators, outcomes, measured variables, confounding variables), the statistics, and the certainty of this evidence.
The EvidenceReport Resource is a specialized container for a collection of resources and codeable concepts, adapted to support compositions of Evidence, EvidenceVariable, and Citation resources and related concepts.
The EvidenceVariable resource describes an element that knowledge (Evidence) is about.
A walkthrough of a workflow showing the interaction between systems and the instances shared, possibly including the evolution of instances over time.
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.
Expression Type: A expression that is evaluated in a specified context and returns a value.
Deprecated.
This interface only exists to provide backward compatibility for the following two projects:
clinical-reasoning
clinical_quality-language
Due to a circular dependency, they cannot be updated without a release of HAPI, which requires backwards
compatibility with core version 6.1.2.2
ExtendedContactDetail Type: Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization.
Extension Type: 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.
Deprecated.
This interface only exists to provide backward compatibility for the following two projects:
clinical-reasoning
clinical_quality-language
Due to a circular dependency, they cannot be updated without a release of HAPI, which requires backwards
compatibility with core version 6.1.2.2
Very Simple RESTful client.
Who What When Where Why - Common pattern for all resources that deals with attribution.
Prospective warnings of potential issues when providing care to the patient.
This resource describes a product or service that is available through a program and includes the conditions and constraints of availability.
A set of analyses performed to analyze and generate genomic data.
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 or in a catalog.
HumanName Type: A name, normally of a human, that can be used for other living entities (e.g.
Identifier Type: 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.
A selection of DICOM SOP instances and/or frames within a single Study and Series.
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.
An ingredient of a manufactured item or pharmaceutical product.
Represents a FHIR instant datatype.
Details of a Health Insurance product/plan provided by an organization.
Primitive type "integer64" in FHIR: A signed 64-bit integer
Primitive type "integer" in FHIR: A signed 32-bit integer
functional description of an inventory item used in inventory and supply-related workflows.
A report of inventory or stock items.
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.
This is the standard interface used for access to underlying FHIR
services through the tools and utilities provided by the reference
implementation.
Deprecated, for removal: This API element is subject to removal in a future version.
This interface only exists to provide backward compatibility for the following two projects:
clinical-reasoning
clinical_quality-language
Due to a circular dependency, they cannot be updated without a release of HAPI, which requires backwards
compatibility with core version 6.1.2.2
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.
This clas smaps between the jurisdictions defined for CanonicalResource.jurisdiction
and Java Locale
in here:
* generateTranslations
* importFromTranslations
* stripTranslations
* switchLanguage
in the validator
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, for things such as problem lists, allergy lists, facility list, organization list, etc.
Details and position information for a place where services are provided and resources and participants may be stored, found, contained, or accommodated.
The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product.
Primitive type "code" in FHIR, when not bound to an enumerated list of codes
MarketingStatus Type: 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.
This resource is primarily used for the identification and definition of a medication, including ingredients, 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.
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.
Meta Type: The metadata about a resource.
Common Interface declaration for conformance and knowledge artifact resources.
Representation of a molecular sequence.
MonetaryComponent Type: Availability data for an {item}.
Money Type: 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.
Narrative Type: A human-readable summary of the resource conveying the essential clinical and business information for the resource.
A record of food or fluid that is being consumed by a patient.
A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
A food or supplement that is consumed by patients.
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.
Base StructureDefinition for OrderedDistribution Type: An ordered list (distribution) of statistics.
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 organizations, that is not a part-of relationship/sub-division relationship.
A medically related item or items, in a container or package.
ParameterDefinition Type: The parameters to the module.
This resource is used to pass information into and back from an operation (whether invoked directly from REST or within a messaging environment).
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.
The easiest way to generate code is to use the FHIR Validator, which can generate java classes for profiles
using this code.
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
Period Type: A time period defined by a start and end date and optionally time.
Permission resource holds access rules for a given data and context.
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.
Primitive type "integer" in FHIR: A signed 32-bit integer
A person who is directly or indirectly involved in the provisioning of healthcare or related services.
A specific set of Roles/Locations/specialties/services that a practitioner may perform, or has performed at an organization during a period of time.
An action that is or was performed on or for a patient, practitioner, device, organization, or location.
Base StructureDefinition for ProdCharacteristic Type: 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.
ProductShelfLife Type: The shelf-life and storage information for a medicinal product item or container can be described using this class.
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.
Quantity Type: 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.
Range Type: A set of ordered Quantities defined by a low and high limit.
Ratio Type: A relationship of two Quantity values - expressed as a numerator and a denominator.
RatioRange Type: A range of ratios expressed as a low and high numerator and a denominator.
Reference Type: A reference from one resource to another.
Regulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity that is cited in a guidance, regulation, rule or legislative act.
RelatedArtifact Type: Related artifacts such as additional documentation, justification, or bibliographic references.
Information about a person that is involved in a patient's health or the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.
Rendering framework:
* boolean render(DomainResource) : produce an HTML representation suitable for runtime / documentation, and insert it into the resource.
Managing Language when rendering
You can specify a language to use when rendering resources by setting the setLocale() on
the super class.
What kind of user the renderer is targeting - end users, or technical users
This affects the way codes and references are rendered
A pattern to be followed by resources that represent a specific proposal, plan and/or order for some sort of action or service.
A set of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".
The Requirements resource is used to describe an actor - a human or an application that plays a role in data exchange, and that may have obligations associated with the role the actor plays.
A scientific study of nature that sometimes includes processes involved in health and disease.
A ResearchSubject is a participant or object which is the recipient of investigative activities in a research 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
This class is used to walk through the resources when rendering, whether
the resource is a native resource or loaded by the element model
This class is used to walk through the resources when rendering, whether
the resource is a native resource or loaded by the element model
This class is used to walk through the resources when rendering, whether
the resource is a native resource or loaded by the element model
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.
SampledData Type: 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.
this class is actually a smart health cards validator.
this class is actually a smart health link retreiver.
Signature Type: 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.
Base StructureDefinition for Statistic Type: A fact or piece of data from a study of a large quantity of numerical data.
Primitive type "string" in FHIR - any sequence of unicode characters less than 1MB in length
A definition of a FHIR structure.
This works around known issues in struture definitions
A Map of relationships between 2 structures that can be used to transform data.
Services in this class:
The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.
The SubscriptionStatus resource describes the state of a Subscription during notifications.
Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic.
A homogeneous material with a definite composition.
Base StructureDefinition for SubstanceAmount Type: Chemical substances are a single substance type whose primary defining element is the molecular structure.
The detailed description of a substance, typically at a level beyond what is used for prescribing.
Nucleic acids are defined by three distinct elements: the base, sugar and linkage.
Properties of a substance specific to it being a polymer.
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.
Record of delivery of what is supplied.
A record of a non-patient specific request for a medication, substance, device, certain types of biologically derived product, and nutrition product 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 plan for executing testing on an artifact or specifications
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.
Timing Type: Specifies an event that may occur multiple times.
Record of transport.
TriggerDefinition Type: A description of a triggering event.
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...
UsageContext Type: Specifies clinical/business/etc.
When the validator is calling validateCode, it typically has a partially loaded resource that may provide
additional resources that are relevant to the validation.
A list of resources that provide context - typically, a container resource, and a bundle resource.
String value is always provided, and a more specific value may also be provided
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
VirtualServiceDetail Type: Virtual Service Contact Details.
An authorization for the provision of glasses and/or contact lenses to a patient.
General parser for XML content.