Package com.ibm.fhir.model.type.code

Class FHIRDefinedType

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class FHIRDefinedType
extends Code

    • Field Detail

      • ADDRESS

        public static final FHIRDefinedType ADDRESS
        Address

        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.

      • AGE

        public static final FHIRDefinedType AGE
        Age

        A duration of time during which an organism (or a process) has existed.

      • ANNOTATION

        public static final FHIRDefinedType ANNOTATION
        Annotation

        A text note which also contains information about who made the statement and when.

      • ATTACHMENT

        public static final FHIRDefinedType ATTACHMENT
        Attachment

        For referring to data content defined in other formats.

      • BACKBONE_ELEMENT

        public static final FHIRDefinedType BACKBONE_ELEMENT
        BackboneElement

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

      • CODEABLE_CONCEPT

        public static final FHIRDefinedType CODEABLE_CONCEPT
        CodeableConcept

        A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

      • CODING

        public static final FHIRDefinedType CODING
        Coding

        A reference to a code defined by a terminology system.

      • CONTACT_DETAIL

        public static final FHIRDefinedType CONTACT_DETAIL
        ContactDetail

        Specifies contact information for a person or organization.

      • CONTACT_POINT

        public static final FHIRDefinedType CONTACT_POINT
        ContactPoint

        Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

      • CONTRIBUTOR

        public static final FHIRDefinedType CONTRIBUTOR
        Contributor

        A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.

      • COUNT

        public static final FHIRDefinedType COUNT
        Count

        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.

      • DATA_REQUIREMENT

        public static final FHIRDefinedType DATA_REQUIREMENT
        DataRequirement

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

      • DISTANCE

        public static final FHIRDefinedType DISTANCE
        Distance

        A length - a value with a unit that is a physical distance.

      • DOSAGE

        public static final FHIRDefinedType DOSAGE
        Dosage

        Indicates how the medication is/was taken or should be taken by the patient.

      • DURATION

        public static final FHIRDefinedType DURATION
        Duration

        A length of time.

      • ELEMENT

        public static final FHIRDefinedType ELEMENT
        Element

        Base definition for all elements in a resource.

      • ELEMENT_DEFINITION

        public static final FHIRDefinedType ELEMENT_DEFINITION
        ElementDefinition

        Captures constraints on each element within the resource, profile, or extension.

      • EXPRESSION

        public static final FHIRDefinedType EXPRESSION
        Expression

        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.

      • EXTENSION

        public static final FHIRDefinedType EXTENSION
        Extension

        Optional Extension Element - found in all resources.

      • HUMAN_NAME

        public static final FHIRDefinedType HUMAN_NAME
        HumanName

        A human's name with the ability to identify parts and usage.

      • IDENTIFIER

        public static final FHIRDefinedType IDENTIFIER
        Identifier

        An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

      • MARKETING_STATUS

        public static final FHIRDefinedType MARKETING_STATUS
        MarketingStatus

        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.

      • META

        public static final FHIRDefinedType META
        Meta

        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.

      • MONEY

        public static final FHIRDefinedType MONEY
        Money

        An amount of economic utility in some recognized currency.

      • MONEY_QUANTITY

        public static final FHIRDefinedType MONEY_QUANTITY
        MoneyQuantity

      • NARRATIVE

        public static final FHIRDefinedType NARRATIVE
        Narrative

        A human-readable summary of the resource conveying the essential clinical and business information for the resource.

      • PARAMETER_DEFINITION

        public static final FHIRDefinedType PARAMETER_DEFINITION
        ParameterDefinition

        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.

      • PERIOD

        public static final FHIRDefinedType PERIOD
        Period

        A time period defined by a start and end date and optionally time.

      • POPULATION

        public static final FHIRDefinedType POPULATION
        Population

        A populatioof people with some set of grouping criteria.

      • PROD_CHARACTERISTIC

        public static final FHIRDefinedType PROD_CHARACTERISTIC
        ProdCharacteristic

        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.

      • PRODUCT_SHELF_LIFE

        public static final FHIRDefinedType PRODUCT_SHELF_LIFE
        ProductShelfLife

        The shelf-life and storage information for a medicinal product item or container can be described using this class.

      • QUANTITY

        public static final FHIRDefinedType QUANTITY
        Quantity

        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.

      • RANGE

        public static final FHIRDefinedType RANGE
        Range

        A set of ordered Quantities defined by a low and high limit.

      • RATIO

        public static final FHIRDefinedType RATIO
        Ratio

        A relationship of two Quantity values - expressed as a numerator and a denominator.

      • REFERENCE

        public static final FHIRDefinedType REFERENCE
        Reference

        A reference from one resource to another.

      • RELATED_ARTIFACT

        public static final FHIRDefinedType RELATED_ARTIFACT
        RelatedArtifact

        Related artifacts such as additional documentation, justification, or bibliographic references.

      • SAMPLED_DATA

        public static final FHIRDefinedType SAMPLED_DATA
        SampledData

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

      • SIGNATURE

        public static final FHIRDefinedType SIGNATURE
        Signature

        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.

      • SIMPLE_QUANTITY

        public static final FHIRDefinedType SIMPLE_QUANTITY
        SimpleQuantity

      • SUBSTANCE_AMOUNT

        public static final FHIRDefinedType SUBSTANCE_AMOUNT
        SubstanceAmount

        Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID.

      • TIMING

        public static final FHIRDefinedType TIMING
        Timing

        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.

      • TRIGGER_DEFINITION

        public static final FHIRDefinedType TRIGGER_DEFINITION
        TriggerDefinition

        A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.

      • USAGE_CONTEXT

        public static final FHIRDefinedType USAGE_CONTEXT
        UsageContext

        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).

      • BASE64BINARY

        public static final FHIRDefinedType BASE64BINARY
        base64Binary

        A stream of bytes

      • BOOLEAN

        public static final FHIRDefinedType BOOLEAN
        boolean

        Value of "true" or "false"

      • CANONICAL

        public static final FHIRDefinedType CANONICAL
        canonical

        A URI that is a reference to a canonical URL on a FHIR resource

      • CODE

        public static final FHIRDefinedType CODE
        code

        A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

      • DATE

        public static final FHIRDefinedType DATE
        date

        A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates.

      • DATE_TIME

        public static final FHIRDefinedType DATE_TIME
        dateTime

        A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.

      • DECIMAL

        public static final FHIRDefinedType DECIMAL
        decimal

        A rational number with implicit precision

      • ID

        public static final FHIRDefinedType ID
        id

        Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

      • INSTANT

        public static final FHIRDefinedType INSTANT
        instant

        An instant in time - known at least to the second

      • INTEGER

        public static final FHIRDefinedType INTEGER
        integer

        A whole number

      • MARKDOWN

        public static final FHIRDefinedType MARKDOWN
        markdown

        A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine

      • OID

        public static final FHIRDefinedType OID
        oid

        An OID represented as a URI

      • POSITIVE_INT

        public static final FHIRDefinedType POSITIVE_INT
        positiveInt

        An integer with a value that is positive (e.g. >0)

      • STRING

        public static final FHIRDefinedType STRING
        string

        A sequence of Unicode characters

      • TIME

        public static final FHIRDefinedType TIME
        time

        A time during the day, with no date specified

      • UNSIGNED_INT

        public static final FHIRDefinedType UNSIGNED_INT
        unsignedInt

        An integer with a value that is not negative (e.g. >= 0)

      • URI

        public static final FHIRDefinedType URI
        uri

        String of characters used to identify a name or a resource

      • URL

        public static final FHIRDefinedType URL
        url

        A URI that is a literal reference

      • UUID

        public static final FHIRDefinedType UUID
        uuid

        A UUID, represented as a URI

      • XHTML

        public static final FHIRDefinedType XHTML
        XHTML

        XHTML format, as defined by W3C, but restricted usage (mainly, no active content)

      • ACCOUNT

        public static final FHIRDefinedType ACCOUNT
        Account

        A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.

      • ACTIVITY_DEFINITION

        public static final FHIRDefinedType ACTIVITY_DEFINITION
        ActivityDefinition

        This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.

      • ADVERSE_EVENT

        public static final FHIRDefinedType ADVERSE_EVENT
        AdverseEvent

        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.

      • ALLERGY_INTOLERANCE

        public static final FHIRDefinedType ALLERGY_INTOLERANCE
        AllergyIntolerance

        Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

      • APPOINTMENT

        public static final FHIRDefinedType APPOINTMENT
        Appointment

        A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

      • APPOINTMENT_RESPONSE

        public static final FHIRDefinedType APPOINTMENT_RESPONSE
        AppointmentResponse

        A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.

      • AUDIT_EVENT

        public static final FHIRDefinedType AUDIT_EVENT
        AuditEvent

        A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.

      • BASIC

        public static final FHIRDefinedType BASIC
        Basic

        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.

      • BINARY

        public static final FHIRDefinedType BINARY
        Binary

        A resource that represents the data of a single raw artifact as digital content accessible in its native format. A Binary resource can contain any content, whether text, image, pdf, zip archive, etc.

      • BIOLOGICALLY_DERIVED_PRODUCT

        public static final FHIRDefinedType BIOLOGICALLY_DERIVED_PRODUCT
        BiologicallyDerivedProduct

        A material substance originating from a biological entity intended to be transplanted or infused

        into another (possibly the same) biological entity.

      • BODY_STRUCTURE

        public static final FHIRDefinedType BODY_STRUCTURE
        BodyStructure

        Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.

      • BUNDLE

        public static final FHIRDefinedType BUNDLE
        Bundle

        A container for a collection of resources.

      • CAPABILITY_STATEMENT

        public static final FHIRDefinedType CAPABILITY_STATEMENT
        CapabilityStatement

        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.

      • CARE_PLAN

        public static final FHIRDefinedType CARE_PLAN
        CarePlan

        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.

      • CARE_TEAM

        public static final FHIRDefinedType CARE_TEAM
        CareTeam

        The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.

      • CATALOG_ENTRY

        public static final FHIRDefinedType CATALOG_ENTRY
        CatalogEntry

        Catalog entries are wrappers that contextualize items included in a catalog.

      • CHARGE_ITEM

        public static final FHIRDefinedType CHARGE_ITEM
        ChargeItem

        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. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.

      • CHARGE_ITEM_DEFINITION

        public static final FHIRDefinedType CHARGE_ITEM_DEFINITION
        ChargeItemDefinition

        The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.

      • CLAIM

        public static final FHIRDefinedType CLAIM
        Claim

        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.

      • CLAIM_RESPONSE

        public static final FHIRDefinedType CLAIM_RESPONSE
        ClaimResponse

        This resource provides the adjudication details from the processing of a Claim resource.

      • CLINICAL_IMPRESSION

        public static final FHIRDefinedType CLINICAL_IMPRESSION
        ClinicalImpression

        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. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.

      • CODE_SYSTEM

        public static final FHIRDefinedType CODE_SYSTEM
        CodeSystem

        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.

      • COMMUNICATION

        public static final FHIRDefinedType COMMUNICATION
        Communication

        An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.

      • COMMUNICATION_REQUEST

        public static final FHIRDefinedType COMMUNICATION_REQUEST
        CommunicationRequest

        A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

      • COMPARTMENT_DEFINITION

        public static final FHIRDefinedType COMPARTMENT_DEFINITION
        CompartmentDefinition

        A compartment definition that defines how resources are accessed on a server.

      • COMPOSITION

        public static final FHIRDefinedType COMPOSITION
        Composition

        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 Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).

      • CONCEPT_MAP

        public static final FHIRDefinedType CONCEPT_MAP
        ConceptMap

        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.

      • CONDITION

        public static final FHIRDefinedType CONDITION
        Condition

        A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.

      • CONSENT

        public static final FHIRDefinedType CONSENT
        Consent

        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.

      • CONTRACT

        public static final FHIRDefinedType CONTRACT
        Contract

        Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.

      • COVERAGE

        public static final FHIRDefinedType COVERAGE
        Coverage

        Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.

      • COVERAGE_ELIGIBILITY_REQUEST

        public static final FHIRDefinedType COVERAGE_ELIGIBILITY_REQUEST
        CoverageEligibilityRequest

        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.

      • COVERAGE_ELIGIBILITY_RESPONSE

        public static final FHIRDefinedType COVERAGE_ELIGIBILITY_RESPONSE
        CoverageEligibilityResponse

        This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.

      • DETECTED_ISSUE

        public static final FHIRDefinedType DETECTED_ISSUE
        DetectedIssue

        Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.

      • DEVICE

        public static final FHIRDefinedType DEVICE
        Device

        A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.

      • DEVICE_DEFINITION

        public static final FHIRDefinedType DEVICE_DEFINITION
        DeviceDefinition

        The characteristics, operational status and capabilities of a medical-related component of a medical device.

      • DEVICE_METRIC

        public static final FHIRDefinedType DEVICE_METRIC
        DeviceMetric

        Describes a measurement, calculation or setting capability of a medical device.

      • DEVICE_REQUEST

        public static final FHIRDefinedType DEVICE_REQUEST
        DeviceRequest

        Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.

      • DEVICE_USE_STATEMENT

        public static final FHIRDefinedType DEVICE_USE_STATEMENT
        DeviceUseStatement

        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.

      • DIAGNOSTIC_REPORT

        public static final FHIRDefinedType DIAGNOSTIC_REPORT
        DiagnosticReport

        The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.

      • DOCUMENT_MANIFEST

        public static final FHIRDefinedType DOCUMENT_MANIFEST
        DocumentManifest

        A collection of documents compiled for a purpose together with metadata that applies to the collection.

      • DOCUMENT_REFERENCE

        public static final FHIRDefinedType DOCUMENT_REFERENCE
        DocumentReference

        A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.

      • DOMAIN_RESOURCE

        public static final FHIRDefinedType DOMAIN_RESOURCE
        DomainResource

        A resource that includes narrative, extensions, and contained resources.

      • EFFECT_EVIDENCE_SYNTHESIS

        public static final FHIRDefinedType EFFECT_EVIDENCE_SYNTHESIS
        EffectEvidenceSynthesis

        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.

      • ENCOUNTER

        public static final FHIRDefinedType ENCOUNTER
        Encounter

        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.

      • ENDPOINT

        public static final FHIRDefinedType ENDPOINT
        Endpoint

        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 may include any security context information.

      • ENROLLMENT_REQUEST

        public static final FHIRDefinedType ENROLLMENT_REQUEST
        EnrollmentRequest

        This resource provides the insurance enrollment details to the insurer regarding a specified coverage.

      • ENROLLMENT_RESPONSE

        public static final FHIRDefinedType ENROLLMENT_RESPONSE
        EnrollmentResponse

        This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.

      • EPISODE_OF_CARE

        public static final FHIRDefinedType EPISODE_OF_CARE
        EpisodeOfCare

        An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.

      • EVENT_DEFINITION

        public static final FHIRDefinedType EVENT_DEFINITION
        EventDefinition

        The EventDefinition resource provides a reusable description of when a particular event can occur.

      • EVIDENCE

        public static final FHIRDefinedType EVIDENCE
        Evidence

        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.

      • EVIDENCE_VARIABLE

        public static final FHIRDefinedType EVIDENCE_VARIABLE
        EvidenceVariable

        The EvidenceVariable resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.

      • EXAMPLE_SCENARIO

        public static final FHIRDefinedType EXAMPLE_SCENARIO
        ExampleScenario

        Example of workflow instance.

      • EXPLANATION_OF_BENEFIT

        public static final FHIRDefinedType EXPLANATION_OF_BENEFIT
        ExplanationOfBenefit

        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.

      • FAMILY_MEMBER_HISTORY

        public static final FHIRDefinedType FAMILY_MEMBER_HISTORY
        FamilyMemberHistory

        Significant health conditions for a person related to the patient relevant in the context of care for the patient.

      • FLAG

        public static final FHIRDefinedType FLAG
        Flag

        Prospective warnings of potential issues when providing care to the patient.

      • GOAL

        public static final FHIRDefinedType GOAL
        Goal

        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.

      • GRAPH_DEFINITION

        public static final FHIRDefinedType GRAPH_DEFINITION
        GraphDefinition

        A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.

      • GROUP

        public static final FHIRDefinedType GROUP
        Group

        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 collection of entities that isn't an Organization.

      • GUIDANCE_RESPONSE

        public static final FHIRDefinedType GUIDANCE_RESPONSE
        GuidanceResponse

        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.

      • HEALTHCARE_SERVICE

        public static final FHIRDefinedType HEALTHCARE_SERVICE
        HealthcareService

        The details of a healthcare service available at a location.

      • IMAGING_STUDY

        public static final FHIRDefinedType IMAGING_STUDY
        ImagingStudy

        Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.

      • IMMUNIZATION

        public static final FHIRDefinedType IMMUNIZATION
        Immunization

        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.

      • IMMUNIZATION_EVALUATION

        public static final FHIRDefinedType IMMUNIZATION_EVALUATION
        ImmunizationEvaluation

        Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations.

      • IMMUNIZATION_RECOMMENDATION

        public static final FHIRDefinedType IMMUNIZATION_RECOMMENDATION
        ImmunizationRecommendation

        A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.

      • IMPLEMENTATION_GUIDE

        public static final FHIRDefinedType IMPLEMENTATION_GUIDE
        ImplementationGuide

        A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.

      • INSURANCE_PLAN

        public static final FHIRDefinedType INSURANCE_PLAN
        InsurancePlan

        Details of a Health Insurance product/plan provided by an organization.

      • INVOICE

        public static final FHIRDefinedType INVOICE
        Invoice

        Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.

      • LIBRARY

        public static final FHIRDefinedType LIBRARY
        Library

        The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.

      • LINKAGE

        public static final FHIRDefinedType LINKAGE
        Linkage

        Identifies two or more records (resource instances) that refer to the same real-world "occurrence".

      • LIST

        public static final FHIRDefinedType LIST
        List

        A list is a curated collection of resources.

      • LOCATION

        public static final FHIRDefinedType LOCATION
        Location

        Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

      • MEASURE

        public static final FHIRDefinedType MEASURE
        Measure

        The Measure resource provides the definition of a quality measure.

      • MEASURE_REPORT

        public static final FHIRDefinedType MEASURE_REPORT
        MeasureReport

        The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.

      • MEDIA

        public static final FHIRDefinedType MEDIA
        Media

        A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.

      • MEDICATION

        public static final FHIRDefinedType MEDICATION
        Medication

        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.

      • MEDICATION_ADMINISTRATION

        public static final FHIRDefinedType MEDICATION_ADMINISTRATION
        MedicationAdministration

        Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.

      • MEDICATION_DISPENSE

        public static final FHIRDefinedType MEDICATION_DISPENSE
        MedicationDispense

        Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.

      • MEDICATION_KNOWLEDGE

        public static final FHIRDefinedType MEDICATION_KNOWLEDGE
        MedicationKnowledge

        Information about a medication that is used to support knowledge.

      • MEDICATION_REQUEST

        public static final FHIRDefinedType MEDICATION_REQUEST
        MedicationRequest

        An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.

      • MEDICATION_STATEMENT

        public static final FHIRDefinedType MEDICATION_STATEMENT
        MedicationStatement

        A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains.

        The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.

      • MEDICINAL_PRODUCT

        public static final FHIRDefinedType MEDICINAL_PRODUCT
        MedicinalProduct

        Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).

      • MEDICINAL_PRODUCT_AUTHORIZATION

        public static final FHIRDefinedType MEDICINAL_PRODUCT_AUTHORIZATION
        MedicinalProductAuthorization

        The regulatory authorization of a medicinal product.

      • MEDICINAL_PRODUCT_CONTRAINDICATION

        public static final FHIRDefinedType MEDICINAL_PRODUCT_CONTRAINDICATION
        MedicinalProductContraindication

        The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.

      • MEDICINAL_PRODUCT_INDICATION

        public static final FHIRDefinedType MEDICINAL_PRODUCT_INDICATION
        MedicinalProductIndication

        Indication for the Medicinal Product.

      • MEDICINAL_PRODUCT_INGREDIENT

        public static final FHIRDefinedType MEDICINAL_PRODUCT_INGREDIENT
        MedicinalProductIngredient

        An ingredient of a manufactured item or pharmaceutical product.

      • MEDICINAL_PRODUCT_INTERACTION

        public static final FHIRDefinedType MEDICINAL_PRODUCT_INTERACTION
        MedicinalProductInteraction

        The interactions of the medicinal product with other medicinal products, or other forms of interactions.

      • MEDICINAL_PRODUCT_MANUFACTURED

        public static final FHIRDefinedType MEDICINAL_PRODUCT_MANUFACTURED
        MedicinalProductManufactured

        The manufactured item as contained in the packaged medicinal product.

      • MEDICINAL_PRODUCT_PACKAGED

        public static final FHIRDefinedType MEDICINAL_PRODUCT_PACKAGED
        MedicinalProductPackaged

        A medicinal product in a container or package.

      • MEDICINAL_PRODUCT_PHARMACEUTICAL

        public static final FHIRDefinedType MEDICINAL_PRODUCT_PHARMACEUTICAL
        MedicinalProductPharmaceutical

        A pharmaceutical product described in terms of its composition and dose form.

      • MEDICINAL_PRODUCT_UNDESIRABLE_EFFECT

        public static final FHIRDefinedType MEDICINAL_PRODUCT_UNDESIRABLE_EFFECT
        MedicinalProductUndesirableEffect

        Describe the undesirable effects of the medicinal product.

      • MESSAGE_DEFINITION

        public static final FHIRDefinedType MESSAGE_DEFINITION
        MessageDefinition

        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.

      • MESSAGE_HEADER

        public static final FHIRDefinedType MESSAGE_HEADER
        MessageHeader

        The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.

      • MOLECULAR_SEQUENCE

        public static final FHIRDefinedType MOLECULAR_SEQUENCE
        MolecularSequence

        Raw data describing a biological sequence.

      • NAMING_SYSTEM

        public static final FHIRDefinedType NAMING_SYSTEM
        NamingSystem

        A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.

      • NUTRITION_ORDER

        public static final FHIRDefinedType NUTRITION_ORDER
        NutritionOrder

        A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.

      • OBSERVATION

        public static final FHIRDefinedType OBSERVATION
        Observation

        Measurements and simple assertions made about a patient, device or other subject.

      • OBSERVATION_DEFINITION

        public static final FHIRDefinedType OBSERVATION_DEFINITION
        ObservationDefinition

        Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.

      • OPERATION_DEFINITION

        public static final FHIRDefinedType OPERATION_DEFINITION
        OperationDefinition

        A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).

      • OPERATION_OUTCOME

        public static final FHIRDefinedType OPERATION_OUTCOME
        OperationOutcome

        A collection of error, warning, or information messages that result from a system action.

      • ORGANIZATION

        public static final FHIRDefinedType ORGANIZATION
        Organization

        A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

      • ORGANIZATION_AFFILIATION

        public static final FHIRDefinedType ORGANIZATION_AFFILIATION
        OrganizationAffiliation

        Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.

      • PARAMETERS

        public static final FHIRDefinedType PARAMETERS
        Parameters

        This resource is a non-persisted resource used to pass information into and back from an [operation](operations. html). It has no other use, and there is no RESTful endpoint associated with it.

      • PATIENT

        public static final FHIRDefinedType PATIENT
        Patient

        Demographics and other administrative information about an individual or animal receiving care or other health- related services.

      • PAYMENT_NOTICE

        public static final FHIRDefinedType PAYMENT_NOTICE
        PaymentNotice

        This resource provides the status of the payment for goods and services rendered, and the request and response resource references.

      • PAYMENT_RECONCILIATION

        public static final FHIRDefinedType PAYMENT_RECONCILIATION
        PaymentReconciliation

        This resource provides the details including amount of a payment and allocates the payment items being paid.

      • PERSON

        public static final FHIRDefinedType PERSON
        Person

        Demographics and administrative information about a person independent of a specific health-related context.

      • PLAN_DEFINITION

        public static final FHIRDefinedType PLAN_DEFINITION
        PlanDefinition

        This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.

      • PRACTITIONER

        public static final FHIRDefinedType PRACTITIONER
        Practitioner

        A person who is directly or indirectly involved in the provisioning of healthcare.

      • PRACTITIONER_ROLE

        public static final FHIRDefinedType PRACTITIONER_ROLE
        PractitionerRole

        A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

      • PROCEDURE

        public static final FHIRDefinedType PROCEDURE
        Procedure

        An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.

      • PROVENANCE

        public static final FHIRDefinedType PROVENANCE
        Provenance

        Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.

      • QUESTIONNAIRE

        public static final FHIRDefinedType QUESTIONNAIRE
        Questionnaire

        A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.

      • QUESTIONNAIRE_RESPONSE

        public static final FHIRDefinedType QUESTIONNAIRE_RESPONSE
        QuestionnaireResponse

        A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.

      • RELATED_PERSON

        public static final FHIRDefinedType RELATED_PERSON
        RelatedPerson

        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.

      • REQUEST_GROUP

        public static final FHIRDefinedType REQUEST_GROUP
        RequestGroup

        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".

      • RESEARCH_DEFINITION

        public static final FHIRDefinedType RESEARCH_DEFINITION
        ResearchDefinition

        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.

      • RESEARCH_ELEMENT_DEFINITION

        public static final FHIRDefinedType RESEARCH_ELEMENT_DEFINITION
        ResearchElementDefinition

        The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.

      • RESEARCH_STUDY

        public static final FHIRDefinedType RESEARCH_STUDY
        ResearchStudy

        A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.

      • RESEARCH_SUBJECT

        public static final FHIRDefinedType RESEARCH_SUBJECT
        ResearchSubject

        A physical entity which is the primary unit of operational and/or administrative interest in a study.

      • RESOURCE

        public static final FHIRDefinedType RESOURCE
        Resource

        This is the base resource type for everything.

      • RISK_ASSESSMENT

        public static final FHIRDefinedType RISK_ASSESSMENT
        RiskAssessment

        An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.

      • RISK_EVIDENCE_SYNTHESIS

        public static final FHIRDefinedType RISK_EVIDENCE_SYNTHESIS
        RiskEvidenceSynthesis

        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.

      • SCHEDULE

        public static final FHIRDefinedType SCHEDULE
        Schedule

        A container for slots of time that may be available for booking appointments.

      • SEARCH_PARAMETER

        public static final FHIRDefinedType SEARCH_PARAMETER
        SearchParameter

        A search parameter that defines a named search item that can be used to search/filter on a resource.

      • SERVICE_REQUEST

        public static final FHIRDefinedType SERVICE_REQUEST
        ServiceRequest

        A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.

      • SLOT

        public static final FHIRDefinedType SLOT
        Slot

        A slot of time on a schedule that may be available for booking appointments.

      • SPECIMEN

        public static final FHIRDefinedType SPECIMEN
        Specimen

        A sample to be used for analysis.

      • SPECIMEN_DEFINITION

        public static final FHIRDefinedType SPECIMEN_DEFINITION
        SpecimenDefinition

        A kind of specimen with associated set of requirements.

      • STRUCTURE_DEFINITION

        public static final FHIRDefinedType STRUCTURE_DEFINITION
        StructureDefinition

        A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.

      • STRUCTURE_MAP

        public static final FHIRDefinedType STRUCTURE_MAP
        StructureMap

        A Map of relationships between 2 structures that can be used to transform data.

      • SUBSCRIPTION

        public static final FHIRDefinedType SUBSCRIPTION
        Subscription

        The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action.

      • SUBSTANCE

        public static final FHIRDefinedType SUBSTANCE
        Substance

        A homogeneous material with a definite composition.

      • SUBSTANCE_NUCLEIC_ACID

        public static final FHIRDefinedType SUBSTANCE_NUCLEIC_ACID
        SubstanceNucleicAcid

        Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will be created for each of these elements. The nucleotide sequence will be always entered in the 5’-3’ direction.

      • SUBSTANCE_POLYMER

        public static final FHIRDefinedType SUBSTANCE_POLYMER
        SubstancePolymer

        Todo.

      • SUBSTANCE_PROTEIN

        public static final FHIRDefinedType SUBSTANCE_PROTEIN
        SubstanceProtein

        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. This includes all synthetic, recombinant and purified SubstanceProteins of defined sequence, whether the use is therapeutic or prophylactic. This set of elements will be used to describe albumins, coagulation factors, cytokines, growth factors, peptide/SubstanceProtein hormones, enzymes, toxins, toxoids, recombinant vaccines, and immunomodulators.

      • SUBSTANCE_REFERENCE_INFORMATION

        public static final FHIRDefinedType SUBSTANCE_REFERENCE_INFORMATION
        SubstanceReferenceInformation

        Todo.

      • SUBSTANCE_SOURCE_MATERIAL

        public static final FHIRDefinedType SUBSTANCE_SOURCE_MATERIAL
        SubstanceSourceMaterial

        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. This set of data elements shall be used to define polymer substances isolated from biological matrices. Taxonomic and anatomical origins shall be described using a controlled vocabulary as required. This information is captured for naturally derived polymers ( . starch) and structurally diverse substances. For Organisms belonging to the Kingdom Plantae the Substance level defines the fresh material of a single species or infraspecies, the Herbal Drug and the Herbal preparation. For Herbal preparations, the fraction information will be captured at the Substance information level and additional information for herbal extracts will be captured at the Specified Substance Group 1 information level. See for further explanation the Substance Class: Structurally Diverse and the herbal annex.

      • SUBSTANCE_SPECIFICATION

        public static final FHIRDefinedType SUBSTANCE_SPECIFICATION
        SubstanceSpecification

        The detailed description of a substance, typically at a level beyond what is used for prescribing.

      • SUPPLY_DELIVERY

        public static final FHIRDefinedType SUPPLY_DELIVERY
        SupplyDelivery

        Record of delivery of what is supplied.

      • SUPPLY_REQUEST

        public static final FHIRDefinedType SUPPLY_REQUEST
        SupplyRequest

        A record of a request for a medication, substance or device used in the healthcare setting.

      • TASK

        public static final FHIRDefinedType TASK
        Task

        A task to be performed.

      • TERMINOLOGY_CAPABILITIES

        public static final FHIRDefinedType TERMINOLOGY_CAPABILITIES
        TerminologyCapabilities

        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.

      • TEST_REPORT

        public static final FHIRDefinedType TEST_REPORT
        TestReport

        A summary of information based on the results of executing a TestScript.

      • TEST_SCRIPT

        public static final FHIRDefinedType TEST_SCRIPT
        TestScript

        A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.

      • VALUE_SET

        public static final FHIRDefinedType VALUE_SET
        ValueSet

        A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements] (terminologies.html).

      • VERIFICATION_RESULT

        public static final FHIRDefinedType VERIFICATION_RESULT
        VerificationResult

        Describes validation requirements, source(s), status and dates for one or more elements.

      • VISION_PRESCRIPTION

        public static final FHIRDefinedType VISION_PRESCRIPTION
        VisionPrescription

        An authorization for the provision of glasses and/or contact lenses to a patient.

    • Method Detail

      • of

        public static FHIRDefinedType of​(String value)
        Factory method for creating FHIRDefinedType objects from a passed string value.
        Parameters:
        value - A string that matches one of the allowed code values
        Throws:
        IllegalArgumentException - If the passed string cannot be parsed into an allowed code value

      • string

        public static String string​(String value)
        Inherited factory method for creating FHIRDefinedType objects from a passed string value.
        Parameters:
        value - A string that matches one of the allowed code values
        Throws:
        IllegalArgumentException - If the passed string cannot be parsed into an allowed code value

      • code

        public static Code code​(String value)
        Inherited factory method for creating FHIRDefinedType objects from a passed string value.
        Parameters:
        value - A string that matches one of the allowed code values
        Throws:
        IllegalArgumentException - If the passed string cannot be parsed into an allowed code value

      • equals

        public boolean equals​(Object obj)
        Overrides:
        equals in class Code

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Code